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 109
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,
265 /* various PCM "codecs" */
266 CODEC_ID_PCM_S16LE= 0x10000,
282 CODEC_ID_PCM_S24DAUD,
284 CODEC_ID_PCM_S16LE_PLANAR,
293 /* various ADPCM codecs */
294 CODEC_ID_ADPCM_IMA_QT= 0x11000,
295 CODEC_ID_ADPCM_IMA_WAV,
296 CODEC_ID_ADPCM_IMA_DK3,
297 CODEC_ID_ADPCM_IMA_DK4,
298 CODEC_ID_ADPCM_IMA_WS,
299 CODEC_ID_ADPCM_IMA_SMJPEG,
308 CODEC_ID_ADPCM_YAMAHA,
309 CODEC_ID_ADPCM_SBPRO_4,
310 CODEC_ID_ADPCM_SBPRO_3,
311 CODEC_ID_ADPCM_SBPRO_2,
313 CODEC_ID_ADPCM_IMA_AMV,
314 CODEC_ID_ADPCM_EA_R1,
315 CODEC_ID_ADPCM_EA_R3,
316 CODEC_ID_ADPCM_EA_R2,
317 CODEC_ID_ADPCM_IMA_EA_SEAD,
318 CODEC_ID_ADPCM_IMA_EA_EACS,
319 CODEC_ID_ADPCM_EA_XAS,
320 CODEC_ID_ADPCM_EA_MAXIS_XA,
321 CODEC_ID_ADPCM_IMA_ISS,
325 CODEC_ID_AMR_NB= 0x12000,
328 /* RealAudio codecs*/
329 CODEC_ID_RA_144= 0x13000,
332 /* various DPCM codecs */
333 CODEC_ID_ROQ_DPCM= 0x14000,
334 CODEC_ID_INTERPLAY_DPCM,
339 CODEC_ID_MP2= 0x15000,
340 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 /* subtitle codecs */
395 CODEC_ID_DVD_SUBTITLE= 0x17000,
396 CODEC_ID_DVB_SUBTITLE,
397 CODEC_ID_TEXT, ///< raw UTF-8 text
401 CODEC_ID_HDMV_PGS_SUBTITLE,
402 CODEC_ID_DVB_TELETEXT,
405 /* other specific kind of codecs (generally used for attachments) */
406 CODEC_ID_TTF= 0x18000,
408 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
410 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
411 * stream (only used by libavformat) */
412 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
415 #if LIBAVCODEC_VERSION_MAJOR < 53
416 #define CodecType AVMediaType
418 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
419 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
420 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
421 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
422 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
423 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
424 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
427 #if FF_API_OLD_SAMPLE_FMT
428 #define SampleFormat AVSampleFormat
430 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
431 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
432 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
433 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
434 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
435 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
436 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
439 #if FF_API_OLD_AUDIOCONVERT
440 #include "libavcore/audioconvert.h"
442 /* Audio channel masks */
443 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
444 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
445 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
446 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
447 #define CH_BACK_LEFT AV_CH_BACK_LEFT
448 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
449 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
450 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
451 #define CH_BACK_CENTER AV_CH_BACK_CENTER
452 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
453 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
454 #define CH_TOP_CENTER AV_CH_TOP_CENTER
455 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
456 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
457 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
458 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
459 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
460 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
461 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
462 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
464 /** Channel mask value used for AVCodecContext.request_channel_layout
465 to indicate that the user requests the channel order of the decoder output
466 to be the native codec channel order. */
467 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
469 /* Audio channel convenience macros */
470 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
471 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
472 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
473 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
474 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
475 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
476 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
477 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
478 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
479 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
480 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
481 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
482 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
483 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
484 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
488 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
491 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
492 * This is mainly needed because some optimized bitstream readers read
493 * 32 or 64 bit at once and could read over the end.<br>
494 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
495 * MPEG bitstreams could cause overread and segfault.
497 #define FF_INPUT_BUFFER_PADDING_SIZE 8
500 * minimum encoding buffer size
501 * Used to avoid some checks during header writing.
503 #define FF_MIN_BUFFER_SIZE 16384
507 * motion estimation type.
510 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
514 ME_EPZS, ///< enhanced predictive zonal search
515 ME_X1, ///< reserved for experiments
516 ME_HEX, ///< hexagon based search
517 ME_UMH, ///< uneven multi-hexagon search
518 ME_ITER, ///< iterative search
519 ME_TESA, ///< transformed exhaustive search algorithm
523 /* We leave some space between them for extensions (drop some
524 * keyframes for intra-only or drop just some bidir frames). */
525 AVDISCARD_NONE =-16, ///< discard nothing
526 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
527 AVDISCARD_NONREF = 8, ///< discard all non reference
528 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
529 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
530 AVDISCARD_ALL = 48, ///< discard all
533 enum AVColorPrimaries{
534 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
535 AVCOL_PRI_UNSPECIFIED=2,
537 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
538 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
539 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
541 AVCOL_PRI_NB , ///< Not part of ABI
544 enum AVColorTransferCharacteristic{
545 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
546 AVCOL_TRC_UNSPECIFIED=2,
547 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
548 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
549 AVCOL_TRC_NB , ///< Not part of ABI
554 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
555 AVCOL_SPC_UNSPECIFIED=2,
557 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
558 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
559 AVCOL_SPC_SMPTE240M =7,
560 AVCOL_SPC_NB , ///< Not part of ABI
564 AVCOL_RANGE_UNSPECIFIED=0,
565 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
566 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
567 AVCOL_RANGE_NB , ///< Not part of ABI
571 * X X 3 4 X X are luma samples,
572 * 1 2 1-6 are possible chroma positions
573 * X X 5 6 X 0 is undefined/unknown position
575 enum AVChromaLocation{
576 AVCHROMA_LOC_UNSPECIFIED=0,
577 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
578 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
579 AVCHROMA_LOC_TOPLEFT =3, ///< DV
581 AVCHROMA_LOC_BOTTOMLEFT =5,
582 AVCHROMA_LOC_BOTTOM =6,
583 AVCHROMA_LOC_NB , ///< Not part of ABI
590 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
591 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
592 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
593 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
594 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
595 AV_LPC_TYPE_NB , ///< Not part of ABI
598 typedef struct RcOverride{
601 int qscale; // If this is 0 then quality_factor will be used instead.
602 float quality_factor;
605 #define FF_MAX_B_FRAMES 16
608 These flags can be passed in AVCodecContext.flags before initialization.
609 Note: Not everything is supported yet.
612 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
613 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
614 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
615 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
616 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
617 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
619 * The parent program guarantees that the input for B-frames containing
620 * streams is not written to for at least s->max_b_frames+1 frames, if
621 * this is not set the input will be copied.
623 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
624 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
625 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
626 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
627 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
628 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
629 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
630 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
631 location instead of only at frame boundaries. */
632 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
633 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
634 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
635 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
636 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
637 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
638 /* Fx : Flag for h263+ extra options */
639 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
640 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
641 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
642 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
643 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
644 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
645 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
646 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
647 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
648 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
649 #define CODEC_FLAG_CLOSED_GOP 0x80000000
650 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
651 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
652 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
653 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
654 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
655 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
656 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
657 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
658 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
659 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
660 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
661 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
662 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
663 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
664 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
665 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
666 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
667 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
668 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
669 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
670 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
671 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
673 /* Unsupported options :
674 * Syntax Arithmetic coding (SAC)
675 * Reference Picture Selection
676 * Independent Segment Decoding */
678 /* codec capabilities */
680 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
682 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
683 * If not set, it might not use get_buffer() at all or use operations that
684 * assume the buffer was allocated by avcodec_default_get_buffer.
686 #define CODEC_CAP_DR1 0x0002
687 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
688 #define CODEC_CAP_PARSE_ONLY 0x0004
689 #define CODEC_CAP_TRUNCATED 0x0008
690 /* Codec can export data for HW decoding (XvMC). */
691 #define CODEC_CAP_HWACCEL 0x0010
693 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
694 * If this is not set, the codec is guaranteed to never be fed with NULL data.
696 #define CODEC_CAP_DELAY 0x0020
698 * Codec can be fed a final frame with a smaller size.
699 * This can be used to prevent truncation of the last audio samples.
701 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
703 * Codec can export data for HW decoding (VDPAU).
705 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
707 * Codec can output multiple frames per AVPacket
708 * Normally demuxers return one frame at a time, demuxers which do not do
709 * are connected to a parser to split what they return into proper frames.
710 * This flag is reserved to the very rare category of codecs which have a
711 * bitstream that cannot be split into frames without timeconsuming
712 * operations like full decoding. Demuxers carring such bitstreams thus
713 * may return multiple frames in a packet. This has many disadvantages like
714 * prohibiting stream copy in many cases thus it should only be considered
717 #define CODEC_CAP_SUBFRAMES 0x0100
719 * Codec is experimental and is thus avoided in favor of non experimental
722 #define CODEC_CAP_EXPERIMENTAL 0x0200
724 * Codec should fill in channel configuration and samplerate instead of container
726 #define CODEC_CAP_CHANNEL_CONF 0x0400
728 * Codec is able to deal with negative linesizes
730 #define CODEC_CAP_NEG_LINESIZES 0x0800
732 //The following defines may change, don't expect compatibility if you use them.
733 #define MB_TYPE_INTRA4x4 0x0001
734 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
735 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
736 #define MB_TYPE_16x16 0x0008
737 #define MB_TYPE_16x8 0x0010
738 #define MB_TYPE_8x16 0x0020
739 #define MB_TYPE_8x8 0x0040
740 #define MB_TYPE_INTERLACED 0x0080
741 #define MB_TYPE_DIRECT2 0x0100 //FIXME
742 #define MB_TYPE_ACPRED 0x0200
743 #define MB_TYPE_GMC 0x0400
744 #define MB_TYPE_SKIP 0x0800
745 #define MB_TYPE_P0L0 0x1000
746 #define MB_TYPE_P1L0 0x2000
747 #define MB_TYPE_P0L1 0x4000
748 #define MB_TYPE_P1L1 0x8000
749 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
750 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
751 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
752 #define MB_TYPE_QUANT 0x00010000
753 #define MB_TYPE_CBP 0x00020000
754 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
758 * This specifies the area which should be displayed.
759 * Note there may be multiple such areas for one frame.
761 typedef struct AVPanScan{
764 * - encoding: Set by user.
765 * - decoding: Set by libavcodec.
770 * width and height in 1/16 pel
771 * - encoding: Set by user.
772 * - decoding: Set by libavcodec.
778 * position of the top left corner in 1/16 pel for up to 3 fields/frames
779 * - encoding: Set by user.
780 * - decoding: Set by libavcodec.
782 int16_t position[3][2];
785 #define FF_COMMON_FRAME \
787 * pointer to the picture planes.\
788 * This might be different from the first allocated byte\
795 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
796 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
802 * 1 -> keyframe, 0-> not\
803 * - encoding: Set by libavcodec.\
804 * - decoding: Set by libavcodec.\
809 * Picture type of the frame, see ?_TYPE below.\
810 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
811 * - decoding: Set by libavcodec.\
816 * presentation timestamp in time_base units (time when frame should be shown to user)\
817 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
818 * - encoding: MUST be set by user.\
819 * - decoding: Set by libavcodec.\
824 * picture number in bitstream order\
825 * - encoding: set by\
826 * - decoding: Set by libavcodec.\
828 int coded_picture_number;\
830 * picture number in display order\
831 * - encoding: set by\
832 * - decoding: Set by libavcodec.\
834 int display_picture_number;\
837 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
838 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
839 * - decoding: Set by libavcodec.\
844 * buffer age (1->was last buffer and dint change, 2->..., ...).\
845 * Set to INT_MAX if the buffer has not been used yet.\
846 * - encoding: unused\
847 * - decoding: MUST be set by get_buffer().\
852 * is this picture used as reference\
853 * The values for this are the same as the MpegEncContext.picture_structure\
854 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
855 * Set to 4 for delayed, non-reference frames.\
856 * - encoding: unused\
857 * - decoding: Set by libavcodec. (before get_buffer() call)).\
863 * - encoding: unused\
864 * - decoding: Set by libavcodec.\
866 int8_t *qscale_table;\
869 * - encoding: unused\
870 * - decoding: Set by libavcodec.\
875 * mbskip_table[mb]>=1 if MB didn't change\
876 * stride= mb_width = (width+15)>>4\
877 * - encoding: unused\
878 * - decoding: Set by libavcodec.\
880 uint8_t *mbskip_table;\
883 * motion vector table\
886 * int mv_sample_log2= 4 - motion_subsample_log2;\
887 * int mb_width= (width+15)>>4;\
888 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
889 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
891 * - encoding: Set by user.\
892 * - decoding: Set by libavcodec.\
894 int16_t (*motion_val[2])[2];\
897 * macroblock type table\
898 * mb_type_base + mb_width + 2\
899 * - encoding: Set by user.\
900 * - decoding: Set by libavcodec.\
905 * log2 of the size of the block which a single vector in motion_val represents: \
906 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
907 * - encoding: unused\
908 * - decoding: Set by libavcodec.\
910 uint8_t motion_subsample_log2;\
913 * for some private data of the user\
914 * - encoding: unused\
915 * - decoding: Set by user.\
921 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
922 * - decoding: unused\
927 * type of the buffer (to keep track of who has to deallocate data[*])\
928 * - encoding: Set by the one who allocates it.\
929 * - decoding: Set by the one who allocates it.\
930 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
935 * When decoding, this signals how much the picture must be delayed.\
936 * extra_delay = repeat_pict / (2*fps)\
937 * - encoding: unused\
938 * - decoding: Set by libavcodec.\
948 * The content of the picture is interlaced.\
949 * - encoding: Set by user.\
950 * - decoding: Set by libavcodec. (default 0)\
952 int interlaced_frame;\
955 * If the content is interlaced, is top field displayed first.\
956 * - encoding: Set by user.\
957 * - decoding: Set by libavcodec.\
959 int top_field_first;\
963 * - encoding: Set by user.\
964 * - decoding: Set by libavcodec.\
966 AVPanScan *pan_scan;\
969 * Tell user application that palette has changed from previous frame.\
970 * - encoding: ??? (no palette-enabled encoder yet)\
971 * - decoding: Set by libavcodec. (default 0).\
973 int palette_has_changed;\
976 * codec suggestion on buffer type if != 0\
977 * - encoding: unused\
978 * - decoding: Set by libavcodec. (before get_buffer() call)).\
984 * - encoding: unused\
985 * - decoding: Set by libavcodec.\
990 * motion reference frame index\
991 * the order in which these are stored can depend on the codec.\
992 * - encoding: Set by user.\
993 * - decoding: Set by libavcodec.\
995 int8_t *ref_index[2];\
998 * reordered opaque 64bit (generally an integer or a double precision float\
999 * PTS but can be anything). \
1000 * The user sets AVCodecContext.reordered_opaque to represent the input at\
1002 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
1003 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
1004 * @deprecated in favor of pkt_pts\
1005 * - encoding: unused\
1006 * - decoding: Read by user.\
1008 int64_t reordered_opaque;\
1011 * hardware accelerator private data (FFmpeg allocated)\
1012 * - encoding: unused\
1013 * - decoding: Set by libavcodec\
1015 void *hwaccel_picture_private;\
1018 * reordered pts from the last AVPacket that has been input into the decoder\
1019 * - encoding: unused\
1020 * - decoding: Read by user.\
1025 * dts from the last AVPacket that has been input into the decoder\
1026 * - encoding: unused\
1027 * - decoding: Read by user.\
1032 #define FF_QSCALE_TYPE_MPEG1 0
1033 #define FF_QSCALE_TYPE_MPEG2 1
1034 #define FF_QSCALE_TYPE_H264 2
1035 #define FF_QSCALE_TYPE_VP56 3
1037 #define FF_BUFFER_TYPE_INTERNAL 1
1038 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1039 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1040 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1043 #define FF_I_TYPE 1 ///< Intra
1044 #define FF_P_TYPE 2 ///< Predicted
1045 #define FF_B_TYPE 3 ///< Bi-dir predicted
1046 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1047 #define FF_SI_TYPE 5 ///< Switching Intra
1048 #define FF_SP_TYPE 6 ///< Switching Predicted
1049 #define FF_BI_TYPE 7
1051 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1052 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1053 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1054 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1056 typedef struct AVPacket {
1058 * Presentation timestamp in AVStream->time_base units; the time at which
1059 * the decompressed packet will be presented to the user.
1060 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1061 * pts MUST be larger or equal to dts as presentation cannot happen before
1062 * decompression, unless one wants to view hex dumps. Some formats misuse
1063 * the terms dts and pts/cts to mean something different. Such timestamps
1064 * must be converted to true pts/dts before they are stored in AVPacket.
1068 * Decompression timestamp in AVStream->time_base units; the time at which
1069 * the packet is decompressed.
1070 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1078 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1079 * Equals next_pts - this_pts in presentation order.
1082 void (*destruct)(struct AVPacket *);
1084 int64_t pos; ///< byte position in stream, -1 if unknown
1087 * Time difference in AVStream->time_base units from the pts of this
1088 * packet to the point at which the output from the decoder has converged
1089 * independent from the availability of previous frames. That is, the
1090 * frames are virtually identical no matter if decoding started from
1091 * the very first frame or from this keyframe.
1092 * Is AV_NOPTS_VALUE if unknown.
1093 * This field is not the display duration of the current packet.
1094 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1097 * The purpose of this field is to allow seeking in streams that have no
1098 * keyframes in the conventional sense. It corresponds to the
1099 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1100 * essential for some types of subtitle streams to ensure that all
1101 * subtitles are correctly displayed after seeking.
1103 int64_t convergence_duration;
1105 #define AV_PKT_FLAG_KEY 0x0001
1106 #if LIBAVCODEC_VERSION_MAJOR < 53
1107 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1111 * Audio Video Frame.
1112 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1114 * Removal, reordering and changes to existing fields require a major
1115 * version bump. No fields should be added into AVFrame before or after
1117 * sizeof(AVFrame) must not be used outside libav*.
1119 typedef struct AVFrame {
1124 * main external API structure.
1125 * New fields can be added to the end with minor version bumps.
1126 * Removal, reordering and changes to existing fields require a major
1128 * sizeof(AVCodecContext) must not be used outside libav*.
1130 typedef struct AVCodecContext {
1132 * information on struct for av_log
1133 * - set by avcodec_alloc_context
1135 const AVClass *av_class;
1137 * the average bitrate
1138 * - encoding: Set by user; unused for constant quantizer encoding.
1139 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1144 * number of bits the bitstream is allowed to diverge from the reference.
1145 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1146 * - encoding: Set by user; unused for constant quantizer encoding.
1147 * - decoding: unused
1149 int bit_rate_tolerance;
1153 * - encoding: Set by user.
1154 * - decoding: Set by user.
1159 * Some codecs need additional format info. It is stored here.
1160 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1161 * specific codec MUST set it correctly otherwise stream copy breaks.
1162 * In general use of this field by muxers is not recommanded.
1163 * - encoding: Set by libavcodec.
1164 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1169 * Motion estimation algorithm used for video coding.
1170 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1171 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1172 * - encoding: MUST be set by user.
1173 * - decoding: unused
1178 * some codecs need / can use extradata like Huffman tables.
1179 * mjpeg: Huffman tables
1180 * rv10: additional flags
1181 * mpeg4: global headers (they can be in the bitstream or here)
1182 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1183 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1184 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1185 * - encoding: Set/allocated/freed by libavcodec.
1186 * - decoding: Set/allocated/freed by user.
1192 * This is the fundamental unit of time (in seconds) in terms
1193 * of which frame timestamps are represented. For fixed-fps content,
1194 * timebase should be 1/framerate and timestamp increments should be
1196 * - encoding: MUST be set by user.
1197 * - decoding: Set by libavcodec.
1199 AVRational time_base;
1203 * picture width / height.
1204 * - encoding: MUST be set by user.
1205 * - decoding: Set by libavcodec.
1206 * Note: For compatibility it is possible to set this instead of
1207 * coded_width/height before decoding.
1211 #define FF_ASPECT_EXTENDED 15
1214 * the number of pictures in a group of pictures, or 0 for intra_only
1215 * - encoding: Set by user.
1216 * - decoding: unused
1221 * Pixel format, see PIX_FMT_xxx.
1222 * May be set by the demuxer if known from headers.
1223 * May be overriden by the decoder if it knows better.
1224 * - encoding: Set by user.
1225 * - decoding: Set by user if known, overridden by libavcodec if known
1227 enum PixelFormat pix_fmt;
1230 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1231 * has to read frames at native frame rate.
1232 * - encoding: Set by user.
1233 * - decoding: unused
1238 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1239 * decoder to draw a horizontal band. It improves cache usage. Not
1240 * all codecs can do that. You must check the codec capabilities
1242 * The function is also used by hardware acceleration APIs.
1243 * It is called at least once during frame decoding to pass
1244 * the data needed for hardware render.
1245 * In that mode instead of pixel data, AVFrame points to
1246 * a structure specific to the acceleration API. The application
1247 * reads the structure and can change some fields to indicate progress
1249 * - encoding: unused
1250 * - decoding: Set by user.
1251 * @param height the height of the slice
1252 * @param y the y position of the slice
1253 * @param type 1->top field, 2->bottom field, 3->frame
1254 * @param offset offset into the AVFrame.data from which the slice should be read
1256 void (*draw_horiz_band)(struct AVCodecContext *s,
1257 const AVFrame *src, int offset[4],
1258 int y, int type, int height);
1261 int sample_rate; ///< samples per second
1262 int channels; ///< number of audio channels
1265 * audio sample format
1266 * - encoding: Set by user.
1267 * - decoding: Set by libavcodec.
1269 enum AVSampleFormat sample_fmt; ///< sample format
1271 /* The following data should not be initialized. */
1273 * Samples per packet, initialized when calling 'init'.
1276 int frame_number; ///< audio or video frame number
1277 #if LIBAVCODEC_VERSION_MAJOR < 53
1278 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1282 * Number of frames the decoded output will be delayed relative to
1283 * the encoded input.
1284 * - encoding: Set by libavcodec.
1285 * - decoding: unused
1289 /* - encoding parameters */
1290 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1291 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1295 * - encoding: Set by user.
1296 * - decoding: unused
1302 * - encoding: Set by user.
1303 * - decoding: unused
1308 * maximum quantizer difference between frames
1309 * - encoding: Set by user.
1310 * - decoding: unused
1315 * maximum number of B-frames between non-B-frames
1316 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1317 * - encoding: Set by user.
1318 * - decoding: unused
1323 * qscale factor between IP and B-frames
1324 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1325 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1326 * - encoding: Set by user.
1327 * - decoding: unused
1329 float b_quant_factor;
1331 /** obsolete FIXME remove */
1333 #define FF_RC_STRATEGY_XVID 1
1335 int b_frame_strategy;
1339 * - encoding: unused
1340 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1341 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1345 struct AVCodec *codec;
1349 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1350 /* do its best to deliver a chunk with size */
1351 /* below rtp_payload_size, the chunk will start */
1352 /* with a start code on some codecs like H.263. */
1353 /* This doesn't take account of any particular */
1354 /* headers inside the transmitted RTP payload. */
1357 /* The RTP callback: This function is called */
1358 /* every time the encoder has a packet to send. */
1359 /* It depends on the encoder if the data starts */
1360 /* with a Start Code (it should). H.263 does. */
1361 /* mb_nb contains the number of macroblocks */
1362 /* encoded in the RTP payload. */
1363 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1365 /* statistics, used for 2-pass encoding */
1376 * number of bits used for the previously encoded frame
1377 * - encoding: Set by libavcodec.
1378 * - decoding: unused
1383 * Private data of the user, can be used to carry app specific stuff.
1384 * - encoding: Set by user.
1385 * - decoding: Set by user.
1389 char codec_name[32];
1390 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1391 enum CodecID codec_id; /* see CODEC_ID_xxx */
1394 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1395 * This is used to work around some encoder bugs.
1396 * A demuxer should set this to what is stored in the field used to identify the codec.
1397 * If there are multiple such fields in a container then the demuxer should choose the one
1398 * which maximizes the information about the used codec.
1399 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1400 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1401 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1403 * - encoding: Set by user, if not then the default based on codec_id will be used.
1404 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1406 unsigned int codec_tag;
1409 * Work around bugs in encoders which sometimes cannot be detected automatically.
1410 * - encoding: Set by user
1411 * - decoding: Set by user
1413 int workaround_bugs;
1414 #define FF_BUG_AUTODETECT 1 ///< autodetection
1415 #define FF_BUG_OLD_MSMPEG4 2
1416 #define FF_BUG_XVID_ILACE 4
1417 #define FF_BUG_UMP4 8
1418 #define FF_BUG_NO_PADDING 16
1419 #define FF_BUG_AMV 32
1420 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1421 #define FF_BUG_QPEL_CHROMA 64
1422 #define FF_BUG_STD_QPEL 128
1423 #define FF_BUG_QPEL_CHROMA2 256
1424 #define FF_BUG_DIRECT_BLOCKSIZE 512
1425 #define FF_BUG_EDGE 1024
1426 #define FF_BUG_HPEL_CHROMA 2048
1427 #define FF_BUG_DC_CLIP 4096
1428 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1429 #define FF_BUG_TRUNCATED 16384
1430 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1433 * luma single coefficient elimination threshold
1434 * - encoding: Set by user.
1435 * - decoding: unused
1437 int luma_elim_threshold;
1440 * chroma single coeff elimination threshold
1441 * - encoding: Set by user.
1442 * - decoding: unused
1444 int chroma_elim_threshold;
1447 * strictly follow the standard (MPEG4, ...).
1448 * - encoding: Set by user.
1449 * - decoding: Set by user.
1450 * Setting this to STRICT or higher means the encoder and decoder will
1451 * generally do stupid things, whereas setting it to unofficial or lower
1452 * will mean the encoder might produce output that is not supported by all
1453 * spec-compliant decoders. Decoders don't differentiate between normal,
1454 * unofficial and experimental (that is, they always try to decode things
1455 * when they can) unless they are explicitly asked to behave stupidly
1456 * (=strictly conform to the specs)
1458 int strict_std_compliance;
1459 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1460 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1461 #define FF_COMPLIANCE_NORMAL 0
1462 #if FF_API_INOFFICIAL
1463 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1465 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1466 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1469 * qscale offset between IP and B-frames
1470 * - encoding: Set by user.
1471 * - decoding: unused
1473 float b_quant_offset;
1476 * Error recognization; higher values will detect more errors but may
1477 * misdetect some more or less valid parts as errors.
1478 * - encoding: unused
1479 * - decoding: Set by user.
1481 int error_recognition;
1482 #define FF_ER_CAREFUL 1
1483 #define FF_ER_COMPLIANT 2
1484 #define FF_ER_AGGRESSIVE 3
1485 #define FF_ER_VERY_AGGRESSIVE 4
1488 * Called at the beginning of each frame to get a buffer for it.
1489 * If pic.reference is set then the frame will be read later by libavcodec.
1490 * avcodec_align_dimensions2() should be used to find the required width and
1491 * height, as they normally need to be rounded up to the next multiple of 16.
1492 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1493 * avcodec_default_get_buffer() instead of providing buffers allocated by
1495 * - encoding: unused
1496 * - decoding: Set by libavcodec, user can override.
1498 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1501 * Called to release buffers which were allocated with get_buffer.
1502 * A released buffer can be reused in get_buffer().
1503 * pic.data[*] must be set to NULL.
1504 * - encoding: unused
1505 * - decoding: Set by libavcodec, user can override.
1507 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1510 * Size of the frame reordering buffer in the decoder.
1511 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1512 * - encoding: Set by libavcodec.
1513 * - decoding: Set by libavcodec.
1518 * number of bytes per packet if constant and known or 0
1519 * Used by some WAV based audio codecs.
1523 int parse_only; /* - decoding only: If true, only parsing is done
1524 (function avcodec_parse_frame()). The frame
1525 data is returned. Only MPEG codecs support this now. */
1528 * 0-> h263 quant 1-> mpeg quant
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * pass1 encoding statistics output buffer
1536 * - encoding: Set by libavcodec.
1537 * - decoding: unused
1542 * pass2 encoding statistics input buffer
1543 * Concatenated stuff from stats_out of pass1 should be placed here.
1544 * - encoding: Allocated/set/freed by user.
1545 * - decoding: unused
1550 * ratecontrol qmin qmax limiting method
1551 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1552 * - encoding: Set by user.
1553 * - decoding: unused
1561 * ratecontrol override, see RcOverride
1562 * - encoding: Allocated/set/freed by user.
1563 * - decoding: unused
1565 RcOverride *rc_override;
1566 int rc_override_count;
1569 * rate control equation
1570 * - encoding: Set by user
1571 * - decoding: unused
1577 * - encoding: Set by user.
1578 * - decoding: unused
1584 * - encoding: Set by user.
1585 * - decoding: unused
1590 * decoder bitstream buffer size
1591 * - encoding: Set by user.
1592 * - decoding: unused
1595 float rc_buffer_aggressivity;
1598 * qscale factor between P and I-frames
1599 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1600 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1601 * - encoding: Set by user.
1602 * - decoding: unused
1604 float i_quant_factor;
1607 * qscale offset between P and I-frames
1608 * - encoding: Set by user.
1609 * - decoding: unused
1611 float i_quant_offset;
1614 * initial complexity for pass1 ratecontrol
1615 * - encoding: Set by user.
1616 * - decoding: unused
1618 float rc_initial_cplx;
1621 * DCT algorithm, see FF_DCT_* below
1622 * - encoding: Set by user.
1623 * - decoding: unused
1626 #define FF_DCT_AUTO 0
1627 #define FF_DCT_FASTINT 1
1628 #define FF_DCT_INT 2
1629 #define FF_DCT_MMX 3
1630 #define FF_DCT_MLIB 4
1631 #define FF_DCT_ALTIVEC 5
1632 #define FF_DCT_FAAN 6
1635 * luminance masking (0-> disabled)
1636 * - encoding: Set by user.
1637 * - decoding: unused
1642 * temporary complexity masking (0-> disabled)
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 float temporal_cplx_masking;
1649 * spatial complexity masking (0-> disabled)
1650 * - encoding: Set by user.
1651 * - decoding: unused
1653 float spatial_cplx_masking;
1656 * p block masking (0-> disabled)
1657 * - encoding: Set by user.
1658 * - decoding: unused
1663 * darkness masking (0-> disabled)
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * IDCT algorithm, see FF_IDCT_* below.
1671 * - encoding: Set by user.
1672 * - decoding: Set by user.
1675 #define FF_IDCT_AUTO 0
1676 #define FF_IDCT_INT 1
1677 #define FF_IDCT_SIMPLE 2
1678 #define FF_IDCT_SIMPLEMMX 3
1679 #define FF_IDCT_LIBMPEG2MMX 4
1680 #define FF_IDCT_PS2 5
1681 #define FF_IDCT_MLIB 6
1682 #define FF_IDCT_ARM 7
1683 #define FF_IDCT_ALTIVEC 8
1684 #define FF_IDCT_SH4 9
1685 #define FF_IDCT_SIMPLEARM 10
1686 #define FF_IDCT_H264 11
1687 #define FF_IDCT_VP3 12
1688 #define FF_IDCT_IPP 13
1689 #define FF_IDCT_XVIDMMX 14
1690 #define FF_IDCT_CAVS 15
1691 #define FF_IDCT_SIMPLEARMV5TE 16
1692 #define FF_IDCT_SIMPLEARMV6 17
1693 #define FF_IDCT_SIMPLEVIS 18
1694 #define FF_IDCT_WMV2 19
1695 #define FF_IDCT_FAAN 20
1696 #define FF_IDCT_EA 21
1697 #define FF_IDCT_SIMPLENEON 22
1698 #define FF_IDCT_SIMPLEALPHA 23
1699 #define FF_IDCT_BINK 24
1703 * - encoding: Set by libavcodec.
1704 * - decoding: Set by user (or 0).
1708 * slice offsets in the frame in bytes
1709 * - encoding: Set/allocated by libavcodec.
1710 * - decoding: Set/allocated by user (or NULL).
1715 * error concealment flags
1716 * - encoding: unused
1717 * - decoding: Set by user.
1719 int error_concealment;
1720 #define FF_EC_GUESS_MVS 1
1721 #define FF_EC_DEBLOCK 2
1724 * dsp_mask could be add used to disable unwanted CPU features
1725 * CPU features (i.e. MMX, SSE. ...)
1727 * With the FORCE flag you may instead enable given CPU features.
1728 * (Dangerous: Usable in case of misdetection, improper usage however will
1729 * result into program crash.)
1734 #define FF_MM_FORCE AV_CPU_FLAG_FORCE
1735 #define FF_MM_MMX AV_CPU_FLAG_MMX
1736 #define FF_MM_3DNOW AV_CPU_FLAG_3DNOW
1737 #define FF_MM_MMXEXT AV_CPU_FLAG_MMX2
1738 #define FF_MM_MMX2 AV_CPU_FLAG_MMX2
1739 #define FF_MM_SSE AV_CPU_FLAG_SSE
1740 #define FF_MM_SSE2 AV_CPU_FLAG_SSE2
1741 #define FF_MM_SSE2SLOW AV_CPU_FLAG_SSE2SLOW
1742 #define FF_MM_3DNOWEXT AV_CPU_FLAG_3DNOWEXT
1743 #define FF_MM_SSE3 AV_CPU_FLAG_SSE3
1744 #define FF_MM_SSE3SLOW AV_CPU_FLAG_SSE3SLOW
1745 #define FF_MM_SSSE3 AV_CPU_FLAG_SSSE3
1746 #define FF_MM_SSE4 AV_CPU_FLAG_SSE4
1747 #define FF_MM_SSE42 AV_CPU_FLAG_SSE42
1748 #define FF_MM_IWMMXT AV_CPU_FLAG_IWMMXT
1749 #define FF_MM_ALTIVEC AV_CPU_FLAG_ALTIVEC
1753 * bits per sample/pixel from the demuxer (needed for huffyuv).
1754 * - encoding: Set by libavcodec.
1755 * - decoding: Set by user.
1757 int bits_per_coded_sample;
1760 * prediction method (needed for huffyuv)
1761 * - encoding: Set by user.
1762 * - decoding: unused
1764 int prediction_method;
1765 #define FF_PRED_LEFT 0
1766 #define FF_PRED_PLANE 1
1767 #define FF_PRED_MEDIAN 2
1770 * sample aspect ratio (0 if unknown)
1771 * That is the width of a pixel divided by the height of the pixel.
1772 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1773 * - encoding: Set by user.
1774 * - decoding: Set by libavcodec.
1776 AVRational sample_aspect_ratio;
1779 * the picture in the bitstream
1780 * - encoding: Set by libavcodec.
1781 * - decoding: Set by libavcodec.
1783 AVFrame *coded_frame;
1787 * - encoding: Set by user.
1788 * - decoding: Set by user.
1791 #define FF_DEBUG_PICT_INFO 1
1792 #define FF_DEBUG_RC 2
1793 #define FF_DEBUG_BITSTREAM 4
1794 #define FF_DEBUG_MB_TYPE 8
1795 #define FF_DEBUG_QP 16
1796 #define FF_DEBUG_MV 32
1797 #define FF_DEBUG_DCT_COEFF 0x00000040
1798 #define FF_DEBUG_SKIP 0x00000080
1799 #define FF_DEBUG_STARTCODE 0x00000100
1800 #define FF_DEBUG_PTS 0x00000200
1801 #define FF_DEBUG_ER 0x00000400
1802 #define FF_DEBUG_MMCO 0x00000800
1803 #define FF_DEBUG_BUGS 0x00001000
1804 #define FF_DEBUG_VIS_QP 0x00002000
1805 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1806 #define FF_DEBUG_BUFFERS 0x00008000
1810 * - encoding: Set by user.
1811 * - decoding: Set by user.
1814 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1815 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1816 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1820 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1821 * - decoding: unused
1826 * minimum MB quantizer
1827 * - encoding: unused
1828 * - decoding: unused
1833 * maximum MB quantizer
1834 * - encoding: unused
1835 * - decoding: unused
1840 * motion estimation comparison function
1841 * - encoding: Set by user.
1842 * - decoding: unused
1846 * subpixel motion estimation comparison function
1847 * - encoding: Set by user.
1848 * - decoding: unused
1852 * macroblock comparison function (not supported yet)
1853 * - encoding: Set by user.
1854 * - decoding: unused
1858 * interlaced DCT comparison function
1859 * - encoding: Set by user.
1860 * - decoding: unused
1863 #define FF_CMP_SAD 0
1864 #define FF_CMP_SSE 1
1865 #define FF_CMP_SATD 2
1866 #define FF_CMP_DCT 3
1867 #define FF_CMP_PSNR 4
1868 #define FF_CMP_BIT 5
1870 #define FF_CMP_ZERO 7
1871 #define FF_CMP_VSAD 8
1872 #define FF_CMP_VSSE 9
1873 #define FF_CMP_NSSE 10
1874 #define FF_CMP_W53 11
1875 #define FF_CMP_W97 12
1876 #define FF_CMP_DCTMAX 13
1877 #define FF_CMP_DCT264 14
1878 #define FF_CMP_CHROMA 256
1881 * ME diamond size & shape
1882 * - encoding: Set by user.
1883 * - decoding: unused
1888 * amount of previous MV predictors (2a+1 x 2a+1 square)
1889 * - encoding: Set by user.
1890 * - decoding: unused
1892 int last_predictor_count;
1895 * prepass for motion estimation
1896 * - encoding: Set by user.
1897 * - decoding: unused
1902 * motion estimation prepass comparison function
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * ME prepass diamond size & shape
1910 * - encoding: Set by user.
1911 * - decoding: unused
1917 * - encoding: Set by user.
1918 * - decoding: unused
1920 int me_subpel_quality;
1923 * callback to negotiate the pixelFormat
1924 * @param fmt is the list of formats which are supported by the codec,
1925 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1926 * The first is always the native one.
1927 * @return the chosen format
1928 * - encoding: unused
1929 * - decoding: Set by user, if not set the native format will be chosen.
1931 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1934 * DTG active format information (additional aspect ratio
1935 * information only used in DVB MPEG-2 transport streams)
1938 * - encoding: unused
1939 * - decoding: Set by decoder.
1941 int dtg_active_format;
1942 #define FF_DTG_AFD_SAME 8
1943 #define FF_DTG_AFD_4_3 9
1944 #define FF_DTG_AFD_16_9 10
1945 #define FF_DTG_AFD_14_9 11
1946 #define FF_DTG_AFD_4_3_SP_14_9 13
1947 #define FF_DTG_AFD_16_9_SP_14_9 14
1948 #define FF_DTG_AFD_SP_4_3 15
1951 * maximum motion estimation search range in subpel units
1952 * If 0 then no limit.
1954 * - encoding: Set by user.
1955 * - decoding: unused
1960 * intra quantizer bias
1961 * - encoding: Set by user.
1962 * - decoding: unused
1964 int intra_quant_bias;
1965 #define FF_DEFAULT_QUANT_BIAS 999999
1968 * inter quantizer bias
1969 * - encoding: Set by user.
1970 * - decoding: unused
1972 int inter_quant_bias;
1976 * - encoding: unused
1977 * - decoding: Which clrtable should be used for 8bit RGB images.
1978 * Tables have to be stored somewhere. FIXME
1983 * internal_buffer count
1984 * Don't touch, used by libavcodec default_get_buffer().
1986 int internal_buffer_count;
1990 * Don't touch, used by libavcodec default_get_buffer().
1992 void *internal_buffer;
1995 * Global quality for codecs which cannot change it per frame.
1996 * This should be proportional to MPEG-1/2/4 qscale.
1997 * - encoding: Set by user.
1998 * - decoding: unused
2002 #define FF_CODER_TYPE_VLC 0
2003 #define FF_CODER_TYPE_AC 1
2004 #define FF_CODER_TYPE_RAW 2
2005 #define FF_CODER_TYPE_RLE 3
2006 #define FF_CODER_TYPE_DEFLATE 4
2009 * - encoding: Set by user.
2010 * - decoding: unused
2016 * - encoding: Set by user.
2017 * - decoding: unused
2023 * - encoding: unused
2024 * - decoding: Set by user.
2026 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2031 * - encoding: unused
2032 * - decoding: Set by user.
2035 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2036 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2037 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2040 * XVideo Motion Acceleration
2041 * - encoding: forbidden
2042 * - decoding: set by decoder
2044 int xvmc_acceleration;
2047 * macroblock decision mode
2048 * - encoding: Set by user.
2049 * - decoding: unused
2052 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2053 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2054 #define FF_MB_DECISION_RD 2 ///< rate distortion
2057 * custom intra quantization matrix
2058 * - encoding: Set by user, can be NULL.
2059 * - decoding: Set by libavcodec.
2061 uint16_t *intra_matrix;
2064 * custom inter quantization matrix
2065 * - encoding: Set by user, can be NULL.
2066 * - decoding: Set by libavcodec.
2068 uint16_t *inter_matrix;
2071 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2072 * This is used to work around some encoder bugs.
2073 * - encoding: unused
2074 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2076 unsigned int stream_codec_tag;
2079 * scene change detection threshold
2080 * 0 is default, larger means fewer detected scene changes.
2081 * - encoding: Set by user.
2082 * - decoding: unused
2084 int scenechange_threshold;
2087 * minimum Lagrange multipler
2088 * - encoding: Set by user.
2089 * - decoding: unused
2094 * maximum Lagrange multipler
2095 * - encoding: Set by user.
2096 * - decoding: unused
2100 #if FF_API_PALETTE_CONTROL
2102 * palette control structure
2103 * - encoding: ??? (no palette-enabled encoder yet)
2104 * - decoding: Set by user.
2106 struct AVPaletteControl *palctrl;
2110 * noise reduction strength
2111 * - encoding: Set by user.
2112 * - decoding: unused
2114 int noise_reduction;
2117 * Called at the beginning of a frame to get cr buffer for it.
2118 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2119 * libavcodec will pass previous buffer in pic, function should return
2120 * same buffer or new buffer with old frame "painted" into it.
2121 * If pic.data[0] == NULL must behave like get_buffer().
2122 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2123 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2125 * - encoding: unused
2126 * - decoding: Set by libavcodec, user can override.
2128 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2131 * Number of bits which should be loaded into the rc buffer before decoding starts.
2132 * - encoding: Set by user.
2133 * - decoding: unused
2135 int rc_initial_buffer_occupancy;
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int inter_threshold;
2146 * - encoding: Set by user.
2147 * - decoding: Set by user.
2152 * Simulates errors in the bitstream to test error concealment.
2153 * - encoding: Set by user.
2154 * - decoding: unused
2159 * MP3 antialias algorithm, see FF_AA_* below.
2160 * - encoding: unused
2161 * - decoding: Set by user.
2164 #define FF_AA_AUTO 0
2165 #define FF_AA_FASTINT 1 //not implemented yet
2167 #define FF_AA_FLOAT 3
2169 * quantizer noise shaping
2170 * - encoding: Set by user.
2171 * - decoding: unused
2173 int quantizer_noise_shaping;
2177 * is used to decide how many independent tasks should be passed to execute()
2178 * - encoding: Set by user.
2179 * - decoding: Set by user.
2184 * The codec may call this to execute several independent things.
2185 * It will return only after finishing all tasks.
2186 * The user may replace this with some multithreaded implementation,
2187 * the default implementation will execute the parts serially.
2188 * @param count the number of things to execute
2189 * - encoding: Set by libavcodec, user can override.
2190 * - decoding: Set by libavcodec, user can override.
2192 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2196 * Can be used by execute() to store some per AVCodecContext stuff.
2197 * - encoding: set by execute()
2198 * - decoding: set by execute()
2200 void *thread_opaque;
2203 * Motion estimation threshold below which no motion estimation is
2204 * performed, but instead the user specified motion vectors are used.
2206 * - encoding: Set by user.
2207 * - decoding: unused
2212 * Macroblock threshold below which the user specified macroblock types will be used.
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * precision of the intra DC coefficient - 8
2220 * - encoding: Set by user.
2221 * - decoding: unused
2223 int intra_dc_precision;
2226 * noise vs. sse weight for the nsse comparsion function
2227 * - encoding: Set by user.
2228 * - decoding: unused
2233 * Number of macroblock rows at the top which are skipped.
2234 * - encoding: unused
2235 * - decoding: Set by user.
2240 * Number of macroblock rows at the bottom which are skipped.
2241 * - encoding: unused
2242 * - decoding: Set by user.
2248 * - encoding: Set by user.
2249 * - decoding: Set by libavcodec.
2252 #define FF_PROFILE_UNKNOWN -99
2254 #define FF_PROFILE_AAC_MAIN 0
2255 #define FF_PROFILE_AAC_LOW 1
2256 #define FF_PROFILE_AAC_SSR 2
2257 #define FF_PROFILE_AAC_LTP 3
2259 #define FF_PROFILE_DTS 20
2260 #define FF_PROFILE_DTS_ES 30
2261 #define FF_PROFILE_DTS_96_24 40
2262 #define FF_PROFILE_DTS_HD_HRA 50
2263 #define FF_PROFILE_DTS_HD_MA 60
2265 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2266 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2268 #define FF_PROFILE_H264_BASELINE 66
2269 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2270 #define FF_PROFILE_H264_MAIN 77
2271 #define FF_PROFILE_H264_EXTENDED 88
2272 #define FF_PROFILE_H264_HIGH 100
2273 #define FF_PROFILE_H264_HIGH_10 110
2274 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2275 #define FF_PROFILE_H264_HIGH_422 122
2276 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2277 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2278 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2279 #define FF_PROFILE_H264_CAVLC_444 44
2283 * - encoding: Set by user.
2284 * - decoding: Set by libavcodec.
2287 #define FF_LEVEL_UNKNOWN -99
2290 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2291 * - encoding: unused
2292 * - decoding: Set by user.
2297 * Bitstream width / height, may be different from width/height if lowres
2298 * or other things are used.
2299 * - encoding: unused
2300 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2302 int coded_width, coded_height;
2305 * frame skip threshold
2306 * - encoding: Set by user.
2307 * - decoding: unused
2309 int frame_skip_threshold;
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int frame_skip_factor;
2319 * frame skip exponent
2320 * - encoding: Set by user.
2321 * - decoding: unused
2326 * frame skip comparison function
2327 * - encoding: Set by user.
2328 * - decoding: unused
2333 * Border processing masking, raises the quantizer for mbs on the borders
2335 * - encoding: Set by user.
2336 * - decoding: unused
2338 float border_masking;
2341 * minimum MB lagrange multipler
2342 * - encoding: Set by user.
2343 * - decoding: unused
2348 * maximum MB lagrange multipler
2349 * - encoding: Set by user.
2350 * - decoding: unused
2356 * - encoding: Set by user.
2357 * - decoding: unused
2359 int me_penalty_compensation;
2363 * - encoding: unused
2364 * - decoding: Set by user.
2366 enum AVDiscard skip_loop_filter;
2370 * - encoding: unused
2371 * - decoding: Set by user.
2373 enum AVDiscard skip_idct;
2377 * - encoding: unused
2378 * - decoding: Set by user.
2380 enum AVDiscard skip_frame;
2384 * - encoding: Set by user.
2385 * - decoding: unused
2391 * - encoding: Set by user.
2392 * - decoding: unused
2397 * constant rate factor - quality-based VBR - values ~correspond to qps
2398 * - encoding: Set by user.
2399 * - decoding: unused
2404 * constant quantization parameter rate control method
2405 * - encoding: Set by user.
2406 * - decoding: unused
2412 * - encoding: Set by user.
2413 * - decoding: unused
2418 * number of reference frames
2419 * - encoding: Set by user.
2420 * - decoding: Set by lavc.
2425 * chroma qp offset from luma
2426 * - encoding: Set by user.
2427 * - decoding: unused
2432 * Influences how often B-frames are used.
2433 * - encoding: Set by user.
2434 * - decoding: unused
2439 * trellis RD quantization
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * Reduce fluctuations in qp (before curve compression).
2447 * - encoding: Set by user.
2448 * - decoding: unused
2450 float complexityblur;
2453 * in-loop deblocking filter alphac0 parameter
2454 * alpha is in the range -6...6
2455 * - encoding: Set by user.
2456 * - decoding: unused
2461 * in-loop deblocking filter beta parameter
2462 * beta is in the range -6...6
2463 * - encoding: Set by user.
2464 * - decoding: unused
2469 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2470 * - encoding: Set by user.
2471 * - decoding: unused
2474 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2475 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2476 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2477 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2478 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2481 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2482 * - encoding: Set by user.
2483 * - decoding: unused
2488 * Audio cutoff bandwidth (0 means "automatic")
2489 * - encoding: Set by user.
2490 * - decoding: unused
2495 * Multiplied by qscale for each frame and added to scene_change_score.
2496 * - encoding: Set by user.
2497 * - decoding: unused
2499 int scenechange_factor;
2503 * Note: Value depends upon the compare function used for fullpel ME.
2504 * - encoding: Set by user.
2505 * - decoding: unused
2510 * Adjusts sensitivity of b_frame_strategy 1.
2511 * - encoding: Set by user.
2512 * - decoding: unused
2517 * - encoding: Set by user.
2518 * - decoding: unused
2520 int compression_level;
2521 #define FF_COMPRESSION_DEFAULT -1
2525 * Sets whether to use LPC mode - used by FLAC encoder.
2526 * - encoding: Set by user.
2527 * - decoding: unused
2528 * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2534 * LPC coefficient precision - used by FLAC encoder
2535 * - encoding: Set by user.
2536 * - decoding: unused
2538 int lpc_coeff_precision;
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 int min_prediction_order;
2547 * - encoding: Set by user.
2548 * - decoding: unused
2550 int max_prediction_order;
2553 * search method for selecting prediction order
2554 * - encoding: Set by user.
2555 * - decoding: unused
2557 int prediction_order_method;
2560 * - encoding: Set by user.
2561 * - decoding: unused
2563 int min_partition_order;
2566 * - encoding: Set by user.
2567 * - decoding: unused
2569 int max_partition_order;
2572 * GOP timecode frame start number, in non drop frame format
2573 * - encoding: Set by user.
2574 * - decoding: unused
2576 int64_t timecode_frame_start;
2578 #if LIBAVCODEC_VERSION_MAJOR < 53
2580 * Decoder should decode to this many channels if it can (0 for default)
2581 * - encoding: unused
2582 * - decoding: Set by user.
2583 * @deprecated Deprecated in favor of request_channel_layout.
2585 int request_channels;
2589 * Percentage of dynamic range compression to be applied by the decoder.
2590 * The default value is 1.0, corresponding to full compression.
2591 * - encoding: unused
2592 * - decoding: Set by user.
2597 * opaque 64bit number (generally a PTS) that will be reordered and
2598 * output in AVFrame.reordered_opaque
2599 * @deprecated in favor of pkt_pts
2600 * - encoding: unused
2601 * - decoding: Set by user.
2603 int64_t reordered_opaque;
2606 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2607 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2608 * - encoding: set by user.
2609 * - decoding: set by libavcodec.
2611 int bits_per_raw_sample;
2614 * Audio channel layout.
2615 * - encoding: set by user.
2616 * - decoding: set by libavcodec.
2618 int64_t channel_layout;
2621 * Request decoder to use this channel layout if it can (0 for default)
2622 * - encoding: unused
2623 * - decoding: Set by user.
2625 int64_t request_channel_layout;
2628 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2629 * - encoding: Set by user.
2630 * - decoding: unused.
2632 float rc_max_available_vbv_use;
2635 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2636 * - encoding: Set by user.
2637 * - decoding: unused.
2639 float rc_min_vbv_overflow_use;
2642 * Hardware accelerator in use
2643 * - encoding: unused.
2644 * - decoding: Set by libavcodec
2646 struct AVHWAccel *hwaccel;
2649 * For some codecs, the time base is closer to the field rate than the frame rate.
2650 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2651 * if no telecine is used ...
2653 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2655 int ticks_per_frame;
2658 * Hardware accelerator context.
2659 * For some hardware accelerators, a global context needs to be
2660 * provided by the user. In that case, this holds display-dependent
2661 * data FFmpeg cannot instantiate itself. Please refer to the
2662 * FFmpeg HW accelerator documentation to know how to fill this
2663 * is. e.g. for VA API, this is a struct vaapi_context.
2664 * - encoding: unused
2665 * - decoding: Set by user
2667 void *hwaccel_context;
2670 * Chromaticity coordinates of the source primaries.
2671 * - encoding: Set by user
2672 * - decoding: Set by libavcodec
2674 enum AVColorPrimaries color_primaries;
2677 * Color Transfer Characteristic.
2678 * - encoding: Set by user
2679 * - decoding: Set by libavcodec
2681 enum AVColorTransferCharacteristic color_trc;
2684 * YUV colorspace type.
2685 * - encoding: Set by user
2686 * - decoding: Set by libavcodec
2688 enum AVColorSpace colorspace;
2691 * MPEG vs JPEG YUV range.
2692 * - encoding: Set by user
2693 * - decoding: Set by libavcodec
2695 enum AVColorRange color_range;
2698 * This defines the location of chroma samples.
2699 * - encoding: Set by user
2700 * - decoding: Set by libavcodec
2702 enum AVChromaLocation chroma_sample_location;
2705 * The codec may call this to execute several independent things.
2706 * It will return only after finishing all tasks.
2707 * The user may replace this with some multithreaded implementation,
2708 * the default implementation will execute the parts serially.
2709 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2710 * @param c context passed also to func
2711 * @param count the number of things to execute
2712 * @param arg2 argument passed unchanged to func
2713 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2714 * @param func function that will be called count times, with jobnr from 0 to count-1.
2715 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2716 * two instances of func executing at the same time will have the same threadnr.
2717 * @return always 0 currently, but code should handle a future improvement where when any call to func
2718 * returns < 0 no further calls to func may be done and < 0 is returned.
2719 * - encoding: Set by libavcodec, user can override.
2720 * - decoding: Set by libavcodec, user can override.
2722 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2725 * explicit P-frame weighted prediction analysis method
2727 * 1: fast blind weighting (one reference duplicate with -1 offset)
2728 * 2: smart weighting (full fade detection analysis)
2729 * - encoding: Set by user.
2730 * - decoding: unused
2732 int weighted_p_pred;
2737 * 1: Variance AQ (complexity mask)
2738 * 2: Auto-variance AQ (experimental)
2739 * - encoding: Set by user
2740 * - decoding: unused
2746 * Reduces blocking and blurring in flat and textured areas.
2747 * - encoding: Set by user
2748 * - decoding: unused
2754 * Strength of psychovisual optimization
2755 * - encoding: Set by user
2756 * - decoding: unused
2762 * Strength of psychovisual optimization
2763 * - encoding: Set by user
2764 * - decoding: unused
2770 * Number of frames for frametype and ratecontrol lookahead
2771 * - encoding: Set by user
2772 * - decoding: unused
2777 * Constant rate factor maximum
2778 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2779 * than crf_max, even if doing so would violate VBV restrictions.
2780 * - encoding: Set by user.
2781 * - decoding: unused
2785 int log_level_offset;
2788 * Determines which LPC analysis algorithm to use.
2789 * - encoding: Set by user
2790 * - decoding: unused
2792 enum AVLPCType lpc_type;
2795 * Number of passes to use for Cholesky factorization during LPC analysis
2796 * - encoding: Set by user
2797 * - decoding: unused
2803 * Indicates number of picture subdivisions. Used for parallelized
2805 * - encoding: Set by user
2806 * - decoding: unused
2811 * Header containing style information for text subtitles.
2812 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2813 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2814 * the Format line following. It shouldn't include any Dialogue line.
2815 * - encoding: Set/allocated/freed by user (before avcodec_open())
2816 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2818 uint8_t *subtitle_header;
2819 int subtitle_header_size;
2822 * Current packet as passed into the decoder, to avoid having
2823 * to pass the packet into every function. Currently only valid
2824 * inside lavc and get/release_buffer callbacks.
2825 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2826 * - encoding: unused
2834 typedef struct AVProfile {
2836 const char *name; ///< short name for the profile
2842 typedef struct AVCodec {
2844 * Name of the codec implementation.
2845 * The name is globally unique among encoders and among decoders (but an
2846 * encoder and a decoder can share the same name).
2847 * This is the primary way to find a codec from the user perspective.
2850 enum AVMediaType type;
2853 int (*init)(AVCodecContext *);
2854 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2855 int (*close)(AVCodecContext *);
2856 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2858 * Codec capabilities.
2862 struct AVCodec *next;
2865 * Will be called when seeking
2867 void (*flush)(AVCodecContext *);
2868 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2869 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2871 * Descriptive name for the codec, meant to be more human readable than name.
2872 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2874 const char *long_name;
2875 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2876 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2877 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2878 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2879 AVClass *priv_class; ///< AVClass for the private context
2880 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2886 typedef struct AVHWAccel {
2888 * Name of the hardware accelerated codec.
2889 * The name is globally unique among encoders and among decoders (but an
2890 * encoder and a decoder can share the same name).
2895 * Type of codec implemented by the hardware accelerator.
2897 * See AVMEDIA_TYPE_xxx
2899 enum AVMediaType type;
2902 * Codec implemented by the hardware accelerator.
2909 * Supported pixel format.
2911 * Only hardware accelerated formats are supported here.
2913 enum PixelFormat pix_fmt;
2916 * Hardware accelerated codec capabilities.
2917 * see FF_HWACCEL_CODEC_CAP_*
2921 struct AVHWAccel *next;
2924 * Called at the beginning of each frame or field picture.
2926 * Meaningful frame information (codec specific) is guaranteed to
2927 * be parsed at this point. This function is mandatory.
2929 * Note that buf can be NULL along with buf_size set to 0.
2930 * Otherwise, this means the whole frame is available at this point.
2932 * @param avctx the codec context
2933 * @param buf the frame data buffer base
2934 * @param buf_size the size of the frame in bytes
2935 * @return zero if successful, a negative value otherwise
2937 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2940 * Callback for each slice.
2942 * Meaningful slice information (codec specific) is guaranteed to
2943 * be parsed at this point. This function is mandatory.
2945 * @param avctx the codec context
2946 * @param buf the slice data buffer base
2947 * @param buf_size the size of the slice in bytes
2948 * @return zero if successful, a negative value otherwise
2950 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2953 * Called at the end of each frame or field picture.
2955 * The whole picture is parsed at this point and can now be sent
2956 * to the hardware accelerator. This function is mandatory.
2958 * @param avctx the codec context
2959 * @return zero if successful, a negative value otherwise
2961 int (*end_frame)(AVCodecContext *avctx);
2964 * Size of HW accelerator private data.
2966 * Private data is allocated with av_mallocz() before
2967 * AVCodecContext.get_buffer() and deallocated after
2968 * AVCodecContext.release_buffer().
2974 * four components are given, that's all.
2975 * the last component is alpha
2977 typedef struct AVPicture {
2979 int linesize[4]; ///< number of bytes per line
2982 #if FF_API_PALETTE_CONTROL
2985 * This structure defines a method for communicating palette changes
2986 * between and demuxer and a decoder.
2988 * @deprecated Use AVPacket to send palette changes instead.
2989 * This is totally broken.
2991 #define AVPALETTE_SIZE 1024
2992 #define AVPALETTE_COUNT 256
2993 typedef struct AVPaletteControl {
2995 /* Demuxer sets this to 1 to indicate the palette has changed;
2996 * decoder resets to 0. */
2997 int palette_changed;
2999 /* 4-byte ARGB palette entries, stored in native byte order; note that
3000 * the individual palette components should be on a 8-bit scale; if
3001 * the palette data comes from an IBM VGA native format, the component
3002 * data is probably 6 bits in size and needs to be scaled. */
3003 unsigned int palette[AVPALETTE_COUNT];
3005 } AVPaletteControl attribute_deprecated;
3008 enum AVSubtitleType {
3011 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3014 * Plain text, the text field must be set by the decoder and is
3015 * authoritative. ass and pict fields may contain approximations.
3020 * Formatted text, the ass field must be set by the decoder and is
3021 * authoritative. pict and text fields may contain approximations.
3026 typedef struct AVSubtitleRect {
3027 int x; ///< top left corner of pict, undefined when pict is not set
3028 int y; ///< top left corner of pict, undefined when pict is not set
3029 int w; ///< width of pict, undefined when pict is not set
3030 int h; ///< height of pict, undefined when pict is not set
3031 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3034 * data+linesize for the bitmap of this subtitle.
3035 * can be set for text/ass as well once they where rendered
3038 enum AVSubtitleType type;
3040 char *text; ///< 0 terminated plain UTF-8 text
3043 * 0 terminated ASS/SSA compatible event line.
3044 * The pressentation of this is unaffected by the other values in this
3050 typedef struct AVSubtitle {
3051 uint16_t format; /* 0 = graphics */
3052 uint32_t start_display_time; /* relative to packet pts, in ms */
3053 uint32_t end_display_time; /* relative to packet pts, in ms */
3055 AVSubtitleRect **rects;
3056 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3059 /* packet functions */
3062 * @deprecated use NULL instead
3064 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3067 * Default packet destructor.
3069 void av_destruct_packet(AVPacket *pkt);
3072 * Initialize optional fields of a packet with default values.
3076 void av_init_packet(AVPacket *pkt);
3079 * Allocate the payload of a packet and initialize its fields with
3083 * @param size wanted payload size
3084 * @return 0 if OK, AVERROR_xxx otherwise
3086 int av_new_packet(AVPacket *pkt, int size);
3089 * Reduce packet size, correctly zeroing padding
3092 * @param size new size
3094 void av_shrink_packet(AVPacket *pkt, int size);
3097 * Increase packet size, correctly zeroing padding
3100 * @param grow_by number of bytes by which to increase the size of the packet
3102 int av_grow_packet(AVPacket *pkt, int grow_by);
3105 * @warning This is a hack - the packet memory allocation stuff is broken. The
3106 * packet is allocated if it was not really allocated.
3108 int av_dup_packet(AVPacket *pkt);
3113 * @param pkt packet to free
3115 void av_free_packet(AVPacket *pkt);
3119 struct ReSampleContext;
3120 struct AVResampleContext;
3122 typedef struct ReSampleContext ReSampleContext;
3124 #if FF_API_AUDIO_OLD
3126 * @deprecated Use av_audio_resample_init() instead.
3128 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3129 int output_rate, int input_rate);
3132 * Initialize audio resampling context
3134 * @param output_channels number of output channels
3135 * @param input_channels number of input channels
3136 * @param output_rate output sample rate
3137 * @param input_rate input sample rate
3138 * @param sample_fmt_out requested output sample format
3139 * @param sample_fmt_in input sample format
3140 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3141 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3142 * @param linear If 1 then the used FIR filter will be linearly interpolated
3143 between the 2 closest, if 0 the closest will be used
3144 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3145 * @return allocated ReSampleContext, NULL if error occured
3147 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3148 int output_rate, int input_rate,
3149 enum AVSampleFormat sample_fmt_out,
3150 enum AVSampleFormat sample_fmt_in,
3151 int filter_length, int log2_phase_count,
3152 int linear, double cutoff);
3154 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3155 void audio_resample_close(ReSampleContext *s);
3159 * Initialize an audio resampler.
3160 * Note, if either rate is not an integer then simply scale both rates up so they are.
3161 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3162 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3163 * @param linear If 1 then the used FIR filter will be linearly interpolated
3164 between the 2 closest, if 0 the closest will be used
3165 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3167 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3170 * Resample an array of samples using a previously configured context.
3171 * @param src an array of unconsumed samples
3172 * @param consumed the number of samples of src which have been consumed are returned here
3173 * @param src_size the number of unconsumed samples available
3174 * @param dst_size the amount of space in samples available in dst
3175 * @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.
3176 * @return the number of samples written in dst or -1 if an error occurred
3178 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3182 * Compensate samplerate/timestamp drift. The compensation is done by changing
3183 * the resampler parameters, so no audible clicks or similar distortions occur
3184 * @param compensation_distance distance in output samples over which the compensation should be performed
3185 * @param sample_delta number of output samples which should be output less
3187 * example: av_resample_compensate(c, 10, 500)
3188 * here instead of 510 samples only 500 samples would be output
3190 * note, due to rounding the actual compensation might be slightly different,
3191 * especially if the compensation_distance is large and the in_rate used during init is small
3193 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3194 void av_resample_close(struct AVResampleContext *c);
3197 * Allocate memory for a picture. Call avpicture_free to free it.
3199 * @param picture the picture to be filled in
3200 * @param pix_fmt the format of the picture
3201 * @param width the width of the picture
3202 * @param height the height of the picture
3203 * @return zero if successful, a negative value if not
3205 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3208 * Free a picture previously allocated by avpicture_alloc().
3210 * @param picture the AVPicture to be freed
3212 void avpicture_free(AVPicture *picture);
3215 * Fill in the AVPicture fields.
3216 * The fields of the given AVPicture are filled in by using the 'ptr' address
3217 * which points to the image data buffer. Depending on the specified picture
3218 * format, one or multiple image data pointers and line sizes will be set.
3219 * If a planar format is specified, several pointers will be set pointing to
3220 * the different picture planes and the line sizes of the different planes
3221 * will be stored in the lines_sizes array.
3222 * Call with ptr == NULL to get the required size for the ptr buffer.
3224 * @param picture AVPicture whose fields are to be filled in
3225 * @param ptr Buffer which will contain or contains the actual image data
3226 * @param pix_fmt The format in which the picture data is stored.
3227 * @param width the width of the image in pixels
3228 * @param height the height of the image in pixels
3229 * @return size of the image data in bytes
3231 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3232 enum PixelFormat pix_fmt, int width, int height);
3233 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3234 unsigned char *dest, int dest_size);
3237 * Calculate the size in bytes that a picture of the given width and height
3238 * would occupy if stored in the given picture format.
3239 * Note that this returns the size of a compact representation as generated
3240 * by avpicture_layout, which can be smaller than the size required for e.g.
3243 * @param pix_fmt the given picture format
3244 * @param width the width of the image
3245 * @param height the height of the image
3246 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3248 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3249 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3250 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3251 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3253 #if LIBAVCODEC_VERSION_MAJOR < 53
3255 * Return the pixel format corresponding to the name name.
3257 * If there is no pixel format with name name, then look for a
3258 * pixel format with the name corresponding to the native endian
3260 * For example in a little-endian system, first look for "gray16",
3261 * then for "gray16le".
3263 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3265 * @deprecated Deprecated in favor of av_get_pix_fmt().
3267 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3271 * Return a value representing the fourCC code associated to the
3272 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3275 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3278 * Put a string representing the codec tag codec_tag in buf.
3280 * @param buf_size size in bytes of buf
3281 * @return the length of the string that would have been generated if
3282 * enough space had been available, excluding the trailing null
3284 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3286 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3287 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3288 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3289 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3290 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3291 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3294 * Compute what kind of losses will occur when converting from one specific
3295 * pixel format to another.
3296 * When converting from one pixel format to another, information loss may occur.
3297 * For example, when converting from RGB24 to GRAY, the color information will
3298 * be lost. Similarly, other losses occur when converting from some formats to
3299 * other formats. These losses can involve loss of chroma, but also loss of
3300 * resolution, loss of color depth, loss due to the color space conversion, loss
3301 * of the alpha bits or loss due to color quantization.
3302 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3303 * which will occur when converting from one pixel format to another.
3305 * @param[in] dst_pix_fmt destination pixel format
3306 * @param[in] src_pix_fmt source pixel format
3307 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3308 * @return Combination of flags informing you what kind of losses will occur.
3310 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3314 * Find the best pixel format to convert to given a certain source pixel
3315 * format. When converting from one pixel format to another, information loss
3316 * may occur. For example, when converting from RGB24 to GRAY, the color
3317 * information will be lost. Similarly, other losses occur when converting from
3318 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3319 * the given pixel formats should be used to suffer the least amount of loss.
3320 * The pixel formats from which it chooses one, are determined by the
3321 * pix_fmt_mask parameter.
3324 * src_pix_fmt = PIX_FMT_YUV420P;
3325 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3326 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3329 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3330 * @param[in] src_pix_fmt source pixel format
3331 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3332 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3333 * @return The best pixel format to convert to or -1 if none was found.
3335 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3336 int has_alpha, int *loss_ptr);
3338 #if LIBAVCODEC_VERSION_MAJOR < 53
3340 * @deprecated Use av_get_pix_fmt_string() instead.
3342 attribute_deprecated
3343 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3346 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3347 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3350 * Tell if an image really has transparent alpha values.
3351 * @return ored mask of FF_ALPHA_xxx constants
3353 int img_get_alpha_info(const AVPicture *src,
3354 enum PixelFormat pix_fmt, int width, int height);
3356 /* deinterlace a picture */
3357 /* deinterlace - if not supported return -1 */
3358 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3359 enum PixelFormat pix_fmt, int width, int height);
3361 /* external high level API */
3364 * If c is NULL, returns the first registered codec,
3365 * if c is non-NULL, returns the next registered codec after c,
3366 * or NULL if c is the last one.
3368 AVCodec *av_codec_next(AVCodec *c);
3371 * Return the LIBAVCODEC_VERSION_INT constant.
3373 unsigned avcodec_version(void);
3376 * Return the libavcodec build-time configuration.
3378 const char *avcodec_configuration(void);
3381 * Return the libavcodec license.
3383 const char *avcodec_license(void);
3386 * Initialize libavcodec.
3388 * @warning This function must be called before any other libavcodec
3391 void avcodec_init(void);
3393 #if LIBAVCODEC_VERSION_MAJOR < 53
3395 * @deprecated Deprecated in favor of avcodec_register().
3397 attribute_deprecated void register_avcodec(AVCodec *codec);
3401 * Register the codec codec and initialize libavcodec.
3403 * @see avcodec_init()
3405 void avcodec_register(AVCodec *codec);
3408 * Find a registered encoder with a matching codec ID.
3410 * @param id CodecID of the requested encoder
3411 * @return An encoder if one was found, NULL otherwise.
3413 AVCodec *avcodec_find_encoder(enum CodecID id);
3416 * Find a registered encoder with the specified name.
3418 * @param name name of the requested encoder
3419 * @return An encoder if one was found, NULL otherwise.
3421 AVCodec *avcodec_find_encoder_by_name(const char *name);
3424 * Find a registered decoder with a matching codec ID.
3426 * @param id CodecID of the requested decoder
3427 * @return A decoder if one was found, NULL otherwise.
3429 AVCodec *avcodec_find_decoder(enum CodecID id);
3432 * Find a registered decoder with the specified name.
3434 * @param name name of the requested decoder
3435 * @return A decoder if one was found, NULL otherwise.
3437 AVCodec *avcodec_find_decoder_by_name(const char *name);
3438 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3441 * Return a name for the specified profile, if available.
3443 * @param codec the codec that is searched for the given profile
3444 * @param profile the profile value for which a name is requested
3445 * @return A name for the profile if found, NULL otherwise.
3447 const char *av_get_profile_name(const AVCodec *codec, int profile);
3450 * Set the fields of the given AVCodecContext to default values.
3452 * @param s The AVCodecContext of which the fields should be set to default values.
3454 void avcodec_get_context_defaults(AVCodecContext *s);
3456 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3457 * we WILL change its arguments and name a few times! */
3458 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3460 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3461 * we WILL change its arguments and name a few times! */
3462 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3465 * Allocate an AVCodecContext and set its fields to default values. The
3466 * resulting struct can be deallocated by simply calling av_free().
3468 * @return An AVCodecContext filled with default values or NULL on failure.
3469 * @see avcodec_get_context_defaults
3471 AVCodecContext *avcodec_alloc_context(void);
3473 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3474 * we WILL change its arguments and name a few times! */
3475 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3477 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3478 * we WILL change its arguments and name a few times! */
3479 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3482 * Copy the settings of the source AVCodecContext into the destination
3483 * AVCodecContext. The resulting destination codec context will be
3484 * unopened, i.e. you are required to call avcodec_open() before you
3485 * can use this AVCodecContext to decode/encode video/audio data.
3487 * @param dest target codec context, should be initialized with
3488 * avcodec_alloc_context(), but otherwise uninitialized
3489 * @param src source codec context
3490 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3492 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3495 * Set the fields of the given AVFrame to default values.
3497 * @param pic The AVFrame of which the fields should be set to default values.
3499 void avcodec_get_frame_defaults(AVFrame *pic);
3502 * Allocate an AVFrame and set its fields to default values. The resulting
3503 * struct can be deallocated by simply calling av_free().
3505 * @return An AVFrame filled with default values or NULL on failure.
3506 * @see avcodec_get_frame_defaults
3508 AVFrame *avcodec_alloc_frame(void);
3510 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3511 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3512 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3515 * Return the amount of padding in pixels which the get_buffer callback must
3516 * provide around the edge of the image for codecs which do not have the
3517 * CODEC_FLAG_EMU_EDGE flag.
3519 * @return Required padding in pixels.
3521 unsigned avcodec_get_edge_width(void);
3523 * Modify width and height values so that they will result in a memory
3524 * buffer that is acceptable for the codec if you do not use any horizontal
3527 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3528 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3529 * according to avcodec_get_edge_width() before.
3531 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3533 * Modify width and height values so that they will result in a memory
3534 * buffer that is acceptable for the codec if you also ensure that all
3535 * line sizes are a multiple of the respective linesize_align[i].
3537 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3538 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3539 * according to avcodec_get_edge_width() before.
3541 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3542 int linesize_align[4]);
3544 #if LIBAVCODEC_VERSION_MAJOR < 53
3546 * @deprecated Deprecated in favor of av_check_image_size().
3548 attribute_deprecated
3549 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3552 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3554 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3555 void avcodec_thread_free(AVCodecContext *s);
3556 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3557 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3558 //FIXME func typedef
3561 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3562 * function the context has to be allocated.
3564 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3565 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3566 * retrieving a codec.
3568 * @warning This function is not thread safe!
3571 * avcodec_register_all();
3572 * codec = avcodec_find_decoder(CODEC_ID_H264);
3576 * context = avcodec_alloc_context();
3578 * if (avcodec_open(context, codec) < 0)
3582 * @param avctx The context which will be set up to use the given codec.
3583 * @param codec The codec to use within the context.
3584 * @return zero on success, a negative value on error
3585 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3587 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3589 #if FF_API_AUDIO_OLD
3591 * Decode an audio frame from buf into samples.
3592 * Wrapper function which calls avcodec_decode_audio3.
3594 * @deprecated Use avcodec_decode_audio3 instead.
3595 * @param avctx the codec context
3596 * @param[out] samples the output buffer
3597 * @param[in,out] frame_size_ptr the output buffer size in bytes
3598 * @param[in] buf the input buffer
3599 * @param[in] buf_size the input buffer size in bytes
3600 * @return On error a negative value is returned, otherwise the number of bytes
3601 * used or zero if no frame could be decompressed.
3603 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3604 int *frame_size_ptr,
3605 const uint8_t *buf, int buf_size);
3609 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3610 * Some decoders may support multiple frames in a single AVPacket, such
3611 * decoders would then just decode the first frame. In this case,
3612 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3613 * the remaining data in order to decode the second frame etc.
3615 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3616 * decompressed frame size in bytes.
3618 * @warning You must set frame_size_ptr to the allocated size of the
3619 * output buffer before calling avcodec_decode_audio3().
3621 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3622 * the actual read bytes because some optimized bitstream readers read 32 or 64
3623 * bits at once and could read over the end.
3625 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3626 * no overreading happens for damaged MPEG streams.
3628 * @note You might have to align the input buffer avpkt->data and output buffer
3629 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3630 * necessary at all, on others it won't work at all if not aligned and on others
3631 * it will work but it will have an impact on performance.
3633 * In practice, avpkt->data should have 4 byte alignment at minimum and
3634 * samples should be 16 byte aligned unless the CPU doesn't need it
3635 * (AltiVec and SSE do).
3637 * @param avctx the codec context
3638 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3639 * @param[in,out] frame_size_ptr the output buffer size in bytes
3640 * @param[in] avpkt The input AVPacket containing the input buffer.
3641 * You can create such packet with av_init_packet() and by then setting
3642 * data and size, some decoders might in addition need other fields.
3643 * All decoders are designed to use the least fields possible though.
3644 * @return On error a negative value is returned, otherwise the number of bytes
3645 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3647 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3648 int *frame_size_ptr,
3651 #if FF_API_VIDEO_OLD
3653 * Decode a video frame from buf into picture.
3654 * Wrapper function which calls avcodec_decode_video2.
3656 * @deprecated Use avcodec_decode_video2 instead.
3657 * @param avctx the codec context
3658 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3659 * @param[in] buf the input buffer
3660 * @param[in] buf_size the size of the input buffer in bytes
3661 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3662 * @return On error a negative value is returned, otherwise the number of bytes
3663 * used or zero if no frame could be decompressed.
3665 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3666 int *got_picture_ptr,
3667 const uint8_t *buf, int buf_size);
3671 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3672 * Some decoders may support multiple frames in a single AVPacket, such
3673 * decoders would then just decode the first frame.
3675 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3676 * the actual read bytes because some optimized bitstream readers read 32 or 64
3677 * bits at once and could read over the end.
3679 * @warning The end of the input buffer buf should be set to 0 to ensure that
3680 * no overreading happens for damaged MPEG streams.
3682 * @note You might have to align the input buffer avpkt->data.
3683 * The alignment requirements depend on the CPU: on some CPUs it isn't
3684 * necessary at all, on others it won't work at all if not aligned and on others
3685 * it will work but it will have an impact on performance.
3687 * In practice, avpkt->data should have 4 byte alignment at minimum.
3689 * @note Some codecs have a delay between input and output, these need to be
3690 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3692 * @param avctx the codec context
3693 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3694 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3695 * allocate memory for the actual bitmap.
3696 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3697 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3698 * decodes and the decoder tells the user once it does not need the data anymore,
3699 * the user app can at this point free/reuse/keep the memory as it sees fit.
3701 * @param[in] avpkt The input AVpacket containing the input buffer.
3702 * You can create such packet with av_init_packet() and by then setting
3703 * data and size, some decoders might in addition need other fields like
3704 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3706 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3707 * @return On error a negative value is returned, otherwise the number of bytes
3708 * used or zero if no frame could be decompressed.
3710 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3711 int *got_picture_ptr,
3714 #if FF_API_SUBTITLE_OLD
3715 /* Decode a subtitle message. Return -1 if error, otherwise return the
3716 * number of bytes used. If no subtitle could be decompressed,
3717 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3718 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3720 const uint8_t *buf, int buf_size);
3724 * Decode a subtitle message.
3725 * Return a negative value on error, otherwise return the number of bytes used.
3726 * If no subtitle could be decompressed, got_sub_ptr is zero.
3727 * Otherwise, the subtitle is stored in *sub.
3728 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3729 * simplicity, because the performance difference is expect to be negligible
3730 * and reusing a get_buffer written for video codecs would probably perform badly
3731 * due to a potentially very different allocation pattern.
3733 * @param avctx the codec context
3734 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3735 freed with avsubtitle_free if *got_sub_ptr is set.
3736 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3737 * @param[in] avpkt The input AVPacket containing the input buffer.
3739 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3744 * Frees all allocated data in the given subtitle struct.
3746 * @param sub AVSubtitle to free.
3748 void avsubtitle_free(AVSubtitle *sub);
3750 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3752 uint8_t *buf, int buf_size);
3755 * Encode an audio frame from samples into buf.
3757 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3758 * However, for PCM audio the user will know how much space is needed
3759 * because it depends on the value passed in buf_size as described
3760 * below. In that case a lower value can be used.
3762 * @param avctx the codec context
3763 * @param[out] buf the output buffer
3764 * @param[in] buf_size the output buffer size
3765 * @param[in] samples the input buffer containing the samples
3766 * The number of samples read from this buffer is frame_size*channels,
3767 * both of which are defined in avctx.
3768 * For PCM audio the number of samples read from samples is equal to
3769 * buf_size * input_sample_size / output_sample_size.
3770 * @return On error a negative value is returned, on success zero or the number
3771 * of bytes used to encode the data read from the input buffer.
3773 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3774 const short *samples);
3777 * Encode a video frame from pict into buf.
3778 * The input picture should be
3779 * stored using a specific format, namely avctx.pix_fmt.
3781 * @param avctx the codec context
3782 * @param[out] buf the output buffer for the bitstream of encoded frame
3783 * @param[in] buf_size the size of the output buffer in bytes
3784 * @param[in] pict the input picture to encode
3785 * @return On error a negative value is returned, on success zero or the number
3786 * of bytes used from the output buffer.
3788 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3789 const AVFrame *pict);
3790 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3791 const AVSubtitle *sub);
3793 int avcodec_close(AVCodecContext *avctx);
3796 * Register all the codecs, parsers and bitstream filters which were enabled at
3797 * configuration time. If you do not call this function you can select exactly
3798 * which formats you want to support, by using the individual registration
3801 * @see avcodec_register
3802 * @see av_register_codec_parser
3803 * @see av_register_bitstream_filter
3805 void avcodec_register_all(void);
3808 * Flush buffers, should be called when seeking or when switching to a different stream.
3810 void avcodec_flush_buffers(AVCodecContext *avctx);
3812 void avcodec_default_free_buffers(AVCodecContext *s);
3814 /* misc useful functions */
3817 * Return a single letter to describe the given picture type pict_type.
3819 * @param[in] pict_type the picture type
3820 * @return A single character representing the picture type.
3822 char av_get_pict_type_char(int pict_type);
3825 * Return codec bits per sample.
3827 * @param[in] codec_id the codec
3828 * @return Number of bits per sample or zero if unknown for the given codec.
3830 int av_get_bits_per_sample(enum CodecID codec_id);
3832 #if FF_API_OLD_SAMPLE_FMT
3834 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3836 attribute_deprecated
3837 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3841 typedef struct AVCodecParserContext {
3843 struct AVCodecParser *parser;
3844 int64_t frame_offset; /* offset of the current frame */
3845 int64_t cur_offset; /* current offset
3846 (incremented by each av_parser_parse()) */
3847 int64_t next_frame_offset; /* offset of the next frame */
3849 int pict_type; /* XXX: Put it back in AVCodecContext. */
3851 * This field is used for proper frame duration computation in lavf.
3852 * It signals, how much longer the frame duration of the current frame
3853 * is compared to normal frame duration.
3855 * frame_duration = (1 + repeat_pict) * time_base
3857 * It is used by codecs like H.264 to display telecined material.
3859 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3860 int64_t pts; /* pts of the current frame */
3861 int64_t dts; /* dts of the current frame */
3866 int fetch_timestamp;
3868 #define AV_PARSER_PTS_NB 4
3869 int cur_frame_start_index;
3870 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3871 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3872 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3875 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3876 #define PARSER_FLAG_ONCE 0x0002
3877 /// Set if the parser has a valid file offset
3878 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3880 int64_t offset; ///< byte offset from starting packet start
3881 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3884 * Set by parser to 1 for key frames and 0 for non-key frames.
3885 * It is initialized to -1, so if the parser doesn't set this flag,
3886 * old-style fallback using FF_I_TYPE picture type as key frames
3892 * Time difference in stream time base units from the pts of this
3893 * packet to the point at which the output from the decoder has converged
3894 * independent from the availability of previous frames. That is, the
3895 * frames are virtually identical no matter if decoding started from
3896 * the very first frame or from this keyframe.
3897 * Is AV_NOPTS_VALUE if unknown.
3898 * This field is not the display duration of the current frame.
3899 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3902 * The purpose of this field is to allow seeking in streams that have no
3903 * keyframes in the conventional sense. It corresponds to the
3904 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3905 * essential for some types of subtitle streams to ensure that all
3906 * subtitles are correctly displayed after seeking.
3908 int64_t convergence_duration;
3910 // Timestamp generation support:
3912 * Synchronization point for start of timestamp generation.
3914 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3917 * For example, this corresponds to presence of H.264 buffering period
3923 * Offset of the current timestamp against last timestamp sync point in
3924 * units of AVCodecContext.time_base.
3926 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3927 * contain a valid timestamp offset.
3929 * Note that the timestamp of sync point has usually a nonzero
3930 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3931 * the next frame after timestamp sync point will be usually 1.
3933 * For example, this corresponds to H.264 cpb_removal_delay.
3935 int dts_ref_dts_delta;
3938 * Presentation delay of current frame in units of AVCodecContext.time_base.
3940 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3941 * contain valid non-negative timestamp delta (presentation time of a frame
3942 * must not lie in the past).
3944 * This delay represents the difference between decoding and presentation
3945 * time of the frame.
3947 * For example, this corresponds to H.264 dpb_output_delay.
3952 * Position of the packet in file.
3954 * Analogous to cur_frame_pts/dts
3956 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3959 * Byte position of currently parsed frame in stream.
3964 * Previous frame byte position.
3967 } AVCodecParserContext;
3969 typedef struct AVCodecParser {
3970 int codec_ids[5]; /* several codec IDs are permitted */
3972 int (*parser_init)(AVCodecParserContext *s);
3973 int (*parser_parse)(AVCodecParserContext *s,
3974 AVCodecContext *avctx,
3975 const uint8_t **poutbuf, int *poutbuf_size,
3976 const uint8_t *buf, int buf_size);
3977 void (*parser_close)(AVCodecParserContext *s);
3978 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3979 struct AVCodecParser *next;
3982 AVCodecParser *av_parser_next(AVCodecParser *c);
3984 void av_register_codec_parser(AVCodecParser *parser);
3985 AVCodecParserContext *av_parser_init(int codec_id);
3987 #if LIBAVCODEC_VERSION_MAJOR < 53
3988 attribute_deprecated
3989 int av_parser_parse(AVCodecParserContext *s,
3990 AVCodecContext *avctx,
3991 uint8_t **poutbuf, int *poutbuf_size,
3992 const uint8_t *buf, int buf_size,
3993 int64_t pts, int64_t dts);
3999 * @param s parser context.
4000 * @param avctx codec context.
4001 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4002 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4003 * @param buf input buffer.
4004 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4005 * @param pts input presentation timestamp.
4006 * @param dts input decoding timestamp.
4007 * @param pos input byte position in stream.
4008 * @return the number of bytes of the input bitstream used.
4013 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4020 * decode_frame(data, size);
4024 int av_parser_parse2(AVCodecParserContext *s,
4025 AVCodecContext *avctx,
4026 uint8_t **poutbuf, int *poutbuf_size,
4027 const uint8_t *buf, int buf_size,
4028 int64_t pts, int64_t dts,
4031 int av_parser_change(AVCodecParserContext *s,
4032 AVCodecContext *avctx,
4033 uint8_t **poutbuf, int *poutbuf_size,
4034 const uint8_t *buf, int buf_size, int keyframe);
4035 void av_parser_close(AVCodecParserContext *s);
4038 typedef struct AVBitStreamFilterContext {
4040 struct AVBitStreamFilter *filter;
4041 AVCodecParserContext *parser;
4042 struct AVBitStreamFilterContext *next;
4043 } AVBitStreamFilterContext;
4046 typedef struct AVBitStreamFilter {
4049 int (*filter)(AVBitStreamFilterContext *bsfc,
4050 AVCodecContext *avctx, const char *args,
4051 uint8_t **poutbuf, int *poutbuf_size,
4052 const uint8_t *buf, int buf_size, int keyframe);
4053 void (*close)(AVBitStreamFilterContext *bsfc);
4054 struct AVBitStreamFilter *next;
4055 } AVBitStreamFilter;
4057 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4058 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4059 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4060 AVCodecContext *avctx, const char *args,
4061 uint8_t **poutbuf, int *poutbuf_size,
4062 const uint8_t *buf, int buf_size, int keyframe);
4063 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4065 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4070 * Reallocate the given block if it is not large enough, otherwise do nothing.
4074 void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4077 * Allocate a buffer, reusing the given one if large enough.
4079 * Contrary to av_fast_realloc the current buffer contents might not be
4080 * preserved and on error the old buffer is freed, thus no special
4081 * handling to avoid memleaks is necessary.
4083 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4084 * @param size size of the buffer *ptr points to
4085 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4086 * *size 0 if an error occurred.
4088 void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4090 #if LIBAVCODEC_VERSION_MAJOR < 53
4092 * @deprecated Deprecated in favor of av_image_copy().
4094 attribute_deprecated
4095 void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4096 uint8_t *src_data[4], int src_linesize[4],
4097 enum PixelFormat pix_fmt, int width, int height);
4101 * Copy image src to dst. Wraps av_picture_data_copy() above.
4103 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4104 enum PixelFormat pix_fmt, int width, int height);
4107 * Crop image top and left side.
4109 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4110 enum PixelFormat pix_fmt, int top_band, int left_band);
4115 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4116 int padtop, int padbottom, int padleft, int padright, int *color);
4119 * Encode extradata length to a buffer. Used by xiph codecs.
4121 * @param s buffer to write to; must be at least (v/255+1) bytes long
4122 * @param v size of extradata in bytes
4123 * @return number of bytes written to the buffer.
4125 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4127 #if LIBAVCODEC_VERSION_MAJOR < 53
4129 * Parse str and put in width_ptr and height_ptr the detected values.
4131 * @deprecated Deprecated in favor of av_parse_video_size().
4133 attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4136 * Parse str and store the detected values in *frame_rate.
4138 * @deprecated Deprecated in favor of av_parse_video_rate().
4140 attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4144 * Logs a generic warning message about a missing feature. This function is
4145 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4146 * only, and would normally not be used by applications.
4147 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4148 * a pointer to an AVClass struct
4149 * @param[in] feature string containing the name of the missing feature
4150 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4151 * If want_sample is non-zero, additional verbage will be added to the log
4152 * message which tells the user how to report samples to the development
4155 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4158 * Log a generic warning message asking for a sample. This function is
4159 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4160 * only, and would normally not be used by applications.
4161 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4162 * a pointer to an AVClass struct
4163 * @param[in] msg string containing an optional message, or NULL if no message
4165 void av_log_ask_for_sample(void *avc, const char *msg);
4168 * Register the hardware accelerator hwaccel.
4170 void av_register_hwaccel(AVHWAccel *hwaccel);
4173 * If hwaccel is NULL, returns the first registered hardware accelerator,
4174 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4175 * after hwaccel, or NULL if hwaccel is the last one.
4177 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4181 * Lock operation used by lockmgr
4184 AV_LOCK_CREATE, ///< Create a mutex
4185 AV_LOCK_OBTAIN, ///< Lock the mutex
4186 AV_LOCK_RELEASE, ///< Unlock the mutex
4187 AV_LOCK_DESTROY, ///< Free mutex resources
4191 * Register a user provided lock manager supporting the operations
4192 * specified by AVLockOp. mutex points to a (void *) where the
4193 * lockmgr should store/get a pointer to a user allocated mutex. It's
4194 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4196 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4197 * callback during the call to av_lockmgr_register().
4198 * Thus, the application must be prepared to handle that.
4199 * If cb is set to NULL the lockmgr will be unregistered.
4200 * Also note that during unregistration the previously registered
4201 * lockmgr callback may also be invoked.
4203 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4205 #endif /* AVCODEC_AVCODEC_H */