2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg 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 * FFmpeg 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 FFmpeg; 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 "libavcore/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
34 #define LIBAVCODEC_VERSION_MAJOR 52
35 #define LIBAVCODEC_VERSION_MINOR 108
36 #define LIBAVCODEC_VERSION_MICRO 0
38 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
39 LIBAVCODEC_VERSION_MINOR, \
40 LIBAVCODEC_VERSION_MICRO)
41 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
42 LIBAVCODEC_VERSION_MINOR, \
43 LIBAVCODEC_VERSION_MICRO)
44 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
46 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
49 * Those FF_API_* defines are not part of public API.
50 * They may change, break or disappear at any time.
52 #ifndef FF_API_PALETTE_CONTROL
53 #define FF_API_PALETTE_CONTROL (LIBAVCODEC_VERSION_MAJOR < 54)
55 #ifndef FF_API_MM_FLAGS
56 #define FF_API_MM_FLAGS (LIBAVCODEC_VERSION_MAJOR < 53)
58 #ifndef FF_API_OPT_SHOW
59 #define FF_API_OPT_SHOW (LIBAVCODEC_VERSION_MAJOR < 53)
61 #ifndef FF_API_AUDIO_OLD
62 #define FF_API_AUDIO_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
64 #ifndef FF_API_VIDEO_OLD
65 #define FF_API_VIDEO_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
67 #ifndef FF_API_SUBTITLE_OLD
68 #define FF_API_SUBTITLE_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
70 #ifndef FF_API_USE_LPC
71 #define FF_API_USE_LPC (LIBAVCODEC_VERSION_MAJOR < 53)
73 #ifndef FF_API_SET_STRING_OLD
74 #define FF_API_SET_STRING_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
76 #ifndef FF_API_INOFFICIAL
77 #define FF_API_INOFFICIAL (LIBAVCODEC_VERSION_MAJOR < 53)
79 #ifndef FF_API_OLD_SAMPLE_FMT
80 #define FF_API_OLD_SAMPLE_FMT (LIBAVCODEC_VERSION_MAJOR < 53)
82 #ifndef FF_API_OLD_AUDIOCONVERT
83 #define FF_API_OLD_AUDIOCONVERT (LIBAVCODEC_VERSION_MAJOR < 53)
86 #if LIBAVCODEC_VERSION_MAJOR < 53
87 # define FF_INTERNALC_MEM_TYPE unsigned int
89 # define FF_INTERNALC_MEM_TYPE size_t
93 * Identify the syntax and semantics of the bitstream.
94 * The principle is roughly:
95 * Two decoders with the same ID can decode the same streams.
96 * Two encoders with the same ID can encode compatible streams.
97 * There may be slight deviations from the principle due to implementation
100 * If you add a codec ID to this list, add it so that
101 * 1. no value of a existing codec ID changes (that would break ABI),
102 * 2. it is as close as possible to similar codecs.
109 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
110 CODEC_ID_MPEG2VIDEO_XVMC,
147 CODEC_ID_INTERPLAY_VIDEO,
159 CODEC_ID_TRUEMOTION1,
170 #if LIBAVCODEC_VERSION_MAJOR < 53
189 CODEC_ID_TRUEMOTION2,
206 CODEC_ID_DSICINVIDEO,
207 CODEC_ID_TIERTEXSEQVIDEO,
216 CODEC_ID_BETHSOFTVID,
234 CODEC_ID_MOTIONPIXELS,
252 CODEC_ID_IFF_BYTERUN1,
264 /* various PCM "codecs" */
265 CODEC_ID_PCM_S16LE= 0x10000,
281 CODEC_ID_PCM_S24DAUD,
283 CODEC_ID_PCM_S16LE_PLANAR,
292 /* various ADPCM codecs */
293 CODEC_ID_ADPCM_IMA_QT= 0x11000,
294 CODEC_ID_ADPCM_IMA_WAV,
295 CODEC_ID_ADPCM_IMA_DK3,
296 CODEC_ID_ADPCM_IMA_DK4,
297 CODEC_ID_ADPCM_IMA_WS,
298 CODEC_ID_ADPCM_IMA_SMJPEG,
307 CODEC_ID_ADPCM_YAMAHA,
308 CODEC_ID_ADPCM_SBPRO_4,
309 CODEC_ID_ADPCM_SBPRO_3,
310 CODEC_ID_ADPCM_SBPRO_2,
312 CODEC_ID_ADPCM_IMA_AMV,
313 CODEC_ID_ADPCM_EA_R1,
314 CODEC_ID_ADPCM_EA_R3,
315 CODEC_ID_ADPCM_EA_R2,
316 CODEC_ID_ADPCM_IMA_EA_SEAD,
317 CODEC_ID_ADPCM_IMA_EA_EACS,
318 CODEC_ID_ADPCM_EA_XAS,
319 CODEC_ID_ADPCM_EA_MAXIS_XA,
320 CODEC_ID_ADPCM_IMA_ISS,
324 CODEC_ID_AMR_NB= 0x12000,
327 /* RealAudio codecs*/
328 CODEC_ID_RA_144= 0x13000,
331 /* various DPCM codecs */
332 CODEC_ID_ROQ_DPCM= 0x14000,
333 CODEC_ID_INTERPLAY_DPCM,
338 CODEC_ID_MP2= 0x15000,
339 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
357 CODEC_ID_WESTWOOD_SND1,
358 CODEC_ID_GSM, ///< as in Berlin toast format
366 CODEC_ID_DSICINAUDIO,
370 CODEC_ID_GSM_MS, /* as found in WAV */
379 CODEC_ID_WMALOSSLESS,
388 CODEC_ID_BINKAUDIO_RDFT,
389 CODEC_ID_BINKAUDIO_DCT,
392 /* subtitle codecs */
393 CODEC_ID_DVD_SUBTITLE= 0x17000,
394 CODEC_ID_DVB_SUBTITLE,
395 CODEC_ID_TEXT, ///< raw UTF-8 text
399 CODEC_ID_HDMV_PGS_SUBTITLE,
400 CODEC_ID_DVB_TELETEXT,
403 /* other specific kind of codecs (generally used for attachments) */
404 CODEC_ID_TTF= 0x18000,
406 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
408 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
409 * stream (only used by libavformat) */
410 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
413 #if LIBAVCODEC_VERSION_MAJOR < 53
414 #define CodecType AVMediaType
416 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
417 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
418 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
419 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
420 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
421 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
422 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
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 "libavcore/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
486 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
489 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
490 * This is mainly needed because some optimized bitstream readers read
491 * 32 or 64 bit at once and could read over the end.<br>
492 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
493 * MPEG bitstreams could cause overread and segfault.
495 #define FF_INPUT_BUFFER_PADDING_SIZE 8
498 * minimum encoding buffer size
499 * Used to avoid some checks during header writing.
501 #define FF_MIN_BUFFER_SIZE 16384
505 * motion estimation type.
508 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
512 ME_EPZS, ///< enhanced predictive zonal search
513 ME_X1, ///< reserved for experiments
514 ME_HEX, ///< hexagon based search
515 ME_UMH, ///< uneven multi-hexagon search
516 ME_ITER, ///< iterative search
517 ME_TESA, ///< transformed exhaustive search algorithm
521 /* We leave some space between them for extensions (drop some
522 * keyframes for intra-only or drop just some bidir frames). */
523 AVDISCARD_NONE =-16, ///< discard nothing
524 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
525 AVDISCARD_NONREF = 8, ///< discard all non reference
526 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
527 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
528 AVDISCARD_ALL = 48, ///< discard all
531 enum AVColorPrimaries{
532 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
533 AVCOL_PRI_UNSPECIFIED=2,
535 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
536 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
537 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
539 AVCOL_PRI_NB , ///< Not part of ABI
542 enum AVColorTransferCharacteristic{
543 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
544 AVCOL_TRC_UNSPECIFIED=2,
545 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
546 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
547 AVCOL_TRC_NB , ///< Not part of ABI
552 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
553 AVCOL_SPC_UNSPECIFIED=2,
555 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
556 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
557 AVCOL_SPC_SMPTE240M =7,
558 AVCOL_SPC_NB , ///< Not part of ABI
562 AVCOL_RANGE_UNSPECIFIED=0,
563 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
564 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
565 AVCOL_RANGE_NB , ///< Not part of ABI
569 * X X 3 4 X X are luma samples,
570 * 1 2 1-6 are possible chroma positions
571 * X X 5 6 X 0 is undefined/unknown position
573 enum AVChromaLocation{
574 AVCHROMA_LOC_UNSPECIFIED=0,
575 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
576 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
577 AVCHROMA_LOC_TOPLEFT =3, ///< DV
579 AVCHROMA_LOC_BOTTOMLEFT =5,
580 AVCHROMA_LOC_BOTTOM =6,
581 AVCHROMA_LOC_NB , ///< Not part of ABI
588 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
589 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
590 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
591 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
592 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
593 AV_LPC_TYPE_NB , ///< Not part of ABI
596 typedef struct RcOverride{
599 int qscale; // If this is 0 then quality_factor will be used instead.
600 float quality_factor;
603 #define FF_MAX_B_FRAMES 16
606 These flags can be passed in AVCodecContext.flags before initialization.
607 Note: Not everything is supported yet.
610 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
611 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
612 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
613 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
614 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
615 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
617 * The parent program guarantees that the input for B-frames containing
618 * streams is not written to for at least s->max_b_frames+1 frames, if
619 * this is not set the input will be copied.
621 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
622 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
623 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
624 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
625 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
626 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
627 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
628 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
629 location instead of only at frame boundaries. */
630 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
631 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
632 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
633 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
634 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
635 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
636 /* Fx : Flag for h263+ extra options */
637 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
638 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
639 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
640 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
641 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
642 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
643 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
644 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
645 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
646 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
647 #define CODEC_FLAG_CLOSED_GOP 0x80000000
648 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
649 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
650 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
651 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
652 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
653 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
654 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
655 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
656 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
657 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
658 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
659 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
660 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
661 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
662 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
663 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
664 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
665 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
666 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
667 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
668 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
669 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
671 /* Unsupported options :
672 * Syntax Arithmetic coding (SAC)
673 * Reference Picture Selection
674 * Independent Segment Decoding */
676 /* codec capabilities */
678 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
680 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
681 * If not set, it might not use get_buffer() at all or use operations that
682 * assume the buffer was allocated by avcodec_default_get_buffer.
684 #define CODEC_CAP_DR1 0x0002
685 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
686 #define CODEC_CAP_PARSE_ONLY 0x0004
687 #define CODEC_CAP_TRUNCATED 0x0008
688 /* Codec can export data for HW decoding (XvMC). */
689 #define CODEC_CAP_HWACCEL 0x0010
691 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
692 * If this is not set, the codec is guaranteed to never be fed with NULL data.
694 #define CODEC_CAP_DELAY 0x0020
696 * Codec can be fed a final frame with a smaller size.
697 * This can be used to prevent truncation of the last audio samples.
699 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
701 * Codec can export data for HW decoding (VDPAU).
703 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
705 * Codec can output multiple frames per AVPacket
706 * Normally demuxers return one frame at a time, demuxers which do not do
707 * are connected to a parser to split what they return into proper frames.
708 * This flag is reserved to the very rare category of codecs which have a
709 * bitstream that cannot be split into frames without timeconsuming
710 * operations like full decoding. Demuxers carring such bitstreams thus
711 * may return multiple frames in a packet. This has many disadvantages like
712 * prohibiting stream copy in many cases thus it should only be considered
715 #define CODEC_CAP_SUBFRAMES 0x0100
717 * Codec is experimental and is thus avoided in favor of non experimental
720 #define CODEC_CAP_EXPERIMENTAL 0x0200
722 * Codec should fill in channel configuration and samplerate instead of container
724 #define CODEC_CAP_CHANNEL_CONF 0x0400
726 * Codec is able to deal with negative linesizes
728 #define CODEC_CAP_NEG_LINESIZES 0x0800
730 //The following defines may change, don't expect compatibility if you use them.
731 #define MB_TYPE_INTRA4x4 0x0001
732 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
733 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
734 #define MB_TYPE_16x16 0x0008
735 #define MB_TYPE_16x8 0x0010
736 #define MB_TYPE_8x16 0x0020
737 #define MB_TYPE_8x8 0x0040
738 #define MB_TYPE_INTERLACED 0x0080
739 #define MB_TYPE_DIRECT2 0x0100 //FIXME
740 #define MB_TYPE_ACPRED 0x0200
741 #define MB_TYPE_GMC 0x0400
742 #define MB_TYPE_SKIP 0x0800
743 #define MB_TYPE_P0L0 0x1000
744 #define MB_TYPE_P1L0 0x2000
745 #define MB_TYPE_P0L1 0x4000
746 #define MB_TYPE_P1L1 0x8000
747 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
748 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
749 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
750 #define MB_TYPE_QUANT 0x00010000
751 #define MB_TYPE_CBP 0x00020000
752 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
756 * This specifies the area which should be displayed.
757 * Note there may be multiple such areas for one frame.
759 typedef struct AVPanScan{
762 * - encoding: Set by user.
763 * - decoding: Set by libavcodec.
768 * width and height in 1/16 pel
769 * - encoding: Set by user.
770 * - decoding: Set by libavcodec.
776 * position of the top left corner in 1/16 pel for up to 3 fields/frames
777 * - encoding: Set by user.
778 * - decoding: Set by libavcodec.
780 int16_t position[3][2];
783 #define FF_COMMON_FRAME \
785 * pointer to the picture planes.\
786 * This might be different from the first allocated byte\
793 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
794 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
800 * 1 -> keyframe, 0-> not\
801 * - encoding: Set by libavcodec.\
802 * - decoding: Set by libavcodec.\
807 * Picture type of the frame, see ?_TYPE below.\
808 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
809 * - decoding: Set by libavcodec.\
814 * presentation timestamp in time_base units (time when frame should be shown to user)\
815 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
816 * - encoding: MUST be set by user.\
817 * - decoding: Set by libavcodec.\
822 * picture number in bitstream order\
823 * - encoding: set by\
824 * - decoding: Set by libavcodec.\
826 int coded_picture_number;\
828 * picture number in display order\
829 * - encoding: set by\
830 * - decoding: Set by libavcodec.\
832 int display_picture_number;\
835 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
836 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
837 * - decoding: Set by libavcodec.\
842 * buffer age (1->was last buffer and dint change, 2->..., ...).\
843 * Set to INT_MAX if the buffer has not been used yet.\
844 * - encoding: unused\
845 * - decoding: MUST be set by get_buffer().\
850 * is this picture used as reference\
851 * The values for this are the same as the MpegEncContext.picture_structure\
852 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
853 * Set to 4 for delayed, non-reference frames.\
854 * - encoding: unused\
855 * - decoding: Set by libavcodec. (before get_buffer() call)).\
861 * - encoding: unused\
862 * - decoding: Set by libavcodec.\
864 int8_t *qscale_table;\
867 * - encoding: unused\
868 * - decoding: Set by libavcodec.\
873 * mbskip_table[mb]>=1 if MB didn't change\
874 * stride= mb_width = (width+15)>>4\
875 * - encoding: unused\
876 * - decoding: Set by libavcodec.\
878 uint8_t *mbskip_table;\
881 * motion vector table\
884 * int mv_sample_log2= 4 - motion_subsample_log2;\
885 * int mb_width= (width+15)>>4;\
886 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
887 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
889 * - encoding: Set by user.\
890 * - decoding: Set by libavcodec.\
892 int16_t (*motion_val[2])[2];\
895 * macroblock type table\
896 * mb_type_base + mb_width + 2\
897 * - encoding: Set by user.\
898 * - decoding: Set by libavcodec.\
903 * log2 of the size of the block which a single vector in motion_val represents: \
904 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
905 * - encoding: unused\
906 * - decoding: Set by libavcodec.\
908 uint8_t motion_subsample_log2;\
911 * for some private data of the user\
912 * - encoding: unused\
913 * - decoding: Set by user.\
919 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
920 * - decoding: unused\
925 * type of the buffer (to keep track of who has to deallocate data[*])\
926 * - encoding: Set by the one who allocates it.\
927 * - decoding: Set by the one who allocates it.\
928 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
933 * When decoding, this signals how much the picture must be delayed.\
934 * extra_delay = repeat_pict / (2*fps)\
935 * - encoding: unused\
936 * - decoding: Set by libavcodec.\
946 * The content of the picture is interlaced.\
947 * - encoding: Set by user.\
948 * - decoding: Set by libavcodec. (default 0)\
950 int interlaced_frame;\
953 * If the content is interlaced, is top field displayed first.\
954 * - encoding: Set by user.\
955 * - decoding: Set by libavcodec.\
957 int top_field_first;\
961 * - encoding: Set by user.\
962 * - decoding: Set by libavcodec.\
964 AVPanScan *pan_scan;\
967 * Tell user application that palette has changed from previous frame.\
968 * - encoding: ??? (no palette-enabled encoder yet)\
969 * - decoding: Set by libavcodec. (default 0).\
971 int palette_has_changed;\
974 * codec suggestion on buffer type if != 0\
975 * - encoding: unused\
976 * - decoding: Set by libavcodec. (before get_buffer() call)).\
982 * - encoding: unused\
983 * - decoding: Set by libavcodec.\
988 * motion reference frame index\
989 * the order in which these are stored can depend on the codec.\
990 * - encoding: Set by user.\
991 * - decoding: Set by libavcodec.\
993 int8_t *ref_index[2];\
996 * reordered opaque 64bit (generally an integer or a double precision float\
997 * PTS but can be anything). \
998 * The user sets AVCodecContext.reordered_opaque to represent the input at\
1000 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
1001 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
1002 * @deprecated in favor of pkt_pts\
1003 * - encoding: unused\
1004 * - decoding: Read by user.\
1006 int64_t reordered_opaque;\
1009 * hardware accelerator private data (FFmpeg allocated)\
1010 * - encoding: unused\
1011 * - decoding: Set by libavcodec\
1013 void *hwaccel_picture_private;\
1016 * reordered pts from the last AVPacket that has been input into the decoder\
1017 * - encoding: unused\
1018 * - decoding: Read by user.\
1023 * dts from the last AVPacket that has been input into the decoder\
1024 * - encoding: unused\
1025 * - decoding: Read by user.\
1030 #define FF_QSCALE_TYPE_MPEG1 0
1031 #define FF_QSCALE_TYPE_MPEG2 1
1032 #define FF_QSCALE_TYPE_H264 2
1033 #define FF_QSCALE_TYPE_VP56 3
1035 #define FF_BUFFER_TYPE_INTERNAL 1
1036 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1037 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1038 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1041 #define FF_I_TYPE 1 ///< Intra
1042 #define FF_P_TYPE 2 ///< Predicted
1043 #define FF_B_TYPE 3 ///< Bi-dir predicted
1044 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1045 #define FF_SI_TYPE 5 ///< Switching Intra
1046 #define FF_SP_TYPE 6 ///< Switching Predicted
1047 #define FF_BI_TYPE 7
1049 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1050 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1051 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1052 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1054 typedef struct AVPacket {
1056 * Presentation timestamp in AVStream->time_base units; the time at which
1057 * the decompressed packet will be presented to the user.
1058 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1059 * pts MUST be larger or equal to dts as presentation cannot happen before
1060 * decompression, unless one wants to view hex dumps. Some formats misuse
1061 * the terms dts and pts/cts to mean something different. Such timestamps
1062 * must be converted to true pts/dts before they are stored in AVPacket.
1066 * Decompression timestamp in AVStream->time_base units; the time at which
1067 * the packet is decompressed.
1068 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1076 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1077 * Equals next_pts - this_pts in presentation order.
1080 void (*destruct)(struct AVPacket *);
1082 int64_t pos; ///< byte position in stream, -1 if unknown
1085 * Time difference in AVStream->time_base units from the pts of this
1086 * packet to the point at which the output from the decoder has converged
1087 * independent from the availability of previous frames. That is, the
1088 * frames are virtually identical no matter if decoding started from
1089 * the very first frame or from this keyframe.
1090 * Is AV_NOPTS_VALUE if unknown.
1091 * This field is not the display duration of the current packet.
1092 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1095 * The purpose of this field is to allow seeking in streams that have no
1096 * keyframes in the conventional sense. It corresponds to the
1097 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1098 * essential for some types of subtitle streams to ensure that all
1099 * subtitles are correctly displayed after seeking.
1101 int64_t convergence_duration;
1103 #define AV_PKT_FLAG_KEY 0x0001
1104 #if LIBAVCODEC_VERSION_MAJOR < 53
1105 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1109 * Audio Video Frame.
1110 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1112 * Removal, reordering and changes to existing fields require a major
1113 * version bump. No fields should be added into AVFrame before or after
1115 * sizeof(AVFrame) must not be used outside libav*.
1117 typedef struct AVFrame {
1122 * main external API structure.
1123 * New fields can be added to the end with minor version bumps.
1124 * Removal, reordering and changes to existing fields require a major
1126 * sizeof(AVCodecContext) must not be used outside libav*.
1128 typedef struct AVCodecContext {
1130 * information on struct for av_log
1131 * - set by avcodec_alloc_context
1133 const AVClass *av_class;
1135 * the average bitrate
1136 * - encoding: Set by user; unused for constant quantizer encoding.
1137 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1142 * number of bits the bitstream is allowed to diverge from the reference.
1143 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1144 * - encoding: Set by user; unused for constant quantizer encoding.
1145 * - decoding: unused
1147 int bit_rate_tolerance;
1151 * - encoding: Set by user.
1152 * - decoding: Set by user.
1157 * Some codecs need additional format info. It is stored here.
1158 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1159 * specific codec MUST set it correctly otherwise stream copy breaks.
1160 * In general use of this field by muxers is not recommanded.
1161 * - encoding: Set by libavcodec.
1162 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1167 * Motion estimation algorithm used for video coding.
1168 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1169 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1170 * - encoding: MUST be set by user.
1171 * - decoding: unused
1176 * some codecs need / can use extradata like Huffman tables.
1177 * mjpeg: Huffman tables
1178 * rv10: additional flags
1179 * mpeg4: global headers (they can be in the bitstream or here)
1180 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1181 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1182 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1183 * - encoding: Set/allocated/freed by libavcodec.
1184 * - decoding: Set/allocated/freed by user.
1190 * This is the fundamental unit of time (in seconds) in terms
1191 * of which frame timestamps are represented. For fixed-fps content,
1192 * timebase should be 1/framerate and timestamp increments should be
1194 * - encoding: MUST be set by user.
1195 * - decoding: Set by libavcodec.
1197 AVRational time_base;
1201 * picture width / height.
1202 * - encoding: MUST be set by user.
1203 * - decoding: Set by libavcodec.
1204 * Note: For compatibility it is possible to set this instead of
1205 * coded_width/height before decoding.
1209 #define FF_ASPECT_EXTENDED 15
1212 * the number of pictures in a group of pictures, or 0 for intra_only
1213 * - encoding: Set by user.
1214 * - decoding: unused
1219 * Pixel format, see PIX_FMT_xxx.
1220 * May be set by the demuxer if known from headers.
1221 * May be overriden by the decoder if it knows better.
1222 * - encoding: Set by user.
1223 * - decoding: Set by user if known, overridden by libavcodec if known
1225 enum PixelFormat pix_fmt;
1228 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1229 * has to read frames at native frame rate.
1230 * - encoding: Set by user.
1231 * - decoding: unused
1236 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1237 * decoder to draw a horizontal band. It improves cache usage. Not
1238 * all codecs can do that. You must check the codec capabilities
1240 * The function is also used by hardware acceleration APIs.
1241 * It is called at least once during frame decoding to pass
1242 * the data needed for hardware render.
1243 * In that mode instead of pixel data, AVFrame points to
1244 * a structure specific to the acceleration API. The application
1245 * reads the structure and can change some fields to indicate progress
1247 * - encoding: unused
1248 * - decoding: Set by user.
1249 * @param height the height of the slice
1250 * @param y the y position of the slice
1251 * @param type 1->top field, 2->bottom field, 3->frame
1252 * @param offset offset into the AVFrame.data from which the slice should be read
1254 void (*draw_horiz_band)(struct AVCodecContext *s,
1255 const AVFrame *src, int offset[4],
1256 int y, int type, int height);
1259 int sample_rate; ///< samples per second
1260 int channels; ///< number of audio channels
1263 * audio sample format
1264 * - encoding: Set by user.
1265 * - decoding: Set by libavcodec.
1267 enum AVSampleFormat sample_fmt; ///< sample format
1269 /* The following data should not be initialized. */
1271 * Samples per packet, initialized when calling 'init'.
1274 int frame_number; ///< audio or video frame number
1275 #if LIBAVCODEC_VERSION_MAJOR < 53
1276 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1280 * Number of frames the decoded output will be delayed relative to
1281 * the encoded input.
1282 * - encoding: Set by libavcodec.
1283 * - decoding: unused
1287 /* - encoding parameters */
1288 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1289 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1293 * - encoding: Set by user.
1294 * - decoding: unused
1300 * - encoding: Set by user.
1301 * - decoding: unused
1306 * maximum quantizer difference between frames
1307 * - encoding: Set by user.
1308 * - decoding: unused
1313 * maximum number of B-frames between non-B-frames
1314 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1315 * - encoding: Set by user.
1316 * - decoding: unused
1321 * qscale factor between IP and B-frames
1322 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1323 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1324 * - encoding: Set by user.
1325 * - decoding: unused
1327 float b_quant_factor;
1329 /** obsolete FIXME remove */
1331 #define FF_RC_STRATEGY_XVID 1
1333 int b_frame_strategy;
1337 * - encoding: unused
1338 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1339 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1343 struct AVCodec *codec;
1347 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1348 /* do its best to deliver a chunk with size */
1349 /* below rtp_payload_size, the chunk will start */
1350 /* with a start code on some codecs like H.263. */
1351 /* This doesn't take account of any particular */
1352 /* headers inside the transmitted RTP payload. */
1355 /* The RTP callback: This function is called */
1356 /* every time the encoder has a packet to send. */
1357 /* It depends on the encoder if the data starts */
1358 /* with a Start Code (it should). H.263 does. */
1359 /* mb_nb contains the number of macroblocks */
1360 /* encoded in the RTP payload. */
1361 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1363 /* statistics, used for 2-pass encoding */
1374 * number of bits used for the previously encoded frame
1375 * - encoding: Set by libavcodec.
1376 * - decoding: unused
1381 * Private data of the user, can be used to carry app specific stuff.
1382 * - encoding: Set by user.
1383 * - decoding: Set by user.
1387 char codec_name[32];
1388 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1389 enum CodecID codec_id; /* see CODEC_ID_xxx */
1392 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1393 * This is used to work around some encoder bugs.
1394 * A demuxer should set this to what is stored in the field used to identify the codec.
1395 * If there are multiple such fields in a container then the demuxer should choose the one
1396 * which maximizes the information about the used codec.
1397 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1398 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1399 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1401 * - encoding: Set by user, if not then the default based on codec_id will be used.
1402 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1404 unsigned int codec_tag;
1407 * Work around bugs in encoders which sometimes cannot be detected automatically.
1408 * - encoding: Set by user
1409 * - decoding: Set by user
1411 int workaround_bugs;
1412 #define FF_BUG_AUTODETECT 1 ///< autodetection
1413 #define FF_BUG_OLD_MSMPEG4 2
1414 #define FF_BUG_XVID_ILACE 4
1415 #define FF_BUG_UMP4 8
1416 #define FF_BUG_NO_PADDING 16
1417 #define FF_BUG_AMV 32
1418 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1419 #define FF_BUG_QPEL_CHROMA 64
1420 #define FF_BUG_STD_QPEL 128
1421 #define FF_BUG_QPEL_CHROMA2 256
1422 #define FF_BUG_DIRECT_BLOCKSIZE 512
1423 #define FF_BUG_EDGE 1024
1424 #define FF_BUG_HPEL_CHROMA 2048
1425 #define FF_BUG_DC_CLIP 4096
1426 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1427 #define FF_BUG_TRUNCATED 16384
1428 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1431 * luma single coefficient elimination threshold
1432 * - encoding: Set by user.
1433 * - decoding: unused
1435 int luma_elim_threshold;
1438 * chroma single coeff elimination threshold
1439 * - encoding: Set by user.
1440 * - decoding: unused
1442 int chroma_elim_threshold;
1445 * strictly follow the standard (MPEG4, ...).
1446 * - encoding: Set by user.
1447 * - decoding: Set by user.
1448 * Setting this to STRICT or higher means the encoder and decoder will
1449 * generally do stupid things, whereas setting it to unofficial or lower
1450 * will mean the encoder might produce output that is not supported by all
1451 * spec-compliant decoders. Decoders don't differentiate between normal,
1452 * unofficial and experimental (that is, they always try to decode things
1453 * when they can) unless they are explicitly asked to behave stupidly
1454 * (=strictly conform to the specs)
1456 int strict_std_compliance;
1457 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1458 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1459 #define FF_COMPLIANCE_NORMAL 0
1460 #if FF_API_INOFFICIAL
1461 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1463 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1464 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1467 * qscale offset between IP and B-frames
1468 * - encoding: Set by user.
1469 * - decoding: unused
1471 float b_quant_offset;
1474 * Error recognization; higher values will detect more errors but may
1475 * misdetect some more or less valid parts as errors.
1476 * - encoding: unused
1477 * - decoding: Set by user.
1479 int error_recognition;
1480 #define FF_ER_CAREFUL 1
1481 #define FF_ER_COMPLIANT 2
1482 #define FF_ER_AGGRESSIVE 3
1483 #define FF_ER_VERY_AGGRESSIVE 4
1486 * Called at the beginning of each frame to get a buffer for it.
1487 * If pic.reference is set then the frame will be read later by libavcodec.
1488 * avcodec_align_dimensions2() should be used to find the required width and
1489 * height, as they normally need to be rounded up to the next multiple of 16.
1490 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1491 * avcodec_default_get_buffer() instead of providing buffers allocated by
1493 * - encoding: unused
1494 * - decoding: Set by libavcodec, user can override.
1496 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1499 * Called to release buffers which were allocated with get_buffer.
1500 * A released buffer can be reused in get_buffer().
1501 * pic.data[*] must be set to NULL.
1502 * - encoding: unused
1503 * - decoding: Set by libavcodec, user can override.
1505 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1508 * Size of the frame reordering buffer in the decoder.
1509 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1510 * - encoding: Set by libavcodec.
1511 * - decoding: Set by libavcodec.
1516 * number of bytes per packet if constant and known or 0
1517 * Used by some WAV based audio codecs.
1521 int parse_only; /* - decoding only: If true, only parsing is done
1522 (function avcodec_parse_frame()). The frame
1523 data is returned. Only MPEG codecs support this now. */
1526 * 0-> h263 quant 1-> mpeg quant
1527 * - encoding: Set by user.
1528 * - decoding: unused
1533 * pass1 encoding statistics output buffer
1534 * - encoding: Set by libavcodec.
1535 * - decoding: unused
1540 * pass2 encoding statistics input buffer
1541 * Concatenated stuff from stats_out of pass1 should be placed here.
1542 * - encoding: Allocated/set/freed by user.
1543 * - decoding: unused
1548 * ratecontrol qmin qmax limiting method
1549 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1550 * - encoding: Set by user.
1551 * - decoding: unused
1559 * ratecontrol override, see RcOverride
1560 * - encoding: Allocated/set/freed by user.
1561 * - decoding: unused
1563 RcOverride *rc_override;
1564 int rc_override_count;
1567 * rate control equation
1568 * - encoding: Set by user
1569 * - decoding: unused
1575 * - encoding: Set by user.
1576 * - decoding: unused
1582 * - encoding: Set by user.
1583 * - decoding: unused
1588 * decoder bitstream buffer size
1589 * - encoding: Set by user.
1590 * - decoding: unused
1593 float rc_buffer_aggressivity;
1596 * qscale factor between P and I-frames
1597 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1598 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1599 * - encoding: Set by user.
1600 * - decoding: unused
1602 float i_quant_factor;
1605 * qscale offset between P and I-frames
1606 * - encoding: Set by user.
1607 * - decoding: unused
1609 float i_quant_offset;
1612 * initial complexity for pass1 ratecontrol
1613 * - encoding: Set by user.
1614 * - decoding: unused
1616 float rc_initial_cplx;
1619 * DCT algorithm, see FF_DCT_* below
1620 * - encoding: Set by user.
1621 * - decoding: unused
1624 #define FF_DCT_AUTO 0
1625 #define FF_DCT_FASTINT 1
1626 #define FF_DCT_INT 2
1627 #define FF_DCT_MMX 3
1628 #define FF_DCT_MLIB 4
1629 #define FF_DCT_ALTIVEC 5
1630 #define FF_DCT_FAAN 6
1633 * luminance masking (0-> disabled)
1634 * - encoding: Set by user.
1635 * - decoding: unused
1640 * temporary complexity masking (0-> disabled)
1641 * - encoding: Set by user.
1642 * - decoding: unused
1644 float temporal_cplx_masking;
1647 * spatial complexity masking (0-> disabled)
1648 * - encoding: Set by user.
1649 * - decoding: unused
1651 float spatial_cplx_masking;
1654 * p block masking (0-> disabled)
1655 * - encoding: Set by user.
1656 * - decoding: unused
1661 * darkness masking (0-> disabled)
1662 * - encoding: Set by user.
1663 * - decoding: unused
1668 * IDCT algorithm, see FF_IDCT_* below.
1669 * - encoding: Set by user.
1670 * - decoding: Set by user.
1673 #define FF_IDCT_AUTO 0
1674 #define FF_IDCT_INT 1
1675 #define FF_IDCT_SIMPLE 2
1676 #define FF_IDCT_SIMPLEMMX 3
1677 #define FF_IDCT_LIBMPEG2MMX 4
1678 #define FF_IDCT_PS2 5
1679 #define FF_IDCT_MLIB 6
1680 #define FF_IDCT_ARM 7
1681 #define FF_IDCT_ALTIVEC 8
1682 #define FF_IDCT_SH4 9
1683 #define FF_IDCT_SIMPLEARM 10
1684 #define FF_IDCT_H264 11
1685 #define FF_IDCT_VP3 12
1686 #define FF_IDCT_IPP 13
1687 #define FF_IDCT_XVIDMMX 14
1688 #define FF_IDCT_CAVS 15
1689 #define FF_IDCT_SIMPLEARMV5TE 16
1690 #define FF_IDCT_SIMPLEARMV6 17
1691 #define FF_IDCT_SIMPLEVIS 18
1692 #define FF_IDCT_WMV2 19
1693 #define FF_IDCT_FAAN 20
1694 #define FF_IDCT_EA 21
1695 #define FF_IDCT_SIMPLENEON 22
1696 #define FF_IDCT_SIMPLEALPHA 23
1697 #define FF_IDCT_BINK 24
1701 * - encoding: Set by libavcodec.
1702 * - decoding: Set by user (or 0).
1706 * slice offsets in the frame in bytes
1707 * - encoding: Set/allocated by libavcodec.
1708 * - decoding: Set/allocated by user (or NULL).
1713 * error concealment flags
1714 * - encoding: unused
1715 * - decoding: Set by user.
1717 int error_concealment;
1718 #define FF_EC_GUESS_MVS 1
1719 #define FF_EC_DEBLOCK 2
1722 * dsp_mask could be add used to disable unwanted CPU features
1723 * CPU features (i.e. MMX, SSE. ...)
1725 * With the FORCE flag you may instead enable given CPU features.
1726 * (Dangerous: Usable in case of misdetection, improper usage however will
1727 * result into program crash.)
1732 #define FF_MM_FORCE AV_CPU_FLAG_FORCE
1733 #define FF_MM_MMX AV_CPU_FLAG_MMX
1734 #define FF_MM_3DNOW AV_CPU_FLAG_3DNOW
1735 #define FF_MM_MMXEXT AV_CPU_FLAG_MMX2
1736 #define FF_MM_MMX2 AV_CPU_FLAG_MMX2
1737 #define FF_MM_SSE AV_CPU_FLAG_SSE
1738 #define FF_MM_SSE2 AV_CPU_FLAG_SSE2
1739 #define FF_MM_SSE2SLOW AV_CPU_FLAG_SSE2SLOW
1740 #define FF_MM_3DNOWEXT AV_CPU_FLAG_3DNOWEXT
1741 #define FF_MM_SSE3 AV_CPU_FLAG_SSE3
1742 #define FF_MM_SSE3SLOW AV_CPU_FLAG_SSE3SLOW
1743 #define FF_MM_SSSE3 AV_CPU_FLAG_SSSE3
1744 #define FF_MM_SSE4 AV_CPU_FLAG_SSE4
1745 #define FF_MM_SSE42 AV_CPU_FLAG_SSE42
1746 #define FF_MM_IWMMXT AV_CPU_FLAG_IWMMXT
1747 #define FF_MM_ALTIVEC AV_CPU_FLAG_ALTIVEC
1751 * bits per sample/pixel from the demuxer (needed for huffyuv).
1752 * - encoding: Set by libavcodec.
1753 * - decoding: Set by user.
1755 int bits_per_coded_sample;
1758 * prediction method (needed for huffyuv)
1759 * - encoding: Set by user.
1760 * - decoding: unused
1762 int prediction_method;
1763 #define FF_PRED_LEFT 0
1764 #define FF_PRED_PLANE 1
1765 #define FF_PRED_MEDIAN 2
1768 * sample aspect ratio (0 if unknown)
1769 * That is the width of a pixel divided by the height of the pixel.
1770 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1771 * - encoding: Set by user.
1772 * - decoding: Set by libavcodec.
1774 AVRational sample_aspect_ratio;
1777 * the picture in the bitstream
1778 * - encoding: Set by libavcodec.
1779 * - decoding: Set by libavcodec.
1781 AVFrame *coded_frame;
1785 * - encoding: Set by user.
1786 * - decoding: Set by user.
1789 #define FF_DEBUG_PICT_INFO 1
1790 #define FF_DEBUG_RC 2
1791 #define FF_DEBUG_BITSTREAM 4
1792 #define FF_DEBUG_MB_TYPE 8
1793 #define FF_DEBUG_QP 16
1794 #define FF_DEBUG_MV 32
1795 #define FF_DEBUG_DCT_COEFF 0x00000040
1796 #define FF_DEBUG_SKIP 0x00000080
1797 #define FF_DEBUG_STARTCODE 0x00000100
1798 #define FF_DEBUG_PTS 0x00000200
1799 #define FF_DEBUG_ER 0x00000400
1800 #define FF_DEBUG_MMCO 0x00000800
1801 #define FF_DEBUG_BUGS 0x00001000
1802 #define FF_DEBUG_VIS_QP 0x00002000
1803 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1804 #define FF_DEBUG_BUFFERS 0x00008000
1808 * - encoding: Set by user.
1809 * - decoding: Set by user.
1812 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1813 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1814 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1818 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1819 * - decoding: unused
1824 * minimum MB quantizer
1825 * - encoding: unused
1826 * - decoding: unused
1831 * maximum MB quantizer
1832 * - encoding: unused
1833 * - decoding: unused
1838 * motion estimation comparison function
1839 * - encoding: Set by user.
1840 * - decoding: unused
1844 * subpixel motion estimation comparison function
1845 * - encoding: Set by user.
1846 * - decoding: unused
1850 * macroblock comparison function (not supported yet)
1851 * - encoding: Set by user.
1852 * - decoding: unused
1856 * interlaced DCT comparison function
1857 * - encoding: Set by user.
1858 * - decoding: unused
1861 #define FF_CMP_SAD 0
1862 #define FF_CMP_SSE 1
1863 #define FF_CMP_SATD 2
1864 #define FF_CMP_DCT 3
1865 #define FF_CMP_PSNR 4
1866 #define FF_CMP_BIT 5
1868 #define FF_CMP_ZERO 7
1869 #define FF_CMP_VSAD 8
1870 #define FF_CMP_VSSE 9
1871 #define FF_CMP_NSSE 10
1872 #define FF_CMP_W53 11
1873 #define FF_CMP_W97 12
1874 #define FF_CMP_DCTMAX 13
1875 #define FF_CMP_DCT264 14
1876 #define FF_CMP_CHROMA 256
1879 * ME diamond size & shape
1880 * - encoding: Set by user.
1881 * - decoding: unused
1886 * amount of previous MV predictors (2a+1 x 2a+1 square)
1887 * - encoding: Set by user.
1888 * - decoding: unused
1890 int last_predictor_count;
1893 * prepass for motion estimation
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * motion estimation prepass comparison function
1901 * - encoding: Set by user.
1902 * - decoding: unused
1907 * ME prepass diamond size & shape
1908 * - encoding: Set by user.
1909 * - decoding: unused
1915 * - encoding: Set by user.
1916 * - decoding: unused
1918 int me_subpel_quality;
1921 * callback to negotiate the pixelFormat
1922 * @param fmt is the list of formats which are supported by the codec,
1923 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1924 * The first is always the native one.
1925 * @return the chosen format
1926 * - encoding: unused
1927 * - decoding: Set by user, if not set the native format will be chosen.
1929 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1932 * DTG active format information (additional aspect ratio
1933 * information only used in DVB MPEG-2 transport streams)
1936 * - encoding: unused
1937 * - decoding: Set by decoder.
1939 int dtg_active_format;
1940 #define FF_DTG_AFD_SAME 8
1941 #define FF_DTG_AFD_4_3 9
1942 #define FF_DTG_AFD_16_9 10
1943 #define FF_DTG_AFD_14_9 11
1944 #define FF_DTG_AFD_4_3_SP_14_9 13
1945 #define FF_DTG_AFD_16_9_SP_14_9 14
1946 #define FF_DTG_AFD_SP_4_3 15
1949 * maximum motion estimation search range in subpel units
1950 * If 0 then no limit.
1952 * - encoding: Set by user.
1953 * - decoding: unused
1958 * intra quantizer bias
1959 * - encoding: Set by user.
1960 * - decoding: unused
1962 int intra_quant_bias;
1963 #define FF_DEFAULT_QUANT_BIAS 999999
1966 * inter quantizer bias
1967 * - encoding: Set by user.
1968 * - decoding: unused
1970 int inter_quant_bias;
1974 * - encoding: unused
1975 * - decoding: Which clrtable should be used for 8bit RGB images.
1976 * Tables have to be stored somewhere. FIXME
1981 * internal_buffer count
1982 * Don't touch, used by libavcodec default_get_buffer().
1984 int internal_buffer_count;
1988 * Don't touch, used by libavcodec default_get_buffer().
1990 void *internal_buffer;
1993 * Global quality for codecs which cannot change it per frame.
1994 * This should be proportional to MPEG-1/2/4 qscale.
1995 * - encoding: Set by user.
1996 * - decoding: unused
2000 #define FF_CODER_TYPE_VLC 0
2001 #define FF_CODER_TYPE_AC 1
2002 #define FF_CODER_TYPE_RAW 2
2003 #define FF_CODER_TYPE_RLE 3
2004 #define FF_CODER_TYPE_DEFLATE 4
2007 * - encoding: Set by user.
2008 * - decoding: unused
2014 * - encoding: Set by user.
2015 * - decoding: unused
2021 * - encoding: unused
2022 * - decoding: Set by user.
2024 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2029 * - encoding: unused
2030 * - decoding: Set by user.
2033 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2034 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2035 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2038 * XVideo Motion Acceleration
2039 * - encoding: forbidden
2040 * - decoding: set by decoder
2042 int xvmc_acceleration;
2045 * macroblock decision mode
2046 * - encoding: Set by user.
2047 * - decoding: unused
2050 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2051 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2052 #define FF_MB_DECISION_RD 2 ///< rate distortion
2055 * custom intra quantization matrix
2056 * - encoding: Set by user, can be NULL.
2057 * - decoding: Set by libavcodec.
2059 uint16_t *intra_matrix;
2062 * custom inter quantization matrix
2063 * - encoding: Set by user, can be NULL.
2064 * - decoding: Set by libavcodec.
2066 uint16_t *inter_matrix;
2069 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2070 * This is used to work around some encoder bugs.
2071 * - encoding: unused
2072 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2074 unsigned int stream_codec_tag;
2077 * scene change detection threshold
2078 * 0 is default, larger means fewer detected scene changes.
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 int scenechange_threshold;
2085 * minimum Lagrange multipler
2086 * - encoding: Set by user.
2087 * - decoding: unused
2092 * maximum Lagrange multipler
2093 * - encoding: Set by user.
2094 * - decoding: unused
2098 #if FF_API_PALETTE_CONTROL
2100 * palette control structure
2101 * - encoding: ??? (no palette-enabled encoder yet)
2102 * - decoding: Set by user.
2104 struct AVPaletteControl *palctrl;
2108 * noise reduction strength
2109 * - encoding: Set by user.
2110 * - decoding: unused
2112 int noise_reduction;
2115 * Called at the beginning of a frame to get cr buffer for it.
2116 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2117 * libavcodec will pass previous buffer in pic, function should return
2118 * same buffer or new buffer with old frame "painted" into it.
2119 * If pic.data[0] == NULL must behave like get_buffer().
2120 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2121 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2123 * - encoding: unused
2124 * - decoding: Set by libavcodec, user can override.
2126 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2129 * Number of bits which should be loaded into the rc buffer before decoding starts.
2130 * - encoding: Set by user.
2131 * - decoding: unused
2133 int rc_initial_buffer_occupancy;
2137 * - encoding: Set by user.
2138 * - decoding: unused
2140 int inter_threshold;
2144 * - encoding: Set by user.
2145 * - decoding: Set by user.
2150 * Simulates errors in the bitstream to test error concealment.
2151 * - encoding: Set by user.
2152 * - decoding: unused
2157 * MP3 antialias algorithm, see FF_AA_* below.
2158 * - encoding: unused
2159 * - decoding: Set by user.
2162 #define FF_AA_AUTO 0
2163 #define FF_AA_FASTINT 1 //not implemented yet
2165 #define FF_AA_FLOAT 3
2167 * quantizer noise shaping
2168 * - encoding: Set by user.
2169 * - decoding: unused
2171 int quantizer_noise_shaping;
2175 * is used to decide how many independent tasks should be passed to execute()
2176 * - encoding: Set by user.
2177 * - decoding: Set by user.
2182 * The codec may call this to execute several independent things.
2183 * It will return only after finishing all tasks.
2184 * The user may replace this with some multithreaded implementation,
2185 * the default implementation will execute the parts serially.
2186 * @param count the number of things to execute
2187 * - encoding: Set by libavcodec, user can override.
2188 * - decoding: Set by libavcodec, user can override.
2190 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2194 * Can be used by execute() to store some per AVCodecContext stuff.
2195 * - encoding: set by execute()
2196 * - decoding: set by execute()
2198 void *thread_opaque;
2201 * Motion estimation threshold below which no motion estimation is
2202 * performed, but instead the user specified motion vectors are used.
2204 * - encoding: Set by user.
2205 * - decoding: unused
2210 * Macroblock threshold below which the user specified macroblock types will be used.
2211 * - encoding: Set by user.
2212 * - decoding: unused
2217 * precision of the intra DC coefficient - 8
2218 * - encoding: Set by user.
2219 * - decoding: unused
2221 int intra_dc_precision;
2224 * noise vs. sse weight for the nsse comparsion function
2225 * - encoding: Set by user.
2226 * - decoding: unused
2231 * Number of macroblock rows at the top which are skipped.
2232 * - encoding: unused
2233 * - decoding: Set by user.
2238 * Number of macroblock rows at the bottom which are skipped.
2239 * - encoding: unused
2240 * - decoding: Set by user.
2246 * - encoding: Set by user.
2247 * - decoding: Set by libavcodec.
2250 #define FF_PROFILE_UNKNOWN -99
2252 #define FF_PROFILE_AAC_MAIN 0
2253 #define FF_PROFILE_AAC_LOW 1
2254 #define FF_PROFILE_AAC_SSR 2
2255 #define FF_PROFILE_AAC_LTP 3
2257 #define FF_PROFILE_DTS 20
2258 #define FF_PROFILE_DTS_ES 30
2259 #define FF_PROFILE_DTS_96_24 40
2260 #define FF_PROFILE_DTS_HD_HRA 50
2261 #define FF_PROFILE_DTS_HD_MA 60
2263 #define FF_PROFILE_H264_BASELINE 66
2264 #define FF_PROFILE_H264_MAIN 77
2265 #define FF_PROFILE_H264_EXTENDED 88
2266 #define FF_PROFILE_H264_HIGH 100
2267 #define FF_PROFILE_H264_HIGH_10 110
2268 #define FF_PROFILE_H264_HIGH_422 122
2269 #define FF_PROFILE_H264_HIGH_444 244
2270 #define FF_PROFILE_H264_CAVLC_444 44
2274 * - encoding: Set by user.
2275 * - decoding: Set by libavcodec.
2278 #define FF_LEVEL_UNKNOWN -99
2281 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2282 * - encoding: unused
2283 * - decoding: Set by user.
2288 * Bitstream width / height, may be different from width/height if lowres
2289 * or other things are used.
2290 * - encoding: unused
2291 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2293 int coded_width, coded_height;
2296 * frame skip threshold
2297 * - encoding: Set by user.
2298 * - decoding: unused
2300 int frame_skip_threshold;
2304 * - encoding: Set by user.
2305 * - decoding: unused
2307 int frame_skip_factor;
2310 * frame skip exponent
2311 * - encoding: Set by user.
2312 * - decoding: unused
2317 * frame skip comparison function
2318 * - encoding: Set by user.
2319 * - decoding: unused
2324 * Border processing masking, raises the quantizer for mbs on the borders
2326 * - encoding: Set by user.
2327 * - decoding: unused
2329 float border_masking;
2332 * minimum MB lagrange multipler
2333 * - encoding: Set by user.
2334 * - decoding: unused
2339 * maximum MB lagrange multipler
2340 * - encoding: Set by user.
2341 * - decoding: unused
2347 * - encoding: Set by user.
2348 * - decoding: unused
2350 int me_penalty_compensation;
2354 * - encoding: unused
2355 * - decoding: Set by user.
2357 enum AVDiscard skip_loop_filter;
2361 * - encoding: unused
2362 * - decoding: Set by user.
2364 enum AVDiscard skip_idct;
2368 * - encoding: unused
2369 * - decoding: Set by user.
2371 enum AVDiscard skip_frame;
2375 * - encoding: Set by user.
2376 * - decoding: unused
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * constant rate factor - quality-based VBR - values ~correspond to qps
2389 * - encoding: Set by user.
2390 * - decoding: unused
2395 * constant quantization parameter rate control method
2396 * - encoding: Set by user.
2397 * - decoding: unused
2403 * - encoding: Set by user.
2404 * - decoding: unused
2409 * number of reference frames
2410 * - encoding: Set by user.
2411 * - decoding: Set by lavc.
2416 * chroma qp offset from luma
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * Influences how often B-frames are used.
2424 * - encoding: Set by user.
2425 * - decoding: unused
2430 * trellis RD quantization
2431 * - encoding: Set by user.
2432 * - decoding: unused
2437 * Reduce fluctuations in qp (before curve compression).
2438 * - encoding: Set by user.
2439 * - decoding: unused
2441 float complexityblur;
2444 * in-loop deblocking filter alphac0 parameter
2445 * alpha is in the range -6...6
2446 * - encoding: Set by user.
2447 * - decoding: unused
2452 * in-loop deblocking filter beta parameter
2453 * beta is in the range -6...6
2454 * - encoding: Set by user.
2455 * - decoding: unused
2460 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2461 * - encoding: Set by user.
2462 * - decoding: unused
2465 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2466 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2467 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2468 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2469 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2472 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2473 * - encoding: Set by user.
2474 * - decoding: unused
2479 * Audio cutoff bandwidth (0 means "automatic")
2480 * - encoding: Set by user.
2481 * - decoding: unused
2486 * Multiplied by qscale for each frame and added to scene_change_score.
2487 * - encoding: Set by user.
2488 * - decoding: unused
2490 int scenechange_factor;
2494 * Note: Value depends upon the compare function used for fullpel ME.
2495 * - encoding: Set by user.
2496 * - decoding: unused
2501 * Adjusts sensitivity of b_frame_strategy 1.
2502 * - encoding: Set by user.
2503 * - decoding: unused
2508 * - encoding: Set by user.
2509 * - decoding: unused
2511 int compression_level;
2512 #define FF_COMPRESSION_DEFAULT -1
2516 * Sets whether to use LPC mode - used by FLAC encoder.
2517 * - encoding: Set by user.
2518 * - decoding: unused
2519 * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2525 * LPC coefficient precision - used by FLAC encoder
2526 * - encoding: Set by user.
2527 * - decoding: unused
2529 int lpc_coeff_precision;
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 int min_prediction_order;
2538 * - encoding: Set by user.
2539 * - decoding: unused
2541 int max_prediction_order;
2544 * search method for selecting prediction order
2545 * - encoding: Set by user.
2546 * - decoding: unused
2548 int prediction_order_method;
2551 * - encoding: Set by user.
2552 * - decoding: unused
2554 int min_partition_order;
2557 * - encoding: Set by user.
2558 * - decoding: unused
2560 int max_partition_order;
2563 * GOP timecode frame start number, in non drop frame format
2564 * - encoding: Set by user.
2565 * - decoding: unused
2567 int64_t timecode_frame_start;
2569 #if LIBAVCODEC_VERSION_MAJOR < 53
2571 * Decoder should decode to this many channels if it can (0 for default)
2572 * - encoding: unused
2573 * - decoding: Set by user.
2574 * @deprecated Deprecated in favor of request_channel_layout.
2576 int request_channels;
2580 * Percentage of dynamic range compression to be applied by the decoder.
2581 * The default value is 1.0, corresponding to full compression.
2582 * - encoding: unused
2583 * - decoding: Set by user.
2588 * opaque 64bit number (generally a PTS) that will be reordered and
2589 * output in AVFrame.reordered_opaque
2590 * @deprecated in favor of pkt_pts
2591 * - encoding: unused
2592 * - decoding: Set by user.
2594 int64_t reordered_opaque;
2597 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2598 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2599 * - encoding: set by user.
2600 * - decoding: set by libavcodec.
2602 int bits_per_raw_sample;
2605 * Audio channel layout.
2606 * - encoding: set by user.
2607 * - decoding: set by libavcodec.
2609 int64_t channel_layout;
2612 * Request decoder to use this channel layout if it can (0 for default)
2613 * - encoding: unused
2614 * - decoding: Set by user.
2616 int64_t request_channel_layout;
2619 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2620 * - encoding: Set by user.
2621 * - decoding: unused.
2623 float rc_max_available_vbv_use;
2626 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2627 * - encoding: Set by user.
2628 * - decoding: unused.
2630 float rc_min_vbv_overflow_use;
2633 * Hardware accelerator in use
2634 * - encoding: unused.
2635 * - decoding: Set by libavcodec
2637 struct AVHWAccel *hwaccel;
2640 * For some codecs, the time base is closer to the field rate than the frame rate.
2641 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2642 * if no telecine is used ...
2644 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2646 int ticks_per_frame;
2649 * Hardware accelerator context.
2650 * For some hardware accelerators, a global context needs to be
2651 * provided by the user. In that case, this holds display-dependent
2652 * data FFmpeg cannot instantiate itself. Please refer to the
2653 * FFmpeg HW accelerator documentation to know how to fill this
2654 * is. e.g. for VA API, this is a struct vaapi_context.
2655 * - encoding: unused
2656 * - decoding: Set by user
2658 void *hwaccel_context;
2661 * Chromaticity coordinates of the source primaries.
2662 * - encoding: Set by user
2663 * - decoding: Set by libavcodec
2665 enum AVColorPrimaries color_primaries;
2668 * Color Transfer Characteristic.
2669 * - encoding: Set by user
2670 * - decoding: Set by libavcodec
2672 enum AVColorTransferCharacteristic color_trc;
2675 * YUV colorspace type.
2676 * - encoding: Set by user
2677 * - decoding: Set by libavcodec
2679 enum AVColorSpace colorspace;
2682 * MPEG vs JPEG YUV range.
2683 * - encoding: Set by user
2684 * - decoding: Set by libavcodec
2686 enum AVColorRange color_range;
2689 * This defines the location of chroma samples.
2690 * - encoding: Set by user
2691 * - decoding: Set by libavcodec
2693 enum AVChromaLocation chroma_sample_location;
2696 * The codec may call this to execute several independent things.
2697 * It will return only after finishing all tasks.
2698 * The user may replace this with some multithreaded implementation,
2699 * the default implementation will execute the parts serially.
2700 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2701 * @param c context passed also to func
2702 * @param count the number of things to execute
2703 * @param arg2 argument passed unchanged to func
2704 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2705 * @param func function that will be called count times, with jobnr from 0 to count-1.
2706 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2707 * two instances of func executing at the same time will have the same threadnr.
2708 * @return always 0 currently, but code should handle a future improvement where when any call to func
2709 * returns < 0 no further calls to func may be done and < 0 is returned.
2710 * - encoding: Set by libavcodec, user can override.
2711 * - decoding: Set by libavcodec, user can override.
2713 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2716 * explicit P-frame weighted prediction analysis method
2718 * 1: fast blind weighting (one reference duplicate with -1 offset)
2719 * 2: smart weighting (full fade detection analysis)
2720 * - encoding: Set by user.
2721 * - decoding: unused
2723 int weighted_p_pred;
2728 * 1: Variance AQ (complexity mask)
2729 * 2: Auto-variance AQ (experimental)
2730 * - encoding: Set by user
2731 * - decoding: unused
2737 * Reduces blocking and blurring in flat and textured areas.
2738 * - encoding: Set by user
2739 * - decoding: unused
2745 * Strength of psychovisual optimization
2746 * - encoding: Set by user
2747 * - decoding: unused
2753 * Strength of psychovisual optimization
2754 * - encoding: Set by user
2755 * - decoding: unused
2761 * Number of frames for frametype and ratecontrol lookahead
2762 * - encoding: Set by user
2763 * - decoding: unused
2768 * Constant rate factor maximum
2769 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2770 * than crf_max, even if doing so would violate VBV restrictions.
2771 * - encoding: Set by user.
2772 * - decoding: unused
2776 int log_level_offset;
2779 * Determines which LPC analysis algorithm to use.
2780 * - encoding: Set by user
2781 * - decoding: unused
2783 enum AVLPCType lpc_type;
2786 * Number of passes to use for Cholesky factorization during LPC analysis
2787 * - encoding: Set by user
2788 * - decoding: unused
2794 * Indicates number of picture subdivisions. Used for parallelized
2796 * - encoding: Set by user
2797 * - decoding: unused
2802 * Header containing style information for text subtitles.
2803 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2804 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2805 * the Format line following. It shouldn't include any Dialogue line.
2806 * - encoding: Set/allocated/freed by user (before avcodec_open())
2807 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2809 uint8_t *subtitle_header;
2810 int subtitle_header_size;
2813 * Current packet as passed into the decoder, to avoid having
2814 * to pass the packet into every function. Currently only valid
2815 * inside lavc and get/release_buffer callbacks.
2816 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2817 * - encoding: unused
2825 typedef struct AVProfile {
2827 const char *name; ///< short name for the profile
2833 typedef struct AVCodec {
2835 * Name of the codec implementation.
2836 * The name is globally unique among encoders and among decoders (but an
2837 * encoder and a decoder can share the same name).
2838 * This is the primary way to find a codec from the user perspective.
2841 enum AVMediaType type;
2844 int (*init)(AVCodecContext *);
2845 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2846 int (*close)(AVCodecContext *);
2847 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2849 * Codec capabilities.
2853 struct AVCodec *next;
2856 * Will be called when seeking
2858 void (*flush)(AVCodecContext *);
2859 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2860 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2862 * Descriptive name for the codec, meant to be more human readable than name.
2863 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2865 const char *long_name;
2866 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2867 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2868 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2869 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2870 AVClass *priv_class; ///< AVClass for the private context
2871 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2877 typedef struct AVHWAccel {
2879 * Name of the hardware accelerated codec.
2880 * The name is globally unique among encoders and among decoders (but an
2881 * encoder and a decoder can share the same name).
2886 * Type of codec implemented by the hardware accelerator.
2888 * See AVMEDIA_TYPE_xxx
2890 enum AVMediaType type;
2893 * Codec implemented by the hardware accelerator.
2900 * Supported pixel format.
2902 * Only hardware accelerated formats are supported here.
2904 enum PixelFormat pix_fmt;
2907 * Hardware accelerated codec capabilities.
2908 * see FF_HWACCEL_CODEC_CAP_*
2912 struct AVHWAccel *next;
2915 * Called at the beginning of each frame or field picture.
2917 * Meaningful frame information (codec specific) is guaranteed to
2918 * be parsed at this point. This function is mandatory.
2920 * Note that buf can be NULL along with buf_size set to 0.
2921 * Otherwise, this means the whole frame is available at this point.
2923 * @param avctx the codec context
2924 * @param buf the frame data buffer base
2925 * @param buf_size the size of the frame in bytes
2926 * @return zero if successful, a negative value otherwise
2928 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2931 * Callback for each slice.
2933 * Meaningful slice information (codec specific) is guaranteed to
2934 * be parsed at this point. This function is mandatory.
2936 * @param avctx the codec context
2937 * @param buf the slice data buffer base
2938 * @param buf_size the size of the slice in bytes
2939 * @return zero if successful, a negative value otherwise
2941 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2944 * Called at the end of each frame or field picture.
2946 * The whole picture is parsed at this point and can now be sent
2947 * to the hardware accelerator. This function is mandatory.
2949 * @param avctx the codec context
2950 * @return zero if successful, a negative value otherwise
2952 int (*end_frame)(AVCodecContext *avctx);
2955 * Size of HW accelerator private data.
2957 * Private data is allocated with av_mallocz() before
2958 * AVCodecContext.get_buffer() and deallocated after
2959 * AVCodecContext.release_buffer().
2965 * four components are given, that's all.
2966 * the last component is alpha
2968 typedef struct AVPicture {
2970 int linesize[4]; ///< number of bytes per line
2973 #if FF_API_PALETTE_CONTROL
2976 * This structure defines a method for communicating palette changes
2977 * between and demuxer and a decoder.
2979 * @deprecated Use AVPacket to send palette changes instead.
2980 * This is totally broken.
2982 #define AVPALETTE_SIZE 1024
2983 #define AVPALETTE_COUNT 256
2984 typedef struct AVPaletteControl {
2986 /* Demuxer sets this to 1 to indicate the palette has changed;
2987 * decoder resets to 0. */
2988 int palette_changed;
2990 /* 4-byte ARGB palette entries, stored in native byte order; note that
2991 * the individual palette components should be on a 8-bit scale; if
2992 * the palette data comes from an IBM VGA native format, the component
2993 * data is probably 6 bits in size and needs to be scaled. */
2994 unsigned int palette[AVPALETTE_COUNT];
2996 } AVPaletteControl attribute_deprecated;
2999 enum AVSubtitleType {
3002 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3005 * Plain text, the text field must be set by the decoder and is
3006 * authoritative. ass and pict fields may contain approximations.
3011 * Formatted text, the ass field must be set by the decoder and is
3012 * authoritative. pict and text fields may contain approximations.
3017 typedef struct AVSubtitleRect {
3018 int x; ///< top left corner of pict, undefined when pict is not set
3019 int y; ///< top left corner of pict, undefined when pict is not set
3020 int w; ///< width of pict, undefined when pict is not set
3021 int h; ///< height of pict, undefined when pict is not set
3022 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3025 * data+linesize for the bitmap of this subtitle.
3026 * can be set for text/ass as well once they where rendered
3029 enum AVSubtitleType type;
3031 char *text; ///< 0 terminated plain UTF-8 text
3034 * 0 terminated ASS/SSA compatible event line.
3035 * The pressentation of this is unaffected by the other values in this
3041 typedef struct AVSubtitle {
3042 uint16_t format; /* 0 = graphics */
3043 uint32_t start_display_time; /* relative to packet pts, in ms */
3044 uint32_t end_display_time; /* relative to packet pts, in ms */
3046 AVSubtitleRect **rects;
3047 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3050 /* packet functions */
3053 * @deprecated use NULL instead
3055 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3058 * Default packet destructor.
3060 void av_destruct_packet(AVPacket *pkt);
3063 * Initialize optional fields of a packet with default values.
3067 void av_init_packet(AVPacket *pkt);
3070 * Allocate the payload of a packet and initialize its fields with
3074 * @param size wanted payload size
3075 * @return 0 if OK, AVERROR_xxx otherwise
3077 int av_new_packet(AVPacket *pkt, int size);
3080 * Reduce packet size, correctly zeroing padding
3083 * @param size new size
3085 void av_shrink_packet(AVPacket *pkt, int size);
3088 * Increase packet size, correctly zeroing padding
3091 * @param grow_by number of bytes by which to increase the size of the packet
3093 int av_grow_packet(AVPacket *pkt, int grow_by);
3096 * @warning This is a hack - the packet memory allocation stuff is broken. The
3097 * packet is allocated if it was not really allocated.
3099 int av_dup_packet(AVPacket *pkt);
3104 * @param pkt packet to free
3106 void av_free_packet(AVPacket *pkt);
3110 struct ReSampleContext;
3111 struct AVResampleContext;
3113 typedef struct ReSampleContext ReSampleContext;
3115 #if FF_API_AUDIO_OLD
3117 * @deprecated Use av_audio_resample_init() instead.
3119 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3120 int output_rate, int input_rate);
3123 * Initialize audio resampling context
3125 * @param output_channels number of output channels
3126 * @param input_channels number of input channels
3127 * @param output_rate output sample rate
3128 * @param input_rate input sample rate
3129 * @param sample_fmt_out requested output sample format
3130 * @param sample_fmt_in input sample format
3131 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3132 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3133 * @param linear If 1 then the used FIR filter will be linearly interpolated
3134 between the 2 closest, if 0 the closest will be used
3135 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3136 * @return allocated ReSampleContext, NULL if error occured
3138 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3139 int output_rate, int input_rate,
3140 enum AVSampleFormat sample_fmt_out,
3141 enum AVSampleFormat sample_fmt_in,
3142 int filter_length, int log2_phase_count,
3143 int linear, double cutoff);
3145 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3146 void audio_resample_close(ReSampleContext *s);
3150 * Initialize an audio resampler.
3151 * Note, if either rate is not an integer then simply scale both rates up so they are.
3152 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3153 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3154 * @param linear If 1 then the used FIR filter will be linearly interpolated
3155 between the 2 closest, if 0 the closest will be used
3156 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3158 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3161 * Resample an array of samples using a previously configured context.
3162 * @param src an array of unconsumed samples
3163 * @param consumed the number of samples of src which have been consumed are returned here
3164 * @param src_size the number of unconsumed samples available
3165 * @param dst_size the amount of space in samples available in dst
3166 * @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.
3167 * @return the number of samples written in dst or -1 if an error occurred
3169 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3173 * Compensate samplerate/timestamp drift. The compensation is done by changing
3174 * the resampler parameters, so no audible clicks or similar distortions occur
3175 * @param compensation_distance distance in output samples over which the compensation should be performed
3176 * @param sample_delta number of output samples which should be output less
3178 * example: av_resample_compensate(c, 10, 500)
3179 * here instead of 510 samples only 500 samples would be output
3181 * note, due to rounding the actual compensation might be slightly different,
3182 * especially if the compensation_distance is large and the in_rate used during init is small
3184 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3185 void av_resample_close(struct AVResampleContext *c);
3188 * Allocate memory for a picture. Call avpicture_free to free it.
3190 * @param picture the picture to be filled in
3191 * @param pix_fmt the format of the picture
3192 * @param width the width of the picture
3193 * @param height the height of the picture
3194 * @return zero if successful, a negative value if not
3196 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3199 * Free a picture previously allocated by avpicture_alloc().
3201 * @param picture the AVPicture to be freed
3203 void avpicture_free(AVPicture *picture);
3206 * Fill in the AVPicture fields.
3207 * The fields of the given AVPicture are filled in by using the 'ptr' address
3208 * which points to the image data buffer. Depending on the specified picture
3209 * format, one or multiple image data pointers and line sizes will be set.
3210 * If a planar format is specified, several pointers will be set pointing to
3211 * the different picture planes and the line sizes of the different planes
3212 * will be stored in the lines_sizes array.
3213 * Call with ptr == NULL to get the required size for the ptr buffer.
3215 * @param picture AVPicture whose fields are to be filled in
3216 * @param ptr Buffer which will contain or contains the actual image data
3217 * @param pix_fmt The format in which the picture data is stored.
3218 * @param width the width of the image in pixels
3219 * @param height the height of the image in pixels
3220 * @return size of the image data in bytes
3222 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3223 enum PixelFormat pix_fmt, int width, int height);
3224 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3225 unsigned char *dest, int dest_size);
3228 * Calculate the size in bytes that a picture of the given width and height
3229 * would occupy if stored in the given picture format.
3230 * Note that this returns the size of a compact representation as generated
3231 * by avpicture_layout, which can be smaller than the size required for e.g.
3234 * @param pix_fmt the given picture format
3235 * @param width the width of the image
3236 * @param height the height of the image
3237 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3239 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3240 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3241 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3242 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3244 #if LIBAVCODEC_VERSION_MAJOR < 53
3246 * Return the pixel format corresponding to the name name.
3248 * If there is no pixel format with name name, then look for a
3249 * pixel format with the name corresponding to the native endian
3251 * For example in a little-endian system, first look for "gray16",
3252 * then for "gray16le".
3254 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3256 * @deprecated Deprecated in favor of av_get_pix_fmt().
3258 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3262 * Return a value representing the fourCC code associated to the
3263 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3266 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3269 * Put a string representing the codec tag codec_tag in buf.
3271 * @param buf_size size in bytes of buf
3272 * @return the length of the string that would have been generated if
3273 * enough space had been available, excluding the trailing null
3275 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3277 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3278 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3279 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3280 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3281 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3282 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3285 * Compute what kind of losses will occur when converting from one specific
3286 * pixel format to another.
3287 * When converting from one pixel format to another, information loss may occur.
3288 * For example, when converting from RGB24 to GRAY, the color information will
3289 * be lost. Similarly, other losses occur when converting from some formats to
3290 * other formats. These losses can involve loss of chroma, but also loss of
3291 * resolution, loss of color depth, loss due to the color space conversion, loss
3292 * of the alpha bits or loss due to color quantization.
3293 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3294 * which will occur when converting from one pixel format to another.
3296 * @param[in] dst_pix_fmt destination pixel format
3297 * @param[in] src_pix_fmt source pixel format
3298 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3299 * @return Combination of flags informing you what kind of losses will occur.
3301 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3305 * Find the best pixel format to convert to given a certain source pixel
3306 * format. When converting from one pixel format to another, information loss
3307 * may occur. For example, when converting from RGB24 to GRAY, the color
3308 * information will be lost. Similarly, other losses occur when converting from
3309 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3310 * the given pixel formats should be used to suffer the least amount of loss.
3311 * The pixel formats from which it chooses one, are determined by the
3312 * pix_fmt_mask parameter.
3315 * src_pix_fmt = PIX_FMT_YUV420P;
3316 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3317 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3320 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3321 * @param[in] src_pix_fmt source pixel format
3322 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3323 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3324 * @return The best pixel format to convert to or -1 if none was found.
3326 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3327 int has_alpha, int *loss_ptr);
3329 #if LIBAVCODEC_VERSION_MAJOR < 53
3331 * @deprecated Use av_get_pix_fmt_string() instead.
3333 attribute_deprecated
3334 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3337 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3338 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3341 * Tell if an image really has transparent alpha values.
3342 * @return ored mask of FF_ALPHA_xxx constants
3344 int img_get_alpha_info(const AVPicture *src,
3345 enum PixelFormat pix_fmt, int width, int height);
3347 /* deinterlace a picture */
3348 /* deinterlace - if not supported return -1 */
3349 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3350 enum PixelFormat pix_fmt, int width, int height);
3352 /* external high level API */
3355 * If c is NULL, returns the first registered codec,
3356 * if c is non-NULL, returns the next registered codec after c,
3357 * or NULL if c is the last one.
3359 AVCodec *av_codec_next(AVCodec *c);
3362 * Return the LIBAVCODEC_VERSION_INT constant.
3364 unsigned avcodec_version(void);
3367 * Return the libavcodec build-time configuration.
3369 const char *avcodec_configuration(void);
3372 * Return the libavcodec license.
3374 const char *avcodec_license(void);
3377 * Initialize libavcodec.
3379 * @warning This function must be called before any other libavcodec
3382 void avcodec_init(void);
3384 #if LIBAVCODEC_VERSION_MAJOR < 53
3386 * @deprecated Deprecated in favor of avcodec_register().
3388 attribute_deprecated void register_avcodec(AVCodec *codec);
3392 * Register the codec codec and initialize libavcodec.
3394 * @see avcodec_init()
3396 void avcodec_register(AVCodec *codec);
3399 * Find a registered encoder with a matching codec ID.
3401 * @param id CodecID of the requested encoder
3402 * @return An encoder if one was found, NULL otherwise.
3404 AVCodec *avcodec_find_encoder(enum CodecID id);
3407 * Find a registered encoder with the specified name.
3409 * @param name name of the requested encoder
3410 * @return An encoder if one was found, NULL otherwise.
3412 AVCodec *avcodec_find_encoder_by_name(const char *name);
3415 * Find a registered decoder with a matching codec ID.
3417 * @param id CodecID of the requested decoder
3418 * @return A decoder if one was found, NULL otherwise.
3420 AVCodec *avcodec_find_decoder(enum CodecID id);
3423 * Find a registered decoder with the specified name.
3425 * @param name name of the requested decoder
3426 * @return A decoder if one was found, NULL otherwise.
3428 AVCodec *avcodec_find_decoder_by_name(const char *name);
3429 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3432 * Return a name for the specified profile, if available.
3434 * @param codec the codec that is searched for the given profile
3435 * @param profile the profile value for which a name is requested
3436 * @return A name for the profile if found, NULL otherwise.
3438 const char *av_get_profile_name(const AVCodec *codec, int profile);
3441 * Set the fields of the given AVCodecContext to default values.
3443 * @param s The AVCodecContext of which the fields should be set to default values.
3445 void avcodec_get_context_defaults(AVCodecContext *s);
3447 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3448 * we WILL change its arguments and name a few times! */
3449 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3451 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3452 * we WILL change its arguments and name a few times! */
3453 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3456 * Allocate an AVCodecContext and set its fields to default values. The
3457 * resulting struct can be deallocated by simply calling av_free().
3459 * @return An AVCodecContext filled with default values or NULL on failure.
3460 * @see avcodec_get_context_defaults
3462 AVCodecContext *avcodec_alloc_context(void);
3464 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3465 * we WILL change its arguments and name a few times! */
3466 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3468 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3469 * we WILL change its arguments and name a few times! */
3470 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3473 * Copy the settings of the source AVCodecContext into the destination
3474 * AVCodecContext. The resulting destination codec context will be
3475 * unopened, i.e. you are required to call avcodec_open() before you
3476 * can use this AVCodecContext to decode/encode video/audio data.
3478 * @param dest target codec context, should be initialized with
3479 * avcodec_alloc_context(), but otherwise uninitialized
3480 * @param src source codec context
3481 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3483 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3486 * Set the fields of the given AVFrame to default values.
3488 * @param pic The AVFrame of which the fields should be set to default values.
3490 void avcodec_get_frame_defaults(AVFrame *pic);
3493 * Allocate an AVFrame and set its fields to default values. The resulting
3494 * struct can be deallocated by simply calling av_free().
3496 * @return An AVFrame filled with default values or NULL on failure.
3497 * @see avcodec_get_frame_defaults
3499 AVFrame *avcodec_alloc_frame(void);
3501 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3502 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3503 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3506 * Return the amount of padding in pixels which the get_buffer callback must
3507 * provide around the edge of the image for codecs which do not have the
3508 * CODEC_FLAG_EMU_EDGE flag.
3510 * @return Required padding in pixels.
3512 unsigned avcodec_get_edge_width(void);
3514 * Modify width and height values so that they will result in a memory
3515 * buffer that is acceptable for the codec if you do not use any horizontal
3518 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3519 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3520 * according to avcodec_get_edge_width() before.
3522 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3524 * Modify width and height values so that they will result in a memory
3525 * buffer that is acceptable for the codec if you also ensure that all
3526 * line sizes are a multiple of the respective linesize_align[i].
3528 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3529 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3530 * according to avcodec_get_edge_width() before.
3532 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3533 int linesize_align[4]);
3535 #if LIBAVCODEC_VERSION_MAJOR < 53
3537 * @deprecated Deprecated in favor of av_check_image_size().
3539 attribute_deprecated
3540 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3543 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3545 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3546 void avcodec_thread_free(AVCodecContext *s);
3547 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3548 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3549 //FIXME func typedef
3552 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3553 * function the context has to be allocated.
3555 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3556 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3557 * retrieving a codec.
3559 * @warning This function is not thread safe!
3562 * avcodec_register_all();
3563 * codec = avcodec_find_decoder(CODEC_ID_H264);
3567 * context = avcodec_alloc_context();
3569 * if (avcodec_open(context, codec) < 0)
3573 * @param avctx The context which will be set up to use the given codec.
3574 * @param codec The codec to use within the context.
3575 * @return zero on success, a negative value on error
3576 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3578 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3580 #if FF_API_AUDIO_OLD
3582 * Decode an audio frame from buf into samples.
3583 * Wrapper function which calls avcodec_decode_audio3.
3585 * @deprecated Use avcodec_decode_audio3 instead.
3586 * @param avctx the codec context
3587 * @param[out] samples the output buffer
3588 * @param[in,out] frame_size_ptr the output buffer size in bytes
3589 * @param[in] buf the input buffer
3590 * @param[in] buf_size the input buffer size in bytes
3591 * @return On error a negative value is returned, otherwise the number of bytes
3592 * used or zero if no frame could be decompressed.
3594 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3595 int *frame_size_ptr,
3596 const uint8_t *buf, int buf_size);
3600 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3601 * Some decoders may support multiple frames in a single AVPacket, such
3602 * decoders would then just decode the first frame. In this case,
3603 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3604 * the remaining data in order to decode the second frame etc.
3606 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3607 * decompressed frame size in bytes.
3609 * @warning You must set frame_size_ptr to the allocated size of the
3610 * output buffer before calling avcodec_decode_audio3().
3612 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3613 * the actual read bytes because some optimized bitstream readers read 32 or 64
3614 * bits at once and could read over the end.
3616 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3617 * no overreading happens for damaged MPEG streams.
3619 * @note You might have to align the input buffer avpkt->data and output buffer
3620 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3621 * necessary at all, on others it won't work at all if not aligned and on others
3622 * it will work but it will have an impact on performance.
3624 * In practice, avpkt->data should have 4 byte alignment at minimum and
3625 * samples should be 16 byte aligned unless the CPU doesn't need it
3626 * (AltiVec and SSE do).
3628 * @param avctx the codec context
3629 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3630 * @param[in,out] frame_size_ptr the output buffer size in bytes
3631 * @param[in] avpkt The input AVPacket containing the input buffer.
3632 * You can create such packet with av_init_packet() and by then setting
3633 * data and size, some decoders might in addition need other fields.
3634 * All decoders are designed to use the least fields possible though.
3635 * @return On error a negative value is returned, otherwise the number of bytes
3636 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3638 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3639 int *frame_size_ptr,
3642 #if FF_API_VIDEO_OLD
3644 * Decode a video frame from buf into picture.
3645 * Wrapper function which calls avcodec_decode_video2.
3647 * @deprecated Use avcodec_decode_video2 instead.
3648 * @param avctx the codec context
3649 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3650 * @param[in] buf the input buffer
3651 * @param[in] buf_size the size of the input buffer in bytes
3652 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3653 * @return On error a negative value is returned, otherwise the number of bytes
3654 * used or zero if no frame could be decompressed.
3656 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3657 int *got_picture_ptr,
3658 const uint8_t *buf, int buf_size);
3662 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3663 * Some decoders may support multiple frames in a single AVPacket, such
3664 * decoders would then just decode the first frame.
3666 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3667 * the actual read bytes because some optimized bitstream readers read 32 or 64
3668 * bits at once and could read over the end.
3670 * @warning The end of the input buffer buf should be set to 0 to ensure that
3671 * no overreading happens for damaged MPEG streams.
3673 * @note You might have to align the input buffer avpkt->data.
3674 * The alignment requirements depend on the CPU: on some CPUs it isn't
3675 * necessary at all, on others it won't work at all if not aligned and on others
3676 * it will work but it will have an impact on performance.
3678 * In practice, avpkt->data should have 4 byte alignment at minimum.
3680 * @note Some codecs have a delay between input and output, these need to be
3681 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3683 * @param avctx the codec context
3684 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3685 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3686 * allocate memory for the actual bitmap.
3687 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3688 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3689 * decodes and the decoder tells the user once it does not need the data anymore,
3690 * the user app can at this point free/reuse/keep the memory as it sees fit.
3692 * @param[in] avpkt The input AVpacket containing the input buffer.
3693 * You can create such packet with av_init_packet() and by then setting
3694 * data and size, some decoders might in addition need other fields like
3695 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3697 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3698 * @return On error a negative value is returned, otherwise the number of bytes
3699 * used or zero if no frame could be decompressed.
3701 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3702 int *got_picture_ptr,
3705 #if FF_API_SUBTITLE_OLD
3706 /* Decode a subtitle message. Return -1 if error, otherwise return the
3707 * number of bytes used. If no subtitle could be decompressed,
3708 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3709 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3711 const uint8_t *buf, int buf_size);
3715 * Decode a subtitle message.
3716 * Return a negative value on error, otherwise return the number of bytes used.
3717 * If no subtitle could be decompressed, got_sub_ptr is zero.
3718 * Otherwise, the subtitle is stored in *sub.
3719 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3720 * simplicity, because the performance difference is expect to be negligible
3721 * and reusing a get_buffer written for video codecs would probably perform badly
3722 * due to a potentially very different allocation pattern.
3724 * @param avctx the codec context
3725 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3726 freed with avsubtitle_free if *got_sub_ptr is set.
3727 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3728 * @param[in] avpkt The input AVPacket containing the input buffer.
3730 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3735 * Frees all allocated data in the given subtitle struct.
3737 * @param sub AVSubtitle to free.
3739 void avsubtitle_free(AVSubtitle *sub);
3741 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3743 uint8_t *buf, int buf_size);
3746 * Encode an audio frame from samples into buf.
3748 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3749 * However, for PCM audio the user will know how much space is needed
3750 * because it depends on the value passed in buf_size as described
3751 * below. In that case a lower value can be used.
3753 * @param avctx the codec context
3754 * @param[out] buf the output buffer
3755 * @param[in] buf_size the output buffer size
3756 * @param[in] samples the input buffer containing the samples
3757 * The number of samples read from this buffer is frame_size*channels,
3758 * both of which are defined in avctx.
3759 * For PCM audio the number of samples read from samples is equal to
3760 * buf_size * input_sample_size / output_sample_size.
3761 * @return On error a negative value is returned, on success zero or the number
3762 * of bytes used to encode the data read from the input buffer.
3764 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3765 const short *samples);
3768 * Encode a video frame from pict into buf.
3769 * The input picture should be
3770 * stored using a specific format, namely avctx.pix_fmt.
3772 * @param avctx the codec context
3773 * @param[out] buf the output buffer for the bitstream of encoded frame
3774 * @param[in] buf_size the size of the output buffer in bytes
3775 * @param[in] pict the input picture to encode
3776 * @return On error a negative value is returned, on success zero or the number
3777 * of bytes used from the output buffer.
3779 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3780 const AVFrame *pict);
3781 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3782 const AVSubtitle *sub);
3784 int avcodec_close(AVCodecContext *avctx);
3787 * Register all the codecs, parsers and bitstream filters which were enabled at
3788 * configuration time. If you do not call this function you can select exactly
3789 * which formats you want to support, by using the individual registration
3792 * @see avcodec_register
3793 * @see av_register_codec_parser
3794 * @see av_register_bitstream_filter
3796 void avcodec_register_all(void);
3799 * Flush buffers, should be called when seeking or when switching to a different stream.
3801 void avcodec_flush_buffers(AVCodecContext *avctx);
3803 void avcodec_default_free_buffers(AVCodecContext *s);
3805 /* misc useful functions */
3808 * Return a single letter to describe the given picture type pict_type.
3810 * @param[in] pict_type the picture type
3811 * @return A single character representing the picture type.
3813 char av_get_pict_type_char(int pict_type);
3816 * Return codec bits per sample.
3818 * @param[in] codec_id the codec
3819 * @return Number of bits per sample or zero if unknown for the given codec.
3821 int av_get_bits_per_sample(enum CodecID codec_id);
3823 #if FF_API_OLD_SAMPLE_FMT
3825 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3827 attribute_deprecated
3828 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3832 typedef struct AVCodecParserContext {
3834 struct AVCodecParser *parser;
3835 int64_t frame_offset; /* offset of the current frame */
3836 int64_t cur_offset; /* current offset
3837 (incremented by each av_parser_parse()) */
3838 int64_t next_frame_offset; /* offset of the next frame */
3840 int pict_type; /* XXX: Put it back in AVCodecContext. */
3842 * This field is used for proper frame duration computation in lavf.
3843 * It signals, how much longer the frame duration of the current frame
3844 * is compared to normal frame duration.
3846 * frame_duration = (1 + repeat_pict) * time_base
3848 * It is used by codecs like H.264 to display telecined material.
3850 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3851 int64_t pts; /* pts of the current frame */
3852 int64_t dts; /* dts of the current frame */
3857 int fetch_timestamp;
3859 #define AV_PARSER_PTS_NB 4
3860 int cur_frame_start_index;
3861 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3862 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3863 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3866 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3867 #define PARSER_FLAG_ONCE 0x0002
3868 /// Set if the parser has a valid file offset
3869 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3871 int64_t offset; ///< byte offset from starting packet start
3872 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3875 * Set by parser to 1 for key frames and 0 for non-key frames.
3876 * It is initialized to -1, so if the parser doesn't set this flag,
3877 * old-style fallback using FF_I_TYPE picture type as key frames
3883 * Time difference in stream time base units from the pts of this
3884 * packet to the point at which the output from the decoder has converged
3885 * independent from the availability of previous frames. That is, the
3886 * frames are virtually identical no matter if decoding started from
3887 * the very first frame or from this keyframe.
3888 * Is AV_NOPTS_VALUE if unknown.
3889 * This field is not the display duration of the current frame.
3890 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3893 * The purpose of this field is to allow seeking in streams that have no
3894 * keyframes in the conventional sense. It corresponds to the
3895 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3896 * essential for some types of subtitle streams to ensure that all
3897 * subtitles are correctly displayed after seeking.
3899 int64_t convergence_duration;
3901 // Timestamp generation support:
3903 * Synchronization point for start of timestamp generation.
3905 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3908 * For example, this corresponds to presence of H.264 buffering period
3914 * Offset of the current timestamp against last timestamp sync point in
3915 * units of AVCodecContext.time_base.
3917 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3918 * contain a valid timestamp offset.
3920 * Note that the timestamp of sync point has usually a nonzero
3921 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3922 * the next frame after timestamp sync point will be usually 1.
3924 * For example, this corresponds to H.264 cpb_removal_delay.
3926 int dts_ref_dts_delta;
3929 * Presentation delay of current frame in units of AVCodecContext.time_base.
3931 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3932 * contain valid non-negative timestamp delta (presentation time of a frame
3933 * must not lie in the past).
3935 * This delay represents the difference between decoding and presentation
3936 * time of the frame.
3938 * For example, this corresponds to H.264 dpb_output_delay.
3943 * Position of the packet in file.
3945 * Analogous to cur_frame_pts/dts
3947 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3950 * Byte position of currently parsed frame in stream.
3955 * Previous frame byte position.
3958 } AVCodecParserContext;
3960 typedef struct AVCodecParser {
3961 int codec_ids[5]; /* several codec IDs are permitted */
3963 int (*parser_init)(AVCodecParserContext *s);
3964 int (*parser_parse)(AVCodecParserContext *s,
3965 AVCodecContext *avctx,
3966 const uint8_t **poutbuf, int *poutbuf_size,
3967 const uint8_t *buf, int buf_size);
3968 void (*parser_close)(AVCodecParserContext *s);
3969 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3970 struct AVCodecParser *next;
3973 AVCodecParser *av_parser_next(AVCodecParser *c);
3975 void av_register_codec_parser(AVCodecParser *parser);
3976 AVCodecParserContext *av_parser_init(int codec_id);
3978 #if LIBAVCODEC_VERSION_MAJOR < 53
3979 attribute_deprecated
3980 int av_parser_parse(AVCodecParserContext *s,
3981 AVCodecContext *avctx,
3982 uint8_t **poutbuf, int *poutbuf_size,
3983 const uint8_t *buf, int buf_size,
3984 int64_t pts, int64_t dts);
3990 * @param s parser context.
3991 * @param avctx codec context.
3992 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3993 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3994 * @param buf input buffer.
3995 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3996 * @param pts input presentation timestamp.
3997 * @param dts input decoding timestamp.
3998 * @param pos input byte position in stream.
3999 * @return the number of bytes of the input bitstream used.
4004 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4011 * decode_frame(data, size);
4015 int av_parser_parse2(AVCodecParserContext *s,
4016 AVCodecContext *avctx,
4017 uint8_t **poutbuf, int *poutbuf_size,
4018 const uint8_t *buf, int buf_size,
4019 int64_t pts, int64_t dts,
4022 int av_parser_change(AVCodecParserContext *s,
4023 AVCodecContext *avctx,
4024 uint8_t **poutbuf, int *poutbuf_size,
4025 const uint8_t *buf, int buf_size, int keyframe);
4026 void av_parser_close(AVCodecParserContext *s);
4029 typedef struct AVBitStreamFilterContext {
4031 struct AVBitStreamFilter *filter;
4032 AVCodecParserContext *parser;
4033 struct AVBitStreamFilterContext *next;
4034 } AVBitStreamFilterContext;
4037 typedef struct AVBitStreamFilter {
4040 int (*filter)(AVBitStreamFilterContext *bsfc,
4041 AVCodecContext *avctx, const char *args,
4042 uint8_t **poutbuf, int *poutbuf_size,
4043 const uint8_t *buf, int buf_size, int keyframe);
4044 void (*close)(AVBitStreamFilterContext *bsfc);
4045 struct AVBitStreamFilter *next;
4046 } AVBitStreamFilter;
4048 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4049 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4050 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4051 AVCodecContext *avctx, const char *args,
4052 uint8_t **poutbuf, int *poutbuf_size,
4053 const uint8_t *buf, int buf_size, int keyframe);
4054 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4056 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4061 * Reallocate the given block if it is not large enough, otherwise do nothing.
4065 void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4068 * Allocate a buffer, reusing the given one if large enough.
4070 * Contrary to av_fast_realloc the current buffer contents might not be
4071 * preserved and on error the old buffer is freed, thus no special
4072 * handling to avoid memleaks is necessary.
4074 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4075 * @param size size of the buffer *ptr points to
4076 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4077 * *size 0 if an error occurred.
4079 void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4081 #if LIBAVCODEC_VERSION_MAJOR < 53
4083 * @deprecated Deprecated in favor of av_image_copy().
4085 attribute_deprecated
4086 void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4087 uint8_t *src_data[4], int src_linesize[4],
4088 enum PixelFormat pix_fmt, int width, int height);
4092 * Copy image src to dst. Wraps av_picture_data_copy() above.
4094 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4095 enum PixelFormat pix_fmt, int width, int height);
4098 * Crop image top and left side.
4100 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4101 enum PixelFormat pix_fmt, int top_band, int left_band);
4106 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4107 int padtop, int padbottom, int padleft, int padright, int *color);
4110 * Encode extradata length to a buffer. Used by xiph codecs.
4112 * @param s buffer to write to; must be at least (v/255+1) bytes long
4113 * @param v size of extradata in bytes
4114 * @return number of bytes written to the buffer.
4116 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4118 #if LIBAVCODEC_VERSION_MAJOR < 53
4120 * Parse str and put in width_ptr and height_ptr the detected values.
4122 * @deprecated Deprecated in favor of av_parse_video_size().
4124 attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4127 * Parse str and store the detected values in *frame_rate.
4129 * @deprecated Deprecated in favor of av_parse_video_rate().
4131 attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4135 * Logs a generic warning message about a missing feature. This function is
4136 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4137 * only, and would normally not be used by applications.
4138 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4139 * a pointer to an AVClass struct
4140 * @param[in] feature string containing the name of the missing feature
4141 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4142 * If want_sample is non-zero, additional verbage will be added to the log
4143 * message which tells the user how to report samples to the development
4146 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4149 * Log a generic warning message asking for a sample. This function is
4150 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4151 * only, and would normally not be used by applications.
4152 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4153 * a pointer to an AVClass struct
4154 * @param[in] msg string containing an optional message, or NULL if no message
4156 void av_log_ask_for_sample(void *avc, const char *msg);
4159 * Register the hardware accelerator hwaccel.
4161 void av_register_hwaccel(AVHWAccel *hwaccel);
4164 * If hwaccel is NULL, returns the first registered hardware accelerator,
4165 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4166 * after hwaccel, or NULL if hwaccel is the last one.
4168 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4172 * Lock operation used by lockmgr
4175 AV_LOCK_CREATE, ///< Create a mutex
4176 AV_LOCK_OBTAIN, ///< Lock the mutex
4177 AV_LOCK_RELEASE, ///< Unlock the mutex
4178 AV_LOCK_DESTROY, ///< Free mutex resources
4182 * Register a user provided lock manager supporting the operations
4183 * specified by AVLockOp. mutex points to a (void *) where the
4184 * lockmgr should store/get a pointer to a user allocated mutex. It's
4185 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4187 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4188 * callback during the call to av_lockmgr_register().
4189 * Thus, the application must be prepared to handle that.
4190 * If cb is set to NULL the lockmgr will be unregistered.
4191 * Also note that during unregistration the previously registered
4192 * lockmgr callback may also be invoked.
4194 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4196 #endif /* AVCODEC_AVCODEC_H */