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
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
256 /* various PCM "codecs" */
257 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
258 CODEC_ID_PCM_S16LE = 0x10000,
274 CODEC_ID_PCM_S24DAUD,
276 CODEC_ID_PCM_S16LE_PLANAR,
285 CODEC_ID_PCM_S8_PLANAR,
287 /* various ADPCM codecs */
288 CODEC_ID_ADPCM_IMA_QT = 0x11000,
289 CODEC_ID_ADPCM_IMA_WAV,
290 CODEC_ID_ADPCM_IMA_DK3,
291 CODEC_ID_ADPCM_IMA_DK4,
292 CODEC_ID_ADPCM_IMA_WS,
293 CODEC_ID_ADPCM_IMA_SMJPEG,
302 CODEC_ID_ADPCM_YAMAHA,
303 CODEC_ID_ADPCM_SBPRO_4,
304 CODEC_ID_ADPCM_SBPRO_3,
305 CODEC_ID_ADPCM_SBPRO_2,
307 CODEC_ID_ADPCM_IMA_AMV,
308 CODEC_ID_ADPCM_EA_R1,
309 CODEC_ID_ADPCM_EA_R3,
310 CODEC_ID_ADPCM_EA_R2,
311 CODEC_ID_ADPCM_IMA_EA_SEAD,
312 CODEC_ID_ADPCM_IMA_EA_EACS,
313 CODEC_ID_ADPCM_EA_XAS,
314 CODEC_ID_ADPCM_EA_MAXIS_XA,
315 CODEC_ID_ADPCM_IMA_ISS,
319 CODEC_ID_AMR_NB = 0x12000,
322 /* RealAudio codecs*/
323 CODEC_ID_RA_144 = 0x13000,
326 /* various DPCM codecs */
327 CODEC_ID_ROQ_DPCM = 0x14000,
328 CODEC_ID_INTERPLAY_DPCM,
333 CODEC_ID_MP2 = 0x15000,
334 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
345 #if LIBAVCODEC_VERSION_MAJOR == 53
354 CODEC_ID_WESTWOOD_SND1,
355 CODEC_ID_GSM, ///< as in Berlin toast format
363 CODEC_ID_DSICINAUDIO,
367 CODEC_ID_GSM_MS, /* as found in WAV */
376 CODEC_ID_WMALOSSLESS,
385 CODEC_ID_BINKAUDIO_RDFT,
386 CODEC_ID_BINKAUDIO_DCT,
390 #if LIBAVCODEC_VERSION_MAJOR > 53
398 /* subtitle codecs */
399 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
400 CODEC_ID_DVD_SUBTITLE = 0x17000,
401 CODEC_ID_DVB_SUBTITLE,
402 CODEC_ID_TEXT, ///< raw UTF-8 text
406 CODEC_ID_HDMV_PGS_SUBTITLE,
407 CODEC_ID_DVB_TELETEXT,
410 /* other specific kind of codecs (generally used for attachments) */
411 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
412 CODEC_ID_TTF = 0x18000,
414 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
416 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
417 * stream (only used by libavformat) */
418 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
419 * stream (only used by libavformat) */
420 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
423 #if FF_API_OLD_SAMPLE_FMT
424 #define SampleFormat AVSampleFormat
426 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
427 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
428 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
429 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
430 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
431 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
432 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
435 #if FF_API_OLD_AUDIOCONVERT
436 #include "libavutil/audioconvert.h"
438 /* Audio channel masks */
439 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
440 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
441 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
442 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
443 #define CH_BACK_LEFT AV_CH_BACK_LEFT
444 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
445 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
446 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
447 #define CH_BACK_CENTER AV_CH_BACK_CENTER
448 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
449 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
450 #define CH_TOP_CENTER AV_CH_TOP_CENTER
451 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
452 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
453 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
454 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
455 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
456 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
457 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
458 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
460 /** Channel mask value used for AVCodecContext.request_channel_layout
461 to indicate that the user requests the channel order of the decoder output
462 to be the native codec channel order. */
463 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
465 /* Audio channel convenience macros */
466 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
467 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
468 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
469 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
470 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
471 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
472 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
473 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
474 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
475 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
476 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
477 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
478 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
479 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
480 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
484 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
487 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
488 * This is mainly needed because some optimized bitstream readers read
489 * 32 or 64 bit at once and could read over the end.<br>
490 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
491 * MPEG bitstreams could cause overread and segfault.
493 #define FF_INPUT_BUFFER_PADDING_SIZE 8
496 * minimum encoding buffer size
497 * Used to avoid some checks during header writing.
499 #define FF_MIN_BUFFER_SIZE 16384
503 * motion estimation type.
506 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
510 ME_EPZS, ///< enhanced predictive zonal search
511 ME_X1, ///< reserved for experiments
512 ME_HEX, ///< hexagon based search
513 ME_UMH, ///< uneven multi-hexagon search
514 ME_ITER, ///< iterative search
515 ME_TESA, ///< transformed exhaustive search algorithm
519 /* We leave some space between them for extensions (drop some
520 * keyframes for intra-only or drop just some bidir frames). */
521 AVDISCARD_NONE =-16, ///< discard nothing
522 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
523 AVDISCARD_NONREF = 8, ///< discard all non reference
524 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
525 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
526 AVDISCARD_ALL = 48, ///< discard all
529 enum AVColorPrimaries{
530 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
531 AVCOL_PRI_UNSPECIFIED=2,
533 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
534 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
535 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
537 AVCOL_PRI_NB , ///< Not part of ABI
540 enum AVColorTransferCharacteristic{
541 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
542 AVCOL_TRC_UNSPECIFIED=2,
543 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
544 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
545 AVCOL_TRC_NB , ///< Not part of ABI
550 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
551 AVCOL_SPC_UNSPECIFIED=2,
553 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
554 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
555 AVCOL_SPC_SMPTE240M =7,
556 AVCOL_SPC_NB , ///< Not part of ABI
560 AVCOL_RANGE_UNSPECIFIED=0,
561 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
562 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
563 AVCOL_RANGE_NB , ///< Not part of ABI
567 * X X 3 4 X X are luma samples,
568 * 1 2 1-6 are possible chroma positions
569 * X X 5 6 X 0 is undefined/unknown position
571 enum AVChromaLocation{
572 AVCHROMA_LOC_UNSPECIFIED=0,
573 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
574 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
575 AVCHROMA_LOC_TOPLEFT =3, ///< DV
577 AVCHROMA_LOC_BOTTOMLEFT =5,
578 AVCHROMA_LOC_BOTTOM =6,
579 AVCHROMA_LOC_NB , ///< Not part of ABI
582 #if FF_API_FLAC_GLOBAL_OPTS
587 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
588 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
589 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
590 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
591 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
592 AV_LPC_TYPE_NB , ///< Not part of ABI
596 enum AVAudioServiceType {
597 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
598 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
599 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
600 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
601 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
602 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
603 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
604 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
605 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
606 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
609 typedef struct RcOverride{
612 int qscale; // If this is 0 then quality_factor will be used instead.
613 float quality_factor;
616 #define FF_MAX_B_FRAMES 16
619 These flags can be passed in AVCodecContext.flags before initialization.
620 Note: Not everything is supported yet.
623 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
624 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
625 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
626 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
627 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
629 * The parent program guarantees that the input for B-frames containing
630 * streams is not written to for at least s->max_b_frames+1 frames, if
631 * this is not set the input will be copied.
633 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
634 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
635 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
636 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
637 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
638 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
639 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
640 location instead of only at frame boundaries. */
641 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
642 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
643 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
644 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
645 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
646 /* Fx : Flag for h263+ extra options */
647 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
648 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
649 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
650 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
651 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
652 #define CODEC_FLAG_CLOSED_GOP 0x80000000
653 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
654 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
655 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
656 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
657 #define CODEC_FLAG2_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 * @defgroup deprecated_flags Deprecated codec flags
661 * Use corresponding private codec options instead.
664 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
665 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
666 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
667 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
668 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
669 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
670 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
671 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
672 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
673 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
674 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
676 #if FF_API_MJPEG_GLOBAL_OPTS
677 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
679 #if FF_API_X264_GLOBAL_OPTS
680 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
681 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
682 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
683 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
684 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
685 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
686 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
687 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
688 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
689 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
690 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
692 #if FF_API_SNOW_GLOBAL_OPTS
693 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
695 #if FF_API_LAME_GLOBAL_OPTS
696 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
702 /* Unsupported options :
703 * Syntax Arithmetic coding (SAC)
704 * Reference Picture Selection
705 * Independent Segment Decoding */
707 /* codec capabilities */
709 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
711 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
712 * If not set, it might not use get_buffer() at all or use operations that
713 * assume the buffer was allocated by avcodec_default_get_buffer.
715 #define CODEC_CAP_DR1 0x0002
716 #if FF_API_PARSE_FRAME
717 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
718 #define CODEC_CAP_PARSE_ONLY 0x0004
720 #define CODEC_CAP_TRUNCATED 0x0008
721 /* Codec can export data for HW decoding (XvMC). */
722 #define CODEC_CAP_HWACCEL 0x0010
724 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
725 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
726 * returns frames. If this is not set, the codec is guaranteed to never be fed
729 #define CODEC_CAP_DELAY 0x0020
731 * Codec can be fed a final frame with a smaller size.
732 * This can be used to prevent truncation of the last audio samples.
734 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
736 * Codec can export data for HW decoding (VDPAU).
738 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
740 * Codec can output multiple frames per AVPacket
741 * Normally demuxers return one frame at a time, demuxers which do not do
742 * are connected to a parser to split what they return into proper frames.
743 * This flag is reserved to the very rare category of codecs which have a
744 * bitstream that cannot be split into frames without timeconsuming
745 * operations like full decoding. Demuxers carring such bitstreams thus
746 * may return multiple frames in a packet. This has many disadvantages like
747 * prohibiting stream copy in many cases thus it should only be considered
750 #define CODEC_CAP_SUBFRAMES 0x0100
752 * Codec is experimental and is thus avoided in favor of non experimental
755 #define CODEC_CAP_EXPERIMENTAL 0x0200
757 * Codec should fill in channel configuration and samplerate instead of container
759 #define CODEC_CAP_CHANNEL_CONF 0x0400
761 * Codec is able to deal with negative linesizes
763 #define CODEC_CAP_NEG_LINESIZES 0x0800
765 * Codec supports frame-level multithreading.
767 #define CODEC_CAP_FRAME_THREADS 0x1000
769 * Codec supports slice-based (or partition-based) multithreading.
771 #define CODEC_CAP_SLICE_THREADS 0x2000
773 //The following defines may change, don't expect compatibility if you use them.
774 #define MB_TYPE_INTRA4x4 0x0001
775 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
776 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
777 #define MB_TYPE_16x16 0x0008
778 #define MB_TYPE_16x8 0x0010
779 #define MB_TYPE_8x16 0x0020
780 #define MB_TYPE_8x8 0x0040
781 #define MB_TYPE_INTERLACED 0x0080
782 #define MB_TYPE_DIRECT2 0x0100 //FIXME
783 #define MB_TYPE_ACPRED 0x0200
784 #define MB_TYPE_GMC 0x0400
785 #define MB_TYPE_SKIP 0x0800
786 #define MB_TYPE_P0L0 0x1000
787 #define MB_TYPE_P1L0 0x2000
788 #define MB_TYPE_P0L1 0x4000
789 #define MB_TYPE_P1L1 0x8000
790 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
791 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
792 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
793 #define MB_TYPE_QUANT 0x00010000
794 #define MB_TYPE_CBP 0x00020000
795 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
799 * This specifies the area which should be displayed.
800 * Note there may be multiple such areas for one frame.
802 typedef struct AVPanScan{
805 * - encoding: Set by user.
806 * - decoding: Set by libavcodec.
811 * width and height in 1/16 pel
812 * - encoding: Set by user.
813 * - decoding: Set by libavcodec.
819 * position of the top left corner in 1/16 pel for up to 3 fields/frames
820 * - encoding: Set by user.
821 * - decoding: Set by libavcodec.
823 int16_t position[3][2];
826 #define FF_QSCALE_TYPE_MPEG1 0
827 #define FF_QSCALE_TYPE_MPEG2 1
828 #define FF_QSCALE_TYPE_H264 2
829 #define FF_QSCALE_TYPE_VP56 3
831 #define FF_BUFFER_TYPE_INTERNAL 1
832 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
833 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
834 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
836 #if FF_API_OLD_FF_PICT_TYPES
837 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
838 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
839 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
840 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
841 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
842 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
843 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
844 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
847 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
848 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
849 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
850 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
852 enum AVPacketSideDataType {
856 typedef struct AVPacket {
858 * Presentation timestamp in AVStream->time_base units; the time at which
859 * the decompressed packet will be presented to the user.
860 * Can be AV_NOPTS_VALUE if it is not stored in the file.
861 * pts MUST be larger or equal to dts as presentation cannot happen before
862 * decompression, unless one wants to view hex dumps. Some formats misuse
863 * the terms dts and pts/cts to mean something different. Such timestamps
864 * must be converted to true pts/dts before they are stored in AVPacket.
868 * Decompression timestamp in AVStream->time_base units; the time at which
869 * the packet is decompressed.
870 * Can be AV_NOPTS_VALUE if it is not stored in the file.
877 * A combination of AV_PKT_FLAG values
881 * Additional packet data that can be provided by the container.
882 * Packet can contain several types of side information.
887 enum AVPacketSideDataType type;
892 * Duration of this packet in AVStream->time_base units, 0 if unknown.
893 * Equals next_pts - this_pts in presentation order.
896 void (*destruct)(struct AVPacket *);
898 int64_t pos; ///< byte position in stream, -1 if unknown
901 * Time difference in AVStream->time_base units from the pts of this
902 * packet to the point at which the output from the decoder has converged
903 * independent from the availability of previous frames. That is, the
904 * frames are virtually identical no matter if decoding started from
905 * the very first frame or from this keyframe.
906 * Is AV_NOPTS_VALUE if unknown.
907 * This field is not the display duration of the current packet.
908 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
911 * The purpose of this field is to allow seeking in streams that have no
912 * keyframes in the conventional sense. It corresponds to the
913 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
914 * essential for some types of subtitle streams to ensure that all
915 * subtitles are correctly displayed after seeking.
917 int64_t convergence_duration;
919 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
920 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
924 * New fields can be added to the end of AVFRAME with minor version
925 * bumps. Removal, reordering and changes to existing fields require
926 * a major version bump.
927 * sizeof(AVFrame) must not be used outside libav*.
929 typedef struct AVFrame {
930 #if FF_API_DATA_POINTERS
931 #define AV_NUM_DATA_POINTERS 4
933 #define AV_NUM_DATA_POINTERS 8
936 * pointer to the picture planes.
937 * This might be different from the first allocated byte
941 uint8_t *data[AV_NUM_DATA_POINTERS];
942 int linesize[AV_NUM_DATA_POINTERS];
944 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
945 * This isn't used by libavcodec unless the default get/release_buffer() is used.
949 uint8_t *base[AV_NUM_DATA_POINTERS];
951 * 1 -> keyframe, 0-> not
952 * - encoding: Set by libavcodec.
953 * - decoding: Set by libavcodec.
958 * Picture type of the frame, see ?_TYPE below.
959 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
960 * - decoding: Set by libavcodec.
962 enum AVPictureType pict_type;
965 * presentation timestamp in time_base units (time when frame should be shown to user)
966 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
967 * - encoding: MUST be set by user.
968 * - decoding: Set by libavcodec.
973 * picture number in bitstream order
975 * - decoding: Set by libavcodec.
977 int coded_picture_number;
979 * picture number in display order
981 * - decoding: Set by libavcodec.
983 int display_picture_number;
986 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
987 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
988 * - decoding: Set by libavcodec.
993 * buffer age (1->was last buffer and dint change, 2->..., ...).
994 * Set to INT_MAX if the buffer has not been used yet.
996 * - decoding: MUST be set by get_buffer().
1001 * is this picture used as reference
1002 * The values for this are the same as the MpegEncContext.picture_structure
1003 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1004 * Set to 4 for delayed, non-reference frames.
1005 * - encoding: unused
1006 * - decoding: Set by libavcodec. (before get_buffer() call)).
1012 * - encoding: unused
1013 * - decoding: Set by libavcodec.
1015 int8_t *qscale_table;
1018 * - encoding: unused
1019 * - decoding: Set by libavcodec.
1024 * mbskip_table[mb]>=1 if MB didn't change
1025 * stride= mb_width = (width+15)>>4
1026 * - encoding: unused
1027 * - decoding: Set by libavcodec.
1029 uint8_t *mbskip_table;
1032 * motion vector table
1035 * int mv_sample_log2= 4 - motion_subsample_log2;
1036 * int mb_width= (width+15)>>4;
1037 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1038 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1040 * - encoding: Set by user.
1041 * - decoding: Set by libavcodec.
1043 int16_t (*motion_val[2])[2];
1046 * macroblock type table
1047 * mb_type_base + mb_width + 2
1048 * - encoding: Set by user.
1049 * - decoding: Set by libavcodec.
1054 * log2 of the size of the block which a single vector in motion_val represents:
1055 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1056 * - encoding: unused
1057 * - decoding: Set by libavcodec.
1059 uint8_t motion_subsample_log2;
1062 * for some private data of the user
1063 * - encoding: unused
1064 * - decoding: Set by user.
1070 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1071 * - decoding: unused
1073 uint64_t error[AV_NUM_DATA_POINTERS];
1076 * type of the buffer (to keep track of who has to deallocate data[*])
1077 * - encoding: Set by the one who allocates it.
1078 * - decoding: Set by the one who allocates it.
1079 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1084 * When decoding, this signals how much the picture must be delayed.
1085 * extra_delay = repeat_pict / (2*fps)
1086 * - encoding: unused
1087 * - decoding: Set by libavcodec.
1097 * The content of the picture is interlaced.
1098 * - encoding: Set by user.
1099 * - decoding: Set by libavcodec. (default 0)
1101 int interlaced_frame;
1104 * If the content is interlaced, is top field displayed first.
1105 * - encoding: Set by user.
1106 * - decoding: Set by libavcodec.
1108 int top_field_first;
1112 * - encoding: Set by user.
1113 * - decoding: Set by libavcodec.
1115 AVPanScan *pan_scan;
1118 * Tell user application that palette has changed from previous frame.
1119 * - encoding: ??? (no palette-enabled encoder yet)
1120 * - decoding: Set by libavcodec. (default 0).
1122 int palette_has_changed;
1125 * codec suggestion on buffer type if != 0
1126 * - encoding: unused
1127 * - decoding: Set by libavcodec. (before get_buffer() call)).
1133 * - encoding: unused
1134 * - decoding: Set by libavcodec.
1139 * motion reference frame index
1140 * the order in which these are stored can depend on the codec.
1141 * - encoding: Set by user.
1142 * - decoding: Set by libavcodec.
1144 int8_t *ref_index[2];
1147 * reordered opaque 64bit (generally an integer or a double precision float
1148 * PTS but can be anything).
1149 * The user sets AVCodecContext.reordered_opaque to represent the input at
1151 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1152 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1153 * @deprecated in favor of pkt_pts
1154 * - encoding: unused
1155 * - decoding: Read by user.
1157 int64_t reordered_opaque;
1160 * hardware accelerator private data (Libav-allocated)
1161 * - encoding: unused
1162 * - decoding: Set by libavcodec
1164 void *hwaccel_picture_private;
1167 * reordered pts from the last AVPacket that has been input into the decoder
1168 * - encoding: unused
1169 * - decoding: Read by user.
1174 * dts from the last AVPacket that has been input into the decoder
1175 * - encoding: unused
1176 * - decoding: Read by user.
1181 * the AVCodecContext which ff_thread_get_buffer() was last called on
1182 * - encoding: Set by libavcodec.
1183 * - decoding: Set by libavcodec.
1185 struct AVCodecContext *owner;
1188 * used by multithreading to store frame-specific info
1189 * - encoding: Set by libavcodec.
1190 * - decoding: Set by libavcodec.
1192 void *thread_opaque;
1195 struct AVCodecInternal;
1198 * main external API structure.
1199 * New fields can be added to the end with minor version bumps.
1200 * Removal, reordering and changes to existing fields require a major
1202 * sizeof(AVCodecContext) must not be used outside libav*.
1204 typedef struct AVCodecContext {
1206 * information on struct for av_log
1207 * - set by avcodec_alloc_context3
1209 const AVClass *av_class;
1211 * the average bitrate
1212 * - encoding: Set by user; unused for constant quantizer encoding.
1213 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1218 * number of bits the bitstream is allowed to diverge from the reference.
1219 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1220 * - encoding: Set by user; unused for constant quantizer encoding.
1221 * - decoding: unused
1223 int bit_rate_tolerance;
1227 * - encoding: Set by user.
1228 * - decoding: Set by user.
1233 * Some codecs need additional format info. It is stored here.
1234 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1235 * specific codec MUST set it correctly otherwise stream copy breaks.
1236 * In general use of this field by muxers is not recommanded.
1237 * - encoding: Set by libavcodec.
1238 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1243 * Motion estimation algorithm used for video coding.
1244 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1245 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1246 * - encoding: MUST be set by user.
1247 * - decoding: unused
1252 * some codecs need / can use extradata like Huffman tables.
1253 * mjpeg: Huffman tables
1254 * rv10: additional flags
1255 * mpeg4: global headers (they can be in the bitstream or here)
1256 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1257 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1258 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1259 * - encoding: Set/allocated/freed by libavcodec.
1260 * - decoding: Set/allocated/freed by user.
1266 * This is the fundamental unit of time (in seconds) in terms
1267 * of which frame timestamps are represented. For fixed-fps content,
1268 * timebase should be 1/framerate and timestamp increments should be
1270 * - encoding: MUST be set by user.
1271 * - decoding: Set by libavcodec.
1273 AVRational time_base;
1277 * picture width / height.
1278 * - encoding: MUST be set by user.
1279 * - decoding: Set by libavcodec.
1280 * Note: For compatibility it is possible to set this instead of
1281 * coded_width/height before decoding.
1285 #define FF_ASPECT_EXTENDED 15
1288 * the number of pictures in a group of pictures, or 0 for intra_only
1289 * - encoding: Set by user.
1290 * - decoding: unused
1295 * Pixel format, see PIX_FMT_xxx.
1296 * May be set by the demuxer if known from headers.
1297 * May be overriden by the decoder if it knows better.
1298 * - encoding: Set by user.
1299 * - decoding: Set by user if known, overridden by libavcodec if known
1301 enum PixelFormat pix_fmt;
1304 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1305 * decoder to draw a horizontal band. It improves cache usage. Not
1306 * all codecs can do that. You must check the codec capabilities
1308 * When multithreading is used, it may be called from multiple threads
1309 * at the same time; threads might draw different parts of the same AVFrame,
1310 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1312 * The function is also used by hardware acceleration APIs.
1313 * It is called at least once during frame decoding to pass
1314 * the data needed for hardware render.
1315 * In that mode instead of pixel data, AVFrame points to
1316 * a structure specific to the acceleration API. The application
1317 * reads the structure and can change some fields to indicate progress
1319 * - encoding: unused
1320 * - decoding: Set by user.
1321 * @param height the height of the slice
1322 * @param y the y position of the slice
1323 * @param type 1->top field, 2->bottom field, 3->frame
1324 * @param offset offset into the AVFrame.data from which the slice should be read
1326 void (*draw_horiz_band)(struct AVCodecContext *s,
1327 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1328 int y, int type, int height);
1331 int sample_rate; ///< samples per second
1332 int channels; ///< number of audio channels
1335 * audio sample format
1336 * - encoding: Set by user.
1337 * - decoding: Set by libavcodec.
1339 enum AVSampleFormat sample_fmt; ///< sample format
1341 /* The following data should not be initialized. */
1343 * Samples per packet, initialized when calling 'init'.
1346 int frame_number; ///< audio or video frame number
1349 * Number of frames the decoded output will be delayed relative to
1350 * the encoded input.
1351 * - encoding: Set by libavcodec.
1352 * - decoding: unused
1356 /* - encoding parameters */
1357 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1358 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1362 * - encoding: Set by user.
1363 * - decoding: unused
1369 * - encoding: Set by user.
1370 * - decoding: unused
1375 * maximum quantizer difference between frames
1376 * - encoding: Set by user.
1377 * - decoding: unused
1382 * maximum number of B-frames between non-B-frames
1383 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1384 * - encoding: Set by user.
1385 * - decoding: unused
1390 * qscale factor between IP and B-frames
1391 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1392 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1393 * - encoding: Set by user.
1394 * - decoding: unused
1396 float b_quant_factor;
1398 /** obsolete FIXME remove */
1400 #define FF_RC_STRATEGY_XVID 1
1402 int b_frame_strategy;
1404 struct AVCodec *codec;
1408 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1409 /* do its best to deliver a chunk with size */
1410 /* below rtp_payload_size, the chunk will start */
1411 /* with a start code on some codecs like H.263. */
1412 /* This doesn't take account of any particular */
1413 /* headers inside the transmitted RTP payload. */
1416 /* The RTP callback: This function is called */
1417 /* every time the encoder has a packet to send. */
1418 /* It depends on the encoder if the data starts */
1419 /* with a Start Code (it should). H.263 does. */
1420 /* mb_nb contains the number of macroblocks */
1421 /* encoded in the RTP payload. */
1422 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1424 /* statistics, used for 2-pass encoding */
1435 * number of bits used for the previously encoded frame
1436 * - encoding: Set by libavcodec.
1437 * - decoding: unused
1442 * Private data of the user, can be used to carry app specific stuff.
1443 * - encoding: Set by user.
1444 * - decoding: Set by user.
1448 char codec_name[32];
1449 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1450 enum CodecID codec_id; /* see CODEC_ID_xxx */
1453 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1454 * This is used to work around some encoder bugs.
1455 * A demuxer should set this to what is stored in the field used to identify the codec.
1456 * If there are multiple such fields in a container then the demuxer should choose the one
1457 * which maximizes the information about the used codec.
1458 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1459 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1460 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1462 * - encoding: Set by user, if not then the default based on codec_id will be used.
1463 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1465 unsigned int codec_tag;
1468 * Work around bugs in encoders which sometimes cannot be detected automatically.
1469 * - encoding: Set by user
1470 * - decoding: Set by user
1472 int workaround_bugs;
1473 #define FF_BUG_AUTODETECT 1 ///< autodetection
1474 #define FF_BUG_OLD_MSMPEG4 2
1475 #define FF_BUG_XVID_ILACE 4
1476 #define FF_BUG_UMP4 8
1477 #define FF_BUG_NO_PADDING 16
1478 #define FF_BUG_AMV 32
1479 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1480 #define FF_BUG_QPEL_CHROMA 64
1481 #define FF_BUG_STD_QPEL 128
1482 #define FF_BUG_QPEL_CHROMA2 256
1483 #define FF_BUG_DIRECT_BLOCKSIZE 512
1484 #define FF_BUG_EDGE 1024
1485 #define FF_BUG_HPEL_CHROMA 2048
1486 #define FF_BUG_DC_CLIP 4096
1487 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1488 #define FF_BUG_TRUNCATED 16384
1489 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1492 * luma single coefficient elimination threshold
1493 * - encoding: Set by user.
1494 * - decoding: unused
1496 int luma_elim_threshold;
1499 * chroma single coeff elimination threshold
1500 * - encoding: Set by user.
1501 * - decoding: unused
1503 int chroma_elim_threshold;
1506 * strictly follow the standard (MPEG4, ...).
1507 * - encoding: Set by user.
1508 * - decoding: Set by user.
1509 * Setting this to STRICT or higher means the encoder and decoder will
1510 * generally do stupid things, whereas setting it to unofficial or lower
1511 * will mean the encoder might produce output that is not supported by all
1512 * spec-compliant decoders. Decoders don't differentiate between normal,
1513 * unofficial and experimental (that is, they always try to decode things
1514 * when they can) unless they are explicitly asked to behave stupidly
1515 * (=strictly conform to the specs)
1517 int strict_std_compliance;
1518 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1519 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1520 #define FF_COMPLIANCE_NORMAL 0
1521 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1522 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1525 * qscale offset between IP and B-frames
1526 * - encoding: Set by user.
1527 * - decoding: unused
1529 float b_quant_offset;
1533 * Error recognition; higher values will detect more errors but may
1534 * misdetect some more or less valid parts as errors.
1535 * - encoding: unused
1536 * - decoding: Set by user.
1538 attribute_deprecated int error_recognition;
1539 #define FF_ER_CAREFUL 1
1540 #define FF_ER_COMPLIANT 2
1541 #define FF_ER_AGGRESSIVE 3
1542 #define FF_ER_VERY_AGGRESSIVE 4
1543 #define FF_ER_EXPLODE 5
1544 #endif /* FF_API_ER */
1547 * Called at the beginning of each frame to get a buffer for it.
1548 * If pic.reference is set then the frame will be read later by libavcodec.
1549 * avcodec_align_dimensions2() should be used to find the required width and
1550 * height, as they normally need to be rounded up to the next multiple of 16.
1551 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1552 * avcodec_default_get_buffer() instead of providing buffers allocated by
1554 * If frame multithreading is used and thread_safe_callbacks is set,
1555 * it may be called from a different thread, but not from more than one at once.
1556 * Does not need to be reentrant.
1557 * - encoding: unused
1558 * - decoding: Set by libavcodec, user can override.
1560 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1563 * Called to release buffers which were allocated with get_buffer.
1564 * A released buffer can be reused in get_buffer().
1565 * pic.data[*] must be set to NULL.
1566 * May be called from a different thread if frame multithreading is used,
1567 * but not by more than one thread at once, so does not need to be reentrant.
1568 * - encoding: unused
1569 * - decoding: Set by libavcodec, user can override.
1571 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1574 * Size of the frame reordering buffer in the decoder.
1575 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1576 * - encoding: Set by libavcodec.
1577 * - decoding: Set by libavcodec.
1582 * number of bytes per packet if constant and known or 0
1583 * Used by some WAV based audio codecs.
1587 #if FF_API_PARSE_FRAME
1589 * If true, only parsing is done. The frame data is returned.
1590 * Only MPEG audio decoders support this now.
1591 * - encoding: unused
1592 * - decoding: Set by user
1594 attribute_deprecated int parse_only;
1598 * 0-> h263 quant 1-> mpeg quant
1599 * - encoding: Set by user.
1600 * - decoding: unused
1605 * pass1 encoding statistics output buffer
1606 * - encoding: Set by libavcodec.
1607 * - decoding: unused
1612 * pass2 encoding statistics input buffer
1613 * Concatenated stuff from stats_out of pass1 should be placed here.
1614 * - encoding: Allocated/set/freed by user.
1615 * - decoding: unused
1620 * ratecontrol qmin qmax limiting method
1621 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1622 * - encoding: Set by user.
1623 * - decoding: unused
1631 * ratecontrol override, see RcOverride
1632 * - encoding: Allocated/set/freed by user.
1633 * - decoding: unused
1635 RcOverride *rc_override;
1636 int rc_override_count;
1639 * rate control equation
1640 * - encoding: Set by user
1641 * - decoding: unused
1647 * - encoding: Set by user.
1648 * - decoding: unused
1654 * - encoding: Set by user.
1655 * - decoding: unused
1660 * decoder bitstream buffer size
1661 * - encoding: Set by user.
1662 * - decoding: unused
1665 float rc_buffer_aggressivity;
1668 * qscale factor between P and I-frames
1669 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1670 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1671 * - encoding: Set by user.
1672 * - decoding: unused
1674 float i_quant_factor;
1677 * qscale offset between P and I-frames
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 float i_quant_offset;
1684 * initial complexity for pass1 ratecontrol
1685 * - encoding: Set by user.
1686 * - decoding: unused
1688 float rc_initial_cplx;
1691 * DCT algorithm, see FF_DCT_* below
1692 * - encoding: Set by user.
1693 * - decoding: unused
1696 #define FF_DCT_AUTO 0
1697 #define FF_DCT_FASTINT 1
1698 #define FF_DCT_INT 2
1699 #define FF_DCT_MMX 3
1700 #define FF_DCT_MLIB 4
1701 #define FF_DCT_ALTIVEC 5
1702 #define FF_DCT_FAAN 6
1705 * luminance masking (0-> disabled)
1706 * - encoding: Set by user.
1707 * - decoding: unused
1712 * temporary complexity masking (0-> disabled)
1713 * - encoding: Set by user.
1714 * - decoding: unused
1716 float temporal_cplx_masking;
1719 * spatial complexity masking (0-> disabled)
1720 * - encoding: Set by user.
1721 * - decoding: unused
1723 float spatial_cplx_masking;
1726 * p block masking (0-> disabled)
1727 * - encoding: Set by user.
1728 * - decoding: unused
1733 * darkness masking (0-> disabled)
1734 * - encoding: Set by user.
1735 * - decoding: unused
1740 * IDCT algorithm, see FF_IDCT_* below.
1741 * - encoding: Set by user.
1742 * - decoding: Set by user.
1745 #define FF_IDCT_AUTO 0
1746 #define FF_IDCT_INT 1
1747 #define FF_IDCT_SIMPLE 2
1748 #define FF_IDCT_SIMPLEMMX 3
1749 #define FF_IDCT_LIBMPEG2MMX 4
1750 #define FF_IDCT_PS2 5
1751 #define FF_IDCT_MLIB 6
1752 #define FF_IDCT_ARM 7
1753 #define FF_IDCT_ALTIVEC 8
1754 #define FF_IDCT_SH4 9
1755 #define FF_IDCT_SIMPLEARM 10
1756 #define FF_IDCT_H264 11
1757 #define FF_IDCT_VP3 12
1758 #define FF_IDCT_IPP 13
1759 #define FF_IDCT_XVIDMMX 14
1760 #define FF_IDCT_CAVS 15
1761 #define FF_IDCT_SIMPLEARMV5TE 16
1762 #define FF_IDCT_SIMPLEARMV6 17
1763 #define FF_IDCT_SIMPLEVIS 18
1764 #define FF_IDCT_WMV2 19
1765 #define FF_IDCT_FAAN 20
1766 #define FF_IDCT_EA 21
1767 #define FF_IDCT_SIMPLENEON 22
1768 #define FF_IDCT_SIMPLEALPHA 23
1769 #define FF_IDCT_BINK 24
1773 * - encoding: Set by libavcodec.
1774 * - decoding: Set by user (or 0).
1778 * slice offsets in the frame in bytes
1779 * - encoding: Set/allocated by libavcodec.
1780 * - decoding: Set/allocated by user (or NULL).
1785 * error concealment flags
1786 * - encoding: unused
1787 * - decoding: Set by user.
1789 int error_concealment;
1790 #define FF_EC_GUESS_MVS 1
1791 #define FF_EC_DEBLOCK 2
1794 * dsp_mask could be add used to disable unwanted CPU features
1795 * CPU features (i.e. MMX, SSE. ...)
1797 * With the FORCE flag you may instead enable given CPU features.
1798 * (Dangerous: Usable in case of misdetection, improper usage however will
1799 * result into program crash.)
1804 * bits per sample/pixel from the demuxer (needed for huffyuv).
1805 * - encoding: Set by libavcodec.
1806 * - decoding: Set by user.
1808 int bits_per_coded_sample;
1811 * prediction method (needed for huffyuv)
1812 * - encoding: Set by user.
1813 * - decoding: unused
1815 int prediction_method;
1816 #define FF_PRED_LEFT 0
1817 #define FF_PRED_PLANE 1
1818 #define FF_PRED_MEDIAN 2
1821 * sample aspect ratio (0 if unknown)
1822 * That is the width of a pixel divided by the height of the pixel.
1823 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1824 * - encoding: Set by user.
1825 * - decoding: Set by libavcodec.
1827 AVRational sample_aspect_ratio;
1830 * the picture in the bitstream
1831 * - encoding: Set by libavcodec.
1832 * - decoding: Set by libavcodec.
1834 AVFrame *coded_frame;
1838 * - encoding: Set by user.
1839 * - decoding: Set by user.
1842 #define FF_DEBUG_PICT_INFO 1
1843 #define FF_DEBUG_RC 2
1844 #define FF_DEBUG_BITSTREAM 4
1845 #define FF_DEBUG_MB_TYPE 8
1846 #define FF_DEBUG_QP 16
1847 #define FF_DEBUG_MV 32
1848 #define FF_DEBUG_DCT_COEFF 0x00000040
1849 #define FF_DEBUG_SKIP 0x00000080
1850 #define FF_DEBUG_STARTCODE 0x00000100
1851 #define FF_DEBUG_PTS 0x00000200
1852 #define FF_DEBUG_ER 0x00000400
1853 #define FF_DEBUG_MMCO 0x00000800
1854 #define FF_DEBUG_BUGS 0x00001000
1855 #define FF_DEBUG_VIS_QP 0x00002000
1856 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1857 #define FF_DEBUG_BUFFERS 0x00008000
1858 #define FF_DEBUG_THREADS 0x00010000
1862 * - encoding: Set by user.
1863 * - decoding: Set by user.
1866 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1867 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1868 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1872 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1873 * - decoding: unused
1875 uint64_t error[AV_NUM_DATA_POINTERS];
1878 * motion estimation comparison function
1879 * - encoding: Set by user.
1880 * - decoding: unused
1884 * subpixel motion estimation comparison function
1885 * - encoding: Set by user.
1886 * - decoding: unused
1890 * macroblock comparison function (not supported yet)
1891 * - encoding: Set by user.
1892 * - decoding: unused
1896 * interlaced DCT comparison function
1897 * - encoding: Set by user.
1898 * - decoding: unused
1901 #define FF_CMP_SAD 0
1902 #define FF_CMP_SSE 1
1903 #define FF_CMP_SATD 2
1904 #define FF_CMP_DCT 3
1905 #define FF_CMP_PSNR 4
1906 #define FF_CMP_BIT 5
1908 #define FF_CMP_ZERO 7
1909 #define FF_CMP_VSAD 8
1910 #define FF_CMP_VSSE 9
1911 #define FF_CMP_NSSE 10
1912 #define FF_CMP_W53 11
1913 #define FF_CMP_W97 12
1914 #define FF_CMP_DCTMAX 13
1915 #define FF_CMP_DCT264 14
1916 #define FF_CMP_CHROMA 256
1919 * ME diamond size & shape
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * amount of previous MV predictors (2a+1 x 2a+1 square)
1927 * - encoding: Set by user.
1928 * - decoding: unused
1930 int last_predictor_count;
1933 * prepass for motion estimation
1934 * - encoding: Set by user.
1935 * - decoding: unused
1940 * motion estimation prepass comparison function
1941 * - encoding: Set by user.
1942 * - decoding: unused
1947 * ME prepass diamond size & shape
1948 * - encoding: Set by user.
1949 * - decoding: unused
1955 * - encoding: Set by user.
1956 * - decoding: unused
1958 int me_subpel_quality;
1961 * callback to negotiate the pixelFormat
1962 * @param fmt is the list of formats which are supported by the codec,
1963 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1964 * The first is always the native one.
1965 * @return the chosen format
1966 * - encoding: unused
1967 * - decoding: Set by user, if not set the native format will be chosen.
1969 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1972 * DTG active format information (additional aspect ratio
1973 * information only used in DVB MPEG-2 transport streams)
1976 * - encoding: unused
1977 * - decoding: Set by decoder.
1979 int dtg_active_format;
1980 #define FF_DTG_AFD_SAME 8
1981 #define FF_DTG_AFD_4_3 9
1982 #define FF_DTG_AFD_16_9 10
1983 #define FF_DTG_AFD_14_9 11
1984 #define FF_DTG_AFD_4_3_SP_14_9 13
1985 #define FF_DTG_AFD_16_9_SP_14_9 14
1986 #define FF_DTG_AFD_SP_4_3 15
1989 * maximum motion estimation search range in subpel units
1990 * If 0 then no limit.
1992 * - encoding: Set by user.
1993 * - decoding: unused
1998 * intra quantizer bias
1999 * - encoding: Set by user.
2000 * - decoding: unused
2002 int intra_quant_bias;
2003 #define FF_DEFAULT_QUANT_BIAS 999999
2006 * inter quantizer bias
2007 * - encoding: Set by user.
2008 * - decoding: unused
2010 int inter_quant_bias;
2014 * - encoding: unused
2015 * - decoding: Which clrtable should be used for 8bit RGB images.
2016 * Tables have to be stored somewhere. FIXME
2020 #if FF_API_INTERNAL_CONTEXT
2022 * internal_buffer count
2023 * Don't touch, used by libavcodec default_get_buffer().
2024 * @deprecated this field was moved to an internal context
2026 attribute_deprecated int internal_buffer_count;
2030 * Don't touch, used by libavcodec default_get_buffer().
2031 * @deprecated this field was moved to an internal context
2033 attribute_deprecated void *internal_buffer;
2037 * Global quality for codecs which cannot change it per frame.
2038 * This should be proportional to MPEG-1/2/4 qscale.
2039 * - encoding: Set by user.
2040 * - decoding: unused
2044 #define FF_CODER_TYPE_VLC 0
2045 #define FF_CODER_TYPE_AC 1
2046 #define FF_CODER_TYPE_RAW 2
2047 #define FF_CODER_TYPE_RLE 3
2048 #define FF_CODER_TYPE_DEFLATE 4
2051 * - encoding: Set by user.
2052 * - decoding: unused
2058 * - encoding: Set by user.
2059 * - decoding: unused
2065 * - encoding: unused
2066 * - decoding: Set by user.
2068 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2073 * - encoding: unused
2074 * - decoding: Set by user.
2077 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2078 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2079 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2082 * XVideo Motion Acceleration
2083 * - encoding: forbidden
2084 * - decoding: set by decoder
2086 int xvmc_acceleration;
2089 * macroblock decision mode
2090 * - encoding: Set by user.
2091 * - decoding: unused
2094 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2095 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2096 #define FF_MB_DECISION_RD 2 ///< rate distortion
2099 * custom intra quantization matrix
2100 * - encoding: Set by user, can be NULL.
2101 * - decoding: Set by libavcodec.
2103 uint16_t *intra_matrix;
2106 * custom inter quantization matrix
2107 * - encoding: Set by user, can be NULL.
2108 * - decoding: Set by libavcodec.
2110 uint16_t *inter_matrix;
2113 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2114 * This is used to work around some encoder bugs.
2115 * - encoding: unused
2116 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2118 unsigned int stream_codec_tag;
2121 * scene change detection threshold
2122 * 0 is default, larger means fewer detected scene changes.
2123 * - encoding: Set by user.
2124 * - decoding: unused
2126 int scenechange_threshold;
2129 * minimum Lagrange multipler
2130 * - encoding: Set by user.
2131 * - decoding: unused
2136 * maximum Lagrange multipler
2137 * - encoding: Set by user.
2138 * - decoding: unused
2142 #if FF_API_PALETTE_CONTROL
2144 * palette control structure
2145 * - encoding: ??? (no palette-enabled encoder yet)
2146 * - decoding: Set by user.
2148 struct AVPaletteControl *palctrl;
2152 * noise reduction strength
2153 * - encoding: Set by user.
2154 * - decoding: unused
2156 int noise_reduction;
2159 * Called at the beginning of a frame to get cr buffer for it.
2160 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2161 * libavcodec will pass previous buffer in pic, function should return
2162 * same buffer or new buffer with old frame "painted" into it.
2163 * If pic.data[0] == NULL must behave like get_buffer().
2164 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2165 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2167 * - encoding: unused
2168 * - decoding: Set by libavcodec, user can override.
2170 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2173 * Number of bits which should be loaded into the rc buffer before decoding starts.
2174 * - encoding: Set by user.
2175 * - decoding: unused
2177 int rc_initial_buffer_occupancy;
2181 * - encoding: Set by user.
2182 * - decoding: unused
2184 int inter_threshold;
2188 * - encoding: Set by user.
2189 * - decoding: Set by user.
2194 * Simulates errors in the bitstream to test error concealment.
2195 * - encoding: Set by user.
2196 * - decoding: unused
2200 #if FF_API_ANTIALIAS_ALGO
2202 * MP3 antialias algorithm, see FF_AA_* below.
2203 * - encoding: unused
2204 * - decoding: Set by user.
2206 attribute_deprecated int antialias_algo;
2207 #define FF_AA_AUTO 0
2208 #define FF_AA_FASTINT 1 //not implemented yet
2210 #define FF_AA_FLOAT 3
2214 * quantizer noise shaping
2215 * - encoding: Set by user.
2216 * - decoding: unused
2218 int quantizer_noise_shaping;
2222 * is used to decide how many independent tasks should be passed to execute()
2223 * - encoding: Set by user.
2224 * - decoding: Set by user.
2229 * The codec may call this to execute several independent things.
2230 * It will return only after finishing all tasks.
2231 * The user may replace this with some multithreaded implementation,
2232 * the default implementation will execute the parts serially.
2233 * @param count the number of things to execute
2234 * - encoding: Set by libavcodec, user can override.
2235 * - decoding: Set by libavcodec, user can override.
2237 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2241 * Can be used by execute() to store some per AVCodecContext stuff.
2242 * - encoding: set by execute()
2243 * - decoding: set by execute()
2245 void *thread_opaque;
2248 * Motion estimation threshold below which no motion estimation is
2249 * performed, but instead the user specified motion vectors are used.
2251 * - encoding: Set by user.
2252 * - decoding: unused
2257 * Macroblock threshold below which the user specified macroblock types will be used.
2258 * - encoding: Set by user.
2259 * - decoding: unused
2264 * precision of the intra DC coefficient - 8
2265 * - encoding: Set by user.
2266 * - decoding: unused
2268 int intra_dc_precision;
2271 * noise vs. sse weight for the nsse comparsion function
2272 * - encoding: Set by user.
2273 * - decoding: unused
2278 * Number of macroblock rows at the top which are skipped.
2279 * - encoding: unused
2280 * - decoding: Set by user.
2285 * Number of macroblock rows at the bottom which are skipped.
2286 * - encoding: unused
2287 * - decoding: Set by user.
2293 * - encoding: Set by user.
2294 * - decoding: Set by libavcodec.
2297 #define FF_PROFILE_UNKNOWN -99
2298 #define FF_PROFILE_RESERVED -100
2300 #define FF_PROFILE_AAC_MAIN 0
2301 #define FF_PROFILE_AAC_LOW 1
2302 #define FF_PROFILE_AAC_SSR 2
2303 #define FF_PROFILE_AAC_LTP 3
2305 #define FF_PROFILE_DTS 20
2306 #define FF_PROFILE_DTS_ES 30
2307 #define FF_PROFILE_DTS_96_24 40
2308 #define FF_PROFILE_DTS_HD_HRA 50
2309 #define FF_PROFILE_DTS_HD_MA 60
2311 #define FF_PROFILE_MPEG2_422 0
2312 #define FF_PROFILE_MPEG2_HIGH 1
2313 #define FF_PROFILE_MPEG2_SS 2
2314 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2315 #define FF_PROFILE_MPEG2_MAIN 4
2316 #define FF_PROFILE_MPEG2_SIMPLE 5
2318 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2319 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2321 #define FF_PROFILE_H264_BASELINE 66
2322 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2323 #define FF_PROFILE_H264_MAIN 77
2324 #define FF_PROFILE_H264_EXTENDED 88
2325 #define FF_PROFILE_H264_HIGH 100
2326 #define FF_PROFILE_H264_HIGH_10 110
2327 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2328 #define FF_PROFILE_H264_HIGH_422 122
2329 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2330 #define FF_PROFILE_H264_HIGH_444 144
2331 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2332 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2333 #define FF_PROFILE_H264_CAVLC_444 44
2335 #define FF_PROFILE_VC1_SIMPLE 0
2336 #define FF_PROFILE_VC1_MAIN 1
2337 #define FF_PROFILE_VC1_COMPLEX 2
2338 #define FF_PROFILE_VC1_ADVANCED 3
2340 #define FF_PROFILE_MPEG4_SIMPLE 0
2341 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2342 #define FF_PROFILE_MPEG4_CORE 2
2343 #define FF_PROFILE_MPEG4_MAIN 3
2344 #define FF_PROFILE_MPEG4_N_BIT 4
2345 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2346 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2347 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2348 #define FF_PROFILE_MPEG4_HYBRID 8
2349 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2350 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2351 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2352 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2353 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2354 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2355 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2359 * - encoding: Set by user.
2360 * - decoding: Set by libavcodec.
2363 #define FF_LEVEL_UNKNOWN -99
2366 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2367 * - encoding: unused
2368 * - decoding: Set by user.
2373 * Bitstream width / height, may be different from width/height if lowres enabled.
2374 * - encoding: unused
2375 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2377 int coded_width, coded_height;
2380 * frame skip threshold
2381 * - encoding: Set by user.
2382 * - decoding: unused
2384 int frame_skip_threshold;
2388 * - encoding: Set by user.
2389 * - decoding: unused
2391 int frame_skip_factor;
2394 * frame skip exponent
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * frame skip comparison function
2402 * - encoding: Set by user.
2403 * - decoding: unused
2408 * Border processing masking, raises the quantizer for mbs on the borders
2410 * - encoding: Set by user.
2411 * - decoding: unused
2413 float border_masking;
2416 * minimum MB lagrange multipler
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * maximum MB lagrange multipler
2424 * - encoding: Set by user.
2425 * - decoding: unused
2431 * - encoding: Set by user.
2432 * - decoding: unused
2434 int me_penalty_compensation;
2438 * - encoding: unused
2439 * - decoding: Set by user.
2441 enum AVDiscard skip_loop_filter;
2445 * - encoding: unused
2446 * - decoding: Set by user.
2448 enum AVDiscard skip_idct;
2452 * - encoding: unused
2453 * - decoding: Set by user.
2455 enum AVDiscard skip_frame;
2459 * - encoding: Set by user.
2460 * - decoding: unused
2466 * - encoding: Set by user.
2467 * - decoding: unused
2471 #if FF_API_X264_GLOBAL_OPTS
2473 * constant rate factor - quality-based VBR - values ~correspond to qps
2474 * - encoding: Set by user.
2475 * - decoding: unused
2476 * @deprecated use 'crf' libx264 private option
2478 attribute_deprecated float crf;
2481 * constant quantization parameter rate control method
2482 * - encoding: Set by user.
2483 * - decoding: unused
2484 * @deprecated use 'cqp' libx264 private option
2486 attribute_deprecated int cqp;
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * number of reference frames
2498 * - encoding: Set by user.
2499 * - decoding: Set by lavc.
2504 * chroma qp offset from luma
2505 * - encoding: Set by user.
2506 * - decoding: unused
2510 #if FF_API_X264_GLOBAL_OPTS
2512 * Influences how often B-frames are used.
2513 * - encoding: Set by user.
2514 * - decoding: unused
2516 attribute_deprecated int bframebias;
2520 * trellis RD quantization
2521 * - encoding: Set by user.
2522 * - decoding: unused
2526 #if FF_API_X264_GLOBAL_OPTS
2528 * Reduce fluctuations in qp (before curve compression).
2529 * - encoding: Set by user.
2530 * - decoding: unused
2532 attribute_deprecated float complexityblur;
2535 * in-loop deblocking filter alphac0 parameter
2536 * alpha is in the range -6...6
2537 * - encoding: Set by user.
2538 * - decoding: unused
2540 attribute_deprecated int deblockalpha;
2543 * in-loop deblocking filter beta parameter
2544 * beta is in the range -6...6
2545 * - encoding: Set by user.
2546 * - decoding: unused
2548 attribute_deprecated int deblockbeta;
2551 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2552 * - encoding: Set by user.
2553 * - decoding: unused
2555 attribute_deprecated int partitions;
2556 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2557 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2558 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2559 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2560 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2563 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2564 * - encoding: Set by user.
2565 * - decoding: unused
2567 attribute_deprecated int directpred;
2571 * Audio cutoff bandwidth (0 means "automatic")
2572 * - encoding: Set by user.
2573 * - decoding: unused
2578 * Multiplied by qscale for each frame and added to scene_change_score.
2579 * - encoding: Set by user.
2580 * - decoding: unused
2582 int scenechange_factor;
2586 * Note: Value depends upon the compare function used for fullpel ME.
2587 * - encoding: Set by user.
2588 * - decoding: unused
2593 * Adjusts sensitivity of b_frame_strategy 1.
2594 * - encoding: Set by user.
2595 * - decoding: unused
2600 * - encoding: Set by user.
2601 * - decoding: unused
2603 int compression_level;
2604 #define FF_COMPRESSION_DEFAULT -1
2607 * - encoding: Set by user.
2608 * - decoding: unused
2610 int min_prediction_order;
2613 * - encoding: Set by user.
2614 * - decoding: unused
2616 int max_prediction_order;
2618 #if FF_API_FLAC_GLOBAL_OPTS
2620 * @name FLAC options
2621 * @deprecated Use FLAC encoder private options instead.
2626 * LPC coefficient precision - used by FLAC encoder
2627 * - encoding: Set by user.
2628 * - decoding: unused
2630 attribute_deprecated int lpc_coeff_precision;
2633 * search method for selecting prediction order
2634 * - encoding: Set by user.
2635 * - decoding: unused
2637 attribute_deprecated int prediction_order_method;
2640 * - encoding: Set by user.
2641 * - decoding: unused
2643 attribute_deprecated int min_partition_order;
2646 * - encoding: Set by user.
2647 * - decoding: unused
2649 attribute_deprecated int max_partition_order;
2656 * GOP timecode frame start number, in non drop frame format
2657 * - encoding: Set by user.
2658 * - decoding: unused
2660 int64_t timecode_frame_start;
2662 #if FF_API_REQUEST_CHANNELS
2664 * Decoder should decode to this many channels if it can (0 for default)
2665 * - encoding: unused
2666 * - decoding: Set by user.
2667 * @deprecated Deprecated in favor of request_channel_layout.
2669 int request_channels;
2672 #if FF_API_DRC_SCALE
2674 * Percentage of dynamic range compression to be applied by the decoder.
2675 * The default value is 1.0, corresponding to full compression.
2676 * - encoding: unused
2677 * - decoding: Set by user.
2678 * @deprecated use AC3 decoder private option instead.
2680 attribute_deprecated float drc_scale;
2684 * opaque 64bit number (generally a PTS) that will be reordered and
2685 * output in AVFrame.reordered_opaque
2686 * @deprecated in favor of pkt_pts
2687 * - encoding: unused
2688 * - decoding: Set by user.
2690 int64_t reordered_opaque;
2693 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2694 * - encoding: set by user.
2695 * - decoding: set by libavcodec.
2697 int bits_per_raw_sample;
2700 * Audio channel layout.
2701 * - encoding: set by user.
2702 * - decoding: set by libavcodec.
2704 uint64_t channel_layout;
2707 * Request decoder to use this channel layout if it can (0 for default)
2708 * - encoding: unused
2709 * - decoding: Set by user.
2711 uint64_t request_channel_layout;
2714 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2715 * - encoding: Set by user.
2716 * - decoding: unused.
2718 float rc_max_available_vbv_use;
2721 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2722 * - encoding: Set by user.
2723 * - decoding: unused.
2725 float rc_min_vbv_overflow_use;
2728 * Hardware accelerator in use
2729 * - encoding: unused.
2730 * - decoding: Set by libavcodec
2732 struct AVHWAccel *hwaccel;
2735 * For some codecs, the time base is closer to the field rate than the frame rate.
2736 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2737 * if no telecine is used ...
2739 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2741 int ticks_per_frame;
2744 * Hardware accelerator context.
2745 * For some hardware accelerators, a global context needs to be
2746 * provided by the user. In that case, this holds display-dependent
2747 * data Libav cannot instantiate itself. Please refer to the
2748 * Libav HW accelerator documentation to know how to fill this
2749 * is. e.g. for VA API, this is a struct vaapi_context.
2750 * - encoding: unused
2751 * - decoding: Set by user
2753 void *hwaccel_context;
2756 * Chromaticity coordinates of the source primaries.
2757 * - encoding: Set by user
2758 * - decoding: Set by libavcodec
2760 enum AVColorPrimaries color_primaries;
2763 * Color Transfer Characteristic.
2764 * - encoding: Set by user
2765 * - decoding: Set by libavcodec
2767 enum AVColorTransferCharacteristic color_trc;
2770 * YUV colorspace type.
2771 * - encoding: Set by user
2772 * - decoding: Set by libavcodec
2774 enum AVColorSpace colorspace;
2777 * MPEG vs JPEG YUV range.
2778 * - encoding: Set by user
2779 * - decoding: Set by libavcodec
2781 enum AVColorRange color_range;
2784 * This defines the location of chroma samples.
2785 * - encoding: Set by user
2786 * - decoding: Set by libavcodec
2788 enum AVChromaLocation chroma_sample_location;
2791 * The codec may call this to execute several independent things.
2792 * It will return only after finishing all tasks.
2793 * The user may replace this with some multithreaded implementation,
2794 * the default implementation will execute the parts serially.
2795 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2796 * @param c context passed also to func
2797 * @param count the number of things to execute
2798 * @param arg2 argument passed unchanged to func
2799 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2800 * @param func function that will be called count times, with jobnr from 0 to count-1.
2801 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2802 * two instances of func executing at the same time will have the same threadnr.
2803 * @return always 0 currently, but code should handle a future improvement where when any call to func
2804 * returns < 0 no further calls to func may be done and < 0 is returned.
2805 * - encoding: Set by libavcodec, user can override.
2806 * - decoding: Set by libavcodec, user can override.
2808 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2810 #if FF_API_X264_GLOBAL_OPTS
2812 * explicit P-frame weighted prediction analysis method
2814 * 1: fast blind weighting (one reference duplicate with -1 offset)
2815 * 2: smart weighting (full fade detection analysis)
2816 * - encoding: Set by user.
2817 * - decoding: unused
2819 attribute_deprecated int weighted_p_pred;
2824 * 1: Variance AQ (complexity mask)
2825 * 2: Auto-variance AQ (experimental)
2826 * - encoding: Set by user
2827 * - decoding: unused
2829 attribute_deprecated int aq_mode;
2833 * Reduces blocking and blurring in flat and textured areas.
2834 * - encoding: Set by user
2835 * - decoding: unused
2837 attribute_deprecated float aq_strength;
2841 * Strength of psychovisual optimization
2842 * - encoding: Set by user
2843 * - decoding: unused
2845 attribute_deprecated float psy_rd;
2849 * Strength of psychovisual optimization
2850 * - encoding: Set by user
2851 * - decoding: unused
2853 attribute_deprecated float psy_trellis;
2857 * Number of frames for frametype and ratecontrol lookahead
2858 * - encoding: Set by user
2859 * - decoding: unused
2861 attribute_deprecated int rc_lookahead;
2864 * Constant rate factor maximum
2865 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2866 * than crf_max, even if doing so would violate VBV restrictions.
2867 * - encoding: Set by user.
2868 * - decoding: unused
2870 attribute_deprecated float crf_max;
2873 int log_level_offset;
2875 #if FF_API_FLAC_GLOBAL_OPTS
2877 * Determines which LPC analysis algorithm to use.
2878 * - encoding: Set by user
2879 * - decoding: unused
2881 attribute_deprecated enum AVLPCType lpc_type;
2884 * Number of passes to use for Cholesky factorization during LPC analysis
2885 * - encoding: Set by user
2886 * - decoding: unused
2888 attribute_deprecated int lpc_passes;
2893 * Indicates number of picture subdivisions. Used for parallelized
2895 * - encoding: Set by user
2896 * - decoding: unused
2901 * Header containing style information for text subtitles.
2902 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2903 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2904 * the Format line following. It shouldn't include any Dialogue line.
2905 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2906 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2908 uint8_t *subtitle_header;
2909 int subtitle_header_size;
2912 * Current packet as passed into the decoder, to avoid having
2913 * to pass the packet into every function. Currently only valid
2914 * inside lavc and get/release_buffer callbacks.
2915 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2916 * - encoding: unused
2920 #if FF_API_INTERNAL_CONTEXT
2922 * Whether this is a copy of the context which had init() called on it.
2923 * This is used by multithreading - shared tables and picture pointers
2924 * should be freed from the original context only.
2925 * - encoding: Set by libavcodec.
2926 * - decoding: Set by libavcodec.
2928 * @deprecated this field has been moved to an internal context
2930 attribute_deprecated int is_copy;
2934 * Which multithreading methods to use.
2935 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2936 * so clients which cannot provide future frames should not use it.
2938 * - encoding: Set by user, otherwise the default is used.
2939 * - decoding: Set by user, otherwise the default is used.
2942 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2943 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2946 * Which multithreading methods are in use by the codec.
2947 * - encoding: Set by libavcodec.
2948 * - decoding: Set by libavcodec.
2950 int active_thread_type;
2953 * Set by the client if its custom get_buffer() callback can be called
2954 * from another thread, which allows faster multithreaded decoding.
2955 * draw_horiz_band() will be called from other threads regardless of this setting.
2956 * Ignored if the default get_buffer() is used.
2957 * - encoding: Set by user.
2958 * - decoding: Set by user.
2960 int thread_safe_callbacks;
2963 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2964 * Used for compliant TS muxing.
2965 * - encoding: Set by libavcodec.
2966 * - decoding: unused.
2971 * Type of service that the audio stream conveys.
2972 * - encoding: Set by user.
2973 * - decoding: Set by libavcodec.
2975 enum AVAudioServiceType audio_service_type;
2978 * Used to request a sample format from the decoder.
2979 * - encoding: unused.
2980 * - decoding: Set by user.
2982 enum AVSampleFormat request_sample_fmt;
2985 * Error recognition; may misdetect some more or less valid parts as errors.
2986 * - encoding: unused
2987 * - decoding: Set by user.
2989 int err_recognition;
2990 #define AV_EF_CRCCHECK (1<<0)
2991 #define AV_EF_BITSTREAM (1<<1)
2992 #define AV_EF_BUFFER (1<<2)
2993 #define AV_EF_EXPLODE (1<<3)
2996 * Private context used for internal data.
2998 * Unlike priv_data, this is not codec-specific. It is used in general
2999 * libavcodec functions.
3001 struct AVCodecInternal *internal;
3007 typedef struct AVProfile {
3009 const char *name; ///< short name for the profile
3012 typedef struct AVCodecDefault AVCodecDefault;
3017 typedef struct AVCodec {
3019 * Name of the codec implementation.
3020 * The name is globally unique among encoders and among decoders (but an
3021 * encoder and a decoder can share the same name).
3022 * This is the primary way to find a codec from the user perspective.
3025 enum AVMediaType type;
3028 int (*init)(AVCodecContext *);
3029 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3030 int (*close)(AVCodecContext *);
3031 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3033 * Codec capabilities.
3037 struct AVCodec *next;
3040 * Will be called when seeking
3042 void (*flush)(AVCodecContext *);
3043 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3044 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3046 * Descriptive name for the codec, meant to be more human readable than name.
3047 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3049 const char *long_name;
3050 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3051 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3052 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3053 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3054 const AVClass *priv_class; ///< AVClass for the private context
3055 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3058 * @name Frame-level threading support functions
3062 * If defined, called on thread contexts when they are created.
3063 * If the codec allocates writable tables in init(), re-allocate them here.
3064 * priv_data will be set to a copy of the original.
3066 int (*init_thread_copy)(AVCodecContext *);
3068 * Copy necessary context variables from a previous thread context to the current one.
3069 * If not defined, the next thread will start automatically; otherwise, the codec
3070 * must call ff_thread_finish_setup().
3072 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3074 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3078 * Private codec-specific defaults.
3080 const AVCodecDefault *defaults;
3083 * Initialize codec static data, called from avcodec_register().
3085 void (*init_static_data)(struct AVCodec *codec);
3091 typedef struct AVHWAccel {
3093 * Name of the hardware accelerated codec.
3094 * The name is globally unique among encoders and among decoders (but an
3095 * encoder and a decoder can share the same name).
3100 * Type of codec implemented by the hardware accelerator.
3102 * See AVMEDIA_TYPE_xxx
3104 enum AVMediaType type;
3107 * Codec implemented by the hardware accelerator.
3114 * Supported pixel format.
3116 * Only hardware accelerated formats are supported here.
3118 enum PixelFormat pix_fmt;
3121 * Hardware accelerated codec capabilities.
3122 * see FF_HWACCEL_CODEC_CAP_*
3126 struct AVHWAccel *next;
3129 * Called at the beginning of each frame or field picture.
3131 * Meaningful frame information (codec specific) is guaranteed to
3132 * be parsed at this point. This function is mandatory.
3134 * Note that buf can be NULL along with buf_size set to 0.
3135 * Otherwise, this means the whole frame is available at this point.
3137 * @param avctx the codec context
3138 * @param buf the frame data buffer base
3139 * @param buf_size the size of the frame in bytes
3140 * @return zero if successful, a negative value otherwise
3142 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3145 * Callback for each slice.
3147 * Meaningful slice information (codec specific) is guaranteed to
3148 * be parsed at this point. This function is mandatory.
3150 * @param avctx the codec context
3151 * @param buf the slice data buffer base
3152 * @param buf_size the size of the slice in bytes
3153 * @return zero if successful, a negative value otherwise
3155 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3158 * Called at the end of each frame or field picture.
3160 * The whole picture is parsed at this point and can now be sent
3161 * to the hardware accelerator. This function is mandatory.
3163 * @param avctx the codec context
3164 * @return zero if successful, a negative value otherwise
3166 int (*end_frame)(AVCodecContext *avctx);
3169 * Size of HW accelerator private data.
3171 * Private data is allocated with av_mallocz() before
3172 * AVCodecContext.get_buffer() and deallocated after
3173 * AVCodecContext.release_buffer().
3179 * four components are given, that's all.
3180 * the last component is alpha
3182 typedef struct AVPicture {
3183 uint8_t *data[AV_NUM_DATA_POINTERS];
3184 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3187 #define AVPALETTE_SIZE 1024
3188 #define AVPALETTE_COUNT 256
3189 #if FF_API_PALETTE_CONTROL
3192 * This structure defines a method for communicating palette changes
3193 * between and demuxer and a decoder.
3195 * @deprecated Use AVPacket to send palette changes instead.
3196 * This is totally broken.
3198 typedef struct AVPaletteControl {
3200 /* Demuxer sets this to 1 to indicate the palette has changed;
3201 * decoder resets to 0. */
3202 int palette_changed;
3204 /* 4-byte ARGB palette entries, stored in native byte order; note that
3205 * the individual palette components should be on a 8-bit scale; if
3206 * the palette data comes from an IBM VGA native format, the component
3207 * data is probably 6 bits in size and needs to be scaled. */
3208 unsigned int palette[AVPALETTE_COUNT];
3210 } AVPaletteControl attribute_deprecated;
3213 enum AVSubtitleType {
3216 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3219 * Plain text, the text field must be set by the decoder and is
3220 * authoritative. ass and pict fields may contain approximations.
3225 * Formatted text, the ass field must be set by the decoder and is
3226 * authoritative. pict and text fields may contain approximations.
3231 typedef struct AVSubtitleRect {
3232 int x; ///< top left corner of pict, undefined when pict is not set
3233 int y; ///< top left corner of pict, undefined when pict is not set
3234 int w; ///< width of pict, undefined when pict is not set
3235 int h; ///< height of pict, undefined when pict is not set
3236 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3239 * data+linesize for the bitmap of this subtitle.
3240 * can be set for text/ass as well once they where rendered
3243 enum AVSubtitleType type;
3245 char *text; ///< 0 terminated plain UTF-8 text
3248 * 0 terminated ASS/SSA compatible event line.
3249 * The pressentation of this is unaffected by the other values in this
3255 typedef struct AVSubtitle {
3256 uint16_t format; /* 0 = graphics */
3257 uint32_t start_display_time; /* relative to packet pts, in ms */
3258 uint32_t end_display_time; /* relative to packet pts, in ms */
3260 AVSubtitleRect **rects;
3261 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3264 /* packet functions */
3267 * @deprecated use NULL instead
3269 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3272 * Default packet destructor.
3274 void av_destruct_packet(AVPacket *pkt);
3277 * Initialize optional fields of a packet with default values.
3281 void av_init_packet(AVPacket *pkt);
3284 * Allocate the payload of a packet and initialize its fields with
3288 * @param size wanted payload size
3289 * @return 0 if OK, AVERROR_xxx otherwise
3291 int av_new_packet(AVPacket *pkt, int size);
3294 * Reduce packet size, correctly zeroing padding
3297 * @param size new size
3299 void av_shrink_packet(AVPacket *pkt, int size);
3302 * Increase packet size, correctly zeroing padding
3305 * @param grow_by number of bytes by which to increase the size of the packet
3307 int av_grow_packet(AVPacket *pkt, int grow_by);
3310 * @warning This is a hack - the packet memory allocation stuff is broken. The
3311 * packet is allocated if it was not really allocated.
3313 int av_dup_packet(AVPacket *pkt);
3318 * @param pkt packet to free
3320 void av_free_packet(AVPacket *pkt);
3323 * Allocate new information of a packet.
3326 * @param type side information type
3327 * @param size side information size
3328 * @return pointer to fresh allocated data or NULL otherwise
3330 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3334 * Get side information from packet.
3337 * @param type desired side information type
3338 * @param size pointer for side information size to store (optional)
3339 * @return pointer to data if present or NULL otherwise
3341 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3346 struct ReSampleContext;
3347 struct AVResampleContext;
3349 typedef struct ReSampleContext ReSampleContext;
3352 * Initialize audio resampling context.
3354 * @param output_channels number of output channels
3355 * @param input_channels number of input channels
3356 * @param output_rate output sample rate
3357 * @param input_rate input sample rate
3358 * @param sample_fmt_out requested output sample format
3359 * @param sample_fmt_in input sample format
3360 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3361 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3362 * @param linear if 1 then the used FIR filter will be linearly interpolated
3363 between the 2 closest, if 0 the closest will be used
3364 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3365 * @return allocated ReSampleContext, NULL if error occured
3367 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3368 int output_rate, int input_rate,
3369 enum AVSampleFormat sample_fmt_out,
3370 enum AVSampleFormat sample_fmt_in,
3371 int filter_length, int log2_phase_count,
3372 int linear, double cutoff);
3374 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3377 * Free resample context.
3379 * @param s a non-NULL pointer to a resample context previously
3380 * created with av_audio_resample_init()
3382 void audio_resample_close(ReSampleContext *s);
3386 * Initialize an audio resampler.
3387 * Note, if either rate is not an integer then simply scale both rates up so they are.
3388 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3389 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3390 * @param linear If 1 then the used FIR filter will be linearly interpolated
3391 between the 2 closest, if 0 the closest will be used
3392 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3394 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3397 * Resample an array of samples using a previously configured context.
3398 * @param src an array of unconsumed samples
3399 * @param consumed the number of samples of src which have been consumed are returned here
3400 * @param src_size the number of unconsumed samples available
3401 * @param dst_size the amount of space in samples available in dst
3402 * @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.
3403 * @return the number of samples written in dst or -1 if an error occurred
3405 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3409 * Compensate samplerate/timestamp drift. The compensation is done by changing
3410 * the resampler parameters, so no audible clicks or similar distortions occur
3411 * @param compensation_distance distance in output samples over which the compensation should be performed
3412 * @param sample_delta number of output samples which should be output less
3414 * example: av_resample_compensate(c, 10, 500)
3415 * here instead of 510 samples only 500 samples would be output
3417 * note, due to rounding the actual compensation might be slightly different,
3418 * especially if the compensation_distance is large and the in_rate used during init is small
3420 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3421 void av_resample_close(struct AVResampleContext *c);
3424 * Allocate memory for a picture. Call avpicture_free() to free it.
3426 * @see avpicture_fill()
3428 * @param picture the picture to be filled in
3429 * @param pix_fmt the format of the picture
3430 * @param width the width of the picture
3431 * @param height the height of the picture
3432 * @return zero if successful, a negative value if not
3434 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3437 * Free a picture previously allocated by avpicture_alloc().
3438 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3441 * @param picture the AVPicture to be freed
3443 void avpicture_free(AVPicture *picture);
3446 * Fill in the AVPicture fields.
3447 * The fields of the given AVPicture are filled in by using the 'ptr' address
3448 * which points to the image data buffer. Depending on the specified picture
3449 * format, one or multiple image data pointers and line sizes will be set.
3450 * If a planar format is specified, several pointers will be set pointing to
3451 * the different picture planes and the line sizes of the different planes
3452 * will be stored in the lines_sizes array.
3453 * Call with ptr == NULL to get the required size for the ptr buffer.
3455 * To allocate the buffer and fill in the AVPicture fields in one call,
3456 * use avpicture_alloc().
3458 * @param picture AVPicture whose fields are to be filled in
3459 * @param ptr Buffer which will contain or contains the actual image data
3460 * @param pix_fmt The format in which the picture data is stored.
3461 * @param width the width of the image in pixels
3462 * @param height the height of the image in pixels
3463 * @return size of the image data in bytes
3465 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3466 enum PixelFormat pix_fmt, int width, int height);
3469 * Copy pixel data from an AVPicture into a buffer.
3470 * The data is stored compactly, without any gaps for alignment or padding
3471 * which may be applied by avpicture_fill().
3473 * @see avpicture_get_size()
3475 * @param[in] src AVPicture containing image data
3476 * @param[in] pix_fmt The format in which the picture data is stored.
3477 * @param[in] width the width of the image in pixels.
3478 * @param[in] height the height of the image in pixels.
3479 * @param[out] dest A buffer into which picture data will be copied.
3480 * @param[in] dest_size The size of 'dest'.
3481 * @return The number of bytes written to dest, or a negative value (error code) on error.
3483 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3484 unsigned char *dest, int dest_size);
3487 * Calculate the size in bytes that a picture of the given width and height
3488 * would occupy if stored in the given picture format.
3489 * Note that this returns the size of a compact representation as generated
3490 * by avpicture_layout(), which can be smaller than the size required for e.g.
3493 * @param pix_fmt the given picture format
3494 * @param width the width of the image
3495 * @param height the height of the image
3496 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3498 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3499 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3501 #if FF_API_GET_PIX_FMT_NAME
3503 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3505 attribute_deprecated
3506 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3509 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3512 * Return a value representing the fourCC code associated to the
3513 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3516 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3519 * Put a string representing the codec tag codec_tag in buf.
3521 * @param buf_size size in bytes of buf
3522 * @return the length of the string that would have been generated if
3523 * enough space had been available, excluding the trailing null
3525 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3527 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3528 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3529 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3530 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3531 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3532 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3535 * Compute what kind of losses will occur when converting from one specific
3536 * pixel format to another.
3537 * When converting from one pixel format to another, information loss may occur.
3538 * For example, when converting from RGB24 to GRAY, the color information will
3539 * be lost. Similarly, other losses occur when converting from some formats to
3540 * other formats. These losses can involve loss of chroma, but also loss of
3541 * resolution, loss of color depth, loss due to the color space conversion, loss
3542 * of the alpha bits or loss due to color quantization.
3543 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3544 * which will occur when converting from one pixel format to another.
3546 * @param[in] dst_pix_fmt destination pixel format
3547 * @param[in] src_pix_fmt source pixel format
3548 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3549 * @return Combination of flags informing you what kind of losses will occur.
3551 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3555 * Find the best pixel format to convert to given a certain source pixel
3556 * format. When converting from one pixel format to another, information loss
3557 * may occur. For example, when converting from RGB24 to GRAY, the color
3558 * information will be lost. Similarly, other losses occur when converting from
3559 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3560 * the given pixel formats should be used to suffer the least amount of loss.
3561 * The pixel formats from which it chooses one, are determined by the
3562 * pix_fmt_mask parameter.
3565 * src_pix_fmt = PIX_FMT_YUV420P;
3566 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3567 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3570 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3571 * @param[in] src_pix_fmt source pixel format
3572 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3573 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3574 * @return The best pixel format to convert to or -1 if none was found.
3576 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3577 int has_alpha, int *loss_ptr);
3579 #if FF_API_GET_ALPHA_INFO
3580 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3581 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3584 * Tell if an image really has transparent alpha values.
3585 * @return ored mask of FF_ALPHA_xxx constants
3587 attribute_deprecated
3588 int img_get_alpha_info(const AVPicture *src,
3589 enum PixelFormat pix_fmt, int width, int height);
3592 /* deinterlace a picture */
3593 /* deinterlace - if not supported return -1 */
3594 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3595 enum PixelFormat pix_fmt, int width, int height);
3597 /* external high level API */
3600 * If c is NULL, returns the first registered codec,
3601 * if c is non-NULL, returns the next registered codec after c,
3602 * or NULL if c is the last one.
3604 AVCodec *av_codec_next(AVCodec *c);
3607 * Return the LIBAVCODEC_VERSION_INT constant.
3609 unsigned avcodec_version(void);
3612 * Return the libavcodec build-time configuration.
3614 const char *avcodec_configuration(void);
3617 * Return the libavcodec license.
3619 const char *avcodec_license(void);
3621 #if FF_API_AVCODEC_INIT
3623 * @deprecated this function is called automatically from avcodec_register()
3624 * and avcodec_register_all(), there is no need to call it manually
3626 attribute_deprecated
3627 void avcodec_init(void);
3631 * Register the codec codec and initialize libavcodec.
3633 * @warning either this function or avcodec_register_all() must be called
3634 * before any other libavcodec functions.
3636 * @see avcodec_register_all()
3638 void avcodec_register(AVCodec *codec);
3641 * Find a registered encoder with a matching codec ID.
3643 * @param id CodecID of the requested encoder
3644 * @return An encoder if one was found, NULL otherwise.
3646 AVCodec *avcodec_find_encoder(enum CodecID id);
3649 * Find a registered encoder with the specified name.
3651 * @param name name of the requested encoder
3652 * @return An encoder if one was found, NULL otherwise.
3654 AVCodec *avcodec_find_encoder_by_name(const char *name);
3657 * Find a registered decoder with a matching codec ID.
3659 * @param id CodecID of the requested decoder
3660 * @return A decoder if one was found, NULL otherwise.
3662 AVCodec *avcodec_find_decoder(enum CodecID id);
3665 * Find a registered decoder with the specified name.
3667 * @param name name of the requested decoder
3668 * @return A decoder if one was found, NULL otherwise.
3670 AVCodec *avcodec_find_decoder_by_name(const char *name);
3671 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3674 * Return a name for the specified profile, if available.
3676 * @param codec the codec that is searched for the given profile
3677 * @param profile the profile value for which a name is requested
3678 * @return A name for the profile if found, NULL otherwise.
3680 const char *av_get_profile_name(const AVCodec *codec, int profile);
3682 #if FF_API_ALLOC_CONTEXT
3684 * Set the fields of the given AVCodecContext to default values.
3686 * @param s The AVCodecContext of which the fields should be set to default values.
3687 * @deprecated use avcodec_get_context_defaults3
3689 attribute_deprecated
3690 void avcodec_get_context_defaults(AVCodecContext *s);
3692 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3693 * we WILL change its arguments and name a few times! */
3694 attribute_deprecated
3695 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3699 * Set the fields of the given AVCodecContext to default values corresponding
3700 * to the given codec (defaults may be codec-dependent).
3702 * Do not call this function if a non-NULL codec has been passed
3703 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3704 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3705 * different codec on this AVCodecContext.
3707 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3709 #if FF_API_ALLOC_CONTEXT
3711 * Allocate an AVCodecContext and set its fields to default values. The
3712 * resulting struct can be deallocated by simply calling av_free().
3714 * @return An AVCodecContext filled with default values or NULL on failure.
3715 * @see avcodec_get_context_defaults
3717 * @deprecated use avcodec_alloc_context3()
3719 attribute_deprecated
3720 AVCodecContext *avcodec_alloc_context(void);
3722 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3723 * we WILL change its arguments and name a few times! */
3724 attribute_deprecated
3725 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3729 * Allocate an AVCodecContext and set its fields to default values. The
3730 * resulting struct can be deallocated by simply calling av_free().
3732 * @param codec if non-NULL, allocate private data and initialize defaults
3733 * for the given codec. It is illegal to then call avcodec_open2()
3734 * with a different codec.
3736 * @return An AVCodecContext filled with default values or NULL on failure.
3737 * @see avcodec_get_context_defaults
3739 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3742 * Copy the settings of the source AVCodecContext into the destination
3743 * AVCodecContext. The resulting destination codec context will be
3744 * unopened, i.e. you are required to call avcodec_open2() before you
3745 * can use this AVCodecContext to decode/encode video/audio data.
3747 * @param dest target codec context, should be initialized with
3748 * avcodec_alloc_context3(), but otherwise uninitialized
3749 * @param src source codec context
3750 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3752 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3755 * Set the fields of the given AVFrame to default values.
3757 * @param pic The AVFrame of which the fields should be set to default values.
3759 void avcodec_get_frame_defaults(AVFrame *pic);
3762 * Allocate an AVFrame and set its fields to default values. The resulting
3763 * struct can be deallocated by simply calling av_free().
3765 * @return An AVFrame filled with default values or NULL on failure.
3766 * @see avcodec_get_frame_defaults
3768 AVFrame *avcodec_alloc_frame(void);
3770 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3771 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3772 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3775 * Return the amount of padding in pixels which the get_buffer callback must
3776 * provide around the edge of the image for codecs which do not have the
3777 * CODEC_FLAG_EMU_EDGE flag.
3779 * @return Required padding in pixels.
3781 unsigned avcodec_get_edge_width(void);
3783 * Modify width and height values so that they will result in a memory
3784 * buffer that is acceptable for the codec if you do not use any horizontal
3787 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3788 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3789 * according to avcodec_get_edge_width() before.
3791 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3793 * Modify width and height values so that they will result in a memory
3794 * buffer that is acceptable for the codec if you also ensure that all
3795 * line sizes are a multiple of the respective linesize_align[i].
3797 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3798 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3799 * according to avcodec_get_edge_width() before.
3801 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3802 int linesize_align[AV_NUM_DATA_POINTERS]);
3804 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3806 #if FF_API_THREAD_INIT
3808 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
3810 attribute_deprecated
3811 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3814 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3815 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3816 //FIXME func typedef
3818 #if FF_API_AVCODEC_OPEN
3820 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3821 * function the context has to be allocated.
3823 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3824 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3825 * retrieving a codec.
3827 * @warning This function is not thread safe!
3830 * avcodec_register_all();
3831 * codec = avcodec_find_decoder(CODEC_ID_H264);
3835 * context = avcodec_alloc_context3(codec);
3837 * if (avcodec_open(context, codec) < 0)
3841 * @param avctx The context which will be set up to use the given codec.
3842 * @param codec The codec to use within the context.
3843 * @return zero on success, a negative value on error
3844 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3846 * @deprecated use avcodec_open2
3848 attribute_deprecated
3849 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3853 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3854 * function the context has to be allocated with avcodec_alloc_context3().
3856 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3857 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3858 * retrieving a codec.
3860 * @warning This function is not thread safe!
3863 * avcodec_register_all();
3864 * av_dict_set(&opts, "b", "2.5M", 0);
3865 * codec = avcodec_find_decoder(CODEC_ID_H264);
3869 * context = avcodec_alloc_context3(codec);
3871 * if (avcodec_open2(context, codec, opts) < 0)
3875 * @param avctx The context to initialize.
3876 * @param options A dictionary filled with AVCodecContext and codec-private options.
3877 * On return this object will be filled with options that were not found.
3879 * @return zero on success, a negative value on error
3880 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3881 * av_dict_set(), av_opt_find().
3883 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3886 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3887 * Some decoders may support multiple frames in a single AVPacket, such
3888 * decoders would then just decode the first frame. In this case,
3889 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3890 * the remaining data in order to decode the second frame etc.
3892 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3893 * decompressed frame size in bytes.
3895 * @warning You must set frame_size_ptr to the allocated size of the
3896 * output buffer before calling avcodec_decode_audio3().
3898 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3899 * the actual read bytes because some optimized bitstream readers read 32 or 64
3900 * bits at once and could read over the end.
3902 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3903 * no overreading happens for damaged MPEG streams.
3905 * @note You might have to align the input buffer avpkt->data and output buffer
3906 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3907 * necessary at all, on others it won't work at all if not aligned and on others
3908 * it will work but it will have an impact on performance.
3910 * In practice, avpkt->data should have 4 byte alignment at minimum and
3911 * samples should be 16 byte aligned unless the CPU doesn't need it
3912 * (AltiVec and SSE do).
3914 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3915 * between input and output, these need to be fed with avpkt->data=NULL,
3916 * avpkt->size=0 at the end to return the remaining frames.
3918 * @param avctx the codec context
3919 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3920 * @param[in,out] frame_size_ptr the output buffer size in bytes
3921 * @param[in] avpkt The input AVPacket containing the input buffer.
3922 * You can create such packet with av_init_packet() and by then setting
3923 * data and size, some decoders might in addition need other fields.
3924 * All decoders are designed to use the least fields possible though.
3925 * @return On error a negative value is returned, otherwise the number of bytes
3926 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3928 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3929 int *frame_size_ptr,
3933 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3934 * Some decoders may support multiple frames in a single AVPacket, such
3935 * decoders would then just decode the first frame.
3937 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3938 * the actual read bytes because some optimized bitstream readers read 32 or 64
3939 * bits at once and could read over the end.
3941 * @warning The end of the input buffer buf should be set to 0 to ensure that
3942 * no overreading happens for damaged MPEG streams.
3944 * @note You might have to align the input buffer avpkt->data.
3945 * The alignment requirements depend on the CPU: on some CPUs it isn't
3946 * necessary at all, on others it won't work at all if not aligned and on others
3947 * it will work but it will have an impact on performance.
3949 * In practice, avpkt->data should have 4 byte alignment at minimum.
3951 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3952 * between input and output, these need to be fed with avpkt->data=NULL,
3953 * avpkt->size=0 at the end to return the remaining frames.
3955 * @param avctx the codec context
3956 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3957 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3958 * allocate memory for the actual bitmap.
3959 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3960 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3961 * decodes and the decoder tells the user once it does not need the data anymore,
3962 * the user app can at this point free/reuse/keep the memory as it sees fit.
3964 * @param[in] avpkt The input AVpacket containing the input buffer.
3965 * You can create such packet with av_init_packet() and by then setting
3966 * data and size, some decoders might in addition need other fields like
3967 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3969 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3970 * @return On error a negative value is returned, otherwise the number of bytes
3971 * used or zero if no frame could be decompressed.
3973 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3974 int *got_picture_ptr,
3978 * Decode a subtitle message.
3979 * Return a negative value on error, otherwise return the number of bytes used.
3980 * If no subtitle could be decompressed, got_sub_ptr is zero.
3981 * Otherwise, the subtitle is stored in *sub.
3982 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3983 * simplicity, because the performance difference is expect to be negligible
3984 * and reusing a get_buffer written for video codecs would probably perform badly
3985 * due to a potentially very different allocation pattern.
3987 * @param avctx the codec context
3988 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3989 freed with avsubtitle_free if *got_sub_ptr is set.
3990 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3991 * @param[in] avpkt The input AVPacket containing the input buffer.
3993 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3998 * Frees all allocated data in the given subtitle struct.
4000 * @param sub AVSubtitle to free.
4002 void avsubtitle_free(AVSubtitle *sub);
4005 * Encode an audio frame from samples into buf.
4007 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4008 * However, for PCM audio the user will know how much space is needed
4009 * because it depends on the value passed in buf_size as described
4010 * below. In that case a lower value can be used.
4012 * @param avctx the codec context
4013 * @param[out] buf the output buffer
4014 * @param[in] buf_size the output buffer size
4015 * @param[in] samples the input buffer containing the samples
4016 * The number of samples read from this buffer is frame_size*channels,
4017 * both of which are defined in avctx.
4018 * For PCM audio the number of samples read from samples is equal to
4019 * buf_size * input_sample_size / output_sample_size.
4020 * @return On error a negative value is returned, on success zero or the number
4021 * of bytes used to encode the data read from the input buffer.
4023 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4024 const short *samples);
4027 * Encode a video frame from pict into buf.
4028 * The input picture should be
4029 * stored using a specific format, namely avctx.pix_fmt.
4031 * @param avctx the codec context
4032 * @param[out] buf the output buffer for the bitstream of encoded frame
4033 * @param[in] buf_size the size of the output buffer in bytes
4034 * @param[in] pict the input picture to encode
4035 * @return On error a negative value is returned, on success zero or the number
4036 * of bytes used from the output buffer.
4038 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4039 const AVFrame *pict);
4040 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4041 const AVSubtitle *sub);
4043 int avcodec_close(AVCodecContext *avctx);
4046 * Register all the codecs, parsers and bitstream filters which were enabled at
4047 * configuration time. If you do not call this function you can select exactly
4048 * which formats you want to support, by using the individual registration
4051 * @see avcodec_register
4052 * @see av_register_codec_parser
4053 * @see av_register_bitstream_filter
4055 void avcodec_register_all(void);
4058 * Flush buffers, should be called when seeking or when switching to a different stream.
4060 void avcodec_flush_buffers(AVCodecContext *avctx);
4062 void avcodec_default_free_buffers(AVCodecContext *s);
4064 /* misc useful functions */
4066 #if FF_API_OLD_FF_PICT_TYPES
4068 * Return a single letter to describe the given picture type pict_type.
4070 * @param[in] pict_type the picture type
4071 * @return A single character representing the picture type.
4072 * @deprecated Use av_get_picture_type_char() instead.
4074 attribute_deprecated
4075 char av_get_pict_type_char(int pict_type);
4079 * Return codec bits per sample.
4081 * @param[in] codec_id the codec
4082 * @return Number of bits per sample or zero if unknown for the given codec.
4084 int av_get_bits_per_sample(enum CodecID codec_id);
4086 #if FF_API_OLD_SAMPLE_FMT
4088 * @deprecated Use av_get_bytes_per_sample() instead.
4090 attribute_deprecated
4091 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4095 typedef struct AVCodecParserContext {
4097 struct AVCodecParser *parser;
4098 int64_t frame_offset; /* offset of the current frame */
4099 int64_t cur_offset; /* current offset
4100 (incremented by each av_parser_parse()) */
4101 int64_t next_frame_offset; /* offset of the next frame */
4103 int pict_type; /* XXX: Put it back in AVCodecContext. */
4105 * This field is used for proper frame duration computation in lavf.
4106 * It signals, how much longer the frame duration of the current frame
4107 * is compared to normal frame duration.
4109 * frame_duration = (1 + repeat_pict) * time_base
4111 * It is used by codecs like H.264 to display telecined material.
4113 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4114 int64_t pts; /* pts of the current frame */
4115 int64_t dts; /* dts of the current frame */
4120 int fetch_timestamp;
4122 #define AV_PARSER_PTS_NB 4
4123 int cur_frame_start_index;
4124 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4125 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4126 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4129 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4130 #define PARSER_FLAG_ONCE 0x0002
4131 /// Set if the parser has a valid file offset
4132 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4134 int64_t offset; ///< byte offset from starting packet start
4135 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4138 * Set by parser to 1 for key frames and 0 for non-key frames.
4139 * It is initialized to -1, so if the parser doesn't set this flag,
4140 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4146 * Time difference in stream time base units from the pts of this
4147 * packet to the point at which the output from the decoder has converged
4148 * independent from the availability of previous frames. That is, the
4149 * frames are virtually identical no matter if decoding started from
4150 * the very first frame or from this keyframe.
4151 * Is AV_NOPTS_VALUE if unknown.
4152 * This field is not the display duration of the current frame.
4153 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4156 * The purpose of this field is to allow seeking in streams that have no
4157 * keyframes in the conventional sense. It corresponds to the
4158 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4159 * essential for some types of subtitle streams to ensure that all
4160 * subtitles are correctly displayed after seeking.
4162 int64_t convergence_duration;
4164 // Timestamp generation support:
4166 * Synchronization point for start of timestamp generation.
4168 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4171 * For example, this corresponds to presence of H.264 buffering period
4177 * Offset of the current timestamp against last timestamp sync point in
4178 * units of AVCodecContext.time_base.
4180 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4181 * contain a valid timestamp offset.
4183 * Note that the timestamp of sync point has usually a nonzero
4184 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4185 * the next frame after timestamp sync point will be usually 1.
4187 * For example, this corresponds to H.264 cpb_removal_delay.
4189 int dts_ref_dts_delta;
4192 * Presentation delay of current frame in units of AVCodecContext.time_base.
4194 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4195 * contain valid non-negative timestamp delta (presentation time of a frame
4196 * must not lie in the past).
4198 * This delay represents the difference between decoding and presentation
4199 * time of the frame.
4201 * For example, this corresponds to H.264 dpb_output_delay.
4206 * Position of the packet in file.
4208 * Analogous to cur_frame_pts/dts
4210 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4213 * Byte position of currently parsed frame in stream.
4218 * Previous frame byte position.
4221 } AVCodecParserContext;
4223 typedef struct AVCodecParser {
4224 int codec_ids[5]; /* several codec IDs are permitted */
4226 int (*parser_init)(AVCodecParserContext *s);
4227 int (*parser_parse)(AVCodecParserContext *s,
4228 AVCodecContext *avctx,
4229 const uint8_t **poutbuf, int *poutbuf_size,
4230 const uint8_t *buf, int buf_size);
4231 void (*parser_close)(AVCodecParserContext *s);
4232 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4233 struct AVCodecParser *next;
4236 AVCodecParser *av_parser_next(AVCodecParser *c);
4238 void av_register_codec_parser(AVCodecParser *parser);
4239 AVCodecParserContext *av_parser_init(int codec_id);
4244 * @param s parser context.
4245 * @param avctx codec context.
4246 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4247 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4248 * @param buf input buffer.
4249 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4250 * @param pts input presentation timestamp.
4251 * @param dts input decoding timestamp.
4252 * @param pos input byte position in stream.
4253 * @return the number of bytes of the input bitstream used.
4258 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4265 * decode_frame(data, size);
4269 int av_parser_parse2(AVCodecParserContext *s,
4270 AVCodecContext *avctx,
4271 uint8_t **poutbuf, int *poutbuf_size,
4272 const uint8_t *buf, int buf_size,
4273 int64_t pts, int64_t dts,
4276 int av_parser_change(AVCodecParserContext *s,
4277 AVCodecContext *avctx,
4278 uint8_t **poutbuf, int *poutbuf_size,
4279 const uint8_t *buf, int buf_size, int keyframe);
4280 void av_parser_close(AVCodecParserContext *s);
4283 typedef struct AVBitStreamFilterContext {
4285 struct AVBitStreamFilter *filter;
4286 AVCodecParserContext *parser;
4287 struct AVBitStreamFilterContext *next;
4288 } AVBitStreamFilterContext;
4291 typedef struct AVBitStreamFilter {
4294 int (*filter)(AVBitStreamFilterContext *bsfc,
4295 AVCodecContext *avctx, const char *args,
4296 uint8_t **poutbuf, int *poutbuf_size,
4297 const uint8_t *buf, int buf_size, int keyframe);
4298 void (*close)(AVBitStreamFilterContext *bsfc);
4299 struct AVBitStreamFilter *next;
4300 } AVBitStreamFilter;
4302 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4303 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4304 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4305 AVCodecContext *avctx, const char *args,
4306 uint8_t **poutbuf, int *poutbuf_size,
4307 const uint8_t *buf, int buf_size, int keyframe);
4308 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4310 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4315 * Reallocate the given block if it is not large enough, otherwise do nothing.
4319 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4322 * Allocate a buffer, reusing the given one if large enough.
4324 * Contrary to av_fast_realloc the current buffer contents might not be
4325 * preserved and on error the old buffer is freed, thus no special
4326 * handling to avoid memleaks is necessary.
4328 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4329 * @param size size of the buffer *ptr points to
4330 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4331 * *size 0 if an error occurred.
4333 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4336 * Copy image src to dst. Wraps av_picture_data_copy() above.
4338 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4339 enum PixelFormat pix_fmt, int width, int height);
4342 * Crop image top and left side.
4344 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4345 enum PixelFormat pix_fmt, int top_band, int left_band);
4350 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4351 int padtop, int padbottom, int padleft, int padright, int *color);
4354 * Encode extradata length to a buffer. Used by xiph codecs.
4356 * @param s buffer to write to; must be at least (v/255+1) bytes long
4357 * @param v size of extradata in bytes
4358 * @return number of bytes written to the buffer.
4360 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4363 * Logs a generic warning message about a missing feature. This function is
4364 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4365 * only, and would normally not be used by applications.
4366 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4367 * a pointer to an AVClass struct
4368 * @param[in] feature string containing the name of the missing feature
4369 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4370 * If want_sample is non-zero, additional verbage will be added to the log
4371 * message which tells the user how to report samples to the development
4374 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4377 * Log a generic warning message asking for a sample. This function is
4378 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4379 * only, and would normally not be used by applications.
4380 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4381 * a pointer to an AVClass struct
4382 * @param[in] msg string containing an optional message, or NULL if no message
4384 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4387 * Register the hardware accelerator hwaccel.
4389 void av_register_hwaccel(AVHWAccel *hwaccel);
4392 * If hwaccel is NULL, returns the first registered hardware accelerator,
4393 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4394 * after hwaccel, or NULL if hwaccel is the last one.
4396 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4400 * Lock operation used by lockmgr
4403 AV_LOCK_CREATE, ///< Create a mutex
4404 AV_LOCK_OBTAIN, ///< Lock the mutex
4405 AV_LOCK_RELEASE, ///< Unlock the mutex
4406 AV_LOCK_DESTROY, ///< Free mutex resources
4410 * Register a user provided lock manager supporting the operations
4411 * specified by AVLockOp. mutex points to a (void *) where the
4412 * lockmgr should store/get a pointer to a user allocated mutex. It's
4413 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4415 * @param cb User defined callback. Note: Libav may invoke calls to this
4416 * callback during the call to av_lockmgr_register().
4417 * Thus, the application must be prepared to handle that.
4418 * If cb is set to NULL the lockmgr will be unregistered.
4419 * Also note that during unregistration the previously registered
4420 * lockmgr callback may also be invoked.
4422 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4425 * Get the type of the given codec.
4427 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4430 * Get the AVClass for AVCodecContext. It can be used in combination with
4431 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4433 * @see av_opt_find().
4435 const AVClass *avcodec_get_class(void);
4437 #endif /* AVCODEC_AVCODEC_H */