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 "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
34 #define LIBAVCODEC_VERSION_MAJOR 52
35 #define LIBAVCODEC_VERSION_MINOR 114
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,
266 /* various PCM "codecs" */
267 CODEC_ID_PCM_S16LE= 0x10000,
283 CODEC_ID_PCM_S24DAUD,
285 CODEC_ID_PCM_S16LE_PLANAR,
294 /* various ADPCM codecs */
295 CODEC_ID_ADPCM_IMA_QT= 0x11000,
296 CODEC_ID_ADPCM_IMA_WAV,
297 CODEC_ID_ADPCM_IMA_DK3,
298 CODEC_ID_ADPCM_IMA_DK4,
299 CODEC_ID_ADPCM_IMA_WS,
300 CODEC_ID_ADPCM_IMA_SMJPEG,
309 CODEC_ID_ADPCM_YAMAHA,
310 CODEC_ID_ADPCM_SBPRO_4,
311 CODEC_ID_ADPCM_SBPRO_3,
312 CODEC_ID_ADPCM_SBPRO_2,
314 CODEC_ID_ADPCM_IMA_AMV,
315 CODEC_ID_ADPCM_EA_R1,
316 CODEC_ID_ADPCM_EA_R3,
317 CODEC_ID_ADPCM_EA_R2,
318 CODEC_ID_ADPCM_IMA_EA_SEAD,
319 CODEC_ID_ADPCM_IMA_EA_EACS,
320 CODEC_ID_ADPCM_EA_XAS,
321 CODEC_ID_ADPCM_EA_MAXIS_XA,
322 CODEC_ID_ADPCM_IMA_ISS,
326 CODEC_ID_AMR_NB= 0x12000,
329 /* RealAudio codecs*/
330 CODEC_ID_RA_144= 0x13000,
333 /* various DPCM codecs */
334 CODEC_ID_ROQ_DPCM= 0x14000,
335 CODEC_ID_INTERPLAY_DPCM,
340 CODEC_ID_MP2= 0x15000,
341 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
359 CODEC_ID_WESTWOOD_SND1,
360 CODEC_ID_GSM, ///< as in Berlin toast format
368 CODEC_ID_DSICINAUDIO,
372 CODEC_ID_GSM_MS, /* as found in WAV */
381 CODEC_ID_WMALOSSLESS,
390 CODEC_ID_BINKAUDIO_RDFT,
391 CODEC_ID_BINKAUDIO_DCT,
395 /* subtitle codecs */
396 CODEC_ID_DVD_SUBTITLE= 0x17000,
397 CODEC_ID_DVB_SUBTITLE,
398 CODEC_ID_TEXT, ///< raw UTF-8 text
402 CODEC_ID_HDMV_PGS_SUBTITLE,
403 CODEC_ID_DVB_TELETEXT,
406 /* other specific kind of codecs (generally used for attachments) */
407 CODEC_ID_TTF= 0x18000,
409 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
411 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
412 * stream (only used by libavformat) */
413 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
416 #if LIBAVCODEC_VERSION_MAJOR < 53
417 #define CodecType AVMediaType
419 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
420 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
421 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
422 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
423 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
424 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
425 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
428 #if FF_API_OLD_SAMPLE_FMT
429 #define SampleFormat AVSampleFormat
431 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
432 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
433 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
434 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
435 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
436 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
437 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
440 #if FF_API_OLD_AUDIOCONVERT
441 #include "libavutil/audioconvert.h"
443 /* Audio channel masks */
444 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
445 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
446 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
447 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
448 #define CH_BACK_LEFT AV_CH_BACK_LEFT
449 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
450 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
451 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
452 #define CH_BACK_CENTER AV_CH_BACK_CENTER
453 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
454 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
455 #define CH_TOP_CENTER AV_CH_TOP_CENTER
456 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
457 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
458 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
459 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
460 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
461 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
462 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
463 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
465 /** Channel mask value used for AVCodecContext.request_channel_layout
466 to indicate that the user requests the channel order of the decoder output
467 to be the native codec channel order. */
468 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
470 /* Audio channel convenience macros */
471 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
472 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
473 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
474 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
475 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
476 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
477 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
478 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
479 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
480 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
481 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
482 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
483 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
484 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
485 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
489 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
492 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
493 * This is mainly needed because some optimized bitstream readers read
494 * 32 or 64 bit at once and could read over the end.<br>
495 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
496 * MPEG bitstreams could cause overread and segfault.
498 #define FF_INPUT_BUFFER_PADDING_SIZE 8
501 * minimum encoding buffer size
502 * Used to avoid some checks during header writing.
504 #define FF_MIN_BUFFER_SIZE 16384
508 * motion estimation type.
511 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
515 ME_EPZS, ///< enhanced predictive zonal search
516 ME_X1, ///< reserved for experiments
517 ME_HEX, ///< hexagon based search
518 ME_UMH, ///< uneven multi-hexagon search
519 ME_ITER, ///< iterative search
520 ME_TESA, ///< transformed exhaustive search algorithm
524 /* We leave some space between them for extensions (drop some
525 * keyframes for intra-only or drop just some bidir frames). */
526 AVDISCARD_NONE =-16, ///< discard nothing
527 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
528 AVDISCARD_NONREF = 8, ///< discard all non reference
529 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
530 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
531 AVDISCARD_ALL = 48, ///< discard all
534 enum AVColorPrimaries{
535 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
536 AVCOL_PRI_UNSPECIFIED=2,
538 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
539 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
540 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
542 AVCOL_PRI_NB , ///< Not part of ABI
545 enum AVColorTransferCharacteristic{
546 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
547 AVCOL_TRC_UNSPECIFIED=2,
548 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
549 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
550 AVCOL_TRC_NB , ///< Not part of ABI
555 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
556 AVCOL_SPC_UNSPECIFIED=2,
558 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
559 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
560 AVCOL_SPC_SMPTE240M =7,
561 AVCOL_SPC_NB , ///< Not part of ABI
565 AVCOL_RANGE_UNSPECIFIED=0,
566 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
567 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
568 AVCOL_RANGE_NB , ///< Not part of ABI
572 * X X 3 4 X X are luma samples,
573 * 1 2 1-6 are possible chroma positions
574 * X X 5 6 X 0 is undefined/unknown position
576 enum AVChromaLocation{
577 AVCHROMA_LOC_UNSPECIFIED=0,
578 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
579 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
580 AVCHROMA_LOC_TOPLEFT =3, ///< DV
582 AVCHROMA_LOC_BOTTOMLEFT =5,
583 AVCHROMA_LOC_BOTTOM =6,
584 AVCHROMA_LOC_NB , ///< Not part of ABI
591 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
592 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
593 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
594 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
595 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
596 AV_LPC_TYPE_NB , ///< Not part of ABI
599 typedef struct RcOverride{
602 int qscale; // If this is 0 then quality_factor will be used instead.
603 float quality_factor;
606 #define FF_MAX_B_FRAMES 16
609 These flags can be passed in AVCodecContext.flags before initialization.
610 Note: Not everything is supported yet.
613 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
614 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
615 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
616 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
617 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
618 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
620 * The parent program guarantees that the input for B-frames containing
621 * streams is not written to for at least s->max_b_frames+1 frames, if
622 * this is not set the input will be copied.
624 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
625 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
626 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
627 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
628 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
629 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
630 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
631 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
632 location instead of only at frame boundaries. */
633 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
634 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
635 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
636 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
637 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
638 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
639 /* Fx : Flag for h263+ extra options */
640 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
641 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
642 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
643 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
644 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
645 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
646 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
647 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
648 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
649 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
650 #define CODEC_FLAG_CLOSED_GOP 0x80000000
651 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
652 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
653 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
654 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
655 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
656 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
657 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
658 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
659 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
660 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
661 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
662 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
663 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
664 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
665 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
666 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
667 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
668 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
669 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
670 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
671 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
672 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
674 /* Unsupported options :
675 * Syntax Arithmetic coding (SAC)
676 * Reference Picture Selection
677 * Independent Segment Decoding */
679 /* codec capabilities */
681 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
683 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
684 * If not set, it might not use get_buffer() at all or use operations that
685 * assume the buffer was allocated by avcodec_default_get_buffer.
687 #define CODEC_CAP_DR1 0x0002
688 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
689 #define CODEC_CAP_PARSE_ONLY 0x0004
690 #define CODEC_CAP_TRUNCATED 0x0008
691 /* Codec can export data for HW decoding (XvMC). */
692 #define CODEC_CAP_HWACCEL 0x0010
694 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
695 * If this is not set, the codec is guaranteed to never be fed with NULL data.
697 #define CODEC_CAP_DELAY 0x0020
699 * Codec can be fed a final frame with a smaller size.
700 * This can be used to prevent truncation of the last audio samples.
702 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
704 * Codec can export data for HW decoding (VDPAU).
706 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
708 * Codec can output multiple frames per AVPacket
709 * Normally demuxers return one frame at a time, demuxers which do not do
710 * are connected to a parser to split what they return into proper frames.
711 * This flag is reserved to the very rare category of codecs which have a
712 * bitstream that cannot be split into frames without timeconsuming
713 * operations like full decoding. Demuxers carring such bitstreams thus
714 * may return multiple frames in a packet. This has many disadvantages like
715 * prohibiting stream copy in many cases thus it should only be considered
718 #define CODEC_CAP_SUBFRAMES 0x0100
720 * Codec is experimental and is thus avoided in favor of non experimental
723 #define CODEC_CAP_EXPERIMENTAL 0x0200
725 * Codec should fill in channel configuration and samplerate instead of container
727 #define CODEC_CAP_CHANNEL_CONF 0x0400
729 * Codec is able to deal with negative linesizes
731 #define CODEC_CAP_NEG_LINESIZES 0x0800
733 * Codec supports frame-level multithreading.
735 #define CODEC_CAP_FRAME_THREADS 0x1000
737 //The following defines may change, don't expect compatibility if you use them.
738 #define MB_TYPE_INTRA4x4 0x0001
739 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
740 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
741 #define MB_TYPE_16x16 0x0008
742 #define MB_TYPE_16x8 0x0010
743 #define MB_TYPE_8x16 0x0020
744 #define MB_TYPE_8x8 0x0040
745 #define MB_TYPE_INTERLACED 0x0080
746 #define MB_TYPE_DIRECT2 0x0100 //FIXME
747 #define MB_TYPE_ACPRED 0x0200
748 #define MB_TYPE_GMC 0x0400
749 #define MB_TYPE_SKIP 0x0800
750 #define MB_TYPE_P0L0 0x1000
751 #define MB_TYPE_P1L0 0x2000
752 #define MB_TYPE_P0L1 0x4000
753 #define MB_TYPE_P1L1 0x8000
754 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
755 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
756 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
757 #define MB_TYPE_QUANT 0x00010000
758 #define MB_TYPE_CBP 0x00020000
759 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
763 * This specifies the area which should be displayed.
764 * Note there may be multiple such areas for one frame.
766 typedef struct AVPanScan{
769 * - encoding: Set by user.
770 * - decoding: Set by libavcodec.
775 * width and height in 1/16 pel
776 * - encoding: Set by user.
777 * - decoding: Set by libavcodec.
783 * position of the top left corner in 1/16 pel for up to 3 fields/frames
784 * - encoding: Set by user.
785 * - decoding: Set by libavcodec.
787 int16_t position[3][2];
790 #define FF_COMMON_FRAME \
792 * pointer to the picture planes.\
793 * This might be different from the first allocated byte\
800 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
801 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
807 * 1 -> keyframe, 0-> not\
808 * - encoding: Set by libavcodec.\
809 * - decoding: Set by libavcodec.\
814 * Picture type of the frame, see ?_TYPE below.\
815 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
816 * - decoding: Set by libavcodec.\
821 * presentation timestamp in time_base units (time when frame should be shown to user)\
822 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
823 * - encoding: MUST be set by user.\
824 * - decoding: Set by libavcodec.\
829 * picture number in bitstream order\
830 * - encoding: set by\
831 * - decoding: Set by libavcodec.\
833 int coded_picture_number;\
835 * picture number in display order\
836 * - encoding: set by\
837 * - decoding: Set by libavcodec.\
839 int display_picture_number;\
842 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
843 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
844 * - decoding: Set by libavcodec.\
849 * buffer age (1->was last buffer and dint change, 2->..., ...).\
850 * Set to INT_MAX if the buffer has not been used yet.\
851 * - encoding: unused\
852 * - decoding: MUST be set by get_buffer().\
857 * is this picture used as reference\
858 * The values for this are the same as the MpegEncContext.picture_structure\
859 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
860 * Set to 4 for delayed, non-reference frames.\
861 * - encoding: unused\
862 * - decoding: Set by libavcodec. (before get_buffer() call)).\
868 * - encoding: unused\
869 * - decoding: Set by libavcodec.\
871 int8_t *qscale_table;\
874 * - encoding: unused\
875 * - decoding: Set by libavcodec.\
880 * mbskip_table[mb]>=1 if MB didn't change\
881 * stride= mb_width = (width+15)>>4\
882 * - encoding: unused\
883 * - decoding: Set by libavcodec.\
885 uint8_t *mbskip_table;\
888 * motion vector table\
891 * int mv_sample_log2= 4 - motion_subsample_log2;\
892 * int mb_width= (width+15)>>4;\
893 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
894 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
896 * - encoding: Set by user.\
897 * - decoding: Set by libavcodec.\
899 int16_t (*motion_val[2])[2];\
902 * macroblock type table\
903 * mb_type_base + mb_width + 2\
904 * - encoding: Set by user.\
905 * - decoding: Set by libavcodec.\
910 * log2 of the size of the block which a single vector in motion_val represents: \
911 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
912 * - encoding: unused\
913 * - decoding: Set by libavcodec.\
915 uint8_t motion_subsample_log2;\
918 * for some private data of the user\
919 * - encoding: unused\
920 * - decoding: Set by user.\
926 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
927 * - decoding: unused\
932 * type of the buffer (to keep track of who has to deallocate data[*])\
933 * - encoding: Set by the one who allocates it.\
934 * - decoding: Set by the one who allocates it.\
935 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
940 * When decoding, this signals how much the picture must be delayed.\
941 * extra_delay = repeat_pict / (2*fps)\
942 * - encoding: unused\
943 * - decoding: Set by libavcodec.\
953 * The content of the picture is interlaced.\
954 * - encoding: Set by user.\
955 * - decoding: Set by libavcodec. (default 0)\
957 int interlaced_frame;\
960 * If the content is interlaced, is top field displayed first.\
961 * - encoding: Set by user.\
962 * - decoding: Set by libavcodec.\
964 int top_field_first;\
968 * - encoding: Set by user.\
969 * - decoding: Set by libavcodec.\
971 AVPanScan *pan_scan;\
974 * Tell user application that palette has changed from previous frame.\
975 * - encoding: ??? (no palette-enabled encoder yet)\
976 * - decoding: Set by libavcodec. (default 0).\
978 int palette_has_changed;\
981 * codec suggestion on buffer type if != 0\
982 * - encoding: unused\
983 * - decoding: Set by libavcodec. (before get_buffer() call)).\
989 * - encoding: unused\
990 * - decoding: Set by libavcodec.\
995 * motion reference frame index\
996 * the order in which these are stored can depend on the codec.\
997 * - encoding: Set by user.\
998 * - decoding: Set by libavcodec.\
1000 int8_t *ref_index[2];\
1003 * reordered opaque 64bit (generally an integer or a double precision float\
1004 * PTS but can be anything). \
1005 * The user sets AVCodecContext.reordered_opaque to represent the input at\
1007 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
1008 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
1009 * @deprecated in favor of pkt_pts\
1010 * - encoding: unused\
1011 * - decoding: Read by user.\
1013 int64_t reordered_opaque;\
1016 * hardware accelerator private data (FFmpeg allocated)\
1017 * - encoding: unused\
1018 * - decoding: Set by libavcodec\
1020 void *hwaccel_picture_private;\
1023 * reordered pts from the last AVPacket that has been input into the decoder\
1024 * - encoding: unused\
1025 * - decoding: Read by user.\
1030 * dts from the last AVPacket that has been input into the decoder\
1031 * - encoding: unused\
1032 * - decoding: Read by user.\
1037 * the AVCodecContext which ff_thread_get_buffer() was last called on\
1038 * - encoding: Set by libavcodec.\
1039 * - decoding: Set by libavcodec.\
1041 struct AVCodecContext *owner;\
1044 * used by multithreading to store frame-specific info\
1045 * - encoding: Set by libavcodec.\
1046 * - decoding: Set by libavcodec.\
1048 void *thread_opaque;\
1050 #define FF_QSCALE_TYPE_MPEG1 0
1051 #define FF_QSCALE_TYPE_MPEG2 1
1052 #define FF_QSCALE_TYPE_H264 2
1053 #define FF_QSCALE_TYPE_VP56 3
1055 #define FF_BUFFER_TYPE_INTERNAL 1
1056 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1057 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1058 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1061 #define FF_I_TYPE 1 ///< Intra
1062 #define FF_P_TYPE 2 ///< Predicted
1063 #define FF_B_TYPE 3 ///< Bi-dir predicted
1064 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1065 #define FF_SI_TYPE 5 ///< Switching Intra
1066 #define FF_SP_TYPE 6 ///< Switching Predicted
1067 #define FF_BI_TYPE 7
1069 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1070 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1071 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1072 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1074 typedef struct AVPacket {
1076 * Presentation timestamp in AVStream->time_base units; the time at which
1077 * the decompressed packet will be presented to the user.
1078 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1079 * pts MUST be larger or equal to dts as presentation cannot happen before
1080 * decompression, unless one wants to view hex dumps. Some formats misuse
1081 * the terms dts and pts/cts to mean something different. Such timestamps
1082 * must be converted to true pts/dts before they are stored in AVPacket.
1086 * Decompression timestamp in AVStream->time_base units; the time at which
1087 * the packet is decompressed.
1088 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1096 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1097 * Equals next_pts - this_pts in presentation order.
1100 void (*destruct)(struct AVPacket *);
1102 int64_t pos; ///< byte position in stream, -1 if unknown
1105 * Time difference in AVStream->time_base units from the pts of this
1106 * packet to the point at which the output from the decoder has converged
1107 * independent from the availability of previous frames. That is, the
1108 * frames are virtually identical no matter if decoding started from
1109 * the very first frame or from this keyframe.
1110 * Is AV_NOPTS_VALUE if unknown.
1111 * This field is not the display duration of the current packet.
1112 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1115 * The purpose of this field is to allow seeking in streams that have no
1116 * keyframes in the conventional sense. It corresponds to the
1117 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1118 * essential for some types of subtitle streams to ensure that all
1119 * subtitles are correctly displayed after seeking.
1121 int64_t convergence_duration;
1123 #define AV_PKT_FLAG_KEY 0x0001
1124 #if LIBAVCODEC_VERSION_MAJOR < 53
1125 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1129 * Audio Video Frame.
1130 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1132 * Removal, reordering and changes to existing fields require a major
1133 * version bump. No fields should be added into AVFrame before or after
1135 * sizeof(AVFrame) must not be used outside libav*.
1137 typedef struct AVFrame {
1142 * main external API structure.
1143 * New fields can be added to the end with minor version bumps.
1144 * Removal, reordering and changes to existing fields require a major
1146 * sizeof(AVCodecContext) must not be used outside libav*.
1148 typedef struct AVCodecContext {
1150 * information on struct for av_log
1151 * - set by avcodec_alloc_context
1153 const AVClass *av_class;
1155 * the average bitrate
1156 * - encoding: Set by user; unused for constant quantizer encoding.
1157 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1162 * number of bits the bitstream is allowed to diverge from the reference.
1163 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1164 * - encoding: Set by user; unused for constant quantizer encoding.
1165 * - decoding: unused
1167 int bit_rate_tolerance;
1171 * - encoding: Set by user.
1172 * - decoding: Set by user.
1177 * Some codecs need additional format info. It is stored here.
1178 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1179 * specific codec MUST set it correctly otherwise stream copy breaks.
1180 * In general use of this field by muxers is not recommanded.
1181 * - encoding: Set by libavcodec.
1182 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1187 * Motion estimation algorithm used for video coding.
1188 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1189 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1190 * - encoding: MUST be set by user.
1191 * - decoding: unused
1196 * some codecs need / can use extradata like Huffman tables.
1197 * mjpeg: Huffman tables
1198 * rv10: additional flags
1199 * mpeg4: global headers (they can be in the bitstream or here)
1200 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1201 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1202 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1203 * - encoding: Set/allocated/freed by libavcodec.
1204 * - decoding: Set/allocated/freed by user.
1210 * This is the fundamental unit of time (in seconds) in terms
1211 * of which frame timestamps are represented. For fixed-fps content,
1212 * timebase should be 1/framerate and timestamp increments should be
1214 * - encoding: MUST be set by user.
1215 * - decoding: Set by libavcodec.
1217 AVRational time_base;
1221 * picture width / height.
1222 * - encoding: MUST be set by user.
1223 * - decoding: Set by libavcodec.
1224 * Note: For compatibility it is possible to set this instead of
1225 * coded_width/height before decoding.
1229 #define FF_ASPECT_EXTENDED 15
1232 * the number of pictures in a group of pictures, or 0 for intra_only
1233 * - encoding: Set by user.
1234 * - decoding: unused
1239 * Pixel format, see PIX_FMT_xxx.
1240 * May be set by the demuxer if known from headers.
1241 * May be overriden by the decoder if it knows better.
1242 * - encoding: Set by user.
1243 * - decoding: Set by user if known, overridden by libavcodec if known
1245 enum PixelFormat pix_fmt;
1248 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1249 * has to read frames at native frame rate.
1250 * - encoding: Set by user.
1251 * - decoding: unused
1256 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1257 * decoder to draw a horizontal band. It improves cache usage. Not
1258 * all codecs can do that. You must check the codec capabilities
1260 * When multithreading is used, it may be called from multiple threads
1261 * at the same time; threads might draw different parts of the same AVFrame,
1262 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1264 * The function is also used by hardware acceleration APIs.
1265 * It is called at least once during frame decoding to pass
1266 * the data needed for hardware render.
1267 * In that mode instead of pixel data, AVFrame points to
1268 * a structure specific to the acceleration API. The application
1269 * reads the structure and can change some fields to indicate progress
1271 * - encoding: unused
1272 * - decoding: Set by user.
1273 * @param height the height of the slice
1274 * @param y the y position of the slice
1275 * @param type 1->top field, 2->bottom field, 3->frame
1276 * @param offset offset into the AVFrame.data from which the slice should be read
1278 void (*draw_horiz_band)(struct AVCodecContext *s,
1279 const AVFrame *src, int offset[4],
1280 int y, int type, int height);
1283 int sample_rate; ///< samples per second
1284 int channels; ///< number of audio channels
1287 * audio sample format
1288 * - encoding: Set by user.
1289 * - decoding: Set by libavcodec.
1291 enum AVSampleFormat sample_fmt; ///< sample format
1293 /* The following data should not be initialized. */
1295 * Samples per packet, initialized when calling 'init'.
1298 int frame_number; ///< audio or video frame number
1299 #if LIBAVCODEC_VERSION_MAJOR < 53
1300 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1304 * Number of frames the decoded output will be delayed relative to
1305 * the encoded input.
1306 * - encoding: Set by libavcodec.
1307 * - decoding: unused
1311 /* - encoding parameters */
1312 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1313 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1317 * - encoding: Set by user.
1318 * - decoding: unused
1324 * - encoding: Set by user.
1325 * - decoding: unused
1330 * maximum quantizer difference between frames
1331 * - encoding: Set by user.
1332 * - decoding: unused
1337 * maximum number of B-frames between non-B-frames
1338 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1339 * - encoding: Set by user.
1340 * - decoding: unused
1345 * qscale factor between IP and B-frames
1346 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1347 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1348 * - encoding: Set by user.
1349 * - decoding: unused
1351 float b_quant_factor;
1353 /** obsolete FIXME remove */
1355 #define FF_RC_STRATEGY_XVID 1
1357 int b_frame_strategy;
1361 * - encoding: unused
1362 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1363 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1367 struct AVCodec *codec;
1371 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1372 /* do its best to deliver a chunk with size */
1373 /* below rtp_payload_size, the chunk will start */
1374 /* with a start code on some codecs like H.263. */
1375 /* This doesn't take account of any particular */
1376 /* headers inside the transmitted RTP payload. */
1379 /* The RTP callback: This function is called */
1380 /* every time the encoder has a packet to send. */
1381 /* It depends on the encoder if the data starts */
1382 /* with a Start Code (it should). H.263 does. */
1383 /* mb_nb contains the number of macroblocks */
1384 /* encoded in the RTP payload. */
1385 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1387 /* statistics, used for 2-pass encoding */
1398 * number of bits used for the previously encoded frame
1399 * - encoding: Set by libavcodec.
1400 * - decoding: unused
1405 * Private data of the user, can be used to carry app specific stuff.
1406 * - encoding: Set by user.
1407 * - decoding: Set by user.
1411 char codec_name[32];
1412 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1413 enum CodecID codec_id; /* see CODEC_ID_xxx */
1416 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1417 * This is used to work around some encoder bugs.
1418 * A demuxer should set this to what is stored in the field used to identify the codec.
1419 * If there are multiple such fields in a container then the demuxer should choose the one
1420 * which maximizes the information about the used codec.
1421 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1422 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1423 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1425 * - encoding: Set by user, if not then the default based on codec_id will be used.
1426 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1428 unsigned int codec_tag;
1431 * Work around bugs in encoders which sometimes cannot be detected automatically.
1432 * - encoding: Set by user
1433 * - decoding: Set by user
1435 int workaround_bugs;
1436 #define FF_BUG_AUTODETECT 1 ///< autodetection
1437 #define FF_BUG_OLD_MSMPEG4 2
1438 #define FF_BUG_XVID_ILACE 4
1439 #define FF_BUG_UMP4 8
1440 #define FF_BUG_NO_PADDING 16
1441 #define FF_BUG_AMV 32
1442 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1443 #define FF_BUG_QPEL_CHROMA 64
1444 #define FF_BUG_STD_QPEL 128
1445 #define FF_BUG_QPEL_CHROMA2 256
1446 #define FF_BUG_DIRECT_BLOCKSIZE 512
1447 #define FF_BUG_EDGE 1024
1448 #define FF_BUG_HPEL_CHROMA 2048
1449 #define FF_BUG_DC_CLIP 4096
1450 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1451 #define FF_BUG_TRUNCATED 16384
1452 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1455 * luma single coefficient elimination threshold
1456 * - encoding: Set by user.
1457 * - decoding: unused
1459 int luma_elim_threshold;
1462 * chroma single coeff elimination threshold
1463 * - encoding: Set by user.
1464 * - decoding: unused
1466 int chroma_elim_threshold;
1469 * strictly follow the standard (MPEG4, ...).
1470 * - encoding: Set by user.
1471 * - decoding: Set by user.
1472 * Setting this to STRICT or higher means the encoder and decoder will
1473 * generally do stupid things, whereas setting it to unofficial or lower
1474 * will mean the encoder might produce output that is not supported by all
1475 * spec-compliant decoders. Decoders don't differentiate between normal,
1476 * unofficial and experimental (that is, they always try to decode things
1477 * when they can) unless they are explicitly asked to behave stupidly
1478 * (=strictly conform to the specs)
1480 int strict_std_compliance;
1481 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1482 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1483 #define FF_COMPLIANCE_NORMAL 0
1484 #if FF_API_INOFFICIAL
1485 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1487 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1488 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1491 * qscale offset between IP and B-frames
1492 * - encoding: Set by user.
1493 * - decoding: unused
1495 float b_quant_offset;
1498 * Error recognization; higher values will detect more errors but may
1499 * misdetect some more or less valid parts as errors.
1500 * - encoding: unused
1501 * - decoding: Set by user.
1503 int error_recognition;
1504 #define FF_ER_CAREFUL 1
1505 #define FF_ER_COMPLIANT 2
1506 #define FF_ER_AGGRESSIVE 3
1507 #define FF_ER_VERY_AGGRESSIVE 4
1510 * Called at the beginning of each frame to get a buffer for it.
1511 * If pic.reference is set then the frame will be read later by libavcodec.
1512 * avcodec_align_dimensions2() should be used to find the required width and
1513 * height, as they normally need to be rounded up to the next multiple of 16.
1514 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1515 * avcodec_default_get_buffer() instead of providing buffers allocated by
1517 * If frame multithreading is used and thread_safe_callbacks is set,
1518 * it may be called from a different thread, but not from more than one at once.
1519 * Does not need to be reentrant.
1520 * - encoding: unused
1521 * - decoding: Set by libavcodec, user can override.
1523 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1526 * Called to release buffers which were allocated with get_buffer.
1527 * A released buffer can be reused in get_buffer().
1528 * pic.data[*] must be set to NULL.
1529 * May be called from a different thread if frame multithreading is used,
1530 * but not by more than one thread at once, so does not need to be reentrant.
1531 * - encoding: unused
1532 * - decoding: Set by libavcodec, user can override.
1534 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1537 * Size of the frame reordering buffer in the decoder.
1538 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1539 * - encoding: Set by libavcodec.
1540 * - decoding: Set by libavcodec.
1545 * number of bytes per packet if constant and known or 0
1546 * Used by some WAV based audio codecs.
1550 int parse_only; /* - decoding only: If true, only parsing is done
1551 (function avcodec_parse_frame()). The frame
1552 data is returned. Only MPEG codecs support this now. */
1555 * 0-> h263 quant 1-> mpeg quant
1556 * - encoding: Set by user.
1557 * - decoding: unused
1562 * pass1 encoding statistics output buffer
1563 * - encoding: Set by libavcodec.
1564 * - decoding: unused
1569 * pass2 encoding statistics input buffer
1570 * Concatenated stuff from stats_out of pass1 should be placed here.
1571 * - encoding: Allocated/set/freed by user.
1572 * - decoding: unused
1577 * ratecontrol qmin qmax limiting method
1578 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1579 * - encoding: Set by user.
1580 * - decoding: unused
1588 * ratecontrol override, see RcOverride
1589 * - encoding: Allocated/set/freed by user.
1590 * - decoding: unused
1592 RcOverride *rc_override;
1593 int rc_override_count;
1596 * rate control equation
1597 * - encoding: Set by user
1598 * - decoding: unused
1604 * - encoding: Set by user.
1605 * - decoding: unused
1611 * - encoding: Set by user.
1612 * - decoding: unused
1617 * decoder bitstream buffer size
1618 * - encoding: Set by user.
1619 * - decoding: unused
1622 float rc_buffer_aggressivity;
1625 * qscale factor between P and I-frames
1626 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1627 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1628 * - encoding: Set by user.
1629 * - decoding: unused
1631 float i_quant_factor;
1634 * qscale offset between P and I-frames
1635 * - encoding: Set by user.
1636 * - decoding: unused
1638 float i_quant_offset;
1641 * initial complexity for pass1 ratecontrol
1642 * - encoding: Set by user.
1643 * - decoding: unused
1645 float rc_initial_cplx;
1648 * DCT algorithm, see FF_DCT_* below
1649 * - encoding: Set by user.
1650 * - decoding: unused
1653 #define FF_DCT_AUTO 0
1654 #define FF_DCT_FASTINT 1
1655 #define FF_DCT_INT 2
1656 #define FF_DCT_MMX 3
1657 #define FF_DCT_MLIB 4
1658 #define FF_DCT_ALTIVEC 5
1659 #define FF_DCT_FAAN 6
1662 * luminance masking (0-> disabled)
1663 * - encoding: Set by user.
1664 * - decoding: unused
1669 * temporary complexity masking (0-> disabled)
1670 * - encoding: Set by user.
1671 * - decoding: unused
1673 float temporal_cplx_masking;
1676 * spatial complexity masking (0-> disabled)
1677 * - encoding: Set by user.
1678 * - decoding: unused
1680 float spatial_cplx_masking;
1683 * p block masking (0-> disabled)
1684 * - encoding: Set by user.
1685 * - decoding: unused
1690 * darkness masking (0-> disabled)
1691 * - encoding: Set by user.
1692 * - decoding: unused
1697 * IDCT algorithm, see FF_IDCT_* below.
1698 * - encoding: Set by user.
1699 * - decoding: Set by user.
1702 #define FF_IDCT_AUTO 0
1703 #define FF_IDCT_INT 1
1704 #define FF_IDCT_SIMPLE 2
1705 #define FF_IDCT_SIMPLEMMX 3
1706 #define FF_IDCT_LIBMPEG2MMX 4
1707 #define FF_IDCT_PS2 5
1708 #define FF_IDCT_MLIB 6
1709 #define FF_IDCT_ARM 7
1710 #define FF_IDCT_ALTIVEC 8
1711 #define FF_IDCT_SH4 9
1712 #define FF_IDCT_SIMPLEARM 10
1713 #define FF_IDCT_H264 11
1714 #define FF_IDCT_VP3 12
1715 #define FF_IDCT_IPP 13
1716 #define FF_IDCT_XVIDMMX 14
1717 #define FF_IDCT_CAVS 15
1718 #define FF_IDCT_SIMPLEARMV5TE 16
1719 #define FF_IDCT_SIMPLEARMV6 17
1720 #define FF_IDCT_SIMPLEVIS 18
1721 #define FF_IDCT_WMV2 19
1722 #define FF_IDCT_FAAN 20
1723 #define FF_IDCT_EA 21
1724 #define FF_IDCT_SIMPLENEON 22
1725 #define FF_IDCT_SIMPLEALPHA 23
1726 #define FF_IDCT_BINK 24
1730 * - encoding: Set by libavcodec.
1731 * - decoding: Set by user (or 0).
1735 * slice offsets in the frame in bytes
1736 * - encoding: Set/allocated by libavcodec.
1737 * - decoding: Set/allocated by user (or NULL).
1742 * error concealment flags
1743 * - encoding: unused
1744 * - decoding: Set by user.
1746 int error_concealment;
1747 #define FF_EC_GUESS_MVS 1
1748 #define FF_EC_DEBLOCK 2
1751 * dsp_mask could be add used to disable unwanted CPU features
1752 * CPU features (i.e. MMX, SSE. ...)
1754 * With the FORCE flag you may instead enable given CPU features.
1755 * (Dangerous: Usable in case of misdetection, improper usage however will
1756 * result into program crash.)
1761 #define FF_MM_FORCE AV_CPU_FLAG_FORCE
1762 #define FF_MM_MMX AV_CPU_FLAG_MMX
1763 #define FF_MM_3DNOW AV_CPU_FLAG_3DNOW
1764 #define FF_MM_MMXEXT AV_CPU_FLAG_MMX2
1765 #define FF_MM_MMX2 AV_CPU_FLAG_MMX2
1766 #define FF_MM_SSE AV_CPU_FLAG_SSE
1767 #define FF_MM_SSE2 AV_CPU_FLAG_SSE2
1768 #define FF_MM_SSE2SLOW AV_CPU_FLAG_SSE2SLOW
1769 #define FF_MM_3DNOWEXT AV_CPU_FLAG_3DNOWEXT
1770 #define FF_MM_SSE3 AV_CPU_FLAG_SSE3
1771 #define FF_MM_SSE3SLOW AV_CPU_FLAG_SSE3SLOW
1772 #define FF_MM_SSSE3 AV_CPU_FLAG_SSSE3
1773 #define FF_MM_SSE4 AV_CPU_FLAG_SSE4
1774 #define FF_MM_SSE42 AV_CPU_FLAG_SSE42
1775 #define FF_MM_IWMMXT AV_CPU_FLAG_IWMMXT
1776 #define FF_MM_ALTIVEC AV_CPU_FLAG_ALTIVEC
1780 * bits per sample/pixel from the demuxer (needed for huffyuv).
1781 * - encoding: Set by libavcodec.
1782 * - decoding: Set by user.
1784 int bits_per_coded_sample;
1787 * prediction method (needed for huffyuv)
1788 * - encoding: Set by user.
1789 * - decoding: unused
1791 int prediction_method;
1792 #define FF_PRED_LEFT 0
1793 #define FF_PRED_PLANE 1
1794 #define FF_PRED_MEDIAN 2
1797 * sample aspect ratio (0 if unknown)
1798 * That is the width of a pixel divided by the height of the pixel.
1799 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1800 * - encoding: Set by user.
1801 * - decoding: Set by libavcodec.
1803 AVRational sample_aspect_ratio;
1806 * the picture in the bitstream
1807 * - encoding: Set by libavcodec.
1808 * - decoding: Set by libavcodec.
1810 AVFrame *coded_frame;
1814 * - encoding: Set by user.
1815 * - decoding: Set by user.
1818 #define FF_DEBUG_PICT_INFO 1
1819 #define FF_DEBUG_RC 2
1820 #define FF_DEBUG_BITSTREAM 4
1821 #define FF_DEBUG_MB_TYPE 8
1822 #define FF_DEBUG_QP 16
1823 #define FF_DEBUG_MV 32
1824 #define FF_DEBUG_DCT_COEFF 0x00000040
1825 #define FF_DEBUG_SKIP 0x00000080
1826 #define FF_DEBUG_STARTCODE 0x00000100
1827 #define FF_DEBUG_PTS 0x00000200
1828 #define FF_DEBUG_ER 0x00000400
1829 #define FF_DEBUG_MMCO 0x00000800
1830 #define FF_DEBUG_BUGS 0x00001000
1831 #define FF_DEBUG_VIS_QP 0x00002000
1832 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1833 #define FF_DEBUG_BUFFERS 0x00008000
1834 #define FF_DEBUG_THREADS 0x00010000
1838 * - encoding: Set by user.
1839 * - decoding: Set by user.
1842 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1843 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1844 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1848 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1849 * - decoding: unused
1854 * minimum MB quantizer
1855 * - encoding: unused
1856 * - decoding: unused
1861 * maximum MB quantizer
1862 * - encoding: unused
1863 * - decoding: unused
1868 * motion estimation comparison function
1869 * - encoding: Set by user.
1870 * - decoding: unused
1874 * subpixel motion estimation comparison function
1875 * - encoding: Set by user.
1876 * - decoding: unused
1880 * macroblock comparison function (not supported yet)
1881 * - encoding: Set by user.
1882 * - decoding: unused
1886 * interlaced DCT comparison function
1887 * - encoding: Set by user.
1888 * - decoding: unused
1891 #define FF_CMP_SAD 0
1892 #define FF_CMP_SSE 1
1893 #define FF_CMP_SATD 2
1894 #define FF_CMP_DCT 3
1895 #define FF_CMP_PSNR 4
1896 #define FF_CMP_BIT 5
1898 #define FF_CMP_ZERO 7
1899 #define FF_CMP_VSAD 8
1900 #define FF_CMP_VSSE 9
1901 #define FF_CMP_NSSE 10
1902 #define FF_CMP_W53 11
1903 #define FF_CMP_W97 12
1904 #define FF_CMP_DCTMAX 13
1905 #define FF_CMP_DCT264 14
1906 #define FF_CMP_CHROMA 256
1909 * ME diamond size & shape
1910 * - encoding: Set by user.
1911 * - decoding: unused
1916 * amount of previous MV predictors (2a+1 x 2a+1 square)
1917 * - encoding: Set by user.
1918 * - decoding: unused
1920 int last_predictor_count;
1923 * prepass for motion estimation
1924 * - encoding: Set by user.
1925 * - decoding: unused
1930 * motion estimation prepass comparison function
1931 * - encoding: Set by user.
1932 * - decoding: unused
1937 * ME prepass diamond size & shape
1938 * - encoding: Set by user.
1939 * - decoding: unused
1945 * - encoding: Set by user.
1946 * - decoding: unused
1948 int me_subpel_quality;
1951 * callback to negotiate the pixelFormat
1952 * @param fmt is the list of formats which are supported by the codec,
1953 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1954 * The first is always the native one.
1955 * @return the chosen format
1956 * - encoding: unused
1957 * - decoding: Set by user, if not set the native format will be chosen.
1959 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1962 * DTG active format information (additional aspect ratio
1963 * information only used in DVB MPEG-2 transport streams)
1966 * - encoding: unused
1967 * - decoding: Set by decoder.
1969 int dtg_active_format;
1970 #define FF_DTG_AFD_SAME 8
1971 #define FF_DTG_AFD_4_3 9
1972 #define FF_DTG_AFD_16_9 10
1973 #define FF_DTG_AFD_14_9 11
1974 #define FF_DTG_AFD_4_3_SP_14_9 13
1975 #define FF_DTG_AFD_16_9_SP_14_9 14
1976 #define FF_DTG_AFD_SP_4_3 15
1979 * maximum motion estimation search range in subpel units
1980 * If 0 then no limit.
1982 * - encoding: Set by user.
1983 * - decoding: unused
1988 * intra quantizer bias
1989 * - encoding: Set by user.
1990 * - decoding: unused
1992 int intra_quant_bias;
1993 #define FF_DEFAULT_QUANT_BIAS 999999
1996 * inter quantizer bias
1997 * - encoding: Set by user.
1998 * - decoding: unused
2000 int inter_quant_bias;
2004 * - encoding: unused
2005 * - decoding: Which clrtable should be used for 8bit RGB images.
2006 * Tables have to be stored somewhere. FIXME
2011 * internal_buffer count
2012 * Don't touch, used by libavcodec default_get_buffer().
2014 int internal_buffer_count;
2018 * Don't touch, used by libavcodec default_get_buffer().
2020 void *internal_buffer;
2023 * Global quality for codecs which cannot change it per frame.
2024 * This should be proportional to MPEG-1/2/4 qscale.
2025 * - encoding: Set by user.
2026 * - decoding: unused
2030 #define FF_CODER_TYPE_VLC 0
2031 #define FF_CODER_TYPE_AC 1
2032 #define FF_CODER_TYPE_RAW 2
2033 #define FF_CODER_TYPE_RLE 3
2034 #define FF_CODER_TYPE_DEFLATE 4
2037 * - encoding: Set by user.
2038 * - decoding: unused
2044 * - encoding: Set by user.
2045 * - decoding: unused
2051 * - encoding: unused
2052 * - decoding: Set by user.
2054 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2059 * - encoding: unused
2060 * - decoding: Set by user.
2063 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2064 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2065 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2068 * XVideo Motion Acceleration
2069 * - encoding: forbidden
2070 * - decoding: set by decoder
2072 int xvmc_acceleration;
2075 * macroblock decision mode
2076 * - encoding: Set by user.
2077 * - decoding: unused
2080 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2081 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2082 #define FF_MB_DECISION_RD 2 ///< rate distortion
2085 * custom intra quantization matrix
2086 * - encoding: Set by user, can be NULL.
2087 * - decoding: Set by libavcodec.
2089 uint16_t *intra_matrix;
2092 * custom inter quantization matrix
2093 * - encoding: Set by user, can be NULL.
2094 * - decoding: Set by libavcodec.
2096 uint16_t *inter_matrix;
2099 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2100 * This is used to work around some encoder bugs.
2101 * - encoding: unused
2102 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2104 unsigned int stream_codec_tag;
2107 * scene change detection threshold
2108 * 0 is default, larger means fewer detected scene changes.
2109 * - encoding: Set by user.
2110 * - decoding: unused
2112 int scenechange_threshold;
2115 * minimum Lagrange multipler
2116 * - encoding: Set by user.
2117 * - decoding: unused
2122 * maximum Lagrange multipler
2123 * - encoding: Set by user.
2124 * - decoding: unused
2128 #if FF_API_PALETTE_CONTROL
2130 * palette control structure
2131 * - encoding: ??? (no palette-enabled encoder yet)
2132 * - decoding: Set by user.
2134 struct AVPaletteControl *palctrl;
2138 * noise reduction strength
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int noise_reduction;
2145 * Called at the beginning of a frame to get cr buffer for it.
2146 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2147 * libavcodec will pass previous buffer in pic, function should return
2148 * same buffer or new buffer with old frame "painted" into it.
2149 * If pic.data[0] == NULL must behave like get_buffer().
2150 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2151 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2153 * - encoding: unused
2154 * - decoding: Set by libavcodec, user can override.
2156 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2159 * Number of bits which should be loaded into the rc buffer before decoding starts.
2160 * - encoding: Set by user.
2161 * - decoding: unused
2163 int rc_initial_buffer_occupancy;
2167 * - encoding: Set by user.
2168 * - decoding: unused
2170 int inter_threshold;
2174 * - encoding: Set by user.
2175 * - decoding: Set by user.
2180 * Simulates errors in the bitstream to test error concealment.
2181 * - encoding: Set by user.
2182 * - decoding: unused
2187 * MP3 antialias algorithm, see FF_AA_* below.
2188 * - encoding: unused
2189 * - decoding: Set by user.
2192 #define FF_AA_AUTO 0
2193 #define FF_AA_FASTINT 1 //not implemented yet
2195 #define FF_AA_FLOAT 3
2197 * quantizer noise shaping
2198 * - encoding: Set by user.
2199 * - decoding: unused
2201 int quantizer_noise_shaping;
2205 * is used to decide how many independent tasks should be passed to execute()
2206 * - encoding: Set by user.
2207 * - decoding: Set by user.
2212 * The codec may call this to execute several independent things.
2213 * It will return only after finishing all tasks.
2214 * The user may replace this with some multithreaded implementation,
2215 * the default implementation will execute the parts serially.
2216 * @param count the number of things to execute
2217 * - encoding: Set by libavcodec, user can override.
2218 * - decoding: Set by libavcodec, user can override.
2220 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2224 * Can be used by execute() to store some per AVCodecContext stuff.
2225 * - encoding: set by execute()
2226 * - decoding: set by execute()
2228 void *thread_opaque;
2231 * Motion estimation threshold below which no motion estimation is
2232 * performed, but instead the user specified motion vectors are used.
2234 * - encoding: Set by user.
2235 * - decoding: unused
2240 * Macroblock threshold below which the user specified macroblock types will be used.
2241 * - encoding: Set by user.
2242 * - decoding: unused
2247 * precision of the intra DC coefficient - 8
2248 * - encoding: Set by user.
2249 * - decoding: unused
2251 int intra_dc_precision;
2254 * noise vs. sse weight for the nsse comparsion function
2255 * - encoding: Set by user.
2256 * - decoding: unused
2261 * Number of macroblock rows at the top which are skipped.
2262 * - encoding: unused
2263 * - decoding: Set by user.
2268 * Number of macroblock rows at the bottom which are skipped.
2269 * - encoding: unused
2270 * - decoding: Set by user.
2276 * - encoding: Set by user.
2277 * - decoding: Set by libavcodec.
2280 #define FF_PROFILE_UNKNOWN -99
2281 #define FF_PROFILE_RESERVED -100
2283 #define FF_PROFILE_AAC_MAIN 0
2284 #define FF_PROFILE_AAC_LOW 1
2285 #define FF_PROFILE_AAC_SSR 2
2286 #define FF_PROFILE_AAC_LTP 3
2288 #define FF_PROFILE_DTS 20
2289 #define FF_PROFILE_DTS_ES 30
2290 #define FF_PROFILE_DTS_96_24 40
2291 #define FF_PROFILE_DTS_HD_HRA 50
2292 #define FF_PROFILE_DTS_HD_MA 60
2294 #define FF_PROFILE_MPEG2_422 0
2295 #define FF_PROFILE_MPEG2_HIGH 1
2296 #define FF_PROFILE_MPEG2_SS 2
2297 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2298 #define FF_PROFILE_MPEG2_MAIN 4
2299 #define FF_PROFILE_MPEG2_SIMPLE 5
2301 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2302 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2304 #define FF_PROFILE_H264_BASELINE 66
2305 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2306 #define FF_PROFILE_H264_MAIN 77
2307 #define FF_PROFILE_H264_EXTENDED 88
2308 #define FF_PROFILE_H264_HIGH 100
2309 #define FF_PROFILE_H264_HIGH_10 110
2310 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2311 #define FF_PROFILE_H264_HIGH_422 122
2312 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2313 #define FF_PROFILE_H264_HIGH_444 144
2314 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2315 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2316 #define FF_PROFILE_H264_CAVLC_444 44
2318 #define FF_PROFILE_VC1_SIMPLE 0
2319 #define FF_PROFILE_VC1_MAIN 1
2320 #define FF_PROFILE_VC1_COMPLEX 2
2321 #define FF_PROFILE_VC1_ADVANCED 3
2325 * - encoding: Set by user.
2326 * - decoding: Set by libavcodec.
2329 #define FF_LEVEL_UNKNOWN -99
2332 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2333 * - encoding: unused
2334 * - decoding: Set by user.
2339 * Bitstream width / height, may be different from width/height if lowres
2340 * or other things are used.
2341 * - encoding: unused
2342 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2344 int coded_width, coded_height;
2347 * frame skip threshold
2348 * - encoding: Set by user.
2349 * - decoding: unused
2351 int frame_skip_threshold;
2355 * - encoding: Set by user.
2356 * - decoding: unused
2358 int frame_skip_factor;
2361 * frame skip exponent
2362 * - encoding: Set by user.
2363 * - decoding: unused
2368 * frame skip comparison function
2369 * - encoding: Set by user.
2370 * - decoding: unused
2375 * Border processing masking, raises the quantizer for mbs on the borders
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 float border_masking;
2383 * minimum MB lagrange multipler
2384 * - encoding: Set by user.
2385 * - decoding: unused
2390 * maximum MB lagrange multipler
2391 * - encoding: Set by user.
2392 * - decoding: unused
2398 * - encoding: Set by user.
2399 * - decoding: unused
2401 int me_penalty_compensation;
2405 * - encoding: unused
2406 * - decoding: Set by user.
2408 enum AVDiscard skip_loop_filter;
2412 * - encoding: unused
2413 * - decoding: Set by user.
2415 enum AVDiscard skip_idct;
2419 * - encoding: unused
2420 * - decoding: Set by user.
2422 enum AVDiscard skip_frame;
2426 * - encoding: Set by user.
2427 * - decoding: unused
2433 * - encoding: Set by user.
2434 * - decoding: unused
2439 * constant rate factor - quality-based VBR - values ~correspond to qps
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * constant quantization parameter rate control method
2447 * - encoding: Set by user.
2448 * - decoding: unused
2454 * - encoding: Set by user.
2455 * - decoding: unused
2460 * number of reference frames
2461 * - encoding: Set by user.
2462 * - decoding: Set by lavc.
2467 * chroma qp offset from luma
2468 * - encoding: Set by user.
2469 * - decoding: unused
2474 * Influences how often B-frames are used.
2475 * - encoding: Set by user.
2476 * - decoding: unused
2481 * trellis RD quantization
2482 * - encoding: Set by user.
2483 * - decoding: unused
2488 * Reduce fluctuations in qp (before curve compression).
2489 * - encoding: Set by user.
2490 * - decoding: unused
2492 float complexityblur;
2495 * in-loop deblocking filter alphac0 parameter
2496 * alpha is in the range -6...6
2497 * - encoding: Set by user.
2498 * - decoding: unused
2503 * in-loop deblocking filter beta parameter
2504 * beta is in the range -6...6
2505 * - encoding: Set by user.
2506 * - decoding: unused
2511 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2512 * - encoding: Set by user.
2513 * - decoding: unused
2516 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2517 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2518 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2519 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2520 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2523 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2524 * - encoding: Set by user.
2525 * - decoding: unused
2530 * Audio cutoff bandwidth (0 means "automatic")
2531 * - encoding: Set by user.
2532 * - decoding: unused
2537 * Multiplied by qscale for each frame and added to scene_change_score.
2538 * - encoding: Set by user.
2539 * - decoding: unused
2541 int scenechange_factor;
2545 * Note: Value depends upon the compare function used for fullpel ME.
2546 * - encoding: Set by user.
2547 * - decoding: unused
2552 * Adjusts sensitivity of b_frame_strategy 1.
2553 * - encoding: Set by user.
2554 * - decoding: unused
2559 * - encoding: Set by user.
2560 * - decoding: unused
2562 int compression_level;
2563 #define FF_COMPRESSION_DEFAULT -1
2567 * Sets whether to use LPC mode - used by FLAC encoder.
2568 * - encoding: Set by user.
2569 * - decoding: unused
2570 * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2576 * LPC coefficient precision - used by FLAC encoder
2577 * - encoding: Set by user.
2578 * - decoding: unused
2580 int lpc_coeff_precision;
2583 * - encoding: Set by user.
2584 * - decoding: unused
2586 int min_prediction_order;
2589 * - encoding: Set by user.
2590 * - decoding: unused
2592 int max_prediction_order;
2595 * search method for selecting prediction order
2596 * - encoding: Set by user.
2597 * - decoding: unused
2599 int prediction_order_method;
2602 * - encoding: Set by user.
2603 * - decoding: unused
2605 int min_partition_order;
2608 * - encoding: Set by user.
2609 * - decoding: unused
2611 int max_partition_order;
2614 * GOP timecode frame start number, in non drop frame format
2615 * - encoding: Set by user.
2616 * - decoding: unused
2618 int64_t timecode_frame_start;
2620 #if LIBAVCODEC_VERSION_MAJOR < 53
2622 * Decoder should decode to this many channels if it can (0 for default)
2623 * - encoding: unused
2624 * - decoding: Set by user.
2625 * @deprecated Deprecated in favor of request_channel_layout.
2627 int request_channels;
2631 * Percentage of dynamic range compression to be applied by the decoder.
2632 * The default value is 1.0, corresponding to full compression.
2633 * - encoding: unused
2634 * - decoding: Set by user.
2639 * opaque 64bit number (generally a PTS) that will be reordered and
2640 * output in AVFrame.reordered_opaque
2641 * @deprecated in favor of pkt_pts
2642 * - encoding: unused
2643 * - decoding: Set by user.
2645 int64_t reordered_opaque;
2648 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2649 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2650 * - encoding: set by user.
2651 * - decoding: set by libavcodec.
2653 int bits_per_raw_sample;
2656 * Audio channel layout.
2657 * - encoding: set by user.
2658 * - decoding: set by libavcodec.
2660 int64_t channel_layout;
2663 * Request decoder to use this channel layout if it can (0 for default)
2664 * - encoding: unused
2665 * - decoding: Set by user.
2667 int64_t request_channel_layout;
2670 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2671 * - encoding: Set by user.
2672 * - decoding: unused.
2674 float rc_max_available_vbv_use;
2677 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2678 * - encoding: Set by user.
2679 * - decoding: unused.
2681 float rc_min_vbv_overflow_use;
2684 * Hardware accelerator in use
2685 * - encoding: unused.
2686 * - decoding: Set by libavcodec
2688 struct AVHWAccel *hwaccel;
2691 * For some codecs, the time base is closer to the field rate than the frame rate.
2692 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2693 * if no telecine is used ...
2695 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2697 int ticks_per_frame;
2700 * Hardware accelerator context.
2701 * For some hardware accelerators, a global context needs to be
2702 * provided by the user. In that case, this holds display-dependent
2703 * data FFmpeg cannot instantiate itself. Please refer to the
2704 * FFmpeg HW accelerator documentation to know how to fill this
2705 * is. e.g. for VA API, this is a struct vaapi_context.
2706 * - encoding: unused
2707 * - decoding: Set by user
2709 void *hwaccel_context;
2712 * Chromaticity coordinates of the source primaries.
2713 * - encoding: Set by user
2714 * - decoding: Set by libavcodec
2716 enum AVColorPrimaries color_primaries;
2719 * Color Transfer Characteristic.
2720 * - encoding: Set by user
2721 * - decoding: Set by libavcodec
2723 enum AVColorTransferCharacteristic color_trc;
2726 * YUV colorspace type.
2727 * - encoding: Set by user
2728 * - decoding: Set by libavcodec
2730 enum AVColorSpace colorspace;
2733 * MPEG vs JPEG YUV range.
2734 * - encoding: Set by user
2735 * - decoding: Set by libavcodec
2737 enum AVColorRange color_range;
2740 * This defines the location of chroma samples.
2741 * - encoding: Set by user
2742 * - decoding: Set by libavcodec
2744 enum AVChromaLocation chroma_sample_location;
2747 * The codec may call this to execute several independent things.
2748 * It will return only after finishing all tasks.
2749 * The user may replace this with some multithreaded implementation,
2750 * the default implementation will execute the parts serially.
2751 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2752 * @param c context passed also to func
2753 * @param count the number of things to execute
2754 * @param arg2 argument passed unchanged to func
2755 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2756 * @param func function that will be called count times, with jobnr from 0 to count-1.
2757 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2758 * two instances of func executing at the same time will have the same threadnr.
2759 * @return always 0 currently, but code should handle a future improvement where when any call to func
2760 * returns < 0 no further calls to func may be done and < 0 is returned.
2761 * - encoding: Set by libavcodec, user can override.
2762 * - decoding: Set by libavcodec, user can override.
2764 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2767 * explicit P-frame weighted prediction analysis method
2769 * 1: fast blind weighting (one reference duplicate with -1 offset)
2770 * 2: smart weighting (full fade detection analysis)
2771 * - encoding: Set by user.
2772 * - decoding: unused
2774 int weighted_p_pred;
2779 * 1: Variance AQ (complexity mask)
2780 * 2: Auto-variance AQ (experimental)
2781 * - encoding: Set by user
2782 * - decoding: unused
2788 * Reduces blocking and blurring in flat and textured areas.
2789 * - encoding: Set by user
2790 * - decoding: unused
2796 * Strength of psychovisual optimization
2797 * - encoding: Set by user
2798 * - decoding: unused
2804 * Strength of psychovisual optimization
2805 * - encoding: Set by user
2806 * - decoding: unused
2812 * Number of frames for frametype and ratecontrol lookahead
2813 * - encoding: Set by user
2814 * - decoding: unused
2819 * Constant rate factor maximum
2820 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2821 * than crf_max, even if doing so would violate VBV restrictions.
2822 * - encoding: Set by user.
2823 * - decoding: unused
2827 int log_level_offset;
2830 * Determines which LPC analysis algorithm to use.
2831 * - encoding: Set by user
2832 * - decoding: unused
2834 enum AVLPCType lpc_type;
2837 * Number of passes to use for Cholesky factorization during LPC analysis
2838 * - encoding: Set by user
2839 * - decoding: unused
2845 * Indicates number of picture subdivisions. Used for parallelized
2847 * - encoding: Set by user
2848 * - decoding: unused
2853 * Header containing style information for text subtitles.
2854 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2855 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2856 * the Format line following. It shouldn't include any Dialogue line.
2857 * - encoding: Set/allocated/freed by user (before avcodec_open())
2858 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2860 uint8_t *subtitle_header;
2861 int subtitle_header_size;
2864 * Current packet as passed into the decoder, to avoid having
2865 * to pass the packet into every function. Currently only valid
2866 * inside lavc and get/release_buffer callbacks.
2867 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2868 * - encoding: unused
2873 * Whether this is a copy of the context which had init() called on it.
2874 * This is used by multithreading - shared tables and picture pointers
2875 * should be freed from the original context only.
2876 * - encoding: Set by libavcodec.
2877 * - decoding: Set by libavcodec.
2882 * Which multithreading methods to use.
2883 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2884 * so clients which cannot provide future frames should not use it.
2886 * - encoding: Set by user, otherwise the default is used.
2887 * - decoding: Set by user, otherwise the default is used.
2890 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2891 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2894 * Which multithreading methods are in use by the codec.
2895 * - encoding: Set by libavcodec.
2896 * - decoding: Set by libavcodec.
2898 int active_thread_type;
2901 * Set by the client if its custom get_buffer() callback can be called
2902 * from another thread, which allows faster multithreaded decoding.
2903 * draw_horiz_band() will be called from other threads regardless of this setting.
2904 * Ignored if the default get_buffer() is used.
2905 * - encoding: Set by user.
2906 * - decoding: Set by user.
2908 int thread_safe_callbacks;
2911 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2912 * Used for compliant TS muxing.
2913 * - encoding: Set by libavcodec.
2914 * - decoding: unused.
2922 typedef struct AVProfile {
2924 const char *name; ///< short name for the profile
2930 typedef struct AVCodec {
2932 * Name of the codec implementation.
2933 * The name is globally unique among encoders and among decoders (but an
2934 * encoder and a decoder can share the same name).
2935 * This is the primary way to find a codec from the user perspective.
2938 enum AVMediaType type;
2941 int (*init)(AVCodecContext *);
2942 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2943 int (*close)(AVCodecContext *);
2944 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2946 * Codec capabilities.
2950 struct AVCodec *next;
2953 * Will be called when seeking
2955 void (*flush)(AVCodecContext *);
2956 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2957 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2959 * Descriptive name for the codec, meant to be more human readable than name.
2960 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2962 const char *long_name;
2963 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2964 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2965 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2966 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2967 AVClass *priv_class; ///< AVClass for the private context
2968 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2971 * @defgroup framethreading Frame-level threading support functions.
2975 * If defined, called on thread contexts when they are created.
2976 * If the codec allocates writable tables in init(), re-allocate them here.
2977 * priv_data will be set to a copy of the original.
2979 int (*init_thread_copy)(AVCodecContext *);
2981 * Copy necessary context variables from a previous thread context to the current one.
2982 * If not defined, the next thread will start automatically; otherwise, the codec
2983 * must call ff_thread_finish_setup().
2985 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2987 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2994 typedef struct AVHWAccel {
2996 * Name of the hardware accelerated codec.
2997 * The name is globally unique among encoders and among decoders (but an
2998 * encoder and a decoder can share the same name).
3003 * Type of codec implemented by the hardware accelerator.
3005 * See AVMEDIA_TYPE_xxx
3007 enum AVMediaType type;
3010 * Codec implemented by the hardware accelerator.
3017 * Supported pixel format.
3019 * Only hardware accelerated formats are supported here.
3021 enum PixelFormat pix_fmt;
3024 * Hardware accelerated codec capabilities.
3025 * see FF_HWACCEL_CODEC_CAP_*
3029 struct AVHWAccel *next;
3032 * Called at the beginning of each frame or field picture.
3034 * Meaningful frame information (codec specific) is guaranteed to
3035 * be parsed at this point. This function is mandatory.
3037 * Note that buf can be NULL along with buf_size set to 0.
3038 * Otherwise, this means the whole frame is available at this point.
3040 * @param avctx the codec context
3041 * @param buf the frame data buffer base
3042 * @param buf_size the size of the frame in bytes
3043 * @return zero if successful, a negative value otherwise
3045 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3048 * Callback for each slice.
3050 * Meaningful slice information (codec specific) is guaranteed to
3051 * be parsed at this point. This function is mandatory.
3053 * @param avctx the codec context
3054 * @param buf the slice data buffer base
3055 * @param buf_size the size of the slice in bytes
3056 * @return zero if successful, a negative value otherwise
3058 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3061 * Called at the end of each frame or field picture.
3063 * The whole picture is parsed at this point and can now be sent
3064 * to the hardware accelerator. This function is mandatory.
3066 * @param avctx the codec context
3067 * @return zero if successful, a negative value otherwise
3069 int (*end_frame)(AVCodecContext *avctx);
3072 * Size of HW accelerator private data.
3074 * Private data is allocated with av_mallocz() before
3075 * AVCodecContext.get_buffer() and deallocated after
3076 * AVCodecContext.release_buffer().
3082 * four components are given, that's all.
3083 * the last component is alpha
3085 typedef struct AVPicture {
3087 int linesize[4]; ///< number of bytes per line
3090 #if FF_API_PALETTE_CONTROL
3093 * This structure defines a method for communicating palette changes
3094 * between and demuxer and a decoder.
3096 * @deprecated Use AVPacket to send palette changes instead.
3097 * This is totally broken.
3099 #define AVPALETTE_SIZE 1024
3100 #define AVPALETTE_COUNT 256
3101 typedef struct AVPaletteControl {
3103 /* Demuxer sets this to 1 to indicate the palette has changed;
3104 * decoder resets to 0. */
3105 int palette_changed;
3107 /* 4-byte ARGB palette entries, stored in native byte order; note that
3108 * the individual palette components should be on a 8-bit scale; if
3109 * the palette data comes from an IBM VGA native format, the component
3110 * data is probably 6 bits in size and needs to be scaled. */
3111 unsigned int palette[AVPALETTE_COUNT];
3113 } AVPaletteControl attribute_deprecated;
3116 enum AVSubtitleType {
3119 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3122 * Plain text, the text field must be set by the decoder and is
3123 * authoritative. ass and pict fields may contain approximations.
3128 * Formatted text, the ass field must be set by the decoder and is
3129 * authoritative. pict and text fields may contain approximations.
3134 typedef struct AVSubtitleRect {
3135 int x; ///< top left corner of pict, undefined when pict is not set
3136 int y; ///< top left corner of pict, undefined when pict is not set
3137 int w; ///< width of pict, undefined when pict is not set
3138 int h; ///< height of pict, undefined when pict is not set
3139 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3142 * data+linesize for the bitmap of this subtitle.
3143 * can be set for text/ass as well once they where rendered
3146 enum AVSubtitleType type;
3148 char *text; ///< 0 terminated plain UTF-8 text
3151 * 0 terminated ASS/SSA compatible event line.
3152 * The pressentation of this is unaffected by the other values in this
3158 typedef struct AVSubtitle {
3159 uint16_t format; /* 0 = graphics */
3160 uint32_t start_display_time; /* relative to packet pts, in ms */
3161 uint32_t end_display_time; /* relative to packet pts, in ms */
3163 AVSubtitleRect **rects;
3164 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3167 /* packet functions */
3170 * @deprecated use NULL instead
3172 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3175 * Default packet destructor.
3177 void av_destruct_packet(AVPacket *pkt);
3180 * Initialize optional fields of a packet with default values.
3184 void av_init_packet(AVPacket *pkt);
3187 * Allocate the payload of a packet and initialize its fields with
3191 * @param size wanted payload size
3192 * @return 0 if OK, AVERROR_xxx otherwise
3194 int av_new_packet(AVPacket *pkt, int size);
3197 * Reduce packet size, correctly zeroing padding
3200 * @param size new size
3202 void av_shrink_packet(AVPacket *pkt, int size);
3205 * Increase packet size, correctly zeroing padding
3208 * @param grow_by number of bytes by which to increase the size of the packet
3210 int av_grow_packet(AVPacket *pkt, int grow_by);
3213 * @warning This is a hack - the packet memory allocation stuff is broken. The
3214 * packet is allocated if it was not really allocated.
3216 int av_dup_packet(AVPacket *pkt);
3221 * @param pkt packet to free
3223 void av_free_packet(AVPacket *pkt);
3227 struct ReSampleContext;
3228 struct AVResampleContext;
3230 typedef struct ReSampleContext ReSampleContext;
3232 #if FF_API_AUDIO_OLD
3234 * @deprecated Use av_audio_resample_init() instead.
3236 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3237 int output_rate, int input_rate);
3241 * Initialize audio resampling context.
3243 * @param output_channels number of output channels
3244 * @param input_channels number of input channels
3245 * @param output_rate output sample rate
3246 * @param input_rate input sample rate
3247 * @param sample_fmt_out requested output sample format
3248 * @param sample_fmt_in input sample format
3249 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3250 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3251 * @param linear if 1 then the used FIR filter will be linearly interpolated
3252 between the 2 closest, if 0 the closest will be used
3253 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3254 * @return allocated ReSampleContext, NULL if error occured
3256 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3257 int output_rate, int input_rate,
3258 enum AVSampleFormat sample_fmt_out,
3259 enum AVSampleFormat sample_fmt_in,
3260 int filter_length, int log2_phase_count,
3261 int linear, double cutoff);
3263 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3266 * Free resample context.
3268 * @param s a non-NULL pointer to a resample context previously
3269 * created with av_audio_resample_init()
3271 void audio_resample_close(ReSampleContext *s);
3275 * Initialize an audio resampler.
3276 * Note, if either rate is not an integer then simply scale both rates up so they are.
3277 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3278 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3279 * @param linear If 1 then the used FIR filter will be linearly interpolated
3280 between the 2 closest, if 0 the closest will be used
3281 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3283 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3286 * Resample an array of samples using a previously configured context.
3287 * @param src an array of unconsumed samples
3288 * @param consumed the number of samples of src which have been consumed are returned here
3289 * @param src_size the number of unconsumed samples available
3290 * @param dst_size the amount of space in samples available in dst
3291 * @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.
3292 * @return the number of samples written in dst or -1 if an error occurred
3294 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3298 * Compensate samplerate/timestamp drift. The compensation is done by changing
3299 * the resampler parameters, so no audible clicks or similar distortions occur
3300 * @param compensation_distance distance in output samples over which the compensation should be performed
3301 * @param sample_delta number of output samples which should be output less
3303 * example: av_resample_compensate(c, 10, 500)
3304 * here instead of 510 samples only 500 samples would be output
3306 * note, due to rounding the actual compensation might be slightly different,
3307 * especially if the compensation_distance is large and the in_rate used during init is small
3309 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3310 void av_resample_close(struct AVResampleContext *c);
3313 * Allocate memory for a picture. Call avpicture_free to free it.
3315 * @param picture the picture to be filled in
3316 * @param pix_fmt the format of the picture
3317 * @param width the width of the picture
3318 * @param height the height of the picture
3319 * @return zero if successful, a negative value if not
3321 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3324 * Free a picture previously allocated by avpicture_alloc().
3326 * @param picture the AVPicture to be freed
3328 void avpicture_free(AVPicture *picture);
3331 * Fill in the AVPicture fields.
3332 * The fields of the given AVPicture are filled in by using the 'ptr' address
3333 * which points to the image data buffer. Depending on the specified picture
3334 * format, one or multiple image data pointers and line sizes will be set.
3335 * If a planar format is specified, several pointers will be set pointing to
3336 * the different picture planes and the line sizes of the different planes
3337 * will be stored in the lines_sizes array.
3338 * Call with ptr == NULL to get the required size for the ptr buffer.
3340 * @param picture AVPicture whose fields are to be filled in
3341 * @param ptr Buffer which will contain or contains the actual image data
3342 * @param pix_fmt The format in which the picture data is stored.
3343 * @param width the width of the image in pixels
3344 * @param height the height of the image in pixels
3345 * @return size of the image data in bytes
3347 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3348 enum PixelFormat pix_fmt, int width, int height);
3349 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3350 unsigned char *dest, int dest_size);
3353 * Calculate the size in bytes that a picture of the given width and height
3354 * would occupy if stored in the given picture format.
3355 * Note that this returns the size of a compact representation as generated
3356 * by avpicture_layout, which can be smaller than the size required for e.g.
3359 * @param pix_fmt the given picture format
3360 * @param width the width of the image
3361 * @param height the height of the image
3362 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3364 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3365 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3366 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3367 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3369 #if LIBAVCODEC_VERSION_MAJOR < 53
3371 * Return the pixel format corresponding to the name name.
3373 * If there is no pixel format with name name, then look for a
3374 * pixel format with the name corresponding to the native endian
3376 * For example in a little-endian system, first look for "gray16",
3377 * then for "gray16le".
3379 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3381 * @deprecated Deprecated in favor of av_get_pix_fmt().
3383 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3387 * Return a value representing the fourCC code associated to the
3388 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3391 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3394 * Put a string representing the codec tag codec_tag in buf.
3396 * @param buf_size size in bytes of buf
3397 * @return the length of the string that would have been generated if
3398 * enough space had been available, excluding the trailing null
3400 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3402 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3403 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3404 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3405 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3406 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3407 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3410 * Compute what kind of losses will occur when converting from one specific
3411 * pixel format to another.
3412 * When converting from one pixel format to another, information loss may occur.
3413 * For example, when converting from RGB24 to GRAY, the color information will
3414 * be lost. Similarly, other losses occur when converting from some formats to
3415 * other formats. These losses can involve loss of chroma, but also loss of
3416 * resolution, loss of color depth, loss due to the color space conversion, loss
3417 * of the alpha bits or loss due to color quantization.
3418 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3419 * which will occur when converting from one pixel format to another.
3421 * @param[in] dst_pix_fmt destination pixel format
3422 * @param[in] src_pix_fmt source pixel format
3423 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3424 * @return Combination of flags informing you what kind of losses will occur.
3426 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3430 * Find the best pixel format to convert to given a certain source pixel
3431 * format. When converting from one pixel format to another, information loss
3432 * may occur. For example, when converting from RGB24 to GRAY, the color
3433 * information will be lost. Similarly, other losses occur when converting from
3434 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3435 * the given pixel formats should be used to suffer the least amount of loss.
3436 * The pixel formats from which it chooses one, are determined by the
3437 * pix_fmt_mask parameter.
3440 * src_pix_fmt = PIX_FMT_YUV420P;
3441 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3442 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3445 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3446 * @param[in] src_pix_fmt source pixel format
3447 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3448 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3449 * @return The best pixel format to convert to or -1 if none was found.
3451 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3452 int has_alpha, int *loss_ptr);
3454 #if LIBAVCODEC_VERSION_MAJOR < 53
3456 * @deprecated Use av_get_pix_fmt_string() instead.
3458 attribute_deprecated
3459 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3462 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3463 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3466 * Tell if an image really has transparent alpha values.
3467 * @return ored mask of FF_ALPHA_xxx constants
3469 int img_get_alpha_info(const AVPicture *src,
3470 enum PixelFormat pix_fmt, int width, int height);
3472 /* deinterlace a picture */
3473 /* deinterlace - if not supported return -1 */
3474 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3475 enum PixelFormat pix_fmt, int width, int height);
3477 /* external high level API */
3480 * If c is NULL, returns the first registered codec,
3481 * if c is non-NULL, returns the next registered codec after c,
3482 * or NULL if c is the last one.
3484 AVCodec *av_codec_next(AVCodec *c);
3487 * Return the LIBAVCODEC_VERSION_INT constant.
3489 unsigned avcodec_version(void);
3492 * Return the libavcodec build-time configuration.
3494 const char *avcodec_configuration(void);
3497 * Return the libavcodec license.
3499 const char *avcodec_license(void);
3502 * Initialize libavcodec.
3504 * @warning This function must be called before any other libavcodec
3507 void avcodec_init(void);
3509 #if LIBAVCODEC_VERSION_MAJOR < 53
3511 * @deprecated Deprecated in favor of avcodec_register().
3513 attribute_deprecated void register_avcodec(AVCodec *codec);
3517 * Register the codec codec and initialize libavcodec.
3519 * @see avcodec_init()
3521 void avcodec_register(AVCodec *codec);
3524 * Find a registered encoder with a matching codec ID.
3526 * @param id CodecID of the requested encoder
3527 * @return An encoder if one was found, NULL otherwise.
3529 AVCodec *avcodec_find_encoder(enum CodecID id);
3532 * Find a registered encoder with the specified name.
3534 * @param name name of the requested encoder
3535 * @return An encoder if one was found, NULL otherwise.
3537 AVCodec *avcodec_find_encoder_by_name(const char *name);
3540 * Find a registered decoder with a matching codec ID.
3542 * @param id CodecID of the requested decoder
3543 * @return A decoder if one was found, NULL otherwise.
3545 AVCodec *avcodec_find_decoder(enum CodecID id);
3548 * Find a registered decoder with the specified name.
3550 * @param name name of the requested decoder
3551 * @return A decoder if one was found, NULL otherwise.
3553 AVCodec *avcodec_find_decoder_by_name(const char *name);
3554 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3557 * Return a name for the specified profile, if available.
3559 * @param codec the codec that is searched for the given profile
3560 * @param profile the profile value for which a name is requested
3561 * @return A name for the profile if found, NULL otherwise.
3563 const char *av_get_profile_name(const AVCodec *codec, int profile);
3566 * Set the fields of the given AVCodecContext to default values.
3568 * @param s The AVCodecContext of which the fields should be set to default values.
3570 void avcodec_get_context_defaults(AVCodecContext *s);
3572 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3573 * we WILL change its arguments and name a few times! */
3574 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3576 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3577 * we WILL change its arguments and name a few times! */
3578 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3581 * Allocate an AVCodecContext and set its fields to default values. The
3582 * resulting struct can be deallocated by simply calling av_free().
3584 * @return An AVCodecContext filled with default values or NULL on failure.
3585 * @see avcodec_get_context_defaults
3587 AVCodecContext *avcodec_alloc_context(void);
3589 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3590 * we WILL change its arguments and name a few times! */
3591 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3593 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3594 * we WILL change its arguments and name a few times! */
3595 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3598 * Copy the settings of the source AVCodecContext into the destination
3599 * AVCodecContext. The resulting destination codec context will be
3600 * unopened, i.e. you are required to call avcodec_open() before you
3601 * can use this AVCodecContext to decode/encode video/audio data.
3603 * @param dest target codec context, should be initialized with
3604 * avcodec_alloc_context(), but otherwise uninitialized
3605 * @param src source codec context
3606 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3608 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3611 * Set the fields of the given AVFrame to default values.
3613 * @param pic The AVFrame of which the fields should be set to default values.
3615 void avcodec_get_frame_defaults(AVFrame *pic);
3618 * Allocate an AVFrame and set its fields to default values. The resulting
3619 * struct can be deallocated by simply calling av_free().
3621 * @return An AVFrame filled with default values or NULL on failure.
3622 * @see avcodec_get_frame_defaults
3624 AVFrame *avcodec_alloc_frame(void);
3626 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3627 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3628 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3631 * Return the amount of padding in pixels which the get_buffer callback must
3632 * provide around the edge of the image for codecs which do not have the
3633 * CODEC_FLAG_EMU_EDGE flag.
3635 * @return Required padding in pixels.
3637 unsigned avcodec_get_edge_width(void);
3639 * Modify width and height values so that they will result in a memory
3640 * buffer that is acceptable for the codec if you do not use any horizontal
3643 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3644 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3645 * according to avcodec_get_edge_width() before.
3647 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3649 * Modify width and height values so that they will result in a memory
3650 * buffer that is acceptable for the codec if you also ensure that all
3651 * line sizes are a multiple of the respective linesize_align[i].
3653 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3654 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3655 * according to avcodec_get_edge_width() before.
3657 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3658 int linesize_align[4]);
3660 #if LIBAVCODEC_VERSION_MAJOR < 53
3662 * @deprecated Deprecated in favor of av_check_image_size().
3664 attribute_deprecated
3665 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3668 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3670 #if LIBAVCODEC_VERSION_MAJOR < 53
3672 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3674 attribute_deprecated
3675 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3676 void avcodec_thread_free(AVCodecContext *s);
3678 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3679 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3680 //FIXME func typedef
3683 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3684 * function the context has to be allocated.
3686 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3687 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3688 * retrieving a codec.
3690 * @warning This function is not thread safe!
3693 * avcodec_register_all();
3694 * codec = avcodec_find_decoder(CODEC_ID_H264);
3698 * context = avcodec_alloc_context();
3700 * if (avcodec_open(context, codec) < 0)
3704 * @param avctx The context which will be set up to use the given codec.
3705 * @param codec The codec to use within the context.
3706 * @return zero on success, a negative value on error
3707 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3709 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3711 #if FF_API_AUDIO_OLD
3713 * Decode an audio frame from buf into samples.
3714 * Wrapper function which calls avcodec_decode_audio3.
3716 * @deprecated Use avcodec_decode_audio3 instead.
3717 * @param avctx the codec context
3718 * @param[out] samples the output buffer
3719 * @param[in,out] frame_size_ptr the output buffer size in bytes
3720 * @param[in] buf the input buffer
3721 * @param[in] buf_size the input buffer size in bytes
3722 * @return On error a negative value is returned, otherwise the number of bytes
3723 * used or zero if no frame could be decompressed.
3725 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3726 int *frame_size_ptr,
3727 const uint8_t *buf, int buf_size);
3731 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3732 * Some decoders may support multiple frames in a single AVPacket, such
3733 * decoders would then just decode the first frame. In this case,
3734 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3735 * the remaining data in order to decode the second frame etc.
3737 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3738 * decompressed frame size in bytes.
3740 * @warning You must set frame_size_ptr to the allocated size of the
3741 * output buffer before calling avcodec_decode_audio3().
3743 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3744 * the actual read bytes because some optimized bitstream readers read 32 or 64
3745 * bits at once and could read over the end.
3747 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3748 * no overreading happens for damaged MPEG streams.
3750 * @note You might have to align the input buffer avpkt->data and output buffer
3751 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3752 * necessary at all, on others it won't work at all if not aligned and on others
3753 * it will work but it will have an impact on performance.
3755 * In practice, avpkt->data should have 4 byte alignment at minimum and
3756 * samples should be 16 byte aligned unless the CPU doesn't need it
3757 * (AltiVec and SSE do).
3759 * @param avctx the codec context
3760 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3761 * @param[in,out] frame_size_ptr the output buffer size in bytes
3762 * @param[in] avpkt The input AVPacket containing the input buffer.
3763 * You can create such packet with av_init_packet() and by then setting
3764 * data and size, some decoders might in addition need other fields.
3765 * All decoders are designed to use the least fields possible though.
3766 * @return On error a negative value is returned, otherwise the number of bytes
3767 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3769 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3770 int *frame_size_ptr,
3773 #if FF_API_VIDEO_OLD
3775 * Decode a video frame from buf into picture.
3776 * Wrapper function which calls avcodec_decode_video2.
3778 * @deprecated Use avcodec_decode_video2 instead.
3779 * @param avctx the codec context
3780 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3781 * @param[in] buf the input buffer
3782 * @param[in] buf_size the size of the input buffer in bytes
3783 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3784 * @return On error a negative value is returned, otherwise the number of bytes
3785 * used or zero if no frame could be decompressed.
3787 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3788 int *got_picture_ptr,
3789 const uint8_t *buf, int buf_size);
3793 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3794 * Some decoders may support multiple frames in a single AVPacket, such
3795 * decoders would then just decode the first frame.
3797 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3798 * the actual read bytes because some optimized bitstream readers read 32 or 64
3799 * bits at once and could read over the end.
3801 * @warning The end of the input buffer buf should be set to 0 to ensure that
3802 * no overreading happens for damaged MPEG streams.
3804 * @note You might have to align the input buffer avpkt->data.
3805 * The alignment requirements depend on the CPU: on some CPUs it isn't
3806 * necessary at all, on others it won't work at all if not aligned and on others
3807 * it will work but it will have an impact on performance.
3809 * In practice, avpkt->data should have 4 byte alignment at minimum.
3811 * @note Some codecs have a delay between input and output, these need to be
3812 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3814 * @param avctx the codec context
3815 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3816 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3817 * allocate memory for the actual bitmap.
3818 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3819 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3820 * decodes and the decoder tells the user once it does not need the data anymore,
3821 * the user app can at this point free/reuse/keep the memory as it sees fit.
3823 * @param[in] avpkt The input AVpacket containing the input buffer.
3824 * You can create such packet with av_init_packet() and by then setting
3825 * data and size, some decoders might in addition need other fields like
3826 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3828 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3829 * @return On error a negative value is returned, otherwise the number of bytes
3830 * used or zero if no frame could be decompressed.
3832 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3833 int *got_picture_ptr,
3836 #if FF_API_SUBTITLE_OLD
3837 /* Decode a subtitle message. Return -1 if error, otherwise return the
3838 * number of bytes used. If no subtitle could be decompressed,
3839 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3840 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3842 const uint8_t *buf, int buf_size);
3846 * Decode a subtitle message.
3847 * Return a negative value on error, otherwise return the number of bytes used.
3848 * If no subtitle could be decompressed, got_sub_ptr is zero.
3849 * Otherwise, the subtitle is stored in *sub.
3850 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3851 * simplicity, because the performance difference is expect to be negligible
3852 * and reusing a get_buffer written for video codecs would probably perform badly
3853 * due to a potentially very different allocation pattern.
3855 * @param avctx the codec context
3856 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3857 freed with avsubtitle_free if *got_sub_ptr is set.
3858 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3859 * @param[in] avpkt The input AVPacket containing the input buffer.
3861 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3866 * Frees all allocated data in the given subtitle struct.
3868 * @param sub AVSubtitle to free.
3870 void avsubtitle_free(AVSubtitle *sub);
3872 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3874 uint8_t *buf, int buf_size);
3877 * Encode an audio frame from samples into buf.
3879 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3880 * However, for PCM audio the user will know how much space is needed
3881 * because it depends on the value passed in buf_size as described
3882 * below. In that case a lower value can be used.
3884 * @param avctx the codec context
3885 * @param[out] buf the output buffer
3886 * @param[in] buf_size the output buffer size
3887 * @param[in] samples the input buffer containing the samples
3888 * The number of samples read from this buffer is frame_size*channels,
3889 * both of which are defined in avctx.
3890 * For PCM audio the number of samples read from samples is equal to
3891 * buf_size * input_sample_size / output_sample_size.
3892 * @return On error a negative value is returned, on success zero or the number
3893 * of bytes used to encode the data read from the input buffer.
3895 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3896 const short *samples);
3899 * Encode a video frame from pict into buf.
3900 * The input picture should be
3901 * stored using a specific format, namely avctx.pix_fmt.
3903 * @param avctx the codec context
3904 * @param[out] buf the output buffer for the bitstream of encoded frame
3905 * @param[in] buf_size the size of the output buffer in bytes
3906 * @param[in] pict the input picture to encode
3907 * @return On error a negative value is returned, on success zero or the number
3908 * of bytes used from the output buffer.
3910 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3911 const AVFrame *pict);
3912 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3913 const AVSubtitle *sub);
3915 int avcodec_close(AVCodecContext *avctx);
3918 * Register all the codecs, parsers and bitstream filters which were enabled at
3919 * configuration time. If you do not call this function you can select exactly
3920 * which formats you want to support, by using the individual registration
3923 * @see avcodec_register
3924 * @see av_register_codec_parser
3925 * @see av_register_bitstream_filter
3927 void avcodec_register_all(void);
3930 * Flush buffers, should be called when seeking or when switching to a different stream.
3932 void avcodec_flush_buffers(AVCodecContext *avctx);
3934 void avcodec_default_free_buffers(AVCodecContext *s);
3936 /* misc useful functions */
3939 * Return a single letter to describe the given picture type pict_type.
3941 * @param[in] pict_type the picture type
3942 * @return A single character representing the picture type.
3944 char av_get_pict_type_char(int pict_type);
3947 * Return codec bits per sample.
3949 * @param[in] codec_id the codec
3950 * @return Number of bits per sample or zero if unknown for the given codec.
3952 int av_get_bits_per_sample(enum CodecID codec_id);
3954 #if FF_API_OLD_SAMPLE_FMT
3956 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3958 attribute_deprecated
3959 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3963 typedef struct AVCodecParserContext {
3965 struct AVCodecParser *parser;
3966 int64_t frame_offset; /* offset of the current frame */
3967 int64_t cur_offset; /* current offset
3968 (incremented by each av_parser_parse()) */
3969 int64_t next_frame_offset; /* offset of the next frame */
3971 int pict_type; /* XXX: Put it back in AVCodecContext. */
3973 * This field is used for proper frame duration computation in lavf.
3974 * It signals, how much longer the frame duration of the current frame
3975 * is compared to normal frame duration.
3977 * frame_duration = (1 + repeat_pict) * time_base
3979 * It is used by codecs like H.264 to display telecined material.
3981 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3982 int64_t pts; /* pts of the current frame */
3983 int64_t dts; /* dts of the current frame */
3988 int fetch_timestamp;
3990 #define AV_PARSER_PTS_NB 4
3991 int cur_frame_start_index;
3992 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3993 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3994 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3997 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3998 #define PARSER_FLAG_ONCE 0x0002
3999 /// Set if the parser has a valid file offset
4000 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4002 int64_t offset; ///< byte offset from starting packet start
4003 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4006 * Set by parser to 1 for key frames and 0 for non-key frames.
4007 * It is initialized to -1, so if the parser doesn't set this flag,
4008 * old-style fallback using FF_I_TYPE picture type as key frames
4014 * Time difference in stream time base units from the pts of this
4015 * packet to the point at which the output from the decoder has converged
4016 * independent from the availability of previous frames. That is, the
4017 * frames are virtually identical no matter if decoding started from
4018 * the very first frame or from this keyframe.
4019 * Is AV_NOPTS_VALUE if unknown.
4020 * This field is not the display duration of the current frame.
4021 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4024 * The purpose of this field is to allow seeking in streams that have no
4025 * keyframes in the conventional sense. It corresponds to the
4026 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4027 * essential for some types of subtitle streams to ensure that all
4028 * subtitles are correctly displayed after seeking.
4030 int64_t convergence_duration;
4032 // Timestamp generation support:
4034 * Synchronization point for start of timestamp generation.
4036 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4039 * For example, this corresponds to presence of H.264 buffering period
4045 * Offset of the current timestamp against last timestamp sync point in
4046 * units of AVCodecContext.time_base.
4048 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4049 * contain a valid timestamp offset.
4051 * Note that the timestamp of sync point has usually a nonzero
4052 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4053 * the next frame after timestamp sync point will be usually 1.
4055 * For example, this corresponds to H.264 cpb_removal_delay.
4057 int dts_ref_dts_delta;
4060 * Presentation delay of current frame in units of AVCodecContext.time_base.
4062 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4063 * contain valid non-negative timestamp delta (presentation time of a frame
4064 * must not lie in the past).
4066 * This delay represents the difference between decoding and presentation
4067 * time of the frame.
4069 * For example, this corresponds to H.264 dpb_output_delay.
4074 * Position of the packet in file.
4076 * Analogous to cur_frame_pts/dts
4078 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4081 * Byte position of currently parsed frame in stream.
4086 * Previous frame byte position.
4089 } AVCodecParserContext;
4091 typedef struct AVCodecParser {
4092 int codec_ids[5]; /* several codec IDs are permitted */
4094 int (*parser_init)(AVCodecParserContext *s);
4095 int (*parser_parse)(AVCodecParserContext *s,
4096 AVCodecContext *avctx,
4097 const uint8_t **poutbuf, int *poutbuf_size,
4098 const uint8_t *buf, int buf_size);
4099 void (*parser_close)(AVCodecParserContext *s);
4100 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4101 struct AVCodecParser *next;
4104 AVCodecParser *av_parser_next(AVCodecParser *c);
4106 void av_register_codec_parser(AVCodecParser *parser);
4107 AVCodecParserContext *av_parser_init(int codec_id);
4109 #if LIBAVCODEC_VERSION_MAJOR < 53
4110 attribute_deprecated
4111 int av_parser_parse(AVCodecParserContext *s,
4112 AVCodecContext *avctx,
4113 uint8_t **poutbuf, int *poutbuf_size,
4114 const uint8_t *buf, int buf_size,
4115 int64_t pts, int64_t dts);
4121 * @param s parser context.
4122 * @param avctx codec context.
4123 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4124 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4125 * @param buf input buffer.
4126 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4127 * @param pts input presentation timestamp.
4128 * @param dts input decoding timestamp.
4129 * @param pos input byte position in stream.
4130 * @return the number of bytes of the input bitstream used.
4135 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4142 * decode_frame(data, size);
4146 int av_parser_parse2(AVCodecParserContext *s,
4147 AVCodecContext *avctx,
4148 uint8_t **poutbuf, int *poutbuf_size,
4149 const uint8_t *buf, int buf_size,
4150 int64_t pts, int64_t dts,
4153 int av_parser_change(AVCodecParserContext *s,
4154 AVCodecContext *avctx,
4155 uint8_t **poutbuf, int *poutbuf_size,
4156 const uint8_t *buf, int buf_size, int keyframe);
4157 void av_parser_close(AVCodecParserContext *s);
4160 typedef struct AVBitStreamFilterContext {
4162 struct AVBitStreamFilter *filter;
4163 AVCodecParserContext *parser;
4164 struct AVBitStreamFilterContext *next;
4165 } AVBitStreamFilterContext;
4168 typedef struct AVBitStreamFilter {
4171 int (*filter)(AVBitStreamFilterContext *bsfc,
4172 AVCodecContext *avctx, const char *args,
4173 uint8_t **poutbuf, int *poutbuf_size,
4174 const uint8_t *buf, int buf_size, int keyframe);
4175 void (*close)(AVBitStreamFilterContext *bsfc);
4176 struct AVBitStreamFilter *next;
4177 } AVBitStreamFilter;
4179 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4180 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4181 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4182 AVCodecContext *avctx, const char *args,
4183 uint8_t **poutbuf, int *poutbuf_size,
4184 const uint8_t *buf, int buf_size, int keyframe);
4185 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4187 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4192 * Reallocate the given block if it is not large enough, otherwise do nothing.
4196 void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4199 * Allocate a buffer, reusing the given one if large enough.
4201 * Contrary to av_fast_realloc the current buffer contents might not be
4202 * preserved and on error the old buffer is freed, thus no special
4203 * handling to avoid memleaks is necessary.
4205 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4206 * @param size size of the buffer *ptr points to
4207 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4208 * *size 0 if an error occurred.
4210 void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4212 #if LIBAVCODEC_VERSION_MAJOR < 53
4214 * @deprecated Deprecated in favor of av_image_copy().
4216 attribute_deprecated
4217 void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4218 uint8_t *src_data[4], int src_linesize[4],
4219 enum PixelFormat pix_fmt, int width, int height);
4223 * Copy image src to dst. Wraps av_picture_data_copy() above.
4225 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4226 enum PixelFormat pix_fmt, int width, int height);
4229 * Crop image top and left side.
4231 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4232 enum PixelFormat pix_fmt, int top_band, int left_band);
4237 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4238 int padtop, int padbottom, int padleft, int padright, int *color);
4241 * Encode extradata length to a buffer. Used by xiph codecs.
4243 * @param s buffer to write to; must be at least (v/255+1) bytes long
4244 * @param v size of extradata in bytes
4245 * @return number of bytes written to the buffer.
4247 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4249 #if LIBAVCODEC_VERSION_MAJOR < 53
4251 * Parse str and put in width_ptr and height_ptr the detected values.
4253 * @deprecated Deprecated in favor of av_parse_video_size().
4255 attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4258 * Parse str and store the detected values in *frame_rate.
4260 * @deprecated Deprecated in favor of av_parse_video_rate().
4262 attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4266 * Logs a generic warning message about a missing feature. This function is
4267 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4268 * only, and would normally not be used by applications.
4269 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4270 * a pointer to an AVClass struct
4271 * @param[in] feature string containing the name of the missing feature
4272 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4273 * If want_sample is non-zero, additional verbage will be added to the log
4274 * message which tells the user how to report samples to the development
4277 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4280 * Log a generic warning message asking for a sample. This function is
4281 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4282 * only, and would normally not be used by applications.
4283 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4284 * a pointer to an AVClass struct
4285 * @param[in] msg string containing an optional message, or NULL if no message
4287 void av_log_ask_for_sample(void *avc, const char *msg);
4290 * Register the hardware accelerator hwaccel.
4292 void av_register_hwaccel(AVHWAccel *hwaccel);
4295 * If hwaccel is NULL, returns the first registered hardware accelerator,
4296 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4297 * after hwaccel, or NULL if hwaccel is the last one.
4299 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4303 * Lock operation used by lockmgr
4306 AV_LOCK_CREATE, ///< Create a mutex
4307 AV_LOCK_OBTAIN, ///< Lock the mutex
4308 AV_LOCK_RELEASE, ///< Unlock the mutex
4309 AV_LOCK_DESTROY, ///< Free mutex resources
4313 * Register a user provided lock manager supporting the operations
4314 * specified by AVLockOp. mutex points to a (void *) where the
4315 * lockmgr should store/get a pointer to a user allocated mutex. It's
4316 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4318 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4319 * callback during the call to av_lockmgr_register().
4320 * Thus, the application must be prepared to handle that.
4321 * If cb is set to NULL the lockmgr will be unregistered.
4322 * Also note that during unregistration the previously registered
4323 * lockmgr callback may also be invoked.
4325 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4327 #endif /* AVCODEC_AVCODEC_H */