2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
71 * @defgroup lavc_core Core functions/structures.
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. it is as close as possible to similar codecs.
92 * After adding new codec IDs, do not forget to add an entry to the codec
93 * descriptor list and bump libavcodec minor version.
99 AV_CODEC_ID_MPEG1VIDEO,
100 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
101 AV_CODEC_ID_MPEG2VIDEO_XVMC,
112 AV_CODEC_ID_RAWVIDEO,
113 AV_CODEC_ID_MSMPEG4V1,
114 AV_CODEC_ID_MSMPEG4V2,
115 AV_CODEC_ID_MSMPEG4V3,
138 AV_CODEC_ID_INTERPLAY_VIDEO,
145 AV_CODEC_ID_MSVIDEO1,
150 AV_CODEC_ID_TRUEMOTION1,
151 AV_CODEC_ID_VMDVIDEO,
177 AV_CODEC_ID_TRUEMOTION2,
183 AV_CODEC_ID_SMACKVIDEO,
188 AV_CODEC_ID_JPEG2000,
194 AV_CODEC_ID_DSICINVIDEO,
195 AV_CODEC_ID_TIERTEXSEQVIDEO,
203 AV_CODEC_ID_BETHSOFTVID,
215 AV_CODEC_ID_ESCAPE124,
219 AV_CODEC_ID_MOTIONPIXELS,
231 AV_CODEC_ID_FLASHSV2,
232 AV_CODEC_ID_CDGRAPHICS,
235 AV_CODEC_ID_BINKVIDEO,
236 AV_CODEC_ID_IFF_ILBM,
237 AV_CODEC_ID_IFF_BYTERUN1,
243 AV_CODEC_ID_A64_MULTI,
244 AV_CODEC_ID_A64_MULTI5,
247 AV_CODEC_ID_LAGARITH,
251 AV_CODEC_ID_WMV3IMAGE,
252 AV_CODEC_ID_VC1IMAGE,
254 AV_CODEC_ID_BMV_VIDEO,
261 AV_CODEC_ID_ZEROCODEC,
269 /* various PCM "codecs" */
270 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
271 AV_CODEC_ID_PCM_S16LE = 0x10000,
272 AV_CODEC_ID_PCM_S16BE,
273 AV_CODEC_ID_PCM_U16LE,
274 AV_CODEC_ID_PCM_U16BE,
277 AV_CODEC_ID_PCM_MULAW,
278 AV_CODEC_ID_PCM_ALAW,
279 AV_CODEC_ID_PCM_S32LE,
280 AV_CODEC_ID_PCM_S32BE,
281 AV_CODEC_ID_PCM_U32LE,
282 AV_CODEC_ID_PCM_U32BE,
283 AV_CODEC_ID_PCM_S24LE,
284 AV_CODEC_ID_PCM_S24BE,
285 AV_CODEC_ID_PCM_U24LE,
286 AV_CODEC_ID_PCM_U24BE,
287 AV_CODEC_ID_PCM_S24DAUD,
288 AV_CODEC_ID_PCM_ZORK,
289 AV_CODEC_ID_PCM_S16LE_PLANAR,
291 AV_CODEC_ID_PCM_F32BE,
292 AV_CODEC_ID_PCM_F32LE,
293 AV_CODEC_ID_PCM_F64BE,
294 AV_CODEC_ID_PCM_F64LE,
295 AV_CODEC_ID_PCM_BLURAY,
298 AV_CODEC_ID_PCM_S8_PLANAR,
300 /* various ADPCM codecs */
301 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
302 AV_CODEC_ID_ADPCM_IMA_WAV,
303 AV_CODEC_ID_ADPCM_IMA_DK3,
304 AV_CODEC_ID_ADPCM_IMA_DK4,
305 AV_CODEC_ID_ADPCM_IMA_WS,
306 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
307 AV_CODEC_ID_ADPCM_MS,
308 AV_CODEC_ID_ADPCM_4XM,
309 AV_CODEC_ID_ADPCM_XA,
310 AV_CODEC_ID_ADPCM_ADX,
311 AV_CODEC_ID_ADPCM_EA,
312 AV_CODEC_ID_ADPCM_G726,
313 AV_CODEC_ID_ADPCM_CT,
314 AV_CODEC_ID_ADPCM_SWF,
315 AV_CODEC_ID_ADPCM_YAMAHA,
316 AV_CODEC_ID_ADPCM_SBPRO_4,
317 AV_CODEC_ID_ADPCM_SBPRO_3,
318 AV_CODEC_ID_ADPCM_SBPRO_2,
319 AV_CODEC_ID_ADPCM_THP,
320 AV_CODEC_ID_ADPCM_IMA_AMV,
321 AV_CODEC_ID_ADPCM_EA_R1,
322 AV_CODEC_ID_ADPCM_EA_R3,
323 AV_CODEC_ID_ADPCM_EA_R2,
324 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
325 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
326 AV_CODEC_ID_ADPCM_EA_XAS,
327 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
328 AV_CODEC_ID_ADPCM_IMA_ISS,
329 AV_CODEC_ID_ADPCM_G722,
330 AV_CODEC_ID_ADPCM_IMA_APC,
333 AV_CODEC_ID_AMR_NB = 0x12000,
336 /* RealAudio codecs*/
337 AV_CODEC_ID_RA_144 = 0x13000,
340 /* various DPCM codecs */
341 AV_CODEC_ID_ROQ_DPCM = 0x14000,
342 AV_CODEC_ID_INTERPLAY_DPCM,
343 AV_CODEC_ID_XAN_DPCM,
344 AV_CODEC_ID_SOL_DPCM,
347 AV_CODEC_ID_MP2 = 0x15000,
348 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 AV_CODEC_ID_VMDAUDIO,
364 AV_CODEC_ID_WESTWOOD_SND1,
365 AV_CODEC_ID_GSM, ///< as in Berlin toast format
368 AV_CODEC_ID_TRUESPEECH,
370 AV_CODEC_ID_SMACKAUDIO,
373 AV_CODEC_ID_DSICINAUDIO,
375 AV_CODEC_ID_MUSEPACK7,
377 AV_CODEC_ID_GSM_MS, /* as found in WAV */
381 AV_CODEC_ID_NELLYMOSER,
382 AV_CODEC_ID_MUSEPACK8,
384 AV_CODEC_ID_WMAVOICE,
386 AV_CODEC_ID_WMALOSSLESS,
395 AV_CODEC_ID_BINKAUDIO_RDFT,
396 AV_CODEC_ID_BINKAUDIO_DCT,
397 AV_CODEC_ID_AAC_LATM,
402 AV_CODEC_ID_8SVX_EXP,
403 AV_CODEC_ID_8SVX_FIB,
404 AV_CODEC_ID_BMV_AUDIO,
409 /* subtitle codecs */
410 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
411 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
412 AV_CODEC_ID_DVB_SUBTITLE,
413 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
416 AV_CODEC_ID_MOV_TEXT,
417 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
418 AV_CODEC_ID_DVB_TELETEXT,
421 /* other specific kind of codecs (generally used for attachments) */
422 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
423 AV_CODEC_ID_TTF = 0x18000,
425 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
427 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
428 * stream (only used by libavformat) */
429 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
430 * stream (only used by libavformat) */
431 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
434 #include "old_codec_ids.h"
439 #define CodecID AVCodecID
443 * This struct describes the properties of a single codec described by an
445 * @see avcodec_get_descriptor()
447 typedef struct AVCodecDescriptor {
449 enum AVMediaType type;
451 * Name of the codec described by this descriptor. It is non-empty and
452 * unique for each codec descriptor. It should contain alphanumeric
453 * characters and '_' only.
457 * A more descriptive name for this codec. May be NULL.
459 const char *long_name;
461 * Codec properties, a combination of AV_CODEC_PROP_* flags.
467 * Codec uses only intra compression.
470 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
472 * Codec supports lossy compression. Audio and video codecs only.
473 * @note a codec may support both lossy and lossless
476 #define AV_CODEC_PROP_LOSSY (1 << 1)
478 * Codec supports lossless compression. Audio and video codecs only.
480 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
482 #if FF_API_OLD_DECODE_AUDIO
484 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
488 * @ingroup lavc_decoding
489 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
490 * This is mainly needed because some optimized bitstream readers read
491 * 32 or 64 bit at once and could read over the end.<br>
492 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
493 * MPEG bitstreams could cause overread and segfault.
495 #define FF_INPUT_BUFFER_PADDING_SIZE 8
498 * @ingroup lavc_encoding
499 * minimum encoding buffer size
500 * Used to avoid some checks during header writing.
502 #define FF_MIN_BUFFER_SIZE 16384
506 * @ingroup lavc_encoding
507 * motion estimation type.
510 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
514 ME_EPZS, ///< enhanced predictive zonal search
515 ME_X1, ///< reserved for experiments
516 ME_HEX, ///< hexagon based search
517 ME_UMH, ///< uneven multi-hexagon search
518 ME_ITER, ///< iterative search
519 ME_TESA, ///< transformed exhaustive search algorithm
523 * @ingroup lavc_decoding
526 /* We leave some space between them for extensions (drop some
527 * keyframes for intra-only or drop just some bidir frames). */
528 AVDISCARD_NONE =-16, ///< discard nothing
529 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
530 AVDISCARD_NONREF = 8, ///< discard all non reference
531 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
532 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
533 AVDISCARD_ALL = 48, ///< discard all
536 enum AVColorPrimaries{
537 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
538 AVCOL_PRI_UNSPECIFIED = 2,
539 AVCOL_PRI_BT470M = 4,
540 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
541 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
542 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
544 AVCOL_PRI_NB , ///< Not part of ABI
547 enum AVColorTransferCharacteristic{
548 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
549 AVCOL_TRC_UNSPECIFIED = 2,
550 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
551 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
552 AVCOL_TRC_SMPTE240M = 7,
553 AVCOL_TRC_NB , ///< Not part of ABI
558 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
559 AVCOL_SPC_UNSPECIFIED = 2,
561 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
562 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
563 AVCOL_SPC_SMPTE240M = 7,
564 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
565 AVCOL_SPC_NB , ///< Not part of ABI
569 AVCOL_RANGE_UNSPECIFIED = 0,
570 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
571 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
572 AVCOL_RANGE_NB , ///< Not part of ABI
576 * X X 3 4 X X are luma samples,
577 * 1 2 1-6 are possible chroma positions
578 * X X 5 6 X 0 is undefined/unknown position
580 enum AVChromaLocation{
581 AVCHROMA_LOC_UNSPECIFIED = 0,
582 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
583 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
584 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
585 AVCHROMA_LOC_TOP = 4,
586 AVCHROMA_LOC_BOTTOMLEFT = 5,
587 AVCHROMA_LOC_BOTTOM = 6,
588 AVCHROMA_LOC_NB , ///< Not part of ABI
591 enum AVAudioServiceType {
592 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
593 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
594 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
595 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
596 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
597 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
598 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
599 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
600 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
601 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
605 * @ingroup lavc_encoding
607 typedef struct RcOverride{
610 int qscale; // If this is 0 then quality_factor will be used instead.
611 float quality_factor;
614 #define FF_MAX_B_FRAMES 16
617 These flags can be passed in AVCodecContext.flags before initialization.
618 Note: Not everything is supported yet.
621 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
622 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
623 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
624 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
625 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
627 * The parent program guarantees that the input for B-frames containing
628 * streams is not written to for at least s->max_b_frames+1 frames, if
629 * this is not set the input will be copied.
631 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
632 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
633 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
634 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
635 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
636 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
637 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
638 location instead of only at frame boundaries. */
639 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
640 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
641 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
642 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
643 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
644 /* Fx : Flag for h263+ extra options */
645 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
646 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
647 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
648 #define CODEC_FLAG_CLOSED_GOP 0x80000000
649 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
650 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
651 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
652 #if FF_API_MPV_GLOBAL_OPTS
653 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
654 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
655 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
656 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
658 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
660 /* Unsupported options :
661 * Syntax Arithmetic coding (SAC)
662 * Reference Picture Selection
663 * Independent Segment Decoding */
665 /* codec capabilities */
667 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
669 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
670 * If not set, it might not use get_buffer() at all or use operations that
671 * assume the buffer was allocated by avcodec_default_get_buffer.
673 #define CODEC_CAP_DR1 0x0002
674 #define CODEC_CAP_TRUNCATED 0x0008
675 /* Codec can export data for HW decoding (XvMC). */
676 #define CODEC_CAP_HWACCEL 0x0010
678 * Encoder or decoder requires flushing with NULL input at the end in order to
679 * give the complete and correct output.
681 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
682 * with NULL data. The user can still send NULL data to the public encode
683 * or decode function, but libavcodec will not pass it along to the codec
684 * unless this flag is set.
687 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
688 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
692 * The encoder needs to be fed with NULL data at the end of encoding until the
693 * encoder no longer returns data.
695 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
696 * flag also means that the encoder must set the pts and duration for
697 * each output packet. If this flag is not set, the pts and duration will
698 * be determined by libavcodec from the input frame.
700 #define CODEC_CAP_DELAY 0x0020
702 * Codec can be fed a final frame with a smaller size.
703 * This can be used to prevent truncation of the last audio samples.
705 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
707 * Codec can export data for HW decoding (VDPAU).
709 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
711 * Codec can output multiple frames per AVPacket
712 * Normally demuxers return one frame at a time, demuxers which do not do
713 * are connected to a parser to split what they return into proper frames.
714 * This flag is reserved to the very rare category of codecs which have a
715 * bitstream that cannot be split into frames without timeconsuming
716 * operations like full decoding. Demuxers carring such bitstreams thus
717 * may return multiple frames in a packet. This has many disadvantages like
718 * prohibiting stream copy in many cases thus it should only be considered
721 #define CODEC_CAP_SUBFRAMES 0x0100
723 * Codec is experimental and is thus avoided in favor of non experimental
726 #define CODEC_CAP_EXPERIMENTAL 0x0200
728 * Codec should fill in channel configuration and samplerate instead of container
730 #define CODEC_CAP_CHANNEL_CONF 0x0400
732 * Codec is able to deal with negative linesizes
734 #define CODEC_CAP_NEG_LINESIZES 0x0800
736 * Codec supports frame-level multithreading.
738 #define CODEC_CAP_FRAME_THREADS 0x1000
740 * Codec supports slice-based (or partition-based) multithreading.
742 #define CODEC_CAP_SLICE_THREADS 0x2000
744 * Codec supports changed parameters at any point.
746 #define CODEC_CAP_PARAM_CHANGE 0x4000
748 * Codec supports avctx->thread_count == 0 (auto).
750 #define CODEC_CAP_AUTO_THREADS 0x8000
752 * Audio encoder supports receiving a different number of samples in each call.
754 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
756 //The following defines may change, don't expect compatibility if you use them.
757 #define MB_TYPE_INTRA4x4 0x0001
758 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
759 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
760 #define MB_TYPE_16x16 0x0008
761 #define MB_TYPE_16x8 0x0010
762 #define MB_TYPE_8x16 0x0020
763 #define MB_TYPE_8x8 0x0040
764 #define MB_TYPE_INTERLACED 0x0080
765 #define MB_TYPE_DIRECT2 0x0100 //FIXME
766 #define MB_TYPE_ACPRED 0x0200
767 #define MB_TYPE_GMC 0x0400
768 #define MB_TYPE_SKIP 0x0800
769 #define MB_TYPE_P0L0 0x1000
770 #define MB_TYPE_P1L0 0x2000
771 #define MB_TYPE_P0L1 0x4000
772 #define MB_TYPE_P1L1 0x8000
773 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
774 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
775 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
776 #define MB_TYPE_QUANT 0x00010000
777 #define MB_TYPE_CBP 0x00020000
778 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
782 * This specifies the area which should be displayed.
783 * Note there may be multiple such areas for one frame.
785 typedef struct AVPanScan{
788 * - encoding: Set by user.
789 * - decoding: Set by libavcodec.
794 * width and height in 1/16 pel
795 * - encoding: Set by user.
796 * - decoding: Set by libavcodec.
802 * position of the top left corner in 1/16 pel for up to 3 fields/frames
803 * - encoding: Set by user.
804 * - decoding: Set by libavcodec.
806 int16_t position[3][2];
809 #define FF_QSCALE_TYPE_MPEG1 0
810 #define FF_QSCALE_TYPE_MPEG2 1
811 #define FF_QSCALE_TYPE_H264 2
812 #define FF_QSCALE_TYPE_VP56 3
814 #define FF_BUFFER_TYPE_INTERNAL 1
815 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
816 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
817 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
819 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
820 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
821 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
822 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
825 * @defgroup lavc_packet AVPacket
827 * Types and functions for working with AVPacket.
830 enum AVPacketSideDataType {
832 AV_PKT_DATA_NEW_EXTRADATA,
835 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
838 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
839 * s32le channel_count
840 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
841 * u64le channel_layout
842 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
844 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
849 AV_PKT_DATA_PARAM_CHANGE,
852 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
853 * structures with info about macroblocks relevant to splitting the
854 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
855 * That is, it does not necessarily contain info about all macroblocks,
856 * as long as the distance between macroblocks in the info is smaller
857 * than the target payload size.
858 * Each MB info structure is 12 bytes, and is laid out as follows:
860 * u32le bit offset from the start of the packet
861 * u8 current quantizer at the start of the macroblock
863 * u16le macroblock address within the GOB
864 * u8 horizontal MV predictor
865 * u8 vertical MV predictor
866 * u8 horizontal MV predictor for block number 3
867 * u8 vertical MV predictor for block number 3
870 AV_PKT_DATA_H263_MB_INFO,
873 typedef struct AVPacket {
875 * Presentation timestamp in AVStream->time_base units; the time at which
876 * the decompressed packet will be presented to the user.
877 * Can be AV_NOPTS_VALUE if it is not stored in the file.
878 * pts MUST be larger or equal to dts as presentation cannot happen before
879 * decompression, unless one wants to view hex dumps. Some formats misuse
880 * the terms dts and pts/cts to mean something different. Such timestamps
881 * must be converted to true pts/dts before they are stored in AVPacket.
885 * Decompression timestamp in AVStream->time_base units; the time at which
886 * the packet is decompressed.
887 * Can be AV_NOPTS_VALUE if it is not stored in the file.
894 * A combination of AV_PKT_FLAG values
898 * Additional packet data that can be provided by the container.
899 * Packet can contain several types of side information.
904 enum AVPacketSideDataType type;
909 * Duration of this packet in AVStream->time_base units, 0 if unknown.
910 * Equals next_pts - this_pts in presentation order.
913 void (*destruct)(struct AVPacket *);
915 int64_t pos; ///< byte position in stream, -1 if unknown
918 * Time difference in AVStream->time_base units from the pts of this
919 * packet to the point at which the output from the decoder has converged
920 * independent from the availability of previous frames. That is, the
921 * frames are virtually identical no matter if decoding started from
922 * the very first frame or from this keyframe.
923 * Is AV_NOPTS_VALUE if unknown.
924 * This field is not the display duration of the current packet.
925 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
928 * The purpose of this field is to allow seeking in streams that have no
929 * keyframes in the conventional sense. It corresponds to the
930 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
931 * essential for some types of subtitle streams to ensure that all
932 * subtitles are correctly displayed after seeking.
934 int64_t convergence_duration;
936 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
937 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
939 enum AVSideDataParamChangeFlags {
940 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
941 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
942 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
943 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
951 * New fields can be added to the end of AVFRAME with minor version
952 * bumps. Removal, reordering and changes to existing fields require
953 * a major version bump.
954 * sizeof(AVFrame) must not be used outside libav*.
956 typedef struct AVFrame {
957 #define AV_NUM_DATA_POINTERS 8
959 * pointer to the picture/channel planes.
960 * This might be different from the first allocated byte
961 * - encoding: Set by user
962 * - decoding: set by AVCodecContext.get_buffer()
964 uint8_t *data[AV_NUM_DATA_POINTERS];
967 * Size, in bytes, of the data for each picture/channel plane.
969 * For audio, only linesize[0] may be set. For planar audio, each channel
970 * plane must be the same size.
972 * - encoding: Set by user
973 * - decoding: set by AVCodecContext.get_buffer()
975 int linesize[AV_NUM_DATA_POINTERS];
978 * pointers to the data planes/channels.
980 * For video, this should simply point to data[].
982 * For planar audio, each channel has a separate data pointer, and
983 * linesize[0] contains the size of each channel buffer.
984 * For packed audio, there is just one data pointer, and linesize[0]
985 * contains the total size of the buffer for all channels.
987 * Note: Both data and extended_data will always be set by get_buffer(),
988 * but for planar audio with more channels that can fit in data,
989 * extended_data must be used by the decoder in order to access all
993 * decoding: set by AVCodecContext.get_buffer()
995 uint8_t **extended_data;
998 * width and height of the video frame
1000 * - decoding: Read by user.
1005 * number of audio samples (per channel) described by this frame
1006 * - encoding: Set by user
1007 * - decoding: Set by libavcodec
1012 * format of the frame, -1 if unknown or unset
1013 * Values correspond to enum PixelFormat for video frames,
1014 * enum AVSampleFormat for audio)
1015 * - encoding: unused
1016 * - decoding: Read by user.
1021 * 1 -> keyframe, 0-> not
1022 * - encoding: Set by libavcodec.
1023 * - decoding: Set by libavcodec.
1028 * Picture type of the frame, see ?_TYPE below.
1029 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1030 * - decoding: Set by libavcodec.
1032 enum AVPictureType pict_type;
1035 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1036 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1040 uint8_t *base[AV_NUM_DATA_POINTERS];
1043 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1044 * - encoding: unused
1045 * - decoding: Read by user.
1047 AVRational sample_aspect_ratio;
1050 * presentation timestamp in time_base units (time when frame should be shown to user)
1051 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1052 * - encoding: MUST be set by user.
1053 * - decoding: Set by libavcodec.
1058 * reordered pts from the last AVPacket that has been input into the decoder
1059 * - encoding: unused
1060 * - decoding: Read by user.
1065 * dts from the last AVPacket that has been input into the decoder
1066 * - encoding: unused
1067 * - decoding: Read by user.
1072 * picture number in bitstream order
1073 * - encoding: set by
1074 * - decoding: Set by libavcodec.
1076 int coded_picture_number;
1078 * picture number in display order
1079 * - encoding: set by
1080 * - decoding: Set by libavcodec.
1082 int display_picture_number;
1085 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1086 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1087 * - decoding: Set by libavcodec.
1092 * is this picture used as reference
1093 * The values for this are the same as the MpegEncContext.picture_structure
1094 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1095 * Set to 4 for delayed, non-reference frames.
1096 * - encoding: unused
1097 * - decoding: Set by libavcodec. (before get_buffer() call)).
1103 * - encoding: unused
1104 * - decoding: Set by libavcodec.
1106 int8_t *qscale_table;
1109 * - encoding: unused
1110 * - decoding: Set by libavcodec.
1120 * mbskip_table[mb]>=1 if MB didn't change
1121 * stride= mb_width = (width+15)>>4
1122 * - encoding: unused
1123 * - decoding: Set by libavcodec.
1125 uint8_t *mbskip_table;
1128 * motion vector table
1131 * int mv_sample_log2= 4 - motion_subsample_log2;
1132 * int mb_width= (width+15)>>4;
1133 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1134 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1136 * - encoding: Set by user.
1137 * - decoding: Set by libavcodec.
1139 int16_t (*motion_val[2])[2];
1142 * macroblock type table
1143 * mb_type_base + mb_width + 2
1144 * - encoding: Set by user.
1145 * - decoding: Set by libavcodec.
1151 * - encoding: unused
1152 * - decoding: Set by libavcodec.
1157 * motion reference frame index
1158 * the order in which these are stored can depend on the codec.
1159 * - encoding: Set by user.
1160 * - decoding: Set by libavcodec.
1162 int8_t *ref_index[2];
1165 * for some private data of the user
1166 * - encoding: unused
1167 * - decoding: Set by user.
1173 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1174 * - decoding: unused
1176 uint64_t error[AV_NUM_DATA_POINTERS];
1179 * type of the buffer (to keep track of who has to deallocate data[*])
1180 * - encoding: Set by the one who allocates it.
1181 * - decoding: Set by the one who allocates it.
1182 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1187 * When decoding, this signals how much the picture must be delayed.
1188 * extra_delay = repeat_pict / (2*fps)
1189 * - encoding: unused
1190 * - decoding: Set by libavcodec.
1195 * The content of the picture is interlaced.
1196 * - encoding: Set by user.
1197 * - decoding: Set by libavcodec. (default 0)
1199 int interlaced_frame;
1202 * If the content is interlaced, is top field displayed first.
1203 * - encoding: Set by user.
1204 * - decoding: Set by libavcodec.
1206 int top_field_first;
1209 * Tell user application that palette has changed from previous frame.
1210 * - encoding: ??? (no palette-enabled encoder yet)
1211 * - decoding: Set by libavcodec. (default 0).
1213 int palette_has_changed;
1216 * codec suggestion on buffer type if != 0
1217 * - encoding: unused
1218 * - decoding: Set by libavcodec. (before get_buffer() call)).
1224 * - encoding: Set by user.
1225 * - decoding: Set by libavcodec.
1227 AVPanScan *pan_scan;
1230 * reordered opaque 64bit (generally an integer or a double precision float
1231 * PTS but can be anything).
1232 * The user sets AVCodecContext.reordered_opaque to represent the input at
1234 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1235 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1236 * @deprecated in favor of pkt_pts
1237 * - encoding: unused
1238 * - decoding: Read by user.
1240 int64_t reordered_opaque;
1243 * hardware accelerator private data (Libav-allocated)
1244 * - encoding: unused
1245 * - decoding: Set by libavcodec
1247 void *hwaccel_picture_private;
1250 * the AVCodecContext which ff_thread_get_buffer() was last called on
1251 * - encoding: Set by libavcodec.
1252 * - decoding: Set by libavcodec.
1254 struct AVCodecContext *owner;
1257 * used by multithreading to store frame-specific info
1258 * - encoding: Set by libavcodec.
1259 * - decoding: Set by libavcodec.
1261 void *thread_opaque;
1264 * log2 of the size of the block which a single vector in motion_val represents:
1265 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1266 * - encoding: unused
1267 * - decoding: Set by libavcodec.
1269 uint8_t motion_subsample_log2;
1272 * Sample rate of the audio data.
1274 * - encoding: unused
1275 * - decoding: set by get_buffer()
1280 * Channel layout of the audio data.
1282 * - encoding: unused
1283 * - decoding: set by get_buffer()
1285 uint64_t channel_layout;
1288 struct AVCodecInternal;
1292 AV_FIELD_PROGRESSIVE,
1293 AV_FIELD_TT, //< Top coded_first, top displayed first
1294 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1295 AV_FIELD_TB, //< Top coded first, bottom displayed first
1296 AV_FIELD_BT, //< Bottom coded first, top displayed first
1300 * main external API structure.
1301 * New fields can be added to the end with minor version bumps.
1302 * Removal, reordering and changes to existing fields require a major
1304 * sizeof(AVCodecContext) must not be used outside libav*.
1306 typedef struct AVCodecContext {
1308 * information on struct for av_log
1309 * - set by avcodec_alloc_context3
1311 const AVClass *av_class;
1312 int log_level_offset;
1314 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1315 const struct AVCodec *codec;
1316 char codec_name[32];
1317 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1320 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1321 * This is used to work around some encoder bugs.
1322 * A demuxer should set this to what is stored in the field used to identify the codec.
1323 * If there are multiple such fields in a container then the demuxer should choose the one
1324 * which maximizes the information about the used codec.
1325 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1326 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1327 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1329 * - encoding: Set by user, if not then the default based on codec_id will be used.
1330 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1332 unsigned int codec_tag;
1335 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1336 * This is used to work around some encoder bugs.
1337 * - encoding: unused
1338 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1340 unsigned int stream_codec_tag;
1344 * @deprecated this field is unused
1346 attribute_deprecated int sub_id;
1352 * Private context used for internal data.
1354 * Unlike priv_data, this is not codec-specific. It is used in general
1355 * libavcodec functions.
1357 struct AVCodecInternal *internal;
1360 * Private data of the user, can be used to carry app specific stuff.
1361 * - encoding: Set by user.
1362 * - decoding: Set by user.
1367 * the average bitrate
1368 * - encoding: Set by user; unused for constant quantizer encoding.
1369 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1374 * number of bits the bitstream is allowed to diverge from the reference.
1375 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1376 * - encoding: Set by user; unused for constant quantizer encoding.
1377 * - decoding: unused
1379 int bit_rate_tolerance;
1382 * Global quality for codecs which cannot change it per frame.
1383 * This should be proportional to MPEG-1/2/4 qscale.
1384 * - encoding: Set by user.
1385 * - decoding: unused
1390 * - encoding: Set by user.
1391 * - decoding: unused
1393 int compression_level;
1394 #define FF_COMPRESSION_DEFAULT -1
1398 * - encoding: Set by user.
1399 * - decoding: Set by user.
1405 * - encoding: Set by user.
1406 * - decoding: Set by user.
1411 * some codecs need / can use extradata like Huffman tables.
1412 * mjpeg: Huffman tables
1413 * rv10: additional flags
1414 * mpeg4: global headers (they can be in the bitstream or here)
1415 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1416 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1417 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1418 * - encoding: Set/allocated/freed by libavcodec.
1419 * - decoding: Set/allocated/freed by user.
1425 * This is the fundamental unit of time (in seconds) in terms
1426 * of which frame timestamps are represented. For fixed-fps content,
1427 * timebase should be 1/framerate and timestamp increments should be
1429 * - encoding: MUST be set by user.
1430 * - decoding: Set by libavcodec.
1432 AVRational time_base;
1435 * For some codecs, the time base is closer to the field rate than the frame rate.
1436 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1437 * if no telecine is used ...
1439 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1441 int ticks_per_frame;
1447 * Number of frames the decoded output will be delayed relative to the
1451 * Number of "priming" samples added to the beginning of the stream
1452 * during encoding. The decoded output will be delayed by this many
1453 * samples relative to the input to the encoder. Note that this field is
1454 * purely informational and does not directly affect the pts output by
1455 * the encoder, which should always be based on the actual presentation
1456 * time, including any delay.
1458 * - encoding: Set by libavcodec.
1459 * - decoding: unused
1466 * picture width / height.
1467 * - encoding: MUST be set by user.
1468 * - decoding: Set by libavcodec.
1469 * Note: For compatibility it is possible to set this instead of
1470 * coded_width/height before decoding.
1475 * Bitstream width / height, may be different from width/height.
1476 * - encoding: unused
1477 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1479 int coded_width, coded_height;
1481 #define FF_ASPECT_EXTENDED 15
1484 * the number of pictures in a group of pictures, or 0 for intra_only
1485 * - encoding: Set by user.
1486 * - decoding: unused
1491 * Pixel format, see PIX_FMT_xxx.
1492 * May be set by the demuxer if known from headers.
1493 * May be overriden by the decoder if it knows better.
1494 * - encoding: Set by user.
1495 * - decoding: Set by user if known, overridden by libavcodec if known
1497 enum PixelFormat pix_fmt;
1500 * Motion estimation algorithm used for video coding.
1501 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1502 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1503 * - encoding: MUST be set by user.
1504 * - decoding: unused
1509 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1510 * decoder to draw a horizontal band. It improves cache usage. Not
1511 * all codecs can do that. You must check the codec capabilities
1513 * When multithreading is used, it may be called from multiple threads
1514 * at the same time; threads might draw different parts of the same AVFrame,
1515 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1517 * The function is also used by hardware acceleration APIs.
1518 * It is called at least once during frame decoding to pass
1519 * the data needed for hardware render.
1520 * In that mode instead of pixel data, AVFrame points to
1521 * a structure specific to the acceleration API. The application
1522 * reads the structure and can change some fields to indicate progress
1524 * - encoding: unused
1525 * - decoding: Set by user.
1526 * @param height the height of the slice
1527 * @param y the y position of the slice
1528 * @param type 1->top field, 2->bottom field, 3->frame
1529 * @param offset offset into the AVFrame.data from which the slice should be read
1531 void (*draw_horiz_band)(struct AVCodecContext *s,
1532 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1533 int y, int type, int height);
1536 * callback to negotiate the pixelFormat
1537 * @param fmt is the list of formats which are supported by the codec,
1538 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1539 * The first is always the native one.
1540 * @return the chosen format
1541 * - encoding: unused
1542 * - decoding: Set by user, if not set the native format will be chosen.
1544 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1547 * maximum number of B-frames between non-B-frames
1548 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1549 * - encoding: Set by user.
1550 * - decoding: unused
1555 * qscale factor between IP and B-frames
1556 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1557 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1558 * - encoding: Set by user.
1559 * - decoding: unused
1561 float b_quant_factor;
1563 /** obsolete FIXME remove */
1565 #define FF_RC_STRATEGY_XVID 1
1567 int b_frame_strategy;
1569 #if FF_API_MPV_GLOBAL_OPTS
1571 * luma single coefficient elimination threshold
1572 * - encoding: Set by user.
1573 * - decoding: unused
1575 attribute_deprecated int luma_elim_threshold;
1578 * chroma single coeff elimination threshold
1579 * - encoding: Set by user.
1580 * - decoding: unused
1582 attribute_deprecated int chroma_elim_threshold;
1586 * qscale offset between IP and B-frames
1587 * - encoding: Set by user.
1588 * - decoding: unused
1590 float b_quant_offset;
1593 * Size of the frame reordering buffer in the decoder.
1594 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1595 * - encoding: Set by libavcodec.
1596 * - decoding: Set by libavcodec.
1601 * 0-> h263 quant 1-> mpeg quant
1602 * - encoding: Set by user.
1603 * - decoding: unused
1608 * qscale factor between P and I-frames
1609 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1610 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1611 * - encoding: Set by user.
1612 * - decoding: unused
1614 float i_quant_factor;
1617 * qscale offset between P and I-frames
1618 * - encoding: Set by user.
1619 * - decoding: unused
1621 float i_quant_offset;
1624 * luminance masking (0-> disabled)
1625 * - encoding: Set by user.
1626 * - decoding: unused
1631 * temporary complexity masking (0-> disabled)
1632 * - encoding: Set by user.
1633 * - decoding: unused
1635 float temporal_cplx_masking;
1638 * spatial complexity masking (0-> disabled)
1639 * - encoding: Set by user.
1640 * - decoding: unused
1642 float spatial_cplx_masking;
1645 * p block masking (0-> disabled)
1646 * - encoding: Set by user.
1647 * - decoding: unused
1652 * darkness masking (0-> disabled)
1653 * - encoding: Set by user.
1654 * - decoding: unused
1660 * - encoding: Set by libavcodec.
1661 * - decoding: Set by user (or 0).
1665 * prediction method (needed for huffyuv)
1666 * - encoding: Set by user.
1667 * - decoding: unused
1669 int prediction_method;
1670 #define FF_PRED_LEFT 0
1671 #define FF_PRED_PLANE 1
1672 #define FF_PRED_MEDIAN 2
1675 * slice offsets in the frame in bytes
1676 * - encoding: Set/allocated by libavcodec.
1677 * - decoding: Set/allocated by user (or NULL).
1682 * sample aspect ratio (0 if unknown)
1683 * That is the width of a pixel divided by the height of the pixel.
1684 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1685 * - encoding: Set by user.
1686 * - decoding: Set by libavcodec.
1688 AVRational sample_aspect_ratio;
1691 * motion estimation comparison function
1692 * - encoding: Set by user.
1693 * - decoding: unused
1697 * subpixel motion estimation comparison function
1698 * - encoding: Set by user.
1699 * - decoding: unused
1703 * macroblock comparison function (not supported yet)
1704 * - encoding: Set by user.
1705 * - decoding: unused
1709 * interlaced DCT comparison function
1710 * - encoding: Set by user.
1711 * - decoding: unused
1714 #define FF_CMP_SAD 0
1715 #define FF_CMP_SSE 1
1716 #define FF_CMP_SATD 2
1717 #define FF_CMP_DCT 3
1718 #define FF_CMP_PSNR 4
1719 #define FF_CMP_BIT 5
1721 #define FF_CMP_ZERO 7
1722 #define FF_CMP_VSAD 8
1723 #define FF_CMP_VSSE 9
1724 #define FF_CMP_NSSE 10
1725 #define FF_CMP_W53 11
1726 #define FF_CMP_W97 12
1727 #define FF_CMP_DCTMAX 13
1728 #define FF_CMP_DCT264 14
1729 #define FF_CMP_CHROMA 256
1732 * ME diamond size & shape
1733 * - encoding: Set by user.
1734 * - decoding: unused
1739 * amount of previous MV predictors (2a+1 x 2a+1 square)
1740 * - encoding: Set by user.
1741 * - decoding: unused
1743 int last_predictor_count;
1746 * prepass for motion estimation
1747 * - encoding: Set by user.
1748 * - decoding: unused
1753 * motion estimation prepass comparison function
1754 * - encoding: Set by user.
1755 * - decoding: unused
1760 * ME prepass diamond size & shape
1761 * - encoding: Set by user.
1762 * - decoding: unused
1768 * - encoding: Set by user.
1769 * - decoding: unused
1771 int me_subpel_quality;
1774 * DTG active format information (additional aspect ratio
1775 * information only used in DVB MPEG-2 transport streams)
1778 * - encoding: unused
1779 * - decoding: Set by decoder.
1781 int dtg_active_format;
1782 #define FF_DTG_AFD_SAME 8
1783 #define FF_DTG_AFD_4_3 9
1784 #define FF_DTG_AFD_16_9 10
1785 #define FF_DTG_AFD_14_9 11
1786 #define FF_DTG_AFD_4_3_SP_14_9 13
1787 #define FF_DTG_AFD_16_9_SP_14_9 14
1788 #define FF_DTG_AFD_SP_4_3 15
1791 * maximum motion estimation search range in subpel units
1792 * If 0 then no limit.
1794 * - encoding: Set by user.
1795 * - decoding: unused
1800 * intra quantizer bias
1801 * - encoding: Set by user.
1802 * - decoding: unused
1804 int intra_quant_bias;
1805 #define FF_DEFAULT_QUANT_BIAS 999999
1808 * inter quantizer bias
1809 * - encoding: Set by user.
1810 * - decoding: unused
1812 int inter_quant_bias;
1814 #if FF_API_COLOR_TABLE_ID
1817 * - encoding: unused
1818 * - decoding: Which clrtable should be used for 8bit RGB images.
1819 * Tables have to be stored somewhere. FIXME
1821 attribute_deprecated int color_table_id;
1826 * - encoding: unused
1827 * - decoding: Set by user.
1830 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1831 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1832 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1835 * XVideo Motion Acceleration
1836 * - encoding: forbidden
1837 * - decoding: set by decoder
1839 int xvmc_acceleration;
1842 * macroblock decision mode
1843 * - encoding: Set by user.
1844 * - decoding: unused
1847 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1848 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1849 #define FF_MB_DECISION_RD 2 ///< rate distortion
1852 * custom intra quantization matrix
1853 * - encoding: Set by user, can be NULL.
1854 * - decoding: Set by libavcodec.
1856 uint16_t *intra_matrix;
1859 * custom inter quantization matrix
1860 * - encoding: Set by user, can be NULL.
1861 * - decoding: Set by libavcodec.
1863 uint16_t *inter_matrix;
1866 * scene change detection threshold
1867 * 0 is default, larger means fewer detected scene changes.
1868 * - encoding: Set by user.
1869 * - decoding: unused
1871 int scenechange_threshold;
1874 * noise reduction strength
1875 * - encoding: Set by user.
1876 * - decoding: unused
1878 int noise_reduction;
1880 #if FF_API_INTER_THRESHOLD
1882 * @deprecated this field is unused
1884 attribute_deprecated int inter_threshold;
1887 #if FF_API_MPV_GLOBAL_OPTS
1889 * @deprecated use mpegvideo private options instead
1891 attribute_deprecated int quantizer_noise_shaping;
1895 * Motion estimation threshold below which no motion estimation is
1896 * performed, but instead the user specified motion vectors are used.
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * Macroblock threshold below which the user specified macroblock types will be used.
1905 * - encoding: Set by user.
1906 * - decoding: unused
1911 * precision of the intra DC coefficient - 8
1912 * - encoding: Set by user.
1913 * - decoding: unused
1915 int intra_dc_precision;
1918 * Number of macroblock rows at the top which are skipped.
1919 * - encoding: unused
1920 * - decoding: Set by user.
1925 * Number of macroblock rows at the bottom which are skipped.
1926 * - encoding: unused
1927 * - decoding: Set by user.
1932 * Border processing masking, raises the quantizer for mbs on the borders
1934 * - encoding: Set by user.
1935 * - decoding: unused
1937 float border_masking;
1940 * minimum MB lagrange multipler
1941 * - encoding: Set by user.
1942 * - decoding: unused
1947 * maximum MB lagrange multipler
1948 * - encoding: Set by user.
1949 * - decoding: unused
1955 * - encoding: Set by user.
1956 * - decoding: unused
1958 int me_penalty_compensation;
1962 * - encoding: Set by user.
1963 * - decoding: unused
1969 * - encoding: Set by user.
1970 * - decoding: unused
1976 * - encoding: Set by user.
1977 * - decoding: unused
1982 * number of reference frames
1983 * - encoding: Set by user.
1984 * - decoding: Set by lavc.
1989 * chroma qp offset from luma
1990 * - encoding: Set by user.
1991 * - decoding: unused
1996 * Multiplied by qscale for each frame and added to scene_change_score.
1997 * - encoding: Set by user.
1998 * - decoding: unused
2000 int scenechange_factor;
2004 * Note: Value depends upon the compare function used for fullpel ME.
2005 * - encoding: Set by user.
2006 * - decoding: unused
2011 * Adjust sensitivity of b_frame_strategy 1.
2012 * - encoding: Set by user.
2013 * - decoding: unused
2018 * Chromaticity coordinates of the source primaries.
2019 * - encoding: Set by user
2020 * - decoding: Set by libavcodec
2022 enum AVColorPrimaries color_primaries;
2025 * Color Transfer Characteristic.
2026 * - encoding: Set by user
2027 * - decoding: Set by libavcodec
2029 enum AVColorTransferCharacteristic color_trc;
2032 * YUV colorspace type.
2033 * - encoding: Set by user
2034 * - decoding: Set by libavcodec
2036 enum AVColorSpace colorspace;
2039 * MPEG vs JPEG YUV range.
2040 * - encoding: Set by user
2041 * - decoding: Set by libavcodec
2043 enum AVColorRange color_range;
2046 * This defines the location of chroma samples.
2047 * - encoding: Set by user
2048 * - decoding: Set by libavcodec
2050 enum AVChromaLocation chroma_sample_location;
2054 * Indicates number of picture subdivisions. Used for parallelized
2056 * - encoding: Set by user
2057 * - decoding: unused
2062 * - encoding: set by libavcodec
2063 * - decoding: Set by libavcodec
2065 enum AVFieldOrder field_order;
2068 int sample_rate; ///< samples per second
2069 int channels; ///< number of audio channels
2072 * audio sample format
2073 * - encoding: Set by user.
2074 * - decoding: Set by libavcodec.
2076 enum AVSampleFormat sample_fmt; ///< sample format
2078 /* The following data should not be initialized. */
2080 * Samples per packet, initialized when calling 'init'.
2085 * Frame counter, set by libavcodec.
2087 * - decoding: total number of frames returned from the decoder so far.
2088 * - encoding: total number of frames passed to the encoder so far.
2090 * @note the counter is not incremented if encoding/decoding resulted in
2096 * number of bytes per packet if constant and known or 0
2097 * Used by some WAV based audio codecs.
2102 * Audio cutoff bandwidth (0 means "automatic")
2103 * - encoding: Set by user.
2104 * - decoding: unused
2108 #if FF_API_REQUEST_CHANNELS
2110 * Decoder should decode to this many channels if it can (0 for default)
2111 * - encoding: unused
2112 * - decoding: Set by user.
2113 * @deprecated Deprecated in favor of request_channel_layout.
2115 int request_channels;
2119 * Audio channel layout.
2120 * - encoding: set by user.
2121 * - decoding: set by libavcodec.
2123 uint64_t channel_layout;
2126 * Request decoder to use this channel layout if it can (0 for default)
2127 * - encoding: unused
2128 * - decoding: Set by user.
2130 uint64_t request_channel_layout;
2133 * Type of service that the audio stream conveys.
2134 * - encoding: Set by user.
2135 * - decoding: Set by libavcodec.
2137 enum AVAudioServiceType audio_service_type;
2140 * Used to request a sample format from the decoder.
2141 * - encoding: unused.
2142 * - decoding: Set by user.
2144 enum AVSampleFormat request_sample_fmt;
2147 * Called at the beginning of each frame to get a buffer for it.
2149 * The function will set AVFrame.data[], AVFrame.linesize[].
2150 * AVFrame.extended_data[] must also be set, but it should be the same as
2151 * AVFrame.data[] except for planar audio with more channels than can fit
2152 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2153 * many data pointers as it can hold.
2155 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2156 * avcodec_default_get_buffer() instead of providing buffers allocated by
2159 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2160 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2161 * but if get_buffer() is overridden then alignment considerations should
2162 * be taken into account.
2164 * @see avcodec_default_get_buffer()
2168 * If pic.reference is set then the frame will be read later by libavcodec.
2169 * avcodec_align_dimensions2() should be used to find the required width and
2170 * height, as they normally need to be rounded up to the next multiple of 16.
2172 * If frame multithreading is used and thread_safe_callbacks is set,
2173 * it may be called from a different thread, but not from more than one at
2174 * once. Does not need to be reentrant.
2176 * @see release_buffer(), reget_buffer()
2177 * @see avcodec_align_dimensions2()
2181 * Decoders request a buffer of a particular size by setting
2182 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2183 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2184 * to a smaller value in the output frame.
2186 * Decoders cannot use the buffer after returning from
2187 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2188 * is assumed to be released immediately upon return.
2190 * As a convenience, av_samples_get_buffer_size() and
2191 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2192 * functions to find the required data size and to fill data pointers and
2193 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2194 * since all planes must be the same size.
2196 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2198 * - encoding: unused
2199 * - decoding: Set by libavcodec, user can override.
2201 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2204 * Called to release buffers which were allocated with get_buffer.
2205 * A released buffer can be reused in get_buffer().
2206 * pic.data[*] must be set to NULL.
2207 * May be called from a different thread if frame multithreading is used,
2208 * but not by more than one thread at once, so does not need to be reentrant.
2209 * - encoding: unused
2210 * - decoding: Set by libavcodec, user can override.
2212 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2215 * Called at the beginning of a frame to get cr buffer for it.
2216 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2217 * libavcodec will pass previous buffer in pic, function should return
2218 * same buffer or new buffer with old frame "painted" into it.
2219 * If pic.data[0] == NULL must behave like get_buffer().
2220 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2221 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2223 * - encoding: unused
2224 * - decoding: Set by libavcodec, user can override.
2226 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2229 /* - encoding parameters */
2230 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2231 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2235 * - encoding: Set by user.
2236 * - decoding: unused
2242 * - encoding: Set by user.
2243 * - decoding: unused
2248 * maximum quantizer difference between frames
2249 * - encoding: Set by user.
2250 * - decoding: unused
2255 * ratecontrol qmin qmax limiting method
2256 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2257 * - encoding: Set by user.
2258 * - decoding: unused
2266 * decoder bitstream buffer size
2267 * - encoding: Set by user.
2268 * - decoding: unused
2273 * ratecontrol override, see RcOverride
2274 * - encoding: Allocated/set/freed by user.
2275 * - decoding: unused
2277 int rc_override_count;
2278 RcOverride *rc_override;
2281 * rate control equation
2282 * - encoding: Set by user
2283 * - decoding: unused
2289 * - encoding: Set by user.
2290 * - decoding: unused
2296 * - encoding: Set by user.
2297 * - decoding: unused
2301 float rc_buffer_aggressivity;
2304 * initial complexity for pass1 ratecontrol
2305 * - encoding: Set by user.
2306 * - decoding: unused
2308 float rc_initial_cplx;
2311 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2312 * - encoding: Set by user.
2313 * - decoding: unused.
2315 float rc_max_available_vbv_use;
2318 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2319 * - encoding: Set by user.
2320 * - decoding: unused.
2322 float rc_min_vbv_overflow_use;
2325 * Number of bits which should be loaded into the rc buffer before decoding starts.
2326 * - encoding: Set by user.
2327 * - decoding: unused
2329 int rc_initial_buffer_occupancy;
2331 #define FF_CODER_TYPE_VLC 0
2332 #define FF_CODER_TYPE_AC 1
2333 #define FF_CODER_TYPE_RAW 2
2334 #define FF_CODER_TYPE_RLE 3
2335 #define FF_CODER_TYPE_DEFLATE 4
2338 * - encoding: Set by user.
2339 * - decoding: unused
2345 * - encoding: Set by user.
2346 * - decoding: unused
2351 * minimum Lagrange multipler
2352 * - encoding: Set by user.
2353 * - decoding: unused
2358 * maximum Lagrange multipler
2359 * - encoding: Set by user.
2360 * - decoding: unused
2365 * frame skip threshold
2366 * - encoding: Set by user.
2367 * - decoding: unused
2369 int frame_skip_threshold;
2373 * - encoding: Set by user.
2374 * - decoding: unused
2376 int frame_skip_factor;
2379 * frame skip exponent
2380 * - encoding: Set by user.
2381 * - decoding: unused
2386 * frame skip comparison function
2387 * - encoding: Set by user.
2388 * - decoding: unused
2393 * trellis RD quantization
2394 * - encoding: Set by user.
2395 * - decoding: unused
2400 * - encoding: Set by user.
2401 * - decoding: unused
2403 int min_prediction_order;
2406 * - encoding: Set by user.
2407 * - decoding: unused
2409 int max_prediction_order;
2412 * GOP timecode frame start number, in non drop frame format
2413 * - encoding: Set by user.
2414 * - decoding: unused
2416 int64_t timecode_frame_start;
2418 /* The RTP callback: This function is called */
2419 /* every time the encoder has a packet to send. */
2420 /* It depends on the encoder if the data starts */
2421 /* with a Start Code (it should). H.263 does. */
2422 /* mb_nb contains the number of macroblocks */
2423 /* encoded in the RTP payload. */
2424 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2426 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2427 /* do its best to deliver a chunk with size */
2428 /* below rtp_payload_size, the chunk will start */
2429 /* with a start code on some codecs like H.263. */
2430 /* This doesn't take account of any particular */
2431 /* headers inside the transmitted RTP payload. */
2433 /* statistics, used for 2-pass encoding */
2444 * number of bits used for the previously encoded frame
2445 * - encoding: Set by libavcodec.
2446 * - decoding: unused
2451 * pass1 encoding statistics output buffer
2452 * - encoding: Set by libavcodec.
2453 * - decoding: unused
2458 * pass2 encoding statistics input buffer
2459 * Concatenated stuff from stats_out of pass1 should be placed here.
2460 * - encoding: Allocated/set/freed by user.
2461 * - decoding: unused
2466 * Work around bugs in encoders which sometimes cannot be detected automatically.
2467 * - encoding: Set by user
2468 * - decoding: Set by user
2470 int workaround_bugs;
2471 #define FF_BUG_AUTODETECT 1 ///< autodetection
2472 #define FF_BUG_OLD_MSMPEG4 2
2473 #define FF_BUG_XVID_ILACE 4
2474 #define FF_BUG_UMP4 8
2475 #define FF_BUG_NO_PADDING 16
2476 #define FF_BUG_AMV 32
2477 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2478 #define FF_BUG_QPEL_CHROMA 64
2479 #define FF_BUG_STD_QPEL 128
2480 #define FF_BUG_QPEL_CHROMA2 256
2481 #define FF_BUG_DIRECT_BLOCKSIZE 512
2482 #define FF_BUG_EDGE 1024
2483 #define FF_BUG_HPEL_CHROMA 2048
2484 #define FF_BUG_DC_CLIP 4096
2485 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2486 #define FF_BUG_TRUNCATED 16384
2489 * strictly follow the standard (MPEG4, ...).
2490 * - encoding: Set by user.
2491 * - decoding: Set by user.
2492 * Setting this to STRICT or higher means the encoder and decoder will
2493 * generally do stupid things, whereas setting it to unofficial or lower
2494 * will mean the encoder might produce output that is not supported by all
2495 * spec-compliant decoders. Decoders don't differentiate between normal,
2496 * unofficial and experimental (that is, they always try to decode things
2497 * when they can) unless they are explicitly asked to behave stupidly
2498 * (=strictly conform to the specs)
2500 int strict_std_compliance;
2501 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2502 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2503 #define FF_COMPLIANCE_NORMAL 0
2504 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2505 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2508 * error concealment flags
2509 * - encoding: unused
2510 * - decoding: Set by user.
2512 int error_concealment;
2513 #define FF_EC_GUESS_MVS 1
2514 #define FF_EC_DEBLOCK 2
2518 * - encoding: Set by user.
2519 * - decoding: Set by user.
2522 #define FF_DEBUG_PICT_INFO 1
2523 #define FF_DEBUG_RC 2
2524 #define FF_DEBUG_BITSTREAM 4
2525 #define FF_DEBUG_MB_TYPE 8
2526 #define FF_DEBUG_QP 16
2527 #define FF_DEBUG_MV 32
2528 #define FF_DEBUG_DCT_COEFF 0x00000040
2529 #define FF_DEBUG_SKIP 0x00000080
2530 #define FF_DEBUG_STARTCODE 0x00000100
2531 #define FF_DEBUG_PTS 0x00000200
2532 #define FF_DEBUG_ER 0x00000400
2533 #define FF_DEBUG_MMCO 0x00000800
2534 #define FF_DEBUG_BUGS 0x00001000
2535 #define FF_DEBUG_VIS_QP 0x00002000
2536 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2537 #define FF_DEBUG_BUFFERS 0x00008000
2538 #define FF_DEBUG_THREADS 0x00010000
2542 * - encoding: Set by user.
2543 * - decoding: Set by user.
2546 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2547 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2548 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2551 * Error recognition; may misdetect some more or less valid parts as errors.
2552 * - encoding: unused
2553 * - decoding: Set by user.
2555 int err_recognition;
2556 #define AV_EF_CRCCHECK (1<<0)
2557 #define AV_EF_BITSTREAM (1<<1)
2558 #define AV_EF_BUFFER (1<<2)
2559 #define AV_EF_EXPLODE (1<<3)
2562 * opaque 64bit number (generally a PTS) that will be reordered and
2563 * output in AVFrame.reordered_opaque
2564 * @deprecated in favor of pkt_pts
2565 * - encoding: unused
2566 * - decoding: Set by user.
2568 int64_t reordered_opaque;
2571 * Hardware accelerator in use
2572 * - encoding: unused.
2573 * - decoding: Set by libavcodec
2575 struct AVHWAccel *hwaccel;
2578 * Hardware accelerator context.
2579 * For some hardware accelerators, a global context needs to be
2580 * provided by the user. In that case, this holds display-dependent
2581 * data Libav cannot instantiate itself. Please refer to the
2582 * Libav HW accelerator documentation to know how to fill this
2583 * is. e.g. for VA API, this is a struct vaapi_context.
2584 * - encoding: unused
2585 * - decoding: Set by user
2587 void *hwaccel_context;
2591 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2592 * - decoding: unused
2594 uint64_t error[AV_NUM_DATA_POINTERS];
2597 * DCT algorithm, see FF_DCT_* below
2598 * - encoding: Set by user.
2599 * - decoding: unused
2602 #define FF_DCT_AUTO 0
2603 #define FF_DCT_FASTINT 1
2604 #define FF_DCT_INT 2
2605 #define FF_DCT_MMX 3
2606 #define FF_DCT_ALTIVEC 5
2607 #define FF_DCT_FAAN 6
2610 * IDCT algorithm, see FF_IDCT_* below.
2611 * - encoding: Set by user.
2612 * - decoding: Set by user.
2615 #define FF_IDCT_AUTO 0
2616 #define FF_IDCT_INT 1
2617 #define FF_IDCT_SIMPLE 2
2618 #define FF_IDCT_SIMPLEMMX 3
2619 #define FF_IDCT_LIBMPEG2MMX 4
2620 #define FF_IDCT_MMI 5
2621 #define FF_IDCT_ARM 7
2622 #define FF_IDCT_ALTIVEC 8
2623 #define FF_IDCT_SH4 9
2624 #define FF_IDCT_SIMPLEARM 10
2625 #define FF_IDCT_H264 11
2626 #define FF_IDCT_VP3 12
2627 #define FF_IDCT_IPP 13
2628 #define FF_IDCT_XVIDMMX 14
2629 #define FF_IDCT_CAVS 15
2630 #define FF_IDCT_SIMPLEARMV5TE 16
2631 #define FF_IDCT_SIMPLEARMV6 17
2632 #define FF_IDCT_SIMPLEVIS 18
2633 #define FF_IDCT_WMV2 19
2634 #define FF_IDCT_FAAN 20
2635 #define FF_IDCT_EA 21
2636 #define FF_IDCT_SIMPLENEON 22
2637 #define FF_IDCT_SIMPLEALPHA 23
2638 #define FF_IDCT_BINK 24
2643 * @deprecated use av_set_cpu_flags_mask() instead.
2645 attribute_deprecated unsigned dsp_mask;
2649 * bits per sample/pixel from the demuxer (needed for huffyuv).
2650 * - encoding: Set by libavcodec.
2651 * - decoding: Set by user.
2653 int bits_per_coded_sample;
2656 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2657 * - encoding: set by user.
2658 * - decoding: set by libavcodec.
2660 int bits_per_raw_sample;
2663 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2664 * - encoding: unused
2665 * - decoding: Set by user.
2667 attribute_deprecated int lowres;
2670 * the picture in the bitstream
2671 * - encoding: Set by libavcodec.
2672 * - decoding: Set by libavcodec.
2674 AVFrame *coded_frame;
2678 * is used to decide how many independent tasks should be passed to execute()
2679 * - encoding: Set by user.
2680 * - decoding: Set by user.
2685 * Which multithreading methods to use.
2686 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2687 * so clients which cannot provide future frames should not use it.
2689 * - encoding: Set by user, otherwise the default is used.
2690 * - decoding: Set by user, otherwise the default is used.
2693 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2694 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2697 * Which multithreading methods are in use by the codec.
2698 * - encoding: Set by libavcodec.
2699 * - decoding: Set by libavcodec.
2701 int active_thread_type;
2704 * Set by the client if its custom get_buffer() callback can be called
2705 * synchronously from another thread, which allows faster multithreaded decoding.
2706 * draw_horiz_band() will be called from other threads regardless of this setting.
2707 * Ignored if the default get_buffer() is used.
2708 * - encoding: Set by user.
2709 * - decoding: Set by user.
2711 int thread_safe_callbacks;
2714 * The codec may call this to execute several independent things.
2715 * It will return only after finishing all tasks.
2716 * The user may replace this with some multithreaded implementation,
2717 * the default implementation will execute the parts serially.
2718 * @param count the number of things to execute
2719 * - encoding: Set by libavcodec, user can override.
2720 * - decoding: Set by libavcodec, user can override.
2722 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2725 * The codec may call this to execute several independent things.
2726 * It will return only after finishing all tasks.
2727 * The user may replace this with some multithreaded implementation,
2728 * the default implementation will execute the parts serially.
2729 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2730 * @param c context passed also to func
2731 * @param count the number of things to execute
2732 * @param arg2 argument passed unchanged to func
2733 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2734 * @param func function that will be called count times, with jobnr from 0 to count-1.
2735 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2736 * two instances of func executing at the same time will have the same threadnr.
2737 * @return always 0 currently, but code should handle a future improvement where when any call to func
2738 * returns < 0 no further calls to func may be done and < 0 is returned.
2739 * - encoding: Set by libavcodec, user can override.
2740 * - decoding: Set by libavcodec, user can override.
2742 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2746 * Can be used by execute() to store some per AVCodecContext stuff.
2747 * - encoding: set by execute()
2748 * - decoding: set by execute()
2750 void *thread_opaque;
2753 * noise vs. sse weight for the nsse comparsion function
2754 * - encoding: Set by user.
2755 * - decoding: unused
2761 * - encoding: Set by user.
2762 * - decoding: Set by libavcodec.
2765 #define FF_PROFILE_UNKNOWN -99
2766 #define FF_PROFILE_RESERVED -100
2768 #define FF_PROFILE_AAC_MAIN 0
2769 #define FF_PROFILE_AAC_LOW 1
2770 #define FF_PROFILE_AAC_SSR 2
2771 #define FF_PROFILE_AAC_LTP 3
2772 #define FF_PROFILE_AAC_HE 4
2773 #define FF_PROFILE_AAC_HE_V2 28
2774 #define FF_PROFILE_AAC_LD 22
2775 #define FF_PROFILE_AAC_ELD 38
2777 #define FF_PROFILE_DTS 20
2778 #define FF_PROFILE_DTS_ES 30
2779 #define FF_PROFILE_DTS_96_24 40
2780 #define FF_PROFILE_DTS_HD_HRA 50
2781 #define FF_PROFILE_DTS_HD_MA 60
2783 #define FF_PROFILE_MPEG2_422 0
2784 #define FF_PROFILE_MPEG2_HIGH 1
2785 #define FF_PROFILE_MPEG2_SS 2
2786 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2787 #define FF_PROFILE_MPEG2_MAIN 4
2788 #define FF_PROFILE_MPEG2_SIMPLE 5
2790 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2791 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2793 #define FF_PROFILE_H264_BASELINE 66
2794 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2795 #define FF_PROFILE_H264_MAIN 77
2796 #define FF_PROFILE_H264_EXTENDED 88
2797 #define FF_PROFILE_H264_HIGH 100
2798 #define FF_PROFILE_H264_HIGH_10 110
2799 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2800 #define FF_PROFILE_H264_HIGH_422 122
2801 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2802 #define FF_PROFILE_H264_HIGH_444 144
2803 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2804 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2805 #define FF_PROFILE_H264_CAVLC_444 44
2807 #define FF_PROFILE_VC1_SIMPLE 0
2808 #define FF_PROFILE_VC1_MAIN 1
2809 #define FF_PROFILE_VC1_COMPLEX 2
2810 #define FF_PROFILE_VC1_ADVANCED 3
2812 #define FF_PROFILE_MPEG4_SIMPLE 0
2813 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2814 #define FF_PROFILE_MPEG4_CORE 2
2815 #define FF_PROFILE_MPEG4_MAIN 3
2816 #define FF_PROFILE_MPEG4_N_BIT 4
2817 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2818 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2819 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2820 #define FF_PROFILE_MPEG4_HYBRID 8
2821 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2822 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2823 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2824 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2825 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2826 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2827 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2831 * - encoding: Set by user.
2832 * - decoding: Set by libavcodec.
2835 #define FF_LEVEL_UNKNOWN -99
2839 * - encoding: unused
2840 * - decoding: Set by user.
2842 enum AVDiscard skip_loop_filter;
2846 * - encoding: unused
2847 * - decoding: Set by user.
2849 enum AVDiscard skip_idct;
2853 * - encoding: unused
2854 * - decoding: Set by user.
2856 enum AVDiscard skip_frame;
2859 * Header containing style information for text subtitles.
2860 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2861 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2862 * the Format line following. It shouldn't include any Dialogue line.
2863 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2864 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2866 uint8_t *subtitle_header;
2867 int subtitle_header_size;
2870 * Simulates errors in the bitstream to test error concealment.
2871 * - encoding: Set by user.
2872 * - decoding: unused
2877 * Current packet as passed into the decoder, to avoid having
2878 * to pass the packet into every function. Currently only valid
2879 * inside lavc and get/release_buffer callbacks.
2880 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2881 * - encoding: unused
2886 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2887 * Used for compliant TS muxing.
2888 * - encoding: Set by libavcodec.
2889 * - decoding: unused.
2897 typedef struct AVProfile {
2899 const char *name; ///< short name for the profile
2902 typedef struct AVCodecDefault AVCodecDefault;
2907 typedef struct AVCodec {
2909 * Name of the codec implementation.
2910 * The name is globally unique among encoders and among decoders (but an
2911 * encoder and a decoder can share the same name).
2912 * This is the primary way to find a codec from the user perspective.
2916 * Descriptive name for the codec, meant to be more human readable than name.
2917 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2919 const char *long_name;
2920 enum AVMediaType type;
2923 * Codec capabilities.
2927 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2928 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2929 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2930 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2931 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2932 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2933 const AVClass *priv_class; ///< AVClass for the private context
2934 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2936 /*****************************************************************
2937 * No fields below this line are part of the public API. They
2938 * may not be used outside of libavcodec and can be changed and
2940 * New public fields should be added right above.
2941 *****************************************************************
2944 struct AVCodec *next;
2946 * @name Frame-level threading support functions
2950 * If defined, called on thread contexts when they are created.
2951 * If the codec allocates writable tables in init(), re-allocate them here.
2952 * priv_data will be set to a copy of the original.
2954 int (*init_thread_copy)(AVCodecContext *);
2956 * Copy necessary context variables from a previous thread context to the current one.
2957 * If not defined, the next thread will start automatically; otherwise, the codec
2958 * must call ff_thread_finish_setup().
2960 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2962 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2966 * Private codec-specific defaults.
2968 const AVCodecDefault *defaults;
2971 * Initialize codec static data, called from avcodec_register().
2973 void (*init_static_data)(struct AVCodec *codec);
2975 int (*init)(AVCodecContext *);
2976 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2978 * Encode data to an AVPacket.
2980 * @param avctx codec context
2981 * @param avpkt output AVPacket (may contain a user-provided buffer)
2982 * @param[in] frame AVFrame containing the raw data to be encoded
2983 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2984 * non-empty packet was returned in avpkt.
2985 * @return 0 on success, negative error code on failure
2987 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2988 int *got_packet_ptr);
2989 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2990 int (*close)(AVCodecContext *);
2993 * Will be called when seeking
2995 void (*flush)(AVCodecContext *);
3001 typedef struct AVHWAccel {
3003 * Name of the hardware accelerated codec.
3004 * The name is globally unique among encoders and among decoders (but an
3005 * encoder and a decoder can share the same name).
3010 * Type of codec implemented by the hardware accelerator.
3012 * See AVMEDIA_TYPE_xxx
3014 enum AVMediaType type;
3017 * Codec implemented by the hardware accelerator.
3019 * See AV_CODEC_ID_xxx
3024 * Supported pixel format.
3026 * Only hardware accelerated formats are supported here.
3028 enum PixelFormat pix_fmt;
3031 * Hardware accelerated codec capabilities.
3032 * see FF_HWACCEL_CODEC_CAP_*
3036 struct AVHWAccel *next;
3039 * Called at the beginning of each frame or field picture.
3041 * Meaningful frame information (codec specific) is guaranteed to
3042 * be parsed at this point. This function is mandatory.
3044 * Note that buf can be NULL along with buf_size set to 0.
3045 * Otherwise, this means the whole frame is available at this point.
3047 * @param avctx the codec context
3048 * @param buf the frame data buffer base
3049 * @param buf_size the size of the frame in bytes
3050 * @return zero if successful, a negative value otherwise
3052 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3055 * Callback for each slice.
3057 * Meaningful slice information (codec specific) is guaranteed to
3058 * be parsed at this point. This function is mandatory.
3060 * @param avctx the codec context
3061 * @param buf the slice data buffer base
3062 * @param buf_size the size of the slice in bytes
3063 * @return zero if successful, a negative value otherwise
3065 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3068 * Called at the end of each frame or field picture.
3070 * The whole picture is parsed at this point and can now be sent
3071 * to the hardware accelerator. This function is mandatory.
3073 * @param avctx the codec context
3074 * @return zero if successful, a negative value otherwise
3076 int (*end_frame)(AVCodecContext *avctx);
3079 * Size of HW accelerator private data.
3081 * Private data is allocated with av_mallocz() before
3082 * AVCodecContext.get_buffer() and deallocated after
3083 * AVCodecContext.release_buffer().
3089 * @defgroup lavc_picture AVPicture
3091 * Functions for working with AVPicture
3096 * four components are given, that's all.
3097 * the last component is alpha
3099 typedef struct AVPicture {
3100 uint8_t *data[AV_NUM_DATA_POINTERS];
3101 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3108 #define AVPALETTE_SIZE 1024
3109 #define AVPALETTE_COUNT 256
3111 enum AVSubtitleType {
3114 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3117 * Plain text, the text field must be set by the decoder and is
3118 * authoritative. ass and pict fields may contain approximations.
3123 * Formatted text, the ass field must be set by the decoder and is
3124 * authoritative. pict and text fields may contain approximations.
3129 typedef struct AVSubtitleRect {
3130 int x; ///< top left corner of pict, undefined when pict is not set
3131 int y; ///< top left corner of pict, undefined when pict is not set
3132 int w; ///< width of pict, undefined when pict is not set
3133 int h; ///< height of pict, undefined when pict is not set
3134 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3137 * data+linesize for the bitmap of this subtitle.
3138 * can be set for text/ass as well once they where rendered
3141 enum AVSubtitleType type;
3143 char *text; ///< 0 terminated plain UTF-8 text
3146 * 0 terminated ASS/SSA compatible event line.
3147 * The pressentation of this is unaffected by the other values in this
3153 typedef struct AVSubtitle {
3154 uint16_t format; /* 0 = graphics */
3155 uint32_t start_display_time; /* relative to packet pts, in ms */
3156 uint32_t end_display_time; /* relative to packet pts, in ms */
3158 AVSubtitleRect **rects;
3159 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3163 * If c is NULL, returns the first registered codec,
3164 * if c is non-NULL, returns the next registered codec after c,
3165 * or NULL if c is the last one.
3167 AVCodec *av_codec_next(const AVCodec *c);
3170 * Return the LIBAVCODEC_VERSION_INT constant.
3172 unsigned avcodec_version(void);
3175 * Return the libavcodec build-time configuration.
3177 const char *avcodec_configuration(void);
3180 * Return the libavcodec license.
3182 const char *avcodec_license(void);
3185 * Register the codec codec and initialize libavcodec.
3187 * @warning either this function or avcodec_register_all() must be called
3188 * before any other libavcodec functions.
3190 * @see avcodec_register_all()
3192 void avcodec_register(AVCodec *codec);
3195 * Register all the codecs, parsers and bitstream filters which were enabled at
3196 * configuration time. If you do not call this function you can select exactly
3197 * which formats you want to support, by using the individual registration
3200 * @see avcodec_register
3201 * @see av_register_codec_parser
3202 * @see av_register_bitstream_filter
3204 void avcodec_register_all(void);
3207 * Allocate an AVCodecContext and set its fields to default values. The
3208 * resulting struct can be deallocated by calling avcodec_close() on it followed
3211 * @param codec if non-NULL, allocate private data and initialize defaults
3212 * for the given codec. It is illegal to then call avcodec_open2()
3213 * with a different codec.
3214 * If NULL, then the codec-specific defaults won't be initialized,
3215 * which may result in suboptimal default settings (this is
3216 * important mainly for encoders, e.g. libx264).
3218 * @return An AVCodecContext filled with default values or NULL on failure.
3219 * @see avcodec_get_context_defaults
3221 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3224 * Set the fields of the given AVCodecContext to default values corresponding
3225 * to the given codec (defaults may be codec-dependent).
3227 * Do not call this function if a non-NULL codec has been passed
3228 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3229 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3230 * different codec on this AVCodecContext.
3232 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3235 * Get the AVClass for AVCodecContext. It can be used in combination with
3236 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3238 * @see av_opt_find().
3240 const AVClass *avcodec_get_class(void);
3243 * Copy the settings of the source AVCodecContext into the destination
3244 * AVCodecContext. The resulting destination codec context will be
3245 * unopened, i.e. you are required to call avcodec_open2() before you
3246 * can use this AVCodecContext to decode/encode video/audio data.
3248 * @param dest target codec context, should be initialized with
3249 * avcodec_alloc_context3(), but otherwise uninitialized
3250 * @param src source codec context
3251 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3253 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3256 * Allocate an AVFrame and set its fields to default values. The resulting
3257 * struct can be deallocated by simply calling av_free().
3259 * @return An AVFrame filled with default values or NULL on failure.
3260 * @see avcodec_get_frame_defaults
3262 AVFrame *avcodec_alloc_frame(void);
3265 * Set the fields of the given AVFrame to default values.
3267 * @param pic The AVFrame of which the fields should be set to default values.
3269 void avcodec_get_frame_defaults(AVFrame *pic);
3272 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3273 * function the context has to be allocated with avcodec_alloc_context3().
3275 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3276 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3277 * retrieving a codec.
3279 * @warning This function is not thread safe!
3282 * avcodec_register_all();
3283 * av_dict_set(&opts, "b", "2.5M", 0);
3284 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3288 * context = avcodec_alloc_context3(codec);
3290 * if (avcodec_open2(context, codec, opts) < 0)
3294 * @param avctx The context to initialize.
3295 * @param codec The codec to open this context for. If a non-NULL codec has been
3296 * previously passed to avcodec_alloc_context3() or
3297 * avcodec_get_context_defaults3() for this context, then this
3298 * parameter MUST be either NULL or equal to the previously passed
3300 * @param options A dictionary filled with AVCodecContext and codec-private options.
3301 * On return this object will be filled with options that were not found.
3303 * @return zero on success, a negative value on error
3304 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3305 * av_dict_set(), av_opt_find().
3307 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3310 * Close a given AVCodecContext and free all the data associated with it
3311 * (but not the AVCodecContext itself).
3313 * Calling this function on an AVCodecContext that hasn't been opened will free
3314 * the codec-specific data allocated in avcodec_alloc_context3() /
3315 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3318 int avcodec_close(AVCodecContext *avctx);
3321 * Free all allocated data in the given subtitle struct.
3323 * @param sub AVSubtitle to free.
3325 void avsubtitle_free(AVSubtitle *sub);
3332 * @addtogroup lavc_packet
3337 * Default packet destructor.
3339 void av_destruct_packet(AVPacket *pkt);
3342 * Initialize optional fields of a packet with default values.
3344 * Note, this does not touch the data and size members, which have to be
3345 * initialized separately.
3349 void av_init_packet(AVPacket *pkt);
3352 * Allocate the payload of a packet and initialize its fields with
3356 * @param size wanted payload size
3357 * @return 0 if OK, AVERROR_xxx otherwise
3359 int av_new_packet(AVPacket *pkt, int size);
3362 * Reduce packet size, correctly zeroing padding
3365 * @param size new size
3367 void av_shrink_packet(AVPacket *pkt, int size);
3370 * Increase packet size, correctly zeroing padding
3373 * @param grow_by number of bytes by which to increase the size of the packet
3375 int av_grow_packet(AVPacket *pkt, int grow_by);
3378 * @warning This is a hack - the packet memory allocation stuff is broken. The
3379 * packet is allocated if it was not really allocated.
3381 int av_dup_packet(AVPacket *pkt);
3386 * @param pkt packet to free
3388 void av_free_packet(AVPacket *pkt);
3391 * Allocate new information of a packet.
3394 * @param type side information type
3395 * @param size side information size
3396 * @return pointer to fresh allocated data or NULL otherwise
3398 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3402 * Shrink the already allocated side data buffer
3405 * @param type side information type
3406 * @param size new side information size
3407 * @return 0 on success, < 0 on failure
3409 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3413 * Get side information from packet.
3416 * @param type desired side information type
3417 * @param size pointer for side information size to store (optional)
3418 * @return pointer to data if present or NULL otherwise
3420 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3428 * @addtogroup lavc_decoding
3433 * Find a registered decoder with a matching codec ID.
3435 * @param id AVCodecID of the requested decoder
3436 * @return A decoder if one was found, NULL otherwise.
3438 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3441 * Find a registered decoder with the specified name.
3443 * @param name name of the requested decoder
3444 * @return A decoder if one was found, NULL otherwise.
3446 AVCodec *avcodec_find_decoder_by_name(const char *name);
3448 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3449 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3450 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3453 * Return the amount of padding in pixels which the get_buffer callback must
3454 * provide around the edge of the image for codecs which do not have the
3455 * CODEC_FLAG_EMU_EDGE flag.
3457 * @return Required padding in pixels.
3459 unsigned avcodec_get_edge_width(void);
3462 * Modify width and height values so that they will result in a memory
3463 * buffer that is acceptable for the codec if you do not use any horizontal
3466 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3467 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3468 * according to avcodec_get_edge_width() before.
3470 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3473 * Modify width and height values so that they will result in a memory
3474 * buffer that is acceptable for the codec if you also ensure that all
3475 * line sizes are a multiple of the respective linesize_align[i].
3477 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3478 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3479 * according to avcodec_get_edge_width() before.
3481 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3482 int linesize_align[AV_NUM_DATA_POINTERS]);
3484 #if FF_API_OLD_DECODE_AUDIO
3486 * Wrapper function which calls avcodec_decode_audio4.
3488 * @deprecated Use avcodec_decode_audio4 instead.
3490 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3491 * Some decoders may support multiple frames in a single AVPacket, such
3492 * decoders would then just decode the first frame. In this case,
3493 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3494 * the remaining data in order to decode the second frame etc.
3496 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3497 * decompressed frame size in bytes.
3499 * @warning You must set frame_size_ptr to the allocated size of the
3500 * output buffer before calling avcodec_decode_audio3().
3502 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3503 * the actual read bytes because some optimized bitstream readers read 32 or 64
3504 * bits at once and could read over the end.
3506 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3507 * no overreading happens for damaged MPEG streams.
3509 * @warning You must not provide a custom get_buffer() when using
3510 * avcodec_decode_audio3(). Doing so will override it with
3511 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3512 * which does allow the application to provide a custom get_buffer().
3514 * @note You might have to align the input buffer avpkt->data and output buffer
3515 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3516 * necessary at all, on others it won't work at all if not aligned and on others
3517 * it will work but it will have an impact on performance.
3519 * In practice, avpkt->data should have 4 byte alignment at minimum and
3520 * samples should be 16 byte aligned unless the CPU doesn't need it
3521 * (AltiVec and SSE do).
3523 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3524 * between input and output, these need to be fed with avpkt->data=NULL,
3525 * avpkt->size=0 at the end to return the remaining frames.
3527 * @param avctx the codec context
3528 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3529 * If the sample format is planar, each channel plane will
3530 * be the same size, with no padding between channels.
3531 * @param[in,out] frame_size_ptr the output buffer size in bytes
3532 * @param[in] avpkt The input AVPacket containing the input buffer.
3533 * You can create such packet with av_init_packet() and by then setting
3534 * data and size, some decoders might in addition need other fields.
3535 * All decoders are designed to use the least fields possible though.
3536 * @return On error a negative value is returned, otherwise the number of bytes
3537 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3539 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3540 int *frame_size_ptr,
3545 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3547 * Some decoders may support multiple frames in a single AVPacket. Such
3548 * decoders would then just decode the first frame. In this case,
3549 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3550 * the remaining data in order to decode the second frame, etc...
3551 * Even if no frames are returned, the packet needs to be fed to the decoder
3552 * with remaining data until it is completely consumed or an error occurs.
3554 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3555 * larger than the actual read bytes because some optimized bitstream
3556 * readers read 32 or 64 bits at once and could read over the end.
3558 * @note You might have to align the input buffer. The alignment requirements
3559 * depend on the CPU and the decoder.
3561 * @param avctx the codec context
3562 * @param[out] frame The AVFrame in which to store decoded audio samples.
3563 * Decoders request a buffer of a particular size by setting
3564 * AVFrame.nb_samples prior to calling get_buffer(). The
3565 * decoder may, however, only utilize part of the buffer by
3566 * setting AVFrame.nb_samples to a smaller value in the
3568 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3570 * @param[in] avpkt The input AVPacket containing the input buffer.
3571 * At least avpkt->data and avpkt->size should be set. Some
3572 * decoders might also require additional fields to be set.
3573 * @return A negative error code is returned if an error occurred during
3574 * decoding, otherwise the number of bytes consumed from the input
3575 * AVPacket is returned.
3577 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3578 int *got_frame_ptr, AVPacket *avpkt);
3581 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3582 * Some decoders may support multiple frames in a single AVPacket, such
3583 * decoders would then just decode the first frame.
3585 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3586 * the actual read bytes because some optimized bitstream readers read 32 or 64
3587 * bits at once and could read over the end.
3589 * @warning The end of the input buffer buf should be set to 0 to ensure that
3590 * no overreading happens for damaged MPEG streams.
3592 * @note You might have to align the input buffer avpkt->data.
3593 * The alignment requirements depend on the CPU: on some CPUs it isn't
3594 * necessary at all, on others it won't work at all if not aligned and on others
3595 * it will work but it will have an impact on performance.
3597 * In practice, avpkt->data should have 4 byte alignment at minimum.
3599 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3600 * between input and output, these need to be fed with avpkt->data=NULL,
3601 * avpkt->size=0 at the end to return the remaining frames.
3603 * @param avctx the codec context
3604 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3605 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3606 * allocate memory for the actual bitmap.
3607 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3608 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3609 * decodes and the decoder tells the user once it does not need the data anymore,
3610 * the user app can at this point free/reuse/keep the memory as it sees fit.
3612 * @param[in] avpkt The input AVpacket containing the input buffer.
3613 * You can create such packet with av_init_packet() and by then setting
3614 * data and size, some decoders might in addition need other fields like
3615 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3617 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3618 * @return On error a negative value is returned, otherwise the number of bytes
3619 * used or zero if no frame could be decompressed.
3621 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3622 int *got_picture_ptr,
3626 * Decode a subtitle message.
3627 * Return a negative value on error, otherwise return the number of bytes used.
3628 * If no subtitle could be decompressed, got_sub_ptr is zero.
3629 * Otherwise, the subtitle is stored in *sub.
3630 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3631 * simplicity, because the performance difference is expect to be negligible
3632 * and reusing a get_buffer written for video codecs would probably perform badly
3633 * due to a potentially very different allocation pattern.
3635 * @param avctx the codec context
3636 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3637 freed with avsubtitle_free if *got_sub_ptr is set.
3638 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3639 * @param[in] avpkt The input AVPacket containing the input buffer.
3641 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3646 * @defgroup lavc_parsing Frame parsing
3650 typedef struct AVCodecParserContext {
3652 struct AVCodecParser *parser;
3653 int64_t frame_offset; /* offset of the current frame */
3654 int64_t cur_offset; /* current offset
3655 (incremented by each av_parser_parse()) */
3656 int64_t next_frame_offset; /* offset of the next frame */
3658 int pict_type; /* XXX: Put it back in AVCodecContext. */
3660 * This field is used for proper frame duration computation in lavf.
3661 * It signals, how much longer the frame duration of the current frame
3662 * is compared to normal frame duration.
3664 * frame_duration = (1 + repeat_pict) * time_base
3666 * It is used by codecs like H.264 to display telecined material.
3668 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3669 int64_t pts; /* pts of the current frame */
3670 int64_t dts; /* dts of the current frame */
3675 int fetch_timestamp;
3677 #define AV_PARSER_PTS_NB 4
3678 int cur_frame_start_index;
3679 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3680 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3681 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3684 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3685 #define PARSER_FLAG_ONCE 0x0002
3686 /// Set if the parser has a valid file offset
3687 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3689 int64_t offset; ///< byte offset from starting packet start
3690 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3693 * Set by parser to 1 for key frames and 0 for non-key frames.
3694 * It is initialized to -1, so if the parser doesn't set this flag,
3695 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3701 * Time difference in stream time base units from the pts of this
3702 * packet to the point at which the output from the decoder has converged
3703 * independent from the availability of previous frames. That is, the
3704 * frames are virtually identical no matter if decoding started from
3705 * the very first frame or from this keyframe.
3706 * Is AV_NOPTS_VALUE if unknown.
3707 * This field is not the display duration of the current frame.
3708 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3711 * The purpose of this field is to allow seeking in streams that have no
3712 * keyframes in the conventional sense. It corresponds to the
3713 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3714 * essential for some types of subtitle streams to ensure that all
3715 * subtitles are correctly displayed after seeking.
3717 int64_t convergence_duration;
3719 // Timestamp generation support:
3721 * Synchronization point for start of timestamp generation.
3723 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3726 * For example, this corresponds to presence of H.264 buffering period
3732 * Offset of the current timestamp against last timestamp sync point in
3733 * units of AVCodecContext.time_base.
3735 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3736 * contain a valid timestamp offset.
3738 * Note that the timestamp of sync point has usually a nonzero
3739 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3740 * the next frame after timestamp sync point will be usually 1.
3742 * For example, this corresponds to H.264 cpb_removal_delay.
3744 int dts_ref_dts_delta;
3747 * Presentation delay of current frame in units of AVCodecContext.time_base.
3749 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3750 * contain valid non-negative timestamp delta (presentation time of a frame
3751 * must not lie in the past).
3753 * This delay represents the difference between decoding and presentation
3754 * time of the frame.
3756 * For example, this corresponds to H.264 dpb_output_delay.
3761 * Position of the packet in file.
3763 * Analogous to cur_frame_pts/dts
3765 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3768 * Byte position of currently parsed frame in stream.
3773 * Previous frame byte position.
3778 * Duration of the current frame.
3779 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3780 * For all other types, this is in units of AVCodecContext.time_base.
3783 } AVCodecParserContext;
3785 typedef struct AVCodecParser {
3786 int codec_ids[5]; /* several codec IDs are permitted */
3788 int (*parser_init)(AVCodecParserContext *s);
3789 int (*parser_parse)(AVCodecParserContext *s,
3790 AVCodecContext *avctx,
3791 const uint8_t **poutbuf, int *poutbuf_size,
3792 const uint8_t *buf, int buf_size);
3793 void (*parser_close)(AVCodecParserContext *s);
3794 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3795 struct AVCodecParser *next;
3798 AVCodecParser *av_parser_next(AVCodecParser *c);
3800 void av_register_codec_parser(AVCodecParser *parser);
3801 AVCodecParserContext *av_parser_init(int codec_id);
3806 * @param s parser context.
3807 * @param avctx codec context.
3808 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3809 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3810 * @param buf input buffer.
3811 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3812 * @param pts input presentation timestamp.
3813 * @param dts input decoding timestamp.
3814 * @param pos input byte position in stream.
3815 * @return the number of bytes of the input bitstream used.
3820 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3827 * decode_frame(data, size);
3831 int av_parser_parse2(AVCodecParserContext *s,
3832 AVCodecContext *avctx,
3833 uint8_t **poutbuf, int *poutbuf_size,
3834 const uint8_t *buf, int buf_size,
3835 int64_t pts, int64_t dts,
3838 int av_parser_change(AVCodecParserContext *s,
3839 AVCodecContext *avctx,
3840 uint8_t **poutbuf, int *poutbuf_size,
3841 const uint8_t *buf, int buf_size, int keyframe);
3842 void av_parser_close(AVCodecParserContext *s);
3850 * @addtogroup lavc_encoding
3855 * Find a registered encoder with a matching codec ID.
3857 * @param id AVCodecID of the requested encoder
3858 * @return An encoder if one was found, NULL otherwise.
3860 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3863 * Find a registered encoder with the specified name.
3865 * @param name name of the requested encoder
3866 * @return An encoder if one was found, NULL otherwise.
3868 AVCodec *avcodec_find_encoder_by_name(const char *name);
3870 #if FF_API_OLD_ENCODE_AUDIO
3872 * Encode an audio frame from samples into buf.
3874 * @deprecated Use avcodec_encode_audio2 instead.
3876 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3877 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3878 * will know how much space is needed because it depends on the value passed
3879 * in buf_size as described below. In that case a lower value can be used.
3881 * @param avctx the codec context
3882 * @param[out] buf the output buffer
3883 * @param[in] buf_size the output buffer size
3884 * @param[in] samples the input buffer containing the samples
3885 * The number of samples read from this buffer is frame_size*channels,
3886 * both of which are defined in avctx.
3887 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3888 * samples read from samples is equal to:
3889 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3890 * This also implies that av_get_bits_per_sample() must not return 0 for these
3892 * @return On error a negative value is returned, on success zero or the number
3893 * of bytes used to encode the data read from the input buffer.
3895 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3896 uint8_t *buf, int buf_size,
3897 const short *samples);
3901 * Encode a frame of audio.
3903 * Takes input samples from frame and writes the next output packet, if
3904 * available, to avpkt. The output packet does not necessarily contain data for
3905 * the most recent frame, as encoders can delay, split, and combine input frames
3906 * internally as needed.
3908 * @param avctx codec context
3909 * @param avpkt output AVPacket.
3910 * The user can supply an output buffer by setting
3911 * avpkt->data and avpkt->size prior to calling the
3912 * function, but if the size of the user-provided data is not
3913 * large enough, encoding will fail. All other AVPacket fields
3914 * will be reset by the encoder using av_init_packet(). If
3915 * avpkt->data is NULL, the encoder will allocate it.
3916 * The encoder will set avpkt->size to the size of the
3919 * If this function fails or produces no output, avpkt will be
3920 * freed using av_free_packet() (i.e. avpkt->destruct will be
3921 * called to free the user supplied buffer).
3922 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3923 * May be NULL when flushing an encoder that has the
3924 * CODEC_CAP_DELAY capability set.
3925 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3926 * can have any number of samples.
3927 * If it is not set, frame->nb_samples must be equal to
3928 * avctx->frame_size for all frames except the last.
3929 * The final frame may be smaller than avctx->frame_size.
3930 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3931 * output packet is non-empty, and to 0 if it is
3932 * empty. If the function returns an error, the
3933 * packet can be assumed to be invalid, and the
3934 * value of got_packet_ptr is undefined and should
3936 * @return 0 on success, negative error code on failure
3938 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3939 const AVFrame *frame, int *got_packet_ptr);
3941 #if FF_API_OLD_ENCODE_VIDEO
3943 * @deprecated use avcodec_encode_video2() instead.
3945 * Encode a video frame from pict into buf.
3946 * The input picture should be
3947 * stored using a specific format, namely avctx.pix_fmt.
3949 * @param avctx the codec context
3950 * @param[out] buf the output buffer for the bitstream of encoded frame
3951 * @param[in] buf_size the size of the output buffer in bytes
3952 * @param[in] pict the input picture to encode
3953 * @return On error a negative value is returned, on success zero or the number
3954 * of bytes used from the output buffer.
3956 attribute_deprecated
3957 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3958 const AVFrame *pict);
3962 * Encode a frame of video.
3964 * Takes input raw video data from frame and writes the next output packet, if
3965 * available, to avpkt. The output packet does not necessarily contain data for
3966 * the most recent frame, as encoders can delay and reorder input frames
3967 * internally as needed.
3969 * @param avctx codec context
3970 * @param avpkt output AVPacket.
3971 * The user can supply an output buffer by setting
3972 * avpkt->data and avpkt->size prior to calling the
3973 * function, but if the size of the user-provided data is not
3974 * large enough, encoding will fail. All other AVPacket fields
3975 * will be reset by the encoder using av_init_packet(). If
3976 * avpkt->data is NULL, the encoder will allocate it.
3977 * The encoder will set avpkt->size to the size of the
3978 * output packet. The returned data (if any) belongs to the
3979 * caller, he is responsible for freeing it.
3981 * If this function fails or produces no output, avpkt will be
3982 * freed using av_free_packet() (i.e. avpkt->destruct will be
3983 * called to free the user supplied buffer).
3984 * @param[in] frame AVFrame containing the raw video data to be encoded.
3985 * May be NULL when flushing an encoder that has the
3986 * CODEC_CAP_DELAY capability set.
3987 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3988 * output packet is non-empty, and to 0 if it is
3989 * empty. If the function returns an error, the
3990 * packet can be assumed to be invalid, and the
3991 * value of got_packet_ptr is undefined and should
3993 * @return 0 on success, negative error code on failure
3995 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3996 const AVFrame *frame, int *got_packet_ptr);
3998 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3999 const AVSubtitle *sub);
4007 * @defgroup lavc_resample Audio resampling
4012 struct ReSampleContext;
4013 struct AVResampleContext;
4015 typedef struct ReSampleContext ReSampleContext;
4018 * Initialize audio resampling context.
4020 * @param output_channels number of output channels
4021 * @param input_channels number of input channels
4022 * @param output_rate output sample rate
4023 * @param input_rate input sample rate
4024 * @param sample_fmt_out requested output sample format
4025 * @param sample_fmt_in input sample format
4026 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4027 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4028 * @param linear if 1 then the used FIR filter will be linearly interpolated
4029 between the 2 closest, if 0 the closest will be used
4030 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4031 * @return allocated ReSampleContext, NULL if error occurred
4033 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4034 int output_rate, int input_rate,
4035 enum AVSampleFormat sample_fmt_out,
4036 enum AVSampleFormat sample_fmt_in,
4037 int filter_length, int log2_phase_count,
4038 int linear, double cutoff);
4040 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4043 * Free resample context.
4045 * @param s a non-NULL pointer to a resample context previously
4046 * created with av_audio_resample_init()
4048 void audio_resample_close(ReSampleContext *s);
4052 * Initialize an audio resampler.
4053 * Note, if either rate is not an integer then simply scale both rates up so they are.
4054 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4055 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4056 * @param linear If 1 then the used FIR filter will be linearly interpolated
4057 between the 2 closest, if 0 the closest will be used
4058 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4060 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4063 * Resample an array of samples using a previously configured context.
4064 * @param src an array of unconsumed samples
4065 * @param consumed the number of samples of src which have been consumed are returned here
4066 * @param src_size the number of unconsumed samples available
4067 * @param dst_size the amount of space in samples available in dst
4068 * @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.
4069 * @return the number of samples written in dst or -1 if an error occurred
4071 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4075 * Compensate samplerate/timestamp drift. The compensation is done by changing
4076 * the resampler parameters, so no audible clicks or similar distortions occur
4077 * @param compensation_distance distance in output samples over which the compensation should be performed
4078 * @param sample_delta number of output samples which should be output less
4080 * example: av_resample_compensate(c, 10, 500)
4081 * here instead of 510 samples only 500 samples would be output
4083 * note, due to rounding the actual compensation might be slightly different,
4084 * especially if the compensation_distance is large and the in_rate used during init is small
4086 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4087 void av_resample_close(struct AVResampleContext *c);
4094 * @addtogroup lavc_picture
4099 * Allocate memory for a picture. Call avpicture_free() to free it.
4101 * @see avpicture_fill()
4103 * @param picture the picture to be filled in
4104 * @param pix_fmt the format of the picture
4105 * @param width the width of the picture
4106 * @param height the height of the picture
4107 * @return zero if successful, a negative value if not
4109 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4112 * Free a picture previously allocated by avpicture_alloc().
4113 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4116 * @param picture the AVPicture to be freed
4118 void avpicture_free(AVPicture *picture);
4121 * Fill in the AVPicture fields.
4122 * The fields of the given AVPicture are filled in by using the 'ptr' address
4123 * which points to the image data buffer. Depending on the specified picture
4124 * format, one or multiple image data pointers and line sizes will be set.
4125 * If a planar format is specified, several pointers will be set pointing to
4126 * the different picture planes and the line sizes of the different planes
4127 * will be stored in the lines_sizes array.
4128 * Call with ptr == NULL to get the required size for the ptr buffer.
4130 * To allocate the buffer and fill in the AVPicture fields in one call,
4131 * use avpicture_alloc().
4133 * @param picture AVPicture whose fields are to be filled in
4134 * @param ptr Buffer which will contain or contains the actual image data
4135 * @param pix_fmt The format in which the picture data is stored.
4136 * @param width the width of the image in pixels
4137 * @param height the height of the image in pixels
4138 * @return size of the image data in bytes
4140 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4141 enum PixelFormat pix_fmt, int width, int height);
4144 * Copy pixel data from an AVPicture into a buffer.
4145 * The data is stored compactly, without any gaps for alignment or padding
4146 * which may be applied by avpicture_fill().
4148 * @see avpicture_get_size()
4150 * @param[in] src AVPicture containing image data
4151 * @param[in] pix_fmt The format in which the picture data is stored.
4152 * @param[in] width the width of the image in pixels.
4153 * @param[in] height the height of the image in pixels.
4154 * @param[out] dest A buffer into which picture data will be copied.
4155 * @param[in] dest_size The size of 'dest'.
4156 * @return The number of bytes written to dest, or a negative value (error code) on error.
4158 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4159 unsigned char *dest, int dest_size);
4162 * Calculate the size in bytes that a picture of the given width and height
4163 * would occupy if stored in the given picture format.
4164 * Note that this returns the size of a compact representation as generated
4165 * by avpicture_layout(), which can be smaller than the size required for e.g.
4168 * @param pix_fmt the given picture format
4169 * @param width the width of the image
4170 * @param height the height of the image
4171 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4173 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4176 * deinterlace - if not supported return -1
4178 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4179 enum PixelFormat pix_fmt, int width, int height);
4181 * Copy image src to dst. Wraps av_picture_data_copy() above.
4183 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4184 enum PixelFormat pix_fmt, int width, int height);
4187 * Crop image top and left side.
4189 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4190 enum PixelFormat pix_fmt, int top_band, int left_band);
4195 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4196 int padtop, int padbottom, int padleft, int padright, int *color);
4203 * @defgroup lavc_misc Utility functions
4206 * Miscellaneous utility functions related to both encoding and decoding
4212 * @defgroup lavc_misc_pixfmt Pixel formats
4214 * Functions for working with pixel formats.
4218 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4221 * Return a value representing the fourCC code associated to the
4222 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4225 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4227 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4228 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4229 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4230 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4231 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4232 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4235 * Compute what kind of losses will occur when converting from one specific
4236 * pixel format to another.
4237 * When converting from one pixel format to another, information loss may occur.
4238 * For example, when converting from RGB24 to GRAY, the color information will
4239 * be lost. Similarly, other losses occur when converting from some formats to
4240 * other formats. These losses can involve loss of chroma, but also loss of
4241 * resolution, loss of color depth, loss due to the color space conversion, loss
4242 * of the alpha bits or loss due to color quantization.
4243 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4244 * which will occur when converting from one pixel format to another.
4246 * @param[in] dst_pix_fmt destination pixel format
4247 * @param[in] src_pix_fmt source pixel format
4248 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4249 * @return Combination of flags informing you what kind of losses will occur.
4251 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4254 #if FF_API_FIND_BEST_PIX_FMT
4256 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4258 * Find the best pixel format to convert to given a certain source pixel
4259 * format. When converting from one pixel format to another, information loss
4260 * may occur. For example, when converting from RGB24 to GRAY, the color
4261 * information will be lost. Similarly, other losses occur when converting from
4262 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4263 * the given pixel formats should be used to suffer the least amount of loss.
4264 * The pixel formats from which it chooses one, are determined by the
4265 * pix_fmt_mask parameter.
4268 * src_pix_fmt = PIX_FMT_YUV420P;
4269 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
4270 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4273 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4274 * @param[in] src_pix_fmt source pixel format
4275 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4276 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4277 * @return The best pixel format to convert to or -1 if none was found.
4279 attribute_deprecated
4280 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4281 int has_alpha, int *loss_ptr);
4282 #endif /* FF_API_FIND_BEST_PIX_FMT */
4285 * Find the best pixel format to convert to given a certain source pixel
4286 * format. When converting from one pixel format to another, information loss
4287 * may occur. For example, when converting from RGB24 to GRAY, the color
4288 * information will be lost. Similarly, other losses occur when converting from
4289 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4290 * the given pixel formats should be used to suffer the least amount of loss.
4291 * The pixel formats from which it chooses one, are determined by the
4292 * pix_fmt_list parameter.
4295 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4296 * @param[in] src_pix_fmt source pixel format
4297 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4298 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4299 * @return The best pixel format to convert to or -1 if none was found.
4301 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat *pix_fmt_list,
4302 enum PixelFormat src_pix_fmt,
4303 int has_alpha, int *loss_ptr);
4305 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4311 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4314 * Put a string representing the codec tag codec_tag in buf.
4316 * @param buf_size size in bytes of buf
4317 * @return the length of the string that would have been generated if
4318 * enough space had been available, excluding the trailing null
4320 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4322 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4325 * Return a name for the specified profile, if available.
4327 * @param codec the codec that is searched for the given profile
4328 * @param profile the profile value for which a name is requested
4329 * @return A name for the profile if found, NULL otherwise.
4331 const char *av_get_profile_name(const AVCodec *codec, int profile);
4333 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4334 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4335 //FIXME func typedef
4338 * Fill audio frame data and linesize.
4339 * AVFrame extended_data channel pointers are allocated if necessary for
4342 * @param frame the AVFrame
4343 * frame->nb_samples must be set prior to calling the
4344 * function. This function fills in frame->data,
4345 * frame->extended_data, frame->linesize[0].
4346 * @param nb_channels channel count
4347 * @param sample_fmt sample format
4348 * @param buf buffer to use for frame data
4349 * @param buf_size size of buffer
4350 * @param align plane size sample alignment (0 = default)
4351 * @return 0 on success, negative error code on failure
4353 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4354 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4355 int buf_size, int align);
4358 * Flush buffers, should be called when seeking or when switching to a different stream.
4360 void avcodec_flush_buffers(AVCodecContext *avctx);
4362 void avcodec_default_free_buffers(AVCodecContext *s);
4365 * Return codec bits per sample.
4367 * @param[in] codec_id the codec
4368 * @return Number of bits per sample or zero if unknown for the given codec.
4370 int av_get_bits_per_sample(enum AVCodecID codec_id);
4373 * Return codec bits per sample.
4374 * Only return non-zero if the bits per sample is exactly correct, not an
4377 * @param[in] codec_id the codec
4378 * @return Number of bits per sample or zero if unknown for the given codec.
4380 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4383 * Return audio frame duration.
4385 * @param avctx codec context
4386 * @param frame_bytes size of the frame, or 0 if unknown
4387 * @return frame duration, in samples, if known. 0 if not able to
4390 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4393 typedef struct AVBitStreamFilterContext {
4395 struct AVBitStreamFilter *filter;
4396 AVCodecParserContext *parser;
4397 struct AVBitStreamFilterContext *next;
4398 } AVBitStreamFilterContext;
4401 typedef struct AVBitStreamFilter {
4404 int (*filter)(AVBitStreamFilterContext *bsfc,
4405 AVCodecContext *avctx, const char *args,
4406 uint8_t **poutbuf, int *poutbuf_size,
4407 const uint8_t *buf, int buf_size, int keyframe);
4408 void (*close)(AVBitStreamFilterContext *bsfc);
4409 struct AVBitStreamFilter *next;
4410 } AVBitStreamFilter;
4412 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4413 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4414 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4415 AVCodecContext *avctx, const char *args,
4416 uint8_t **poutbuf, int *poutbuf_size,
4417 const uint8_t *buf, int buf_size, int keyframe);
4418 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4420 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4425 * Reallocate the given block if it is not large enough, otherwise do nothing.
4429 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4432 * Allocate a buffer, reusing the given one if large enough.
4434 * Contrary to av_fast_realloc the current buffer contents might not be
4435 * preserved and on error the old buffer is freed, thus no special
4436 * handling to avoid memleaks is necessary.
4438 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4439 * @param size size of the buffer *ptr points to
4440 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4441 * *size 0 if an error occurred.
4443 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4446 * Allocate a buffer with padding, reusing the given one if large enough.
4448 * Same behaviour av_fast_malloc but the buffer has additional
4449 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4452 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4455 * Encode extradata length to a buffer. Used by xiph codecs.
4457 * @param s buffer to write to; must be at least (v/255+1) bytes long
4458 * @param v size of extradata in bytes
4459 * @return number of bytes written to the buffer.
4461 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4464 * Log a generic warning message about a missing feature. This function is
4465 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4466 * only, and would normally not be used by applications.
4467 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4468 * a pointer to an AVClass struct
4469 * @param[in] feature string containing the name of the missing feature
4470 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4471 * If want_sample is non-zero, additional verbage will be added to the log
4472 * message which tells the user how to report samples to the development
4475 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4478 * Log a generic warning message asking for a sample. This function is
4479 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4480 * only, and would normally not be used by applications.
4481 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4482 * a pointer to an AVClass struct
4483 * @param[in] msg string containing an optional message, or NULL if no message
4485 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4488 * Register the hardware accelerator hwaccel.
4490 void av_register_hwaccel(AVHWAccel *hwaccel);
4493 * If hwaccel is NULL, returns the first registered hardware accelerator,
4494 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4495 * after hwaccel, or NULL if hwaccel is the last one.
4497 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4501 * Lock operation used by lockmgr
4504 AV_LOCK_CREATE, ///< Create a mutex
4505 AV_LOCK_OBTAIN, ///< Lock the mutex
4506 AV_LOCK_RELEASE, ///< Unlock the mutex
4507 AV_LOCK_DESTROY, ///< Free mutex resources
4511 * Register a user provided lock manager supporting the operations
4512 * specified by AVLockOp. mutex points to a (void *) where the
4513 * lockmgr should store/get a pointer to a user allocated mutex. It's
4514 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4516 * @param cb User defined callback. Note: Libav may invoke calls to this
4517 * callback during the call to av_lockmgr_register().
4518 * Thus, the application must be prepared to handle that.
4519 * If cb is set to NULL the lockmgr will be unregistered.
4520 * Also note that during unregistration the previously registered
4521 * lockmgr callback may also be invoked.
4523 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4526 * Get the type of the given codec.
4528 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4531 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4532 * with no corresponding avcodec_close()), 0 otherwise.
4534 int avcodec_is_open(AVCodecContext *s);
4537 * @return a non-zero number if codec is an encoder, zero otherwise
4539 int av_codec_is_encoder(const AVCodec *codec);
4542 * @return a non-zero number if codec is a decoder, zero otherwise
4544 int av_codec_is_decoder(const AVCodec *codec);
4547 * @return descriptor for given codec ID or NULL if no descriptor exists.
4549 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4552 * Iterate over all codec descriptors known to libavcodec.
4554 * @param prev previous descriptor. NULL to get the first descriptor.
4556 * @return next descriptor or NULL after the last descriptor
4558 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4561 * @return codec descriptor with the given name or NULL if no such descriptor
4564 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4570 #endif /* AVCODEC_AVCODEC_H */