2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavcore/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
34 #define LIBAVCODEC_VERSION_MAJOR 52
35 #define LIBAVCODEC_VERSION_MINOR 111
36 #define LIBAVCODEC_VERSION_MICRO 0
38 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
39 LIBAVCODEC_VERSION_MINOR, \
40 LIBAVCODEC_VERSION_MICRO)
41 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
42 LIBAVCODEC_VERSION_MINOR, \
43 LIBAVCODEC_VERSION_MICRO)
44 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
46 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
49 * Those FF_API_* defines are not part of public API.
50 * They may change, break or disappear at any time.
52 #ifndef FF_API_PALETTE_CONTROL
53 #define FF_API_PALETTE_CONTROL (LIBAVCODEC_VERSION_MAJOR < 54)
55 #ifndef FF_API_MM_FLAGS
56 #define FF_API_MM_FLAGS (LIBAVCODEC_VERSION_MAJOR < 53)
58 #ifndef FF_API_OPT_SHOW
59 #define FF_API_OPT_SHOW (LIBAVCODEC_VERSION_MAJOR < 53)
61 #ifndef FF_API_AUDIO_OLD
62 #define FF_API_AUDIO_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
64 #ifndef FF_API_VIDEO_OLD
65 #define FF_API_VIDEO_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
67 #ifndef FF_API_SUBTITLE_OLD
68 #define FF_API_SUBTITLE_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
70 #ifndef FF_API_USE_LPC
71 #define FF_API_USE_LPC (LIBAVCODEC_VERSION_MAJOR < 53)
73 #ifndef FF_API_SET_STRING_OLD
74 #define FF_API_SET_STRING_OLD (LIBAVCODEC_VERSION_MAJOR < 53)
76 #ifndef FF_API_INOFFICIAL
77 #define FF_API_INOFFICIAL (LIBAVCODEC_VERSION_MAJOR < 53)
79 #ifndef FF_API_OLD_SAMPLE_FMT
80 #define FF_API_OLD_SAMPLE_FMT (LIBAVCODEC_VERSION_MAJOR < 53)
82 #ifndef FF_API_OLD_AUDIOCONVERT
83 #define FF_API_OLD_AUDIOCONVERT (LIBAVCODEC_VERSION_MAJOR < 53)
86 #if LIBAVCODEC_VERSION_MAJOR < 53
87 # define FF_INTERNALC_MEM_TYPE unsigned int
89 # define FF_INTERNALC_MEM_TYPE size_t
93 * Identify the syntax and semantics of the bitstream.
94 * The principle is roughly:
95 * Two decoders with the same ID can decode the same streams.
96 * Two encoders with the same ID can encode compatible streams.
97 * There may be slight deviations from the principle due to implementation
100 * If you add a codec ID to this list, add it so that
101 * 1. no value of a existing codec ID changes (that would break ABI),
102 * 2. it is as close as possible to similar codecs.
109 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
110 CODEC_ID_MPEG2VIDEO_XVMC,
147 CODEC_ID_INTERPLAY_VIDEO,
159 CODEC_ID_TRUEMOTION1,
170 #if LIBAVCODEC_VERSION_MAJOR < 53
189 CODEC_ID_TRUEMOTION2,
206 CODEC_ID_DSICINVIDEO,
207 CODEC_ID_TIERTEXSEQVIDEO,
216 CODEC_ID_BETHSOFTVID,
234 CODEC_ID_MOTIONPIXELS,
252 CODEC_ID_IFF_BYTERUN1,
265 /* various PCM "codecs" */
266 CODEC_ID_PCM_S16LE= 0x10000,
282 CODEC_ID_PCM_S24DAUD,
284 CODEC_ID_PCM_S16LE_PLANAR,
293 /* various ADPCM codecs */
294 CODEC_ID_ADPCM_IMA_QT= 0x11000,
295 CODEC_ID_ADPCM_IMA_WAV,
296 CODEC_ID_ADPCM_IMA_DK3,
297 CODEC_ID_ADPCM_IMA_DK4,
298 CODEC_ID_ADPCM_IMA_WS,
299 CODEC_ID_ADPCM_IMA_SMJPEG,
308 CODEC_ID_ADPCM_YAMAHA,
309 CODEC_ID_ADPCM_SBPRO_4,
310 CODEC_ID_ADPCM_SBPRO_3,
311 CODEC_ID_ADPCM_SBPRO_2,
313 CODEC_ID_ADPCM_IMA_AMV,
314 CODEC_ID_ADPCM_EA_R1,
315 CODEC_ID_ADPCM_EA_R3,
316 CODEC_ID_ADPCM_EA_R2,
317 CODEC_ID_ADPCM_IMA_EA_SEAD,
318 CODEC_ID_ADPCM_IMA_EA_EACS,
319 CODEC_ID_ADPCM_EA_XAS,
320 CODEC_ID_ADPCM_EA_MAXIS_XA,
321 CODEC_ID_ADPCM_IMA_ISS,
325 CODEC_ID_AMR_NB= 0x12000,
328 /* RealAudio codecs*/
329 CODEC_ID_RA_144= 0x13000,
332 /* various DPCM codecs */
333 CODEC_ID_ROQ_DPCM= 0x14000,
334 CODEC_ID_INTERPLAY_DPCM,
339 CODEC_ID_MP2= 0x15000,
340 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 /* subtitle codecs */
395 CODEC_ID_DVD_SUBTITLE= 0x17000,
396 CODEC_ID_DVB_SUBTITLE,
397 CODEC_ID_TEXT, ///< raw UTF-8 text
401 CODEC_ID_HDMV_PGS_SUBTITLE,
402 CODEC_ID_DVB_TELETEXT,
405 /* other specific kind of codecs (generally used for attachments) */
406 CODEC_ID_TTF= 0x18000,
408 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
410 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
411 * stream (only used by libavformat) */
412 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
415 #if LIBAVCODEC_VERSION_MAJOR < 53
416 #define CodecType AVMediaType
418 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
419 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
420 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
421 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
422 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
423 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
424 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
427 #if FF_API_OLD_SAMPLE_FMT
428 #define SampleFormat AVSampleFormat
430 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
431 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
432 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
433 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
434 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
435 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
436 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
439 #if FF_API_OLD_AUDIOCONVERT
440 #include "libavcore/audioconvert.h"
442 /* Audio channel masks */
443 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
444 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
445 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
446 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
447 #define CH_BACK_LEFT AV_CH_BACK_LEFT
448 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
449 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
450 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
451 #define CH_BACK_CENTER AV_CH_BACK_CENTER
452 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
453 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
454 #define CH_TOP_CENTER AV_CH_TOP_CENTER
455 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
456 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
457 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
458 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
459 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
460 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
461 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
462 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
464 /** Channel mask value used for AVCodecContext.request_channel_layout
465 to indicate that the user requests the channel order of the decoder output
466 to be the native codec channel order. */
467 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
469 /* Audio channel convenience macros */
470 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
471 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
472 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
473 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
474 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
475 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
476 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
477 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
478 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
479 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
480 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
481 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
482 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
483 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
484 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
488 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
491 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
492 * This is mainly needed because some optimized bitstream readers read
493 * 32 or 64 bit at once and could read over the end.<br>
494 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
495 * MPEG bitstreams could cause overread and segfault.
497 #define FF_INPUT_BUFFER_PADDING_SIZE 8
500 * minimum encoding buffer size
501 * Used to avoid some checks during header writing.
503 #define FF_MIN_BUFFER_SIZE 16384
507 * motion estimation type.
510 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
514 ME_EPZS, ///< enhanced predictive zonal search
515 ME_X1, ///< reserved for experiments
516 ME_HEX, ///< hexagon based search
517 ME_UMH, ///< uneven multi-hexagon search
518 ME_ITER, ///< iterative search
519 ME_TESA, ///< transformed exhaustive search algorithm
523 /* We leave some space between them for extensions (drop some
524 * keyframes for intra-only or drop just some bidir frames). */
525 AVDISCARD_NONE =-16, ///< discard nothing
526 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
527 AVDISCARD_NONREF = 8, ///< discard all non reference
528 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
529 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
530 AVDISCARD_ALL = 48, ///< discard all
533 enum AVColorPrimaries{
534 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
535 AVCOL_PRI_UNSPECIFIED=2,
537 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
538 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
539 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
541 AVCOL_PRI_NB , ///< Not part of ABI
544 enum AVColorTransferCharacteristic{
545 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
546 AVCOL_TRC_UNSPECIFIED=2,
547 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
548 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
549 AVCOL_TRC_NB , ///< Not part of ABI
554 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
555 AVCOL_SPC_UNSPECIFIED=2,
557 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
558 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
559 AVCOL_SPC_SMPTE240M =7,
560 AVCOL_SPC_NB , ///< Not part of ABI
564 AVCOL_RANGE_UNSPECIFIED=0,
565 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
566 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
567 AVCOL_RANGE_NB , ///< Not part of ABI
571 * X X 3 4 X X are luma samples,
572 * 1 2 1-6 are possible chroma positions
573 * X X 5 6 X 0 is undefined/unknown position
575 enum AVChromaLocation{
576 AVCHROMA_LOC_UNSPECIFIED=0,
577 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
578 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
579 AVCHROMA_LOC_TOPLEFT =3, ///< DV
581 AVCHROMA_LOC_BOTTOMLEFT =5,
582 AVCHROMA_LOC_BOTTOM =6,
583 AVCHROMA_LOC_NB , ///< Not part of ABI
590 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
591 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
592 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
593 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
594 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
595 AV_LPC_TYPE_NB , ///< Not part of ABI
598 typedef struct RcOverride{
601 int qscale; // If this is 0 then quality_factor will be used instead.
602 float quality_factor;
605 #define FF_MAX_B_FRAMES 16
608 These flags can be passed in AVCodecContext.flags before initialization.
609 Note: Not everything is supported yet.
612 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
613 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
614 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
615 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
616 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
617 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
619 * The parent program guarantees that the input for B-frames containing
620 * streams is not written to for at least s->max_b_frames+1 frames, if
621 * this is not set the input will be copied.
623 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
624 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
625 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
626 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
627 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
628 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
629 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
630 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
631 location instead of only at frame boundaries. */
632 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
633 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
634 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
635 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
636 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
637 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
638 /* Fx : Flag for h263+ extra options */
639 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
640 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
641 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
642 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
643 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
644 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
645 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
646 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
647 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
648 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
649 #define CODEC_FLAG_CLOSED_GOP 0x80000000
650 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
651 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
652 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
653 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
654 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
655 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
656 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
657 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
658 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
659 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
660 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
661 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
662 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
663 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
664 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
665 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
666 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
667 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
668 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
669 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
670 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
671 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
673 /* Unsupported options :
674 * Syntax Arithmetic coding (SAC)
675 * Reference Picture Selection
676 * Independent Segment Decoding */
678 /* codec capabilities */
680 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
682 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
683 * If not set, it might not use get_buffer() at all or use operations that
684 * assume the buffer was allocated by avcodec_default_get_buffer.
686 #define CODEC_CAP_DR1 0x0002
687 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
688 #define CODEC_CAP_PARSE_ONLY 0x0004
689 #define CODEC_CAP_TRUNCATED 0x0008
690 /* Codec can export data for HW decoding (XvMC). */
691 #define CODEC_CAP_HWACCEL 0x0010
693 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
694 * If this is not set, the codec is guaranteed to never be fed with NULL data.
696 #define CODEC_CAP_DELAY 0x0020
698 * Codec can be fed a final frame with a smaller size.
699 * This can be used to prevent truncation of the last audio samples.
701 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
703 * Codec can export data for HW decoding (VDPAU).
705 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
707 * Codec can output multiple frames per AVPacket
708 * Normally demuxers return one frame at a time, demuxers which do not do
709 * are connected to a parser to split what they return into proper frames.
710 * This flag is reserved to the very rare category of codecs which have a
711 * bitstream that cannot be split into frames without timeconsuming
712 * operations like full decoding. Demuxers carring such bitstreams thus
713 * may return multiple frames in a packet. This has many disadvantages like
714 * prohibiting stream copy in many cases thus it should only be considered
717 #define CODEC_CAP_SUBFRAMES 0x0100
719 * Codec is experimental and is thus avoided in favor of non experimental
722 #define CODEC_CAP_EXPERIMENTAL 0x0200
724 * Codec should fill in channel configuration and samplerate instead of container
726 #define CODEC_CAP_CHANNEL_CONF 0x0400
728 * Codec is able to deal with negative linesizes
730 #define CODEC_CAP_NEG_LINESIZES 0x0800
732 * Codec supports frame-level multithreading.
734 #define CODEC_CAP_FRAME_THREADS 0x1000
736 //The following defines may change, don't expect compatibility if you use them.
737 #define MB_TYPE_INTRA4x4 0x0001
738 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
739 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
740 #define MB_TYPE_16x16 0x0008
741 #define MB_TYPE_16x8 0x0010
742 #define MB_TYPE_8x16 0x0020
743 #define MB_TYPE_8x8 0x0040
744 #define MB_TYPE_INTERLACED 0x0080
745 #define MB_TYPE_DIRECT2 0x0100 //FIXME
746 #define MB_TYPE_ACPRED 0x0200
747 #define MB_TYPE_GMC 0x0400
748 #define MB_TYPE_SKIP 0x0800
749 #define MB_TYPE_P0L0 0x1000
750 #define MB_TYPE_P1L0 0x2000
751 #define MB_TYPE_P0L1 0x4000
752 #define MB_TYPE_P1L1 0x8000
753 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
754 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
755 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
756 #define MB_TYPE_QUANT 0x00010000
757 #define MB_TYPE_CBP 0x00020000
758 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
762 * This specifies the area which should be displayed.
763 * Note there may be multiple such areas for one frame.
765 typedef struct AVPanScan{
768 * - encoding: Set by user.
769 * - decoding: Set by libavcodec.
774 * width and height in 1/16 pel
775 * - encoding: Set by user.
776 * - decoding: Set by libavcodec.
782 * position of the top left corner in 1/16 pel for up to 3 fields/frames
783 * - encoding: Set by user.
784 * - decoding: Set by libavcodec.
786 int16_t position[3][2];
789 #define FF_COMMON_FRAME \
791 * pointer to the picture planes.\
792 * This might be different from the first allocated byte\
799 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
800 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
806 * 1 -> keyframe, 0-> not\
807 * - encoding: Set by libavcodec.\
808 * - decoding: Set by libavcodec.\
813 * Picture type of the frame, see ?_TYPE below.\
814 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
815 * - decoding: Set by libavcodec.\
820 * presentation timestamp in time_base units (time when frame should be shown to user)\
821 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
822 * - encoding: MUST be set by user.\
823 * - decoding: Set by libavcodec.\
828 * picture number in bitstream order\
829 * - encoding: set by\
830 * - decoding: Set by libavcodec.\
832 int coded_picture_number;\
834 * picture number in display order\
835 * - encoding: set by\
836 * - decoding: Set by libavcodec.\
838 int display_picture_number;\
841 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
842 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
843 * - decoding: Set by libavcodec.\
848 * buffer age (1->was last buffer and dint change, 2->..., ...).\
849 * Set to INT_MAX if the buffer has not been used yet.\
850 * - encoding: unused\
851 * - decoding: MUST be set by get_buffer().\
856 * is this picture used as reference\
857 * The values for this are the same as the MpegEncContext.picture_structure\
858 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
859 * Set to 4 for delayed, non-reference frames.\
860 * - encoding: unused\
861 * - decoding: Set by libavcodec. (before get_buffer() call)).\
867 * - encoding: unused\
868 * - decoding: Set by libavcodec.\
870 int8_t *qscale_table;\
873 * - encoding: unused\
874 * - decoding: Set by libavcodec.\
879 * mbskip_table[mb]>=1 if MB didn't change\
880 * stride= mb_width = (width+15)>>4\
881 * - encoding: unused\
882 * - decoding: Set by libavcodec.\
884 uint8_t *mbskip_table;\
887 * motion vector table\
890 * int mv_sample_log2= 4 - motion_subsample_log2;\
891 * int mb_width= (width+15)>>4;\
892 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
893 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
895 * - encoding: Set by user.\
896 * - decoding: Set by libavcodec.\
898 int16_t (*motion_val[2])[2];\
901 * macroblock type table\
902 * mb_type_base + mb_width + 2\
903 * - encoding: Set by user.\
904 * - decoding: Set by libavcodec.\
909 * log2 of the size of the block which a single vector in motion_val represents: \
910 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
911 * - encoding: unused\
912 * - decoding: Set by libavcodec.\
914 uint8_t motion_subsample_log2;\
917 * for some private data of the user\
918 * - encoding: unused\
919 * - decoding: Set by user.\
925 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
926 * - decoding: unused\
931 * type of the buffer (to keep track of who has to deallocate data[*])\
932 * - encoding: Set by the one who allocates it.\
933 * - decoding: Set by the one who allocates it.\
934 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
939 * When decoding, this signals how much the picture must be delayed.\
940 * extra_delay = repeat_pict / (2*fps)\
941 * - encoding: unused\
942 * - decoding: Set by libavcodec.\
952 * The content of the picture is interlaced.\
953 * - encoding: Set by user.\
954 * - decoding: Set by libavcodec. (default 0)\
956 int interlaced_frame;\
959 * If the content is interlaced, is top field displayed first.\
960 * - encoding: Set by user.\
961 * - decoding: Set by libavcodec.\
963 int top_field_first;\
967 * - encoding: Set by user.\
968 * - decoding: Set by libavcodec.\
970 AVPanScan *pan_scan;\
973 * Tell user application that palette has changed from previous frame.\
974 * - encoding: ??? (no palette-enabled encoder yet)\
975 * - decoding: Set by libavcodec. (default 0).\
977 int palette_has_changed;\
980 * codec suggestion on buffer type if != 0\
981 * - encoding: unused\
982 * - decoding: Set by libavcodec. (before get_buffer() call)).\
988 * - encoding: unused\
989 * - decoding: Set by libavcodec.\
994 * motion reference frame index\
995 * the order in which these are stored can depend on the codec.\
996 * - encoding: Set by user.\
997 * - decoding: Set by libavcodec.\
999 int8_t *ref_index[2];\
1002 * reordered opaque 64bit (generally an integer or a double precision float\
1003 * PTS but can be anything). \
1004 * The user sets AVCodecContext.reordered_opaque to represent the input at\
1006 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
1007 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
1008 * @deprecated in favor of pkt_pts\
1009 * - encoding: unused\
1010 * - decoding: Read by user.\
1012 int64_t reordered_opaque;\
1015 * hardware accelerator private data (FFmpeg allocated)\
1016 * - encoding: unused\
1017 * - decoding: Set by libavcodec\
1019 void *hwaccel_picture_private;\
1022 * reordered pts from the last AVPacket that has been input into the decoder\
1023 * - encoding: unused\
1024 * - decoding: Read by user.\
1029 * dts from the last AVPacket that has been input into the decoder\
1030 * - encoding: unused\
1031 * - decoding: Read by user.\
1036 * the AVCodecContext which ff_thread_get_buffer() was last called on\
1037 * - encoding: Set by libavcodec.\
1038 * - decoding: Set by libavcodec.\
1040 struct AVCodecContext *owner;\
1043 * used by multithreading to store frame-specific info\
1044 * - encoding: Set by libavcodec.\
1045 * - decoding: Set by libavcodec.\
1047 void *thread_opaque;
1049 #define FF_QSCALE_TYPE_MPEG1 0
1050 #define FF_QSCALE_TYPE_MPEG2 1
1051 #define FF_QSCALE_TYPE_H264 2
1052 #define FF_QSCALE_TYPE_VP56 3
1054 #define FF_BUFFER_TYPE_INTERNAL 1
1055 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1056 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1057 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1060 #define FF_I_TYPE 1 ///< Intra
1061 #define FF_P_TYPE 2 ///< Predicted
1062 #define FF_B_TYPE 3 ///< Bi-dir predicted
1063 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1064 #define FF_SI_TYPE 5 ///< Switching Intra
1065 #define FF_SP_TYPE 6 ///< Switching Predicted
1066 #define FF_BI_TYPE 7
1068 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1069 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1070 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1071 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1073 typedef struct AVPacket {
1075 * Presentation timestamp in AVStream->time_base units; the time at which
1076 * the decompressed packet will be presented to the user.
1077 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1078 * pts MUST be larger or equal to dts as presentation cannot happen before
1079 * decompression, unless one wants to view hex dumps. Some formats misuse
1080 * the terms dts and pts/cts to mean something different. Such timestamps
1081 * must be converted to true pts/dts before they are stored in AVPacket.
1085 * Decompression timestamp in AVStream->time_base units; the time at which
1086 * the packet is decompressed.
1087 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1095 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1096 * Equals next_pts - this_pts in presentation order.
1099 void (*destruct)(struct AVPacket *);
1101 int64_t pos; ///< byte position in stream, -1 if unknown
1104 * Time difference in AVStream->time_base units from the pts of this
1105 * packet to the point at which the output from the decoder has converged
1106 * independent from the availability of previous frames. That is, the
1107 * frames are virtually identical no matter if decoding started from
1108 * the very first frame or from this keyframe.
1109 * Is AV_NOPTS_VALUE if unknown.
1110 * This field is not the display duration of the current packet.
1111 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1114 * The purpose of this field is to allow seeking in streams that have no
1115 * keyframes in the conventional sense. It corresponds to the
1116 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1117 * essential for some types of subtitle streams to ensure that all
1118 * subtitles are correctly displayed after seeking.
1120 int64_t convergence_duration;
1122 #define AV_PKT_FLAG_KEY 0x0001
1123 #if LIBAVCODEC_VERSION_MAJOR < 53
1124 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1128 * Audio Video Frame.
1129 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1131 * Removal, reordering and changes to existing fields require a major
1132 * version bump. No fields should be added into AVFrame before or after
1134 * sizeof(AVFrame) must not be used outside libav*.
1136 typedef struct AVFrame {
1141 * main external API structure.
1142 * New fields can be added to the end with minor version bumps.
1143 * Removal, reordering and changes to existing fields require a major
1145 * sizeof(AVCodecContext) must not be used outside libav*.
1147 typedef struct AVCodecContext {
1149 * information on struct for av_log
1150 * - set by avcodec_alloc_context
1152 const AVClass *av_class;
1154 * the average bitrate
1155 * - encoding: Set by user; unused for constant quantizer encoding.
1156 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1161 * number of bits the bitstream is allowed to diverge from the reference.
1162 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1163 * - encoding: Set by user; unused for constant quantizer encoding.
1164 * - decoding: unused
1166 int bit_rate_tolerance;
1170 * - encoding: Set by user.
1171 * - decoding: Set by user.
1176 * Some codecs need additional format info. It is stored here.
1177 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1178 * specific codec MUST set it correctly otherwise stream copy breaks.
1179 * In general use of this field by muxers is not recommanded.
1180 * - encoding: Set by libavcodec.
1181 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1186 * Motion estimation algorithm used for video coding.
1187 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1188 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1189 * - encoding: MUST be set by user.
1190 * - decoding: unused
1195 * some codecs need / can use extradata like Huffman tables.
1196 * mjpeg: Huffman tables
1197 * rv10: additional flags
1198 * mpeg4: global headers (they can be in the bitstream or here)
1199 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1200 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1201 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1202 * - encoding: Set/allocated/freed by libavcodec.
1203 * - decoding: Set/allocated/freed by user.
1209 * This is the fundamental unit of time (in seconds) in terms
1210 * of which frame timestamps are represented. For fixed-fps content,
1211 * timebase should be 1/framerate and timestamp increments should be
1213 * - encoding: MUST be set by user.
1214 * - decoding: Set by libavcodec.
1216 AVRational time_base;
1220 * picture width / height.
1221 * - encoding: MUST be set by user.
1222 * - decoding: Set by libavcodec.
1223 * Note: For compatibility it is possible to set this instead of
1224 * coded_width/height before decoding.
1228 #define FF_ASPECT_EXTENDED 15
1231 * the number of pictures in a group of pictures, or 0 for intra_only
1232 * - encoding: Set by user.
1233 * - decoding: unused
1238 * Pixel format, see PIX_FMT_xxx.
1239 * May be set by the demuxer if known from headers.
1240 * May be overriden by the decoder if it knows better.
1241 * - encoding: Set by user.
1242 * - decoding: Set by user if known, overridden by libavcodec if known
1244 enum PixelFormat pix_fmt;
1247 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1248 * has to read frames at native frame rate.
1249 * - encoding: Set by user.
1250 * - decoding: unused
1255 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1256 * decoder to draw a horizontal band. It improves cache usage. Not
1257 * all codecs can do that. You must check the codec capabilities
1259 * When multithreading is used, it may be called from multiple threads
1260 * at the same time; threads might draw different parts of the same AVFrame,
1261 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1263 * The function is also used by hardware acceleration APIs.
1264 * It is called at least once during frame decoding to pass
1265 * the data needed for hardware render.
1266 * In that mode instead of pixel data, AVFrame points to
1267 * a structure specific to the acceleration API. The application
1268 * reads the structure and can change some fields to indicate progress
1270 * - encoding: unused
1271 * - decoding: Set by user.
1272 * @param height the height of the slice
1273 * @param y the y position of the slice
1274 * @param type 1->top field, 2->bottom field, 3->frame
1275 * @param offset offset into the AVFrame.data from which the slice should be read
1277 void (*draw_horiz_band)(struct AVCodecContext *s,
1278 const AVFrame *src, int offset[4],
1279 int y, int type, int height);
1282 int sample_rate; ///< samples per second
1283 int channels; ///< number of audio channels
1286 * audio sample format
1287 * - encoding: Set by user.
1288 * - decoding: Set by libavcodec.
1290 enum AVSampleFormat sample_fmt; ///< sample format
1292 /* The following data should not be initialized. */
1294 * Samples per packet, initialized when calling 'init'.
1297 int frame_number; ///< audio or video frame number
1298 #if LIBAVCODEC_VERSION_MAJOR < 53
1299 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1303 * Number of frames the decoded output will be delayed relative to
1304 * the encoded input.
1305 * - encoding: Set by libavcodec.
1306 * - decoding: unused
1310 /* - encoding parameters */
1311 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1312 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1316 * - encoding: Set by user.
1317 * - decoding: unused
1323 * - encoding: Set by user.
1324 * - decoding: unused
1329 * maximum quantizer difference between frames
1330 * - encoding: Set by user.
1331 * - decoding: unused
1336 * maximum number of B-frames between non-B-frames
1337 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1338 * - encoding: Set by user.
1339 * - decoding: unused
1344 * qscale factor between IP and B-frames
1345 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1346 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1347 * - encoding: Set by user.
1348 * - decoding: unused
1350 float b_quant_factor;
1352 /** obsolete FIXME remove */
1354 #define FF_RC_STRATEGY_XVID 1
1356 int b_frame_strategy;
1360 * - encoding: unused
1361 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1362 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1366 struct AVCodec *codec;
1370 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1371 /* do its best to deliver a chunk with size */
1372 /* below rtp_payload_size, the chunk will start */
1373 /* with a start code on some codecs like H.263. */
1374 /* This doesn't take account of any particular */
1375 /* headers inside the transmitted RTP payload. */
1378 /* The RTP callback: This function is called */
1379 /* every time the encoder has a packet to send. */
1380 /* It depends on the encoder if the data starts */
1381 /* with a Start Code (it should). H.263 does. */
1382 /* mb_nb contains the number of macroblocks */
1383 /* encoded in the RTP payload. */
1384 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1386 /* statistics, used for 2-pass encoding */
1397 * number of bits used for the previously encoded frame
1398 * - encoding: Set by libavcodec.
1399 * - decoding: unused
1404 * Private data of the user, can be used to carry app specific stuff.
1405 * - encoding: Set by user.
1406 * - decoding: Set by user.
1410 char codec_name[32];
1411 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1412 enum CodecID codec_id; /* see CODEC_ID_xxx */
1415 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1416 * This is used to work around some encoder bugs.
1417 * A demuxer should set this to what is stored in the field used to identify the codec.
1418 * If there are multiple such fields in a container then the demuxer should choose the one
1419 * which maximizes the information about the used codec.
1420 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1421 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1422 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1424 * - encoding: Set by user, if not then the default based on codec_id will be used.
1425 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1427 unsigned int codec_tag;
1430 * Work around bugs in encoders which sometimes cannot be detected automatically.
1431 * - encoding: Set by user
1432 * - decoding: Set by user
1434 int workaround_bugs;
1435 #define FF_BUG_AUTODETECT 1 ///< autodetection
1436 #define FF_BUG_OLD_MSMPEG4 2
1437 #define FF_BUG_XVID_ILACE 4
1438 #define FF_BUG_UMP4 8
1439 #define FF_BUG_NO_PADDING 16
1440 #define FF_BUG_AMV 32
1441 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1442 #define FF_BUG_QPEL_CHROMA 64
1443 #define FF_BUG_STD_QPEL 128
1444 #define FF_BUG_QPEL_CHROMA2 256
1445 #define FF_BUG_DIRECT_BLOCKSIZE 512
1446 #define FF_BUG_EDGE 1024
1447 #define FF_BUG_HPEL_CHROMA 2048
1448 #define FF_BUG_DC_CLIP 4096
1449 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1450 #define FF_BUG_TRUNCATED 16384
1451 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1454 * luma single coefficient elimination threshold
1455 * - encoding: Set by user.
1456 * - decoding: unused
1458 int luma_elim_threshold;
1461 * chroma single coeff elimination threshold
1462 * - encoding: Set by user.
1463 * - decoding: unused
1465 int chroma_elim_threshold;
1468 * strictly follow the standard (MPEG4, ...).
1469 * - encoding: Set by user.
1470 * - decoding: Set by user.
1471 * Setting this to STRICT or higher means the encoder and decoder will
1472 * generally do stupid things, whereas setting it to unofficial or lower
1473 * will mean the encoder might produce output that is not supported by all
1474 * spec-compliant decoders. Decoders don't differentiate between normal,
1475 * unofficial and experimental (that is, they always try to decode things
1476 * when they can) unless they are explicitly asked to behave stupidly
1477 * (=strictly conform to the specs)
1479 int strict_std_compliance;
1480 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1481 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1482 #define FF_COMPLIANCE_NORMAL 0
1483 #if FF_API_INOFFICIAL
1484 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1486 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1487 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1490 * qscale offset between IP and B-frames
1491 * - encoding: Set by user.
1492 * - decoding: unused
1494 float b_quant_offset;
1497 * Error recognization; higher values will detect more errors but may
1498 * misdetect some more or less valid parts as errors.
1499 * - encoding: unused
1500 * - decoding: Set by user.
1502 int error_recognition;
1503 #define FF_ER_CAREFUL 1
1504 #define FF_ER_COMPLIANT 2
1505 #define FF_ER_AGGRESSIVE 3
1506 #define FF_ER_VERY_AGGRESSIVE 4
1509 * Called at the beginning of each frame to get a buffer for it.
1510 * If pic.reference is set then the frame will be read later by libavcodec.
1511 * avcodec_align_dimensions2() should be used to find the required width and
1512 * height, as they normally need to be rounded up to the next multiple of 16.
1513 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1514 * avcodec_default_get_buffer() instead of providing buffers allocated by
1516 * If frame multithreading is used and thread_safe_callbacks is set,
1517 * it may be called from a different thread, but not from more than one at once.
1518 * Does not need to be reentrant.
1519 * - encoding: unused
1520 * - decoding: Set by libavcodec, user can override.
1522 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1525 * Called to release buffers which were allocated with get_buffer.
1526 * A released buffer can be reused in get_buffer().
1527 * pic.data[*] must be set to NULL.
1528 * May be called from a different thread if frame multithreading is used,
1529 * but not by more than one thread at once, so does not need to be reentrant.
1530 * - encoding: unused
1531 * - decoding: Set by libavcodec, user can override.
1533 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1536 * Size of the frame reordering buffer in the decoder.
1537 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1538 * - encoding: Set by libavcodec.
1539 * - decoding: Set by libavcodec.
1544 * number of bytes per packet if constant and known or 0
1545 * Used by some WAV based audio codecs.
1549 int parse_only; /* - decoding only: If true, only parsing is done
1550 (function avcodec_parse_frame()). The frame
1551 data is returned. Only MPEG codecs support this now. */
1554 * 0-> h263 quant 1-> mpeg quant
1555 * - encoding: Set by user.
1556 * - decoding: unused
1561 * pass1 encoding statistics output buffer
1562 * - encoding: Set by libavcodec.
1563 * - decoding: unused
1568 * pass2 encoding statistics input buffer
1569 * Concatenated stuff from stats_out of pass1 should be placed here.
1570 * - encoding: Allocated/set/freed by user.
1571 * - decoding: unused
1576 * ratecontrol qmin qmax limiting method
1577 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1578 * - encoding: Set by user.
1579 * - decoding: unused
1587 * ratecontrol override, see RcOverride
1588 * - encoding: Allocated/set/freed by user.
1589 * - decoding: unused
1591 RcOverride *rc_override;
1592 int rc_override_count;
1595 * rate control equation
1596 * - encoding: Set by user
1597 * - decoding: unused
1603 * - encoding: Set by user.
1604 * - decoding: unused
1610 * - encoding: Set by user.
1611 * - decoding: unused
1616 * decoder bitstream buffer size
1617 * - encoding: Set by user.
1618 * - decoding: unused
1621 float rc_buffer_aggressivity;
1624 * qscale factor between P and I-frames
1625 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1626 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1627 * - encoding: Set by user.
1628 * - decoding: unused
1630 float i_quant_factor;
1633 * qscale offset between P and I-frames
1634 * - encoding: Set by user.
1635 * - decoding: unused
1637 float i_quant_offset;
1640 * initial complexity for pass1 ratecontrol
1641 * - encoding: Set by user.
1642 * - decoding: unused
1644 float rc_initial_cplx;
1647 * DCT algorithm, see FF_DCT_* below
1648 * - encoding: Set by user.
1649 * - decoding: unused
1652 #define FF_DCT_AUTO 0
1653 #define FF_DCT_FASTINT 1
1654 #define FF_DCT_INT 2
1655 #define FF_DCT_MMX 3
1656 #define FF_DCT_MLIB 4
1657 #define FF_DCT_ALTIVEC 5
1658 #define FF_DCT_FAAN 6
1661 * luminance masking (0-> disabled)
1662 * - encoding: Set by user.
1663 * - decoding: unused
1668 * temporary complexity masking (0-> disabled)
1669 * - encoding: Set by user.
1670 * - decoding: unused
1672 float temporal_cplx_masking;
1675 * spatial complexity masking (0-> disabled)
1676 * - encoding: Set by user.
1677 * - decoding: unused
1679 float spatial_cplx_masking;
1682 * p block masking (0-> disabled)
1683 * - encoding: Set by user.
1684 * - decoding: unused
1689 * darkness masking (0-> disabled)
1690 * - encoding: Set by user.
1691 * - decoding: unused
1696 * IDCT algorithm, see FF_IDCT_* below.
1697 * - encoding: Set by user.
1698 * - decoding: Set by user.
1701 #define FF_IDCT_AUTO 0
1702 #define FF_IDCT_INT 1
1703 #define FF_IDCT_SIMPLE 2
1704 #define FF_IDCT_SIMPLEMMX 3
1705 #define FF_IDCT_LIBMPEG2MMX 4
1706 #define FF_IDCT_PS2 5
1707 #define FF_IDCT_MLIB 6
1708 #define FF_IDCT_ARM 7
1709 #define FF_IDCT_ALTIVEC 8
1710 #define FF_IDCT_SH4 9
1711 #define FF_IDCT_SIMPLEARM 10
1712 #define FF_IDCT_H264 11
1713 #define FF_IDCT_VP3 12
1714 #define FF_IDCT_IPP 13
1715 #define FF_IDCT_XVIDMMX 14
1716 #define FF_IDCT_CAVS 15
1717 #define FF_IDCT_SIMPLEARMV5TE 16
1718 #define FF_IDCT_SIMPLEARMV6 17
1719 #define FF_IDCT_SIMPLEVIS 18
1720 #define FF_IDCT_WMV2 19
1721 #define FF_IDCT_FAAN 20
1722 #define FF_IDCT_EA 21
1723 #define FF_IDCT_SIMPLENEON 22
1724 #define FF_IDCT_SIMPLEALPHA 23
1725 #define FF_IDCT_BINK 24
1729 * - encoding: Set by libavcodec.
1730 * - decoding: Set by user (or 0).
1734 * slice offsets in the frame in bytes
1735 * - encoding: Set/allocated by libavcodec.
1736 * - decoding: Set/allocated by user (or NULL).
1741 * error concealment flags
1742 * - encoding: unused
1743 * - decoding: Set by user.
1745 int error_concealment;
1746 #define FF_EC_GUESS_MVS 1
1747 #define FF_EC_DEBLOCK 2
1750 * dsp_mask could be add used to disable unwanted CPU features
1751 * CPU features (i.e. MMX, SSE. ...)
1753 * With the FORCE flag you may instead enable given CPU features.
1754 * (Dangerous: Usable in case of misdetection, improper usage however will
1755 * result into program crash.)
1760 #define FF_MM_FORCE AV_CPU_FLAG_FORCE
1761 #define FF_MM_MMX AV_CPU_FLAG_MMX
1762 #define FF_MM_3DNOW AV_CPU_FLAG_3DNOW
1763 #define FF_MM_MMXEXT AV_CPU_FLAG_MMX2
1764 #define FF_MM_MMX2 AV_CPU_FLAG_MMX2
1765 #define FF_MM_SSE AV_CPU_FLAG_SSE
1766 #define FF_MM_SSE2 AV_CPU_FLAG_SSE2
1767 #define FF_MM_SSE2SLOW AV_CPU_FLAG_SSE2SLOW
1768 #define FF_MM_3DNOWEXT AV_CPU_FLAG_3DNOWEXT
1769 #define FF_MM_SSE3 AV_CPU_FLAG_SSE3
1770 #define FF_MM_SSE3SLOW AV_CPU_FLAG_SSE3SLOW
1771 #define FF_MM_SSSE3 AV_CPU_FLAG_SSSE3
1772 #define FF_MM_SSE4 AV_CPU_FLAG_SSE4
1773 #define FF_MM_SSE42 AV_CPU_FLAG_SSE42
1774 #define FF_MM_IWMMXT AV_CPU_FLAG_IWMMXT
1775 #define FF_MM_ALTIVEC AV_CPU_FLAG_ALTIVEC
1779 * bits per sample/pixel from the demuxer (needed for huffyuv).
1780 * - encoding: Set by libavcodec.
1781 * - decoding: Set by user.
1783 int bits_per_coded_sample;
1786 * prediction method (needed for huffyuv)
1787 * - encoding: Set by user.
1788 * - decoding: unused
1790 int prediction_method;
1791 #define FF_PRED_LEFT 0
1792 #define FF_PRED_PLANE 1
1793 #define FF_PRED_MEDIAN 2
1796 * sample aspect ratio (0 if unknown)
1797 * That is the width of a pixel divided by the height of the pixel.
1798 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1799 * - encoding: Set by user.
1800 * - decoding: Set by libavcodec.
1802 AVRational sample_aspect_ratio;
1805 * the picture in the bitstream
1806 * - encoding: Set by libavcodec.
1807 * - decoding: Set by libavcodec.
1809 AVFrame *coded_frame;
1813 * - encoding: Set by user.
1814 * - decoding: Set by user.
1817 #define FF_DEBUG_PICT_INFO 1
1818 #define FF_DEBUG_RC 2
1819 #define FF_DEBUG_BITSTREAM 4
1820 #define FF_DEBUG_MB_TYPE 8
1821 #define FF_DEBUG_QP 16
1822 #define FF_DEBUG_MV 32
1823 #define FF_DEBUG_DCT_COEFF 0x00000040
1824 #define FF_DEBUG_SKIP 0x00000080
1825 #define FF_DEBUG_STARTCODE 0x00000100
1826 #define FF_DEBUG_PTS 0x00000200
1827 #define FF_DEBUG_ER 0x00000400
1828 #define FF_DEBUG_MMCO 0x00000800
1829 #define FF_DEBUG_BUGS 0x00001000
1830 #define FF_DEBUG_VIS_QP 0x00002000
1831 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1832 #define FF_DEBUG_BUFFERS 0x00008000
1833 #define FF_DEBUG_THREADS 0x00010000
1837 * - encoding: Set by user.
1838 * - decoding: Set by user.
1841 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1842 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1843 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1847 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1848 * - decoding: unused
1853 * minimum MB quantizer
1854 * - encoding: unused
1855 * - decoding: unused
1860 * maximum MB quantizer
1861 * - encoding: unused
1862 * - decoding: unused
1867 * motion estimation comparison function
1868 * - encoding: Set by user.
1869 * - decoding: unused
1873 * subpixel motion estimation comparison function
1874 * - encoding: Set by user.
1875 * - decoding: unused
1879 * macroblock comparison function (not supported yet)
1880 * - encoding: Set by user.
1881 * - decoding: unused
1885 * interlaced DCT comparison function
1886 * - encoding: Set by user.
1887 * - decoding: unused
1890 #define FF_CMP_SAD 0
1891 #define FF_CMP_SSE 1
1892 #define FF_CMP_SATD 2
1893 #define FF_CMP_DCT 3
1894 #define FF_CMP_PSNR 4
1895 #define FF_CMP_BIT 5
1897 #define FF_CMP_ZERO 7
1898 #define FF_CMP_VSAD 8
1899 #define FF_CMP_VSSE 9
1900 #define FF_CMP_NSSE 10
1901 #define FF_CMP_W53 11
1902 #define FF_CMP_W97 12
1903 #define FF_CMP_DCTMAX 13
1904 #define FF_CMP_DCT264 14
1905 #define FF_CMP_CHROMA 256
1908 * ME diamond size & shape
1909 * - encoding: Set by user.
1910 * - decoding: unused
1915 * amount of previous MV predictors (2a+1 x 2a+1 square)
1916 * - encoding: Set by user.
1917 * - decoding: unused
1919 int last_predictor_count;
1922 * prepass for motion estimation
1923 * - encoding: Set by user.
1924 * - decoding: unused
1929 * motion estimation prepass comparison function
1930 * - encoding: Set by user.
1931 * - decoding: unused
1936 * ME prepass diamond size & shape
1937 * - encoding: Set by user.
1938 * - decoding: unused
1944 * - encoding: Set by user.
1945 * - decoding: unused
1947 int me_subpel_quality;
1950 * callback to negotiate the pixelFormat
1951 * @param fmt is the list of formats which are supported by the codec,
1952 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1953 * The first is always the native one.
1954 * @return the chosen format
1955 * - encoding: unused
1956 * - decoding: Set by user, if not set the native format will be chosen.
1958 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1961 * DTG active format information (additional aspect ratio
1962 * information only used in DVB MPEG-2 transport streams)
1965 * - encoding: unused
1966 * - decoding: Set by decoder.
1968 int dtg_active_format;
1969 #define FF_DTG_AFD_SAME 8
1970 #define FF_DTG_AFD_4_3 9
1971 #define FF_DTG_AFD_16_9 10
1972 #define FF_DTG_AFD_14_9 11
1973 #define FF_DTG_AFD_4_3_SP_14_9 13
1974 #define FF_DTG_AFD_16_9_SP_14_9 14
1975 #define FF_DTG_AFD_SP_4_3 15
1978 * maximum motion estimation search range in subpel units
1979 * If 0 then no limit.
1981 * - encoding: Set by user.
1982 * - decoding: unused
1987 * intra quantizer bias
1988 * - encoding: Set by user.
1989 * - decoding: unused
1991 int intra_quant_bias;
1992 #define FF_DEFAULT_QUANT_BIAS 999999
1995 * inter quantizer bias
1996 * - encoding: Set by user.
1997 * - decoding: unused
1999 int inter_quant_bias;
2003 * - encoding: unused
2004 * - decoding: Which clrtable should be used for 8bit RGB images.
2005 * Tables have to be stored somewhere. FIXME
2010 * internal_buffer count
2011 * Don't touch, used by libavcodec default_get_buffer().
2013 int internal_buffer_count;
2017 * Don't touch, used by libavcodec default_get_buffer().
2019 void *internal_buffer;
2022 * Global quality for codecs which cannot change it per frame.
2023 * This should be proportional to MPEG-1/2/4 qscale.
2024 * - encoding: Set by user.
2025 * - decoding: unused
2029 #define FF_CODER_TYPE_VLC 0
2030 #define FF_CODER_TYPE_AC 1
2031 #define FF_CODER_TYPE_RAW 2
2032 #define FF_CODER_TYPE_RLE 3
2033 #define FF_CODER_TYPE_DEFLATE 4
2036 * - encoding: Set by user.
2037 * - decoding: unused
2043 * - encoding: Set by user.
2044 * - decoding: unused
2050 * - encoding: unused
2051 * - decoding: Set by user.
2053 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2058 * - encoding: unused
2059 * - decoding: Set by user.
2062 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2063 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2064 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2067 * XVideo Motion Acceleration
2068 * - encoding: forbidden
2069 * - decoding: set by decoder
2071 int xvmc_acceleration;
2074 * macroblock decision mode
2075 * - encoding: Set by user.
2076 * - decoding: unused
2079 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2080 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2081 #define FF_MB_DECISION_RD 2 ///< rate distortion
2084 * custom intra quantization matrix
2085 * - encoding: Set by user, can be NULL.
2086 * - decoding: Set by libavcodec.
2088 uint16_t *intra_matrix;
2091 * custom inter quantization matrix
2092 * - encoding: Set by user, can be NULL.
2093 * - decoding: Set by libavcodec.
2095 uint16_t *inter_matrix;
2098 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2099 * This is used to work around some encoder bugs.
2100 * - encoding: unused
2101 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2103 unsigned int stream_codec_tag;
2106 * scene change detection threshold
2107 * 0 is default, larger means fewer detected scene changes.
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int scenechange_threshold;
2114 * minimum Lagrange multipler
2115 * - encoding: Set by user.
2116 * - decoding: unused
2121 * maximum Lagrange multipler
2122 * - encoding: Set by user.
2123 * - decoding: unused
2127 #if FF_API_PALETTE_CONTROL
2129 * palette control structure
2130 * - encoding: ??? (no palette-enabled encoder yet)
2131 * - decoding: Set by user.
2133 struct AVPaletteControl *palctrl;
2137 * noise reduction strength
2138 * - encoding: Set by user.
2139 * - decoding: unused
2141 int noise_reduction;
2144 * Called at the beginning of a frame to get cr buffer for it.
2145 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2146 * libavcodec will pass previous buffer in pic, function should return
2147 * same buffer or new buffer with old frame "painted" into it.
2148 * If pic.data[0] == NULL must behave like get_buffer().
2149 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2150 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2152 * - encoding: unused
2153 * - decoding: Set by libavcodec, user can override.
2155 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2158 * Number of bits which should be loaded into the rc buffer before decoding starts.
2159 * - encoding: Set by user.
2160 * - decoding: unused
2162 int rc_initial_buffer_occupancy;
2166 * - encoding: Set by user.
2167 * - decoding: unused
2169 int inter_threshold;
2173 * - encoding: Set by user.
2174 * - decoding: Set by user.
2179 * Simulates errors in the bitstream to test error concealment.
2180 * - encoding: Set by user.
2181 * - decoding: unused
2186 * MP3 antialias algorithm, see FF_AA_* below.
2187 * - encoding: unused
2188 * - decoding: Set by user.
2191 #define FF_AA_AUTO 0
2192 #define FF_AA_FASTINT 1 //not implemented yet
2194 #define FF_AA_FLOAT 3
2196 * quantizer noise shaping
2197 * - encoding: Set by user.
2198 * - decoding: unused
2200 int quantizer_noise_shaping;
2204 * is used to decide how many independent tasks should be passed to execute()
2205 * - encoding: Set by user.
2206 * - decoding: Set by user.
2211 * The codec may call this to execute several independent things.
2212 * It will return only after finishing all tasks.
2213 * The user may replace this with some multithreaded implementation,
2214 * the default implementation will execute the parts serially.
2215 * @param count the number of things to execute
2216 * - encoding: Set by libavcodec, user can override.
2217 * - decoding: Set by libavcodec, user can override.
2219 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2223 * Can be used by execute() to store some per AVCodecContext stuff.
2224 * - encoding: set by execute()
2225 * - decoding: set by execute()
2227 void *thread_opaque;
2230 * Motion estimation threshold below which no motion estimation is
2231 * performed, but instead the user specified motion vectors are used.
2233 * - encoding: Set by user.
2234 * - decoding: unused
2239 * Macroblock threshold below which the user specified macroblock types will be used.
2240 * - encoding: Set by user.
2241 * - decoding: unused
2246 * precision of the intra DC coefficient - 8
2247 * - encoding: Set by user.
2248 * - decoding: unused
2250 int intra_dc_precision;
2253 * noise vs. sse weight for the nsse comparsion function
2254 * - encoding: Set by user.
2255 * - decoding: unused
2260 * Number of macroblock rows at the top which are skipped.
2261 * - encoding: unused
2262 * - decoding: Set by user.
2267 * Number of macroblock rows at the bottom which are skipped.
2268 * - encoding: unused
2269 * - decoding: Set by user.
2275 * - encoding: Set by user.
2276 * - decoding: Set by libavcodec.
2279 #define FF_PROFILE_UNKNOWN -99
2281 #define FF_PROFILE_AAC_MAIN 0
2282 #define FF_PROFILE_AAC_LOW 1
2283 #define FF_PROFILE_AAC_SSR 2
2284 #define FF_PROFILE_AAC_LTP 3
2286 #define FF_PROFILE_DTS 20
2287 #define FF_PROFILE_DTS_ES 30
2288 #define FF_PROFILE_DTS_96_24 40
2289 #define FF_PROFILE_DTS_HD_HRA 50
2290 #define FF_PROFILE_DTS_HD_MA 60
2292 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2293 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2295 #define FF_PROFILE_H264_BASELINE 66
2296 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2297 #define FF_PROFILE_H264_MAIN 77
2298 #define FF_PROFILE_H264_EXTENDED 88
2299 #define FF_PROFILE_H264_HIGH 100
2300 #define FF_PROFILE_H264_HIGH_10 110
2301 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2302 #define FF_PROFILE_H264_HIGH_422 122
2303 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2304 #define FF_PROFILE_H264_HIGH_444 144
2305 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2306 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2307 #define FF_PROFILE_H264_CAVLC_444 44
2311 * - encoding: Set by user.
2312 * - decoding: Set by libavcodec.
2315 #define FF_LEVEL_UNKNOWN -99
2318 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2319 * - encoding: unused
2320 * - decoding: Set by user.
2325 * Bitstream width / height, may be different from width/height if lowres
2326 * or other things are used.
2327 * - encoding: unused
2328 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2330 int coded_width, coded_height;
2333 * frame skip threshold
2334 * - encoding: Set by user.
2335 * - decoding: unused
2337 int frame_skip_threshold;
2341 * - encoding: Set by user.
2342 * - decoding: unused
2344 int frame_skip_factor;
2347 * frame skip exponent
2348 * - encoding: Set by user.
2349 * - decoding: unused
2354 * frame skip comparison function
2355 * - encoding: Set by user.
2356 * - decoding: unused
2361 * Border processing masking, raises the quantizer for mbs on the borders
2363 * - encoding: Set by user.
2364 * - decoding: unused
2366 float border_masking;
2369 * minimum MB lagrange multipler
2370 * - encoding: Set by user.
2371 * - decoding: unused
2376 * maximum MB lagrange multipler
2377 * - encoding: Set by user.
2378 * - decoding: unused
2384 * - encoding: Set by user.
2385 * - decoding: unused
2387 int me_penalty_compensation;
2391 * - encoding: unused
2392 * - decoding: Set by user.
2394 enum AVDiscard skip_loop_filter;
2398 * - encoding: unused
2399 * - decoding: Set by user.
2401 enum AVDiscard skip_idct;
2405 * - encoding: unused
2406 * - decoding: Set by user.
2408 enum AVDiscard skip_frame;
2412 * - encoding: Set by user.
2413 * - decoding: unused
2419 * - encoding: Set by user.
2420 * - decoding: unused
2425 * constant rate factor - quality-based VBR - values ~correspond to qps
2426 * - encoding: Set by user.
2427 * - decoding: unused
2432 * constant quantization parameter rate control method
2433 * - encoding: Set by user.
2434 * - decoding: unused
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * number of reference frames
2447 * - encoding: Set by user.
2448 * - decoding: Set by lavc.
2453 * chroma qp offset from luma
2454 * - encoding: Set by user.
2455 * - decoding: unused
2460 * Influences how often B-frames are used.
2461 * - encoding: Set by user.
2462 * - decoding: unused
2467 * trellis RD quantization
2468 * - encoding: Set by user.
2469 * - decoding: unused
2474 * Reduce fluctuations in qp (before curve compression).
2475 * - encoding: Set by user.
2476 * - decoding: unused
2478 float complexityblur;
2481 * in-loop deblocking filter alphac0 parameter
2482 * alpha is in the range -6...6
2483 * - encoding: Set by user.
2484 * - decoding: unused
2489 * in-loop deblocking filter beta parameter
2490 * beta is in the range -6...6
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2498 * - encoding: Set by user.
2499 * - decoding: unused
2502 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2503 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2504 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2505 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2506 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2509 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2510 * - encoding: Set by user.
2511 * - decoding: unused
2516 * Audio cutoff bandwidth (0 means "automatic")
2517 * - encoding: Set by user.
2518 * - decoding: unused
2523 * Multiplied by qscale for each frame and added to scene_change_score.
2524 * - encoding: Set by user.
2525 * - decoding: unused
2527 int scenechange_factor;
2531 * Note: Value depends upon the compare function used for fullpel ME.
2532 * - encoding: Set by user.
2533 * - decoding: unused
2538 * Adjusts sensitivity of b_frame_strategy 1.
2539 * - encoding: Set by user.
2540 * - decoding: unused
2545 * - encoding: Set by user.
2546 * - decoding: unused
2548 int compression_level;
2549 #define FF_COMPRESSION_DEFAULT -1
2553 * Sets whether to use LPC mode - used by FLAC encoder.
2554 * - encoding: Set by user.
2555 * - decoding: unused
2556 * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2562 * LPC coefficient precision - used by FLAC encoder
2563 * - encoding: Set by user.
2564 * - decoding: unused
2566 int lpc_coeff_precision;
2569 * - encoding: Set by user.
2570 * - decoding: unused
2572 int min_prediction_order;
2575 * - encoding: Set by user.
2576 * - decoding: unused
2578 int max_prediction_order;
2581 * search method for selecting prediction order
2582 * - encoding: Set by user.
2583 * - decoding: unused
2585 int prediction_order_method;
2588 * - encoding: Set by user.
2589 * - decoding: unused
2591 int min_partition_order;
2594 * - encoding: Set by user.
2595 * - decoding: unused
2597 int max_partition_order;
2600 * GOP timecode frame start number, in non drop frame format
2601 * - encoding: Set by user.
2602 * - decoding: unused
2604 int64_t timecode_frame_start;
2606 #if LIBAVCODEC_VERSION_MAJOR < 53
2608 * Decoder should decode to this many channels if it can (0 for default)
2609 * - encoding: unused
2610 * - decoding: Set by user.
2611 * @deprecated Deprecated in favor of request_channel_layout.
2613 int request_channels;
2617 * Percentage of dynamic range compression to be applied by the decoder.
2618 * The default value is 1.0, corresponding to full compression.
2619 * - encoding: unused
2620 * - decoding: Set by user.
2625 * opaque 64bit number (generally a PTS) that will be reordered and
2626 * output in AVFrame.reordered_opaque
2627 * @deprecated in favor of pkt_pts
2628 * - encoding: unused
2629 * - decoding: Set by user.
2631 int64_t reordered_opaque;
2634 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2635 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2636 * - encoding: set by user.
2637 * - decoding: set by libavcodec.
2639 int bits_per_raw_sample;
2642 * Audio channel layout.
2643 * - encoding: set by user.
2644 * - decoding: set by libavcodec.
2646 int64_t channel_layout;
2649 * Request decoder to use this channel layout if it can (0 for default)
2650 * - encoding: unused
2651 * - decoding: Set by user.
2653 int64_t request_channel_layout;
2656 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2657 * - encoding: Set by user.
2658 * - decoding: unused.
2660 float rc_max_available_vbv_use;
2663 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2664 * - encoding: Set by user.
2665 * - decoding: unused.
2667 float rc_min_vbv_overflow_use;
2670 * Hardware accelerator in use
2671 * - encoding: unused.
2672 * - decoding: Set by libavcodec
2674 struct AVHWAccel *hwaccel;
2677 * For some codecs, the time base is closer to the field rate than the frame rate.
2678 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2679 * if no telecine is used ...
2681 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2683 int ticks_per_frame;
2686 * Hardware accelerator context.
2687 * For some hardware accelerators, a global context needs to be
2688 * provided by the user. In that case, this holds display-dependent
2689 * data FFmpeg cannot instantiate itself. Please refer to the
2690 * FFmpeg HW accelerator documentation to know how to fill this
2691 * is. e.g. for VA API, this is a struct vaapi_context.
2692 * - encoding: unused
2693 * - decoding: Set by user
2695 void *hwaccel_context;
2698 * Chromaticity coordinates of the source primaries.
2699 * - encoding: Set by user
2700 * - decoding: Set by libavcodec
2702 enum AVColorPrimaries color_primaries;
2705 * Color Transfer Characteristic.
2706 * - encoding: Set by user
2707 * - decoding: Set by libavcodec
2709 enum AVColorTransferCharacteristic color_trc;
2712 * YUV colorspace type.
2713 * - encoding: Set by user
2714 * - decoding: Set by libavcodec
2716 enum AVColorSpace colorspace;
2719 * MPEG vs JPEG YUV range.
2720 * - encoding: Set by user
2721 * - decoding: Set by libavcodec
2723 enum AVColorRange color_range;
2726 * This defines the location of chroma samples.
2727 * - encoding: Set by user
2728 * - decoding: Set by libavcodec
2730 enum AVChromaLocation chroma_sample_location;
2733 * The codec may call this to execute several independent things.
2734 * It will return only after finishing all tasks.
2735 * The user may replace this with some multithreaded implementation,
2736 * the default implementation will execute the parts serially.
2737 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2738 * @param c context passed also to func
2739 * @param count the number of things to execute
2740 * @param arg2 argument passed unchanged to func
2741 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2742 * @param func function that will be called count times, with jobnr from 0 to count-1.
2743 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2744 * two instances of func executing at the same time will have the same threadnr.
2745 * @return always 0 currently, but code should handle a future improvement where when any call to func
2746 * returns < 0 no further calls to func may be done and < 0 is returned.
2747 * - encoding: Set by libavcodec, user can override.
2748 * - decoding: Set by libavcodec, user can override.
2750 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2753 * explicit P-frame weighted prediction analysis method
2755 * 1: fast blind weighting (one reference duplicate with -1 offset)
2756 * 2: smart weighting (full fade detection analysis)
2757 * - encoding: Set by user.
2758 * - decoding: unused
2760 int weighted_p_pred;
2765 * 1: Variance AQ (complexity mask)
2766 * 2: Auto-variance AQ (experimental)
2767 * - encoding: Set by user
2768 * - decoding: unused
2774 * Reduces blocking and blurring in flat and textured areas.
2775 * - encoding: Set by user
2776 * - decoding: unused
2782 * Strength of psychovisual optimization
2783 * - encoding: Set by user
2784 * - decoding: unused
2790 * Strength of psychovisual optimization
2791 * - encoding: Set by user
2792 * - decoding: unused
2798 * Number of frames for frametype and ratecontrol lookahead
2799 * - encoding: Set by user
2800 * - decoding: unused
2805 * Constant rate factor maximum
2806 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2807 * than crf_max, even if doing so would violate VBV restrictions.
2808 * - encoding: Set by user.
2809 * - decoding: unused
2813 int log_level_offset;
2816 * Determines which LPC analysis algorithm to use.
2817 * - encoding: Set by user
2818 * - decoding: unused
2820 enum AVLPCType lpc_type;
2823 * Number of passes to use for Cholesky factorization during LPC analysis
2824 * - encoding: Set by user
2825 * - decoding: unused
2831 * Indicates number of picture subdivisions. Used for parallelized
2833 * - encoding: Set by user
2834 * - decoding: unused
2839 * Header containing style information for text subtitles.
2840 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2841 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2842 * the Format line following. It shouldn't include any Dialogue line.
2843 * - encoding: Set/allocated/freed by user (before avcodec_open())
2844 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2846 uint8_t *subtitle_header;
2847 int subtitle_header_size;
2850 * Current packet as passed into the decoder, to avoid having
2851 * to pass the packet into every function. Currently only valid
2852 * inside lavc and get/release_buffer callbacks.
2853 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2854 * - encoding: unused
2859 * Whether this is a copy of the context which had init() called on it.
2860 * This is used by multithreading - shared tables and picture pointers
2861 * should be freed from the original context only.
2862 * - encoding: Set by libavcodec.
2863 * - decoding: Set by libavcodec.
2868 * Which multithreading methods to use.
2869 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2870 * so clients which cannot provide future frames should not use it.
2872 * - encoding: Set by user, otherwise the default is used.
2873 * - decoding: Set by user, otherwise the default is used.
2876 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2877 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2880 * Which multithreading methods are in use by the codec.
2881 * - encoding: Set by libavcodec.
2882 * - decoding: Set by libavcodec.
2884 int active_thread_type;
2887 * Set by the client if its custom get_buffer() callback can be called
2888 * from another thread, which allows faster multithreaded decoding.
2889 * draw_horiz_band() will be called from other threads regardless of this setting.
2890 * Ignored if the default get_buffer() is used.
2891 * - encoding: Set by user.
2892 * - decoding: Set by user.
2894 int thread_safe_callbacks;
2900 typedef struct AVProfile {
2902 const char *name; ///< short name for the profile
2908 typedef struct AVCodec {
2910 * Name of the codec implementation.
2911 * The name is globally unique among encoders and among decoders (but an
2912 * encoder and a decoder can share the same name).
2913 * This is the primary way to find a codec from the user perspective.
2916 enum AVMediaType type;
2919 int (*init)(AVCodecContext *);
2920 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2921 int (*close)(AVCodecContext *);
2922 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2924 * Codec capabilities.
2928 struct AVCodec *next;
2931 * Will be called when seeking
2933 void (*flush)(AVCodecContext *);
2934 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2935 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2937 * Descriptive name for the codec, meant to be more human readable than name.
2938 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2940 const char *long_name;
2941 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2942 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2943 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2944 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2945 AVClass *priv_class; ///< AVClass for the private context
2946 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2949 * @defgroup framethreading Frame-level threading support functions.
2953 * If defined, called on thread contexts when they are created.
2954 * If the codec allocates writable tables in init(), re-allocate them here.
2955 * priv_data will be set to a copy of the original.
2957 int (*init_thread_copy)(AVCodecContext *);
2959 * Copy necessary context variables from a previous thread context to the current one.
2960 * If not defined, the next thread will start automatically; otherwise, the codec
2961 * must call ff_thread_finish_setup().
2963 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2965 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2972 typedef struct AVHWAccel {
2974 * Name of the hardware accelerated codec.
2975 * The name is globally unique among encoders and among decoders (but an
2976 * encoder and a decoder can share the same name).
2981 * Type of codec implemented by the hardware accelerator.
2983 * See AVMEDIA_TYPE_xxx
2985 enum AVMediaType type;
2988 * Codec implemented by the hardware accelerator.
2995 * Supported pixel format.
2997 * Only hardware accelerated formats are supported here.
2999 enum PixelFormat pix_fmt;
3002 * Hardware accelerated codec capabilities.
3003 * see FF_HWACCEL_CODEC_CAP_*
3007 struct AVHWAccel *next;
3010 * Called at the beginning of each frame or field picture.
3012 * Meaningful frame information (codec specific) is guaranteed to
3013 * be parsed at this point. This function is mandatory.
3015 * Note that buf can be NULL along with buf_size set to 0.
3016 * Otherwise, this means the whole frame is available at this point.
3018 * @param avctx the codec context
3019 * @param buf the frame data buffer base
3020 * @param buf_size the size of the frame in bytes
3021 * @return zero if successful, a negative value otherwise
3023 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3026 * Callback for each slice.
3028 * Meaningful slice information (codec specific) is guaranteed to
3029 * be parsed at this point. This function is mandatory.
3031 * @param avctx the codec context
3032 * @param buf the slice data buffer base
3033 * @param buf_size the size of the slice in bytes
3034 * @return zero if successful, a negative value otherwise
3036 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3039 * Called at the end of each frame or field picture.
3041 * The whole picture is parsed at this point and can now be sent
3042 * to the hardware accelerator. This function is mandatory.
3044 * @param avctx the codec context
3045 * @return zero if successful, a negative value otherwise
3047 int (*end_frame)(AVCodecContext *avctx);
3050 * Size of HW accelerator private data.
3052 * Private data is allocated with av_mallocz() before
3053 * AVCodecContext.get_buffer() and deallocated after
3054 * AVCodecContext.release_buffer().
3060 * four components are given, that's all.
3061 * the last component is alpha
3063 typedef struct AVPicture {
3065 int linesize[4]; ///< number of bytes per line
3068 #if FF_API_PALETTE_CONTROL
3071 * This structure defines a method for communicating palette changes
3072 * between and demuxer and a decoder.
3074 * @deprecated Use AVPacket to send palette changes instead.
3075 * This is totally broken.
3077 #define AVPALETTE_SIZE 1024
3078 #define AVPALETTE_COUNT 256
3079 typedef struct AVPaletteControl {
3081 /* Demuxer sets this to 1 to indicate the palette has changed;
3082 * decoder resets to 0. */
3083 int palette_changed;
3085 /* 4-byte ARGB palette entries, stored in native byte order; note that
3086 * the individual palette components should be on a 8-bit scale; if
3087 * the palette data comes from an IBM VGA native format, the component
3088 * data is probably 6 bits in size and needs to be scaled. */
3089 unsigned int palette[AVPALETTE_COUNT];
3091 } AVPaletteControl attribute_deprecated;
3094 enum AVSubtitleType {
3097 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3100 * Plain text, the text field must be set by the decoder and is
3101 * authoritative. ass and pict fields may contain approximations.
3106 * Formatted text, the ass field must be set by the decoder and is
3107 * authoritative. pict and text fields may contain approximations.
3112 typedef struct AVSubtitleRect {
3113 int x; ///< top left corner of pict, undefined when pict is not set
3114 int y; ///< top left corner of pict, undefined when pict is not set
3115 int w; ///< width of pict, undefined when pict is not set
3116 int h; ///< height of pict, undefined when pict is not set
3117 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3120 * data+linesize for the bitmap of this subtitle.
3121 * can be set for text/ass as well once they where rendered
3124 enum AVSubtitleType type;
3126 char *text; ///< 0 terminated plain UTF-8 text
3129 * 0 terminated ASS/SSA compatible event line.
3130 * The pressentation of this is unaffected by the other values in this
3136 typedef struct AVSubtitle {
3137 uint16_t format; /* 0 = graphics */
3138 uint32_t start_display_time; /* relative to packet pts, in ms */
3139 uint32_t end_display_time; /* relative to packet pts, in ms */
3141 AVSubtitleRect **rects;
3142 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3145 /* packet functions */
3148 * @deprecated use NULL instead
3150 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3153 * Default packet destructor.
3155 void av_destruct_packet(AVPacket *pkt);
3158 * Initialize optional fields of a packet with default values.
3162 void av_init_packet(AVPacket *pkt);
3165 * Allocate the payload of a packet and initialize its fields with
3169 * @param size wanted payload size
3170 * @return 0 if OK, AVERROR_xxx otherwise
3172 int av_new_packet(AVPacket *pkt, int size);
3175 * Reduce packet size, correctly zeroing padding
3178 * @param size new size
3180 void av_shrink_packet(AVPacket *pkt, int size);
3183 * Increase packet size, correctly zeroing padding
3186 * @param grow_by number of bytes by which to increase the size of the packet
3188 int av_grow_packet(AVPacket *pkt, int grow_by);
3191 * @warning This is a hack - the packet memory allocation stuff is broken. The
3192 * packet is allocated if it was not really allocated.
3194 int av_dup_packet(AVPacket *pkt);
3199 * @param pkt packet to free
3201 void av_free_packet(AVPacket *pkt);
3205 struct ReSampleContext;
3206 struct AVResampleContext;
3208 typedef struct ReSampleContext ReSampleContext;
3210 #if FF_API_AUDIO_OLD
3212 * @deprecated Use av_audio_resample_init() instead.
3214 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3215 int output_rate, int input_rate);
3218 * Initialize audio resampling context
3220 * @param output_channels number of output channels
3221 * @param input_channels number of input channels
3222 * @param output_rate output sample rate
3223 * @param input_rate input sample rate
3224 * @param sample_fmt_out requested output sample format
3225 * @param sample_fmt_in input sample format
3226 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3227 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3228 * @param linear If 1 then the used FIR filter will be linearly interpolated
3229 between the 2 closest, if 0 the closest will be used
3230 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3231 * @return allocated ReSampleContext, NULL if error occured
3233 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3234 int output_rate, int input_rate,
3235 enum AVSampleFormat sample_fmt_out,
3236 enum AVSampleFormat sample_fmt_in,
3237 int filter_length, int log2_phase_count,
3238 int linear, double cutoff);
3240 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3241 void audio_resample_close(ReSampleContext *s);
3245 * Initialize an audio resampler.
3246 * Note, if either rate is not an integer then simply scale both rates up so they are.
3247 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3248 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3249 * @param linear If 1 then the used FIR filter will be linearly interpolated
3250 between the 2 closest, if 0 the closest will be used
3251 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3253 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3256 * Resample an array of samples using a previously configured context.
3257 * @param src an array of unconsumed samples
3258 * @param consumed the number of samples of src which have been consumed are returned here
3259 * @param src_size the number of unconsumed samples available
3260 * @param dst_size the amount of space in samples available in dst
3261 * @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.
3262 * @return the number of samples written in dst or -1 if an error occurred
3264 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3268 * Compensate samplerate/timestamp drift. The compensation is done by changing
3269 * the resampler parameters, so no audible clicks or similar distortions occur
3270 * @param compensation_distance distance in output samples over which the compensation should be performed
3271 * @param sample_delta number of output samples which should be output less
3273 * example: av_resample_compensate(c, 10, 500)
3274 * here instead of 510 samples only 500 samples would be output
3276 * note, due to rounding the actual compensation might be slightly different,
3277 * especially if the compensation_distance is large and the in_rate used during init is small
3279 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3280 void av_resample_close(struct AVResampleContext *c);
3283 * Allocate memory for a picture. Call avpicture_free to free it.
3285 * @param picture the picture to be filled in
3286 * @param pix_fmt the format of the picture
3287 * @param width the width of the picture
3288 * @param height the height of the picture
3289 * @return zero if successful, a negative value if not
3291 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3294 * Free a picture previously allocated by avpicture_alloc().
3296 * @param picture the AVPicture to be freed
3298 void avpicture_free(AVPicture *picture);
3301 * Fill in the AVPicture fields.
3302 * The fields of the given AVPicture are filled in by using the 'ptr' address
3303 * which points to the image data buffer. Depending on the specified picture
3304 * format, one or multiple image data pointers and line sizes will be set.
3305 * If a planar format is specified, several pointers will be set pointing to
3306 * the different picture planes and the line sizes of the different planes
3307 * will be stored in the lines_sizes array.
3308 * Call with ptr == NULL to get the required size for the ptr buffer.
3310 * @param picture AVPicture whose fields are to be filled in
3311 * @param ptr Buffer which will contain or contains the actual image data
3312 * @param pix_fmt The format in which the picture data is stored.
3313 * @param width the width of the image in pixels
3314 * @param height the height of the image in pixels
3315 * @return size of the image data in bytes
3317 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3318 enum PixelFormat pix_fmt, int width, int height);
3319 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3320 unsigned char *dest, int dest_size);
3323 * Calculate the size in bytes that a picture of the given width and height
3324 * would occupy if stored in the given picture format.
3325 * Note that this returns the size of a compact representation as generated
3326 * by avpicture_layout, which can be smaller than the size required for e.g.
3329 * @param pix_fmt the given picture format
3330 * @param width the width of the image
3331 * @param height the height of the image
3332 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3334 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3335 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3336 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3337 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3339 #if LIBAVCODEC_VERSION_MAJOR < 53
3341 * Return the pixel format corresponding to the name name.
3343 * If there is no pixel format with name name, then look for a
3344 * pixel format with the name corresponding to the native endian
3346 * For example in a little-endian system, first look for "gray16",
3347 * then for "gray16le".
3349 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3351 * @deprecated Deprecated in favor of av_get_pix_fmt().
3353 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3357 * Return a value representing the fourCC code associated to the
3358 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3361 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3364 * Put a string representing the codec tag codec_tag in buf.
3366 * @param buf_size size in bytes of buf
3367 * @return the length of the string that would have been generated if
3368 * enough space had been available, excluding the trailing null
3370 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3372 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3373 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3374 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3375 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3376 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3377 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3380 * Compute what kind of losses will occur when converting from one specific
3381 * pixel format to another.
3382 * When converting from one pixel format to another, information loss may occur.
3383 * For example, when converting from RGB24 to GRAY, the color information will
3384 * be lost. Similarly, other losses occur when converting from some formats to
3385 * other formats. These losses can involve loss of chroma, but also loss of
3386 * resolution, loss of color depth, loss due to the color space conversion, loss
3387 * of the alpha bits or loss due to color quantization.
3388 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3389 * which will occur when converting from one pixel format to another.
3391 * @param[in] dst_pix_fmt destination pixel format
3392 * @param[in] src_pix_fmt source pixel format
3393 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3394 * @return Combination of flags informing you what kind of losses will occur.
3396 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3400 * Find the best pixel format to convert to given a certain source pixel
3401 * format. When converting from one pixel format to another, information loss
3402 * may occur. For example, when converting from RGB24 to GRAY, the color
3403 * information will be lost. Similarly, other losses occur when converting from
3404 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3405 * the given pixel formats should be used to suffer the least amount of loss.
3406 * The pixel formats from which it chooses one, are determined by the
3407 * pix_fmt_mask parameter.
3410 * src_pix_fmt = PIX_FMT_YUV420P;
3411 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3412 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3415 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3416 * @param[in] src_pix_fmt source pixel format
3417 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3418 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3419 * @return The best pixel format to convert to or -1 if none was found.
3421 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3422 int has_alpha, int *loss_ptr);
3424 #if LIBAVCODEC_VERSION_MAJOR < 53
3426 * @deprecated Use av_get_pix_fmt_string() instead.
3428 attribute_deprecated
3429 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3432 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3433 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3436 * Tell if an image really has transparent alpha values.
3437 * @return ored mask of FF_ALPHA_xxx constants
3439 int img_get_alpha_info(const AVPicture *src,
3440 enum PixelFormat pix_fmt, int width, int height);
3442 /* deinterlace a picture */
3443 /* deinterlace - if not supported return -1 */
3444 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3445 enum PixelFormat pix_fmt, int width, int height);
3447 /* external high level API */
3450 * If c is NULL, returns the first registered codec,
3451 * if c is non-NULL, returns the next registered codec after c,
3452 * or NULL if c is the last one.
3454 AVCodec *av_codec_next(AVCodec *c);
3457 * Return the LIBAVCODEC_VERSION_INT constant.
3459 unsigned avcodec_version(void);
3462 * Return the libavcodec build-time configuration.
3464 const char *avcodec_configuration(void);
3467 * Return the libavcodec license.
3469 const char *avcodec_license(void);
3472 * Initialize libavcodec.
3474 * @warning This function must be called before any other libavcodec
3477 void avcodec_init(void);
3479 #if LIBAVCODEC_VERSION_MAJOR < 53
3481 * @deprecated Deprecated in favor of avcodec_register().
3483 attribute_deprecated void register_avcodec(AVCodec *codec);
3487 * Register the codec codec and initialize libavcodec.
3489 * @see avcodec_init()
3491 void avcodec_register(AVCodec *codec);
3494 * Find a registered encoder with a matching codec ID.
3496 * @param id CodecID of the requested encoder
3497 * @return An encoder if one was found, NULL otherwise.
3499 AVCodec *avcodec_find_encoder(enum CodecID id);
3502 * Find a registered encoder with the specified name.
3504 * @param name name of the requested encoder
3505 * @return An encoder if one was found, NULL otherwise.
3507 AVCodec *avcodec_find_encoder_by_name(const char *name);
3510 * Find a registered decoder with a matching codec ID.
3512 * @param id CodecID of the requested decoder
3513 * @return A decoder if one was found, NULL otherwise.
3515 AVCodec *avcodec_find_decoder(enum CodecID id);
3518 * Find a registered decoder with the specified name.
3520 * @param name name of the requested decoder
3521 * @return A decoder if one was found, NULL otherwise.
3523 AVCodec *avcodec_find_decoder_by_name(const char *name);
3524 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3527 * Return a name for the specified profile, if available.
3529 * @param codec the codec that is searched for the given profile
3530 * @param profile the profile value for which a name is requested
3531 * @return A name for the profile if found, NULL otherwise.
3533 const char *av_get_profile_name(const AVCodec *codec, int profile);
3536 * Set the fields of the given AVCodecContext to default values.
3538 * @param s The AVCodecContext of which the fields should be set to default values.
3540 void avcodec_get_context_defaults(AVCodecContext *s);
3542 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3543 * we WILL change its arguments and name a few times! */
3544 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3546 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3547 * we WILL change its arguments and name a few times! */
3548 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3551 * Allocate an AVCodecContext and set its fields to default values. The
3552 * resulting struct can be deallocated by simply calling av_free().
3554 * @return An AVCodecContext filled with default values or NULL on failure.
3555 * @see avcodec_get_context_defaults
3557 AVCodecContext *avcodec_alloc_context(void);
3559 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3560 * we WILL change its arguments and name a few times! */
3561 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3563 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3564 * we WILL change its arguments and name a few times! */
3565 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3568 * Copy the settings of the source AVCodecContext into the destination
3569 * AVCodecContext. The resulting destination codec context will be
3570 * unopened, i.e. you are required to call avcodec_open() before you
3571 * can use this AVCodecContext to decode/encode video/audio data.
3573 * @param dest target codec context, should be initialized with
3574 * avcodec_alloc_context(), but otherwise uninitialized
3575 * @param src source codec context
3576 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3578 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3581 * Set the fields of the given AVFrame to default values.
3583 * @param pic The AVFrame of which the fields should be set to default values.
3585 void avcodec_get_frame_defaults(AVFrame *pic);
3588 * Allocate an AVFrame and set its fields to default values. The resulting
3589 * struct can be deallocated by simply calling av_free().
3591 * @return An AVFrame filled with default values or NULL on failure.
3592 * @see avcodec_get_frame_defaults
3594 AVFrame *avcodec_alloc_frame(void);
3596 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3597 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3598 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3601 * Return the amount of padding in pixels which the get_buffer callback must
3602 * provide around the edge of the image for codecs which do not have the
3603 * CODEC_FLAG_EMU_EDGE flag.
3605 * @return Required padding in pixels.
3607 unsigned avcodec_get_edge_width(void);
3609 * Modify width and height values so that they will result in a memory
3610 * buffer that is acceptable for the codec if you do not use any horizontal
3613 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3614 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3615 * according to avcodec_get_edge_width() before.
3617 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3619 * Modify width and height values so that they will result in a memory
3620 * buffer that is acceptable for the codec if you also ensure that all
3621 * line sizes are a multiple of the respective linesize_align[i].
3623 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3624 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3625 * according to avcodec_get_edge_width() before.
3627 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3628 int linesize_align[4]);
3630 #if LIBAVCODEC_VERSION_MAJOR < 53
3632 * @deprecated Deprecated in favor of av_check_image_size().
3634 attribute_deprecated
3635 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3638 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3640 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3641 void avcodec_thread_free(AVCodecContext *s);
3642 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3643 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3644 //FIXME func typedef
3647 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3648 * function the context has to be allocated.
3650 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3651 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3652 * retrieving a codec.
3654 * @warning This function is not thread safe!
3657 * avcodec_register_all();
3658 * codec = avcodec_find_decoder(CODEC_ID_H264);
3662 * context = avcodec_alloc_context();
3664 * if (avcodec_open(context, codec) < 0)
3668 * @param avctx The context which will be set up to use the given codec.
3669 * @param codec The codec to use within the context.
3670 * @return zero on success, a negative value on error
3671 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3673 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3675 #if FF_API_AUDIO_OLD
3677 * Decode an audio frame from buf into samples.
3678 * Wrapper function which calls avcodec_decode_audio3.
3680 * @deprecated Use avcodec_decode_audio3 instead.
3681 * @param avctx the codec context
3682 * @param[out] samples the output buffer
3683 * @param[in,out] frame_size_ptr the output buffer size in bytes
3684 * @param[in] buf the input buffer
3685 * @param[in] buf_size the input buffer size in bytes
3686 * @return On error a negative value is returned, otherwise the number of bytes
3687 * used or zero if no frame could be decompressed.
3689 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3690 int *frame_size_ptr,
3691 const uint8_t *buf, int buf_size);
3695 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3696 * Some decoders may support multiple frames in a single AVPacket, such
3697 * decoders would then just decode the first frame. In this case,
3698 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3699 * the remaining data in order to decode the second frame etc.
3701 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3702 * decompressed frame size in bytes.
3704 * @warning You must set frame_size_ptr to the allocated size of the
3705 * output buffer before calling avcodec_decode_audio3().
3707 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3708 * the actual read bytes because some optimized bitstream readers read 32 or 64
3709 * bits at once and could read over the end.
3711 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3712 * no overreading happens for damaged MPEG streams.
3714 * @note You might have to align the input buffer avpkt->data and output buffer
3715 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3716 * necessary at all, on others it won't work at all if not aligned and on others
3717 * it will work but it will have an impact on performance.
3719 * In practice, avpkt->data should have 4 byte alignment at minimum and
3720 * samples should be 16 byte aligned unless the CPU doesn't need it
3721 * (AltiVec and SSE do).
3723 * @param avctx the codec context
3724 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3725 * @param[in,out] frame_size_ptr the output buffer size in bytes
3726 * @param[in] avpkt The input AVPacket containing the input buffer.
3727 * You can create such packet with av_init_packet() and by then setting
3728 * data and size, some decoders might in addition need other fields.
3729 * All decoders are designed to use the least fields possible though.
3730 * @return On error a negative value is returned, otherwise the number of bytes
3731 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3733 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3734 int *frame_size_ptr,
3737 #if FF_API_VIDEO_OLD
3739 * Decode a video frame from buf into picture.
3740 * Wrapper function which calls avcodec_decode_video2.
3742 * @deprecated Use avcodec_decode_video2 instead.
3743 * @param avctx the codec context
3744 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3745 * @param[in] buf the input buffer
3746 * @param[in] buf_size the size of the input buffer in bytes
3747 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3748 * @return On error a negative value is returned, otherwise the number of bytes
3749 * used or zero if no frame could be decompressed.
3751 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3752 int *got_picture_ptr,
3753 const uint8_t *buf, int buf_size);
3757 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3758 * Some decoders may support multiple frames in a single AVPacket, such
3759 * decoders would then just decode the first frame.
3761 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3762 * the actual read bytes because some optimized bitstream readers read 32 or 64
3763 * bits at once and could read over the end.
3765 * @warning The end of the input buffer buf should be set to 0 to ensure that
3766 * no overreading happens for damaged MPEG streams.
3768 * @note You might have to align the input buffer avpkt->data.
3769 * The alignment requirements depend on the CPU: on some CPUs it isn't
3770 * necessary at all, on others it won't work at all if not aligned and on others
3771 * it will work but it will have an impact on performance.
3773 * In practice, avpkt->data should have 4 byte alignment at minimum.
3775 * @note Some codecs have a delay between input and output, these need to be
3776 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3778 * @param avctx the codec context
3779 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3780 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3781 * allocate memory for the actual bitmap.
3782 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3783 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3784 * decodes and the decoder tells the user once it does not need the data anymore,
3785 * the user app can at this point free/reuse/keep the memory as it sees fit.
3787 * @param[in] avpkt The input AVpacket containing the input buffer.
3788 * You can create such packet with av_init_packet() and by then setting
3789 * data and size, some decoders might in addition need other fields like
3790 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3792 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3793 * @return On error a negative value is returned, otherwise the number of bytes
3794 * used or zero if no frame could be decompressed.
3796 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3797 int *got_picture_ptr,
3800 #if FF_API_SUBTITLE_OLD
3801 /* Decode a subtitle message. Return -1 if error, otherwise return the
3802 * number of bytes used. If no subtitle could be decompressed,
3803 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3804 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3806 const uint8_t *buf, int buf_size);
3810 * Decode a subtitle message.
3811 * Return a negative value on error, otherwise return the number of bytes used.
3812 * If no subtitle could be decompressed, got_sub_ptr is zero.
3813 * Otherwise, the subtitle is stored in *sub.
3814 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3815 * simplicity, because the performance difference is expect to be negligible
3816 * and reusing a get_buffer written for video codecs would probably perform badly
3817 * due to a potentially very different allocation pattern.
3819 * @param avctx the codec context
3820 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3821 freed with avsubtitle_free if *got_sub_ptr is set.
3822 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3823 * @param[in] avpkt The input AVPacket containing the input buffer.
3825 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3830 * Frees all allocated data in the given subtitle struct.
3832 * @param sub AVSubtitle to free.
3834 void avsubtitle_free(AVSubtitle *sub);
3836 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3838 uint8_t *buf, int buf_size);
3841 * Encode an audio frame from samples into buf.
3843 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3844 * However, for PCM audio the user will know how much space is needed
3845 * because it depends on the value passed in buf_size as described
3846 * below. In that case a lower value can be used.
3848 * @param avctx the codec context
3849 * @param[out] buf the output buffer
3850 * @param[in] buf_size the output buffer size
3851 * @param[in] samples the input buffer containing the samples
3852 * The number of samples read from this buffer is frame_size*channels,
3853 * both of which are defined in avctx.
3854 * For PCM audio the number of samples read from samples is equal to
3855 * buf_size * input_sample_size / output_sample_size.
3856 * @return On error a negative value is returned, on success zero or the number
3857 * of bytes used to encode the data read from the input buffer.
3859 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3860 const short *samples);
3863 * Encode a video frame from pict into buf.
3864 * The input picture should be
3865 * stored using a specific format, namely avctx.pix_fmt.
3867 * @param avctx the codec context
3868 * @param[out] buf the output buffer for the bitstream of encoded frame
3869 * @param[in] buf_size the size of the output buffer in bytes
3870 * @param[in] pict the input picture to encode
3871 * @return On error a negative value is returned, on success zero or the number
3872 * of bytes used from the output buffer.
3874 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3875 const AVFrame *pict);
3876 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3877 const AVSubtitle *sub);
3879 int avcodec_close(AVCodecContext *avctx);
3882 * Register all the codecs, parsers and bitstream filters which were enabled at
3883 * configuration time. If you do not call this function you can select exactly
3884 * which formats you want to support, by using the individual registration
3887 * @see avcodec_register
3888 * @see av_register_codec_parser
3889 * @see av_register_bitstream_filter
3891 void avcodec_register_all(void);
3894 * Flush buffers, should be called when seeking or when switching to a different stream.
3896 void avcodec_flush_buffers(AVCodecContext *avctx);
3898 void avcodec_default_free_buffers(AVCodecContext *s);
3900 /* misc useful functions */
3903 * Return a single letter to describe the given picture type pict_type.
3905 * @param[in] pict_type the picture type
3906 * @return A single character representing the picture type.
3908 char av_get_pict_type_char(int pict_type);
3911 * Return codec bits per sample.
3913 * @param[in] codec_id the codec
3914 * @return Number of bits per sample or zero if unknown for the given codec.
3916 int av_get_bits_per_sample(enum CodecID codec_id);
3918 #if FF_API_OLD_SAMPLE_FMT
3920 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3922 attribute_deprecated
3923 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3927 typedef struct AVCodecParserContext {
3929 struct AVCodecParser *parser;
3930 int64_t frame_offset; /* offset of the current frame */
3931 int64_t cur_offset; /* current offset
3932 (incremented by each av_parser_parse()) */
3933 int64_t next_frame_offset; /* offset of the next frame */
3935 int pict_type; /* XXX: Put it back in AVCodecContext. */
3937 * This field is used for proper frame duration computation in lavf.
3938 * It signals, how much longer the frame duration of the current frame
3939 * is compared to normal frame duration.
3941 * frame_duration = (1 + repeat_pict) * time_base
3943 * It is used by codecs like H.264 to display telecined material.
3945 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3946 int64_t pts; /* pts of the current frame */
3947 int64_t dts; /* dts of the current frame */
3952 int fetch_timestamp;
3954 #define AV_PARSER_PTS_NB 4
3955 int cur_frame_start_index;
3956 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3957 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3958 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3961 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3962 #define PARSER_FLAG_ONCE 0x0002
3963 /// Set if the parser has a valid file offset
3964 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3966 int64_t offset; ///< byte offset from starting packet start
3967 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3970 * Set by parser to 1 for key frames and 0 for non-key frames.
3971 * It is initialized to -1, so if the parser doesn't set this flag,
3972 * old-style fallback using FF_I_TYPE picture type as key frames
3978 * Time difference in stream time base units from the pts of this
3979 * packet to the point at which the output from the decoder has converged
3980 * independent from the availability of previous frames. That is, the
3981 * frames are virtually identical no matter if decoding started from
3982 * the very first frame or from this keyframe.
3983 * Is AV_NOPTS_VALUE if unknown.
3984 * This field is not the display duration of the current frame.
3985 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3988 * The purpose of this field is to allow seeking in streams that have no
3989 * keyframes in the conventional sense. It corresponds to the
3990 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3991 * essential for some types of subtitle streams to ensure that all
3992 * subtitles are correctly displayed after seeking.
3994 int64_t convergence_duration;
3996 // Timestamp generation support:
3998 * Synchronization point for start of timestamp generation.
4000 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4003 * For example, this corresponds to presence of H.264 buffering period
4009 * Offset of the current timestamp against last timestamp sync point in
4010 * units of AVCodecContext.time_base.
4012 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4013 * contain a valid timestamp offset.
4015 * Note that the timestamp of sync point has usually a nonzero
4016 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4017 * the next frame after timestamp sync point will be usually 1.
4019 * For example, this corresponds to H.264 cpb_removal_delay.
4021 int dts_ref_dts_delta;
4024 * Presentation delay of current frame in units of AVCodecContext.time_base.
4026 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4027 * contain valid non-negative timestamp delta (presentation time of a frame
4028 * must not lie in the past).
4030 * This delay represents the difference between decoding and presentation
4031 * time of the frame.
4033 * For example, this corresponds to H.264 dpb_output_delay.
4038 * Position of the packet in file.
4040 * Analogous to cur_frame_pts/dts
4042 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4045 * Byte position of currently parsed frame in stream.
4050 * Previous frame byte position.
4053 } AVCodecParserContext;
4055 typedef struct AVCodecParser {
4056 int codec_ids[5]; /* several codec IDs are permitted */
4058 int (*parser_init)(AVCodecParserContext *s);
4059 int (*parser_parse)(AVCodecParserContext *s,
4060 AVCodecContext *avctx,
4061 const uint8_t **poutbuf, int *poutbuf_size,
4062 const uint8_t *buf, int buf_size);
4063 void (*parser_close)(AVCodecParserContext *s);
4064 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4065 struct AVCodecParser *next;
4068 AVCodecParser *av_parser_next(AVCodecParser *c);
4070 void av_register_codec_parser(AVCodecParser *parser);
4071 AVCodecParserContext *av_parser_init(int codec_id);
4073 #if LIBAVCODEC_VERSION_MAJOR < 53
4074 attribute_deprecated
4075 int av_parser_parse(AVCodecParserContext *s,
4076 AVCodecContext *avctx,
4077 uint8_t **poutbuf, int *poutbuf_size,
4078 const uint8_t *buf, int buf_size,
4079 int64_t pts, int64_t dts);
4085 * @param s parser context.
4086 * @param avctx codec context.
4087 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4088 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4089 * @param buf input buffer.
4090 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4091 * @param pts input presentation timestamp.
4092 * @param dts input decoding timestamp.
4093 * @param pos input byte position in stream.
4094 * @return the number of bytes of the input bitstream used.
4099 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4106 * decode_frame(data, size);
4110 int av_parser_parse2(AVCodecParserContext *s,
4111 AVCodecContext *avctx,
4112 uint8_t **poutbuf, int *poutbuf_size,
4113 const uint8_t *buf, int buf_size,
4114 int64_t pts, int64_t dts,
4117 int av_parser_change(AVCodecParserContext *s,
4118 AVCodecContext *avctx,
4119 uint8_t **poutbuf, int *poutbuf_size,
4120 const uint8_t *buf, int buf_size, int keyframe);
4121 void av_parser_close(AVCodecParserContext *s);
4124 typedef struct AVBitStreamFilterContext {
4126 struct AVBitStreamFilter *filter;
4127 AVCodecParserContext *parser;
4128 struct AVBitStreamFilterContext *next;
4129 } AVBitStreamFilterContext;
4132 typedef struct AVBitStreamFilter {
4135 int (*filter)(AVBitStreamFilterContext *bsfc,
4136 AVCodecContext *avctx, const char *args,
4137 uint8_t **poutbuf, int *poutbuf_size,
4138 const uint8_t *buf, int buf_size, int keyframe);
4139 void (*close)(AVBitStreamFilterContext *bsfc);
4140 struct AVBitStreamFilter *next;
4141 } AVBitStreamFilter;
4143 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4144 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4145 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4146 AVCodecContext *avctx, const char *args,
4147 uint8_t **poutbuf, int *poutbuf_size,
4148 const uint8_t *buf, int buf_size, int keyframe);
4149 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4151 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4156 * Reallocate the given block if it is not large enough, otherwise do nothing.
4160 void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4163 * Allocate a buffer, reusing the given one if large enough.
4165 * Contrary to av_fast_realloc the current buffer contents might not be
4166 * preserved and on error the old buffer is freed, thus no special
4167 * handling to avoid memleaks is necessary.
4169 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4170 * @param size size of the buffer *ptr points to
4171 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4172 * *size 0 if an error occurred.
4174 void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4176 #if LIBAVCODEC_VERSION_MAJOR < 53
4178 * @deprecated Deprecated in favor of av_image_copy().
4180 attribute_deprecated
4181 void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4182 uint8_t *src_data[4], int src_linesize[4],
4183 enum PixelFormat pix_fmt, int width, int height);
4187 * Copy image src to dst. Wraps av_picture_data_copy() above.
4189 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4190 enum PixelFormat pix_fmt, int width, int height);
4193 * Crop image top and left side.
4195 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4196 enum PixelFormat pix_fmt, int top_band, int left_band);
4201 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4202 int padtop, int padbottom, int padleft, int padright, int *color);
4205 * Encode extradata length to a buffer. Used by xiph codecs.
4207 * @param s buffer to write to; must be at least (v/255+1) bytes long
4208 * @param v size of extradata in bytes
4209 * @return number of bytes written to the buffer.
4211 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4213 #if LIBAVCODEC_VERSION_MAJOR < 53
4215 * Parse str and put in width_ptr and height_ptr the detected values.
4217 * @deprecated Deprecated in favor of av_parse_video_size().
4219 attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4222 * Parse str and store the detected values in *frame_rate.
4224 * @deprecated Deprecated in favor of av_parse_video_rate().
4226 attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4230 * Logs a generic warning message about a missing feature. This function is
4231 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4232 * only, and would normally not be used by applications.
4233 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4234 * a pointer to an AVClass struct
4235 * @param[in] feature string containing the name of the missing feature
4236 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4237 * If want_sample is non-zero, additional verbage will be added to the log
4238 * message which tells the user how to report samples to the development
4241 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4244 * Log a generic warning message asking for a sample. This function is
4245 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4246 * only, and would normally not be used by applications.
4247 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4248 * a pointer to an AVClass struct
4249 * @param[in] msg string containing an optional message, or NULL if no message
4251 void av_log_ask_for_sample(void *avc, const char *msg);
4254 * Register the hardware accelerator hwaccel.
4256 void av_register_hwaccel(AVHWAccel *hwaccel);
4259 * If hwaccel is NULL, returns the first registered hardware accelerator,
4260 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4261 * after hwaccel, or NULL if hwaccel is the last one.
4263 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4267 * Lock operation used by lockmgr
4270 AV_LOCK_CREATE, ///< Create a mutex
4271 AV_LOCK_OBTAIN, ///< Lock the mutex
4272 AV_LOCK_RELEASE, ///< Unlock the mutex
4273 AV_LOCK_DESTROY, ///< Free mutex resources
4277 * Register a user provided lock manager supporting the operations
4278 * specified by AVLockOp. mutex points to a (void *) where the
4279 * lockmgr should store/get a pointer to a user allocated mutex. It's
4280 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4282 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4283 * callback during the call to av_lockmgr_register().
4284 * Thus, the application must be prepared to handle that.
4285 * If cb is set to NULL the lockmgr will be unregistered.
4286 * Also note that during unregistration the previously registered
4287 * lockmgr callback may also be invoked.
4289 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4291 #endif /* AVCODEC_AVCODEC_H */