2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
82 * This ensures that 2 forks can independantly add CodecIDs without producing conflicts.
89 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
90 CODEC_ID_MPEG2VIDEO_XVMC,
127 CODEC_ID_INTERPLAY_VIDEO,
139 CODEC_ID_TRUEMOTION1,
166 CODEC_ID_TRUEMOTION2,
183 CODEC_ID_DSICINVIDEO,
184 CODEC_ID_TIERTEXSEQVIDEO,
187 #if LIBAVCODEC_VERSION_MAJOR == 53
195 CODEC_ID_BETHSOFTVID,
207 #if LIBAVCODEC_VERSION_MAJOR == 53
215 CODEC_ID_MOTIONPIXELS,
233 CODEC_ID_IFF_BYTERUN1,
249 #if LIBAVCODEC_VERSION_MAJOR == 53
250 CODEC_ID_G723_1_DEPRECATED,
251 CODEC_ID_G729_DEPRECATED,
253 CODEC_ID_UTVIDEO_DEPRECATED,
256 CODEC_ID_UTVIDEO = 0x800,
258 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
260 /* various PCM "codecs" */
261 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
262 CODEC_ID_PCM_S16LE = 0x10000,
278 CODEC_ID_PCM_S24DAUD,
280 CODEC_ID_PCM_S16LE_PLANAR,
289 CODEC_ID_PCM_S8_PLANAR,
291 /* various ADPCM codecs */
292 CODEC_ID_ADPCM_IMA_QT = 0x11000,
293 CODEC_ID_ADPCM_IMA_WAV,
294 CODEC_ID_ADPCM_IMA_DK3,
295 CODEC_ID_ADPCM_IMA_DK4,
296 CODEC_ID_ADPCM_IMA_WS,
297 CODEC_ID_ADPCM_IMA_SMJPEG,
306 CODEC_ID_ADPCM_YAMAHA,
307 CODEC_ID_ADPCM_SBPRO_4,
308 CODEC_ID_ADPCM_SBPRO_3,
309 CODEC_ID_ADPCM_SBPRO_2,
311 CODEC_ID_ADPCM_IMA_AMV,
312 CODEC_ID_ADPCM_EA_R1,
313 CODEC_ID_ADPCM_EA_R3,
314 CODEC_ID_ADPCM_EA_R2,
315 CODEC_ID_ADPCM_IMA_EA_SEAD,
316 CODEC_ID_ADPCM_IMA_EA_EACS,
317 CODEC_ID_ADPCM_EA_XAS,
318 CODEC_ID_ADPCM_EA_MAXIS_XA,
319 CODEC_ID_ADPCM_IMA_ISS,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
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 #if LIBAVCODEC_VERSION_MAJOR > 53
395 CODEC_ID_G723_1_DEPRECATED,
396 CODEC_ID_G729_DEPRECATED,
401 CODEC_ID_G729 = 0x15800,
402 CODEC_ID_G723_1= 0x15801,
403 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
405 /* subtitle codecs */
406 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
407 CODEC_ID_DVD_SUBTITLE = 0x17000,
408 CODEC_ID_DVB_SUBTITLE,
409 CODEC_ID_TEXT, ///< raw UTF-8 text
413 CODEC_ID_HDMV_PGS_SUBTITLE,
414 CODEC_ID_DVB_TELETEXT,
416 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
418 /* other specific kind of codecs (generally used for attachments) */
419 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
420 CODEC_ID_TTF = 0x18000,
421 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
422 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
423 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
425 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
427 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
428 * stream (only used by libavformat) */
429 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
430 * stream (only used by libavformat) */
431 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
434 #if FF_API_OLD_SAMPLE_FMT
435 #define SampleFormat AVSampleFormat
437 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
438 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
439 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
440 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
441 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
442 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
443 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
446 #if FF_API_OLD_AUDIOCONVERT
447 #include "libavutil/audioconvert.h"
449 /* Audio channel masks */
450 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
451 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
452 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
453 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
454 #define CH_BACK_LEFT AV_CH_BACK_LEFT
455 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
456 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
457 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
458 #define CH_BACK_CENTER AV_CH_BACK_CENTER
459 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
460 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
461 #define CH_TOP_CENTER AV_CH_TOP_CENTER
462 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
463 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
464 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
465 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
466 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
467 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
468 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
469 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
471 /** Channel mask value used for AVCodecContext.request_channel_layout
472 to indicate that the user requests the channel order of the decoder output
473 to be the native codec channel order. */
474 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
476 /* Audio channel convenience macros */
477 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
478 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
479 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
480 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
481 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
482 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
483 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
484 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
485 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
486 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
487 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
488 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
489 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
490 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
491 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
494 #if FF_API_OLD_DECODE_AUDIO
496 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
500 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
501 * This is mainly needed because some optimized bitstream readers read
502 * 32 or 64 bit at once and could read over the end.<br>
503 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
504 * MPEG bitstreams could cause overread and segfault.
506 #define FF_INPUT_BUFFER_PADDING_SIZE 16
509 * minimum encoding buffer size
510 * Used to avoid some checks during header writing.
512 #define FF_MIN_BUFFER_SIZE 16384
516 * motion estimation type.
519 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
523 ME_EPZS, ///< enhanced predictive zonal search
524 ME_X1, ///< reserved for experiments
525 ME_HEX, ///< hexagon based search
526 ME_UMH, ///< uneven multi-hexagon search
527 ME_ITER, ///< iterative search
528 ME_TESA, ///< transformed exhaustive search algorithm
532 /* We leave some space between them for extensions (drop some
533 * keyframes for intra-only or drop just some bidir frames). */
534 AVDISCARD_NONE =-16, ///< discard nothing
535 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
536 AVDISCARD_NONREF = 8, ///< discard all non reference
537 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
538 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
539 AVDISCARD_ALL = 48, ///< discard all
542 enum AVColorPrimaries{
543 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
544 AVCOL_PRI_UNSPECIFIED=2,
546 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
547 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
548 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
550 AVCOL_PRI_NB , ///< Not part of ABI
553 enum AVColorTransferCharacteristic{
554 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
555 AVCOL_TRC_UNSPECIFIED=2,
556 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
557 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
558 AVCOL_TRC_SMPTE240M =7,
559 AVCOL_TRC_NB , ///< Not part of ABI
564 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
565 AVCOL_SPC_UNSPECIFIED=2,
567 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
568 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
569 AVCOL_SPC_SMPTE240M =7,
571 AVCOL_SPC_NB , ///< Not part of ABI
575 AVCOL_RANGE_UNSPECIFIED=0,
576 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
577 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
578 AVCOL_RANGE_NB , ///< Not part of ABI
582 * X X 3 4 X X are luma samples,
583 * 1 2 1-6 are possible chroma positions
584 * X X 5 6 X 0 is undefined/unknown position
586 enum AVChromaLocation{
587 AVCHROMA_LOC_UNSPECIFIED=0,
588 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
589 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
590 AVCHROMA_LOC_TOPLEFT =3, ///< DV
592 AVCHROMA_LOC_BOTTOMLEFT =5,
593 AVCHROMA_LOC_BOTTOM =6,
594 AVCHROMA_LOC_NB , ///< Not part of ABI
597 #if FF_API_FLAC_GLOBAL_OPTS
602 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
603 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
604 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
605 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
606 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
607 AV_LPC_TYPE_NB , ///< Not part of ABI
611 enum AVAudioServiceType {
612 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
613 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
614 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
615 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
616 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
617 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
618 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
619 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
620 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
621 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
624 typedef struct RcOverride{
627 int qscale; // If this is 0 then quality_factor will be used instead.
628 float quality_factor;
631 #define FF_MAX_B_FRAMES 16
634 These flags can be passed in AVCodecContext.flags before initialization.
635 Note: Not everything is supported yet.
638 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
639 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
640 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
641 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
642 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
644 * The parent program guarantees that the input for B-frames containing
645 * streams is not written to for at least s->max_b_frames+1 frames, if
646 * this is not set the input will be copied.
648 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
649 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
650 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
651 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
652 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
653 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
654 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
655 location instead of only at frame boundaries. */
656 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
657 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
658 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
659 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
660 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
661 /* Fx : Flag for h263+ extra options */
662 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
663 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
664 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
665 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
666 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
667 #define CODEC_FLAG_CLOSED_GOP 0x80000000
668 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
669 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
670 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
671 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
672 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
673 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
674 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
676 * @defgroup deprecated_flags Deprecated codec flags
677 * Use corresponding private codec options instead.
680 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
681 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
682 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
683 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
684 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
685 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
686 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
687 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
688 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
689 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
690 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
692 #if FF_API_MJPEG_GLOBAL_OPTS
693 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
695 #if FF_API_X264_GLOBAL_OPTS
696 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
697 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
698 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
699 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
700 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
701 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
702 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
703 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
704 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
705 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
706 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
708 #if FF_API_SNOW_GLOBAL_OPTS
709 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
711 #if FF_API_LAME_GLOBAL_OPTS
712 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
718 /* Unsupported options :
719 * Syntax Arithmetic coding (SAC)
720 * Reference Picture Selection
721 * Independent Segment Decoding */
723 /* codec capabilities */
725 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
727 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
728 * If not set, it might not use get_buffer() at all or use operations that
729 * assume the buffer was allocated by avcodec_default_get_buffer.
731 #define CODEC_CAP_DR1 0x0002
732 #if FF_API_PARSE_FRAME
733 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
734 #define CODEC_CAP_PARSE_ONLY 0x0004
736 #define CODEC_CAP_TRUNCATED 0x0008
737 /* Codec can export data for HW decoding (XvMC). */
738 #define CODEC_CAP_HWACCEL 0x0010
740 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
741 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
742 * returns frames. If this is not set, the codec is guaranteed to never be fed
745 #define CODEC_CAP_DELAY 0x0020
747 * Codec can be fed a final frame with a smaller size.
748 * This can be used to prevent truncation of the last audio samples.
750 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
752 * Codec can export data for HW decoding (VDPAU).
754 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
756 * Codec can output multiple frames per AVPacket
757 * Normally demuxers return one frame at a time, demuxers which do not do
758 * are connected to a parser to split what they return into proper frames.
759 * This flag is reserved to the very rare category of codecs which have a
760 * bitstream that cannot be split into frames without timeconsuming
761 * operations like full decoding. Demuxers carring such bitstreams thus
762 * may return multiple frames in a packet. This has many disadvantages like
763 * prohibiting stream copy in many cases thus it should only be considered
766 #define CODEC_CAP_SUBFRAMES 0x0100
768 * Codec is experimental and is thus avoided in favor of non experimental
771 #define CODEC_CAP_EXPERIMENTAL 0x0200
773 * Codec should fill in channel configuration and samplerate instead of container
775 #define CODEC_CAP_CHANNEL_CONF 0x0400
778 * Codec is able to deal with negative linesizes
780 #define CODEC_CAP_NEG_LINESIZES 0x0800
783 * Codec supports frame-level multithreading.
785 #define CODEC_CAP_FRAME_THREADS 0x1000
787 * Codec supports slice-based (or partition-based) multithreading.
789 #define CODEC_CAP_SLICE_THREADS 0x2000
793 #define CODEC_CAP_LOSSLESS 0x80000000
795 //The following defines may change, don't expect compatibility if you use them.
796 #define MB_TYPE_INTRA4x4 0x0001
797 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
798 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
799 #define MB_TYPE_16x16 0x0008
800 #define MB_TYPE_16x8 0x0010
801 #define MB_TYPE_8x16 0x0020
802 #define MB_TYPE_8x8 0x0040
803 #define MB_TYPE_INTERLACED 0x0080
804 #define MB_TYPE_DIRECT2 0x0100 //FIXME
805 #define MB_TYPE_ACPRED 0x0200
806 #define MB_TYPE_GMC 0x0400
807 #define MB_TYPE_SKIP 0x0800
808 #define MB_TYPE_P0L0 0x1000
809 #define MB_TYPE_P1L0 0x2000
810 #define MB_TYPE_P0L1 0x4000
811 #define MB_TYPE_P1L1 0x8000
812 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
813 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
814 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
815 #define MB_TYPE_QUANT 0x00010000
816 #define MB_TYPE_CBP 0x00020000
817 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
821 * This specifies the area which should be displayed.
822 * Note there may be multiple such areas for one frame.
824 typedef struct AVPanScan{
827 * - encoding: Set by user.
828 * - decoding: Set by libavcodec.
833 * width and height in 1/16 pel
834 * - encoding: Set by user.
835 * - decoding: Set by libavcodec.
841 * position of the top left corner in 1/16 pel for up to 3 fields/frames
842 * - encoding: Set by user.
843 * - decoding: Set by libavcodec.
845 int16_t position[3][2];
848 #define FF_QSCALE_TYPE_MPEG1 0
849 #define FF_QSCALE_TYPE_MPEG2 1
850 #define FF_QSCALE_TYPE_H264 2
851 #define FF_QSCALE_TYPE_VP56 3
853 #define FF_BUFFER_TYPE_INTERNAL 1
854 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
855 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
856 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
858 #if FF_API_OLD_FF_PICT_TYPES
859 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
860 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
861 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
862 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
863 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
864 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
865 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
866 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
869 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
870 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
871 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
872 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
874 enum AVPacketSideDataType {
878 typedef struct AVPacket {
880 * Presentation timestamp in AVStream->time_base units; the time at which
881 * the decompressed packet will be presented to the user.
882 * Can be AV_NOPTS_VALUE if it is not stored in the file.
883 * pts MUST be larger or equal to dts as presentation cannot happen before
884 * decompression, unless one wants to view hex dumps. Some formats misuse
885 * the terms dts and pts/cts to mean something different. Such timestamps
886 * must be converted to true pts/dts before they are stored in AVPacket.
890 * Decompression timestamp in AVStream->time_base units; the time at which
891 * the packet is decompressed.
892 * Can be AV_NOPTS_VALUE if it is not stored in the file.
899 * A combination of AV_PKT_FLAG values
903 * Additional packet data that can be provided by the container.
904 * Packet can contain several types of side information.
909 enum AVPacketSideDataType type;
914 * Duration of this packet in AVStream->time_base units, 0 if unknown.
915 * Equals next_pts - this_pts in presentation order.
918 void (*destruct)(struct AVPacket *);
920 int64_t pos; ///< byte position in stream, -1 if unknown
923 * Time difference in AVStream->time_base units from the pts of this
924 * packet to the point at which the output from the decoder has converged
925 * independent from the availability of previous frames. That is, the
926 * frames are virtually identical no matter if decoding started from
927 * the very first frame or from this keyframe.
928 * Is AV_NOPTS_VALUE if unknown.
929 * This field is not the display duration of the current packet.
930 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
933 * The purpose of this field is to allow seeking in streams that have no
934 * keyframes in the conventional sense. It corresponds to the
935 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
936 * essential for some types of subtitle streams to ensure that all
937 * subtitles are correctly displayed after seeking.
939 int64_t convergence_duration;
941 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
942 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
946 * New fields can be added to the end of AVFRAME with minor version
947 * bumps. Removal, reordering and changes to existing fields require
948 * a major version bump.
949 * sizeof(AVFrame) must not be used outside libav*.
951 typedef struct AVFrame {
952 #if FF_API_DATA_POINTERS
953 #define AV_NUM_DATA_POINTERS 4
955 #define AV_NUM_DATA_POINTERS 8
958 * pointer to the picture/channel planes.
959 * This might be different from the first allocated byte
960 * - encoding: Set by user
961 * - decoding: set by AVCodecContext.get_buffer()
963 uint8_t *data[AV_NUM_DATA_POINTERS];
966 * Size, in bytes, of the data for each picture/channel plane.
968 * For audio, only linesize[0] may be set. For planar audio, each channel
969 * plane must be the same size.
971 * - encoding: Set by user (video only)
972 * - decoding: set by AVCodecContext.get_buffer()
974 int linesize[AV_NUM_DATA_POINTERS];
977 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
978 * This isn't used by libavcodec unless the default get/release_buffer() is used.
982 uint8_t *base[AV_NUM_DATA_POINTERS];
984 * 1 -> keyframe, 0-> not
985 * - encoding: Set by libavcodec.
986 * - decoding: Set by libavcodec.
991 * Picture type of the frame, see ?_TYPE below.
992 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
993 * - decoding: Set by libavcodec.
995 enum AVPictureType pict_type;
998 * presentation timestamp in time_base units (time when frame should be shown to user)
999 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1000 * - encoding: MUST be set by user.
1001 * - decoding: Set by libavcodec.
1006 * picture number in bitstream order
1007 * - encoding: set by
1008 * - decoding: Set by libavcodec.
1010 int coded_picture_number;
1012 * picture number in display order
1013 * - encoding: set by
1014 * - decoding: Set by libavcodec.
1016 int display_picture_number;
1019 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1020 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1021 * - decoding: Set by libavcodec.
1026 * buffer age (1->was last buffer and dint change, 2->..., ...).
1027 * Set to INT_MAX if the buffer has not been used yet.
1028 * - encoding: unused
1029 * - decoding: MUST be set by get_buffer() for video.
1034 * is this picture used as reference
1035 * The values for this are the same as the MpegEncContext.picture_structure
1036 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1037 * Set to 4 for delayed, non-reference frames.
1038 * - encoding: unused
1039 * - decoding: Set by libavcodec. (before get_buffer() call)).
1045 * - encoding: unused
1046 * - decoding: Set by libavcodec.
1048 int8_t *qscale_table;
1051 * - encoding: unused
1052 * - decoding: Set by libavcodec.
1057 * mbskip_table[mb]>=1 if MB didn't change
1058 * stride= mb_width = (width+15)>>4
1059 * - encoding: unused
1060 * - decoding: Set by libavcodec.
1062 uint8_t *mbskip_table;
1065 * motion vector table
1068 * int mv_sample_log2= 4 - motion_subsample_log2;
1069 * int mb_width= (width+15)>>4;
1070 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1071 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1073 * - encoding: Set by user.
1074 * - decoding: Set by libavcodec.
1076 int16_t (*motion_val[2])[2];
1079 * macroblock type table
1080 * mb_type_base + mb_width + 2
1081 * - encoding: Set by user.
1082 * - decoding: Set by libavcodec.
1087 * log2 of the size of the block which a single vector in motion_val represents:
1088 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1089 * - encoding: unused
1090 * - decoding: Set by libavcodec.
1092 uint8_t motion_subsample_log2;
1095 * for some private data of the user
1096 * - encoding: unused
1097 * - decoding: Set by user.
1103 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1104 * - decoding: unused
1106 uint64_t error[AV_NUM_DATA_POINTERS];
1109 * type of the buffer (to keep track of who has to deallocate data[*])
1110 * - encoding: Set by the one who allocates it.
1111 * - decoding: Set by the one who allocates it.
1112 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1117 * When decoding, this signals how much the picture must be delayed.
1118 * extra_delay = repeat_pict / (2*fps)
1119 * - encoding: unused
1120 * - decoding: Set by libavcodec.
1130 * The content of the picture is interlaced.
1131 * - encoding: Set by user.
1132 * - decoding: Set by libavcodec. (default 0)
1134 int interlaced_frame;
1137 * If the content is interlaced, is top field displayed first.
1138 * - encoding: Set by user.
1139 * - decoding: Set by libavcodec.
1141 int top_field_first;
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1148 AVPanScan *pan_scan;
1151 * Tell user application that palette has changed from previous frame.
1152 * - encoding: ??? (no palette-enabled encoder yet)
1153 * - decoding: Set by libavcodec. (default 0).
1155 int palette_has_changed;
1158 * codec suggestion on buffer type if != 0
1159 * - encoding: unused
1160 * - decoding: Set by libavcodec. (before get_buffer() call)).
1166 * - encoding: unused
1167 * - decoding: Set by libavcodec.
1172 * motion reference frame index
1173 * the order in which these are stored can depend on the codec.
1174 * - encoding: Set by user.
1175 * - decoding: Set by libavcodec.
1177 int8_t *ref_index[2];
1180 * reordered opaque 64bit (generally an integer or a double precision float
1181 * PTS but can be anything).
1182 * The user sets AVCodecContext.reordered_opaque to represent the input at
1184 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1185 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1186 * @deprecated in favor of pkt_pts
1187 * - encoding: unused
1188 * - decoding: Read by user.
1190 int64_t reordered_opaque;
1193 * hardware accelerator private data (FFmpeg-allocated)
1194 * - encoding: unused
1195 * - decoding: Set by libavcodec
1197 void *hwaccel_picture_private;
1200 * reordered pts from the last AVPacket that has been input into the decoder
1201 * - encoding: unused
1202 * - decoding: Read by user.
1207 * dts from the last AVPacket that has been input into the decoder
1208 * - encoding: unused
1209 * - decoding: Read by user.
1214 * the AVCodecContext which ff_thread_get_buffer() was last called on
1215 * - encoding: Set by libavcodec.
1216 * - decoding: Set by libavcodec.
1218 struct AVCodecContext *owner;
1221 * used by multithreading to store frame-specific info
1222 * - encoding: Set by libavcodec.
1223 * - decoding: Set by libavcodec.
1225 void *thread_opaque;
1228 * number of audio samples (per channel) described by this frame
1229 * - encoding: unused
1230 * - decoding: Set by libavcodec
1235 * pointers to the data planes/channels.
1237 * For video, this should simply point to data[].
1239 * For planar audio, each channel has a separate data pointer, and
1240 * linesize[0] contains the size of each channel buffer.
1241 * For packed audio, there is just one data pointer, and linesize[0]
1242 * contains the total size of the buffer for all channels.
1244 * Note: Both data and extended_data will always be set by get_buffer(),
1245 * but for planar audio with more channels that can fit in data,
1246 * extended_data must be used by the decoder in order to access all
1250 * decoding: set by AVCodecContext.get_buffer()
1252 uint8_t **extended_data;
1255 * frame timestamp estimated using various heuristics, in stream time base
1256 * - encoding: unused
1257 * - decoding: set by libavcodec, read by user.
1259 int64_t best_effort_timestamp;
1262 * reordered pos from the last AVPacket that has been input into the decoder
1263 * - encoding: unused
1264 * - decoding: Read by user.
1269 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1270 * - encoding: unused
1271 * - decoding: Read by user.
1273 AVRational sample_aspect_ratio;
1276 * width and height of the video frame
1277 * - encoding: unused
1278 * - decoding: Read by user.
1283 * format of the frame, -1 if unknown or unset
1284 * It should be cast to the corresponding enum (enum PixelFormat
1285 * for video, enum AVSampleFormat for audio)
1286 * - encoding: unused
1287 * - decoding: Read by user.
1293 struct AVCodecInternal;
1296 * main external API structure.
1297 * New fields can be added to the end with minor version bumps.
1298 * Removal, reordering and changes to existing fields require a major
1300 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1302 * sizeof(AVCodecContext) must not be used outside libav*.
1304 typedef struct AVCodecContext {
1306 * information on struct for av_log
1307 * - set by avcodec_alloc_context3
1309 const AVClass *av_class;
1311 * the average bitrate
1312 * - encoding: Set by user; unused for constant quantizer encoding.
1313 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1318 * number of bits the bitstream is allowed to diverge from the reference.
1319 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1320 * - encoding: Set by user; unused for constant quantizer encoding.
1321 * - decoding: unused
1323 int bit_rate_tolerance;
1327 * - encoding: Set by user.
1328 * - decoding: Set by user.
1333 * Some codecs need additional format info. It is stored here.
1334 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1335 * specific codec MUST set it correctly otherwise stream copy breaks.
1336 * In general use of this field by muxers is not recommanded.
1337 * - encoding: Set by libavcodec.
1338 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1343 * Motion estimation algorithm used for video coding.
1344 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1345 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1346 * - encoding: MUST be set by user.
1347 * - decoding: unused
1352 * some codecs need / can use extradata like Huffman tables.
1353 * mjpeg: Huffman tables
1354 * rv10: additional flags
1355 * mpeg4: global headers (they can be in the bitstream or here)
1356 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1357 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1358 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1359 * - encoding: Set/allocated/freed by libavcodec.
1360 * - decoding: Set/allocated/freed by user.
1366 * This is the fundamental unit of time (in seconds) in terms
1367 * of which frame timestamps are represented. For fixed-fps content,
1368 * timebase should be 1/framerate and timestamp increments should be
1370 * - encoding: MUST be set by user.
1371 * - decoding: Set by libavcodec.
1373 AVRational time_base;
1377 * picture width / height.
1378 * - encoding: MUST be set by user.
1379 * - decoding: Set by libavcodec.
1380 * Note: For compatibility it is possible to set this instead of
1381 * coded_width/height before decoding.
1385 #define FF_ASPECT_EXTENDED 15
1388 * the number of pictures in a group of pictures, or 0 for intra_only
1389 * - encoding: Set by user.
1390 * - decoding: unused
1395 * Pixel format, see PIX_FMT_xxx.
1396 * May be set by the demuxer if known from headers.
1397 * May be overriden by the decoder if it knows better.
1398 * - encoding: Set by user.
1399 * - decoding: Set by user if known, overridden by libavcodec if known
1401 enum PixelFormat pix_fmt;
1404 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1405 * decoder to draw a horizontal band. It improves cache usage. Not
1406 * all codecs can do that. You must check the codec capabilities
1408 * When multithreading is used, it may be called from multiple threads
1409 * at the same time; threads might draw different parts of the same AVFrame,
1410 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1412 * The function is also used by hardware acceleration APIs.
1413 * It is called at least once during frame decoding to pass
1414 * the data needed for hardware render.
1415 * In that mode instead of pixel data, AVFrame points to
1416 * a structure specific to the acceleration API. The application
1417 * reads the structure and can change some fields to indicate progress
1419 * - encoding: unused
1420 * - decoding: Set by user.
1421 * @param height the height of the slice
1422 * @param y the y position of the slice
1423 * @param type 1->top field, 2->bottom field, 3->frame
1424 * @param offset offset into the AVFrame.data from which the slice should be read
1426 void (*draw_horiz_band)(struct AVCodecContext *s,
1427 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1428 int y, int type, int height);
1431 int sample_rate; ///< samples per second
1432 int channels; ///< number of audio channels
1435 * audio sample format
1436 * - encoding: Set by user.
1437 * - decoding: Set by libavcodec.
1439 enum AVSampleFormat sample_fmt; ///< sample format
1441 /* The following data should not be initialized. */
1443 * Samples per packet, initialized when calling 'init'.
1446 int frame_number; ///< audio or video frame number
1449 * Encoding: Number of frames delay there will be from the encoder input to
1450 * the decoder output. (we assume the decoder matches the spec)
1451 * Decoding: Number of frames delay in addition to what a standard decoder
1452 * as specified in the spec would produce.
1453 * - encoding: Set by libavcodec.
1454 * - decoding: Set by libavcodec.
1458 /* - encoding parameters */
1459 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1460 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1464 * - encoding: Set by user.
1465 * - decoding: unused
1471 * - encoding: Set by user.
1472 * - decoding: unused
1477 * maximum quantizer difference between frames
1478 * - encoding: Set by user.
1479 * - decoding: unused
1484 * maximum number of B-frames between non-B-frames
1485 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1486 * - encoding: Set by user.
1487 * - decoding: unused
1492 * qscale factor between IP and B-frames
1493 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1494 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1495 * - encoding: Set by user.
1496 * - decoding: unused
1498 float b_quant_factor;
1500 /** obsolete FIXME remove */
1502 #define FF_RC_STRATEGY_XVID 1
1504 int b_frame_strategy;
1506 struct AVCodec *codec;
1510 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1511 /* do its best to deliver a chunk with size */
1512 /* below rtp_payload_size, the chunk will start */
1513 /* with a start code on some codecs like H.263. */
1514 /* This doesn't take account of any particular */
1515 /* headers inside the transmitted RTP payload. */
1518 /* The RTP callback: This function is called */
1519 /* every time the encoder has a packet to send. */
1520 /* It depends on the encoder if the data starts */
1521 /* with a Start Code (it should). H.263 does. */
1522 /* mb_nb contains the number of macroblocks */
1523 /* encoded in the RTP payload. */
1524 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1526 /* statistics, used for 2-pass encoding */
1537 * number of bits used for the previously encoded frame
1538 * - encoding: Set by libavcodec.
1539 * - decoding: unused
1544 * Private data of the user, can be used to carry app specific stuff.
1545 * - encoding: Set by user.
1546 * - decoding: Set by user.
1550 char codec_name[32];
1551 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1552 enum CodecID codec_id; /* see CODEC_ID_xxx */
1555 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1556 * This is used to work around some encoder bugs.
1557 * A demuxer should set this to what is stored in the field used to identify the codec.
1558 * If there are multiple such fields in a container then the demuxer should choose the one
1559 * which maximizes the information about the used codec.
1560 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1561 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1562 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1564 * - encoding: Set by user, if not then the default based on codec_id will be used.
1565 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1567 unsigned int codec_tag;
1570 * Work around bugs in encoders which sometimes cannot be detected automatically.
1571 * - encoding: Set by user
1572 * - decoding: Set by user
1574 int workaround_bugs;
1575 #define FF_BUG_AUTODETECT 1 ///< autodetection
1576 #define FF_BUG_OLD_MSMPEG4 2
1577 #define FF_BUG_XVID_ILACE 4
1578 #define FF_BUG_UMP4 8
1579 #define FF_BUG_NO_PADDING 16
1580 #define FF_BUG_AMV 32
1581 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1582 #define FF_BUG_QPEL_CHROMA 64
1583 #define FF_BUG_STD_QPEL 128
1584 #define FF_BUG_QPEL_CHROMA2 256
1585 #define FF_BUG_DIRECT_BLOCKSIZE 512
1586 #define FF_BUG_EDGE 1024
1587 #define FF_BUG_HPEL_CHROMA 2048
1588 #define FF_BUG_DC_CLIP 4096
1589 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1590 #define FF_BUG_TRUNCATED 16384
1591 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1594 * luma single coefficient elimination threshold
1595 * - encoding: Set by user.
1596 * - decoding: unused
1598 int luma_elim_threshold;
1601 * chroma single coeff elimination threshold
1602 * - encoding: Set by user.
1603 * - decoding: unused
1605 int chroma_elim_threshold;
1608 * strictly follow the standard (MPEG4, ...).
1609 * - encoding: Set by user.
1610 * - decoding: Set by user.
1611 * Setting this to STRICT or higher means the encoder and decoder will
1612 * generally do stupid things, whereas setting it to unofficial or lower
1613 * will mean the encoder might produce output that is not supported by all
1614 * spec-compliant decoders. Decoders don't differentiate between normal,
1615 * unofficial and experimental (that is, they always try to decode things
1616 * when they can) unless they are explicitly asked to behave stupidly
1617 * (=strictly conform to the specs)
1619 int strict_std_compliance;
1620 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1621 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1622 #define FF_COMPLIANCE_NORMAL 0
1623 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1624 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1627 * qscale offset between IP and B-frames
1628 * - encoding: Set by user.
1629 * - decoding: unused
1631 float b_quant_offset;
1635 * Error recognition; higher values will detect more errors but may
1636 * misdetect some more or less valid parts as errors.
1637 * - encoding: unused
1638 * - decoding: Set by user.
1640 attribute_deprecated int error_recognition;
1641 #define FF_ER_CAREFUL 1
1642 #define FF_ER_COMPLIANT 2
1643 #define FF_ER_AGGRESSIVE 3
1644 #define FF_ER_VERY_AGGRESSIVE 4
1645 #define FF_ER_EXPLODE 5
1646 #endif /* FF_API_ER */
1649 * Called at the beginning of each frame to get a buffer for it.
1651 * The function will set AVFrame.data[], AVFrame.linesize[].
1652 * AVFrame.extended_data[] must also be set, but it should be the same as
1653 * AVFrame.data[] except for planar audio with more channels than can fit
1654 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1655 * many data pointers as it can hold.
1657 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1658 * avcodec_default_get_buffer() instead of providing buffers allocated by
1661 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1662 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1663 * but if get_buffer() is overridden then alignment considerations should
1664 * be taken into account.
1666 * @see avcodec_default_get_buffer()
1670 * If pic.reference is set then the frame will be read later by libavcodec.
1671 * avcodec_align_dimensions2() should be used to find the required width and
1672 * height, as they normally need to be rounded up to the next multiple of 16.
1674 * If frame multithreading is used and thread_safe_callbacks is set,
1675 * it may be called from a different thread, but not from more than one at
1676 * once. Does not need to be reentrant.
1678 * @see release_buffer(), reget_buffer()
1679 * @see avcodec_align_dimensions2()
1683 * Decoders request a buffer of a particular size by setting
1684 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1685 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1686 * to a smaller value in the output frame.
1688 * Decoders cannot use the buffer after returning from
1689 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1690 * is assumed to be released immediately upon return.
1692 * As a convenience, av_samples_get_buffer_size() and
1693 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1694 * functions to find the required data size and to fill data pointers and
1695 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1696 * since all planes must be the same size.
1698 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1700 * - encoding: unused
1701 * - decoding: Set by libavcodec, user can override.
1703 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1706 * Called to release buffers which were allocated with get_buffer.
1707 * A released buffer can be reused in get_buffer().
1708 * pic.data[*] must be set to NULL.
1709 * May be called from a different thread if frame multithreading is used,
1710 * but not by more than one thread at once, so does not need to be reentrant.
1711 * - encoding: unused
1712 * - decoding: Set by libavcodec, user can override.
1714 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1717 * Size of the frame reordering buffer in the decoder.
1718 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1719 * - encoding: Set by libavcodec.
1720 * - decoding: Set by libavcodec.
1725 * number of bytes per packet if constant and known or 0
1726 * Used by some WAV based audio codecs.
1730 #if FF_API_PARSE_FRAME
1732 * If true, only parsing is done. The frame data is returned.
1733 * Only MPEG audio decoders support this now.
1734 * - encoding: unused
1735 * - decoding: Set by user
1737 attribute_deprecated int parse_only;
1741 * 0-> h263 quant 1-> mpeg quant
1742 * - encoding: Set by user.
1743 * - decoding: unused
1748 * pass1 encoding statistics output buffer
1749 * - encoding: Set by libavcodec.
1750 * - decoding: unused
1755 * pass2 encoding statistics input buffer
1756 * Concatenated stuff from stats_out of pass1 should be placed here.
1757 * - encoding: Allocated/set/freed by user.
1758 * - decoding: unused
1763 * ratecontrol qmin qmax limiting method
1764 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1765 * - encoding: Set by user.
1766 * - decoding: unused
1774 * ratecontrol override, see RcOverride
1775 * - encoding: Allocated/set/freed by user.
1776 * - decoding: unused
1778 RcOverride *rc_override;
1779 int rc_override_count;
1782 * rate control equation
1783 * - encoding: Set by user
1784 * - decoding: unused
1790 * - encoding: Set by user.
1791 * - decoding: unused
1797 * - encoding: Set by user.
1798 * - decoding: unused
1803 * decoder bitstream buffer size
1804 * - encoding: Set by user.
1805 * - decoding: unused
1808 float rc_buffer_aggressivity;
1811 * qscale factor between P and I-frames
1812 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1813 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 float i_quant_factor;
1820 * qscale offset between P and I-frames
1821 * - encoding: Set by user.
1822 * - decoding: unused
1824 float i_quant_offset;
1827 * initial complexity for pass1 ratecontrol
1828 * - encoding: Set by user.
1829 * - decoding: unused
1831 float rc_initial_cplx;
1834 * DCT algorithm, see FF_DCT_* below
1835 * - encoding: Set by user.
1836 * - decoding: unused
1839 #define FF_DCT_AUTO 0
1840 #define FF_DCT_FASTINT 1
1841 #define FF_DCT_INT 2
1842 #define FF_DCT_MMX 3
1843 #define FF_DCT_MLIB 4
1844 #define FF_DCT_ALTIVEC 5
1845 #define FF_DCT_FAAN 6
1848 * luminance masking (0-> disabled)
1849 * - encoding: Set by user.
1850 * - decoding: unused
1855 * temporary complexity masking (0-> disabled)
1856 * - encoding: Set by user.
1857 * - decoding: unused
1859 float temporal_cplx_masking;
1862 * spatial complexity masking (0-> disabled)
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 float spatial_cplx_masking;
1869 * p block masking (0-> disabled)
1870 * - encoding: Set by user.
1871 * - decoding: unused
1876 * darkness masking (0-> disabled)
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * IDCT algorithm, see FF_IDCT_* below.
1884 * - encoding: Set by user.
1885 * - decoding: Set by user.
1888 #define FF_IDCT_AUTO 0
1889 #define FF_IDCT_INT 1
1890 #define FF_IDCT_SIMPLE 2
1891 #define FF_IDCT_SIMPLEMMX 3
1892 #define FF_IDCT_LIBMPEG2MMX 4
1893 #define FF_IDCT_PS2 5
1894 #define FF_IDCT_MLIB 6
1895 #define FF_IDCT_ARM 7
1896 #define FF_IDCT_ALTIVEC 8
1897 #define FF_IDCT_SH4 9
1898 #define FF_IDCT_SIMPLEARM 10
1899 #define FF_IDCT_H264 11
1900 #define FF_IDCT_VP3 12
1901 #define FF_IDCT_IPP 13
1902 #define FF_IDCT_XVIDMMX 14
1903 #define FF_IDCT_CAVS 15
1904 #define FF_IDCT_SIMPLEARMV5TE 16
1905 #define FF_IDCT_SIMPLEARMV6 17
1906 #define FF_IDCT_SIMPLEVIS 18
1907 #define FF_IDCT_WMV2 19
1908 #define FF_IDCT_FAAN 20
1909 #define FF_IDCT_EA 21
1910 #define FF_IDCT_SIMPLENEON 22
1911 #define FF_IDCT_SIMPLEALPHA 23
1912 #define FF_IDCT_BINK 24
1916 * - encoding: Set by libavcodec.
1917 * - decoding: Set by user (or 0).
1921 * slice offsets in the frame in bytes
1922 * - encoding: Set/allocated by libavcodec.
1923 * - decoding: Set/allocated by user (or NULL).
1928 * error concealment flags
1929 * - encoding: unused
1930 * - decoding: Set by user.
1932 int error_concealment;
1933 #define FF_EC_GUESS_MVS 1
1934 #define FF_EC_DEBLOCK 2
1937 * dsp_mask could be add used to disable unwanted CPU features
1938 * CPU features (i.e. MMX, SSE. ...)
1940 * With the FORCE flag you may instead enable given CPU features.
1941 * (Dangerous: Usable in case of misdetection, improper usage however will
1942 * result into program crash.)
1947 * bits per sample/pixel from the demuxer (needed for huffyuv).
1948 * - encoding: Set by libavcodec.
1949 * - decoding: Set by user.
1951 int bits_per_coded_sample;
1954 * prediction method (needed for huffyuv)
1955 * - encoding: Set by user.
1956 * - decoding: unused
1958 int prediction_method;
1959 #define FF_PRED_LEFT 0
1960 #define FF_PRED_PLANE 1
1961 #define FF_PRED_MEDIAN 2
1964 * sample aspect ratio (0 if unknown)
1965 * That is the width of a pixel divided by the height of the pixel.
1966 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1967 * - encoding: Set by user.
1968 * - decoding: Set by libavcodec.
1970 AVRational sample_aspect_ratio;
1973 * the picture in the bitstream
1974 * - encoding: Set by libavcodec.
1975 * - decoding: Set by libavcodec.
1977 AVFrame *coded_frame;
1981 * - encoding: Set by user.
1982 * - decoding: Set by user.
1985 #define FF_DEBUG_PICT_INFO 1
1986 #define FF_DEBUG_RC 2
1987 #define FF_DEBUG_BITSTREAM 4
1988 #define FF_DEBUG_MB_TYPE 8
1989 #define FF_DEBUG_QP 16
1990 #define FF_DEBUG_MV 32
1991 #define FF_DEBUG_DCT_COEFF 0x00000040
1992 #define FF_DEBUG_SKIP 0x00000080
1993 #define FF_DEBUG_STARTCODE 0x00000100
1994 #define FF_DEBUG_PTS 0x00000200
1995 #define FF_DEBUG_ER 0x00000400
1996 #define FF_DEBUG_MMCO 0x00000800
1997 #define FF_DEBUG_BUGS 0x00001000
1998 #define FF_DEBUG_VIS_QP 0x00002000
1999 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2000 #define FF_DEBUG_BUFFERS 0x00008000
2001 #define FF_DEBUG_THREADS 0x00010000
2005 * - encoding: Set by user.
2006 * - decoding: Set by user.
2009 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2010 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2011 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2015 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2016 * - decoding: unused
2018 uint64_t error[AV_NUM_DATA_POINTERS];
2021 * motion estimation comparison function
2022 * - encoding: Set by user.
2023 * - decoding: unused
2027 * subpixel motion estimation comparison function
2028 * - encoding: Set by user.
2029 * - decoding: unused
2033 * macroblock comparison function (not supported yet)
2034 * - encoding: Set by user.
2035 * - decoding: unused
2039 * interlaced DCT comparison function
2040 * - encoding: Set by user.
2041 * - decoding: unused
2044 #define FF_CMP_SAD 0
2045 #define FF_CMP_SSE 1
2046 #define FF_CMP_SATD 2
2047 #define FF_CMP_DCT 3
2048 #define FF_CMP_PSNR 4
2049 #define FF_CMP_BIT 5
2051 #define FF_CMP_ZERO 7
2052 #define FF_CMP_VSAD 8
2053 #define FF_CMP_VSSE 9
2054 #define FF_CMP_NSSE 10
2055 #define FF_CMP_W53 11
2056 #define FF_CMP_W97 12
2057 #define FF_CMP_DCTMAX 13
2058 #define FF_CMP_DCT264 14
2059 #define FF_CMP_CHROMA 256
2062 * ME diamond size & shape
2063 * - encoding: Set by user.
2064 * - decoding: unused
2069 * amount of previous MV predictors (2a+1 x 2a+1 square)
2070 * - encoding: Set by user.
2071 * - decoding: unused
2073 int last_predictor_count;
2076 * prepass for motion estimation
2077 * - encoding: Set by user.
2078 * - decoding: unused
2083 * motion estimation prepass comparison function
2084 * - encoding: Set by user.
2085 * - decoding: unused
2090 * ME prepass diamond size & shape
2091 * - encoding: Set by user.
2092 * - decoding: unused
2098 * - encoding: Set by user.
2099 * - decoding: unused
2101 int me_subpel_quality;
2104 * callback to negotiate the pixelFormat
2105 * @param fmt is the list of formats which are supported by the codec,
2106 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2107 * The first is always the native one.
2108 * @return the chosen format
2109 * - encoding: unused
2110 * - decoding: Set by user, if not set the native format will be chosen.
2112 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2115 * DTG active format information (additional aspect ratio
2116 * information only used in DVB MPEG-2 transport streams)
2119 * - encoding: unused
2120 * - decoding: Set by decoder.
2122 int dtg_active_format;
2123 #define FF_DTG_AFD_SAME 8
2124 #define FF_DTG_AFD_4_3 9
2125 #define FF_DTG_AFD_16_9 10
2126 #define FF_DTG_AFD_14_9 11
2127 #define FF_DTG_AFD_4_3_SP_14_9 13
2128 #define FF_DTG_AFD_16_9_SP_14_9 14
2129 #define FF_DTG_AFD_SP_4_3 15
2132 * maximum motion estimation search range in subpel units
2133 * If 0 then no limit.
2135 * - encoding: Set by user.
2136 * - decoding: unused
2141 * intra quantizer bias
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 int intra_quant_bias;
2146 #define FF_DEFAULT_QUANT_BIAS 999999
2149 * inter quantizer bias
2150 * - encoding: Set by user.
2151 * - decoding: unused
2153 int inter_quant_bias;
2157 * - encoding: unused
2158 * - decoding: Which clrtable should be used for 8bit RGB images.
2159 * Tables have to be stored somewhere. FIXME
2163 #if FF_API_INTERNAL_CONTEXT
2165 * internal_buffer count
2166 * Don't touch, used by libavcodec default_get_buffer().
2167 * @deprecated this field was moved to an internal context
2169 attribute_deprecated int internal_buffer_count;
2173 * Don't touch, used by libavcodec default_get_buffer().
2174 * @deprecated this field was moved to an internal context
2176 attribute_deprecated void *internal_buffer;
2180 * Global quality for codecs which cannot change it per frame.
2181 * This should be proportional to MPEG-1/2/4 qscale.
2182 * - encoding: Set by user.
2183 * - decoding: unused
2187 #define FF_CODER_TYPE_VLC 0
2188 #define FF_CODER_TYPE_AC 1
2189 #define FF_CODER_TYPE_RAW 2
2190 #define FF_CODER_TYPE_RLE 3
2191 #define FF_CODER_TYPE_DEFLATE 4
2194 * - encoding: Set by user.
2195 * - decoding: unused
2201 * - encoding: Set by user.
2202 * - decoding: unused
2208 * - encoding: unused
2209 * - decoding: Set by user.
2211 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2216 * - encoding: unused
2217 * - decoding: Set by user.
2220 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2221 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2222 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2225 * XVideo Motion Acceleration
2226 * - encoding: forbidden
2227 * - decoding: set by decoder
2229 int xvmc_acceleration;
2232 * macroblock decision mode
2233 * - encoding: Set by user.
2234 * - decoding: unused
2237 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2238 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2239 #define FF_MB_DECISION_RD 2 ///< rate distortion
2242 * custom intra quantization matrix
2243 * - encoding: Set by user, can be NULL.
2244 * - decoding: Set by libavcodec.
2246 uint16_t *intra_matrix;
2249 * custom inter quantization matrix
2250 * - encoding: Set by user, can be NULL.
2251 * - decoding: Set by libavcodec.
2253 uint16_t *inter_matrix;
2256 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2257 * This is used to work around some encoder bugs.
2258 * - encoding: unused
2259 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2261 unsigned int stream_codec_tag;
2264 * scene change detection threshold
2265 * 0 is default, larger means fewer detected scene changes.
2266 * - encoding: Set by user.
2267 * - decoding: unused
2269 int scenechange_threshold;
2272 * minimum Lagrange multipler
2273 * - encoding: Set by user.
2274 * - decoding: unused
2279 * maximum Lagrange multipler
2280 * - encoding: Set by user.
2281 * - decoding: unused
2285 #if FF_API_PALETTE_CONTROL
2287 * palette control structure
2288 * - encoding: ??? (no palette-enabled encoder yet)
2289 * - decoding: Set by user.
2291 struct AVPaletteControl *palctrl;
2295 * noise reduction strength
2296 * - encoding: Set by user.
2297 * - decoding: unused
2299 int noise_reduction;
2302 * Called at the beginning of a frame to get cr buffer for it.
2303 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2304 * libavcodec will pass previous buffer in pic, function should return
2305 * same buffer or new buffer with old frame "painted" into it.
2306 * If pic.data[0] == NULL must behave like get_buffer().
2307 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2308 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2310 * - encoding: unused
2311 * - decoding: Set by libavcodec, user can override.
2313 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2316 * Number of bits which should be loaded into the rc buffer before decoding starts.
2317 * - encoding: Set by user.
2318 * - decoding: unused
2320 int rc_initial_buffer_occupancy;
2324 * - encoding: Set by user.
2325 * - decoding: unused
2327 int inter_threshold;
2331 * - encoding: Set by user.
2332 * - decoding: Set by user.
2337 * Simulates errors in the bitstream to test error concealment.
2338 * - encoding: Set by user.
2339 * - decoding: unused
2343 #if FF_API_ANTIALIAS_ALGO
2345 * MP3 antialias algorithm, see FF_AA_* below.
2346 * - encoding: unused
2347 * - decoding: Set by user.
2349 attribute_deprecated int antialias_algo;
2350 #define FF_AA_AUTO 0
2351 #define FF_AA_FASTINT 1 //not implemented yet
2353 #define FF_AA_FLOAT 3
2357 * quantizer noise shaping
2358 * - encoding: Set by user.
2359 * - decoding: unused
2361 int quantizer_noise_shaping;
2365 * is used to decide how many independent tasks should be passed to execute()
2366 * - encoding: Set by user.
2367 * - decoding: Set by user.
2372 * The codec may call this to execute several independent things.
2373 * It will return only after finishing all tasks.
2374 * The user may replace this with some multithreaded implementation,
2375 * the default implementation will execute the parts serially.
2376 * @param count the number of things to execute
2377 * - encoding: Set by libavcodec, user can override.
2378 * - decoding: Set by libavcodec, user can override.
2380 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2384 * Can be used by execute() to store some per AVCodecContext stuff.
2385 * - encoding: set by execute()
2386 * - decoding: set by execute()
2388 void *thread_opaque;
2391 * Motion estimation threshold below which no motion estimation is
2392 * performed, but instead the user specified motion vectors are used.
2394 * - encoding: Set by user.
2395 * - decoding: unused
2400 * Macroblock threshold below which the user specified macroblock types will be used.
2401 * - encoding: Set by user.
2402 * - decoding: unused
2407 * precision of the intra DC coefficient - 8
2408 * - encoding: Set by user.
2409 * - decoding: unused
2411 int intra_dc_precision;
2414 * noise vs. sse weight for the nsse comparsion function
2415 * - encoding: Set by user.
2416 * - decoding: unused
2421 * Number of macroblock rows at the top which are skipped.
2422 * - encoding: unused
2423 * - decoding: Set by user.
2428 * Number of macroblock rows at the bottom which are skipped.
2429 * - encoding: unused
2430 * - decoding: Set by user.
2436 * - encoding: Set by user.
2437 * - decoding: Set by libavcodec.
2440 #define FF_PROFILE_UNKNOWN -99
2441 #define FF_PROFILE_RESERVED -100
2443 #define FF_PROFILE_AAC_MAIN 0
2444 #define FF_PROFILE_AAC_LOW 1
2445 #define FF_PROFILE_AAC_SSR 2
2446 #define FF_PROFILE_AAC_LTP 3
2448 #define FF_PROFILE_DTS 20
2449 #define FF_PROFILE_DTS_ES 30
2450 #define FF_PROFILE_DTS_96_24 40
2451 #define FF_PROFILE_DTS_HD_HRA 50
2452 #define FF_PROFILE_DTS_HD_MA 60
2454 #define FF_PROFILE_MPEG2_422 0
2455 #define FF_PROFILE_MPEG2_HIGH 1
2456 #define FF_PROFILE_MPEG2_SS 2
2457 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2458 #define FF_PROFILE_MPEG2_MAIN 4
2459 #define FF_PROFILE_MPEG2_SIMPLE 5
2461 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2462 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2464 #define FF_PROFILE_H264_BASELINE 66
2465 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2466 #define FF_PROFILE_H264_MAIN 77
2467 #define FF_PROFILE_H264_EXTENDED 88
2468 #define FF_PROFILE_H264_HIGH 100
2469 #define FF_PROFILE_H264_HIGH_10 110
2470 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2471 #define FF_PROFILE_H264_HIGH_422 122
2472 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2473 #define FF_PROFILE_H264_HIGH_444 144
2474 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2475 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2476 #define FF_PROFILE_H264_CAVLC_444 44
2478 #define FF_PROFILE_VC1_SIMPLE 0
2479 #define FF_PROFILE_VC1_MAIN 1
2480 #define FF_PROFILE_VC1_COMPLEX 2
2481 #define FF_PROFILE_VC1_ADVANCED 3
2483 #define FF_PROFILE_MPEG4_SIMPLE 0
2484 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2485 #define FF_PROFILE_MPEG4_CORE 2
2486 #define FF_PROFILE_MPEG4_MAIN 3
2487 #define FF_PROFILE_MPEG4_N_BIT 4
2488 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2489 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2490 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2491 #define FF_PROFILE_MPEG4_HYBRID 8
2492 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2493 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2494 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2495 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2496 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2497 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2498 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2502 * - encoding: Set by user.
2503 * - decoding: Set by libavcodec.
2506 #define FF_LEVEL_UNKNOWN -99
2509 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2510 * - encoding: unused
2511 * - decoding: Set by user.
2516 * Bitstream width / height, may be different from width/height if lowres enabled.
2517 * - encoding: unused
2518 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2520 int coded_width, coded_height;
2523 * frame skip threshold
2524 * - encoding: Set by user.
2525 * - decoding: unused
2527 int frame_skip_threshold;
2531 * - encoding: Set by user.
2532 * - decoding: unused
2534 int frame_skip_factor;
2537 * frame skip exponent
2538 * - encoding: Set by user.
2539 * - decoding: unused
2544 * frame skip comparison function
2545 * - encoding: Set by user.
2546 * - decoding: unused
2551 * Border processing masking, raises the quantizer for mbs on the borders
2553 * - encoding: Set by user.
2554 * - decoding: unused
2556 float border_masking;
2559 * minimum MB lagrange multipler
2560 * - encoding: Set by user.
2561 * - decoding: unused
2566 * maximum MB lagrange multipler
2567 * - encoding: Set by user.
2568 * - decoding: unused
2574 * - encoding: Set by user.
2575 * - decoding: unused
2577 int me_penalty_compensation;
2581 * - encoding: unused
2582 * - decoding: Set by user.
2584 enum AVDiscard skip_loop_filter;
2588 * - encoding: unused
2589 * - decoding: Set by user.
2591 enum AVDiscard skip_idct;
2595 * - encoding: unused
2596 * - decoding: Set by user.
2598 enum AVDiscard skip_frame;
2602 * - encoding: Set by user.
2603 * - decoding: unused
2609 * - encoding: Set by user.
2610 * - decoding: unused
2614 #if FF_API_X264_GLOBAL_OPTS
2616 * constant rate factor - quality-based VBR - values ~correspond to qps
2617 * - encoding: Set by user.
2618 * - decoding: unused
2619 * @deprecated use 'crf' libx264 private option
2621 attribute_deprecated float crf;
2624 * constant quantization parameter rate control method
2625 * - encoding: Set by user.
2626 * - decoding: unused
2627 * @deprecated use 'cqp' libx264 private option
2629 attribute_deprecated int cqp;
2634 * - encoding: Set by user.
2635 * - decoding: unused
2640 * number of reference frames
2641 * - encoding: Set by user.
2642 * - decoding: Set by lavc.
2647 * chroma qp offset from luma
2648 * - encoding: Set by user.
2649 * - decoding: unused
2653 #if FF_API_X264_GLOBAL_OPTS
2655 * Influences how often B-frames are used.
2656 * - encoding: Set by user.
2657 * - decoding: unused
2659 attribute_deprecated int bframebias;
2663 * trellis RD quantization
2664 * - encoding: Set by user.
2665 * - decoding: unused
2669 #if FF_API_X264_GLOBAL_OPTS
2671 * Reduce fluctuations in qp (before curve compression).
2672 * - encoding: Set by user.
2673 * - decoding: unused
2675 attribute_deprecated float complexityblur;
2678 * in-loop deblocking filter alphac0 parameter
2679 * alpha is in the range -6...6
2680 * - encoding: Set by user.
2681 * - decoding: unused
2683 attribute_deprecated int deblockalpha;
2686 * in-loop deblocking filter beta parameter
2687 * beta is in the range -6...6
2688 * - encoding: Set by user.
2689 * - decoding: unused
2691 attribute_deprecated int deblockbeta;
2694 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2695 * - encoding: Set by user.
2696 * - decoding: unused
2698 attribute_deprecated int partitions;
2699 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2700 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2701 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2702 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2703 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2706 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2707 * - encoding: Set by user.
2708 * - decoding: unused
2710 attribute_deprecated int directpred;
2714 * Audio cutoff bandwidth (0 means "automatic")
2715 * - encoding: Set by user.
2716 * - decoding: unused
2721 * Multiplied by qscale for each frame and added to scene_change_score.
2722 * - encoding: Set by user.
2723 * - decoding: unused
2725 int scenechange_factor;
2729 * Note: Value depends upon the compare function used for fullpel ME.
2730 * - encoding: Set by user.
2731 * - decoding: unused
2736 * Adjusts sensitivity of b_frame_strategy 1.
2737 * - encoding: Set by user.
2738 * - decoding: unused
2743 * - encoding: Set by user.
2744 * - decoding: unused
2746 int compression_level;
2747 #define FF_COMPRESSION_DEFAULT -1
2750 * - encoding: Set by user.
2751 * - decoding: unused
2753 int min_prediction_order;
2756 * - encoding: Set by user.
2757 * - decoding: unused
2759 int max_prediction_order;
2761 #if FF_API_FLAC_GLOBAL_OPTS
2763 * @name FLAC options
2764 * @deprecated Use FLAC encoder private options instead.
2769 * LPC coefficient precision - used by FLAC encoder
2770 * - encoding: Set by user.
2771 * - decoding: unused
2773 attribute_deprecated int lpc_coeff_precision;
2776 * search method for selecting prediction order
2777 * - encoding: Set by user.
2778 * - decoding: unused
2780 attribute_deprecated int prediction_order_method;
2783 * - encoding: Set by user.
2784 * - decoding: unused
2786 attribute_deprecated int min_partition_order;
2789 * - encoding: Set by user.
2790 * - decoding: unused
2792 attribute_deprecated int max_partition_order;
2799 * GOP timecode frame start number
2800 * - encoding: Set by user, in non drop frame format
2801 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2803 int64_t timecode_frame_start;
2805 #if FF_API_REQUEST_CHANNELS
2807 * Decoder should decode to this many channels if it can (0 for default)
2808 * - encoding: unused
2809 * - decoding: Set by user.
2810 * @deprecated Deprecated in favor of request_channel_layout.
2812 int request_channels;
2815 #if FF_API_DRC_SCALE
2817 * Percentage of dynamic range compression to be applied by the decoder.
2818 * The default value is 1.0, corresponding to full compression.
2819 * - encoding: unused
2820 * - decoding: Set by user.
2821 * @deprecated use AC3 decoder private option instead.
2823 attribute_deprecated float drc_scale;
2827 * opaque 64bit number (generally a PTS) that will be reordered and
2828 * output in AVFrame.reordered_opaque
2829 * @deprecated in favor of pkt_pts
2830 * - encoding: unused
2831 * - decoding: Set by user.
2833 int64_t reordered_opaque;
2836 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2837 * - encoding: set by user.
2838 * - decoding: set by libavcodec.
2840 int bits_per_raw_sample;
2843 * Audio channel layout.
2844 * - encoding: set by user.
2845 * - decoding: set by user, may be overwritten by libavcodec.
2847 uint64_t channel_layout;
2850 * Request decoder to use this channel layout if it can (0 for default)
2851 * - encoding: unused
2852 * - decoding: Set by user.
2854 uint64_t request_channel_layout;
2857 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2858 * - encoding: Set by user.
2859 * - decoding: unused.
2861 float rc_max_available_vbv_use;
2864 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2865 * - encoding: Set by user.
2866 * - decoding: unused.
2868 float rc_min_vbv_overflow_use;
2871 * Hardware accelerator in use
2872 * - encoding: unused.
2873 * - decoding: Set by libavcodec
2875 struct AVHWAccel *hwaccel;
2878 * For some codecs, the time base is closer to the field rate than the frame rate.
2879 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2880 * if no telecine is used ...
2882 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2884 int ticks_per_frame;
2887 * Hardware accelerator context.
2888 * For some hardware accelerators, a global context needs to be
2889 * provided by the user. In that case, this holds display-dependent
2890 * data FFmpeg cannot instantiate itself. Please refer to the
2891 * FFmpeg HW accelerator documentation to know how to fill this
2892 * is. e.g. for VA API, this is a struct vaapi_context.
2893 * - encoding: unused
2894 * - decoding: Set by user
2896 void *hwaccel_context;
2899 * Chromaticity coordinates of the source primaries.
2900 * - encoding: Set by user
2901 * - decoding: Set by libavcodec
2903 enum AVColorPrimaries color_primaries;
2906 * Color Transfer Characteristic.
2907 * - encoding: Set by user
2908 * - decoding: Set by libavcodec
2910 enum AVColorTransferCharacteristic color_trc;
2913 * YUV colorspace type.
2914 * - encoding: Set by user
2915 * - decoding: Set by libavcodec
2917 enum AVColorSpace colorspace;
2920 * MPEG vs JPEG YUV range.
2921 * - encoding: Set by user
2922 * - decoding: Set by libavcodec
2924 enum AVColorRange color_range;
2927 * This defines the location of chroma samples.
2928 * - encoding: Set by user
2929 * - decoding: Set by libavcodec
2931 enum AVChromaLocation chroma_sample_location;
2934 * The codec may call this to execute several independent things.
2935 * It will return only after finishing all tasks.
2936 * The user may replace this with some multithreaded implementation,
2937 * the default implementation will execute the parts serially.
2938 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2939 * @param c context passed also to func
2940 * @param count the number of things to execute
2941 * @param arg2 argument passed unchanged to func
2942 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2943 * @param func function that will be called count times, with jobnr from 0 to count-1.
2944 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2945 * two instances of func executing at the same time will have the same threadnr.
2946 * @return always 0 currently, but code should handle a future improvement where when any call to func
2947 * returns < 0 no further calls to func may be done and < 0 is returned.
2948 * - encoding: Set by libavcodec, user can override.
2949 * - decoding: Set by libavcodec, user can override.
2951 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2953 #if FF_API_X264_GLOBAL_OPTS
2955 * explicit P-frame weighted prediction analysis method
2957 * 1: fast blind weighting (one reference duplicate with -1 offset)
2958 * 2: smart weighting (full fade detection analysis)
2959 * - encoding: Set by user.
2960 * - decoding: unused
2962 attribute_deprecated int weighted_p_pred;
2967 * 1: Variance AQ (complexity mask)
2968 * 2: Auto-variance AQ (experimental)
2969 * - encoding: Set by user
2970 * - decoding: unused
2972 attribute_deprecated int aq_mode;
2976 * Reduces blocking and blurring in flat and textured areas.
2977 * - encoding: Set by user
2978 * - decoding: unused
2980 attribute_deprecated float aq_strength;
2984 * Strength of psychovisual optimization
2985 * - encoding: Set by user
2986 * - decoding: unused
2988 attribute_deprecated float psy_rd;
2992 * Strength of psychovisual optimization
2993 * - encoding: Set by user
2994 * - decoding: unused
2996 attribute_deprecated float psy_trellis;
3000 * Number of frames for frametype and ratecontrol lookahead
3001 * - encoding: Set by user
3002 * - decoding: unused
3004 attribute_deprecated int rc_lookahead;
3007 * Constant rate factor maximum
3008 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
3009 * than crf_max, even if doing so would violate VBV restrictions.
3010 * - encoding: Set by user.
3011 * - decoding: unused
3013 attribute_deprecated float crf_max;
3016 int log_level_offset;
3018 #if FF_API_FLAC_GLOBAL_OPTS
3020 * Determines which LPC analysis algorithm to use.
3021 * - encoding: Set by user
3022 * - decoding: unused
3024 attribute_deprecated enum AVLPCType lpc_type;
3027 * Number of passes to use for Cholesky factorization during LPC analysis
3028 * - encoding: Set by user
3029 * - decoding: unused
3031 attribute_deprecated int lpc_passes;
3036 * Indicates number of picture subdivisions. Used for parallelized
3038 * - encoding: Set by user
3039 * - decoding: unused
3044 * Header containing style information for text subtitles.
3045 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3046 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3047 * the Format line following. It shouldn't include any Dialogue line.
3048 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3049 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3051 uint8_t *subtitle_header;
3052 int subtitle_header_size;
3055 * Current packet as passed into the decoder, to avoid having
3056 * to pass the packet into every function. Currently only valid
3057 * inside lavc and get/release_buffer callbacks.
3058 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3059 * - encoding: unused
3063 #if FF_API_INTERNAL_CONTEXT
3065 * Whether this is a copy of the context which had init() called on it.
3066 * This is used by multithreading - shared tables and picture pointers
3067 * should be freed from the original context only.
3068 * - encoding: Set by libavcodec.
3069 * - decoding: Set by libavcodec.
3071 * @deprecated this field has been moved to an internal context
3073 attribute_deprecated int is_copy;
3077 * Which multithreading methods to use.
3078 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3079 * so clients which cannot provide future frames should not use it.
3081 * - encoding: Set by user, otherwise the default is used.
3082 * - decoding: Set by user, otherwise the default is used.
3085 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3086 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3089 * Which multithreading methods are in use by the codec.
3090 * - encoding: Set by libavcodec.
3091 * - decoding: Set by libavcodec.
3093 int active_thread_type;
3096 * Set by the client if its custom get_buffer() callback can be called
3097 * from another thread, which allows faster multithreaded decoding.
3098 * draw_horiz_band() will be called from other threads regardless of this setting.
3099 * Ignored if the default get_buffer() is used.
3100 * - encoding: Set by user.
3101 * - decoding: Set by user.
3103 int thread_safe_callbacks;
3106 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3107 * Used for compliant TS muxing.
3108 * - encoding: Set by libavcodec.
3109 * - decoding: unused.
3114 * Type of service that the audio stream conveys.
3115 * - encoding: Set by user.
3116 * - decoding: Set by libavcodec.
3118 enum AVAudioServiceType audio_service_type;
3121 * desired sample format
3122 * - encoding: Not used.
3123 * - decoding: Set by user.
3124 * Decoder will decode to this format if it can.
3126 enum AVSampleFormat request_sample_fmt;
3129 * Error recognition; may misdetect some more or less valid parts as errors.
3130 * - encoding: unused
3131 * - decoding: Set by user.
3133 int err_recognition;
3134 #define AV_EF_CRCCHECK (1<<0)
3135 #define AV_EF_BITSTREAM (1<<1)
3136 #define AV_EF_BUFFER (1<<2)
3137 #define AV_EF_EXPLODE (1<<3)
3139 #define AV_EF_CAREFUL (1<<16)
3140 #define AV_EF_COMPLIANT (1<<17)
3141 #define AV_EF_AGGRESSIVE (1<<18)
3144 * Private context used for internal data.
3146 * Unlike priv_data, this is not codec-specific. It is used in general
3147 * libavcodec functions.
3149 struct AVCodecInternal *internal;
3152 * Current statistics for PTS correction.
3153 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3154 * - encoding: unused
3156 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3157 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3158 int64_t pts_correction_last_pts; /// PTS of the last frame
3159 int64_t pts_correction_last_dts; /// DTS of the last frame
3166 typedef struct AVProfile {
3168 const char *name; ///< short name for the profile
3171 typedef struct AVCodecDefault AVCodecDefault;
3176 typedef struct AVCodec {
3178 * Name of the codec implementation.
3179 * The name is globally unique among encoders and among decoders (but an
3180 * encoder and a decoder can share the same name).
3181 * This is the primary way to find a codec from the user perspective.
3184 enum AVMediaType type;
3187 int (*init)(AVCodecContext *);
3188 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3189 int (*close)(AVCodecContext *);
3190 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3192 * Codec capabilities.
3196 struct AVCodec *next;
3199 * Will be called when seeking
3201 void (*flush)(AVCodecContext *);
3202 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3203 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3205 * Descriptive name for the codec, meant to be more human readable than name.
3206 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3208 const char *long_name;
3209 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3210 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3211 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3212 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3213 const AVClass *priv_class; ///< AVClass for the private context
3214 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3217 * @name Frame-level threading support functions
3221 * If defined, called on thread contexts when they are created.
3222 * If the codec allocates writable tables in init(), re-allocate them here.
3223 * priv_data will be set to a copy of the original.
3225 int (*init_thread_copy)(AVCodecContext *);
3227 * Copy necessary context variables from a previous thread context to the current one.
3228 * If not defined, the next thread will start automatically; otherwise, the codec
3229 * must call ff_thread_finish_setup().
3231 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3233 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3237 * Private codec-specific defaults.
3239 const AVCodecDefault *defaults;
3242 * Initialize codec static data, called from avcodec_register().
3244 void (*init_static_data)(struct AVCodec *codec);
3250 typedef struct AVHWAccel {
3252 * Name of the hardware accelerated codec.
3253 * The name is globally unique among encoders and among decoders (but an
3254 * encoder and a decoder can share the same name).
3259 * Type of codec implemented by the hardware accelerator.
3261 * See AVMEDIA_TYPE_xxx
3263 enum AVMediaType type;
3266 * Codec implemented by the hardware accelerator.
3273 * Supported pixel format.
3275 * Only hardware accelerated formats are supported here.
3277 enum PixelFormat pix_fmt;
3280 * Hardware accelerated codec capabilities.
3281 * see FF_HWACCEL_CODEC_CAP_*
3285 struct AVHWAccel *next;
3288 * Called at the beginning of each frame or field picture.
3290 * Meaningful frame information (codec specific) is guaranteed to
3291 * be parsed at this point. This function is mandatory.
3293 * Note that buf can be NULL along with buf_size set to 0.
3294 * Otherwise, this means the whole frame is available at this point.
3296 * @param avctx the codec context
3297 * @param buf the frame data buffer base
3298 * @param buf_size the size of the frame in bytes
3299 * @return zero if successful, a negative value otherwise
3301 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3304 * Callback for each slice.
3306 * Meaningful slice information (codec specific) is guaranteed to
3307 * be parsed at this point. This function is mandatory.
3309 * @param avctx the codec context
3310 * @param buf the slice data buffer base
3311 * @param buf_size the size of the slice in bytes
3312 * @return zero if successful, a negative value otherwise
3314 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3317 * Called at the end of each frame or field picture.
3319 * The whole picture is parsed at this point and can now be sent
3320 * to the hardware accelerator. This function is mandatory.
3322 * @param avctx the codec context
3323 * @return zero if successful, a negative value otherwise
3325 int (*end_frame)(AVCodecContext *avctx);
3328 * Size of HW accelerator private data.
3330 * Private data is allocated with av_mallocz() before
3331 * AVCodecContext.get_buffer() and deallocated after
3332 * AVCodecContext.release_buffer().
3338 * four components are given, that's all.
3339 * the last component is alpha
3341 typedef struct AVPicture {
3342 uint8_t *data[AV_NUM_DATA_POINTERS];
3343 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3346 #define AVPALETTE_SIZE 1024
3347 #define AVPALETTE_COUNT 256
3348 #if FF_API_PALETTE_CONTROL
3351 * This structure defines a method for communicating palette changes
3352 * between and demuxer and a decoder.
3354 * @deprecated Use AVPacket to send palette changes instead.
3355 * This is totally broken.
3357 typedef struct AVPaletteControl {
3359 /* Demuxer sets this to 1 to indicate the palette has changed;
3360 * decoder resets to 0. */
3361 int palette_changed;
3363 /* 4-byte ARGB palette entries, stored in native byte order; note that
3364 * the individual palette components should be on a 8-bit scale; if
3365 * the palette data comes from an IBM VGA native format, the component
3366 * data is probably 6 bits in size and needs to be scaled. */
3367 unsigned int palette[AVPALETTE_COUNT];
3369 } AVPaletteControl attribute_deprecated;
3372 enum AVSubtitleType {
3375 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3378 * Plain text, the text field must be set by the decoder and is
3379 * authoritative. ass and pict fields may contain approximations.
3384 * Formatted text, the ass field must be set by the decoder and is
3385 * authoritative. pict and text fields may contain approximations.
3390 typedef struct AVSubtitleRect {
3391 int x; ///< top left corner of pict, undefined when pict is not set
3392 int y; ///< top left corner of pict, undefined when pict is not set
3393 int w; ///< width of pict, undefined when pict is not set
3394 int h; ///< height of pict, undefined when pict is not set
3395 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3398 * data+linesize for the bitmap of this subtitle.
3399 * can be set for text/ass as well once they where rendered
3402 enum AVSubtitleType type;
3404 char *text; ///< 0 terminated plain UTF-8 text
3407 * 0 terminated ASS/SSA compatible event line.
3408 * The pressentation of this is unaffected by the other values in this
3414 typedef struct AVSubtitle {
3415 uint16_t format; /* 0 = graphics */
3416 uint32_t start_display_time; /* relative to packet pts, in ms */
3417 uint32_t end_display_time; /* relative to packet pts, in ms */
3419 AVSubtitleRect **rects;
3420 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3423 /* packet functions */
3426 * @deprecated use NULL instead
3428 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3431 * Default packet destructor.
3433 void av_destruct_packet(AVPacket *pkt);
3436 * Initialize optional fields of a packet with default values.
3440 void av_init_packet(AVPacket *pkt);
3443 * Allocate the payload of a packet and initialize its fields with
3447 * @param size wanted payload size
3448 * @return 0 if OK, AVERROR_xxx otherwise
3450 int av_new_packet(AVPacket *pkt, int size);
3453 * Reduce packet size, correctly zeroing padding
3456 * @param size new size
3458 void av_shrink_packet(AVPacket *pkt, int size);
3461 * Increase packet size, correctly zeroing padding
3464 * @param grow_by number of bytes by which to increase the size of the packet
3466 int av_grow_packet(AVPacket *pkt, int grow_by);
3469 * @warning This is a hack - the packet memory allocation stuff is broken. The
3470 * packet is allocated if it was not really allocated.
3472 int av_dup_packet(AVPacket *pkt);
3477 * @param pkt packet to free
3479 void av_free_packet(AVPacket *pkt);
3482 * Allocate new information of a packet.
3485 * @param type side information type
3486 * @param size side information size
3487 * @return pointer to fresh allocated data or NULL otherwise
3489 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3493 * Get side information from packet.
3496 * @param type desired side information type
3497 * @param size pointer for side information size to store (optional)
3498 * @return pointer to data if present or NULL otherwise
3500 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3503 int av_packet_merge_side_data(AVPacket *pkt);
3505 int av_packet_split_side_data(AVPacket *pkt);
3510 struct ReSampleContext;
3511 struct AVResampleContext;
3513 typedef struct ReSampleContext ReSampleContext;
3516 * Initialize audio resampling context.
3518 * @param output_channels number of output channels
3519 * @param input_channels number of input channels
3520 * @param output_rate output sample rate
3521 * @param input_rate input sample rate
3522 * @param sample_fmt_out requested output sample format
3523 * @param sample_fmt_in input sample format
3524 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3525 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3526 * @param linear if 1 then the used FIR filter will be linearly interpolated
3527 between the 2 closest, if 0 the closest will be used
3528 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3529 * @return allocated ReSampleContext, NULL if error occured
3531 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3532 int output_rate, int input_rate,
3533 enum AVSampleFormat sample_fmt_out,
3534 enum AVSampleFormat sample_fmt_in,
3535 int filter_length, int log2_phase_count,
3536 int linear, double cutoff);
3538 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3541 * Free resample context.
3543 * @param s a non-NULL pointer to a resample context previously
3544 * created with av_audio_resample_init()
3546 void audio_resample_close(ReSampleContext *s);
3550 * Initialize an audio resampler.
3551 * Note, if either rate is not an integer then simply scale both rates up so they are.
3552 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3553 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3554 * @param linear If 1 then the used FIR filter will be linearly interpolated
3555 between the 2 closest, if 0 the closest will be used
3556 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3558 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3561 * Resample an array of samples using a previously configured context.
3562 * @param src an array of unconsumed samples
3563 * @param consumed the number of samples of src which have been consumed are returned here
3564 * @param src_size the number of unconsumed samples available
3565 * @param dst_size the amount of space in samples available in dst
3566 * @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.
3567 * @return the number of samples written in dst or -1 if an error occurred
3569 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3573 * Compensate samplerate/timestamp drift. The compensation is done by changing
3574 * the resampler parameters, so no audible clicks or similar distortions occur
3575 * @param compensation_distance distance in output samples over which the compensation should be performed
3576 * @param sample_delta number of output samples which should be output less
3578 * example: av_resample_compensate(c, 10, 500)
3579 * here instead of 510 samples only 500 samples would be output
3581 * note, due to rounding the actual compensation might be slightly different,
3582 * especially if the compensation_distance is large and the in_rate used during init is small
3584 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3585 void av_resample_close(struct AVResampleContext *c);
3588 * Allocate memory for a picture. Call avpicture_free() to free it.
3590 * @see avpicture_fill()
3592 * @param picture the picture to be filled in
3593 * @param pix_fmt the format of the picture
3594 * @param width the width of the picture
3595 * @param height the height of the picture
3596 * @return zero if successful, a negative value if not
3598 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3601 * Free a picture previously allocated by avpicture_alloc().
3602 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3605 * @param picture the AVPicture to be freed
3607 void avpicture_free(AVPicture *picture);
3610 * Fill in the AVPicture fields.
3611 * The fields of the given AVPicture are filled in by using the 'ptr' address
3612 * which points to the image data buffer. Depending on the specified picture
3613 * format, one or multiple image data pointers and line sizes will be set.
3614 * If a planar format is specified, several pointers will be set pointing to
3615 * the different picture planes and the line sizes of the different planes
3616 * will be stored in the lines_sizes array.
3617 * Call with ptr == NULL to get the required size for the ptr buffer.
3619 * To allocate the buffer and fill in the AVPicture fields in one call,
3620 * use avpicture_alloc().
3622 * @param picture AVPicture whose fields are to be filled in
3623 * @param ptr Buffer which will contain or contains the actual image data
3624 * @param pix_fmt The format in which the picture data is stored.
3625 * @param width the width of the image in pixels
3626 * @param height the height of the image in pixels
3627 * @return size of the image data in bytes
3629 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3630 enum PixelFormat pix_fmt, int width, int height);
3633 * Copy pixel data from an AVPicture into a buffer.
3634 * The data is stored compactly, without any gaps for alignment or padding
3635 * which may be applied by avpicture_fill().
3637 * @see avpicture_get_size()
3639 * @param[in] src AVPicture containing image data
3640 * @param[in] pix_fmt The format in which the picture data is stored.
3641 * @param[in] width the width of the image in pixels.
3642 * @param[in] height the height of the image in pixels.
3643 * @param[out] dest A buffer into which picture data will be copied.
3644 * @param[in] dest_size The size of 'dest'.
3645 * @return The number of bytes written to dest, or a negative value (error code) on error.
3647 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3648 unsigned char *dest, int dest_size);
3651 * Calculate the size in bytes that a picture of the given width and height
3652 * would occupy if stored in the given picture format.
3653 * Note that this returns the size of a compact representation as generated
3654 * by avpicture_layout(), which can be smaller than the size required for e.g.
3657 * @param pix_fmt the given picture format
3658 * @param width the width of the image
3659 * @param height the height of the image
3660 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3662 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3663 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3666 * Get the name of a codec.
3667 * @return a static string identifying the codec; never NULL
3669 const char *avcodec_get_name(enum CodecID id);
3671 #if FF_API_GET_PIX_FMT_NAME
3673 * Return the short name for a pixel format.
3675 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3676 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3678 attribute_deprecated
3679 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3682 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3685 * Return a value representing the fourCC code associated to the
3686 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3689 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3692 * Put a string representing the codec tag codec_tag in buf.
3694 * @param buf_size size in bytes of buf
3695 * @return the length of the string that would have been generated if
3696 * enough space had been available, excluding the trailing null
3698 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3700 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3701 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3702 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3703 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3704 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3705 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3708 * Compute what kind of losses will occur when converting from one specific
3709 * pixel format to another.
3710 * When converting from one pixel format to another, information loss may occur.
3711 * For example, when converting from RGB24 to GRAY, the color information will
3712 * be lost. Similarly, other losses occur when converting from some formats to
3713 * other formats. These losses can involve loss of chroma, but also loss of
3714 * resolution, loss of color depth, loss due to the color space conversion, loss
3715 * of the alpha bits or loss due to color quantization.
3716 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3717 * which will occur when converting from one pixel format to another.
3719 * @param[in] dst_pix_fmt destination pixel format
3720 * @param[in] src_pix_fmt source pixel format
3721 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3722 * @return Combination of flags informing you what kind of losses will occur
3723 * (maximum loss for an invalid dst_pix_fmt).
3725 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3729 * Find the best pixel format to convert to given a certain source pixel
3730 * format. When converting from one pixel format to another, information loss
3731 * may occur. For example, when converting from RGB24 to GRAY, the color
3732 * information will be lost. Similarly, other losses occur when converting from
3733 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3734 * the given pixel formats should be used to suffer the least amount of loss.
3735 * The pixel formats from which it chooses one, are determined by the
3736 * pix_fmt_mask parameter.
3738 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3741 * src_pix_fmt = PIX_FMT_YUV420P;
3742 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3743 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3746 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3747 * @param[in] src_pix_fmt source pixel format
3748 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3749 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3750 * @return The best pixel format to convert to or -1 if none was found.
3752 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3753 int has_alpha, int *loss_ptr);
3756 * Find the best pixel format to convert to given a certain source pixel
3757 * format and a selection of two destination pixel formats. When converting from
3758 * one pixel format to another, information loss may occur. For example, when converting
3759 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3760 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3761 * the given pixel formats should be used to suffer the least amount of loss.
3763 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3767 * src_pix_fmt = PIX_FMT_YUV420P;
3768 * dst_pix_fmt1= PIX_FMT_RGB24;
3769 * dst_pix_fmt2= PIX_FMT_GRAY8;
3770 * dst_pix_fmt3= PIX_FMT_RGB8;
3771 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3772 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3773 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3776 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3777 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3778 * @param[in] src_pix_fmt Source pixel format
3779 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3780 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3781 * NULL or value of zero means we care about all losses. Out: the loss
3782 * that occurs when converting from src to selected dst pixel format.
3783 * @return The best pixel format to convert to or -1 if none was found.
3785 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3786 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3788 #if FF_API_GET_ALPHA_INFO
3789 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3790 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3793 * Tell if an image really has transparent alpha values.
3794 * @return ored mask of FF_ALPHA_xxx constants
3796 attribute_deprecated
3797 int img_get_alpha_info(const AVPicture *src,
3798 enum PixelFormat pix_fmt, int width, int height);
3801 /* deinterlace a picture */
3802 /* deinterlace - if not supported return -1 */
3803 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3804 enum PixelFormat pix_fmt, int width, int height);
3806 /* external high level API */
3809 * If c is NULL, returns the first registered codec,
3810 * if c is non-NULL, returns the next registered codec after c,
3811 * or NULL if c is the last one.
3813 AVCodec *av_codec_next(AVCodec *c);
3816 * Return the LIBAVCODEC_VERSION_INT constant.
3818 unsigned avcodec_version(void);
3821 * Return the libavcodec build-time configuration.
3823 const char *avcodec_configuration(void);
3826 * Return the libavcodec license.
3828 const char *avcodec_license(void);
3830 #if FF_API_AVCODEC_INIT
3832 * @deprecated this function is called automatically from avcodec_register()
3833 * and avcodec_register_all(), there is no need to call it manually
3835 attribute_deprecated
3836 void avcodec_init(void);
3840 * Register the codec codec and initialize libavcodec.
3842 * @warning either this function or avcodec_register_all() must be called
3843 * before any other libavcodec functions.
3845 * @see avcodec_register_all()
3847 void avcodec_register(AVCodec *codec);
3850 * Find a registered encoder with a matching codec ID.
3852 * @param id CodecID of the requested encoder
3853 * @return An encoder if one was found, NULL otherwise.
3855 AVCodec *avcodec_find_encoder(enum CodecID id);
3858 * Find a registered encoder with the specified name.
3860 * @param name name of the requested encoder
3861 * @return An encoder if one was found, NULL otherwise.
3863 AVCodec *avcodec_find_encoder_by_name(const char *name);
3866 * Find a registered decoder with a matching codec ID.
3868 * @param id CodecID of the requested decoder
3869 * @return A decoder if one was found, NULL otherwise.
3871 AVCodec *avcodec_find_decoder(enum CodecID id);
3874 * Find a registered decoder with the specified name.
3876 * @param name name of the requested decoder
3877 * @return A decoder if one was found, NULL otherwise.
3879 AVCodec *avcodec_find_decoder_by_name(const char *name);
3880 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3883 * Return a name for the specified profile, if available.
3885 * @param codec the codec that is searched for the given profile
3886 * @param profile the profile value for which a name is requested
3887 * @return A name for the profile if found, NULL otherwise.
3889 const char *av_get_profile_name(const AVCodec *codec, int profile);
3891 #if FF_API_ALLOC_CONTEXT
3893 * Set the fields of the given AVCodecContext to default values.
3895 * @param s The AVCodecContext of which the fields should be set to default values.
3896 * @deprecated use avcodec_get_context_defaults3
3898 attribute_deprecated
3899 void avcodec_get_context_defaults(AVCodecContext *s);
3901 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3902 * we WILL change its arguments and name a few times! */
3903 attribute_deprecated
3904 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3908 * Set the fields of the given AVCodecContext to default values corresponding
3909 * to the given codec (defaults may be codec-dependent).
3911 * Do not call this function if a non-NULL codec has been passed
3912 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3913 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3914 * different codec on this AVCodecContext.
3916 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3918 #if FF_API_ALLOC_CONTEXT
3920 * Allocate an AVCodecContext and set its fields to default values. The
3921 * resulting struct can be deallocated by simply calling av_free().
3923 * @return An AVCodecContext filled with default values or NULL on failure.
3924 * @see avcodec_get_context_defaults
3926 * @deprecated use avcodec_alloc_context3()
3928 attribute_deprecated
3929 AVCodecContext *avcodec_alloc_context(void);
3931 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3932 * we WILL change its arguments and name a few times! */
3933 attribute_deprecated
3934 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3938 * Allocate an AVCodecContext and set its fields to default values. The
3939 * resulting struct can be deallocated by simply calling av_free().
3941 * @param codec if non-NULL, allocate private data and initialize defaults
3942 * for the given codec. It is illegal to then call avcodec_open2()
3943 * with a different codec.
3945 * @return An AVCodecContext filled with default values or NULL on failure.
3946 * @see avcodec_get_context_defaults
3948 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3951 * Copy the settings of the source AVCodecContext into the destination
3952 * AVCodecContext. The resulting destination codec context will be
3953 * unopened, i.e. you are required to call avcodec_open2() before you
3954 * can use this AVCodecContext to decode/encode video/audio data.
3956 * @param dest target codec context, should be initialized with
3957 * avcodec_alloc_context3(), but otherwise uninitialized
3958 * @param src source codec context
3959 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3961 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3964 * Set the fields of the given AVFrame to default values.
3966 * @param pic The AVFrame of which the fields should be set to default values.
3968 void avcodec_get_frame_defaults(AVFrame *pic);
3971 * Allocate an AVFrame and set its fields to default values. The resulting
3972 * struct can be deallocated by simply calling av_free().
3974 * @return An AVFrame filled with default values or NULL on failure.
3975 * @see avcodec_get_frame_defaults
3977 AVFrame *avcodec_alloc_frame(void);
3979 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3980 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3981 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3984 * Return the amount of padding in pixels which the get_buffer callback must
3985 * provide around the edge of the image for codecs which do not have the
3986 * CODEC_FLAG_EMU_EDGE flag.
3988 * @return Required padding in pixels.
3990 unsigned avcodec_get_edge_width(void);
3992 * Modify width and height values so that they will result in a memory
3993 * buffer that is acceptable for the codec if you do not use any horizontal
3996 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3997 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3998 * according to avcodec_get_edge_width() before.
4000 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4002 * Modify width and height values so that they will result in a memory
4003 * buffer that is acceptable for the codec if you also ensure that all
4004 * line sizes are a multiple of the respective linesize_align[i].
4006 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4007 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4008 * according to avcodec_get_edge_width() before.
4010 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4011 int linesize_align[AV_NUM_DATA_POINTERS]);
4013 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4015 #if FF_API_THREAD_INIT
4017 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
4019 attribute_deprecated
4020 int avcodec_thread_init(AVCodecContext *s, int thread_count);
4023 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4024 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4025 //FIXME func typedef
4027 #if FF_API_AVCODEC_OPEN
4029 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4030 * function the context has to be allocated.
4032 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4033 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4034 * retrieving a codec.
4036 * @warning This function is not thread safe!
4039 * avcodec_register_all();
4040 * codec = avcodec_find_decoder(CODEC_ID_H264);
4044 * context = avcodec_alloc_context3(codec);
4046 * if (avcodec_open(context, codec) < 0)
4050 * @param avctx The context which will be set up to use the given codec.
4051 * @param codec The codec to use within the context.
4052 * @return zero on success, a negative value on error
4053 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
4055 * @deprecated use avcodec_open2
4057 attribute_deprecated
4058 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
4062 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4063 * function the context has to be allocated with avcodec_alloc_context3().
4065 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4066 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4067 * retrieving a codec.
4069 * @warning This function is not thread safe!
4072 * avcodec_register_all();
4073 * av_dict_set(&opts, "b", "2.5M", 0);
4074 * codec = avcodec_find_decoder(CODEC_ID_H264);
4078 * context = avcodec_alloc_context3(codec);
4080 * if (avcodec_open2(context, codec, opts) < 0)
4084 * @param avctx The context to initialize.
4085 * @param options A dictionary filled with AVCodecContext and codec-private options.
4086 * On return this object will be filled with options that were not found.
4088 * @return zero on success, a negative value on error
4089 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4090 * av_dict_set(), av_opt_find().
4092 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
4094 #if FF_API_OLD_DECODE_AUDIO
4096 * Wrapper function which calls avcodec_decode_audio4.
4098 * @deprecated Use avcodec_decode_audio4 instead.
4100 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4101 * Some decoders may support multiple frames in a single AVPacket, such
4102 * decoders would then just decode the first frame. In this case,
4103 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4104 * the remaining data in order to decode the second frame etc.
4106 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4107 * decompressed frame size in bytes.
4109 * @warning You must set frame_size_ptr to the allocated size of the
4110 * output buffer before calling avcodec_decode_audio3().
4112 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4113 * the actual read bytes because some optimized bitstream readers read 32 or 64
4114 * bits at once and could read over the end.
4116 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4117 * no overreading happens for damaged MPEG streams.
4119 * @note You might have to align the input buffer avpkt->data and output buffer
4120 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4121 * necessary at all, on others it won't work at all if not aligned and on others
4122 * it will work but it will have an impact on performance.
4124 * In practice, avpkt->data should have 4 byte alignment at minimum and
4125 * samples should be 16 byte aligned unless the CPU doesn't need it
4126 * (AltiVec and SSE do).
4128 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4129 * between input and output, these need to be fed with avpkt->data=NULL,
4130 * avpkt->size=0 at the end to return the remaining frames.
4132 * @param avctx the codec context
4133 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4134 * If the sample format is planar, each channel plane will
4135 * be the same size, with no padding between channels.
4136 * @param[in,out] frame_size_ptr the output buffer size in bytes
4137 * @param[in] avpkt The input AVPacket containing the input buffer.
4138 * You can create such packet with av_init_packet() and by then setting
4139 * data and size, some decoders might in addition need other fields.
4140 * All decoders are designed to use the least fields possible though.
4141 * @return On error a negative value is returned, otherwise the number of bytes
4142 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4144 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4145 int *frame_size_ptr,
4150 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4152 * Some decoders may support multiple frames in a single AVPacket. Such
4153 * decoders would then just decode the first frame. In this case,
4154 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4155 * the remaining data in order to decode the second frame, etc...
4156 * Even if no frames are returned, the packet needs to be fed to the decoder
4157 * with remaining data until it is completely consumed or an error occurs.
4159 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4160 * larger than the actual read bytes because some optimized bitstream
4161 * readers read 32 or 64 bits at once and could read over the end.
4163 * @note You might have to align the input buffer. The alignment requirements
4164 * depend on the CPU and the decoder.
4166 * @param avctx the codec context
4167 * @param[out] frame The AVFrame in which to store decoded audio samples.
4168 * Decoders request a buffer of a particular size by setting
4169 * AVFrame.nb_samples prior to calling get_buffer(). The
4170 * decoder may, however, only utilize part of the buffer by
4171 * setting AVFrame.nb_samples to a smaller value in the
4173 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4175 * @param[in] avpkt The input AVPacket containing the input buffer.
4176 * At least avpkt->data and avpkt->size should be set. Some
4177 * decoders might also require additional fields to be set.
4178 * @return A negative error code is returned if an error occurred during
4179 * decoding, otherwise the number of bytes consumed from the input
4180 * AVPacket is returned.
4182 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4183 int *got_frame_ptr, AVPacket *avpkt);
4186 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4187 * Some decoders may support multiple frames in a single AVPacket, such
4188 * decoders would then just decode the first frame.
4190 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4191 * the actual read bytes because some optimized bitstream readers read 32 or 64
4192 * bits at once and could read over the end.
4194 * @warning The end of the input buffer buf should be set to 0 to ensure that
4195 * no overreading happens for damaged MPEG streams.
4197 * @note You might have to align the input buffer avpkt->data.
4198 * The alignment requirements depend on the CPU: on some CPUs it isn't
4199 * necessary at all, on others it won't work at all if not aligned and on others
4200 * it will work but it will have an impact on performance.
4202 * In practice, avpkt->data should have 4 byte alignment at minimum.
4204 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4205 * between input and output, these need to be fed with avpkt->data=NULL,
4206 * avpkt->size=0 at the end to return the remaining frames.
4208 * @param avctx the codec context
4209 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4210 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4211 * allocate memory for the actual bitmap.
4212 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4213 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4214 * decodes and the decoder tells the user once it does not need the data anymore,
4215 * the user app can at this point free/reuse/keep the memory as it sees fit.
4217 * @param[in] avpkt The input AVpacket containing the input buffer.
4218 * You can create such packet with av_init_packet() and by then setting
4219 * data and size, some decoders might in addition need other fields like
4220 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4222 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4223 * @return On error a negative value is returned, otherwise the number of bytes
4224 * used or zero if no frame could be decompressed.
4226 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4227 int *got_picture_ptr,
4231 * Decode a subtitle message.
4232 * Return a negative value on error, otherwise return the number of bytes used.
4233 * If no subtitle could be decompressed, got_sub_ptr is zero.
4234 * Otherwise, the subtitle is stored in *sub.
4235 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4236 * simplicity, because the performance difference is expect to be negligible
4237 * and reusing a get_buffer written for video codecs would probably perform badly
4238 * due to a potentially very different allocation pattern.
4240 * @param avctx the codec context
4241 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4242 freed with avsubtitle_free if *got_sub_ptr is set.
4243 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4244 * @param[in] avpkt The input AVPacket containing the input buffer.
4246 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4251 * Frees all allocated data in the given subtitle struct.
4253 * @param sub AVSubtitle to free.
4255 void avsubtitle_free(AVSubtitle *sub);
4258 * Encode an audio frame from samples into buf.
4260 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4261 * However, for PCM audio the user will know how much space is needed
4262 * because it depends on the value passed in buf_size as described
4263 * below. In that case a lower value can be used.
4265 * @param avctx the codec context
4266 * @param[out] buf the output buffer
4267 * @param[in] buf_size the output buffer size
4268 * @param[in] samples the input buffer containing the samples
4269 * The number of samples read from this buffer is frame_size*channels,
4270 * both of which are defined in avctx.
4271 * For PCM audio the number of samples read from samples is equal to
4272 * buf_size * input_sample_size / output_sample_size.
4273 * @return On error a negative value is returned, on success zero or the number
4274 * of bytes used to encode the data read from the input buffer.
4276 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4277 const short *samples);
4280 * Encode a video frame from pict into buf.
4281 * The input picture should be
4282 * stored using a specific format, namely avctx.pix_fmt.
4284 * @param avctx the codec context
4285 * @param[out] buf the output buffer for the bitstream of encoded frame
4286 * @param[in] buf_size the size of the output buffer in bytes
4287 * @param[in] pict the input picture to encode
4288 * @return On error a negative value is returned, on success zero or the number
4289 * of bytes used from the output buffer.
4291 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4292 const AVFrame *pict);
4293 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4294 const AVSubtitle *sub);
4296 int avcodec_close(AVCodecContext *avctx);
4299 * Register all the codecs, parsers and bitstream filters which were enabled at
4300 * configuration time. If you do not call this function you can select exactly
4301 * which formats you want to support, by using the individual registration
4304 * @see avcodec_register
4305 * @see av_register_codec_parser
4306 * @see av_register_bitstream_filter
4308 void avcodec_register_all(void);
4311 * Flush buffers, should be called when seeking or when switching to a different stream.
4313 void avcodec_flush_buffers(AVCodecContext *avctx);
4315 void avcodec_default_free_buffers(AVCodecContext *s);
4317 /* misc useful functions */
4319 #if FF_API_OLD_FF_PICT_TYPES
4321 * Return a single letter to describe the given picture type pict_type.
4323 * @param[in] pict_type the picture type
4324 * @return A single character representing the picture type.
4325 * @deprecated Use av_get_picture_type_char() instead.
4327 attribute_deprecated
4328 char av_get_pict_type_char(int pict_type);
4332 * Return codec bits per sample.
4334 * @param[in] codec_id the codec
4335 * @return Number of bits per sample or zero if unknown for the given codec.
4337 int av_get_bits_per_sample(enum CodecID codec_id);
4339 #if FF_API_OLD_SAMPLE_FMT
4341 * @deprecated Use av_get_bytes_per_sample() instead.
4343 attribute_deprecated
4344 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4348 typedef struct AVCodecParserContext {
4350 struct AVCodecParser *parser;
4351 int64_t frame_offset; /* offset of the current frame */
4352 int64_t cur_offset; /* current offset
4353 (incremented by each av_parser_parse()) */
4354 int64_t next_frame_offset; /* offset of the next frame */
4356 int pict_type; /* XXX: Put it back in AVCodecContext. */
4358 * This field is used for proper frame duration computation in lavf.
4359 * It signals, how much longer the frame duration of the current frame
4360 * is compared to normal frame duration.
4362 * frame_duration = (1 + repeat_pict) * time_base
4364 * It is used by codecs like H.264 to display telecined material.
4366 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4367 int64_t pts; /* pts of the current frame */
4368 int64_t dts; /* dts of the current frame */
4373 int fetch_timestamp;
4375 #define AV_PARSER_PTS_NB 4
4376 int cur_frame_start_index;
4377 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4378 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4379 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4382 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4383 #define PARSER_FLAG_ONCE 0x0002
4384 /// Set if the parser has a valid file offset
4385 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4387 int64_t offset; ///< byte offset from starting packet start
4388 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4391 * Set by parser to 1 for key frames and 0 for non-key frames.
4392 * It is initialized to -1, so if the parser doesn't set this flag,
4393 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4399 * Time difference in stream time base units from the pts of this
4400 * packet to the point at which the output from the decoder has converged
4401 * independent from the availability of previous frames. That is, the
4402 * frames are virtually identical no matter if decoding started from
4403 * the very first frame or from this keyframe.
4404 * Is AV_NOPTS_VALUE if unknown.
4405 * This field is not the display duration of the current frame.
4406 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4409 * The purpose of this field is to allow seeking in streams that have no
4410 * keyframes in the conventional sense. It corresponds to the
4411 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4412 * essential for some types of subtitle streams to ensure that all
4413 * subtitles are correctly displayed after seeking.
4415 int64_t convergence_duration;
4417 // Timestamp generation support:
4419 * Synchronization point for start of timestamp generation.
4421 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4424 * For example, this corresponds to presence of H.264 buffering period
4430 * Offset of the current timestamp against last timestamp sync point in
4431 * units of AVCodecContext.time_base.
4433 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4434 * contain a valid timestamp offset.
4436 * Note that the timestamp of sync point has usually a nonzero
4437 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4438 * the next frame after timestamp sync point will be usually 1.
4440 * For example, this corresponds to H.264 cpb_removal_delay.
4442 int dts_ref_dts_delta;
4445 * Presentation delay of current frame in units of AVCodecContext.time_base.
4447 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4448 * contain valid non-negative timestamp delta (presentation time of a frame
4449 * must not lie in the past).
4451 * This delay represents the difference between decoding and presentation
4452 * time of the frame.
4454 * For example, this corresponds to H.264 dpb_output_delay.
4459 * Position of the packet in file.
4461 * Analogous to cur_frame_pts/dts
4463 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4466 * Byte position of currently parsed frame in stream.
4471 * Previous frame byte position.
4474 } AVCodecParserContext;
4476 typedef struct AVCodecParser {
4477 int codec_ids[5]; /* several codec IDs are permitted */
4479 int (*parser_init)(AVCodecParserContext *s);
4480 int (*parser_parse)(AVCodecParserContext *s,
4481 AVCodecContext *avctx,
4482 const uint8_t **poutbuf, int *poutbuf_size,
4483 const uint8_t *buf, int buf_size);
4484 void (*parser_close)(AVCodecParserContext *s);
4485 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4486 struct AVCodecParser *next;
4489 AVCodecParser *av_parser_next(AVCodecParser *c);
4491 void av_register_codec_parser(AVCodecParser *parser);
4492 AVCodecParserContext *av_parser_init(int codec_id);
4497 * @param s parser context.
4498 * @param avctx codec context.
4499 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4500 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4501 * @param buf input buffer.
4502 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4503 * @param pts input presentation timestamp.
4504 * @param dts input decoding timestamp.
4505 * @param pos input byte position in stream.
4506 * @return the number of bytes of the input bitstream used.
4511 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4518 * decode_frame(data, size);
4522 int av_parser_parse2(AVCodecParserContext *s,
4523 AVCodecContext *avctx,
4524 uint8_t **poutbuf, int *poutbuf_size,
4525 const uint8_t *buf, int buf_size,
4526 int64_t pts, int64_t dts,
4529 int av_parser_change(AVCodecParserContext *s,
4530 AVCodecContext *avctx,
4531 uint8_t **poutbuf, int *poutbuf_size,
4532 const uint8_t *buf, int buf_size, int keyframe);
4533 void av_parser_close(AVCodecParserContext *s);
4536 typedef struct AVBitStreamFilterContext {
4538 struct AVBitStreamFilter *filter;
4539 AVCodecParserContext *parser;
4540 struct AVBitStreamFilterContext *next;
4541 } AVBitStreamFilterContext;
4544 typedef struct AVBitStreamFilter {
4547 int (*filter)(AVBitStreamFilterContext *bsfc,
4548 AVCodecContext *avctx, const char *args,
4549 uint8_t **poutbuf, int *poutbuf_size,
4550 const uint8_t *buf, int buf_size, int keyframe);
4551 void (*close)(AVBitStreamFilterContext *bsfc);
4552 struct AVBitStreamFilter *next;
4553 } AVBitStreamFilter;
4555 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4556 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4557 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4558 AVCodecContext *avctx, const char *args,
4559 uint8_t **poutbuf, int *poutbuf_size,
4560 const uint8_t *buf, int buf_size, int keyframe);
4561 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4563 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4568 * Reallocate the given block if it is not large enough, otherwise do nothing.
4572 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4575 * Allocate a buffer, reusing the given one if large enough.
4577 * Contrary to av_fast_realloc the current buffer contents might not be
4578 * preserved and on error the old buffer is freed, thus no special
4579 * handling to avoid memleaks is necessary.
4581 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4582 * @param size size of the buffer *ptr points to
4583 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4584 * *size 0 if an error occurred.
4586 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4589 * Copy image src to dst. Wraps av_picture_data_copy() above.
4591 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4592 enum PixelFormat pix_fmt, int width, int height);
4595 * Crop image top and left side.
4597 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4598 enum PixelFormat pix_fmt, int top_band, int left_band);
4603 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4604 int padtop, int padbottom, int padleft, int padright, int *color);
4607 * Encode extradata length to a buffer. Used by xiph codecs.
4609 * @param s buffer to write to; must be at least (v/255+1) bytes long
4610 * @param v size of extradata in bytes
4611 * @return number of bytes written to the buffer.
4613 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4616 * Logs a generic warning message about a missing feature. This function is
4617 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4618 * only, and would normally not be used by applications.
4619 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4620 * a pointer to an AVClass struct
4621 * @param[in] feature string containing the name of the missing feature
4622 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4623 * If want_sample is non-zero, additional verbage will be added to the log
4624 * message which tells the user how to report samples to the development
4627 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4630 * Log a generic warning message asking for a sample. This function is
4631 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4632 * only, and would normally not be used by applications.
4633 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4634 * a pointer to an AVClass struct
4635 * @param[in] msg string containing an optional message, or NULL if no message
4637 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4640 * Register the hardware accelerator hwaccel.
4642 void av_register_hwaccel(AVHWAccel *hwaccel);
4645 * If hwaccel is NULL, returns the first registered hardware accelerator,
4646 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4647 * after hwaccel, or NULL if hwaccel is the last one.
4649 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4653 * Lock operation used by lockmgr
4656 AV_LOCK_CREATE, ///< Create a mutex
4657 AV_LOCK_OBTAIN, ///< Lock the mutex
4658 AV_LOCK_RELEASE, ///< Unlock the mutex
4659 AV_LOCK_DESTROY, ///< Free mutex resources
4663 * Register a user provided lock manager supporting the operations
4664 * specified by AVLockOp. mutex points to a (void *) where the
4665 * lockmgr should store/get a pointer to a user allocated mutex. It's
4666 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4668 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4669 * callback during the call to av_lockmgr_register().
4670 * Thus, the application must be prepared to handle that.
4671 * If cb is set to NULL the lockmgr will be unregistered.
4672 * Also note that during unregistration the previously registered
4673 * lockmgr callback may also be invoked.
4675 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4678 * Get the type of the given codec.
4680 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4683 * Get the AVClass for AVCodecContext. It can be used in combination with
4684 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4686 * @see av_opt_find().
4688 const AVClass *avcodec_get_class(void);
4690 #endif /* AVCODEC_AVCODEC_H */