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
258 /* various PCM "codecs" */
259 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
260 CODEC_ID_PCM_S16LE = 0x10000,
276 CODEC_ID_PCM_S24DAUD,
278 CODEC_ID_PCM_S16LE_PLANAR,
287 CODEC_ID_PCM_S8_PLANAR,
289 /* various ADPCM codecs */
290 CODEC_ID_ADPCM_IMA_QT = 0x11000,
291 CODEC_ID_ADPCM_IMA_WAV,
292 CODEC_ID_ADPCM_IMA_DK3,
293 CODEC_ID_ADPCM_IMA_DK4,
294 CODEC_ID_ADPCM_IMA_WS,
295 CODEC_ID_ADPCM_IMA_SMJPEG,
304 CODEC_ID_ADPCM_YAMAHA,
305 CODEC_ID_ADPCM_SBPRO_4,
306 CODEC_ID_ADPCM_SBPRO_3,
307 CODEC_ID_ADPCM_SBPRO_2,
309 CODEC_ID_ADPCM_IMA_AMV,
310 CODEC_ID_ADPCM_EA_R1,
311 CODEC_ID_ADPCM_EA_R3,
312 CODEC_ID_ADPCM_EA_R2,
313 CODEC_ID_ADPCM_IMA_EA_SEAD,
314 CODEC_ID_ADPCM_IMA_EA_EACS,
315 CODEC_ID_ADPCM_EA_XAS,
316 CODEC_ID_ADPCM_EA_MAXIS_XA,
317 CODEC_ID_ADPCM_IMA_ISS,
321 CODEC_ID_AMR_NB = 0x12000,
324 /* RealAudio codecs*/
325 CODEC_ID_RA_144 = 0x13000,
328 /* various DPCM codecs */
329 CODEC_ID_ROQ_DPCM = 0x14000,
330 CODEC_ID_INTERPLAY_DPCM,
335 CODEC_ID_MP2 = 0x15000,
336 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
347 #if LIBAVCODEC_VERSION_MAJOR == 53
356 CODEC_ID_WESTWOOD_SND1,
357 CODEC_ID_GSM, ///< as in Berlin toast format
365 CODEC_ID_DSICINAUDIO,
369 CODEC_ID_GSM_MS, /* as found in WAV */
378 CODEC_ID_WMALOSSLESS,
387 CODEC_ID_BINKAUDIO_RDFT,
388 CODEC_ID_BINKAUDIO_DCT,
392 #if LIBAVCODEC_VERSION_MAJOR > 53
400 /* subtitle codecs */
401 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
402 CODEC_ID_DVD_SUBTITLE = 0x17000,
403 CODEC_ID_DVB_SUBTITLE,
404 CODEC_ID_TEXT, ///< raw UTF-8 text
408 CODEC_ID_HDMV_PGS_SUBTITLE,
409 CODEC_ID_DVB_TELETEXT,
412 /* other specific kind of codecs (generally used for attachments) */
413 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
414 CODEC_ID_TTF = 0x18000,
416 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
418 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
419 * stream (only used by libavformat) */
420 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
421 * stream (only used by libavformat) */
422 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
425 #if FF_API_OLD_SAMPLE_FMT
426 #define SampleFormat AVSampleFormat
428 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
429 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
430 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
431 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
432 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
433 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
434 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
437 #if FF_API_OLD_AUDIOCONVERT
438 #include "libavutil/audioconvert.h"
440 /* Audio channel masks */
441 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
442 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
443 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
444 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
445 #define CH_BACK_LEFT AV_CH_BACK_LEFT
446 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
447 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
448 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
449 #define CH_BACK_CENTER AV_CH_BACK_CENTER
450 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
451 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
452 #define CH_TOP_CENTER AV_CH_TOP_CENTER
453 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
454 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
455 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
456 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
457 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
458 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
459 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
460 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
462 /** Channel mask value used for AVCodecContext.request_channel_layout
463 to indicate that the user requests the channel order of the decoder output
464 to be the native codec channel order. */
465 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
467 /* Audio channel convenience macros */
468 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
469 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
470 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
471 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
472 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
473 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
474 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
475 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
476 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
477 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
478 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
479 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
480 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
481 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
482 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
485 #if FF_API_OLD_DECODE_AUDIO
487 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
491 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
492 * This is mainly needed because some optimized bitstream readers read
493 * 32 or 64 bit at once and could read over the end.<br>
494 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
495 * MPEG bitstreams could cause overread and segfault.
497 #define FF_INPUT_BUFFER_PADDING_SIZE 8
500 * minimum encoding buffer size
501 * Used to avoid some checks during header writing.
503 #define FF_MIN_BUFFER_SIZE 16384
507 * motion estimation type.
510 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
514 ME_EPZS, ///< enhanced predictive zonal search
515 ME_X1, ///< reserved for experiments
516 ME_HEX, ///< hexagon based search
517 ME_UMH, ///< uneven multi-hexagon search
518 ME_ITER, ///< iterative search
519 ME_TESA, ///< transformed exhaustive search algorithm
523 /* We leave some space between them for extensions (drop some
524 * keyframes for intra-only or drop just some bidir frames). */
525 AVDISCARD_NONE =-16, ///< discard nothing
526 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
527 AVDISCARD_NONREF = 8, ///< discard all non reference
528 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
529 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
530 AVDISCARD_ALL = 48, ///< discard all
533 enum AVColorPrimaries{
534 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
535 AVCOL_PRI_UNSPECIFIED=2,
537 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
538 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
539 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
541 AVCOL_PRI_NB , ///< Not part of ABI
544 enum AVColorTransferCharacteristic{
545 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
546 AVCOL_TRC_UNSPECIFIED=2,
547 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
548 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
549 AVCOL_TRC_NB , ///< Not part of ABI
554 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
555 AVCOL_SPC_UNSPECIFIED=2,
557 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
558 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
559 AVCOL_SPC_SMPTE240M =7,
560 AVCOL_SPC_NB , ///< Not part of ABI
564 AVCOL_RANGE_UNSPECIFIED=0,
565 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
566 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
567 AVCOL_RANGE_NB , ///< Not part of ABI
571 * X X 3 4 X X are luma samples,
572 * 1 2 1-6 are possible chroma positions
573 * X X 5 6 X 0 is undefined/unknown position
575 enum AVChromaLocation{
576 AVCHROMA_LOC_UNSPECIFIED=0,
577 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
578 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
579 AVCHROMA_LOC_TOPLEFT =3, ///< DV
581 AVCHROMA_LOC_BOTTOMLEFT =5,
582 AVCHROMA_LOC_BOTTOM =6,
583 AVCHROMA_LOC_NB , ///< Not part of ABI
586 #if FF_API_FLAC_GLOBAL_OPTS
591 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
592 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
593 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
594 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
595 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
596 AV_LPC_TYPE_NB , ///< Not part of ABI
600 enum AVAudioServiceType {
601 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
602 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
603 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
604 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
605 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
606 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
607 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
608 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
609 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
610 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
613 typedef struct RcOverride{
616 int qscale; // If this is 0 then quality_factor will be used instead.
617 float quality_factor;
620 #define FF_MAX_B_FRAMES 16
623 These flags can be passed in AVCodecContext.flags before initialization.
624 Note: Not everything is supported yet.
627 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
628 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
629 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
630 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
631 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
633 * The parent program guarantees that the input for B-frames containing
634 * streams is not written to for at least s->max_b_frames+1 frames, if
635 * this is not set the input will be copied.
637 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
638 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
639 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
640 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
641 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
642 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
643 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
644 location instead of only at frame boundaries. */
645 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
646 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
647 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
648 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
649 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
650 /* Fx : Flag for h263+ extra options */
651 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
652 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
653 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
654 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
655 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
656 #define CODEC_FLAG_CLOSED_GOP 0x80000000
657 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
658 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
659 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
660 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
661 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
662 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
664 * @defgroup deprecated_flags Deprecated codec flags
665 * Use corresponding private codec options instead.
668 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
669 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
670 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
671 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
672 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
673 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
674 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
675 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
676 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
677 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
678 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
680 #if FF_API_MJPEG_GLOBAL_OPTS
681 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
683 #if FF_API_X264_GLOBAL_OPTS
684 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
685 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
686 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
687 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
688 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
689 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
690 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
691 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
692 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
693 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
694 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
696 #if FF_API_SNOW_GLOBAL_OPTS
697 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
699 #if FF_API_LAME_GLOBAL_OPTS
700 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
706 /* Unsupported options :
707 * Syntax Arithmetic coding (SAC)
708 * Reference Picture Selection
709 * Independent Segment Decoding */
711 /* codec capabilities */
713 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
715 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
716 * If not set, it might not use get_buffer() at all or use operations that
717 * assume the buffer was allocated by avcodec_default_get_buffer.
719 #define CODEC_CAP_DR1 0x0002
720 #if FF_API_PARSE_FRAME
721 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
722 #define CODEC_CAP_PARSE_ONLY 0x0004
724 #define CODEC_CAP_TRUNCATED 0x0008
725 /* Codec can export data for HW decoding (XvMC). */
726 #define CODEC_CAP_HWACCEL 0x0010
728 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
729 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
730 * returns frames. If this is not set, the codec is guaranteed to never be fed
733 #define CODEC_CAP_DELAY 0x0020
735 * Codec can be fed a final frame with a smaller size.
736 * This can be used to prevent truncation of the last audio samples.
738 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
740 * Codec can export data for HW decoding (VDPAU).
742 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
744 * Codec can output multiple frames per AVPacket
745 * Normally demuxers return one frame at a time, demuxers which do not do
746 * are connected to a parser to split what they return into proper frames.
747 * This flag is reserved to the very rare category of codecs which have a
748 * bitstream that cannot be split into frames without timeconsuming
749 * operations like full decoding. Demuxers carring such bitstreams thus
750 * may return multiple frames in a packet. This has many disadvantages like
751 * prohibiting stream copy in many cases thus it should only be considered
754 #define CODEC_CAP_SUBFRAMES 0x0100
756 * Codec is experimental and is thus avoided in favor of non experimental
759 #define CODEC_CAP_EXPERIMENTAL 0x0200
761 * Codec should fill in channel configuration and samplerate instead of container
763 #define CODEC_CAP_CHANNEL_CONF 0x0400
765 * Codec is able to deal with negative linesizes
767 #define CODEC_CAP_NEG_LINESIZES 0x0800
769 * Codec supports frame-level multithreading.
771 #define CODEC_CAP_FRAME_THREADS 0x1000
773 * Codec supports slice-based (or partition-based) multithreading.
775 #define CODEC_CAP_SLICE_THREADS 0x2000
777 * Codec supports changed parameters at any point.
779 #define CODEC_CAP_PARAM_CHANGE 0x4000
781 //The following defines may change, don't expect compatibility if you use them.
782 #define MB_TYPE_INTRA4x4 0x0001
783 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
784 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
785 #define MB_TYPE_16x16 0x0008
786 #define MB_TYPE_16x8 0x0010
787 #define MB_TYPE_8x16 0x0020
788 #define MB_TYPE_8x8 0x0040
789 #define MB_TYPE_INTERLACED 0x0080
790 #define MB_TYPE_DIRECT2 0x0100 //FIXME
791 #define MB_TYPE_ACPRED 0x0200
792 #define MB_TYPE_GMC 0x0400
793 #define MB_TYPE_SKIP 0x0800
794 #define MB_TYPE_P0L0 0x1000
795 #define MB_TYPE_P1L0 0x2000
796 #define MB_TYPE_P0L1 0x4000
797 #define MB_TYPE_P1L1 0x8000
798 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
799 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
800 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
801 #define MB_TYPE_QUANT 0x00010000
802 #define MB_TYPE_CBP 0x00020000
803 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
807 * This specifies the area which should be displayed.
808 * Note there may be multiple such areas for one frame.
810 typedef struct AVPanScan{
813 * - encoding: Set by user.
814 * - decoding: Set by libavcodec.
819 * width and height in 1/16 pel
820 * - encoding: Set by user.
821 * - decoding: Set by libavcodec.
827 * position of the top left corner in 1/16 pel for up to 3 fields/frames
828 * - encoding: Set by user.
829 * - decoding: Set by libavcodec.
831 int16_t position[3][2];
834 #define FF_QSCALE_TYPE_MPEG1 0
835 #define FF_QSCALE_TYPE_MPEG2 1
836 #define FF_QSCALE_TYPE_H264 2
837 #define FF_QSCALE_TYPE_VP56 3
839 #define FF_BUFFER_TYPE_INTERNAL 1
840 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
841 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
842 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
844 #if FF_API_OLD_FF_PICT_TYPES
845 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
846 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
847 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
848 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
849 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
850 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
851 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
852 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
855 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
856 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
857 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
858 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
860 enum AVPacketSideDataType {
862 AV_PKT_DATA_NEW_EXTRADATA,
863 AV_PKT_DATA_PARAM_CHANGE,
866 typedef struct AVPacket {
868 * Presentation timestamp in AVStream->time_base units; the time at which
869 * the decompressed packet will be presented to the user.
870 * Can be AV_NOPTS_VALUE if it is not stored in the file.
871 * pts MUST be larger or equal to dts as presentation cannot happen before
872 * decompression, unless one wants to view hex dumps. Some formats misuse
873 * the terms dts and pts/cts to mean something different. Such timestamps
874 * must be converted to true pts/dts before they are stored in AVPacket.
878 * Decompression timestamp in AVStream->time_base units; the time at which
879 * the packet is decompressed.
880 * Can be AV_NOPTS_VALUE if it is not stored in the file.
887 * A combination of AV_PKT_FLAG values
891 * Additional packet data that can be provided by the container.
892 * Packet can contain several types of side information.
897 enum AVPacketSideDataType type;
902 * Duration of this packet in AVStream->time_base units, 0 if unknown.
903 * Equals next_pts - this_pts in presentation order.
906 void (*destruct)(struct AVPacket *);
908 int64_t pos; ///< byte position in stream, -1 if unknown
911 * Time difference in AVStream->time_base units from the pts of this
912 * packet to the point at which the output from the decoder has converged
913 * independent from the availability of previous frames. That is, the
914 * frames are virtually identical no matter if decoding started from
915 * the very first frame or from this keyframe.
916 * Is AV_NOPTS_VALUE if unknown.
917 * This field is not the display duration of the current packet.
918 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
921 * The purpose of this field is to allow seeking in streams that have no
922 * keyframes in the conventional sense. It corresponds to the
923 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
924 * essential for some types of subtitle streams to ensure that all
925 * subtitles are correctly displayed after seeking.
927 int64_t convergence_duration;
929 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
930 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
933 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
935 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
936 * s32le channel_count
937 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
938 * u64le channel_layout
939 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
941 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
946 enum AVSideDataParamChangeFlags {
947 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
948 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
949 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
950 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
955 * New fields can be added to the end of AVFRAME with minor version
956 * bumps. Removal, reordering and changes to existing fields require
957 * a major version bump.
958 * sizeof(AVFrame) must not be used outside libav*.
960 typedef struct AVFrame {
961 #if FF_API_DATA_POINTERS
962 #define AV_NUM_DATA_POINTERS 4
964 #define AV_NUM_DATA_POINTERS 8
967 * pointer to the picture/channel planes.
968 * This might be different from the first allocated byte
969 * - encoding: Set by user
970 * - decoding: set by AVCodecContext.get_buffer()
972 uint8_t *data[AV_NUM_DATA_POINTERS];
975 * Size, in bytes, of the data for each picture/channel plane.
977 * For audio, only linesize[0] may be set. For planar audio, each channel
978 * plane must be the same size.
980 * - encoding: Set by user (video only)
981 * - decoding: set by AVCodecContext.get_buffer()
983 int linesize[AV_NUM_DATA_POINTERS];
986 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
987 * This isn't used by libavcodec unless the default get/release_buffer() is used.
991 uint8_t *base[AV_NUM_DATA_POINTERS];
993 * 1 -> keyframe, 0-> not
994 * - encoding: Set by libavcodec.
995 * - decoding: Set by libavcodec.
1000 * Picture type of the frame, see ?_TYPE below.
1001 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1002 * - decoding: Set by libavcodec.
1004 enum AVPictureType pict_type;
1007 * presentation timestamp in time_base units (time when frame should be shown to user)
1008 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1009 * - encoding: MUST be set by user.
1010 * - decoding: Set by libavcodec.
1015 * picture number in bitstream order
1016 * - encoding: set by
1017 * - decoding: Set by libavcodec.
1019 int coded_picture_number;
1021 * picture number in display order
1022 * - encoding: set by
1023 * - decoding: Set by libavcodec.
1025 int display_picture_number;
1028 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1029 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1030 * - decoding: Set by libavcodec.
1034 #if FF_API_AVFRAME_AGE
1036 * @deprecated unused
1038 attribute_deprecated int age;
1042 * is this picture used as reference
1043 * The values for this are the same as the MpegEncContext.picture_structure
1044 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1045 * Set to 4 for delayed, non-reference frames.
1046 * - encoding: unused
1047 * - decoding: Set by libavcodec. (before get_buffer() call)).
1053 * - encoding: unused
1054 * - decoding: Set by libavcodec.
1056 int8_t *qscale_table;
1059 * - encoding: unused
1060 * - decoding: Set by libavcodec.
1065 * mbskip_table[mb]>=1 if MB didn't change
1066 * stride= mb_width = (width+15)>>4
1067 * - encoding: unused
1068 * - decoding: Set by libavcodec.
1070 uint8_t *mbskip_table;
1073 * motion vector table
1076 * int mv_sample_log2= 4 - motion_subsample_log2;
1077 * int mb_width= (width+15)>>4;
1078 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1079 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1081 * - encoding: Set by user.
1082 * - decoding: Set by libavcodec.
1084 int16_t (*motion_val[2])[2];
1087 * macroblock type table
1088 * mb_type_base + mb_width + 2
1089 * - encoding: Set by user.
1090 * - decoding: Set by libavcodec.
1095 * log2 of the size of the block which a single vector in motion_val represents:
1096 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1097 * - encoding: unused
1098 * - decoding: Set by libavcodec.
1100 uint8_t motion_subsample_log2;
1103 * for some private data of the user
1104 * - encoding: unused
1105 * - decoding: Set by user.
1111 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1112 * - decoding: unused
1114 uint64_t error[AV_NUM_DATA_POINTERS];
1117 * type of the buffer (to keep track of who has to deallocate data[*])
1118 * - encoding: Set by the one who allocates it.
1119 * - decoding: Set by the one who allocates it.
1120 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1125 * When decoding, this signals how much the picture must be delayed.
1126 * extra_delay = repeat_pict / (2*fps)
1127 * - encoding: unused
1128 * - decoding: Set by libavcodec.
1138 * The content of the picture is interlaced.
1139 * - encoding: Set by user.
1140 * - decoding: Set by libavcodec. (default 0)
1142 int interlaced_frame;
1145 * If the content is interlaced, is top field displayed first.
1146 * - encoding: Set by user.
1147 * - decoding: Set by libavcodec.
1149 int top_field_first;
1153 * - encoding: Set by user.
1154 * - decoding: Set by libavcodec.
1156 AVPanScan *pan_scan;
1159 * Tell user application that palette has changed from previous frame.
1160 * - encoding: ??? (no palette-enabled encoder yet)
1161 * - decoding: Set by libavcodec. (default 0).
1163 int palette_has_changed;
1166 * codec suggestion on buffer type if != 0
1167 * - encoding: unused
1168 * - decoding: Set by libavcodec. (before get_buffer() call)).
1174 * - encoding: unused
1175 * - decoding: Set by libavcodec.
1180 * motion reference frame index
1181 * the order in which these are stored can depend on the codec.
1182 * - encoding: Set by user.
1183 * - decoding: Set by libavcodec.
1185 int8_t *ref_index[2];
1188 * reordered opaque 64bit (generally an integer or a double precision float
1189 * PTS but can be anything).
1190 * The user sets AVCodecContext.reordered_opaque to represent the input at
1192 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1193 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1194 * @deprecated in favor of pkt_pts
1195 * - encoding: unused
1196 * - decoding: Read by user.
1198 int64_t reordered_opaque;
1201 * hardware accelerator private data (Libav-allocated)
1202 * - encoding: unused
1203 * - decoding: Set by libavcodec
1205 void *hwaccel_picture_private;
1208 * reordered pts from the last AVPacket that has been input into the decoder
1209 * - encoding: unused
1210 * - decoding: Read by user.
1215 * dts from the last AVPacket that has been input into the decoder
1216 * - encoding: unused
1217 * - decoding: Read by user.
1222 * the AVCodecContext which ff_thread_get_buffer() was last called on
1223 * - encoding: Set by libavcodec.
1224 * - decoding: Set by libavcodec.
1226 struct AVCodecContext *owner;
1229 * used by multithreading to store frame-specific info
1230 * - encoding: Set by libavcodec.
1231 * - decoding: Set by libavcodec.
1233 void *thread_opaque;
1236 * number of audio samples (per channel) described by this frame
1237 * - encoding: unused
1238 * - decoding: Set by libavcodec
1243 * pointers to the data planes/channels.
1245 * For video, this should simply point to data[].
1247 * For planar audio, each channel has a separate data pointer, and
1248 * linesize[0] contains the size of each channel buffer.
1249 * For packed audio, there is just one data pointer, and linesize[0]
1250 * contains the total size of the buffer for all channels.
1252 * Note: Both data and extended_data will always be set by get_buffer(),
1253 * but for planar audio with more channels that can fit in data,
1254 * extended_data must be used by the decoder in order to access all
1258 * decoding: set by AVCodecContext.get_buffer()
1260 uint8_t **extended_data;
1263 struct AVCodecInternal;
1266 * main external API structure.
1267 * New fields can be added to the end with minor version bumps.
1268 * Removal, reordering and changes to existing fields require a major
1270 * sizeof(AVCodecContext) must not be used outside libav*.
1272 typedef struct AVCodecContext {
1274 * information on struct for av_log
1275 * - set by avcodec_alloc_context3
1277 const AVClass *av_class;
1279 * the average bitrate
1280 * - encoding: Set by user; unused for constant quantizer encoding.
1281 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1286 * number of bits the bitstream is allowed to diverge from the reference.
1287 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1288 * - encoding: Set by user; unused for constant quantizer encoding.
1289 * - decoding: unused
1291 int bit_rate_tolerance;
1295 * - encoding: Set by user.
1296 * - decoding: Set by user.
1301 * Some codecs need additional format info. It is stored here.
1302 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1303 * specific codec MUST set it correctly otherwise stream copy breaks.
1304 * In general use of this field by muxers is not recommended.
1305 * - encoding: Set by libavcodec.
1306 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1311 * Motion estimation algorithm used for video coding.
1312 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1313 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1314 * - encoding: MUST be set by user.
1315 * - decoding: unused
1320 * some codecs need / can use extradata like Huffman tables.
1321 * mjpeg: Huffman tables
1322 * rv10: additional flags
1323 * mpeg4: global headers (they can be in the bitstream or here)
1324 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1325 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1326 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1327 * - encoding: Set/allocated/freed by libavcodec.
1328 * - decoding: Set/allocated/freed by user.
1334 * This is the fundamental unit of time (in seconds) in terms
1335 * of which frame timestamps are represented. For fixed-fps content,
1336 * timebase should be 1/framerate and timestamp increments should be
1338 * - encoding: MUST be set by user.
1339 * - decoding: Set by libavcodec.
1341 AVRational time_base;
1345 * picture width / height.
1346 * - encoding: MUST be set by user.
1347 * - decoding: Set by libavcodec.
1348 * Note: For compatibility it is possible to set this instead of
1349 * coded_width/height before decoding.
1353 #define FF_ASPECT_EXTENDED 15
1356 * the number of pictures in a group of pictures, or 0 for intra_only
1357 * - encoding: Set by user.
1358 * - decoding: unused
1363 * Pixel format, see PIX_FMT_xxx.
1364 * May be set by the demuxer if known from headers.
1365 * May be overriden by the decoder if it knows better.
1366 * - encoding: Set by user.
1367 * - decoding: Set by user if known, overridden by libavcodec if known
1369 enum PixelFormat pix_fmt;
1372 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1373 * decoder to draw a horizontal band. It improves cache usage. Not
1374 * all codecs can do that. You must check the codec capabilities
1376 * When multithreading is used, it may be called from multiple threads
1377 * at the same time; threads might draw different parts of the same AVFrame,
1378 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1380 * The function is also used by hardware acceleration APIs.
1381 * It is called at least once during frame decoding to pass
1382 * the data needed for hardware render.
1383 * In that mode instead of pixel data, AVFrame points to
1384 * a structure specific to the acceleration API. The application
1385 * reads the structure and can change some fields to indicate progress
1387 * - encoding: unused
1388 * - decoding: Set by user.
1389 * @param height the height of the slice
1390 * @param y the y position of the slice
1391 * @param type 1->top field, 2->bottom field, 3->frame
1392 * @param offset offset into the AVFrame.data from which the slice should be read
1394 void (*draw_horiz_band)(struct AVCodecContext *s,
1395 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1396 int y, int type, int height);
1399 int sample_rate; ///< samples per second
1400 int channels; ///< number of audio channels
1403 * audio sample format
1404 * - encoding: Set by user.
1405 * - decoding: Set by libavcodec.
1407 enum AVSampleFormat sample_fmt; ///< sample format
1409 /* The following data should not be initialized. */
1411 * Samples per packet, initialized when calling 'init'.
1414 int frame_number; ///< audio or video frame number
1417 * Number of frames the decoded output will be delayed relative to
1418 * the encoded input.
1419 * - encoding: Set by libavcodec.
1420 * - decoding: unused
1424 /* - encoding parameters */
1425 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1426 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1430 * - encoding: Set by user.
1431 * - decoding: unused
1437 * - encoding: Set by user.
1438 * - decoding: unused
1443 * maximum quantizer difference between frames
1444 * - encoding: Set by user.
1445 * - decoding: unused
1450 * maximum number of B-frames between non-B-frames
1451 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1452 * - encoding: Set by user.
1453 * - decoding: unused
1458 * qscale factor between IP and B-frames
1459 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1460 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1461 * - encoding: Set by user.
1462 * - decoding: unused
1464 float b_quant_factor;
1466 /** obsolete FIXME remove */
1468 #define FF_RC_STRATEGY_XVID 1
1470 int b_frame_strategy;
1472 struct AVCodec *codec;
1476 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1477 /* do its best to deliver a chunk with size */
1478 /* below rtp_payload_size, the chunk will start */
1479 /* with a start code on some codecs like H.263. */
1480 /* This doesn't take account of any particular */
1481 /* headers inside the transmitted RTP payload. */
1484 /* The RTP callback: This function is called */
1485 /* every time the encoder has a packet to send. */
1486 /* It depends on the encoder if the data starts */
1487 /* with a Start Code (it should). H.263 does. */
1488 /* mb_nb contains the number of macroblocks */
1489 /* encoded in the RTP payload. */
1490 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1492 /* statistics, used for 2-pass encoding */
1503 * number of bits used for the previously encoded frame
1504 * - encoding: Set by libavcodec.
1505 * - decoding: unused
1510 * Private data of the user, can be used to carry app specific stuff.
1511 * - encoding: Set by user.
1512 * - decoding: Set by user.
1516 char codec_name[32];
1517 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1518 enum CodecID codec_id; /* see CODEC_ID_xxx */
1521 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1522 * This is used to work around some encoder bugs.
1523 * A demuxer should set this to what is stored in the field used to identify the codec.
1524 * If there are multiple such fields in a container then the demuxer should choose the one
1525 * which maximizes the information about the used codec.
1526 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1527 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1528 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1530 * - encoding: Set by user, if not then the default based on codec_id will be used.
1531 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1533 unsigned int codec_tag;
1536 * Work around bugs in encoders which sometimes cannot be detected automatically.
1537 * - encoding: Set by user
1538 * - decoding: Set by user
1540 int workaround_bugs;
1541 #define FF_BUG_AUTODETECT 1 ///< autodetection
1542 #define FF_BUG_OLD_MSMPEG4 2
1543 #define FF_BUG_XVID_ILACE 4
1544 #define FF_BUG_UMP4 8
1545 #define FF_BUG_NO_PADDING 16
1546 #define FF_BUG_AMV 32
1547 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1548 #define FF_BUG_QPEL_CHROMA 64
1549 #define FF_BUG_STD_QPEL 128
1550 #define FF_BUG_QPEL_CHROMA2 256
1551 #define FF_BUG_DIRECT_BLOCKSIZE 512
1552 #define FF_BUG_EDGE 1024
1553 #define FF_BUG_HPEL_CHROMA 2048
1554 #define FF_BUG_DC_CLIP 4096
1555 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1556 #define FF_BUG_TRUNCATED 16384
1557 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1560 * luma single coefficient elimination threshold
1561 * - encoding: Set by user.
1562 * - decoding: unused
1564 int luma_elim_threshold;
1567 * chroma single coeff elimination threshold
1568 * - encoding: Set by user.
1569 * - decoding: unused
1571 int chroma_elim_threshold;
1574 * strictly follow the standard (MPEG4, ...).
1575 * - encoding: Set by user.
1576 * - decoding: Set by user.
1577 * Setting this to STRICT or higher means the encoder and decoder will
1578 * generally do stupid things, whereas setting it to unofficial or lower
1579 * will mean the encoder might produce output that is not supported by all
1580 * spec-compliant decoders. Decoders don't differentiate between normal,
1581 * unofficial and experimental (that is, they always try to decode things
1582 * when they can) unless they are explicitly asked to behave stupidly
1583 * (=strictly conform to the specs)
1585 int strict_std_compliance;
1586 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1587 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1588 #define FF_COMPLIANCE_NORMAL 0
1589 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1590 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1593 * qscale offset between IP and B-frames
1594 * - encoding: Set by user.
1595 * - decoding: unused
1597 float b_quant_offset;
1601 * Error recognition; higher values will detect more errors but may
1602 * misdetect some more or less valid parts as errors.
1603 * - encoding: unused
1604 * - decoding: Set by user.
1606 attribute_deprecated int error_recognition;
1607 #define FF_ER_CAREFUL 1
1608 #define FF_ER_COMPLIANT 2
1609 #define FF_ER_AGGRESSIVE 3
1610 #define FF_ER_VERY_AGGRESSIVE 4
1611 #define FF_ER_EXPLODE 5
1612 #endif /* FF_API_ER */
1615 * Called at the beginning of each frame to get a buffer for it.
1617 * The function will set AVFrame.data[], AVFrame.linesize[].
1618 * AVFrame.extended_data[] must also be set, but it should be the same as
1619 * AVFrame.data[] except for planar audio with more channels than can fit
1620 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1621 * many data pointers as it can hold.
1623 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1624 * avcodec_default_get_buffer() instead of providing buffers allocated by
1627 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1628 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1629 * but if get_buffer() is overridden then alignment considerations should
1630 * be taken into account.
1632 * @see avcodec_default_get_buffer()
1636 * If pic.reference is set then the frame will be read later by libavcodec.
1637 * avcodec_align_dimensions2() should be used to find the required width and
1638 * height, as they normally need to be rounded up to the next multiple of 16.
1640 * If frame multithreading is used and thread_safe_callbacks is set,
1641 * it may be called from a different thread, but not from more than one at
1642 * once. Does not need to be reentrant.
1644 * @see release_buffer(), reget_buffer()
1645 * @see avcodec_align_dimensions2()
1649 * Decoders request a buffer of a particular size by setting
1650 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1651 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1652 * to a smaller value in the output frame.
1654 * Decoders cannot use the buffer after returning from
1655 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1656 * is assumed to be released immediately upon return.
1658 * As a convenience, av_samples_get_buffer_size() and
1659 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1660 * functions to find the required data size and to fill data pointers and
1661 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1662 * since all planes must be the same size.
1664 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1666 * - encoding: unused
1667 * - decoding: Set by libavcodec, user can override.
1669 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1672 * Called to release buffers which were allocated with get_buffer.
1673 * A released buffer can be reused in get_buffer().
1674 * pic.data[*] must be set to NULL.
1675 * May be called from a different thread if frame multithreading is used,
1676 * but not by more than one thread at once, so does not need to be reentrant.
1677 * - encoding: unused
1678 * - decoding: Set by libavcodec, user can override.
1680 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1683 * Size of the frame reordering buffer in the decoder.
1684 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1685 * - encoding: Set by libavcodec.
1686 * - decoding: Set by libavcodec.
1691 * number of bytes per packet if constant and known or 0
1692 * Used by some WAV based audio codecs.
1696 #if FF_API_PARSE_FRAME
1698 * If true, only parsing is done. The frame data is returned.
1699 * Only MPEG audio decoders support this now.
1700 * - encoding: unused
1701 * - decoding: Set by user
1703 attribute_deprecated int parse_only;
1707 * 0-> h263 quant 1-> mpeg quant
1708 * - encoding: Set by user.
1709 * - decoding: unused
1714 * pass1 encoding statistics output buffer
1715 * - encoding: Set by libavcodec.
1716 * - decoding: unused
1721 * pass2 encoding statistics input buffer
1722 * Concatenated stuff from stats_out of pass1 should be placed here.
1723 * - encoding: Allocated/set/freed by user.
1724 * - decoding: unused
1729 * ratecontrol qmin qmax limiting method
1730 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1731 * - encoding: Set by user.
1732 * - decoding: unused
1740 * ratecontrol override, see RcOverride
1741 * - encoding: Allocated/set/freed by user.
1742 * - decoding: unused
1744 RcOverride *rc_override;
1745 int rc_override_count;
1748 * rate control equation
1749 * - encoding: Set by user
1750 * - decoding: unused
1756 * - encoding: Set by user.
1757 * - decoding: unused
1763 * - encoding: Set by user.
1764 * - decoding: unused
1769 * decoder bitstream buffer size
1770 * - encoding: Set by user.
1771 * - decoding: unused
1774 float rc_buffer_aggressivity;
1777 * qscale factor between P and I-frames
1778 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1779 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1780 * - encoding: Set by user.
1781 * - decoding: unused
1783 float i_quant_factor;
1786 * qscale offset between P and I-frames
1787 * - encoding: Set by user.
1788 * - decoding: unused
1790 float i_quant_offset;
1793 * initial complexity for pass1 ratecontrol
1794 * - encoding: Set by user.
1795 * - decoding: unused
1797 float rc_initial_cplx;
1800 * DCT algorithm, see FF_DCT_* below
1801 * - encoding: Set by user.
1802 * - decoding: unused
1805 #define FF_DCT_AUTO 0
1806 #define FF_DCT_FASTINT 1
1807 #define FF_DCT_INT 2
1808 #define FF_DCT_MMX 3
1809 #define FF_DCT_MLIB 4
1810 #define FF_DCT_ALTIVEC 5
1811 #define FF_DCT_FAAN 6
1814 * luminance masking (0-> disabled)
1815 * - encoding: Set by user.
1816 * - decoding: unused
1821 * temporary complexity masking (0-> disabled)
1822 * - encoding: Set by user.
1823 * - decoding: unused
1825 float temporal_cplx_masking;
1828 * spatial complexity masking (0-> disabled)
1829 * - encoding: Set by user.
1830 * - decoding: unused
1832 float spatial_cplx_masking;
1835 * p block masking (0-> disabled)
1836 * - encoding: Set by user.
1837 * - decoding: unused
1842 * darkness masking (0-> disabled)
1843 * - encoding: Set by user.
1844 * - decoding: unused
1849 * IDCT algorithm, see FF_IDCT_* below.
1850 * - encoding: Set by user.
1851 * - decoding: Set by user.
1854 #define FF_IDCT_AUTO 0
1855 #define FF_IDCT_INT 1
1856 #define FF_IDCT_SIMPLE 2
1857 #define FF_IDCT_SIMPLEMMX 3
1858 #define FF_IDCT_LIBMPEG2MMX 4
1859 #define FF_IDCT_PS2 5
1860 #define FF_IDCT_MLIB 6
1861 #define FF_IDCT_ARM 7
1862 #define FF_IDCT_ALTIVEC 8
1863 #define FF_IDCT_SH4 9
1864 #define FF_IDCT_SIMPLEARM 10
1865 #define FF_IDCT_H264 11
1866 #define FF_IDCT_VP3 12
1867 #define FF_IDCT_IPP 13
1868 #define FF_IDCT_XVIDMMX 14
1869 #define FF_IDCT_CAVS 15
1870 #define FF_IDCT_SIMPLEARMV5TE 16
1871 #define FF_IDCT_SIMPLEARMV6 17
1872 #define FF_IDCT_SIMPLEVIS 18
1873 #define FF_IDCT_WMV2 19
1874 #define FF_IDCT_FAAN 20
1875 #define FF_IDCT_EA 21
1876 #define FF_IDCT_SIMPLENEON 22
1877 #define FF_IDCT_SIMPLEALPHA 23
1878 #define FF_IDCT_BINK 24
1882 * - encoding: Set by libavcodec.
1883 * - decoding: Set by user (or 0).
1887 * slice offsets in the frame in bytes
1888 * - encoding: Set/allocated by libavcodec.
1889 * - decoding: Set/allocated by user (or NULL).
1894 * error concealment flags
1895 * - encoding: unused
1896 * - decoding: Set by user.
1898 int error_concealment;
1899 #define FF_EC_GUESS_MVS 1
1900 #define FF_EC_DEBLOCK 2
1903 * dsp_mask could be add used to disable unwanted CPU features
1904 * CPU features (i.e. MMX, SSE. ...)
1906 * With the FORCE flag you may instead enable given CPU features.
1907 * (Dangerous: Usable in case of misdetection, improper usage however will
1908 * result into program crash.)
1913 * bits per sample/pixel from the demuxer (needed for huffyuv).
1914 * - encoding: Set by libavcodec.
1915 * - decoding: Set by user.
1917 int bits_per_coded_sample;
1920 * prediction method (needed for huffyuv)
1921 * - encoding: Set by user.
1922 * - decoding: unused
1924 int prediction_method;
1925 #define FF_PRED_LEFT 0
1926 #define FF_PRED_PLANE 1
1927 #define FF_PRED_MEDIAN 2
1930 * sample aspect ratio (0 if unknown)
1931 * That is the width of a pixel divided by the height of the pixel.
1932 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1933 * - encoding: Set by user.
1934 * - decoding: Set by libavcodec.
1936 AVRational sample_aspect_ratio;
1939 * the picture in the bitstream
1940 * - encoding: Set by libavcodec.
1941 * - decoding: Set by libavcodec.
1943 AVFrame *coded_frame;
1947 * - encoding: Set by user.
1948 * - decoding: Set by user.
1951 #define FF_DEBUG_PICT_INFO 1
1952 #define FF_DEBUG_RC 2
1953 #define FF_DEBUG_BITSTREAM 4
1954 #define FF_DEBUG_MB_TYPE 8
1955 #define FF_DEBUG_QP 16
1956 #define FF_DEBUG_MV 32
1957 #define FF_DEBUG_DCT_COEFF 0x00000040
1958 #define FF_DEBUG_SKIP 0x00000080
1959 #define FF_DEBUG_STARTCODE 0x00000100
1960 #define FF_DEBUG_PTS 0x00000200
1961 #define FF_DEBUG_ER 0x00000400
1962 #define FF_DEBUG_MMCO 0x00000800
1963 #define FF_DEBUG_BUGS 0x00001000
1964 #define FF_DEBUG_VIS_QP 0x00002000
1965 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1966 #define FF_DEBUG_BUFFERS 0x00008000
1967 #define FF_DEBUG_THREADS 0x00010000
1971 * - encoding: Set by user.
1972 * - decoding: Set by user.
1975 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1976 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1977 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1981 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1982 * - decoding: unused
1984 uint64_t error[AV_NUM_DATA_POINTERS];
1987 * motion estimation comparison function
1988 * - encoding: Set by user.
1989 * - decoding: unused
1993 * subpixel motion estimation comparison function
1994 * - encoding: Set by user.
1995 * - decoding: unused
1999 * macroblock comparison function (not supported yet)
2000 * - encoding: Set by user.
2001 * - decoding: unused
2005 * interlaced DCT comparison function
2006 * - encoding: Set by user.
2007 * - decoding: unused
2010 #define FF_CMP_SAD 0
2011 #define FF_CMP_SSE 1
2012 #define FF_CMP_SATD 2
2013 #define FF_CMP_DCT 3
2014 #define FF_CMP_PSNR 4
2015 #define FF_CMP_BIT 5
2017 #define FF_CMP_ZERO 7
2018 #define FF_CMP_VSAD 8
2019 #define FF_CMP_VSSE 9
2020 #define FF_CMP_NSSE 10
2021 #define FF_CMP_W53 11
2022 #define FF_CMP_W97 12
2023 #define FF_CMP_DCTMAX 13
2024 #define FF_CMP_DCT264 14
2025 #define FF_CMP_CHROMA 256
2028 * ME diamond size & shape
2029 * - encoding: Set by user.
2030 * - decoding: unused
2035 * amount of previous MV predictors (2a+1 x 2a+1 square)
2036 * - encoding: Set by user.
2037 * - decoding: unused
2039 int last_predictor_count;
2042 * prepass for motion estimation
2043 * - encoding: Set by user.
2044 * - decoding: unused
2049 * motion estimation prepass comparison function
2050 * - encoding: Set by user.
2051 * - decoding: unused
2056 * ME prepass diamond size & shape
2057 * - encoding: Set by user.
2058 * - decoding: unused
2064 * - encoding: Set by user.
2065 * - decoding: unused
2067 int me_subpel_quality;
2070 * callback to negotiate the pixelFormat
2071 * @param fmt is the list of formats which are supported by the codec,
2072 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2073 * The first is always the native one.
2074 * @return the chosen format
2075 * - encoding: unused
2076 * - decoding: Set by user, if not set the native format will be chosen.
2078 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2081 * DTG active format information (additional aspect ratio
2082 * information only used in DVB MPEG-2 transport streams)
2085 * - encoding: unused
2086 * - decoding: Set by decoder.
2088 int dtg_active_format;
2089 #define FF_DTG_AFD_SAME 8
2090 #define FF_DTG_AFD_4_3 9
2091 #define FF_DTG_AFD_16_9 10
2092 #define FF_DTG_AFD_14_9 11
2093 #define FF_DTG_AFD_4_3_SP_14_9 13
2094 #define FF_DTG_AFD_16_9_SP_14_9 14
2095 #define FF_DTG_AFD_SP_4_3 15
2098 * maximum motion estimation search range in subpel units
2099 * If 0 then no limit.
2101 * - encoding: Set by user.
2102 * - decoding: unused
2107 * intra quantizer bias
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int intra_quant_bias;
2112 #define FF_DEFAULT_QUANT_BIAS 999999
2115 * inter quantizer bias
2116 * - encoding: Set by user.
2117 * - decoding: unused
2119 int inter_quant_bias;
2123 * - encoding: unused
2124 * - decoding: Which clrtable should be used for 8bit RGB images.
2125 * Tables have to be stored somewhere. FIXME
2129 #if FF_API_INTERNAL_CONTEXT
2131 * internal_buffer count
2132 * Don't touch, used by libavcodec default_get_buffer().
2133 * @deprecated this field was moved to an internal context
2135 attribute_deprecated int internal_buffer_count;
2139 * Don't touch, used by libavcodec default_get_buffer().
2140 * @deprecated this field was moved to an internal context
2142 attribute_deprecated void *internal_buffer;
2146 * Global quality for codecs which cannot change it per frame.
2147 * This should be proportional to MPEG-1/2/4 qscale.
2148 * - encoding: Set by user.
2149 * - decoding: unused
2153 #define FF_CODER_TYPE_VLC 0
2154 #define FF_CODER_TYPE_AC 1
2155 #define FF_CODER_TYPE_RAW 2
2156 #define FF_CODER_TYPE_RLE 3
2157 #define FF_CODER_TYPE_DEFLATE 4
2160 * - encoding: Set by user.
2161 * - decoding: unused
2167 * - encoding: Set by user.
2168 * - decoding: unused
2174 * - encoding: unused
2175 * - decoding: Set by user.
2177 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2182 * - encoding: unused
2183 * - decoding: Set by user.
2186 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2187 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2188 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2191 * XVideo Motion Acceleration
2192 * - encoding: forbidden
2193 * - decoding: set by decoder
2195 int xvmc_acceleration;
2198 * macroblock decision mode
2199 * - encoding: Set by user.
2200 * - decoding: unused
2203 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2204 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2205 #define FF_MB_DECISION_RD 2 ///< rate distortion
2208 * custom intra quantization matrix
2209 * - encoding: Set by user, can be NULL.
2210 * - decoding: Set by libavcodec.
2212 uint16_t *intra_matrix;
2215 * custom inter quantization matrix
2216 * - encoding: Set by user, can be NULL.
2217 * - decoding: Set by libavcodec.
2219 uint16_t *inter_matrix;
2222 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2223 * This is used to work around some encoder bugs.
2224 * - encoding: unused
2225 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2227 unsigned int stream_codec_tag;
2230 * scene change detection threshold
2231 * 0 is default, larger means fewer detected scene changes.
2232 * - encoding: Set by user.
2233 * - decoding: unused
2235 int scenechange_threshold;
2238 * minimum Lagrange multipler
2239 * - encoding: Set by user.
2240 * - decoding: unused
2245 * maximum Lagrange multipler
2246 * - encoding: Set by user.
2247 * - decoding: unused
2251 #if FF_API_PALETTE_CONTROL
2253 * palette control structure
2254 * - encoding: ??? (no palette-enabled encoder yet)
2255 * - decoding: Set by user.
2257 struct AVPaletteControl *palctrl;
2261 * noise reduction strength
2262 * - encoding: Set by user.
2263 * - decoding: unused
2265 int noise_reduction;
2268 * Called at the beginning of a frame to get cr buffer for it.
2269 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2270 * libavcodec will pass previous buffer in pic, function should return
2271 * same buffer or new buffer with old frame "painted" into it.
2272 * If pic.data[0] == NULL must behave like get_buffer().
2273 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2274 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2276 * - encoding: unused
2277 * - decoding: Set by libavcodec, user can override.
2279 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2282 * Number of bits which should be loaded into the rc buffer before decoding starts.
2283 * - encoding: Set by user.
2284 * - decoding: unused
2286 int rc_initial_buffer_occupancy;
2290 * - encoding: Set by user.
2291 * - decoding: unused
2293 int inter_threshold;
2297 * - encoding: Set by user.
2298 * - decoding: Set by user.
2303 * Simulates errors in the bitstream to test error concealment.
2304 * - encoding: Set by user.
2305 * - decoding: unused
2309 #if FF_API_ANTIALIAS_ALGO
2311 * MP3 antialias algorithm, see FF_AA_* below.
2312 * - encoding: unused
2313 * - decoding: Set by user.
2315 attribute_deprecated int antialias_algo;
2316 #define FF_AA_AUTO 0
2317 #define FF_AA_FASTINT 1 //not implemented yet
2319 #define FF_AA_FLOAT 3
2323 * quantizer noise shaping
2324 * - encoding: Set by user.
2325 * - decoding: unused
2327 int quantizer_noise_shaping;
2331 * is used to decide how many independent tasks should be passed to execute()
2332 * - encoding: Set by user.
2333 * - decoding: Set by user.
2338 * The codec may call this to execute several independent things.
2339 * It will return only after finishing all tasks.
2340 * The user may replace this with some multithreaded implementation,
2341 * the default implementation will execute the parts serially.
2342 * @param count the number of things to execute
2343 * - encoding: Set by libavcodec, user can override.
2344 * - decoding: Set by libavcodec, user can override.
2346 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2350 * Can be used by execute() to store some per AVCodecContext stuff.
2351 * - encoding: set by execute()
2352 * - decoding: set by execute()
2354 void *thread_opaque;
2357 * Motion estimation threshold below which no motion estimation is
2358 * performed, but instead the user specified motion vectors are used.
2360 * - encoding: Set by user.
2361 * - decoding: unused
2366 * Macroblock threshold below which the user specified macroblock types will be used.
2367 * - encoding: Set by user.
2368 * - decoding: unused
2373 * precision of the intra DC coefficient - 8
2374 * - encoding: Set by user.
2375 * - decoding: unused
2377 int intra_dc_precision;
2380 * noise vs. sse weight for the nsse comparsion function
2381 * - encoding: Set by user.
2382 * - decoding: unused
2387 * Number of macroblock rows at the top which are skipped.
2388 * - encoding: unused
2389 * - decoding: Set by user.
2394 * Number of macroblock rows at the bottom which are skipped.
2395 * - encoding: unused
2396 * - decoding: Set by user.
2402 * - encoding: Set by user.
2403 * - decoding: Set by libavcodec.
2406 #define FF_PROFILE_UNKNOWN -99
2407 #define FF_PROFILE_RESERVED -100
2409 #define FF_PROFILE_AAC_MAIN 0
2410 #define FF_PROFILE_AAC_LOW 1
2411 #define FF_PROFILE_AAC_SSR 2
2412 #define FF_PROFILE_AAC_LTP 3
2414 #define FF_PROFILE_DTS 20
2415 #define FF_PROFILE_DTS_ES 30
2416 #define FF_PROFILE_DTS_96_24 40
2417 #define FF_PROFILE_DTS_HD_HRA 50
2418 #define FF_PROFILE_DTS_HD_MA 60
2420 #define FF_PROFILE_MPEG2_422 0
2421 #define FF_PROFILE_MPEG2_HIGH 1
2422 #define FF_PROFILE_MPEG2_SS 2
2423 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2424 #define FF_PROFILE_MPEG2_MAIN 4
2425 #define FF_PROFILE_MPEG2_SIMPLE 5
2427 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2428 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2430 #define FF_PROFILE_H264_BASELINE 66
2431 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2432 #define FF_PROFILE_H264_MAIN 77
2433 #define FF_PROFILE_H264_EXTENDED 88
2434 #define FF_PROFILE_H264_HIGH 100
2435 #define FF_PROFILE_H264_HIGH_10 110
2436 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2437 #define FF_PROFILE_H264_HIGH_422 122
2438 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2439 #define FF_PROFILE_H264_HIGH_444 144
2440 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2441 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2442 #define FF_PROFILE_H264_CAVLC_444 44
2444 #define FF_PROFILE_VC1_SIMPLE 0
2445 #define FF_PROFILE_VC1_MAIN 1
2446 #define FF_PROFILE_VC1_COMPLEX 2
2447 #define FF_PROFILE_VC1_ADVANCED 3
2449 #define FF_PROFILE_MPEG4_SIMPLE 0
2450 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2451 #define FF_PROFILE_MPEG4_CORE 2
2452 #define FF_PROFILE_MPEG4_MAIN 3
2453 #define FF_PROFILE_MPEG4_N_BIT 4
2454 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2455 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2456 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2457 #define FF_PROFILE_MPEG4_HYBRID 8
2458 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2459 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2460 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2461 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2462 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2463 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2464 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2468 * - encoding: Set by user.
2469 * - decoding: Set by libavcodec.
2472 #define FF_LEVEL_UNKNOWN -99
2475 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2476 * - encoding: unused
2477 * - decoding: Set by user.
2482 * Bitstream width / height, may be different from width/height if lowres enabled.
2483 * - encoding: unused
2484 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2486 int coded_width, coded_height;
2489 * frame skip threshold
2490 * - encoding: Set by user.
2491 * - decoding: unused
2493 int frame_skip_threshold;
2497 * - encoding: Set by user.
2498 * - decoding: unused
2500 int frame_skip_factor;
2503 * frame skip exponent
2504 * - encoding: Set by user.
2505 * - decoding: unused
2510 * frame skip comparison function
2511 * - encoding: Set by user.
2512 * - decoding: unused
2517 * Border processing masking, raises the quantizer for mbs on the borders
2519 * - encoding: Set by user.
2520 * - decoding: unused
2522 float border_masking;
2525 * minimum MB lagrange multipler
2526 * - encoding: Set by user.
2527 * - decoding: unused
2532 * maximum MB lagrange multipler
2533 * - encoding: Set by user.
2534 * - decoding: unused
2540 * - encoding: Set by user.
2541 * - decoding: unused
2543 int me_penalty_compensation;
2547 * - encoding: unused
2548 * - decoding: Set by user.
2550 enum AVDiscard skip_loop_filter;
2554 * - encoding: unused
2555 * - decoding: Set by user.
2557 enum AVDiscard skip_idct;
2561 * - encoding: unused
2562 * - decoding: Set by user.
2564 enum AVDiscard skip_frame;
2568 * - encoding: Set by user.
2569 * - decoding: unused
2575 * - encoding: Set by user.
2576 * - decoding: unused
2580 #if FF_API_X264_GLOBAL_OPTS
2582 * constant rate factor - quality-based VBR - values ~correspond to qps
2583 * - encoding: Set by user.
2584 * - decoding: unused
2585 * @deprecated use 'crf' libx264 private option
2587 attribute_deprecated float crf;
2590 * constant quantization parameter rate control method
2591 * - encoding: Set by user.
2592 * - decoding: unused
2593 * @deprecated use 'cqp' libx264 private option
2595 attribute_deprecated int cqp;
2600 * - encoding: Set by user.
2601 * - decoding: unused
2606 * number of reference frames
2607 * - encoding: Set by user.
2608 * - decoding: Set by lavc.
2613 * chroma qp offset from luma
2614 * - encoding: Set by user.
2615 * - decoding: unused
2619 #if FF_API_X264_GLOBAL_OPTS
2621 * Influence how often B-frames are used.
2622 * - encoding: Set by user.
2623 * - decoding: unused
2625 attribute_deprecated int bframebias;
2629 * trellis RD quantization
2630 * - encoding: Set by user.
2631 * - decoding: unused
2635 #if FF_API_X264_GLOBAL_OPTS
2637 * Reduce fluctuations in qp (before curve compression).
2638 * - encoding: Set by user.
2639 * - decoding: unused
2641 attribute_deprecated float complexityblur;
2644 * in-loop deblocking filter alphac0 parameter
2645 * alpha is in the range -6...6
2646 * - encoding: Set by user.
2647 * - decoding: unused
2649 attribute_deprecated int deblockalpha;
2652 * in-loop deblocking filter beta parameter
2653 * beta is in the range -6...6
2654 * - encoding: Set by user.
2655 * - decoding: unused
2657 attribute_deprecated int deblockbeta;
2660 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2661 * - encoding: Set by user.
2662 * - decoding: unused
2664 attribute_deprecated int partitions;
2665 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2666 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2667 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2668 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2669 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2672 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2673 * - encoding: Set by user.
2674 * - decoding: unused
2676 attribute_deprecated int directpred;
2680 * Audio cutoff bandwidth (0 means "automatic")
2681 * - encoding: Set by user.
2682 * - decoding: unused
2687 * Multiplied by qscale for each frame and added to scene_change_score.
2688 * - encoding: Set by user.
2689 * - decoding: unused
2691 int scenechange_factor;
2695 * Note: Value depends upon the compare function used for fullpel ME.
2696 * - encoding: Set by user.
2697 * - decoding: unused
2702 * Adjust sensitivity of b_frame_strategy 1.
2703 * - encoding: Set by user.
2704 * - decoding: unused
2709 * - encoding: Set by user.
2710 * - decoding: unused
2712 int compression_level;
2713 #define FF_COMPRESSION_DEFAULT -1
2716 * - encoding: Set by user.
2717 * - decoding: unused
2719 int min_prediction_order;
2722 * - encoding: Set by user.
2723 * - decoding: unused
2725 int max_prediction_order;
2727 #if FF_API_FLAC_GLOBAL_OPTS
2729 * @name FLAC options
2730 * @deprecated Use FLAC encoder private options instead.
2735 * LPC coefficient precision - used by FLAC encoder
2736 * - encoding: Set by user.
2737 * - decoding: unused
2739 attribute_deprecated int lpc_coeff_precision;
2742 * search method for selecting prediction order
2743 * - encoding: Set by user.
2744 * - decoding: unused
2746 attribute_deprecated int prediction_order_method;
2749 * - encoding: Set by user.
2750 * - decoding: unused
2752 attribute_deprecated int min_partition_order;
2755 * - encoding: Set by user.
2756 * - decoding: unused
2758 attribute_deprecated int max_partition_order;
2765 * GOP timecode frame start number, in non drop frame format
2766 * - encoding: Set by user.
2767 * - decoding: unused
2769 int64_t timecode_frame_start;
2771 #if FF_API_REQUEST_CHANNELS
2773 * Decoder should decode to this many channels if it can (0 for default)
2774 * - encoding: unused
2775 * - decoding: Set by user.
2776 * @deprecated Deprecated in favor of request_channel_layout.
2778 int request_channels;
2781 #if FF_API_DRC_SCALE
2783 * Percentage of dynamic range compression to be applied by the decoder.
2784 * The default value is 1.0, corresponding to full compression.
2785 * - encoding: unused
2786 * - decoding: Set by user.
2787 * @deprecated use AC3 decoder private option instead.
2789 attribute_deprecated float drc_scale;
2793 * opaque 64bit number (generally a PTS) that will be reordered and
2794 * output in AVFrame.reordered_opaque
2795 * @deprecated in favor of pkt_pts
2796 * - encoding: unused
2797 * - decoding: Set by user.
2799 int64_t reordered_opaque;
2802 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2803 * - encoding: set by user.
2804 * - decoding: set by libavcodec.
2806 int bits_per_raw_sample;
2809 * Audio channel layout.
2810 * - encoding: set by user.
2811 * - decoding: set by libavcodec.
2813 uint64_t channel_layout;
2816 * Request decoder to use this channel layout if it can (0 for default)
2817 * - encoding: unused
2818 * - decoding: Set by user.
2820 uint64_t request_channel_layout;
2823 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2824 * - encoding: Set by user.
2825 * - decoding: unused.
2827 float rc_max_available_vbv_use;
2830 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2831 * - encoding: Set by user.
2832 * - decoding: unused.
2834 float rc_min_vbv_overflow_use;
2837 * Hardware accelerator in use
2838 * - encoding: unused.
2839 * - decoding: Set by libavcodec
2841 struct AVHWAccel *hwaccel;
2844 * For some codecs, the time base is closer to the field rate than the frame rate.
2845 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2846 * if no telecine is used ...
2848 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2850 int ticks_per_frame;
2853 * Hardware accelerator context.
2854 * For some hardware accelerators, a global context needs to be
2855 * provided by the user. In that case, this holds display-dependent
2856 * data Libav cannot instantiate itself. Please refer to the
2857 * Libav HW accelerator documentation to know how to fill this
2858 * is. e.g. for VA API, this is a struct vaapi_context.
2859 * - encoding: unused
2860 * - decoding: Set by user
2862 void *hwaccel_context;
2865 * Chromaticity coordinates of the source primaries.
2866 * - encoding: Set by user
2867 * - decoding: Set by libavcodec
2869 enum AVColorPrimaries color_primaries;
2872 * Color Transfer Characteristic.
2873 * - encoding: Set by user
2874 * - decoding: Set by libavcodec
2876 enum AVColorTransferCharacteristic color_trc;
2879 * YUV colorspace type.
2880 * - encoding: Set by user
2881 * - decoding: Set by libavcodec
2883 enum AVColorSpace colorspace;
2886 * MPEG vs JPEG YUV range.
2887 * - encoding: Set by user
2888 * - decoding: Set by libavcodec
2890 enum AVColorRange color_range;
2893 * This defines the location of chroma samples.
2894 * - encoding: Set by user
2895 * - decoding: Set by libavcodec
2897 enum AVChromaLocation chroma_sample_location;
2900 * The codec may call this to execute several independent things.
2901 * It will return only after finishing all tasks.
2902 * The user may replace this with some multithreaded implementation,
2903 * the default implementation will execute the parts serially.
2904 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2905 * @param c context passed also to func
2906 * @param count the number of things to execute
2907 * @param arg2 argument passed unchanged to func
2908 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2909 * @param func function that will be called count times, with jobnr from 0 to count-1.
2910 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2911 * two instances of func executing at the same time will have the same threadnr.
2912 * @return always 0 currently, but code should handle a future improvement where when any call to func
2913 * returns < 0 no further calls to func may be done and < 0 is returned.
2914 * - encoding: Set by libavcodec, user can override.
2915 * - decoding: Set by libavcodec, user can override.
2917 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2919 #if FF_API_X264_GLOBAL_OPTS
2921 * explicit P-frame weighted prediction analysis method
2923 * 1: fast blind weighting (one reference duplicate with -1 offset)
2924 * 2: smart weighting (full fade detection analysis)
2925 * - encoding: Set by user.
2926 * - decoding: unused
2928 attribute_deprecated int weighted_p_pred;
2933 * 1: Variance AQ (complexity mask)
2934 * 2: Auto-variance AQ (experimental)
2935 * - encoding: Set by user
2936 * - decoding: unused
2938 attribute_deprecated int aq_mode;
2942 * Reduces blocking and blurring in flat and textured areas.
2943 * - encoding: Set by user
2944 * - decoding: unused
2946 attribute_deprecated float aq_strength;
2950 * Strength of psychovisual optimization
2951 * - encoding: Set by user
2952 * - decoding: unused
2954 attribute_deprecated float psy_rd;
2958 * Strength of psychovisual optimization
2959 * - encoding: Set by user
2960 * - decoding: unused
2962 attribute_deprecated float psy_trellis;
2966 * Number of frames for frametype and ratecontrol lookahead
2967 * - encoding: Set by user
2968 * - decoding: unused
2970 attribute_deprecated int rc_lookahead;
2973 * Constant rate factor maximum
2974 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2975 * than crf_max, even if doing so would violate VBV restrictions.
2976 * - encoding: Set by user.
2977 * - decoding: unused
2979 attribute_deprecated float crf_max;
2982 int log_level_offset;
2984 #if FF_API_FLAC_GLOBAL_OPTS
2986 * Determine which LPC analysis algorithm to use.
2987 * - encoding: Set by user
2988 * - decoding: unused
2990 attribute_deprecated enum AVLPCType lpc_type;
2993 * Number of passes to use for Cholesky factorization during LPC analysis
2994 * - encoding: Set by user
2995 * - decoding: unused
2997 attribute_deprecated int lpc_passes;
3002 * Indicates number of picture subdivisions. Used for parallelized
3004 * - encoding: Set by user
3005 * - decoding: unused
3010 * Header containing style information for text subtitles.
3011 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3012 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3013 * the Format line following. It shouldn't include any Dialogue line.
3014 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3015 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3017 uint8_t *subtitle_header;
3018 int subtitle_header_size;
3021 * Current packet as passed into the decoder, to avoid having
3022 * to pass the packet into every function. Currently only valid
3023 * inside lavc and get/release_buffer callbacks.
3024 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3025 * - encoding: unused
3029 #if FF_API_INTERNAL_CONTEXT
3031 * Whether this is a copy of the context which had init() called on it.
3032 * This is used by multithreading - shared tables and picture pointers
3033 * should be freed from the original context only.
3034 * - encoding: Set by libavcodec.
3035 * - decoding: Set by libavcodec.
3037 * @deprecated this field has been moved to an internal context
3039 attribute_deprecated int is_copy;
3043 * Which multithreading methods to use.
3044 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3045 * so clients which cannot provide future frames should not use it.
3047 * - encoding: Set by user, otherwise the default is used.
3048 * - decoding: Set by user, otherwise the default is used.
3051 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3052 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3055 * Which multithreading methods are in use by the codec.
3056 * - encoding: Set by libavcodec.
3057 * - decoding: Set by libavcodec.
3059 int active_thread_type;
3062 * Set by the client if its custom get_buffer() callback can be called
3063 * from another thread, which allows faster multithreaded decoding.
3064 * draw_horiz_band() will be called from other threads regardless of this setting.
3065 * Ignored if the default get_buffer() is used.
3066 * - encoding: Set by user.
3067 * - decoding: Set by user.
3069 int thread_safe_callbacks;
3072 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3073 * Used for compliant TS muxing.
3074 * - encoding: Set by libavcodec.
3075 * - decoding: unused.
3080 * Type of service that the audio stream conveys.
3081 * - encoding: Set by user.
3082 * - decoding: Set by libavcodec.
3084 enum AVAudioServiceType audio_service_type;
3087 * Used to request a sample format from the decoder.
3088 * - encoding: unused.
3089 * - decoding: Set by user.
3091 enum AVSampleFormat request_sample_fmt;
3094 * Error recognition; may misdetect some more or less valid parts as errors.
3095 * - encoding: unused
3096 * - decoding: Set by user.
3098 int err_recognition;
3099 #define AV_EF_CRCCHECK (1<<0)
3100 #define AV_EF_BITSTREAM (1<<1)
3101 #define AV_EF_BUFFER (1<<2)
3102 #define AV_EF_EXPLODE (1<<3)
3105 * Private context used for internal data.
3107 * Unlike priv_data, this is not codec-specific. It is used in general
3108 * libavcodec functions.
3110 struct AVCodecInternal *internal;
3116 typedef struct AVProfile {
3118 const char *name; ///< short name for the profile
3121 typedef struct AVCodecDefault AVCodecDefault;
3126 typedef struct AVCodec {
3128 * Name of the codec implementation.
3129 * The name is globally unique among encoders and among decoders (but an
3130 * encoder and a decoder can share the same name).
3131 * This is the primary way to find a codec from the user perspective.
3134 enum AVMediaType type;
3137 int (*init)(AVCodecContext *);
3138 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3139 int (*close)(AVCodecContext *);
3140 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3142 * Codec capabilities.
3146 struct AVCodec *next;
3149 * Will be called when seeking
3151 void (*flush)(AVCodecContext *);
3152 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3153 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3155 * Descriptive name for the codec, meant to be more human readable than name.
3156 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3158 const char *long_name;
3159 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3160 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3161 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3162 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3163 const AVClass *priv_class; ///< AVClass for the private context
3164 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3167 * @name Frame-level threading support functions
3171 * If defined, called on thread contexts when they are created.
3172 * If the codec allocates writable tables in init(), re-allocate them here.
3173 * priv_data will be set to a copy of the original.
3175 int (*init_thread_copy)(AVCodecContext *);
3177 * Copy necessary context variables from a previous thread context to the current one.
3178 * If not defined, the next thread will start automatically; otherwise, the codec
3179 * must call ff_thread_finish_setup().
3181 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3183 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3187 * Private codec-specific defaults.
3189 const AVCodecDefault *defaults;
3192 * Initialize codec static data, called from avcodec_register().
3194 void (*init_static_data)(struct AVCodec *codec);
3200 typedef struct AVHWAccel {
3202 * Name of the hardware accelerated codec.
3203 * The name is globally unique among encoders and among decoders (but an
3204 * encoder and a decoder can share the same name).
3209 * Type of codec implemented by the hardware accelerator.
3211 * See AVMEDIA_TYPE_xxx
3213 enum AVMediaType type;
3216 * Codec implemented by the hardware accelerator.
3223 * Supported pixel format.
3225 * Only hardware accelerated formats are supported here.
3227 enum PixelFormat pix_fmt;
3230 * Hardware accelerated codec capabilities.
3231 * see FF_HWACCEL_CODEC_CAP_*
3235 struct AVHWAccel *next;
3238 * Called at the beginning of each frame or field picture.
3240 * Meaningful frame information (codec specific) is guaranteed to
3241 * be parsed at this point. This function is mandatory.
3243 * Note that buf can be NULL along with buf_size set to 0.
3244 * Otherwise, this means the whole frame is available at this point.
3246 * @param avctx the codec context
3247 * @param buf the frame data buffer base
3248 * @param buf_size the size of the frame in bytes
3249 * @return zero if successful, a negative value otherwise
3251 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3254 * Callback for each slice.
3256 * Meaningful slice information (codec specific) is guaranteed to
3257 * be parsed at this point. This function is mandatory.
3259 * @param avctx the codec context
3260 * @param buf the slice data buffer base
3261 * @param buf_size the size of the slice in bytes
3262 * @return zero if successful, a negative value otherwise
3264 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3267 * Called at the end of each frame or field picture.
3269 * The whole picture is parsed at this point and can now be sent
3270 * to the hardware accelerator. This function is mandatory.
3272 * @param avctx the codec context
3273 * @return zero if successful, a negative value otherwise
3275 int (*end_frame)(AVCodecContext *avctx);
3278 * Size of HW accelerator private data.
3280 * Private data is allocated with av_mallocz() before
3281 * AVCodecContext.get_buffer() and deallocated after
3282 * AVCodecContext.release_buffer().
3288 * four components are given, that's all.
3289 * the last component is alpha
3291 typedef struct AVPicture {
3292 uint8_t *data[AV_NUM_DATA_POINTERS];
3293 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3296 #define AVPALETTE_SIZE 1024
3297 #define AVPALETTE_COUNT 256
3298 #if FF_API_PALETTE_CONTROL
3301 * This structure defines a method for communicating palette changes
3302 * between and demuxer and a decoder.
3304 * @deprecated Use AVPacket to send palette changes instead.
3305 * This is totally broken.
3307 typedef struct AVPaletteControl {
3309 /* Demuxer sets this to 1 to indicate the palette has changed;
3310 * decoder resets to 0. */
3311 int palette_changed;
3313 /* 4-byte ARGB palette entries, stored in native byte order; note that
3314 * the individual palette components should be on a 8-bit scale; if
3315 * the palette data comes from an IBM VGA native format, the component
3316 * data is probably 6 bits in size and needs to be scaled. */
3317 unsigned int palette[AVPALETTE_COUNT];
3319 } AVPaletteControl attribute_deprecated;
3322 enum AVSubtitleType {
3325 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3328 * Plain text, the text field must be set by the decoder and is
3329 * authoritative. ass and pict fields may contain approximations.
3334 * Formatted text, the ass field must be set by the decoder and is
3335 * authoritative. pict and text fields may contain approximations.
3340 typedef struct AVSubtitleRect {
3341 int x; ///< top left corner of pict, undefined when pict is not set
3342 int y; ///< top left corner of pict, undefined when pict is not set
3343 int w; ///< width of pict, undefined when pict is not set
3344 int h; ///< height of pict, undefined when pict is not set
3345 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3348 * data+linesize for the bitmap of this subtitle.
3349 * can be set for text/ass as well once they where rendered
3352 enum AVSubtitleType type;
3354 char *text; ///< 0 terminated plain UTF-8 text
3357 * 0 terminated ASS/SSA compatible event line.
3358 * The pressentation of this is unaffected by the other values in this
3364 typedef struct AVSubtitle {
3365 uint16_t format; /* 0 = graphics */
3366 uint32_t start_display_time; /* relative to packet pts, in ms */
3367 uint32_t end_display_time; /* relative to packet pts, in ms */
3369 AVSubtitleRect **rects;
3370 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3373 /* packet functions */
3376 * @deprecated use NULL instead
3378 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3381 * Default packet destructor.
3383 void av_destruct_packet(AVPacket *pkt);
3386 * Initialize optional fields of a packet with default values.
3390 void av_init_packet(AVPacket *pkt);
3393 * Allocate the payload of a packet and initialize its fields with
3397 * @param size wanted payload size
3398 * @return 0 if OK, AVERROR_xxx otherwise
3400 int av_new_packet(AVPacket *pkt, int size);
3403 * Reduce packet size, correctly zeroing padding
3406 * @param size new size
3408 void av_shrink_packet(AVPacket *pkt, int size);
3411 * Increase packet size, correctly zeroing padding
3414 * @param grow_by number of bytes by which to increase the size of the packet
3416 int av_grow_packet(AVPacket *pkt, int grow_by);
3419 * @warning This is a hack - the packet memory allocation stuff is broken. The
3420 * packet is allocated if it was not really allocated.
3422 int av_dup_packet(AVPacket *pkt);
3427 * @param pkt packet to free
3429 void av_free_packet(AVPacket *pkt);
3432 * Allocate new information of a packet.
3435 * @param type side information type
3436 * @param size side information size
3437 * @return pointer to fresh allocated data or NULL otherwise
3439 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3443 * Get side information from packet.
3446 * @param type desired side information type
3447 * @param size pointer for side information size to store (optional)
3448 * @return pointer to data if present or NULL otherwise
3450 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3455 struct ReSampleContext;
3456 struct AVResampleContext;
3458 typedef struct ReSampleContext ReSampleContext;
3461 * Initialize audio resampling context.
3463 * @param output_channels number of output channels
3464 * @param input_channels number of input channels
3465 * @param output_rate output sample rate
3466 * @param input_rate input sample rate
3467 * @param sample_fmt_out requested output sample format
3468 * @param sample_fmt_in input sample format
3469 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3470 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3471 * @param linear if 1 then the used FIR filter will be linearly interpolated
3472 between the 2 closest, if 0 the closest will be used
3473 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3474 * @return allocated ReSampleContext, NULL if error occurred
3476 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3477 int output_rate, int input_rate,
3478 enum AVSampleFormat sample_fmt_out,
3479 enum AVSampleFormat sample_fmt_in,
3480 int filter_length, int log2_phase_count,
3481 int linear, double cutoff);
3483 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3486 * Free resample context.
3488 * @param s a non-NULL pointer to a resample context previously
3489 * created with av_audio_resample_init()
3491 void audio_resample_close(ReSampleContext *s);
3495 * Initialize an audio resampler.
3496 * Note, if either rate is not an integer then simply scale both rates up so they are.
3497 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3498 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3499 * @param linear If 1 then the used FIR filter will be linearly interpolated
3500 between the 2 closest, if 0 the closest will be used
3501 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3503 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3506 * Resample an array of samples using a previously configured context.
3507 * @param src an array of unconsumed samples
3508 * @param consumed the number of samples of src which have been consumed are returned here
3509 * @param src_size the number of unconsumed samples available
3510 * @param dst_size the amount of space in samples available in dst
3511 * @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.
3512 * @return the number of samples written in dst or -1 if an error occurred
3514 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3518 * Compensate samplerate/timestamp drift. The compensation is done by changing
3519 * the resampler parameters, so no audible clicks or similar distortions occur
3520 * @param compensation_distance distance in output samples over which the compensation should be performed
3521 * @param sample_delta number of output samples which should be output less
3523 * example: av_resample_compensate(c, 10, 500)
3524 * here instead of 510 samples only 500 samples would be output
3526 * note, due to rounding the actual compensation might be slightly different,
3527 * especially if the compensation_distance is large and the in_rate used during init is small
3529 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3530 void av_resample_close(struct AVResampleContext *c);
3533 * Allocate memory for a picture. Call avpicture_free() to free it.
3535 * @see avpicture_fill()
3537 * @param picture the picture to be filled in
3538 * @param pix_fmt the format of the picture
3539 * @param width the width of the picture
3540 * @param height the height of the picture
3541 * @return zero if successful, a negative value if not
3543 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3546 * Free a picture previously allocated by avpicture_alloc().
3547 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3550 * @param picture the AVPicture to be freed
3552 void avpicture_free(AVPicture *picture);
3555 * Fill in the AVPicture fields.
3556 * The fields of the given AVPicture are filled in by using the 'ptr' address
3557 * which points to the image data buffer. Depending on the specified picture
3558 * format, one or multiple image data pointers and line sizes will be set.
3559 * If a planar format is specified, several pointers will be set pointing to
3560 * the different picture planes and the line sizes of the different planes
3561 * will be stored in the lines_sizes array.
3562 * Call with ptr == NULL to get the required size for the ptr buffer.
3564 * To allocate the buffer and fill in the AVPicture fields in one call,
3565 * use avpicture_alloc().
3567 * @param picture AVPicture whose fields are to be filled in
3568 * @param ptr Buffer which will contain or contains the actual image data
3569 * @param pix_fmt The format in which the picture data is stored.
3570 * @param width the width of the image in pixels
3571 * @param height the height of the image in pixels
3572 * @return size of the image data in bytes
3574 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3575 enum PixelFormat pix_fmt, int width, int height);
3578 * Copy pixel data from an AVPicture into a buffer.
3579 * The data is stored compactly, without any gaps for alignment or padding
3580 * which may be applied by avpicture_fill().
3582 * @see avpicture_get_size()
3584 * @param[in] src AVPicture containing image data
3585 * @param[in] pix_fmt The format in which the picture data is stored.
3586 * @param[in] width the width of the image in pixels.
3587 * @param[in] height the height of the image in pixels.
3588 * @param[out] dest A buffer into which picture data will be copied.
3589 * @param[in] dest_size The size of 'dest'.
3590 * @return The number of bytes written to dest, or a negative value (error code) on error.
3592 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3593 unsigned char *dest, int dest_size);
3596 * Calculate the size in bytes that a picture of the given width and height
3597 * would occupy if stored in the given picture format.
3598 * Note that this returns the size of a compact representation as generated
3599 * by avpicture_layout(), which can be smaller than the size required for e.g.
3602 * @param pix_fmt the given picture format
3603 * @param width the width of the image
3604 * @param height the height of the image
3605 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3607 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3608 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3610 #if FF_API_GET_PIX_FMT_NAME
3612 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3614 attribute_deprecated
3615 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3618 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3621 * Return a value representing the fourCC code associated to the
3622 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3625 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3628 * Put a string representing the codec tag codec_tag in buf.
3630 * @param buf_size size in bytes of buf
3631 * @return the length of the string that would have been generated if
3632 * enough space had been available, excluding the trailing null
3634 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3636 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3637 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3638 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3639 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3640 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3641 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3644 * Compute what kind of losses will occur when converting from one specific
3645 * pixel format to another.
3646 * When converting from one pixel format to another, information loss may occur.
3647 * For example, when converting from RGB24 to GRAY, the color information will
3648 * be lost. Similarly, other losses occur when converting from some formats to
3649 * other formats. These losses can involve loss of chroma, but also loss of
3650 * resolution, loss of color depth, loss due to the color space conversion, loss
3651 * of the alpha bits or loss due to color quantization.
3652 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3653 * which will occur when converting from one pixel format to another.
3655 * @param[in] dst_pix_fmt destination pixel format
3656 * @param[in] src_pix_fmt source pixel format
3657 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3658 * @return Combination of flags informing you what kind of losses will occur.
3660 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3664 * Find the best pixel format to convert to given a certain source pixel
3665 * format. When converting from one pixel format to another, information loss
3666 * may occur. For example, when converting from RGB24 to GRAY, the color
3667 * information will be lost. Similarly, other losses occur when converting from
3668 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3669 * the given pixel formats should be used to suffer the least amount of loss.
3670 * The pixel formats from which it chooses one, are determined by the
3671 * pix_fmt_mask parameter.
3674 * src_pix_fmt = PIX_FMT_YUV420P;
3675 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3676 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3679 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3680 * @param[in] src_pix_fmt source pixel format
3681 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3682 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3683 * @return The best pixel format to convert to or -1 if none was found.
3685 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3686 int has_alpha, int *loss_ptr);
3688 #if FF_API_GET_ALPHA_INFO
3689 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3690 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3693 * Tell if an image really has transparent alpha values.
3694 * @return ored mask of FF_ALPHA_xxx constants
3696 attribute_deprecated
3697 int img_get_alpha_info(const AVPicture *src,
3698 enum PixelFormat pix_fmt, int width, int height);
3701 /* deinterlace a picture */
3702 /* deinterlace - if not supported return -1 */
3703 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3704 enum PixelFormat pix_fmt, int width, int height);
3706 /* external high level API */
3709 * If c is NULL, returns the first registered codec,
3710 * if c is non-NULL, returns the next registered codec after c,
3711 * or NULL if c is the last one.
3713 AVCodec *av_codec_next(AVCodec *c);
3716 * Return the LIBAVCODEC_VERSION_INT constant.
3718 unsigned avcodec_version(void);
3721 * Return the libavcodec build-time configuration.
3723 const char *avcodec_configuration(void);
3726 * Return the libavcodec license.
3728 const char *avcodec_license(void);
3730 #if FF_API_AVCODEC_INIT
3732 * @deprecated this function is called automatically from avcodec_register()
3733 * and avcodec_register_all(), there is no need to call it manually
3735 attribute_deprecated
3736 void avcodec_init(void);
3740 * Register the codec codec and initialize libavcodec.
3742 * @warning either this function or avcodec_register_all() must be called
3743 * before any other libavcodec functions.
3745 * @see avcodec_register_all()
3747 void avcodec_register(AVCodec *codec);
3750 * Find a registered encoder with a matching codec ID.
3752 * @param id CodecID of the requested encoder
3753 * @return An encoder if one was found, NULL otherwise.
3755 AVCodec *avcodec_find_encoder(enum CodecID id);
3758 * Find a registered encoder with the specified name.
3760 * @param name name of the requested encoder
3761 * @return An encoder if one was found, NULL otherwise.
3763 AVCodec *avcodec_find_encoder_by_name(const char *name);
3766 * Find a registered decoder with a matching codec ID.
3768 * @param id CodecID of the requested decoder
3769 * @return A decoder if one was found, NULL otherwise.
3771 AVCodec *avcodec_find_decoder(enum CodecID id);
3774 * Find a registered decoder with the specified name.
3776 * @param name name of the requested decoder
3777 * @return A decoder if one was found, NULL otherwise.
3779 AVCodec *avcodec_find_decoder_by_name(const char *name);
3780 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3783 * Return a name for the specified profile, if available.
3785 * @param codec the codec that is searched for the given profile
3786 * @param profile the profile value for which a name is requested
3787 * @return A name for the profile if found, NULL otherwise.
3789 const char *av_get_profile_name(const AVCodec *codec, int profile);
3791 #if FF_API_ALLOC_CONTEXT
3793 * Set the fields of the given AVCodecContext to default values.
3795 * @param s The AVCodecContext of which the fields should be set to default values.
3796 * @deprecated use avcodec_get_context_defaults3
3798 attribute_deprecated
3799 void avcodec_get_context_defaults(AVCodecContext *s);
3801 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3802 * we WILL change its arguments and name a few times! */
3803 attribute_deprecated
3804 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3808 * Set the fields of the given AVCodecContext to default values corresponding
3809 * to the given codec (defaults may be codec-dependent).
3811 * Do not call this function if a non-NULL codec has been passed
3812 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3813 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3814 * different codec on this AVCodecContext.
3816 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3818 #if FF_API_ALLOC_CONTEXT
3820 * Allocate an AVCodecContext and set its fields to default values. The
3821 * resulting struct can be deallocated by simply calling av_free().
3823 * @return An AVCodecContext filled with default values or NULL on failure.
3824 * @see avcodec_get_context_defaults
3826 * @deprecated use avcodec_alloc_context3()
3828 attribute_deprecated
3829 AVCodecContext *avcodec_alloc_context(void);
3831 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3832 * we WILL change its arguments and name a few times! */
3833 attribute_deprecated
3834 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3838 * Allocate an AVCodecContext and set its fields to default values. The
3839 * resulting struct can be deallocated by simply calling av_free().
3841 * @param codec if non-NULL, allocate private data and initialize defaults
3842 * for the given codec. It is illegal to then call avcodec_open2()
3843 * with a different codec.
3845 * @return An AVCodecContext filled with default values or NULL on failure.
3846 * @see avcodec_get_context_defaults
3848 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3851 * Copy the settings of the source AVCodecContext into the destination
3852 * AVCodecContext. The resulting destination codec context will be
3853 * unopened, i.e. you are required to call avcodec_open2() before you
3854 * can use this AVCodecContext to decode/encode video/audio data.
3856 * @param dest target codec context, should be initialized with
3857 * avcodec_alloc_context3(), but otherwise uninitialized
3858 * @param src source codec context
3859 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3861 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3864 * Set the fields of the given AVFrame to default values.
3866 * @param pic The AVFrame of which the fields should be set to default values.
3868 void avcodec_get_frame_defaults(AVFrame *pic);
3871 * Allocate an AVFrame and set its fields to default values. The resulting
3872 * struct can be deallocated by simply calling av_free().
3874 * @return An AVFrame filled with default values or NULL on failure.
3875 * @see avcodec_get_frame_defaults
3877 AVFrame *avcodec_alloc_frame(void);
3879 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3880 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3881 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3884 * Return the amount of padding in pixels which the get_buffer callback must
3885 * provide around the edge of the image for codecs which do not have the
3886 * CODEC_FLAG_EMU_EDGE flag.
3888 * @return Required padding in pixels.
3890 unsigned avcodec_get_edge_width(void);
3892 * Modify width and height values so that they will result in a memory
3893 * buffer that is acceptable for the codec if you do not use any horizontal
3896 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3897 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3898 * according to avcodec_get_edge_width() before.
3900 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3902 * Modify width and height values so that they will result in a memory
3903 * buffer that is acceptable for the codec if you also ensure that all
3904 * line sizes are a multiple of the respective linesize_align[i].
3906 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3907 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3908 * according to avcodec_get_edge_width() before.
3910 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3911 int linesize_align[AV_NUM_DATA_POINTERS]);
3913 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3915 #if FF_API_THREAD_INIT
3917 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
3919 attribute_deprecated
3920 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3923 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3924 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3925 //FIXME func typedef
3927 #if FF_API_AVCODEC_OPEN
3929 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3930 * function the context has to be allocated.
3932 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3933 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3934 * retrieving a codec.
3936 * @warning This function is not thread safe!
3939 * avcodec_register_all();
3940 * codec = avcodec_find_decoder(CODEC_ID_H264);
3944 * context = avcodec_alloc_context3(codec);
3946 * if (avcodec_open(context, codec) < 0)
3950 * @param avctx The context which will be set up to use the given codec.
3951 * @param codec The codec to use within the context.
3952 * @return zero on success, a negative value on error
3953 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3955 * @deprecated use avcodec_open2
3957 attribute_deprecated
3958 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3962 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3963 * function the context has to be allocated with avcodec_alloc_context3().
3965 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3966 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3967 * retrieving a codec.
3969 * @warning This function is not thread safe!
3972 * avcodec_register_all();
3973 * av_dict_set(&opts, "b", "2.5M", 0);
3974 * codec = avcodec_find_decoder(CODEC_ID_H264);
3978 * context = avcodec_alloc_context3(codec);
3980 * if (avcodec_open2(context, codec, opts) < 0)
3984 * @param avctx The context to initialize.
3985 * @param options A dictionary filled with AVCodecContext and codec-private options.
3986 * On return this object will be filled with options that were not found.
3988 * @return zero on success, a negative value on error
3989 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3990 * av_dict_set(), av_opt_find().
3992 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3994 #if FF_API_OLD_DECODE_AUDIO
3996 * Wrapper function which calls avcodec_decode_audio4.
3998 * @deprecated Use avcodec_decode_audio4 instead.
4000 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4001 * Some decoders may support multiple frames in a single AVPacket, such
4002 * decoders would then just decode the first frame. In this case,
4003 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4004 * the remaining data in order to decode the second frame etc.
4006 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4007 * decompressed frame size in bytes.
4009 * @warning You must set frame_size_ptr to the allocated size of the
4010 * output buffer before calling avcodec_decode_audio3().
4012 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4013 * the actual read bytes because some optimized bitstream readers read 32 or 64
4014 * bits at once and could read over the end.
4016 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4017 * no overreading happens for damaged MPEG streams.
4019 * @note You might have to align the input buffer avpkt->data and output buffer
4020 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4021 * necessary at all, on others it won't work at all if not aligned and on others
4022 * it will work but it will have an impact on performance.
4024 * In practice, avpkt->data should have 4 byte alignment at minimum and
4025 * samples should be 16 byte aligned unless the CPU doesn't need it
4026 * (AltiVec and SSE do).
4028 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4029 * between input and output, these need to be fed with avpkt->data=NULL,
4030 * avpkt->size=0 at the end to return the remaining frames.
4032 * @param avctx the codec context
4033 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4034 * If the sample format is planar, each channel plane will
4035 * be the same size, with no padding between channels.
4036 * @param[in,out] frame_size_ptr the output buffer size in bytes
4037 * @param[in] avpkt The input AVPacket containing the input buffer.
4038 * You can create such packet with av_init_packet() and by then setting
4039 * data and size, some decoders might in addition need other fields.
4040 * All decoders are designed to use the least fields possible though.
4041 * @return On error a negative value is returned, otherwise the number of bytes
4042 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4044 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4045 int *frame_size_ptr,
4050 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4052 * Some decoders may support multiple frames in a single AVPacket. Such
4053 * decoders would then just decode the first frame. In this case,
4054 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4055 * the remaining data in order to decode the second frame, etc...
4056 * Even if no frames are returned, the packet needs to be fed to the decoder
4057 * with remaining data until it is completely consumed or an error occurs.
4059 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4060 * larger than the actual read bytes because some optimized bitstream
4061 * readers read 32 or 64 bits at once and could read over the end.
4063 * @note You might have to align the input buffer. The alignment requirements
4064 * depend on the CPU and the decoder.
4066 * @param avctx the codec context
4067 * @param[out] frame The AVFrame in which to store decoded audio samples.
4068 * Decoders request a buffer of a particular size by setting
4069 * AVFrame.nb_samples prior to calling get_buffer(). The
4070 * decoder may, however, only utilize part of the buffer by
4071 * setting AVFrame.nb_samples to a smaller value in the
4073 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4075 * @param[in] avpkt The input AVPacket containing the input buffer.
4076 * At least avpkt->data and avpkt->size should be set. Some
4077 * decoders might also require additional fields to be set.
4078 * @return A negative error code is returned if an error occurred during
4079 * decoding, otherwise the number of bytes consumed from the input
4080 * AVPacket is returned.
4082 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4083 int *got_frame_ptr, AVPacket *avpkt);
4086 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4087 * Some decoders may support multiple frames in a single AVPacket, such
4088 * decoders would then just decode the first frame.
4090 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4091 * the actual read bytes because some optimized bitstream readers read 32 or 64
4092 * bits at once and could read over the end.
4094 * @warning The end of the input buffer buf should be set to 0 to ensure that
4095 * no overreading happens for damaged MPEG streams.
4097 * @note You might have to align the input buffer avpkt->data.
4098 * The alignment requirements depend on the CPU: on some CPUs it isn't
4099 * necessary at all, on others it won't work at all if not aligned and on others
4100 * it will work but it will have an impact on performance.
4102 * In practice, avpkt->data should have 4 byte alignment at minimum.
4104 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4105 * between input and output, these need to be fed with avpkt->data=NULL,
4106 * avpkt->size=0 at the end to return the remaining frames.
4108 * @param avctx the codec context
4109 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4110 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4111 * allocate memory for the actual bitmap.
4112 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4113 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4114 * decodes and the decoder tells the user once it does not need the data anymore,
4115 * the user app can at this point free/reuse/keep the memory as it sees fit.
4117 * @param[in] avpkt The input AVpacket containing the input buffer.
4118 * You can create such packet with av_init_packet() and by then setting
4119 * data and size, some decoders might in addition need other fields like
4120 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4122 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4123 * @return On error a negative value is returned, otherwise the number of bytes
4124 * used or zero if no frame could be decompressed.
4126 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4127 int *got_picture_ptr,
4131 * Decode a subtitle message.
4132 * Return a negative value on error, otherwise return the number of bytes used.
4133 * If no subtitle could be decompressed, got_sub_ptr is zero.
4134 * Otherwise, the subtitle is stored in *sub.
4135 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4136 * simplicity, because the performance difference is expect to be negligible
4137 * and reusing a get_buffer written for video codecs would probably perform badly
4138 * due to a potentially very different allocation pattern.
4140 * @param avctx the codec context
4141 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4142 freed with avsubtitle_free if *got_sub_ptr is set.
4143 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4144 * @param[in] avpkt The input AVPacket containing the input buffer.
4146 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4151 * Free all allocated data in the given subtitle struct.
4153 * @param sub AVSubtitle to free.
4155 void avsubtitle_free(AVSubtitle *sub);
4158 * Encode an audio frame from samples into buf.
4160 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4161 * However, for PCM audio the user will know how much space is needed
4162 * because it depends on the value passed in buf_size as described
4163 * below. In that case a lower value can be used.
4165 * @param avctx the codec context
4166 * @param[out] buf the output buffer
4167 * @param[in] buf_size the output buffer size
4168 * @param[in] samples the input buffer containing the samples
4169 * The number of samples read from this buffer is frame_size*channels,
4170 * both of which are defined in avctx.
4171 * For PCM audio the number of samples read from samples is equal to
4172 * buf_size * input_sample_size / output_sample_size.
4173 * @return On error a negative value is returned, on success zero or the number
4174 * of bytes used to encode the data read from the input buffer.
4176 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4177 const short *samples);
4180 * Encode a video frame from pict into buf.
4181 * The input picture should be
4182 * stored using a specific format, namely avctx.pix_fmt.
4184 * @param avctx the codec context
4185 * @param[out] buf the output buffer for the bitstream of encoded frame
4186 * @param[in] buf_size the size of the output buffer in bytes
4187 * @param[in] pict the input picture to encode
4188 * @return On error a negative value is returned, on success zero or the number
4189 * of bytes used from the output buffer.
4191 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4192 const AVFrame *pict);
4193 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4194 const AVSubtitle *sub);
4196 int avcodec_close(AVCodecContext *avctx);
4199 * Register all the codecs, parsers and bitstream filters which were enabled at
4200 * configuration time. If you do not call this function you can select exactly
4201 * which formats you want to support, by using the individual registration
4204 * @see avcodec_register
4205 * @see av_register_codec_parser
4206 * @see av_register_bitstream_filter
4208 void avcodec_register_all(void);
4211 * Flush buffers, should be called when seeking or when switching to a different stream.
4213 void avcodec_flush_buffers(AVCodecContext *avctx);
4215 void avcodec_default_free_buffers(AVCodecContext *s);
4217 /* misc useful functions */
4219 #if FF_API_OLD_FF_PICT_TYPES
4221 * Return a single letter to describe the given picture type pict_type.
4223 * @param[in] pict_type the picture type
4224 * @return A single character representing the picture type.
4225 * @deprecated Use av_get_picture_type_char() instead.
4227 attribute_deprecated
4228 char av_get_pict_type_char(int pict_type);
4232 * Return codec bits per sample.
4234 * @param[in] codec_id the codec
4235 * @return Number of bits per sample or zero if unknown for the given codec.
4237 int av_get_bits_per_sample(enum CodecID codec_id);
4239 #if FF_API_OLD_SAMPLE_FMT
4241 * @deprecated Use av_get_bytes_per_sample() instead.
4243 attribute_deprecated
4244 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4248 typedef struct AVCodecParserContext {
4250 struct AVCodecParser *parser;
4251 int64_t frame_offset; /* offset of the current frame */
4252 int64_t cur_offset; /* current offset
4253 (incremented by each av_parser_parse()) */
4254 int64_t next_frame_offset; /* offset of the next frame */
4256 int pict_type; /* XXX: Put it back in AVCodecContext. */
4258 * This field is used for proper frame duration computation in lavf.
4259 * It signals, how much longer the frame duration of the current frame
4260 * is compared to normal frame duration.
4262 * frame_duration = (1 + repeat_pict) * time_base
4264 * It is used by codecs like H.264 to display telecined material.
4266 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4267 int64_t pts; /* pts of the current frame */
4268 int64_t dts; /* dts of the current frame */
4273 int fetch_timestamp;
4275 #define AV_PARSER_PTS_NB 4
4276 int cur_frame_start_index;
4277 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4278 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4279 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4282 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4283 #define PARSER_FLAG_ONCE 0x0002
4284 /// Set if the parser has a valid file offset
4285 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4287 int64_t offset; ///< byte offset from starting packet start
4288 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4291 * Set by parser to 1 for key frames and 0 for non-key frames.
4292 * It is initialized to -1, so if the parser doesn't set this flag,
4293 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4299 * Time difference in stream time base units from the pts of this
4300 * packet to the point at which the output from the decoder has converged
4301 * independent from the availability of previous frames. That is, the
4302 * frames are virtually identical no matter if decoding started from
4303 * the very first frame or from this keyframe.
4304 * Is AV_NOPTS_VALUE if unknown.
4305 * This field is not the display duration of the current frame.
4306 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4309 * The purpose of this field is to allow seeking in streams that have no
4310 * keyframes in the conventional sense. It corresponds to the
4311 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4312 * essential for some types of subtitle streams to ensure that all
4313 * subtitles are correctly displayed after seeking.
4315 int64_t convergence_duration;
4317 // Timestamp generation support:
4319 * Synchronization point for start of timestamp generation.
4321 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4324 * For example, this corresponds to presence of H.264 buffering period
4330 * Offset of the current timestamp against last timestamp sync point in
4331 * units of AVCodecContext.time_base.
4333 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4334 * contain a valid timestamp offset.
4336 * Note that the timestamp of sync point has usually a nonzero
4337 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4338 * the next frame after timestamp sync point will be usually 1.
4340 * For example, this corresponds to H.264 cpb_removal_delay.
4342 int dts_ref_dts_delta;
4345 * Presentation delay of current frame in units of AVCodecContext.time_base.
4347 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4348 * contain valid non-negative timestamp delta (presentation time of a frame
4349 * must not lie in the past).
4351 * This delay represents the difference between decoding and presentation
4352 * time of the frame.
4354 * For example, this corresponds to H.264 dpb_output_delay.
4359 * Position of the packet in file.
4361 * Analogous to cur_frame_pts/dts
4363 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4366 * Byte position of currently parsed frame in stream.
4371 * Previous frame byte position.
4374 } AVCodecParserContext;
4376 typedef struct AVCodecParser {
4377 int codec_ids[5]; /* several codec IDs are permitted */
4379 int (*parser_init)(AVCodecParserContext *s);
4380 int (*parser_parse)(AVCodecParserContext *s,
4381 AVCodecContext *avctx,
4382 const uint8_t **poutbuf, int *poutbuf_size,
4383 const uint8_t *buf, int buf_size);
4384 void (*parser_close)(AVCodecParserContext *s);
4385 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4386 struct AVCodecParser *next;
4389 AVCodecParser *av_parser_next(AVCodecParser *c);
4391 void av_register_codec_parser(AVCodecParser *parser);
4392 AVCodecParserContext *av_parser_init(int codec_id);
4397 * @param s parser context.
4398 * @param avctx codec context.
4399 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4400 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4401 * @param buf input buffer.
4402 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4403 * @param pts input presentation timestamp.
4404 * @param dts input decoding timestamp.
4405 * @param pos input byte position in stream.
4406 * @return the number of bytes of the input bitstream used.
4411 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4418 * decode_frame(data, size);
4422 int av_parser_parse2(AVCodecParserContext *s,
4423 AVCodecContext *avctx,
4424 uint8_t **poutbuf, int *poutbuf_size,
4425 const uint8_t *buf, int buf_size,
4426 int64_t pts, int64_t dts,
4429 int av_parser_change(AVCodecParserContext *s,
4430 AVCodecContext *avctx,
4431 uint8_t **poutbuf, int *poutbuf_size,
4432 const uint8_t *buf, int buf_size, int keyframe);
4433 void av_parser_close(AVCodecParserContext *s);
4436 typedef struct AVBitStreamFilterContext {
4438 struct AVBitStreamFilter *filter;
4439 AVCodecParserContext *parser;
4440 struct AVBitStreamFilterContext *next;
4441 } AVBitStreamFilterContext;
4444 typedef struct AVBitStreamFilter {
4447 int (*filter)(AVBitStreamFilterContext *bsfc,
4448 AVCodecContext *avctx, const char *args,
4449 uint8_t **poutbuf, int *poutbuf_size,
4450 const uint8_t *buf, int buf_size, int keyframe);
4451 void (*close)(AVBitStreamFilterContext *bsfc);
4452 struct AVBitStreamFilter *next;
4453 } AVBitStreamFilter;
4455 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4456 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4457 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4458 AVCodecContext *avctx, const char *args,
4459 uint8_t **poutbuf, int *poutbuf_size,
4460 const uint8_t *buf, int buf_size, int keyframe);
4461 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4463 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4468 * Reallocate the given block if it is not large enough, otherwise do nothing.
4472 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4475 * Allocate a buffer, reusing the given one if large enough.
4477 * Contrary to av_fast_realloc the current buffer contents might not be
4478 * preserved and on error the old buffer is freed, thus no special
4479 * handling to avoid memleaks is necessary.
4481 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4482 * @param size size of the buffer *ptr points to
4483 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4484 * *size 0 if an error occurred.
4486 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4489 * Copy image src to dst. Wraps av_picture_data_copy() above.
4491 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4492 enum PixelFormat pix_fmt, int width, int height);
4495 * Crop image top and left side.
4497 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4498 enum PixelFormat pix_fmt, int top_band, int left_band);
4503 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4504 int padtop, int padbottom, int padleft, int padright, int *color);
4507 * Encode extradata length to a buffer. Used by xiph codecs.
4509 * @param s buffer to write to; must be at least (v/255+1) bytes long
4510 * @param v size of extradata in bytes
4511 * @return number of bytes written to the buffer.
4513 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4516 * Log a generic warning message about a missing feature. This function is
4517 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4518 * only, and would normally not be used by applications.
4519 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4520 * a pointer to an AVClass struct
4521 * @param[in] feature string containing the name of the missing feature
4522 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4523 * If want_sample is non-zero, additional verbage will be added to the log
4524 * message which tells the user how to report samples to the development
4527 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4530 * Log a generic warning message asking for a sample. This function is
4531 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4532 * only, and would normally not be used by applications.
4533 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4534 * a pointer to an AVClass struct
4535 * @param[in] msg string containing an optional message, or NULL if no message
4537 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4540 * Register the hardware accelerator hwaccel.
4542 void av_register_hwaccel(AVHWAccel *hwaccel);
4545 * If hwaccel is NULL, returns the first registered hardware accelerator,
4546 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4547 * after hwaccel, or NULL if hwaccel is the last one.
4549 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4553 * Lock operation used by lockmgr
4556 AV_LOCK_CREATE, ///< Create a mutex
4557 AV_LOCK_OBTAIN, ///< Lock the mutex
4558 AV_LOCK_RELEASE, ///< Unlock the mutex
4559 AV_LOCK_DESTROY, ///< Free mutex resources
4563 * Register a user provided lock manager supporting the operations
4564 * specified by AVLockOp. mutex points to a (void *) where the
4565 * lockmgr should store/get a pointer to a user allocated mutex. It's
4566 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4568 * @param cb User defined callback. Note: Libav may invoke calls to this
4569 * callback during the call to av_lockmgr_register().
4570 * Thus, the application must be prepared to handle that.
4571 * If cb is set to NULL the lockmgr will be unregistered.
4572 * Also note that during unregistration the previously registered
4573 * lockmgr callback may also be invoked.
4575 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4578 * Get the type of the given codec.
4580 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4583 * Get the AVClass for AVCodecContext. It can be used in combination with
4584 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4586 * @see av_opt_find().
4588 const AVClass *avcodec_get_class(void);
4590 #endif /* AVCODEC_AVCODEC_H */