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,
258 CODEC_ID_UTVIDEO = 0x800,
259 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
261 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
263 /* various PCM "codecs" */
264 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
265 CODEC_ID_PCM_S16LE = 0x10000,
281 CODEC_ID_PCM_S24DAUD,
283 CODEC_ID_PCM_S16LE_PLANAR,
292 CODEC_ID_PCM_S8_PLANAR,
294 /* various ADPCM codecs */
295 CODEC_ID_ADPCM_IMA_QT = 0x11000,
296 CODEC_ID_ADPCM_IMA_WAV,
297 CODEC_ID_ADPCM_IMA_DK3,
298 CODEC_ID_ADPCM_IMA_DK4,
299 CODEC_ID_ADPCM_IMA_WS,
300 CODEC_ID_ADPCM_IMA_SMJPEG,
309 CODEC_ID_ADPCM_YAMAHA,
310 CODEC_ID_ADPCM_SBPRO_4,
311 CODEC_ID_ADPCM_SBPRO_3,
312 CODEC_ID_ADPCM_SBPRO_2,
314 CODEC_ID_ADPCM_IMA_AMV,
315 CODEC_ID_ADPCM_EA_R1,
316 CODEC_ID_ADPCM_EA_R3,
317 CODEC_ID_ADPCM_EA_R2,
318 CODEC_ID_ADPCM_IMA_EA_SEAD,
319 CODEC_ID_ADPCM_IMA_EA_EACS,
320 CODEC_ID_ADPCM_EA_XAS,
321 CODEC_ID_ADPCM_EA_MAXIS_XA,
322 CODEC_ID_ADPCM_IMA_ISS,
326 CODEC_ID_AMR_NB = 0x12000,
329 /* RealAudio codecs*/
330 CODEC_ID_RA_144 = 0x13000,
333 /* various DPCM codecs */
334 CODEC_ID_ROQ_DPCM = 0x14000,
335 CODEC_ID_INTERPLAY_DPCM,
340 CODEC_ID_MP2 = 0x15000,
341 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
352 #if LIBAVCODEC_VERSION_MAJOR == 53
361 CODEC_ID_WESTWOOD_SND1,
362 CODEC_ID_GSM, ///< as in Berlin toast format
370 CODEC_ID_DSICINAUDIO,
374 CODEC_ID_GSM_MS, /* as found in WAV */
383 CODEC_ID_WMALOSSLESS,
392 CODEC_ID_BINKAUDIO_RDFT,
393 CODEC_ID_BINKAUDIO_DCT,
397 #if LIBAVCODEC_VERSION_MAJOR > 53
398 CODEC_ID_G723_1_DEPRECATED,
399 CODEC_ID_G729_DEPRECATED,
404 CODEC_ID_G729 = 0x15800,
405 CODEC_ID_G723_1= 0x15801,
406 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
407 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
409 /* subtitle codecs */
410 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
411 CODEC_ID_DVD_SUBTITLE = 0x17000,
412 CODEC_ID_DVB_SUBTITLE,
413 CODEC_ID_TEXT, ///< raw UTF-8 text
417 CODEC_ID_HDMV_PGS_SUBTITLE,
418 CODEC_ID_DVB_TELETEXT,
420 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
422 /* other specific kind of codecs (generally used for attachments) */
423 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
424 CODEC_ID_TTF = 0x18000,
425 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
426 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
427 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
429 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
431 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
432 * stream (only used by libavformat) */
433 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
434 * stream (only used by libavformat) */
435 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
438 #if FF_API_OLD_SAMPLE_FMT
439 #define SampleFormat AVSampleFormat
441 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
442 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
443 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
444 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
445 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
446 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
447 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
450 #if FF_API_OLD_AUDIOCONVERT
451 #include "libavutil/audioconvert.h"
453 /* Audio channel masks */
454 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
455 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
456 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
457 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
458 #define CH_BACK_LEFT AV_CH_BACK_LEFT
459 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
460 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
461 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
462 #define CH_BACK_CENTER AV_CH_BACK_CENTER
463 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
464 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
465 #define CH_TOP_CENTER AV_CH_TOP_CENTER
466 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
467 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
468 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
469 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
470 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
471 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
472 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
473 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
475 /** Channel mask value used for AVCodecContext.request_channel_layout
476 to indicate that the user requests the channel order of the decoder output
477 to be the native codec channel order. */
478 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
480 /* Audio channel convenience macros */
481 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
482 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
483 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
484 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
485 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
486 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
487 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
488 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
489 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
490 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
491 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
492 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
493 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
494 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
495 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
498 #if FF_API_OLD_DECODE_AUDIO
500 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
504 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
505 * This is mainly needed because some optimized bitstream readers read
506 * 32 or 64 bit at once and could read over the end.<br>
507 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
508 * MPEG bitstreams could cause overread and segfault.
510 #define FF_INPUT_BUFFER_PADDING_SIZE 16
513 * minimum encoding buffer size
514 * Used to avoid some checks during header writing.
516 #define FF_MIN_BUFFER_SIZE 16384
520 * motion estimation type.
523 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
527 ME_EPZS, ///< enhanced predictive zonal search
528 ME_X1, ///< reserved for experiments
529 ME_HEX, ///< hexagon based search
530 ME_UMH, ///< uneven multi-hexagon search
531 ME_ITER, ///< iterative search
532 ME_TESA, ///< transformed exhaustive search algorithm
536 /* We leave some space between them for extensions (drop some
537 * keyframes for intra-only or drop just some bidir frames). */
538 AVDISCARD_NONE =-16, ///< discard nothing
539 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
540 AVDISCARD_NONREF = 8, ///< discard all non reference
541 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
542 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
543 AVDISCARD_ALL = 48, ///< discard all
546 enum AVColorPrimaries{
547 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
548 AVCOL_PRI_UNSPECIFIED=2,
550 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
551 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
552 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
554 AVCOL_PRI_NB , ///< Not part of ABI
557 enum AVColorTransferCharacteristic{
558 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
559 AVCOL_TRC_UNSPECIFIED=2,
560 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
561 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
562 AVCOL_TRC_SMPTE240M =7,
563 AVCOL_TRC_NB , ///< Not part of ABI
568 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
569 AVCOL_SPC_UNSPECIFIED=2,
571 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
572 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
573 AVCOL_SPC_SMPTE240M =7,
575 AVCOL_SPC_NB , ///< Not part of ABI
579 AVCOL_RANGE_UNSPECIFIED=0,
580 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
581 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
582 AVCOL_RANGE_NB , ///< Not part of ABI
586 * X X 3 4 X X are luma samples,
587 * 1 2 1-6 are possible chroma positions
588 * X X 5 6 X 0 is undefined/unknown position
590 enum AVChromaLocation{
591 AVCHROMA_LOC_UNSPECIFIED=0,
592 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
593 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
594 AVCHROMA_LOC_TOPLEFT =3, ///< DV
596 AVCHROMA_LOC_BOTTOMLEFT =5,
597 AVCHROMA_LOC_BOTTOM =6,
598 AVCHROMA_LOC_NB , ///< Not part of ABI
601 #if FF_API_FLAC_GLOBAL_OPTS
606 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
607 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
608 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
609 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
610 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
611 AV_LPC_TYPE_NB , ///< Not part of ABI
615 enum AVAudioServiceType {
616 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
617 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
618 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
619 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
620 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
621 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
622 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
623 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
624 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
625 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
628 typedef struct RcOverride{
631 int qscale; // If this is 0 then quality_factor will be used instead.
632 float quality_factor;
635 #define FF_MAX_B_FRAMES 16
638 These flags can be passed in AVCodecContext.flags before initialization.
639 Note: Not everything is supported yet.
642 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
643 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
644 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
645 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
646 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
648 * The parent program guarantees that the input for B-frames containing
649 * streams is not written to for at least s->max_b_frames+1 frames, if
650 * this is not set the input will be copied.
652 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
653 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
654 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
655 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
656 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
657 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
658 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
659 location instead of only at frame boundaries. */
660 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
661 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
662 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
663 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
664 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
665 /* Fx : Flag for h263+ extra options */
666 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
667 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
668 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
669 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
670 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
671 #define CODEC_FLAG_CLOSED_GOP 0x80000000
672 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
673 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
674 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
675 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
676 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
677 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
678 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
680 * @defgroup deprecated_flags Deprecated codec flags
681 * Use corresponding private codec options instead.
684 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
685 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
686 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
687 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
688 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
689 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
690 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
691 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
692 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
693 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
694 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
696 #if FF_API_MJPEG_GLOBAL_OPTS
697 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
699 #if FF_API_X264_GLOBAL_OPTS
700 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
701 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
702 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
703 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
704 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
705 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
706 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
707 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
708 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
709 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
710 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
712 #if FF_API_SNOW_GLOBAL_OPTS
713 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
715 #if FF_API_LAME_GLOBAL_OPTS
716 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
722 /* Unsupported options :
723 * Syntax Arithmetic coding (SAC)
724 * Reference Picture Selection
725 * Independent Segment Decoding */
727 /* codec capabilities */
729 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
731 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
732 * If not set, it might not use get_buffer() at all or use operations that
733 * assume the buffer was allocated by avcodec_default_get_buffer.
735 #define CODEC_CAP_DR1 0x0002
736 #if FF_API_PARSE_FRAME
737 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
738 #define CODEC_CAP_PARSE_ONLY 0x0004
740 #define CODEC_CAP_TRUNCATED 0x0008
741 /* Codec can export data for HW decoding (XvMC). */
742 #define CODEC_CAP_HWACCEL 0x0010
744 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
745 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
746 * returns frames. If this is not set, the codec is guaranteed to never be fed
749 #define CODEC_CAP_DELAY 0x0020
751 * Codec can be fed a final frame with a smaller size.
752 * This can be used to prevent truncation of the last audio samples.
754 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
756 * Codec can export data for HW decoding (VDPAU).
758 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
760 * Codec can output multiple frames per AVPacket
761 * Normally demuxers return one frame at a time, demuxers which do not do
762 * are connected to a parser to split what they return into proper frames.
763 * This flag is reserved to the very rare category of codecs which have a
764 * bitstream that cannot be split into frames without timeconsuming
765 * operations like full decoding. Demuxers carring such bitstreams thus
766 * may return multiple frames in a packet. This has many disadvantages like
767 * prohibiting stream copy in many cases thus it should only be considered
770 #define CODEC_CAP_SUBFRAMES 0x0100
772 * Codec is experimental and is thus avoided in favor of non experimental
775 #define CODEC_CAP_EXPERIMENTAL 0x0200
777 * Codec should fill in channel configuration and samplerate instead of container
779 #define CODEC_CAP_CHANNEL_CONF 0x0400
782 * Codec is able to deal with negative linesizes
784 #define CODEC_CAP_NEG_LINESIZES 0x0800
787 * Codec supports frame-level multithreading.
789 #define CODEC_CAP_FRAME_THREADS 0x1000
791 * Codec supports slice-based (or partition-based) multithreading.
793 #define CODEC_CAP_SLICE_THREADS 0x2000
797 #define CODEC_CAP_LOSSLESS 0x80000000
799 //The following defines may change, don't expect compatibility if you use them.
800 #define MB_TYPE_INTRA4x4 0x0001
801 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
802 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
803 #define MB_TYPE_16x16 0x0008
804 #define MB_TYPE_16x8 0x0010
805 #define MB_TYPE_8x16 0x0020
806 #define MB_TYPE_8x8 0x0040
807 #define MB_TYPE_INTERLACED 0x0080
808 #define MB_TYPE_DIRECT2 0x0100 //FIXME
809 #define MB_TYPE_ACPRED 0x0200
810 #define MB_TYPE_GMC 0x0400
811 #define MB_TYPE_SKIP 0x0800
812 #define MB_TYPE_P0L0 0x1000
813 #define MB_TYPE_P1L0 0x2000
814 #define MB_TYPE_P0L1 0x4000
815 #define MB_TYPE_P1L1 0x8000
816 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
817 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
818 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
819 #define MB_TYPE_QUANT 0x00010000
820 #define MB_TYPE_CBP 0x00020000
821 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
825 * This specifies the area which should be displayed.
826 * Note there may be multiple such areas for one frame.
828 typedef struct AVPanScan{
831 * - encoding: Set by user.
832 * - decoding: Set by libavcodec.
837 * width and height in 1/16 pel
838 * - encoding: Set by user.
839 * - decoding: Set by libavcodec.
845 * position of the top left corner in 1/16 pel for up to 3 fields/frames
846 * - encoding: Set by user.
847 * - decoding: Set by libavcodec.
849 int16_t position[3][2];
852 #define FF_QSCALE_TYPE_MPEG1 0
853 #define FF_QSCALE_TYPE_MPEG2 1
854 #define FF_QSCALE_TYPE_H264 2
855 #define FF_QSCALE_TYPE_VP56 3
857 #define FF_BUFFER_TYPE_INTERNAL 1
858 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
859 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
860 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
862 #if FF_API_OLD_FF_PICT_TYPES
863 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
864 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
865 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
866 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
867 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
868 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
869 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
870 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
873 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
874 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
875 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
876 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
878 enum AVPacketSideDataType {
882 typedef struct AVPacket {
884 * Presentation timestamp in AVStream->time_base units; the time at which
885 * the decompressed packet will be presented to the user.
886 * Can be AV_NOPTS_VALUE if it is not stored in the file.
887 * pts MUST be larger or equal to dts as presentation cannot happen before
888 * decompression, unless one wants to view hex dumps. Some formats misuse
889 * the terms dts and pts/cts to mean something different. Such timestamps
890 * must be converted to true pts/dts before they are stored in AVPacket.
894 * Decompression timestamp in AVStream->time_base units; the time at which
895 * the packet is decompressed.
896 * Can be AV_NOPTS_VALUE if it is not stored in the file.
903 * A combination of AV_PKT_FLAG values
907 * Additional packet data that can be provided by the container.
908 * Packet can contain several types of side information.
913 enum AVPacketSideDataType type;
918 * Duration of this packet in AVStream->time_base units, 0 if unknown.
919 * Equals next_pts - this_pts in presentation order.
922 void (*destruct)(struct AVPacket *);
924 int64_t pos; ///< byte position in stream, -1 if unknown
927 * Time difference in AVStream->time_base units from the pts of this
928 * packet to the point at which the output from the decoder has converged
929 * independent from the availability of previous frames. That is, the
930 * frames are virtually identical no matter if decoding started from
931 * the very first frame or from this keyframe.
932 * Is AV_NOPTS_VALUE if unknown.
933 * This field is not the display duration of the current packet.
934 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
937 * The purpose of this field is to allow seeking in streams that have no
938 * keyframes in the conventional sense. It corresponds to the
939 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
940 * essential for some types of subtitle streams to ensure that all
941 * subtitles are correctly displayed after seeking.
943 int64_t convergence_duration;
945 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
946 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
950 * New fields can be added to the end of AVFRAME with minor version
951 * bumps. Similarly fields that are marked as to be only accessed by
952 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
953 * without breaking compatibility with each other.
954 * Removal, reordering and changes in the remaining cases require
955 * a major version bump.
956 * sizeof(AVFrame) must not be used outside libavcodec.
958 typedef struct AVFrame {
959 #if FF_API_DATA_POINTERS
960 #define AV_NUM_DATA_POINTERS 4
962 #define AV_NUM_DATA_POINTERS 8
965 * pointer to the picture/channel planes.
966 * This might be different from the first allocated byte
967 * - encoding: Set by user
968 * - decoding: set by AVCodecContext.get_buffer()
970 uint8_t *data[AV_NUM_DATA_POINTERS];
973 * Size, in bytes, of the data for each picture/channel plane.
975 * For audio, only linesize[0] may be set. For planar audio, each channel
976 * plane must be the same size.
978 * - encoding: Set by user (video only)
979 * - decoding: set by AVCodecContext.get_buffer()
981 int linesize[AV_NUM_DATA_POINTERS];
984 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
985 * This isn't used by libavcodec unless the default get/release_buffer() is used.
989 uint8_t *base[AV_NUM_DATA_POINTERS];
991 * 1 -> keyframe, 0-> not
992 * - encoding: Set by libavcodec.
993 * - decoding: Set by libavcodec.
998 * Picture type of the frame, see ?_TYPE below.
999 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1000 * - decoding: Set by libavcodec.
1002 enum AVPictureType pict_type;
1005 * presentation timestamp in time_base units (time when frame should be shown to user)
1006 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1007 * - encoding: MUST be set by user.
1008 * - decoding: Set by libavcodec.
1013 * picture number in bitstream order
1014 * - encoding: set by
1015 * - decoding: Set by libavcodec.
1017 int coded_picture_number;
1019 * picture number in display order
1020 * - encoding: set by
1021 * - decoding: Set by libavcodec.
1023 int display_picture_number;
1026 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1027 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1028 * - decoding: Set by libavcodec.
1032 #if FF_API_AVFRAME_AGE
1034 * @deprecated unused
1036 attribute_deprecated int age;
1040 * is this picture used as reference
1041 * The values for this are the same as the MpegEncContext.picture_structure
1042 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1043 * Set to 4 for delayed, non-reference frames.
1044 * - encoding: unused
1045 * - decoding: Set by libavcodec. (before get_buffer() call)).
1051 * - encoding: unused
1052 * - decoding: Set by libavcodec.
1054 int8_t *qscale_table;
1057 * - encoding: unused
1058 * - decoding: Set by libavcodec.
1063 * mbskip_table[mb]>=1 if MB didn't change
1064 * stride= mb_width = (width+15)>>4
1065 * - encoding: unused
1066 * - decoding: Set by libavcodec.
1068 uint8_t *mbskip_table;
1071 * motion vector table
1074 * int mv_sample_log2= 4 - motion_subsample_log2;
1075 * int mb_width= (width+15)>>4;
1076 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1077 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1079 * - encoding: Set by user.
1080 * - decoding: Set by libavcodec.
1082 int16_t (*motion_val[2])[2];
1085 * macroblock type table
1086 * mb_type_base + mb_width + 2
1087 * - encoding: Set by user.
1088 * - decoding: Set by libavcodec.
1093 * log2 of the size of the block which a single vector in motion_val represents:
1094 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1095 * - encoding: unused
1096 * - decoding: Set by libavcodec.
1098 uint8_t motion_subsample_log2;
1101 * for some private data of the user
1102 * - encoding: unused
1103 * - decoding: Set by user.
1109 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1110 * - decoding: unused
1112 uint64_t error[AV_NUM_DATA_POINTERS];
1115 * type of the buffer (to keep track of who has to deallocate data[*])
1116 * - encoding: Set by the one who allocates it.
1117 * - decoding: Set by the one who allocates it.
1118 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1123 * When decoding, this signals how much the picture must be delayed.
1124 * extra_delay = repeat_pict / (2*fps)
1125 * - encoding: unused
1126 * - decoding: Set by libavcodec.
1136 * The content of the picture is interlaced.
1137 * - encoding: Set by user.
1138 * - decoding: Set by libavcodec. (default 0)
1140 int interlaced_frame;
1143 * If the content is interlaced, is top field displayed first.
1144 * - encoding: Set by user.
1145 * - decoding: Set by libavcodec.
1147 int top_field_first;
1151 * - encoding: Set by user.
1152 * - decoding: Set by libavcodec.
1154 AVPanScan *pan_scan;
1157 * Tell user application that palette has changed from previous frame.
1158 * - encoding: ??? (no palette-enabled encoder yet)
1159 * - decoding: Set by libavcodec. (default 0).
1161 int palette_has_changed;
1164 * codec suggestion on buffer type if != 0
1165 * - encoding: unused
1166 * - decoding: Set by libavcodec. (before get_buffer() call)).
1172 * - encoding: unused
1173 * - decoding: Set by libavcodec.
1178 * motion reference frame index
1179 * the order in which these are stored can depend on the codec.
1180 * - encoding: Set by user.
1181 * - decoding: Set by libavcodec.
1183 int8_t *ref_index[2];
1186 * reordered opaque 64bit (generally an integer or a double precision float
1187 * PTS but can be anything).
1188 * The user sets AVCodecContext.reordered_opaque to represent the input at
1190 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1191 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1192 * @deprecated in favor of pkt_pts
1193 * - encoding: unused
1194 * - decoding: Read by user.
1196 int64_t reordered_opaque;
1199 * hardware accelerator private data (FFmpeg-allocated)
1200 * - encoding: unused
1201 * - decoding: Set by libavcodec
1203 void *hwaccel_picture_private;
1206 * reordered pts from the last AVPacket that has been input into the decoder
1207 * - encoding: unused
1208 * - decoding: Read by user.
1213 * dts from the last AVPacket that has been input into the decoder
1214 * - encoding: unused
1215 * - decoding: Read by user.
1220 * the AVCodecContext which ff_thread_get_buffer() was last called on
1221 * - encoding: Set by libavcodec.
1222 * - decoding: Set by libavcodec.
1224 struct AVCodecContext *owner;
1227 * used by multithreading to store frame-specific info
1228 * - encoding: Set by libavcodec.
1229 * - decoding: Set by libavcodec.
1231 void *thread_opaque;
1234 * number of audio samples (per channel) described by this frame
1235 * - encoding: unused
1236 * - decoding: Set by libavcodec
1241 * pointers to the data planes/channels.
1243 * For video, this should simply point to data[].
1245 * For planar audio, each channel has a separate data pointer, and
1246 * linesize[0] contains the size of each channel buffer.
1247 * For packed audio, there is just one data pointer, and linesize[0]
1248 * contains the total size of the buffer for all channels.
1250 * Note: Both data and extended_data will always be set by get_buffer(),
1251 * but for planar audio with more channels that can fit in data,
1252 * extended_data must be used by the decoder in order to access all
1256 * decoding: set by AVCodecContext.get_buffer()
1258 uint8_t **extended_data;
1261 * frame timestamp estimated using various heuristics, in stream time base
1262 * Code outside libavcodec should access this field using:
1263 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1264 * - encoding: unused
1265 * - decoding: set by libavcodec, read by user.
1267 int64_t best_effort_timestamp;
1270 * reordered pos from the last AVPacket that has been input into the decoder
1271 * Code outside libavcodec should access this field using:
1272 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1273 * - encoding: unused
1274 * - decoding: Read by user.
1279 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1280 * Code outside libavcodec should access this field using:
1281 * av_opt_ptr(avcodec_get_frame_class(), frame, "sample_aspect_ratio");
1282 * - encoding: unused
1283 * - decoding: Read by user.
1285 AVRational sample_aspect_ratio;
1288 * width and height of the video frame
1289 * Code outside libavcodec should access this field using:
1290 * av_opt_ptr(avcodec_get_frame_class(), frame, "width");
1291 * - encoding: unused
1292 * - decoding: Read by user.
1297 * format of the frame, -1 if unknown or unset
1298 * It should be cast to the corresponding enum (enum PixelFormat
1299 * for video, enum AVSampleFormat for audio)
1300 * Code outside libavcodec should access this field using:
1301 * av_opt_ptr(avcodec_get_frame_class(), frame, "format");
1302 * - encoding: unused
1303 * - decoding: Read by user.
1309 struct AVCodecInternal;
1312 * main external API structure.
1313 * New fields can be added to the end with minor version bumps.
1314 * Removal, reordering and changes to existing fields require a major
1316 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1318 * sizeof(AVCodecContext) must not be used outside libav*.
1320 typedef struct AVCodecContext {
1322 * information on struct for av_log
1323 * - set by avcodec_alloc_context3
1325 const AVClass *av_class;
1327 * the average bitrate
1328 * - encoding: Set by user; unused for constant quantizer encoding.
1329 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1334 * number of bits the bitstream is allowed to diverge from the reference.
1335 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1336 * - encoding: Set by user; unused for constant quantizer encoding.
1337 * - decoding: unused
1339 int bit_rate_tolerance;
1343 * - encoding: Set by user.
1344 * - decoding: Set by user.
1349 * Some codecs need additional format info. It is stored here.
1350 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1351 * specific codec MUST set it correctly otherwise stream copy breaks.
1352 * In general use of this field by muxers is not recommended.
1353 * - encoding: Set by libavcodec.
1354 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1359 * Motion estimation algorithm used for video coding.
1360 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1361 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1362 * - encoding: MUST be set by user.
1363 * - decoding: unused
1368 * some codecs need / can use extradata like Huffman tables.
1369 * mjpeg: Huffman tables
1370 * rv10: additional flags
1371 * mpeg4: global headers (they can be in the bitstream or here)
1372 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1373 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1374 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1375 * - encoding: Set/allocated/freed by libavcodec.
1376 * - decoding: Set/allocated/freed by user.
1382 * This is the fundamental unit of time (in seconds) in terms
1383 * of which frame timestamps are represented. For fixed-fps content,
1384 * timebase should be 1/framerate and timestamp increments should be
1386 * - encoding: MUST be set by user.
1387 * - decoding: Set by libavcodec.
1389 AVRational time_base;
1393 * picture width / height.
1394 * - encoding: MUST be set by user.
1395 * - decoding: Set by libavcodec.
1396 * Note: For compatibility it is possible to set this instead of
1397 * coded_width/height before decoding.
1401 #define FF_ASPECT_EXTENDED 15
1404 * the number of pictures in a group of pictures, or 0 for intra_only
1405 * - encoding: Set by user.
1406 * - decoding: unused
1411 * Pixel format, see PIX_FMT_xxx.
1412 * May be set by the demuxer if known from headers.
1413 * May be overriden by the decoder if it knows better.
1414 * - encoding: Set by user.
1415 * - decoding: Set by user if known, overridden by libavcodec if known
1417 enum PixelFormat pix_fmt;
1420 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1421 * decoder to draw a horizontal band. It improves cache usage. Not
1422 * all codecs can do that. You must check the codec capabilities
1424 * When multithreading is used, it may be called from multiple threads
1425 * at the same time; threads might draw different parts of the same AVFrame,
1426 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1428 * The function is also used by hardware acceleration APIs.
1429 * It is called at least once during frame decoding to pass
1430 * the data needed for hardware render.
1431 * In that mode instead of pixel data, AVFrame points to
1432 * a structure specific to the acceleration API. The application
1433 * reads the structure and can change some fields to indicate progress
1435 * - encoding: unused
1436 * - decoding: Set by user.
1437 * @param height the height of the slice
1438 * @param y the y position of the slice
1439 * @param type 1->top field, 2->bottom field, 3->frame
1440 * @param offset offset into the AVFrame.data from which the slice should be read
1442 void (*draw_horiz_band)(struct AVCodecContext *s,
1443 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1444 int y, int type, int height);
1447 int sample_rate; ///< samples per second
1448 int channels; ///< number of audio channels
1451 * audio sample format
1452 * - encoding: Set by user.
1453 * - decoding: Set by libavcodec.
1455 enum AVSampleFormat sample_fmt; ///< sample format
1457 /* The following data should not be initialized. */
1459 * Samples per packet, initialized when calling 'init'.
1462 int frame_number; ///< audio or video frame number
1465 * Encoding: Number of frames delay there will be from the encoder input to
1466 * the decoder output. (we assume the decoder matches the spec)
1467 * Decoding: Number of frames delay in addition to what a standard decoder
1468 * as specified in the spec would produce.
1469 * - encoding: Set by libavcodec.
1470 * - decoding: Set by libavcodec.
1474 /* - encoding parameters */
1475 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1476 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1480 * - encoding: Set by user.
1481 * - decoding: unused
1487 * - encoding: Set by user.
1488 * - decoding: unused
1493 * maximum quantizer difference between frames
1494 * - encoding: Set by user.
1495 * - decoding: unused
1500 * maximum number of B-frames between non-B-frames
1501 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1502 * - encoding: Set by user.
1503 * - decoding: unused
1508 * qscale factor between IP and B-frames
1509 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1510 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1511 * - encoding: Set by user.
1512 * - decoding: unused
1514 float b_quant_factor;
1516 /** obsolete FIXME remove */
1518 #define FF_RC_STRATEGY_XVID 1
1520 int b_frame_strategy;
1522 struct AVCodec *codec;
1526 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1527 /* do its best to deliver a chunk with size */
1528 /* below rtp_payload_size, the chunk will start */
1529 /* with a start code on some codecs like H.263. */
1530 /* This doesn't take account of any particular */
1531 /* headers inside the transmitted RTP payload. */
1534 /* The RTP callback: This function is called */
1535 /* every time the encoder has a packet to send. */
1536 /* It depends on the encoder if the data starts */
1537 /* with a Start Code (it should). H.263 does. */
1538 /* mb_nb contains the number of macroblocks */
1539 /* encoded in the RTP payload. */
1540 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1542 /* statistics, used for 2-pass encoding */
1553 * number of bits used for the previously encoded frame
1554 * - encoding: Set by libavcodec.
1555 * - decoding: unused
1560 * Private data of the user, can be used to carry app specific stuff.
1561 * - encoding: Set by user.
1562 * - decoding: Set by user.
1566 char codec_name[32];
1567 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1568 enum CodecID codec_id; /* see CODEC_ID_xxx */
1571 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1572 * This is used to work around some encoder bugs.
1573 * A demuxer should set this to what is stored in the field used to identify the codec.
1574 * If there are multiple such fields in a container then the demuxer should choose the one
1575 * which maximizes the information about the used codec.
1576 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1577 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1578 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1580 * - encoding: Set by user, if not then the default based on codec_id will be used.
1581 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1583 unsigned int codec_tag;
1586 * Work around bugs in encoders which sometimes cannot be detected automatically.
1587 * - encoding: Set by user
1588 * - decoding: Set by user
1590 int workaround_bugs;
1591 #define FF_BUG_AUTODETECT 1 ///< autodetection
1592 #define FF_BUG_OLD_MSMPEG4 2
1593 #define FF_BUG_XVID_ILACE 4
1594 #define FF_BUG_UMP4 8
1595 #define FF_BUG_NO_PADDING 16
1596 #define FF_BUG_AMV 32
1597 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1598 #define FF_BUG_QPEL_CHROMA 64
1599 #define FF_BUG_STD_QPEL 128
1600 #define FF_BUG_QPEL_CHROMA2 256
1601 #define FF_BUG_DIRECT_BLOCKSIZE 512
1602 #define FF_BUG_EDGE 1024
1603 #define FF_BUG_HPEL_CHROMA 2048
1604 #define FF_BUG_DC_CLIP 4096
1605 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1606 #define FF_BUG_TRUNCATED 16384
1607 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1610 * luma single coefficient elimination threshold
1611 * - encoding: Set by user.
1612 * - decoding: unused
1614 int luma_elim_threshold;
1617 * chroma single coeff elimination threshold
1618 * - encoding: Set by user.
1619 * - decoding: unused
1621 int chroma_elim_threshold;
1624 * strictly follow the standard (MPEG4, ...).
1625 * - encoding: Set by user.
1626 * - decoding: Set by user.
1627 * Setting this to STRICT or higher means the encoder and decoder will
1628 * generally do stupid things, whereas setting it to unofficial or lower
1629 * will mean the encoder might produce output that is not supported by all
1630 * spec-compliant decoders. Decoders don't differentiate between normal,
1631 * unofficial and experimental (that is, they always try to decode things
1632 * when they can) unless they are explicitly asked to behave stupidly
1633 * (=strictly conform to the specs)
1635 int strict_std_compliance;
1636 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1637 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1638 #define FF_COMPLIANCE_NORMAL 0
1639 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1640 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1643 * qscale offset between IP and B-frames
1644 * - encoding: Set by user.
1645 * - decoding: unused
1647 float b_quant_offset;
1651 * Error recognition; higher values will detect more errors but may
1652 * misdetect some more or less valid parts as errors.
1653 * - encoding: unused
1654 * - decoding: Set by user.
1656 attribute_deprecated int error_recognition;
1657 #define FF_ER_CAREFUL 1
1658 #define FF_ER_COMPLIANT 2
1659 #define FF_ER_AGGRESSIVE 3
1660 #define FF_ER_VERY_AGGRESSIVE 4
1661 #define FF_ER_EXPLODE 5
1662 #endif /* FF_API_ER */
1665 * Called at the beginning of each frame to get a buffer for it.
1667 * The function will set AVFrame.data[], AVFrame.linesize[].
1668 * AVFrame.extended_data[] must also be set, but it should be the same as
1669 * AVFrame.data[] except for planar audio with more channels than can fit
1670 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1671 * many data pointers as it can hold.
1673 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1674 * avcodec_default_get_buffer() instead of providing buffers allocated by
1677 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1678 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1679 * but if get_buffer() is overridden then alignment considerations should
1680 * be taken into account.
1682 * @see avcodec_default_get_buffer()
1686 * If pic.reference is set then the frame will be read later by libavcodec.
1687 * avcodec_align_dimensions2() should be used to find the required width and
1688 * height, as they normally need to be rounded up to the next multiple of 16.
1690 * If frame multithreading is used and thread_safe_callbacks is set,
1691 * it may be called from a different thread, but not from more than one at
1692 * once. Does not need to be reentrant.
1694 * @see release_buffer(), reget_buffer()
1695 * @see avcodec_align_dimensions2()
1699 * Decoders request a buffer of a particular size by setting
1700 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1701 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1702 * to a smaller value in the output frame.
1704 * Decoders cannot use the buffer after returning from
1705 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1706 * is assumed to be released immediately upon return.
1708 * As a convenience, av_samples_get_buffer_size() and
1709 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1710 * functions to find the required data size and to fill data pointers and
1711 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1712 * since all planes must be the same size.
1714 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1716 * - encoding: unused
1717 * - decoding: Set by libavcodec, user can override.
1719 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1722 * Called to release buffers which were allocated with get_buffer.
1723 * A released buffer can be reused in get_buffer().
1724 * pic.data[*] must be set to NULL.
1725 * May be called from a different thread if frame multithreading is used,
1726 * but not by more than one thread at once, so does not need to be reentrant.
1727 * - encoding: unused
1728 * - decoding: Set by libavcodec, user can override.
1730 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1733 * Size of the frame reordering buffer in the decoder.
1734 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1735 * - encoding: Set by libavcodec.
1736 * - decoding: Set by libavcodec.
1741 * number of bytes per packet if constant and known or 0
1742 * Used by some WAV based audio codecs.
1746 #if FF_API_PARSE_FRAME
1748 * If true, only parsing is done. The frame data is returned.
1749 * Only MPEG audio decoders support this now.
1750 * - encoding: unused
1751 * - decoding: Set by user
1753 attribute_deprecated int parse_only;
1757 * 0-> h263 quant 1-> mpeg quant
1758 * - encoding: Set by user.
1759 * - decoding: unused
1764 * pass1 encoding statistics output buffer
1765 * - encoding: Set by libavcodec.
1766 * - decoding: unused
1771 * pass2 encoding statistics input buffer
1772 * Concatenated stuff from stats_out of pass1 should be placed here.
1773 * - encoding: Allocated/set/freed by user.
1774 * - decoding: unused
1779 * ratecontrol qmin qmax limiting method
1780 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1781 * - encoding: Set by user.
1782 * - decoding: unused
1790 * ratecontrol override, see RcOverride
1791 * - encoding: Allocated/set/freed by user.
1792 * - decoding: unused
1794 RcOverride *rc_override;
1795 int rc_override_count;
1798 * rate control equation
1799 * - encoding: Set by user
1800 * - decoding: unused
1806 * - encoding: Set by user.
1807 * - decoding: unused
1813 * - encoding: Set by user.
1814 * - decoding: unused
1819 * decoder bitstream buffer size
1820 * - encoding: Set by user.
1821 * - decoding: unused
1824 float rc_buffer_aggressivity;
1827 * qscale factor between P and I-frames
1828 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1829 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 float i_quant_factor;
1836 * qscale offset between P and I-frames
1837 * - encoding: Set by user.
1838 * - decoding: unused
1840 float i_quant_offset;
1843 * initial complexity for pass1 ratecontrol
1844 * - encoding: Set by user.
1845 * - decoding: unused
1847 float rc_initial_cplx;
1850 * DCT algorithm, see FF_DCT_* below
1851 * - encoding: Set by user.
1852 * - decoding: unused
1855 #define FF_DCT_AUTO 0
1856 #define FF_DCT_FASTINT 1
1857 #define FF_DCT_INT 2
1858 #define FF_DCT_MMX 3
1859 #define FF_DCT_MLIB 4
1860 #define FF_DCT_ALTIVEC 5
1861 #define FF_DCT_FAAN 6
1864 * luminance masking (0-> disabled)
1865 * - encoding: Set by user.
1866 * - decoding: unused
1871 * temporary complexity masking (0-> disabled)
1872 * - encoding: Set by user.
1873 * - decoding: unused
1875 float temporal_cplx_masking;
1878 * spatial complexity masking (0-> disabled)
1879 * - encoding: Set by user.
1880 * - decoding: unused
1882 float spatial_cplx_masking;
1885 * p block masking (0-> disabled)
1886 * - encoding: Set by user.
1887 * - decoding: unused
1892 * darkness masking (0-> disabled)
1893 * - encoding: Set by user.
1894 * - decoding: unused
1899 * IDCT algorithm, see FF_IDCT_* below.
1900 * - encoding: Set by user.
1901 * - decoding: Set by user.
1904 #define FF_IDCT_AUTO 0
1905 #define FF_IDCT_INT 1
1906 #define FF_IDCT_SIMPLE 2
1907 #define FF_IDCT_SIMPLEMMX 3
1908 #define FF_IDCT_LIBMPEG2MMX 4
1909 #define FF_IDCT_PS2 5
1910 #define FF_IDCT_MLIB 6
1911 #define FF_IDCT_ARM 7
1912 #define FF_IDCT_ALTIVEC 8
1913 #define FF_IDCT_SH4 9
1914 #define FF_IDCT_SIMPLEARM 10
1915 #define FF_IDCT_H264 11
1916 #define FF_IDCT_VP3 12
1917 #define FF_IDCT_IPP 13
1918 #define FF_IDCT_XVIDMMX 14
1919 #define FF_IDCT_CAVS 15
1920 #define FF_IDCT_SIMPLEARMV5TE 16
1921 #define FF_IDCT_SIMPLEARMV6 17
1922 #define FF_IDCT_SIMPLEVIS 18
1923 #define FF_IDCT_WMV2 19
1924 #define FF_IDCT_FAAN 20
1925 #define FF_IDCT_EA 21
1926 #define FF_IDCT_SIMPLENEON 22
1927 #define FF_IDCT_SIMPLEALPHA 23
1928 #define FF_IDCT_BINK 24
1932 * - encoding: Set by libavcodec.
1933 * - decoding: Set by user (or 0).
1937 * slice offsets in the frame in bytes
1938 * - encoding: Set/allocated by libavcodec.
1939 * - decoding: Set/allocated by user (or NULL).
1944 * error concealment flags
1945 * - encoding: unused
1946 * - decoding: Set by user.
1948 int error_concealment;
1949 #define FF_EC_GUESS_MVS 1
1950 #define FF_EC_DEBLOCK 2
1953 * dsp_mask could be add used to disable unwanted CPU features
1954 * CPU features (i.e. MMX, SSE. ...)
1956 * With the FORCE flag you may instead enable given CPU features.
1957 * (Dangerous: Usable in case of misdetection, improper usage however will
1958 * result into program crash.)
1963 * bits per sample/pixel from the demuxer (needed for huffyuv).
1964 * - encoding: Set by libavcodec.
1965 * - decoding: Set by user.
1967 int bits_per_coded_sample;
1970 * prediction method (needed for huffyuv)
1971 * - encoding: Set by user.
1972 * - decoding: unused
1974 int prediction_method;
1975 #define FF_PRED_LEFT 0
1976 #define FF_PRED_PLANE 1
1977 #define FF_PRED_MEDIAN 2
1980 * sample aspect ratio (0 if unknown)
1981 * That is the width of a pixel divided by the height of the pixel.
1982 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1983 * - encoding: Set by user.
1984 * - decoding: Set by libavcodec.
1986 AVRational sample_aspect_ratio;
1989 * the picture in the bitstream
1990 * - encoding: Set by libavcodec.
1991 * - decoding: Set by libavcodec.
1993 AVFrame *coded_frame;
1997 * - encoding: Set by user.
1998 * - decoding: Set by user.
2001 #define FF_DEBUG_PICT_INFO 1
2002 #define FF_DEBUG_RC 2
2003 #define FF_DEBUG_BITSTREAM 4
2004 #define FF_DEBUG_MB_TYPE 8
2005 #define FF_DEBUG_QP 16
2006 #define FF_DEBUG_MV 32
2007 #define FF_DEBUG_DCT_COEFF 0x00000040
2008 #define FF_DEBUG_SKIP 0x00000080
2009 #define FF_DEBUG_STARTCODE 0x00000100
2010 #define FF_DEBUG_PTS 0x00000200
2011 #define FF_DEBUG_ER 0x00000400
2012 #define FF_DEBUG_MMCO 0x00000800
2013 #define FF_DEBUG_BUGS 0x00001000
2014 #define FF_DEBUG_VIS_QP 0x00002000
2015 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2016 #define FF_DEBUG_BUFFERS 0x00008000
2017 #define FF_DEBUG_THREADS 0x00010000
2021 * - encoding: Set by user.
2022 * - decoding: Set by user.
2025 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2026 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2027 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2031 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2032 * - decoding: unused
2034 uint64_t error[AV_NUM_DATA_POINTERS];
2037 * motion estimation comparison function
2038 * - encoding: Set by user.
2039 * - decoding: unused
2043 * subpixel motion estimation comparison function
2044 * - encoding: Set by user.
2045 * - decoding: unused
2049 * macroblock comparison function (not supported yet)
2050 * - encoding: Set by user.
2051 * - decoding: unused
2055 * interlaced DCT comparison function
2056 * - encoding: Set by user.
2057 * - decoding: unused
2060 #define FF_CMP_SAD 0
2061 #define FF_CMP_SSE 1
2062 #define FF_CMP_SATD 2
2063 #define FF_CMP_DCT 3
2064 #define FF_CMP_PSNR 4
2065 #define FF_CMP_BIT 5
2067 #define FF_CMP_ZERO 7
2068 #define FF_CMP_VSAD 8
2069 #define FF_CMP_VSSE 9
2070 #define FF_CMP_NSSE 10
2071 #define FF_CMP_W53 11
2072 #define FF_CMP_W97 12
2073 #define FF_CMP_DCTMAX 13
2074 #define FF_CMP_DCT264 14
2075 #define FF_CMP_CHROMA 256
2078 * ME diamond size & shape
2079 * - encoding: Set by user.
2080 * - decoding: unused
2085 * amount of previous MV predictors (2a+1 x 2a+1 square)
2086 * - encoding: Set by user.
2087 * - decoding: unused
2089 int last_predictor_count;
2092 * prepass for motion estimation
2093 * - encoding: Set by user.
2094 * - decoding: unused
2099 * motion estimation prepass comparison function
2100 * - encoding: Set by user.
2101 * - decoding: unused
2106 * ME prepass diamond size & shape
2107 * - encoding: Set by user.
2108 * - decoding: unused
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int me_subpel_quality;
2120 * callback to negotiate the pixelFormat
2121 * @param fmt is the list of formats which are supported by the codec,
2122 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2123 * The first is always the native one.
2124 * @return the chosen format
2125 * - encoding: unused
2126 * - decoding: Set by user, if not set the native format will be chosen.
2128 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2131 * DTG active format information (additional aspect ratio
2132 * information only used in DVB MPEG-2 transport streams)
2135 * - encoding: unused
2136 * - decoding: Set by decoder.
2138 int dtg_active_format;
2139 #define FF_DTG_AFD_SAME 8
2140 #define FF_DTG_AFD_4_3 9
2141 #define FF_DTG_AFD_16_9 10
2142 #define FF_DTG_AFD_14_9 11
2143 #define FF_DTG_AFD_4_3_SP_14_9 13
2144 #define FF_DTG_AFD_16_9_SP_14_9 14
2145 #define FF_DTG_AFD_SP_4_3 15
2148 * maximum motion estimation search range in subpel units
2149 * If 0 then no limit.
2151 * - encoding: Set by user.
2152 * - decoding: unused
2157 * intra quantizer bias
2158 * - encoding: Set by user.
2159 * - decoding: unused
2161 int intra_quant_bias;
2162 #define FF_DEFAULT_QUANT_BIAS 999999
2165 * inter quantizer bias
2166 * - encoding: Set by user.
2167 * - decoding: unused
2169 int inter_quant_bias;
2173 * - encoding: unused
2174 * - decoding: Which clrtable should be used for 8bit RGB images.
2175 * Tables have to be stored somewhere. FIXME
2179 #if FF_API_INTERNAL_CONTEXT
2181 * internal_buffer count
2182 * Don't touch, used by libavcodec default_get_buffer().
2183 * @deprecated this field was moved to an internal context
2185 attribute_deprecated int internal_buffer_count;
2189 * Don't touch, used by libavcodec default_get_buffer().
2190 * @deprecated this field was moved to an internal context
2192 attribute_deprecated void *internal_buffer;
2196 * Global quality for codecs which cannot change it per frame.
2197 * This should be proportional to MPEG-1/2/4 qscale.
2198 * - encoding: Set by user.
2199 * - decoding: unused
2203 #define FF_CODER_TYPE_VLC 0
2204 #define FF_CODER_TYPE_AC 1
2205 #define FF_CODER_TYPE_RAW 2
2206 #define FF_CODER_TYPE_RLE 3
2207 #define FF_CODER_TYPE_DEFLATE 4
2210 * - encoding: Set by user.
2211 * - decoding: unused
2217 * - encoding: Set by user.
2218 * - decoding: unused
2224 * - encoding: unused
2225 * - decoding: Set by user.
2227 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2232 * - encoding: unused
2233 * - decoding: Set by user.
2236 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2237 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2238 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2241 * XVideo Motion Acceleration
2242 * - encoding: forbidden
2243 * - decoding: set by decoder
2245 int xvmc_acceleration;
2248 * macroblock decision mode
2249 * - encoding: Set by user.
2250 * - decoding: unused
2253 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2254 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2255 #define FF_MB_DECISION_RD 2 ///< rate distortion
2258 * custom intra quantization matrix
2259 * - encoding: Set by user, can be NULL.
2260 * - decoding: Set by libavcodec.
2262 uint16_t *intra_matrix;
2265 * custom inter quantization matrix
2266 * - encoding: Set by user, can be NULL.
2267 * - decoding: Set by libavcodec.
2269 uint16_t *inter_matrix;
2272 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2273 * This is used to work around some encoder bugs.
2274 * - encoding: unused
2275 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2277 unsigned int stream_codec_tag;
2280 * scene change detection threshold
2281 * 0 is default, larger means fewer detected scene changes.
2282 * - encoding: Set by user.
2283 * - decoding: unused
2285 int scenechange_threshold;
2288 * minimum Lagrange multipler
2289 * - encoding: Set by user.
2290 * - decoding: unused
2295 * maximum Lagrange multipler
2296 * - encoding: Set by user.
2297 * - decoding: unused
2301 #if FF_API_PALETTE_CONTROL
2303 * palette control structure
2304 * - encoding: ??? (no palette-enabled encoder yet)
2305 * - decoding: Set by user.
2307 struct AVPaletteControl *palctrl;
2311 * noise reduction strength
2312 * - encoding: Set by user.
2313 * - decoding: unused
2315 int noise_reduction;
2318 * Called at the beginning of a frame to get cr buffer for it.
2319 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2320 * libavcodec will pass previous buffer in pic, function should return
2321 * same buffer or new buffer with old frame "painted" into it.
2322 * If pic.data[0] == NULL must behave like get_buffer().
2323 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2324 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2326 * - encoding: unused
2327 * - decoding: Set by libavcodec, user can override.
2329 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2332 * Number of bits which should be loaded into the rc buffer before decoding starts.
2333 * - encoding: Set by user.
2334 * - decoding: unused
2336 int rc_initial_buffer_occupancy;
2340 * - encoding: Set by user.
2341 * - decoding: unused
2343 int inter_threshold;
2347 * - encoding: Set by user.
2348 * - decoding: Set by user.
2353 * Simulates errors in the bitstream to test error concealment.
2354 * - encoding: Set by user.
2355 * - decoding: unused
2359 #if FF_API_ANTIALIAS_ALGO
2361 * MP3 antialias algorithm, see FF_AA_* below.
2362 * - encoding: unused
2363 * - decoding: Set by user.
2365 attribute_deprecated int antialias_algo;
2366 #define FF_AA_AUTO 0
2367 #define FF_AA_FASTINT 1 //not implemented yet
2369 #define FF_AA_FLOAT 3
2373 * quantizer noise shaping
2374 * - encoding: Set by user.
2375 * - decoding: unused
2377 int quantizer_noise_shaping;
2381 * is used to decide how many independent tasks should be passed to execute()
2382 * - encoding: Set by user.
2383 * - decoding: Set by user.
2388 * The codec may call this to execute several independent things.
2389 * It will return only after finishing all tasks.
2390 * The user may replace this with some multithreaded implementation,
2391 * the default implementation will execute the parts serially.
2392 * @param count the number of things to execute
2393 * - encoding: Set by libavcodec, user can override.
2394 * - decoding: Set by libavcodec, user can override.
2396 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2400 * Can be used by execute() to store some per AVCodecContext stuff.
2401 * - encoding: set by execute()
2402 * - decoding: set by execute()
2404 void *thread_opaque;
2407 * Motion estimation threshold below which no motion estimation is
2408 * performed, but instead the user specified motion vectors are used.
2410 * - encoding: Set by user.
2411 * - decoding: unused
2416 * Macroblock threshold below which the user specified macroblock types will be used.
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * precision of the intra DC coefficient - 8
2424 * - encoding: Set by user.
2425 * - decoding: unused
2427 int intra_dc_precision;
2430 * noise vs. sse weight for the nsse comparsion function
2431 * - encoding: Set by user.
2432 * - decoding: unused
2437 * Number of macroblock rows at the top which are skipped.
2438 * - encoding: unused
2439 * - decoding: Set by user.
2444 * Number of macroblock rows at the bottom which are skipped.
2445 * - encoding: unused
2446 * - decoding: Set by user.
2452 * - encoding: Set by user.
2453 * - decoding: Set by libavcodec.
2456 #define FF_PROFILE_UNKNOWN -99
2457 #define FF_PROFILE_RESERVED -100
2459 #define FF_PROFILE_AAC_MAIN 0
2460 #define FF_PROFILE_AAC_LOW 1
2461 #define FF_PROFILE_AAC_SSR 2
2462 #define FF_PROFILE_AAC_LTP 3
2464 #define FF_PROFILE_DTS 20
2465 #define FF_PROFILE_DTS_ES 30
2466 #define FF_PROFILE_DTS_96_24 40
2467 #define FF_PROFILE_DTS_HD_HRA 50
2468 #define FF_PROFILE_DTS_HD_MA 60
2470 #define FF_PROFILE_MPEG2_422 0
2471 #define FF_PROFILE_MPEG2_HIGH 1
2472 #define FF_PROFILE_MPEG2_SS 2
2473 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2474 #define FF_PROFILE_MPEG2_MAIN 4
2475 #define FF_PROFILE_MPEG2_SIMPLE 5
2477 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2478 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2480 #define FF_PROFILE_H264_BASELINE 66
2481 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2482 #define FF_PROFILE_H264_MAIN 77
2483 #define FF_PROFILE_H264_EXTENDED 88
2484 #define FF_PROFILE_H264_HIGH 100
2485 #define FF_PROFILE_H264_HIGH_10 110
2486 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2487 #define FF_PROFILE_H264_HIGH_422 122
2488 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2489 #define FF_PROFILE_H264_HIGH_444 144
2490 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2491 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2492 #define FF_PROFILE_H264_CAVLC_444 44
2494 #define FF_PROFILE_VC1_SIMPLE 0
2495 #define FF_PROFILE_VC1_MAIN 1
2496 #define FF_PROFILE_VC1_COMPLEX 2
2497 #define FF_PROFILE_VC1_ADVANCED 3
2499 #define FF_PROFILE_MPEG4_SIMPLE 0
2500 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2501 #define FF_PROFILE_MPEG4_CORE 2
2502 #define FF_PROFILE_MPEG4_MAIN 3
2503 #define FF_PROFILE_MPEG4_N_BIT 4
2504 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2505 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2506 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2507 #define FF_PROFILE_MPEG4_HYBRID 8
2508 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2509 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2510 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2511 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2512 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2513 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2514 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2518 * - encoding: Set by user.
2519 * - decoding: Set by libavcodec.
2522 #define FF_LEVEL_UNKNOWN -99
2525 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2526 * - encoding: unused
2527 * - decoding: Set by user.
2532 * Bitstream width / height, may be different from width/height if lowres enabled.
2533 * - encoding: unused
2534 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2536 int coded_width, coded_height;
2539 * frame skip threshold
2540 * - encoding: Set by user.
2541 * - decoding: unused
2543 int frame_skip_threshold;
2547 * - encoding: Set by user.
2548 * - decoding: unused
2550 int frame_skip_factor;
2553 * frame skip exponent
2554 * - encoding: Set by user.
2555 * - decoding: unused
2560 * frame skip comparison function
2561 * - encoding: Set by user.
2562 * - decoding: unused
2567 * Border processing masking, raises the quantizer for mbs on the borders
2569 * - encoding: Set by user.
2570 * - decoding: unused
2572 float border_masking;
2575 * minimum MB lagrange multipler
2576 * - encoding: Set by user.
2577 * - decoding: unused
2582 * maximum MB lagrange multipler
2583 * - encoding: Set by user.
2584 * - decoding: unused
2590 * - encoding: Set by user.
2591 * - decoding: unused
2593 int me_penalty_compensation;
2597 * - encoding: unused
2598 * - decoding: Set by user.
2600 enum AVDiscard skip_loop_filter;
2604 * - encoding: unused
2605 * - decoding: Set by user.
2607 enum AVDiscard skip_idct;
2611 * - encoding: unused
2612 * - decoding: Set by user.
2614 enum AVDiscard skip_frame;
2618 * - encoding: Set by user.
2619 * - decoding: unused
2625 * - encoding: Set by user.
2626 * - decoding: unused
2630 #if FF_API_X264_GLOBAL_OPTS
2632 * constant rate factor - quality-based VBR - values ~correspond to qps
2633 * - encoding: Set by user.
2634 * - decoding: unused
2635 * @deprecated use 'crf' libx264 private option
2637 attribute_deprecated float crf;
2640 * constant quantization parameter rate control method
2641 * - encoding: Set by user.
2642 * - decoding: unused
2643 * @deprecated use 'cqp' libx264 private option
2645 attribute_deprecated int cqp;
2650 * - encoding: Set by user.
2651 * - decoding: unused
2656 * number of reference frames
2657 * - encoding: Set by user.
2658 * - decoding: Set by lavc.
2663 * chroma qp offset from luma
2664 * - encoding: Set by user.
2665 * - decoding: unused
2669 #if FF_API_X264_GLOBAL_OPTS
2671 * Influence how often B-frames are used.
2672 * - encoding: Set by user.
2673 * - decoding: unused
2675 attribute_deprecated int bframebias;
2679 * trellis RD quantization
2680 * - encoding: Set by user.
2681 * - decoding: unused
2685 #if FF_API_X264_GLOBAL_OPTS
2687 * Reduce fluctuations in qp (before curve compression).
2688 * - encoding: Set by user.
2689 * - decoding: unused
2691 attribute_deprecated float complexityblur;
2694 * in-loop deblocking filter alphac0 parameter
2695 * alpha is in the range -6...6
2696 * - encoding: Set by user.
2697 * - decoding: unused
2699 attribute_deprecated int deblockalpha;
2702 * in-loop deblocking filter beta parameter
2703 * beta is in the range -6...6
2704 * - encoding: Set by user.
2705 * - decoding: unused
2707 attribute_deprecated int deblockbeta;
2710 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2711 * - encoding: Set by user.
2712 * - decoding: unused
2714 attribute_deprecated int partitions;
2715 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2716 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2717 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2718 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2719 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2722 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2723 * - encoding: Set by user.
2724 * - decoding: unused
2726 attribute_deprecated int directpred;
2730 * Audio cutoff bandwidth (0 means "automatic")
2731 * - encoding: Set by user.
2732 * - decoding: unused
2737 * Multiplied by qscale for each frame and added to scene_change_score.
2738 * - encoding: Set by user.
2739 * - decoding: unused
2741 int scenechange_factor;
2745 * Note: Value depends upon the compare function used for fullpel ME.
2746 * - encoding: Set by user.
2747 * - decoding: unused
2752 * Adjust sensitivity of b_frame_strategy 1.
2753 * - encoding: Set by user.
2754 * - decoding: unused
2759 * - encoding: Set by user.
2760 * - decoding: unused
2762 int compression_level;
2763 #define FF_COMPRESSION_DEFAULT -1
2766 * - encoding: Set by user.
2767 * - decoding: unused
2769 int min_prediction_order;
2772 * - encoding: Set by user.
2773 * - decoding: unused
2775 int max_prediction_order;
2777 #if FF_API_FLAC_GLOBAL_OPTS
2779 * @name FLAC options
2780 * @deprecated Use FLAC encoder private options instead.
2785 * LPC coefficient precision - used by FLAC encoder
2786 * - encoding: Set by user.
2787 * - decoding: unused
2789 attribute_deprecated int lpc_coeff_precision;
2792 * search method for selecting prediction order
2793 * - encoding: Set by user.
2794 * - decoding: unused
2796 attribute_deprecated int prediction_order_method;
2799 * - encoding: Set by user.
2800 * - decoding: unused
2802 attribute_deprecated int min_partition_order;
2805 * - encoding: Set by user.
2806 * - decoding: unused
2808 attribute_deprecated int max_partition_order;
2815 * GOP timecode frame start number
2816 * - encoding: Set by user, in non drop frame format
2817 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2819 int64_t timecode_frame_start;
2821 #if FF_API_REQUEST_CHANNELS
2823 * Decoder should decode to this many channels if it can (0 for default)
2824 * - encoding: unused
2825 * - decoding: Set by user.
2826 * @deprecated Deprecated in favor of request_channel_layout.
2828 int request_channels;
2831 #if FF_API_DRC_SCALE
2833 * Percentage of dynamic range compression to be applied by the decoder.
2834 * The default value is 1.0, corresponding to full compression.
2835 * - encoding: unused
2836 * - decoding: Set by user.
2837 * @deprecated use AC3 decoder private option instead.
2839 attribute_deprecated float drc_scale;
2843 * opaque 64bit number (generally a PTS) that will be reordered and
2844 * output in AVFrame.reordered_opaque
2845 * @deprecated in favor of pkt_pts
2846 * - encoding: unused
2847 * - decoding: Set by user.
2849 int64_t reordered_opaque;
2852 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2853 * - encoding: set by user.
2854 * - decoding: set by libavcodec.
2856 int bits_per_raw_sample;
2859 * Audio channel layout.
2860 * - encoding: set by user.
2861 * - decoding: set by user, may be overwritten by libavcodec.
2863 uint64_t channel_layout;
2866 * Request decoder to use this channel layout if it can (0 for default)
2867 * - encoding: unused
2868 * - decoding: Set by user.
2870 uint64_t request_channel_layout;
2873 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2874 * - encoding: Set by user.
2875 * - decoding: unused.
2877 float rc_max_available_vbv_use;
2880 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2881 * - encoding: Set by user.
2882 * - decoding: unused.
2884 float rc_min_vbv_overflow_use;
2887 * Hardware accelerator in use
2888 * - encoding: unused.
2889 * - decoding: Set by libavcodec
2891 struct AVHWAccel *hwaccel;
2894 * For some codecs, the time base is closer to the field rate than the frame rate.
2895 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2896 * if no telecine is used ...
2898 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2900 int ticks_per_frame;
2903 * Hardware accelerator context.
2904 * For some hardware accelerators, a global context needs to be
2905 * provided by the user. In that case, this holds display-dependent
2906 * data FFmpeg cannot instantiate itself. Please refer to the
2907 * FFmpeg HW accelerator documentation to know how to fill this
2908 * is. e.g. for VA API, this is a struct vaapi_context.
2909 * - encoding: unused
2910 * - decoding: Set by user
2912 void *hwaccel_context;
2915 * Chromaticity coordinates of the source primaries.
2916 * - encoding: Set by user
2917 * - decoding: Set by libavcodec
2919 enum AVColorPrimaries color_primaries;
2922 * Color Transfer Characteristic.
2923 * - encoding: Set by user
2924 * - decoding: Set by libavcodec
2926 enum AVColorTransferCharacteristic color_trc;
2929 * YUV colorspace type.
2930 * - encoding: Set by user
2931 * - decoding: Set by libavcodec
2933 enum AVColorSpace colorspace;
2936 * MPEG vs JPEG YUV range.
2937 * - encoding: Set by user
2938 * - decoding: Set by libavcodec
2940 enum AVColorRange color_range;
2943 * This defines the location of chroma samples.
2944 * - encoding: Set by user
2945 * - decoding: Set by libavcodec
2947 enum AVChromaLocation chroma_sample_location;
2950 * The codec may call this to execute several independent things.
2951 * It will return only after finishing all tasks.
2952 * The user may replace this with some multithreaded implementation,
2953 * the default implementation will execute the parts serially.
2954 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2955 * @param c context passed also to func
2956 * @param count the number of things to execute
2957 * @param arg2 argument passed unchanged to func
2958 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2959 * @param func function that will be called count times, with jobnr from 0 to count-1.
2960 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2961 * two instances of func executing at the same time will have the same threadnr.
2962 * @return always 0 currently, but code should handle a future improvement where when any call to func
2963 * returns < 0 no further calls to func may be done and < 0 is returned.
2964 * - encoding: Set by libavcodec, user can override.
2965 * - decoding: Set by libavcodec, user can override.
2967 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2969 #if FF_API_X264_GLOBAL_OPTS
2971 * explicit P-frame weighted prediction analysis method
2973 * 1: fast blind weighting (one reference duplicate with -1 offset)
2974 * 2: smart weighting (full fade detection analysis)
2975 * - encoding: Set by user.
2976 * - decoding: unused
2978 attribute_deprecated int weighted_p_pred;
2983 * 1: Variance AQ (complexity mask)
2984 * 2: Auto-variance AQ (experimental)
2985 * - encoding: Set by user
2986 * - decoding: unused
2988 attribute_deprecated int aq_mode;
2992 * Reduces blocking and blurring in flat and textured areas.
2993 * - encoding: Set by user
2994 * - decoding: unused
2996 attribute_deprecated float aq_strength;
3000 * Strength of psychovisual optimization
3001 * - encoding: Set by user
3002 * - decoding: unused
3004 attribute_deprecated float psy_rd;
3008 * Strength of psychovisual optimization
3009 * - encoding: Set by user
3010 * - decoding: unused
3012 attribute_deprecated float psy_trellis;
3016 * Number of frames for frametype and ratecontrol lookahead
3017 * - encoding: Set by user
3018 * - decoding: unused
3020 attribute_deprecated int rc_lookahead;
3023 * Constant rate factor maximum
3024 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
3025 * than crf_max, even if doing so would violate VBV restrictions.
3026 * - encoding: Set by user.
3027 * - decoding: unused
3029 attribute_deprecated float crf_max;
3032 int log_level_offset;
3034 #if FF_API_FLAC_GLOBAL_OPTS
3036 * Determine which LPC analysis algorithm to use.
3037 * - encoding: Set by user
3038 * - decoding: unused
3040 attribute_deprecated enum AVLPCType lpc_type;
3043 * Number of passes to use for Cholesky factorization during LPC analysis
3044 * - encoding: Set by user
3045 * - decoding: unused
3047 attribute_deprecated int lpc_passes;
3052 * Indicates number of picture subdivisions. Used for parallelized
3054 * - encoding: Set by user
3055 * - decoding: unused
3060 * Header containing style information for text subtitles.
3061 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3062 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3063 * the Format line following. It shouldn't include any Dialogue line.
3064 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3065 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3067 uint8_t *subtitle_header;
3068 int subtitle_header_size;
3071 * Current packet as passed into the decoder, to avoid having
3072 * to pass the packet into every function. Currently only valid
3073 * inside lavc and get/release_buffer callbacks.
3074 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3075 * - encoding: unused
3079 #if FF_API_INTERNAL_CONTEXT
3081 * Whether this is a copy of the context which had init() called on it.
3082 * This is used by multithreading - shared tables and picture pointers
3083 * should be freed from the original context only.
3084 * - encoding: Set by libavcodec.
3085 * - decoding: Set by libavcodec.
3087 * @deprecated this field has been moved to an internal context
3089 attribute_deprecated int is_copy;
3093 * Which multithreading methods to use.
3094 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3095 * so clients which cannot provide future frames should not use it.
3097 * - encoding: Set by user, otherwise the default is used.
3098 * - decoding: Set by user, otherwise the default is used.
3101 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3102 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3105 * Which multithreading methods are in use by the codec.
3106 * - encoding: Set by libavcodec.
3107 * - decoding: Set by libavcodec.
3109 int active_thread_type;
3112 * Set by the client if its custom get_buffer() callback can be called
3113 * from another thread, which allows faster multithreaded decoding.
3114 * draw_horiz_band() will be called from other threads regardless of this setting.
3115 * Ignored if the default get_buffer() is used.
3116 * - encoding: Set by user.
3117 * - decoding: Set by user.
3119 int thread_safe_callbacks;
3122 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3123 * Used for compliant TS muxing.
3124 * - encoding: Set by libavcodec.
3125 * - decoding: unused.
3130 * Type of service that the audio stream conveys.
3131 * - encoding: Set by user.
3132 * - decoding: Set by libavcodec.
3134 enum AVAudioServiceType audio_service_type;
3137 * desired sample format
3138 * - encoding: Not used.
3139 * - decoding: Set by user.
3140 * Decoder will decode to this format if it can.
3142 enum AVSampleFormat request_sample_fmt;
3145 * Error recognition; may misdetect some more or less valid parts as errors.
3146 * - encoding: unused
3147 * - decoding: Set by user.
3149 int err_recognition;
3150 #define AV_EF_CRCCHECK (1<<0)
3151 #define AV_EF_BITSTREAM (1<<1)
3152 #define AV_EF_BUFFER (1<<2)
3153 #define AV_EF_EXPLODE (1<<3)
3155 #define AV_EF_CAREFUL (1<<16)
3156 #define AV_EF_COMPLIANT (1<<17)
3157 #define AV_EF_AGGRESSIVE (1<<18)
3160 * Private context used for internal data.
3162 * Unlike priv_data, this is not codec-specific. It is used in general
3163 * libavcodec functions.
3165 struct AVCodecInternal *internal;
3168 * Current statistics for PTS correction.
3169 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3170 * - encoding: unused
3172 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3173 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3174 int64_t pts_correction_last_pts; /// PTS of the last frame
3175 int64_t pts_correction_last_dts; /// DTS of the last frame
3182 typedef struct AVProfile {
3184 const char *name; ///< short name for the profile
3187 typedef struct AVCodecDefault AVCodecDefault;
3192 typedef struct AVCodec {
3194 * Name of the codec implementation.
3195 * The name is globally unique among encoders and among decoders (but an
3196 * encoder and a decoder can share the same name).
3197 * This is the primary way to find a codec from the user perspective.
3200 enum AVMediaType type;
3203 int (*init)(AVCodecContext *);
3204 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3205 int (*close)(AVCodecContext *);
3206 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3208 * Codec capabilities.
3212 struct AVCodec *next;
3215 * Will be called when seeking
3217 void (*flush)(AVCodecContext *);
3218 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3219 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3221 * Descriptive name for the codec, meant to be more human readable than name.
3222 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3224 const char *long_name;
3225 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3226 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3227 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3228 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3229 const AVClass *priv_class; ///< AVClass for the private context
3230 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3233 * @name Frame-level threading support functions
3237 * If defined, called on thread contexts when they are created.
3238 * If the codec allocates writable tables in init(), re-allocate them here.
3239 * priv_data will be set to a copy of the original.
3241 int (*init_thread_copy)(AVCodecContext *);
3243 * Copy necessary context variables from a previous thread context to the current one.
3244 * If not defined, the next thread will start automatically; otherwise, the codec
3245 * must call ff_thread_finish_setup().
3247 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3249 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3253 * Private codec-specific defaults.
3255 const AVCodecDefault *defaults;
3258 * Initialize codec static data, called from avcodec_register().
3260 void (*init_static_data)(struct AVCodec *codec);
3266 typedef struct AVHWAccel {
3268 * Name of the hardware accelerated codec.
3269 * The name is globally unique among encoders and among decoders (but an
3270 * encoder and a decoder can share the same name).
3275 * Type of codec implemented by the hardware accelerator.
3277 * See AVMEDIA_TYPE_xxx
3279 enum AVMediaType type;
3282 * Codec implemented by the hardware accelerator.
3289 * Supported pixel format.
3291 * Only hardware accelerated formats are supported here.
3293 enum PixelFormat pix_fmt;
3296 * Hardware accelerated codec capabilities.
3297 * see FF_HWACCEL_CODEC_CAP_*
3301 struct AVHWAccel *next;
3304 * Called at the beginning of each frame or field picture.
3306 * Meaningful frame information (codec specific) is guaranteed to
3307 * be parsed at this point. This function is mandatory.
3309 * Note that buf can be NULL along with buf_size set to 0.
3310 * Otherwise, this means the whole frame is available at this point.
3312 * @param avctx the codec context
3313 * @param buf the frame data buffer base
3314 * @param buf_size the size of the frame in bytes
3315 * @return zero if successful, a negative value otherwise
3317 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3320 * Callback for each slice.
3322 * Meaningful slice information (codec specific) is guaranteed to
3323 * be parsed at this point. This function is mandatory.
3325 * @param avctx the codec context
3326 * @param buf the slice data buffer base
3327 * @param buf_size the size of the slice in bytes
3328 * @return zero if successful, a negative value otherwise
3330 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3333 * Called at the end of each frame or field picture.
3335 * The whole picture is parsed at this point and can now be sent
3336 * to the hardware accelerator. This function is mandatory.
3338 * @param avctx the codec context
3339 * @return zero if successful, a negative value otherwise
3341 int (*end_frame)(AVCodecContext *avctx);
3344 * Size of HW accelerator private data.
3346 * Private data is allocated with av_mallocz() before
3347 * AVCodecContext.get_buffer() and deallocated after
3348 * AVCodecContext.release_buffer().
3354 * four components are given, that's all.
3355 * the last component is alpha
3357 typedef struct AVPicture {
3358 uint8_t *data[AV_NUM_DATA_POINTERS];
3359 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3362 #define AVPALETTE_SIZE 1024
3363 #define AVPALETTE_COUNT 256
3364 #if FF_API_PALETTE_CONTROL
3367 * This structure defines a method for communicating palette changes
3368 * between and demuxer and a decoder.
3370 * @deprecated Use AVPacket to send palette changes instead.
3371 * This is totally broken.
3373 typedef struct AVPaletteControl {
3375 /* Demuxer sets this to 1 to indicate the palette has changed;
3376 * decoder resets to 0. */
3377 int palette_changed;
3379 /* 4-byte ARGB palette entries, stored in native byte order; note that
3380 * the individual palette components should be on a 8-bit scale; if
3381 * the palette data comes from an IBM VGA native format, the component
3382 * data is probably 6 bits in size and needs to be scaled. */
3383 unsigned int palette[AVPALETTE_COUNT];
3385 } AVPaletteControl attribute_deprecated;
3388 enum AVSubtitleType {
3391 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3394 * Plain text, the text field must be set by the decoder and is
3395 * authoritative. ass and pict fields may contain approximations.
3400 * Formatted text, the ass field must be set by the decoder and is
3401 * authoritative. pict and text fields may contain approximations.
3406 typedef struct AVSubtitleRect {
3407 int x; ///< top left corner of pict, undefined when pict is not set
3408 int y; ///< top left corner of pict, undefined when pict is not set
3409 int w; ///< width of pict, undefined when pict is not set
3410 int h; ///< height of pict, undefined when pict is not set
3411 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3414 * data+linesize for the bitmap of this subtitle.
3415 * can be set for text/ass as well once they where rendered
3418 enum AVSubtitleType type;
3420 char *text; ///< 0 terminated plain UTF-8 text
3423 * 0 terminated ASS/SSA compatible event line.
3424 * The pressentation of this is unaffected by the other values in this
3430 typedef struct AVSubtitle {
3431 uint16_t format; /* 0 = graphics */
3432 uint32_t start_display_time; /* relative to packet pts, in ms */
3433 uint32_t end_display_time; /* relative to packet pts, in ms */
3435 AVSubtitleRect **rects;
3436 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3439 /* packet functions */
3442 * @deprecated use NULL instead
3444 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3447 * Default packet destructor.
3449 void av_destruct_packet(AVPacket *pkt);
3452 * Initialize optional fields of a packet with default values.
3456 void av_init_packet(AVPacket *pkt);
3459 * Allocate the payload of a packet and initialize its fields with
3463 * @param size wanted payload size
3464 * @return 0 if OK, AVERROR_xxx otherwise
3466 int av_new_packet(AVPacket *pkt, int size);
3469 * Reduce packet size, correctly zeroing padding
3472 * @param size new size
3474 void av_shrink_packet(AVPacket *pkt, int size);
3477 * Increase packet size, correctly zeroing padding
3480 * @param grow_by number of bytes by which to increase the size of the packet
3482 int av_grow_packet(AVPacket *pkt, int grow_by);
3485 * @warning This is a hack - the packet memory allocation stuff is broken. The
3486 * packet is allocated if it was not really allocated.
3488 int av_dup_packet(AVPacket *pkt);
3493 * @param pkt packet to free
3495 void av_free_packet(AVPacket *pkt);
3498 * Allocate new information of a packet.
3501 * @param type side information type
3502 * @param size side information size
3503 * @return pointer to fresh allocated data or NULL otherwise
3505 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3509 * Get side information from packet.
3512 * @param type desired side information type
3513 * @param size pointer for side information size to store (optional)
3514 * @return pointer to data if present or NULL otherwise
3516 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3519 int av_packet_merge_side_data(AVPacket *pkt);
3521 int av_packet_split_side_data(AVPacket *pkt);
3526 struct ReSampleContext;
3527 struct AVResampleContext;
3529 typedef struct ReSampleContext ReSampleContext;
3532 * Initialize audio resampling context.
3534 * @param output_channels number of output channels
3535 * @param input_channels number of input channels
3536 * @param output_rate output sample rate
3537 * @param input_rate input sample rate
3538 * @param sample_fmt_out requested output sample format
3539 * @param sample_fmt_in input sample format
3540 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3541 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3542 * @param linear if 1 then the used FIR filter will be linearly interpolated
3543 between the 2 closest, if 0 the closest will be used
3544 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3545 * @return allocated ReSampleContext, NULL if error occurred
3547 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3548 int output_rate, int input_rate,
3549 enum AVSampleFormat sample_fmt_out,
3550 enum AVSampleFormat sample_fmt_in,
3551 int filter_length, int log2_phase_count,
3552 int linear, double cutoff);
3554 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3557 * Free resample context.
3559 * @param s a non-NULL pointer to a resample context previously
3560 * created with av_audio_resample_init()
3562 void audio_resample_close(ReSampleContext *s);
3566 * Initialize an audio resampler.
3567 * Note, if either rate is not an integer then simply scale both rates up so they are.
3568 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3569 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3570 * @param linear If 1 then the used FIR filter will be linearly interpolated
3571 between the 2 closest, if 0 the closest will be used
3572 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3574 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3577 * Resample an array of samples using a previously configured context.
3578 * @param src an array of unconsumed samples
3579 * @param consumed the number of samples of src which have been consumed are returned here
3580 * @param src_size the number of unconsumed samples available
3581 * @param dst_size the amount of space in samples available in dst
3582 * @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.
3583 * @return the number of samples written in dst or -1 if an error occurred
3585 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3589 * Compensate samplerate/timestamp drift. The compensation is done by changing
3590 * the resampler parameters, so no audible clicks or similar distortions occur
3591 * @param compensation_distance distance in output samples over which the compensation should be performed
3592 * @param sample_delta number of output samples which should be output less
3594 * example: av_resample_compensate(c, 10, 500)
3595 * here instead of 510 samples only 500 samples would be output
3597 * note, due to rounding the actual compensation might be slightly different,
3598 * especially if the compensation_distance is large and the in_rate used during init is small
3600 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3601 void av_resample_close(struct AVResampleContext *c);
3604 * Allocate memory for a picture. Call avpicture_free() to free it.
3606 * @see avpicture_fill()
3608 * @param picture the picture to be filled in
3609 * @param pix_fmt the format of the picture
3610 * @param width the width of the picture
3611 * @param height the height of the picture
3612 * @return zero if successful, a negative value if not
3614 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3617 * Free a picture previously allocated by avpicture_alloc().
3618 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3621 * @param picture the AVPicture to be freed
3623 void avpicture_free(AVPicture *picture);
3626 * Fill in the AVPicture fields.
3627 * The fields of the given AVPicture are filled in by using the 'ptr' address
3628 * which points to the image data buffer. Depending on the specified picture
3629 * format, one or multiple image data pointers and line sizes will be set.
3630 * If a planar format is specified, several pointers will be set pointing to
3631 * the different picture planes and the line sizes of the different planes
3632 * will be stored in the lines_sizes array.
3633 * Call with ptr == NULL to get the required size for the ptr buffer.
3635 * To allocate the buffer and fill in the AVPicture fields in one call,
3636 * use avpicture_alloc().
3638 * @param picture AVPicture whose fields are to be filled in
3639 * @param ptr Buffer which will contain or contains the actual image data
3640 * @param pix_fmt The format in which the picture data is stored.
3641 * @param width the width of the image in pixels
3642 * @param height the height of the image in pixels
3643 * @return size of the image data in bytes
3645 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3646 enum PixelFormat pix_fmt, int width, int height);
3649 * Copy pixel data from an AVPicture into a buffer.
3650 * The data is stored compactly, without any gaps for alignment or padding
3651 * which may be applied by avpicture_fill().
3653 * @see avpicture_get_size()
3655 * @param[in] src AVPicture containing image data
3656 * @param[in] pix_fmt The format in which the picture data is stored.
3657 * @param[in] width the width of the image in pixels.
3658 * @param[in] height the height of the image in pixels.
3659 * @param[out] dest A buffer into which picture data will be copied.
3660 * @param[in] dest_size The size of 'dest'.
3661 * @return The number of bytes written to dest, or a negative value (error code) on error.
3663 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3664 unsigned char *dest, int dest_size);
3667 * Calculate the size in bytes that a picture of the given width and height
3668 * would occupy if stored in the given picture format.
3669 * Note that this returns the size of a compact representation as generated
3670 * by avpicture_layout(), which can be smaller than the size required for e.g.
3673 * @param pix_fmt the given picture format
3674 * @param width the width of the image
3675 * @param height the height of the image
3676 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3678 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3679 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3682 * Get the name of a codec.
3683 * @return a static string identifying the codec; never NULL
3685 const char *avcodec_get_name(enum CodecID id);
3687 #if FF_API_GET_PIX_FMT_NAME
3689 * Return the short name for a pixel format.
3691 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3692 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3694 attribute_deprecated
3695 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3698 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3701 * Return a value representing the fourCC code associated to the
3702 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3705 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3708 * Put a string representing the codec tag codec_tag in buf.
3710 * @param buf_size size in bytes of buf
3711 * @return the length of the string that would have been generated if
3712 * enough space had been available, excluding the trailing null
3714 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3716 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3717 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3718 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3719 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3720 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3721 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3724 * Compute what kind of losses will occur when converting from one specific
3725 * pixel format to another.
3726 * When converting from one pixel format to another, information loss may occur.
3727 * For example, when converting from RGB24 to GRAY, the color information will
3728 * be lost. Similarly, other losses occur when converting from some formats to
3729 * other formats. These losses can involve loss of chroma, but also loss of
3730 * resolution, loss of color depth, loss due to the color space conversion, loss
3731 * of the alpha bits or loss due to color quantization.
3732 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3733 * which will occur when converting from one pixel format to another.
3735 * @param[in] dst_pix_fmt destination pixel format
3736 * @param[in] src_pix_fmt source pixel format
3737 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3738 * @return Combination of flags informing you what kind of losses will occur
3739 * (maximum loss for an invalid dst_pix_fmt).
3741 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3745 * Find the best pixel format to convert to given a certain source pixel
3746 * format. When converting from one pixel format to another, information loss
3747 * may occur. For example, when converting from RGB24 to GRAY, the color
3748 * information will be lost. Similarly, other losses occur when converting from
3749 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3750 * the given pixel formats should be used to suffer the least amount of loss.
3751 * The pixel formats from which it chooses one, are determined by the
3752 * pix_fmt_mask parameter.
3754 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3757 * src_pix_fmt = PIX_FMT_YUV420P;
3758 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3759 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3762 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3763 * @param[in] src_pix_fmt source pixel format
3764 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3765 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3766 * @return The best pixel format to convert to or -1 if none was found.
3768 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3769 int has_alpha, int *loss_ptr);
3772 * Find the best pixel format to convert to given a certain source pixel
3773 * format and a selection of two destination pixel formats. When converting from
3774 * one pixel format to another, information loss may occur. For example, when converting
3775 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3776 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3777 * the given pixel formats should be used to suffer the least amount of loss.
3779 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3783 * src_pix_fmt = PIX_FMT_YUV420P;
3784 * dst_pix_fmt1= PIX_FMT_RGB24;
3785 * dst_pix_fmt2= PIX_FMT_GRAY8;
3786 * dst_pix_fmt3= PIX_FMT_RGB8;
3787 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3788 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3789 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3792 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3793 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3794 * @param[in] src_pix_fmt Source pixel format
3795 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3796 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3797 * NULL or value of zero means we care about all losses. Out: the loss
3798 * that occurs when converting from src to selected dst pixel format.
3799 * @return The best pixel format to convert to or -1 if none was found.
3801 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3802 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3804 #if FF_API_GET_ALPHA_INFO
3805 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3806 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3809 * Tell if an image really has transparent alpha values.
3810 * @return ored mask of FF_ALPHA_xxx constants
3812 attribute_deprecated
3813 int img_get_alpha_info(const AVPicture *src,
3814 enum PixelFormat pix_fmt, int width, int height);
3817 /* deinterlace a picture */
3818 /* deinterlace - if not supported return -1 */
3819 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3820 enum PixelFormat pix_fmt, int width, int height);
3822 /* external high level API */
3825 * If c is NULL, returns the first registered codec,
3826 * if c is non-NULL, returns the next registered codec after c,
3827 * or NULL if c is the last one.
3829 AVCodec *av_codec_next(AVCodec *c);
3832 * Return the LIBAVCODEC_VERSION_INT constant.
3834 unsigned avcodec_version(void);
3837 * Return the libavcodec build-time configuration.
3839 const char *avcodec_configuration(void);
3842 * Return the libavcodec license.
3844 const char *avcodec_license(void);
3846 #if FF_API_AVCODEC_INIT
3848 * @deprecated this function is called automatically from avcodec_register()
3849 * and avcodec_register_all(), there is no need to call it manually
3851 attribute_deprecated
3852 void avcodec_init(void);
3856 * Register the codec codec and initialize libavcodec.
3858 * @warning either this function or avcodec_register_all() must be called
3859 * before any other libavcodec functions.
3861 * @see avcodec_register_all()
3863 void avcodec_register(AVCodec *codec);
3866 * Find a registered encoder with a matching codec ID.
3868 * @param id CodecID of the requested encoder
3869 * @return An encoder if one was found, NULL otherwise.
3871 AVCodec *avcodec_find_encoder(enum CodecID id);
3874 * Find a registered encoder with the specified name.
3876 * @param name name of the requested encoder
3877 * @return An encoder if one was found, NULL otherwise.
3879 AVCodec *avcodec_find_encoder_by_name(const char *name);
3882 * Find a registered decoder with a matching codec ID.
3884 * @param id CodecID of the requested decoder
3885 * @return A decoder if one was found, NULL otherwise.
3887 AVCodec *avcodec_find_decoder(enum CodecID id);
3890 * Find a registered decoder with the specified name.
3892 * @param name name of the requested decoder
3893 * @return A decoder if one was found, NULL otherwise.
3895 AVCodec *avcodec_find_decoder_by_name(const char *name);
3896 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3899 * Return a name for the specified profile, if available.
3901 * @param codec the codec that is searched for the given profile
3902 * @param profile the profile value for which a name is requested
3903 * @return A name for the profile if found, NULL otherwise.
3905 const char *av_get_profile_name(const AVCodec *codec, int profile);
3907 #if FF_API_ALLOC_CONTEXT
3909 * Set the fields of the given AVCodecContext to default values.
3911 * @param s The AVCodecContext of which the fields should be set to default values.
3912 * @deprecated use avcodec_get_context_defaults3
3914 attribute_deprecated
3915 void avcodec_get_context_defaults(AVCodecContext *s);
3917 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3918 * we WILL change its arguments and name a few times! */
3919 attribute_deprecated
3920 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3924 * Set the fields of the given AVCodecContext to default values corresponding
3925 * to the given codec (defaults may be codec-dependent).
3927 * Do not call this function if a non-NULL codec has been passed
3928 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3929 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3930 * different codec on this AVCodecContext.
3932 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3934 #if FF_API_ALLOC_CONTEXT
3936 * Allocate an AVCodecContext and set its fields to default values. The
3937 * resulting struct can be deallocated by simply calling av_free().
3939 * @return An AVCodecContext filled with default values or NULL on failure.
3940 * @see avcodec_get_context_defaults
3942 * @deprecated use avcodec_alloc_context3()
3944 attribute_deprecated
3945 AVCodecContext *avcodec_alloc_context(void);
3947 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3948 * we WILL change its arguments and name a few times! */
3949 attribute_deprecated
3950 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3954 * Allocate an AVCodecContext and set its fields to default values. The
3955 * resulting struct can be deallocated by simply calling av_free().
3957 * @param codec if non-NULL, allocate private data and initialize defaults
3958 * for the given codec. It is illegal to then call avcodec_open2()
3959 * with a different codec.
3961 * @return An AVCodecContext filled with default values or NULL on failure.
3962 * @see avcodec_get_context_defaults
3964 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3967 * Copy the settings of the source AVCodecContext into the destination
3968 * AVCodecContext. The resulting destination codec context will be
3969 * unopened, i.e. you are required to call avcodec_open2() before you
3970 * can use this AVCodecContext to decode/encode video/audio data.
3972 * @param dest target codec context, should be initialized with
3973 * avcodec_alloc_context3(), but otherwise uninitialized
3974 * @param src source codec context
3975 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3977 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3980 * Set the fields of the given AVFrame to default values.
3982 * @param pic The AVFrame of which the fields should be set to default values.
3984 void avcodec_get_frame_defaults(AVFrame *pic);
3987 * Allocate an AVFrame and set its fields to default values. The resulting
3988 * struct can be deallocated by simply calling av_free().
3990 * @return An AVFrame filled with default values or NULL on failure.
3991 * @see avcodec_get_frame_defaults
3993 AVFrame *avcodec_alloc_frame(void);
3995 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3996 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3997 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4000 * Return the amount of padding in pixels which the get_buffer callback must
4001 * provide around the edge of the image for codecs which do not have the
4002 * CODEC_FLAG_EMU_EDGE flag.
4004 * @return Required padding in pixels.
4006 unsigned avcodec_get_edge_width(void);
4008 * Modify width and height values so that they will result in a memory
4009 * buffer that is acceptable for the codec if you do not use any horizontal
4012 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4013 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4014 * according to avcodec_get_edge_width() before.
4016 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4018 * Modify width and height values so that they will result in a memory
4019 * buffer that is acceptable for the codec if you also ensure that all
4020 * line sizes are a multiple of the respective linesize_align[i].
4022 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4023 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4024 * according to avcodec_get_edge_width() before.
4026 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4027 int linesize_align[AV_NUM_DATA_POINTERS]);
4029 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4031 #if FF_API_THREAD_INIT
4033 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
4035 attribute_deprecated
4036 int avcodec_thread_init(AVCodecContext *s, int thread_count);
4039 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4040 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4041 //FIXME func typedef
4043 #if FF_API_AVCODEC_OPEN
4045 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4046 * function the context has to be allocated.
4048 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4049 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4050 * retrieving a codec.
4052 * @warning This function is not thread safe!
4055 * avcodec_register_all();
4056 * codec = avcodec_find_decoder(CODEC_ID_H264);
4060 * context = avcodec_alloc_context3(codec);
4062 * if (avcodec_open(context, codec) < 0)
4066 * @param avctx The context which will be set up to use the given codec.
4067 * @param codec The codec to use within the context.
4068 * @return zero on success, a negative value on error
4069 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
4071 * @deprecated use avcodec_open2
4073 attribute_deprecated
4074 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
4078 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4079 * function the context has to be allocated with avcodec_alloc_context3().
4081 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4082 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4083 * retrieving a codec.
4085 * @warning This function is not thread safe!
4088 * avcodec_register_all();
4089 * av_dict_set(&opts, "b", "2.5M", 0);
4090 * codec = avcodec_find_decoder(CODEC_ID_H264);
4094 * context = avcodec_alloc_context3(codec);
4096 * if (avcodec_open2(context, codec, opts) < 0)
4100 * @param avctx The context to initialize.
4101 * @param options A dictionary filled with AVCodecContext and codec-private options.
4102 * On return this object will be filled with options that were not found.
4104 * @return zero on success, a negative value on error
4105 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4106 * av_dict_set(), av_opt_find().
4108 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
4110 #if FF_API_OLD_DECODE_AUDIO
4112 * Wrapper function which calls avcodec_decode_audio4.
4114 * @deprecated Use avcodec_decode_audio4 instead.
4116 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4117 * Some decoders may support multiple frames in a single AVPacket, such
4118 * decoders would then just decode the first frame. In this case,
4119 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4120 * the remaining data in order to decode the second frame etc.
4122 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4123 * decompressed frame size in bytes.
4125 * @warning You must set frame_size_ptr to the allocated size of the
4126 * output buffer before calling avcodec_decode_audio3().
4128 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4129 * the actual read bytes because some optimized bitstream readers read 32 or 64
4130 * bits at once and could read over the end.
4132 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4133 * no overreading happens for damaged MPEG streams.
4135 * @note You might have to align the input buffer avpkt->data and output buffer
4136 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4137 * necessary at all, on others it won't work at all if not aligned and on others
4138 * it will work but it will have an impact on performance.
4140 * In practice, avpkt->data should have 4 byte alignment at minimum and
4141 * samples should be 16 byte aligned unless the CPU doesn't need it
4142 * (AltiVec and SSE do).
4144 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4145 * between input and output, these need to be fed with avpkt->data=NULL,
4146 * avpkt->size=0 at the end to return the remaining frames.
4148 * @param avctx the codec context
4149 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4150 * If the sample format is planar, each channel plane will
4151 * be the same size, with no padding between channels.
4152 * @param[in,out] frame_size_ptr the output buffer size in bytes
4153 * @param[in] avpkt The input AVPacket containing the input buffer.
4154 * You can create such packet with av_init_packet() and by then setting
4155 * data and size, some decoders might in addition need other fields.
4156 * All decoders are designed to use the least fields possible though.
4157 * @return On error a negative value is returned, otherwise the number of bytes
4158 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4160 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4161 int *frame_size_ptr,
4166 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4168 * Some decoders may support multiple frames in a single AVPacket. Such
4169 * decoders would then just decode the first frame. In this case,
4170 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4171 * the remaining data in order to decode the second frame, etc...
4172 * Even if no frames are returned, the packet needs to be fed to the decoder
4173 * with remaining data until it is completely consumed or an error occurs.
4175 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4176 * larger than the actual read bytes because some optimized bitstream
4177 * readers read 32 or 64 bits at once and could read over the end.
4179 * @note You might have to align the input buffer. The alignment requirements
4180 * depend on the CPU and the decoder.
4182 * @param avctx the codec context
4183 * @param[out] frame The AVFrame in which to store decoded audio samples.
4184 * Decoders request a buffer of a particular size by setting
4185 * AVFrame.nb_samples prior to calling get_buffer(). The
4186 * decoder may, however, only utilize part of the buffer by
4187 * setting AVFrame.nb_samples to a smaller value in the
4189 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4191 * @param[in] avpkt The input AVPacket containing the input buffer.
4192 * At least avpkt->data and avpkt->size should be set. Some
4193 * decoders might also require additional fields to be set.
4194 * @return A negative error code is returned if an error occurred during
4195 * decoding, otherwise the number of bytes consumed from the input
4196 * AVPacket is returned.
4198 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4199 int *got_frame_ptr, AVPacket *avpkt);
4202 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4203 * Some decoders may support multiple frames in a single AVPacket, such
4204 * decoders would then just decode the first frame.
4206 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4207 * the actual read bytes because some optimized bitstream readers read 32 or 64
4208 * bits at once and could read over the end.
4210 * @warning The end of the input buffer buf should be set to 0 to ensure that
4211 * no overreading happens for damaged MPEG streams.
4213 * @note You might have to align the input buffer avpkt->data.
4214 * The alignment requirements depend on the CPU: on some CPUs it isn't
4215 * necessary at all, on others it won't work at all if not aligned and on others
4216 * it will work but it will have an impact on performance.
4218 * In practice, avpkt->data should have 4 byte alignment at minimum.
4220 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4221 * between input and output, these need to be fed with avpkt->data=NULL,
4222 * avpkt->size=0 at the end to return the remaining frames.
4224 * @param avctx the codec context
4225 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4226 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4227 * allocate memory for the actual bitmap.
4228 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4229 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4230 * decodes and the decoder tells the user once it does not need the data anymore,
4231 * the user app can at this point free/reuse/keep the memory as it sees fit.
4233 * @param[in] avpkt The input AVpacket containing the input buffer.
4234 * You can create such packet with av_init_packet() and by then setting
4235 * data and size, some decoders might in addition need other fields like
4236 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4238 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4239 * @return On error a negative value is returned, otherwise the number of bytes
4240 * used or zero if no frame could be decompressed.
4242 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4243 int *got_picture_ptr,
4247 * Decode a subtitle message.
4248 * Return a negative value on error, otherwise return the number of bytes used.
4249 * If no subtitle could be decompressed, got_sub_ptr is zero.
4250 * Otherwise, the subtitle is stored in *sub.
4251 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4252 * simplicity, because the performance difference is expect to be negligible
4253 * and reusing a get_buffer written for video codecs would probably perform badly
4254 * due to a potentially very different allocation pattern.
4256 * @param avctx the codec context
4257 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4258 freed with avsubtitle_free if *got_sub_ptr is set.
4259 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4260 * @param[in] avpkt The input AVPacket containing the input buffer.
4262 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4267 * Free all allocated data in the given subtitle struct.
4269 * @param sub AVSubtitle to free.
4271 void avsubtitle_free(AVSubtitle *sub);
4274 * Encode an audio frame from samples into buf.
4276 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4277 * However, for PCM audio the user will know how much space is needed
4278 * because it depends on the value passed in buf_size as described
4279 * below. In that case a lower value can be used.
4281 * @param avctx the codec context
4282 * @param[out] buf the output buffer
4283 * @param[in] buf_size the output buffer size
4284 * @param[in] samples the input buffer containing the samples
4285 * The number of samples read from this buffer is frame_size*channels,
4286 * both of which are defined in avctx.
4287 * For PCM audio the number of samples read from samples is equal to
4288 * buf_size * input_sample_size / output_sample_size.
4289 * @return On error a negative value is returned, on success zero or the number
4290 * of bytes used to encode the data read from the input buffer.
4292 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4293 const short *samples);
4296 * Encode a video frame from pict into buf.
4297 * The input picture should be
4298 * stored using a specific format, namely avctx.pix_fmt.
4300 * @param avctx the codec context
4301 * @param[out] buf the output buffer for the bitstream of encoded frame
4302 * @param[in] buf_size the size of the output buffer in bytes
4303 * @param[in] pict the input picture to encode
4304 * @return On error a negative value is returned, on success zero or the number
4305 * of bytes used from the output buffer.
4307 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4308 const AVFrame *pict);
4309 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4310 const AVSubtitle *sub);
4312 int avcodec_close(AVCodecContext *avctx);
4315 * Register all the codecs, parsers and bitstream filters which were enabled at
4316 * configuration time. If you do not call this function you can select exactly
4317 * which formats you want to support, by using the individual registration
4320 * @see avcodec_register
4321 * @see av_register_codec_parser
4322 * @see av_register_bitstream_filter
4324 void avcodec_register_all(void);
4327 * Flush buffers, should be called when seeking or when switching to a different stream.
4329 void avcodec_flush_buffers(AVCodecContext *avctx);
4331 void avcodec_default_free_buffers(AVCodecContext *s);
4333 /* misc useful functions */
4335 #if FF_API_OLD_FF_PICT_TYPES
4337 * Return a single letter to describe the given picture type pict_type.
4339 * @param[in] pict_type the picture type
4340 * @return A single character representing the picture type.
4341 * @deprecated Use av_get_picture_type_char() instead.
4343 attribute_deprecated
4344 char av_get_pict_type_char(int pict_type);
4348 * Return codec bits per sample.
4350 * @param[in] codec_id the codec
4351 * @return Number of bits per sample or zero if unknown for the given codec.
4353 int av_get_bits_per_sample(enum CodecID codec_id);
4355 #if FF_API_OLD_SAMPLE_FMT
4357 * @deprecated Use av_get_bytes_per_sample() instead.
4359 attribute_deprecated
4360 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4364 typedef struct AVCodecParserContext {
4366 struct AVCodecParser *parser;
4367 int64_t frame_offset; /* offset of the current frame */
4368 int64_t cur_offset; /* current offset
4369 (incremented by each av_parser_parse()) */
4370 int64_t next_frame_offset; /* offset of the next frame */
4372 int pict_type; /* XXX: Put it back in AVCodecContext. */
4374 * This field is used for proper frame duration computation in lavf.
4375 * It signals, how much longer the frame duration of the current frame
4376 * is compared to normal frame duration.
4378 * frame_duration = (1 + repeat_pict) * time_base
4380 * It is used by codecs like H.264 to display telecined material.
4382 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4383 int64_t pts; /* pts of the current frame */
4384 int64_t dts; /* dts of the current frame */
4389 int fetch_timestamp;
4391 #define AV_PARSER_PTS_NB 4
4392 int cur_frame_start_index;
4393 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4394 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4395 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4398 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4399 #define PARSER_FLAG_ONCE 0x0002
4400 /// Set if the parser has a valid file offset
4401 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4403 int64_t offset; ///< byte offset from starting packet start
4404 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4407 * Set by parser to 1 for key frames and 0 for non-key frames.
4408 * It is initialized to -1, so if the parser doesn't set this flag,
4409 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4415 * Time difference in stream time base units from the pts of this
4416 * packet to the point at which the output from the decoder has converged
4417 * independent from the availability of previous frames. That is, the
4418 * frames are virtually identical no matter if decoding started from
4419 * the very first frame or from this keyframe.
4420 * Is AV_NOPTS_VALUE if unknown.
4421 * This field is not the display duration of the current frame.
4422 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4425 * The purpose of this field is to allow seeking in streams that have no
4426 * keyframes in the conventional sense. It corresponds to the
4427 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4428 * essential for some types of subtitle streams to ensure that all
4429 * subtitles are correctly displayed after seeking.
4431 int64_t convergence_duration;
4433 // Timestamp generation support:
4435 * Synchronization point for start of timestamp generation.
4437 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4440 * For example, this corresponds to presence of H.264 buffering period
4446 * Offset of the current timestamp against last timestamp sync point in
4447 * units of AVCodecContext.time_base.
4449 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4450 * contain a valid timestamp offset.
4452 * Note that the timestamp of sync point has usually a nonzero
4453 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4454 * the next frame after timestamp sync point will be usually 1.
4456 * For example, this corresponds to H.264 cpb_removal_delay.
4458 int dts_ref_dts_delta;
4461 * Presentation delay of current frame in units of AVCodecContext.time_base.
4463 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4464 * contain valid non-negative timestamp delta (presentation time of a frame
4465 * must not lie in the past).
4467 * This delay represents the difference between decoding and presentation
4468 * time of the frame.
4470 * For example, this corresponds to H.264 dpb_output_delay.
4475 * Position of the packet in file.
4477 * Analogous to cur_frame_pts/dts
4479 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4482 * Byte position of currently parsed frame in stream.
4487 * Previous frame byte position.
4490 } AVCodecParserContext;
4492 typedef struct AVCodecParser {
4493 int codec_ids[5]; /* several codec IDs are permitted */
4495 int (*parser_init)(AVCodecParserContext *s);
4496 int (*parser_parse)(AVCodecParserContext *s,
4497 AVCodecContext *avctx,
4498 const uint8_t **poutbuf, int *poutbuf_size,
4499 const uint8_t *buf, int buf_size);
4500 void (*parser_close)(AVCodecParserContext *s);
4501 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4502 struct AVCodecParser *next;
4505 AVCodecParser *av_parser_next(AVCodecParser *c);
4507 void av_register_codec_parser(AVCodecParser *parser);
4508 AVCodecParserContext *av_parser_init(int codec_id);
4513 * @param s parser context.
4514 * @param avctx codec context.
4515 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4516 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4517 * @param buf input buffer.
4518 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4519 * @param pts input presentation timestamp.
4520 * @param dts input decoding timestamp.
4521 * @param pos input byte position in stream.
4522 * @return the number of bytes of the input bitstream used.
4527 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4534 * decode_frame(data, size);
4538 int av_parser_parse2(AVCodecParserContext *s,
4539 AVCodecContext *avctx,
4540 uint8_t **poutbuf, int *poutbuf_size,
4541 const uint8_t *buf, int buf_size,
4542 int64_t pts, int64_t dts,
4545 int av_parser_change(AVCodecParserContext *s,
4546 AVCodecContext *avctx,
4547 uint8_t **poutbuf, int *poutbuf_size,
4548 const uint8_t *buf, int buf_size, int keyframe);
4549 void av_parser_close(AVCodecParserContext *s);
4552 typedef struct AVBitStreamFilterContext {
4554 struct AVBitStreamFilter *filter;
4555 AVCodecParserContext *parser;
4556 struct AVBitStreamFilterContext *next;
4557 } AVBitStreamFilterContext;
4560 typedef struct AVBitStreamFilter {
4563 int (*filter)(AVBitStreamFilterContext *bsfc,
4564 AVCodecContext *avctx, const char *args,
4565 uint8_t **poutbuf, int *poutbuf_size,
4566 const uint8_t *buf, int buf_size, int keyframe);
4567 void (*close)(AVBitStreamFilterContext *bsfc);
4568 struct AVBitStreamFilter *next;
4569 } AVBitStreamFilter;
4571 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4572 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4573 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4574 AVCodecContext *avctx, const char *args,
4575 uint8_t **poutbuf, int *poutbuf_size,
4576 const uint8_t *buf, int buf_size, int keyframe);
4577 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4579 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4584 * Reallocate the given block if it is not large enough, otherwise do nothing.
4588 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4591 * Allocate a buffer, reusing the given one if large enough.
4593 * Contrary to av_fast_realloc the current buffer contents might not be
4594 * preserved and on error the old buffer is freed, thus no special
4595 * handling to avoid memleaks is necessary.
4597 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4598 * @param size size of the buffer *ptr points to
4599 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4600 * *size 0 if an error occurred.
4602 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4605 * Copy image src to dst. Wraps av_picture_data_copy() above.
4607 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4608 enum PixelFormat pix_fmt, int width, int height);
4611 * Crop image top and left side.
4613 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4614 enum PixelFormat pix_fmt, int top_band, int left_band);
4619 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4620 int padtop, int padbottom, int padleft, int padright, int *color);
4623 * Encode extradata length to a buffer. Used by xiph codecs.
4625 * @param s buffer to write to; must be at least (v/255+1) bytes long
4626 * @param v size of extradata in bytes
4627 * @return number of bytes written to the buffer.
4629 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4632 * Log a generic warning message about a missing feature. This function is
4633 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4634 * only, and would normally not be used by applications.
4635 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4636 * a pointer to an AVClass struct
4637 * @param[in] feature string containing the name of the missing feature
4638 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4639 * If want_sample is non-zero, additional verbage will be added to the log
4640 * message which tells the user how to report samples to the development
4643 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4646 * Log a generic warning message asking for a sample. This function is
4647 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4648 * only, and would normally not be used by applications.
4649 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4650 * a pointer to an AVClass struct
4651 * @param[in] msg string containing an optional message, or NULL if no message
4653 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4656 * Register the hardware accelerator hwaccel.
4658 void av_register_hwaccel(AVHWAccel *hwaccel);
4661 * If hwaccel is NULL, returns the first registered hardware accelerator,
4662 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4663 * after hwaccel, or NULL if hwaccel is the last one.
4665 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4669 * Lock operation used by lockmgr
4672 AV_LOCK_CREATE, ///< Create a mutex
4673 AV_LOCK_OBTAIN, ///< Lock the mutex
4674 AV_LOCK_RELEASE, ///< Unlock the mutex
4675 AV_LOCK_DESTROY, ///< Free mutex resources
4679 * Register a user provided lock manager supporting the operations
4680 * specified by AVLockOp. mutex points to a (void *) where the
4681 * lockmgr should store/get a pointer to a user allocated mutex. It's
4682 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4684 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4685 * callback during the call to av_lockmgr_register().
4686 * Thus, the application must be prepared to handle that.
4687 * If cb is set to NULL the lockmgr will be unregistered.
4688 * Also note that during unregistration the previously registered
4689 * lockmgr callback may also be invoked.
4691 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4694 * Get the type of the given codec.
4696 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4699 * Get the AVClass for AVCodecContext. It can be used in combination with
4700 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4702 * @see av_opt_find().
4704 const AVClass *avcodec_get_class(void);
4707 * Get the AVClass for AVFrame. It can be used in combination with
4708 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4710 * @see av_opt_find().
4712 const AVClass *avcodec_get_frame_class(void);
4714 #endif /* AVCODEC_AVCODEC_H */