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.
1033 * buffer age (1->was last buffer and dint change, 2->..., ...).
1034 * Set to INT_MAX if the buffer has not been used yet.
1035 * - encoding: unused
1036 * - decoding: MUST be set by get_buffer() for video.
1041 * is this picture used as reference
1042 * The values for this are the same as the MpegEncContext.picture_structure
1043 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1044 * Set to 4 for delayed, non-reference frames.
1045 * - encoding: unused
1046 * - decoding: Set by libavcodec. (before get_buffer() call)).
1052 * - encoding: unused
1053 * - decoding: Set by libavcodec.
1055 int8_t *qscale_table;
1058 * - encoding: unused
1059 * - decoding: Set by libavcodec.
1064 * mbskip_table[mb]>=1 if MB didn't change
1065 * stride= mb_width = (width+15)>>4
1066 * - encoding: unused
1067 * - decoding: Set by libavcodec.
1069 uint8_t *mbskip_table;
1072 * motion vector table
1075 * int mv_sample_log2= 4 - motion_subsample_log2;
1076 * int mb_width= (width+15)>>4;
1077 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1078 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1080 * - encoding: Set by user.
1081 * - decoding: Set by libavcodec.
1083 int16_t (*motion_val[2])[2];
1086 * macroblock type table
1087 * mb_type_base + mb_width + 2
1088 * - encoding: Set by user.
1089 * - decoding: Set by libavcodec.
1094 * log2 of the size of the block which a single vector in motion_val represents:
1095 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1096 * - encoding: unused
1097 * - decoding: Set by libavcodec.
1099 uint8_t motion_subsample_log2;
1102 * for some private data of the user
1103 * - encoding: unused
1104 * - decoding: Set by user.
1110 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1111 * - decoding: unused
1113 uint64_t error[AV_NUM_DATA_POINTERS];
1116 * type of the buffer (to keep track of who has to deallocate data[*])
1117 * - encoding: Set by the one who allocates it.
1118 * - decoding: Set by the one who allocates it.
1119 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1124 * When decoding, this signals how much the picture must be delayed.
1125 * extra_delay = repeat_pict / (2*fps)
1126 * - encoding: unused
1127 * - decoding: Set by libavcodec.
1137 * The content of the picture is interlaced.
1138 * - encoding: Set by user.
1139 * - decoding: Set by libavcodec. (default 0)
1141 int interlaced_frame;
1144 * If the content is interlaced, is top field displayed first.
1145 * - encoding: Set by user.
1146 * - decoding: Set by libavcodec.
1148 int top_field_first;
1152 * - encoding: Set by user.
1153 * - decoding: Set by libavcodec.
1155 AVPanScan *pan_scan;
1158 * Tell user application that palette has changed from previous frame.
1159 * - encoding: ??? (no palette-enabled encoder yet)
1160 * - decoding: Set by libavcodec. (default 0).
1162 int palette_has_changed;
1165 * codec suggestion on buffer type if != 0
1166 * - encoding: unused
1167 * - decoding: Set by libavcodec. (before get_buffer() call)).
1173 * - encoding: unused
1174 * - decoding: Set by libavcodec.
1179 * motion reference frame index
1180 * the order in which these are stored can depend on the codec.
1181 * - encoding: Set by user.
1182 * - decoding: Set by libavcodec.
1184 int8_t *ref_index[2];
1187 * reordered opaque 64bit (generally an integer or a double precision float
1188 * PTS but can be anything).
1189 * The user sets AVCodecContext.reordered_opaque to represent the input at
1191 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1192 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1193 * @deprecated in favor of pkt_pts
1194 * - encoding: unused
1195 * - decoding: Read by user.
1197 int64_t reordered_opaque;
1200 * hardware accelerator private data (FFmpeg-allocated)
1201 * - encoding: unused
1202 * - decoding: Set by libavcodec
1204 void *hwaccel_picture_private;
1207 * reordered pts from the last AVPacket that has been input into the decoder
1208 * - encoding: unused
1209 * - decoding: Read by user.
1214 * dts from the last AVPacket that has been input into the decoder
1215 * - encoding: unused
1216 * - decoding: Read by user.
1221 * the AVCodecContext which ff_thread_get_buffer() was last called on
1222 * - encoding: Set by libavcodec.
1223 * - decoding: Set by libavcodec.
1225 struct AVCodecContext *owner;
1228 * used by multithreading to store frame-specific info
1229 * - encoding: Set by libavcodec.
1230 * - decoding: Set by libavcodec.
1232 void *thread_opaque;
1235 * number of audio samples (per channel) described by this frame
1236 * - encoding: unused
1237 * - decoding: Set by libavcodec
1242 * pointers to the data planes/channels.
1244 * For video, this should simply point to data[].
1246 * For planar audio, each channel has a separate data pointer, and
1247 * linesize[0] contains the size of each channel buffer.
1248 * For packed audio, there is just one data pointer, and linesize[0]
1249 * contains the total size of the buffer for all channels.
1251 * Note: Both data and extended_data will always be set by get_buffer(),
1252 * but for planar audio with more channels that can fit in data,
1253 * extended_data must be used by the decoder in order to access all
1257 * decoding: set by AVCodecContext.get_buffer()
1259 uint8_t **extended_data;
1262 * frame timestamp estimated using various heuristics, in stream time base
1263 * Code outside libavcodec should access this field using:
1264 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1265 * - encoding: unused
1266 * - decoding: set by libavcodec, read by user.
1268 int64_t best_effort_timestamp;
1271 * reordered pos from the last AVPacket that has been input into the decoder
1272 * Code outside libavcodec should access this field using:
1273 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1274 * - encoding: unused
1275 * - decoding: Read by user.
1280 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1281 * Code outside libavcodec should access this field using:
1282 * av_opt_ptr(avcodec_get_frame_class(), frame, "sample_aspect_ratio");
1283 * - encoding: unused
1284 * - decoding: Read by user.
1286 AVRational sample_aspect_ratio;
1289 * width and height of the video frame
1290 * Code outside libavcodec should access this field using:
1291 * av_opt_ptr(avcodec_get_frame_class(), frame, "width");
1292 * - encoding: unused
1293 * - decoding: Read by user.
1298 * format of the frame, -1 if unknown or unset
1299 * It should be cast to the corresponding enum (enum PixelFormat
1300 * for video, enum AVSampleFormat for audio)
1301 * Code outside libavcodec should access this field using:
1302 * av_opt_ptr(avcodec_get_frame_class(), frame, "format");
1303 * - encoding: unused
1304 * - decoding: Read by user.
1310 struct AVCodecInternal;
1313 * main external API structure.
1314 * New fields can be added to the end with minor version bumps.
1315 * Removal, reordering and changes to existing fields require a major
1317 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1319 * sizeof(AVCodecContext) must not be used outside libav*.
1321 typedef struct AVCodecContext {
1323 * information on struct for av_log
1324 * - set by avcodec_alloc_context3
1326 const AVClass *av_class;
1328 * the average bitrate
1329 * - encoding: Set by user; unused for constant quantizer encoding.
1330 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1335 * number of bits the bitstream is allowed to diverge from the reference.
1336 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1337 * - encoding: Set by user; unused for constant quantizer encoding.
1338 * - decoding: unused
1340 int bit_rate_tolerance;
1344 * - encoding: Set by user.
1345 * - decoding: Set by user.
1350 * Some codecs need additional format info. It is stored here.
1351 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1352 * specific codec MUST set it correctly otherwise stream copy breaks.
1353 * In general use of this field by muxers is not recommended.
1354 * - encoding: Set by libavcodec.
1355 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1360 * Motion estimation algorithm used for video coding.
1361 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1362 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1363 * - encoding: MUST be set by user.
1364 * - decoding: unused
1369 * some codecs need / can use extradata like Huffman tables.
1370 * mjpeg: Huffman tables
1371 * rv10: additional flags
1372 * mpeg4: global headers (they can be in the bitstream or here)
1373 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1374 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1375 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1376 * - encoding: Set/allocated/freed by libavcodec.
1377 * - decoding: Set/allocated/freed by user.
1383 * This is the fundamental unit of time (in seconds) in terms
1384 * of which frame timestamps are represented. For fixed-fps content,
1385 * timebase should be 1/framerate and timestamp increments should be
1387 * - encoding: MUST be set by user.
1388 * - decoding: Set by libavcodec.
1390 AVRational time_base;
1394 * picture width / height.
1395 * - encoding: MUST be set by user.
1396 * - decoding: Set by libavcodec.
1397 * Note: For compatibility it is possible to set this instead of
1398 * coded_width/height before decoding.
1402 #define FF_ASPECT_EXTENDED 15
1405 * the number of pictures in a group of pictures, or 0 for intra_only
1406 * - encoding: Set by user.
1407 * - decoding: unused
1412 * Pixel format, see PIX_FMT_xxx.
1413 * May be set by the demuxer if known from headers.
1414 * May be overriden by the decoder if it knows better.
1415 * - encoding: Set by user.
1416 * - decoding: Set by user if known, overridden by libavcodec if known
1418 enum PixelFormat pix_fmt;
1421 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1422 * decoder to draw a horizontal band. It improves cache usage. Not
1423 * all codecs can do that. You must check the codec capabilities
1425 * When multithreading is used, it may be called from multiple threads
1426 * at the same time; threads might draw different parts of the same AVFrame,
1427 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1429 * The function is also used by hardware acceleration APIs.
1430 * It is called at least once during frame decoding to pass
1431 * the data needed for hardware render.
1432 * In that mode instead of pixel data, AVFrame points to
1433 * a structure specific to the acceleration API. The application
1434 * reads the structure and can change some fields to indicate progress
1436 * - encoding: unused
1437 * - decoding: Set by user.
1438 * @param height the height of the slice
1439 * @param y the y position of the slice
1440 * @param type 1->top field, 2->bottom field, 3->frame
1441 * @param offset offset into the AVFrame.data from which the slice should be read
1443 void (*draw_horiz_band)(struct AVCodecContext *s,
1444 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1445 int y, int type, int height);
1448 int sample_rate; ///< samples per second
1449 int channels; ///< number of audio channels
1452 * audio sample format
1453 * - encoding: Set by user.
1454 * - decoding: Set by libavcodec.
1456 enum AVSampleFormat sample_fmt; ///< sample format
1458 /* The following data should not be initialized. */
1460 * Samples per packet, initialized when calling 'init'.
1463 int frame_number; ///< audio or video frame number
1466 * Encoding: Number of frames delay there will be from the encoder input to
1467 * the decoder output. (we assume the decoder matches the spec)
1468 * Decoding: Number of frames delay in addition to what a standard decoder
1469 * as specified in the spec would produce.
1470 * - encoding: Set by libavcodec.
1471 * - decoding: Set by libavcodec.
1475 /* - encoding parameters */
1476 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1477 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1481 * - encoding: Set by user.
1482 * - decoding: unused
1488 * - encoding: Set by user.
1489 * - decoding: unused
1494 * maximum quantizer difference between frames
1495 * - encoding: Set by user.
1496 * - decoding: unused
1501 * maximum number of B-frames between non-B-frames
1502 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1503 * - encoding: Set by user.
1504 * - decoding: unused
1509 * qscale factor between IP and B-frames
1510 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1511 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1512 * - encoding: Set by user.
1513 * - decoding: unused
1515 float b_quant_factor;
1517 /** obsolete FIXME remove */
1519 #define FF_RC_STRATEGY_XVID 1
1521 int b_frame_strategy;
1523 struct AVCodec *codec;
1527 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1528 /* do its best to deliver a chunk with size */
1529 /* below rtp_payload_size, the chunk will start */
1530 /* with a start code on some codecs like H.263. */
1531 /* This doesn't take account of any particular */
1532 /* headers inside the transmitted RTP payload. */
1535 /* The RTP callback: This function is called */
1536 /* every time the encoder has a packet to send. */
1537 /* It depends on the encoder if the data starts */
1538 /* with a Start Code (it should). H.263 does. */
1539 /* mb_nb contains the number of macroblocks */
1540 /* encoded in the RTP payload. */
1541 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1543 /* statistics, used for 2-pass encoding */
1554 * number of bits used for the previously encoded frame
1555 * - encoding: Set by libavcodec.
1556 * - decoding: unused
1561 * Private data of the user, can be used to carry app specific stuff.
1562 * - encoding: Set by user.
1563 * - decoding: Set by user.
1567 char codec_name[32];
1568 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1569 enum CodecID codec_id; /* see CODEC_ID_xxx */
1572 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1573 * This is used to work around some encoder bugs.
1574 * A demuxer should set this to what is stored in the field used to identify the codec.
1575 * If there are multiple such fields in a container then the demuxer should choose the one
1576 * which maximizes the information about the used codec.
1577 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1578 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1579 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1581 * - encoding: Set by user, if not then the default based on codec_id will be used.
1582 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1584 unsigned int codec_tag;
1587 * Work around bugs in encoders which sometimes cannot be detected automatically.
1588 * - encoding: Set by user
1589 * - decoding: Set by user
1591 int workaround_bugs;
1592 #define FF_BUG_AUTODETECT 1 ///< autodetection
1593 #define FF_BUG_OLD_MSMPEG4 2
1594 #define FF_BUG_XVID_ILACE 4
1595 #define FF_BUG_UMP4 8
1596 #define FF_BUG_NO_PADDING 16
1597 #define FF_BUG_AMV 32
1598 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1599 #define FF_BUG_QPEL_CHROMA 64
1600 #define FF_BUG_STD_QPEL 128
1601 #define FF_BUG_QPEL_CHROMA2 256
1602 #define FF_BUG_DIRECT_BLOCKSIZE 512
1603 #define FF_BUG_EDGE 1024
1604 #define FF_BUG_HPEL_CHROMA 2048
1605 #define FF_BUG_DC_CLIP 4096
1606 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1607 #define FF_BUG_TRUNCATED 16384
1608 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1611 * luma single coefficient elimination threshold
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 int luma_elim_threshold;
1618 * chroma single coeff elimination threshold
1619 * - encoding: Set by user.
1620 * - decoding: unused
1622 int chroma_elim_threshold;
1625 * strictly follow the standard (MPEG4, ...).
1626 * - encoding: Set by user.
1627 * - decoding: Set by user.
1628 * Setting this to STRICT or higher means the encoder and decoder will
1629 * generally do stupid things, whereas setting it to unofficial or lower
1630 * will mean the encoder might produce output that is not supported by all
1631 * spec-compliant decoders. Decoders don't differentiate between normal,
1632 * unofficial and experimental (that is, they always try to decode things
1633 * when they can) unless they are explicitly asked to behave stupidly
1634 * (=strictly conform to the specs)
1636 int strict_std_compliance;
1637 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1638 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1639 #define FF_COMPLIANCE_NORMAL 0
1640 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1641 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1644 * qscale offset between IP and B-frames
1645 * - encoding: Set by user.
1646 * - decoding: unused
1648 float b_quant_offset;
1652 * Error recognition; higher values will detect more errors but may
1653 * misdetect some more or less valid parts as errors.
1654 * - encoding: unused
1655 * - decoding: Set by user.
1657 attribute_deprecated int error_recognition;
1658 #define FF_ER_CAREFUL 1
1659 #define FF_ER_COMPLIANT 2
1660 #define FF_ER_AGGRESSIVE 3
1661 #define FF_ER_VERY_AGGRESSIVE 4
1662 #define FF_ER_EXPLODE 5
1663 #endif /* FF_API_ER */
1666 * Called at the beginning of each frame to get a buffer for it.
1668 * The function will set AVFrame.data[], AVFrame.linesize[].
1669 * AVFrame.extended_data[] must also be set, but it should be the same as
1670 * AVFrame.data[] except for planar audio with more channels than can fit
1671 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1672 * many data pointers as it can hold.
1674 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1675 * avcodec_default_get_buffer() instead of providing buffers allocated by
1678 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1679 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1680 * but if get_buffer() is overridden then alignment considerations should
1681 * be taken into account.
1683 * @see avcodec_default_get_buffer()
1687 * If pic.reference is set then the frame will be read later by libavcodec.
1688 * avcodec_align_dimensions2() should be used to find the required width and
1689 * height, as they normally need to be rounded up to the next multiple of 16.
1691 * If frame multithreading is used and thread_safe_callbacks is set,
1692 * it may be called from a different thread, but not from more than one at
1693 * once. Does not need to be reentrant.
1695 * @see release_buffer(), reget_buffer()
1696 * @see avcodec_align_dimensions2()
1700 * Decoders request a buffer of a particular size by setting
1701 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1702 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1703 * to a smaller value in the output frame.
1705 * Decoders cannot use the buffer after returning from
1706 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1707 * is assumed to be released immediately upon return.
1709 * As a convenience, av_samples_get_buffer_size() and
1710 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1711 * functions to find the required data size and to fill data pointers and
1712 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1713 * since all planes must be the same size.
1715 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1717 * - encoding: unused
1718 * - decoding: Set by libavcodec, user can override.
1720 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1723 * Called to release buffers which were allocated with get_buffer.
1724 * A released buffer can be reused in get_buffer().
1725 * pic.data[*] must be set to NULL.
1726 * May be called from a different thread if frame multithreading is used,
1727 * but not by more than one thread at once, so does not need to be reentrant.
1728 * - encoding: unused
1729 * - decoding: Set by libavcodec, user can override.
1731 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1734 * Size of the frame reordering buffer in the decoder.
1735 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1736 * - encoding: Set by libavcodec.
1737 * - decoding: Set by libavcodec.
1742 * number of bytes per packet if constant and known or 0
1743 * Used by some WAV based audio codecs.
1747 #if FF_API_PARSE_FRAME
1749 * If true, only parsing is done. The frame data is returned.
1750 * Only MPEG audio decoders support this now.
1751 * - encoding: unused
1752 * - decoding: Set by user
1754 attribute_deprecated int parse_only;
1758 * 0-> h263 quant 1-> mpeg quant
1759 * - encoding: Set by user.
1760 * - decoding: unused
1765 * pass1 encoding statistics output buffer
1766 * - encoding: Set by libavcodec.
1767 * - decoding: unused
1772 * pass2 encoding statistics input buffer
1773 * Concatenated stuff from stats_out of pass1 should be placed here.
1774 * - encoding: Allocated/set/freed by user.
1775 * - decoding: unused
1780 * ratecontrol qmin qmax limiting method
1781 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1782 * - encoding: Set by user.
1783 * - decoding: unused
1791 * ratecontrol override, see RcOverride
1792 * - encoding: Allocated/set/freed by user.
1793 * - decoding: unused
1795 RcOverride *rc_override;
1796 int rc_override_count;
1799 * rate control equation
1800 * - encoding: Set by user
1801 * - decoding: unused
1807 * - encoding: Set by user.
1808 * - decoding: unused
1814 * - encoding: Set by user.
1815 * - decoding: unused
1820 * decoder bitstream buffer size
1821 * - encoding: Set by user.
1822 * - decoding: unused
1825 float rc_buffer_aggressivity;
1828 * qscale factor between P and I-frames
1829 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1830 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1831 * - encoding: Set by user.
1832 * - decoding: unused
1834 float i_quant_factor;
1837 * qscale offset between P and I-frames
1838 * - encoding: Set by user.
1839 * - decoding: unused
1841 float i_quant_offset;
1844 * initial complexity for pass1 ratecontrol
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 float rc_initial_cplx;
1851 * DCT algorithm, see FF_DCT_* below
1852 * - encoding: Set by user.
1853 * - decoding: unused
1856 #define FF_DCT_AUTO 0
1857 #define FF_DCT_FASTINT 1
1858 #define FF_DCT_INT 2
1859 #define FF_DCT_MMX 3
1860 #define FF_DCT_MLIB 4
1861 #define FF_DCT_ALTIVEC 5
1862 #define FF_DCT_FAAN 6
1865 * luminance masking (0-> disabled)
1866 * - encoding: Set by user.
1867 * - decoding: unused
1872 * temporary complexity masking (0-> disabled)
1873 * - encoding: Set by user.
1874 * - decoding: unused
1876 float temporal_cplx_masking;
1879 * spatial complexity masking (0-> disabled)
1880 * - encoding: Set by user.
1881 * - decoding: unused
1883 float spatial_cplx_masking;
1886 * p block masking (0-> disabled)
1887 * - encoding: Set by user.
1888 * - decoding: unused
1893 * darkness masking (0-> disabled)
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * IDCT algorithm, see FF_IDCT_* below.
1901 * - encoding: Set by user.
1902 * - decoding: Set by user.
1905 #define FF_IDCT_AUTO 0
1906 #define FF_IDCT_INT 1
1907 #define FF_IDCT_SIMPLE 2
1908 #define FF_IDCT_SIMPLEMMX 3
1909 #define FF_IDCT_LIBMPEG2MMX 4
1910 #define FF_IDCT_PS2 5
1911 #define FF_IDCT_MLIB 6
1912 #define FF_IDCT_ARM 7
1913 #define FF_IDCT_ALTIVEC 8
1914 #define FF_IDCT_SH4 9
1915 #define FF_IDCT_SIMPLEARM 10
1916 #define FF_IDCT_H264 11
1917 #define FF_IDCT_VP3 12
1918 #define FF_IDCT_IPP 13
1919 #define FF_IDCT_XVIDMMX 14
1920 #define FF_IDCT_CAVS 15
1921 #define FF_IDCT_SIMPLEARMV5TE 16
1922 #define FF_IDCT_SIMPLEARMV6 17
1923 #define FF_IDCT_SIMPLEVIS 18
1924 #define FF_IDCT_WMV2 19
1925 #define FF_IDCT_FAAN 20
1926 #define FF_IDCT_EA 21
1927 #define FF_IDCT_SIMPLENEON 22
1928 #define FF_IDCT_SIMPLEALPHA 23
1929 #define FF_IDCT_BINK 24
1933 * - encoding: Set by libavcodec.
1934 * - decoding: Set by user (or 0).
1938 * slice offsets in the frame in bytes
1939 * - encoding: Set/allocated by libavcodec.
1940 * - decoding: Set/allocated by user (or NULL).
1945 * error concealment flags
1946 * - encoding: unused
1947 * - decoding: Set by user.
1949 int error_concealment;
1950 #define FF_EC_GUESS_MVS 1
1951 #define FF_EC_DEBLOCK 2
1954 * dsp_mask could be add used to disable unwanted CPU features
1955 * CPU features (i.e. MMX, SSE. ...)
1957 * With the FORCE flag you may instead enable given CPU features.
1958 * (Dangerous: Usable in case of misdetection, improper usage however will
1959 * result into program crash.)
1964 * bits per sample/pixel from the demuxer (needed for huffyuv).
1965 * - encoding: Set by libavcodec.
1966 * - decoding: Set by user.
1968 int bits_per_coded_sample;
1971 * prediction method (needed for huffyuv)
1972 * - encoding: Set by user.
1973 * - decoding: unused
1975 int prediction_method;
1976 #define FF_PRED_LEFT 0
1977 #define FF_PRED_PLANE 1
1978 #define FF_PRED_MEDIAN 2
1981 * sample aspect ratio (0 if unknown)
1982 * That is the width of a pixel divided by the height of the pixel.
1983 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1984 * - encoding: Set by user.
1985 * - decoding: Set by libavcodec.
1987 AVRational sample_aspect_ratio;
1990 * the picture in the bitstream
1991 * - encoding: Set by libavcodec.
1992 * - decoding: Set by libavcodec.
1994 AVFrame *coded_frame;
1998 * - encoding: Set by user.
1999 * - decoding: Set by user.
2002 #define FF_DEBUG_PICT_INFO 1
2003 #define FF_DEBUG_RC 2
2004 #define FF_DEBUG_BITSTREAM 4
2005 #define FF_DEBUG_MB_TYPE 8
2006 #define FF_DEBUG_QP 16
2007 #define FF_DEBUG_MV 32
2008 #define FF_DEBUG_DCT_COEFF 0x00000040
2009 #define FF_DEBUG_SKIP 0x00000080
2010 #define FF_DEBUG_STARTCODE 0x00000100
2011 #define FF_DEBUG_PTS 0x00000200
2012 #define FF_DEBUG_ER 0x00000400
2013 #define FF_DEBUG_MMCO 0x00000800
2014 #define FF_DEBUG_BUGS 0x00001000
2015 #define FF_DEBUG_VIS_QP 0x00002000
2016 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2017 #define FF_DEBUG_BUFFERS 0x00008000
2018 #define FF_DEBUG_THREADS 0x00010000
2022 * - encoding: Set by user.
2023 * - decoding: Set by user.
2026 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2027 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2028 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2032 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2033 * - decoding: unused
2035 uint64_t error[AV_NUM_DATA_POINTERS];
2038 * motion estimation comparison function
2039 * - encoding: Set by user.
2040 * - decoding: unused
2044 * subpixel motion estimation comparison function
2045 * - encoding: Set by user.
2046 * - decoding: unused
2050 * macroblock comparison function (not supported yet)
2051 * - encoding: Set by user.
2052 * - decoding: unused
2056 * interlaced DCT comparison function
2057 * - encoding: Set by user.
2058 * - decoding: unused
2061 #define FF_CMP_SAD 0
2062 #define FF_CMP_SSE 1
2063 #define FF_CMP_SATD 2
2064 #define FF_CMP_DCT 3
2065 #define FF_CMP_PSNR 4
2066 #define FF_CMP_BIT 5
2068 #define FF_CMP_ZERO 7
2069 #define FF_CMP_VSAD 8
2070 #define FF_CMP_VSSE 9
2071 #define FF_CMP_NSSE 10
2072 #define FF_CMP_W53 11
2073 #define FF_CMP_W97 12
2074 #define FF_CMP_DCTMAX 13
2075 #define FF_CMP_DCT264 14
2076 #define FF_CMP_CHROMA 256
2079 * ME diamond size & shape
2080 * - encoding: Set by user.
2081 * - decoding: unused
2086 * amount of previous MV predictors (2a+1 x 2a+1 square)
2087 * - encoding: Set by user.
2088 * - decoding: unused
2090 int last_predictor_count;
2093 * prepass for motion estimation
2094 * - encoding: Set by user.
2095 * - decoding: unused
2100 * motion estimation prepass comparison function
2101 * - encoding: Set by user.
2102 * - decoding: unused
2107 * ME prepass diamond size & shape
2108 * - encoding: Set by user.
2109 * - decoding: unused
2115 * - encoding: Set by user.
2116 * - decoding: unused
2118 int me_subpel_quality;
2121 * callback to negotiate the pixelFormat
2122 * @param fmt is the list of formats which are supported by the codec,
2123 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2124 * The first is always the native one.
2125 * @return the chosen format
2126 * - encoding: unused
2127 * - decoding: Set by user, if not set the native format will be chosen.
2129 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2132 * DTG active format information (additional aspect ratio
2133 * information only used in DVB MPEG-2 transport streams)
2136 * - encoding: unused
2137 * - decoding: Set by decoder.
2139 int dtg_active_format;
2140 #define FF_DTG_AFD_SAME 8
2141 #define FF_DTG_AFD_4_3 9
2142 #define FF_DTG_AFD_16_9 10
2143 #define FF_DTG_AFD_14_9 11
2144 #define FF_DTG_AFD_4_3_SP_14_9 13
2145 #define FF_DTG_AFD_16_9_SP_14_9 14
2146 #define FF_DTG_AFD_SP_4_3 15
2149 * maximum motion estimation search range in subpel units
2150 * If 0 then no limit.
2152 * - encoding: Set by user.
2153 * - decoding: unused
2158 * intra quantizer bias
2159 * - encoding: Set by user.
2160 * - decoding: unused
2162 int intra_quant_bias;
2163 #define FF_DEFAULT_QUANT_BIAS 999999
2166 * inter quantizer bias
2167 * - encoding: Set by user.
2168 * - decoding: unused
2170 int inter_quant_bias;
2174 * - encoding: unused
2175 * - decoding: Which clrtable should be used for 8bit RGB images.
2176 * Tables have to be stored somewhere. FIXME
2180 #if FF_API_INTERNAL_CONTEXT
2182 * internal_buffer count
2183 * Don't touch, used by libavcodec default_get_buffer().
2184 * @deprecated this field was moved to an internal context
2186 attribute_deprecated int internal_buffer_count;
2190 * Don't touch, used by libavcodec default_get_buffer().
2191 * @deprecated this field was moved to an internal context
2193 attribute_deprecated void *internal_buffer;
2197 * Global quality for codecs which cannot change it per frame.
2198 * This should be proportional to MPEG-1/2/4 qscale.
2199 * - encoding: Set by user.
2200 * - decoding: unused
2204 #define FF_CODER_TYPE_VLC 0
2205 #define FF_CODER_TYPE_AC 1
2206 #define FF_CODER_TYPE_RAW 2
2207 #define FF_CODER_TYPE_RLE 3
2208 #define FF_CODER_TYPE_DEFLATE 4
2211 * - encoding: Set by user.
2212 * - decoding: unused
2218 * - encoding: Set by user.
2219 * - decoding: unused
2225 * - encoding: unused
2226 * - decoding: Set by user.
2228 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2233 * - encoding: unused
2234 * - decoding: Set by user.
2237 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2238 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2239 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2242 * XVideo Motion Acceleration
2243 * - encoding: forbidden
2244 * - decoding: set by decoder
2246 int xvmc_acceleration;
2249 * macroblock decision mode
2250 * - encoding: Set by user.
2251 * - decoding: unused
2254 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2255 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2256 #define FF_MB_DECISION_RD 2 ///< rate distortion
2259 * custom intra quantization matrix
2260 * - encoding: Set by user, can be NULL.
2261 * - decoding: Set by libavcodec.
2263 uint16_t *intra_matrix;
2266 * custom inter quantization matrix
2267 * - encoding: Set by user, can be NULL.
2268 * - decoding: Set by libavcodec.
2270 uint16_t *inter_matrix;
2273 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2274 * This is used to work around some encoder bugs.
2275 * - encoding: unused
2276 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2278 unsigned int stream_codec_tag;
2281 * scene change detection threshold
2282 * 0 is default, larger means fewer detected scene changes.
2283 * - encoding: Set by user.
2284 * - decoding: unused
2286 int scenechange_threshold;
2289 * minimum Lagrange multipler
2290 * - encoding: Set by user.
2291 * - decoding: unused
2296 * maximum Lagrange multipler
2297 * - encoding: Set by user.
2298 * - decoding: unused
2302 #if FF_API_PALETTE_CONTROL
2304 * palette control structure
2305 * - encoding: ??? (no palette-enabled encoder yet)
2306 * - decoding: Set by user.
2308 struct AVPaletteControl *palctrl;
2312 * noise reduction strength
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int noise_reduction;
2319 * Called at the beginning of a frame to get cr buffer for it.
2320 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2321 * libavcodec will pass previous buffer in pic, function should return
2322 * same buffer or new buffer with old frame "painted" into it.
2323 * If pic.data[0] == NULL must behave like get_buffer().
2324 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2325 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2327 * - encoding: unused
2328 * - decoding: Set by libavcodec, user can override.
2330 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2333 * Number of bits which should be loaded into the rc buffer before decoding starts.
2334 * - encoding: Set by user.
2335 * - decoding: unused
2337 int rc_initial_buffer_occupancy;
2341 * - encoding: Set by user.
2342 * - decoding: unused
2344 int inter_threshold;
2348 * - encoding: Set by user.
2349 * - decoding: Set by user.
2354 * Simulates errors in the bitstream to test error concealment.
2355 * - encoding: Set by user.
2356 * - decoding: unused
2360 #if FF_API_ANTIALIAS_ALGO
2362 * MP3 antialias algorithm, see FF_AA_* below.
2363 * - encoding: unused
2364 * - decoding: Set by user.
2366 attribute_deprecated int antialias_algo;
2367 #define FF_AA_AUTO 0
2368 #define FF_AA_FASTINT 1 //not implemented yet
2370 #define FF_AA_FLOAT 3
2374 * quantizer noise shaping
2375 * - encoding: Set by user.
2376 * - decoding: unused
2378 int quantizer_noise_shaping;
2382 * is used to decide how many independent tasks should be passed to execute()
2383 * - encoding: Set by user.
2384 * - decoding: Set by user.
2389 * The codec may call this to execute several independent things.
2390 * It will return only after finishing all tasks.
2391 * The user may replace this with some multithreaded implementation,
2392 * the default implementation will execute the parts serially.
2393 * @param count the number of things to execute
2394 * - encoding: Set by libavcodec, user can override.
2395 * - decoding: Set by libavcodec, user can override.
2397 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2401 * Can be used by execute() to store some per AVCodecContext stuff.
2402 * - encoding: set by execute()
2403 * - decoding: set by execute()
2405 void *thread_opaque;
2408 * Motion estimation threshold below which no motion estimation is
2409 * performed, but instead the user specified motion vectors are used.
2411 * - encoding: Set by user.
2412 * - decoding: unused
2417 * Macroblock threshold below which the user specified macroblock types will be used.
2418 * - encoding: Set by user.
2419 * - decoding: unused
2424 * precision of the intra DC coefficient - 8
2425 * - encoding: Set by user.
2426 * - decoding: unused
2428 int intra_dc_precision;
2431 * noise vs. sse weight for the nsse comparsion function
2432 * - encoding: Set by user.
2433 * - decoding: unused
2438 * Number of macroblock rows at the top which are skipped.
2439 * - encoding: unused
2440 * - decoding: Set by user.
2445 * Number of macroblock rows at the bottom which are skipped.
2446 * - encoding: unused
2447 * - decoding: Set by user.
2453 * - encoding: Set by user.
2454 * - decoding: Set by libavcodec.
2457 #define FF_PROFILE_UNKNOWN -99
2458 #define FF_PROFILE_RESERVED -100
2460 #define FF_PROFILE_AAC_MAIN 0
2461 #define FF_PROFILE_AAC_LOW 1
2462 #define FF_PROFILE_AAC_SSR 2
2463 #define FF_PROFILE_AAC_LTP 3
2465 #define FF_PROFILE_DTS 20
2466 #define FF_PROFILE_DTS_ES 30
2467 #define FF_PROFILE_DTS_96_24 40
2468 #define FF_PROFILE_DTS_HD_HRA 50
2469 #define FF_PROFILE_DTS_HD_MA 60
2471 #define FF_PROFILE_MPEG2_422 0
2472 #define FF_PROFILE_MPEG2_HIGH 1
2473 #define FF_PROFILE_MPEG2_SS 2
2474 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2475 #define FF_PROFILE_MPEG2_MAIN 4
2476 #define FF_PROFILE_MPEG2_SIMPLE 5
2478 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2479 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2481 #define FF_PROFILE_H264_BASELINE 66
2482 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2483 #define FF_PROFILE_H264_MAIN 77
2484 #define FF_PROFILE_H264_EXTENDED 88
2485 #define FF_PROFILE_H264_HIGH 100
2486 #define FF_PROFILE_H264_HIGH_10 110
2487 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2488 #define FF_PROFILE_H264_HIGH_422 122
2489 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2490 #define FF_PROFILE_H264_HIGH_444 144
2491 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2492 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2493 #define FF_PROFILE_H264_CAVLC_444 44
2495 #define FF_PROFILE_VC1_SIMPLE 0
2496 #define FF_PROFILE_VC1_MAIN 1
2497 #define FF_PROFILE_VC1_COMPLEX 2
2498 #define FF_PROFILE_VC1_ADVANCED 3
2500 #define FF_PROFILE_MPEG4_SIMPLE 0
2501 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2502 #define FF_PROFILE_MPEG4_CORE 2
2503 #define FF_PROFILE_MPEG4_MAIN 3
2504 #define FF_PROFILE_MPEG4_N_BIT 4
2505 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2506 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2507 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2508 #define FF_PROFILE_MPEG4_HYBRID 8
2509 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2510 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2511 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2512 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2513 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2514 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2515 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2519 * - encoding: Set by user.
2520 * - decoding: Set by libavcodec.
2523 #define FF_LEVEL_UNKNOWN -99
2526 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2527 * - encoding: unused
2528 * - decoding: Set by user.
2533 * Bitstream width / height, may be different from width/height if lowres enabled.
2534 * - encoding: unused
2535 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2537 int coded_width, coded_height;
2540 * frame skip threshold
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 int frame_skip_threshold;
2548 * - encoding: Set by user.
2549 * - decoding: unused
2551 int frame_skip_factor;
2554 * frame skip exponent
2555 * - encoding: Set by user.
2556 * - decoding: unused
2561 * frame skip comparison function
2562 * - encoding: Set by user.
2563 * - decoding: unused
2568 * Border processing masking, raises the quantizer for mbs on the borders
2570 * - encoding: Set by user.
2571 * - decoding: unused
2573 float border_masking;
2576 * minimum MB lagrange multipler
2577 * - encoding: Set by user.
2578 * - decoding: unused
2583 * maximum MB lagrange multipler
2584 * - encoding: Set by user.
2585 * - decoding: unused
2591 * - encoding: Set by user.
2592 * - decoding: unused
2594 int me_penalty_compensation;
2598 * - encoding: unused
2599 * - decoding: Set by user.
2601 enum AVDiscard skip_loop_filter;
2605 * - encoding: unused
2606 * - decoding: Set by user.
2608 enum AVDiscard skip_idct;
2612 * - encoding: unused
2613 * - decoding: Set by user.
2615 enum AVDiscard skip_frame;
2619 * - encoding: Set by user.
2620 * - decoding: unused
2626 * - encoding: Set by user.
2627 * - decoding: unused
2631 #if FF_API_X264_GLOBAL_OPTS
2633 * constant rate factor - quality-based VBR - values ~correspond to qps
2634 * - encoding: Set by user.
2635 * - decoding: unused
2636 * @deprecated use 'crf' libx264 private option
2638 attribute_deprecated float crf;
2641 * constant quantization parameter rate control method
2642 * - encoding: Set by user.
2643 * - decoding: unused
2644 * @deprecated use 'cqp' libx264 private option
2646 attribute_deprecated int cqp;
2651 * - encoding: Set by user.
2652 * - decoding: unused
2657 * number of reference frames
2658 * - encoding: Set by user.
2659 * - decoding: Set by lavc.
2664 * chroma qp offset from luma
2665 * - encoding: Set by user.
2666 * - decoding: unused
2670 #if FF_API_X264_GLOBAL_OPTS
2672 * Influence how often B-frames are used.
2673 * - encoding: Set by user.
2674 * - decoding: unused
2676 attribute_deprecated int bframebias;
2680 * trellis RD quantization
2681 * - encoding: Set by user.
2682 * - decoding: unused
2686 #if FF_API_X264_GLOBAL_OPTS
2688 * Reduce fluctuations in qp (before curve compression).
2689 * - encoding: Set by user.
2690 * - decoding: unused
2692 attribute_deprecated float complexityblur;
2695 * in-loop deblocking filter alphac0 parameter
2696 * alpha is in the range -6...6
2697 * - encoding: Set by user.
2698 * - decoding: unused
2700 attribute_deprecated int deblockalpha;
2703 * in-loop deblocking filter beta parameter
2704 * beta is in the range -6...6
2705 * - encoding: Set by user.
2706 * - decoding: unused
2708 attribute_deprecated int deblockbeta;
2711 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2712 * - encoding: Set by user.
2713 * - decoding: unused
2715 attribute_deprecated int partitions;
2716 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2717 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2718 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2719 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2720 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2723 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2724 * - encoding: Set by user.
2725 * - decoding: unused
2727 attribute_deprecated int directpred;
2731 * Audio cutoff bandwidth (0 means "automatic")
2732 * - encoding: Set by user.
2733 * - decoding: unused
2738 * Multiplied by qscale for each frame and added to scene_change_score.
2739 * - encoding: Set by user.
2740 * - decoding: unused
2742 int scenechange_factor;
2746 * Note: Value depends upon the compare function used for fullpel ME.
2747 * - encoding: Set by user.
2748 * - decoding: unused
2753 * Adjust sensitivity of b_frame_strategy 1.
2754 * - encoding: Set by user.
2755 * - decoding: unused
2760 * - encoding: Set by user.
2761 * - decoding: unused
2763 int compression_level;
2764 #define FF_COMPRESSION_DEFAULT -1
2767 * - encoding: Set by user.
2768 * - decoding: unused
2770 int min_prediction_order;
2773 * - encoding: Set by user.
2774 * - decoding: unused
2776 int max_prediction_order;
2778 #if FF_API_FLAC_GLOBAL_OPTS
2780 * @name FLAC options
2781 * @deprecated Use FLAC encoder private options instead.
2786 * LPC coefficient precision - used by FLAC encoder
2787 * - encoding: Set by user.
2788 * - decoding: unused
2790 attribute_deprecated int lpc_coeff_precision;
2793 * search method for selecting prediction order
2794 * - encoding: Set by user.
2795 * - decoding: unused
2797 attribute_deprecated int prediction_order_method;
2800 * - encoding: Set by user.
2801 * - decoding: unused
2803 attribute_deprecated int min_partition_order;
2806 * - encoding: Set by user.
2807 * - decoding: unused
2809 attribute_deprecated int max_partition_order;
2816 * GOP timecode frame start number
2817 * - encoding: Set by user, in non drop frame format
2818 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2820 int64_t timecode_frame_start;
2822 #if FF_API_REQUEST_CHANNELS
2824 * Decoder should decode to this many channels if it can (0 for default)
2825 * - encoding: unused
2826 * - decoding: Set by user.
2827 * @deprecated Deprecated in favor of request_channel_layout.
2829 int request_channels;
2832 #if FF_API_DRC_SCALE
2834 * Percentage of dynamic range compression to be applied by the decoder.
2835 * The default value is 1.0, corresponding to full compression.
2836 * - encoding: unused
2837 * - decoding: Set by user.
2838 * @deprecated use AC3 decoder private option instead.
2840 attribute_deprecated float drc_scale;
2844 * opaque 64bit number (generally a PTS) that will be reordered and
2845 * output in AVFrame.reordered_opaque
2846 * @deprecated in favor of pkt_pts
2847 * - encoding: unused
2848 * - decoding: Set by user.
2850 int64_t reordered_opaque;
2853 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2854 * - encoding: set by user.
2855 * - decoding: set by libavcodec.
2857 int bits_per_raw_sample;
2860 * Audio channel layout.
2861 * - encoding: set by user.
2862 * - decoding: set by user, may be overwritten by libavcodec.
2864 uint64_t channel_layout;
2867 * Request decoder to use this channel layout if it can (0 for default)
2868 * - encoding: unused
2869 * - decoding: Set by user.
2871 uint64_t request_channel_layout;
2874 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2875 * - encoding: Set by user.
2876 * - decoding: unused.
2878 float rc_max_available_vbv_use;
2881 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2882 * - encoding: Set by user.
2883 * - decoding: unused.
2885 float rc_min_vbv_overflow_use;
2888 * Hardware accelerator in use
2889 * - encoding: unused.
2890 * - decoding: Set by libavcodec
2892 struct AVHWAccel *hwaccel;
2895 * For some codecs, the time base is closer to the field rate than the frame rate.
2896 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2897 * if no telecine is used ...
2899 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2901 int ticks_per_frame;
2904 * Hardware accelerator context.
2905 * For some hardware accelerators, a global context needs to be
2906 * provided by the user. In that case, this holds display-dependent
2907 * data FFmpeg cannot instantiate itself. Please refer to the
2908 * FFmpeg HW accelerator documentation to know how to fill this
2909 * is. e.g. for VA API, this is a struct vaapi_context.
2910 * - encoding: unused
2911 * - decoding: Set by user
2913 void *hwaccel_context;
2916 * Chromaticity coordinates of the source primaries.
2917 * - encoding: Set by user
2918 * - decoding: Set by libavcodec
2920 enum AVColorPrimaries color_primaries;
2923 * Color Transfer Characteristic.
2924 * - encoding: Set by user
2925 * - decoding: Set by libavcodec
2927 enum AVColorTransferCharacteristic color_trc;
2930 * YUV colorspace type.
2931 * - encoding: Set by user
2932 * - decoding: Set by libavcodec
2934 enum AVColorSpace colorspace;
2937 * MPEG vs JPEG YUV range.
2938 * - encoding: Set by user
2939 * - decoding: Set by libavcodec
2941 enum AVColorRange color_range;
2944 * This defines the location of chroma samples.
2945 * - encoding: Set by user
2946 * - decoding: Set by libavcodec
2948 enum AVChromaLocation chroma_sample_location;
2951 * The codec may call this to execute several independent things.
2952 * It will return only after finishing all tasks.
2953 * The user may replace this with some multithreaded implementation,
2954 * the default implementation will execute the parts serially.
2955 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2956 * @param c context passed also to func
2957 * @param count the number of things to execute
2958 * @param arg2 argument passed unchanged to func
2959 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2960 * @param func function that will be called count times, with jobnr from 0 to count-1.
2961 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2962 * two instances of func executing at the same time will have the same threadnr.
2963 * @return always 0 currently, but code should handle a future improvement where when any call to func
2964 * returns < 0 no further calls to func may be done and < 0 is returned.
2965 * - encoding: Set by libavcodec, user can override.
2966 * - decoding: Set by libavcodec, user can override.
2968 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2970 #if FF_API_X264_GLOBAL_OPTS
2972 * explicit P-frame weighted prediction analysis method
2974 * 1: fast blind weighting (one reference duplicate with -1 offset)
2975 * 2: smart weighting (full fade detection analysis)
2976 * - encoding: Set by user.
2977 * - decoding: unused
2979 attribute_deprecated int weighted_p_pred;
2984 * 1: Variance AQ (complexity mask)
2985 * 2: Auto-variance AQ (experimental)
2986 * - encoding: Set by user
2987 * - decoding: unused
2989 attribute_deprecated int aq_mode;
2993 * Reduces blocking and blurring in flat and textured areas.
2994 * - encoding: Set by user
2995 * - decoding: unused
2997 attribute_deprecated float aq_strength;
3001 * Strength of psychovisual optimization
3002 * - encoding: Set by user
3003 * - decoding: unused
3005 attribute_deprecated float psy_rd;
3009 * Strength of psychovisual optimization
3010 * - encoding: Set by user
3011 * - decoding: unused
3013 attribute_deprecated float psy_trellis;
3017 * Number of frames for frametype and ratecontrol lookahead
3018 * - encoding: Set by user
3019 * - decoding: unused
3021 attribute_deprecated int rc_lookahead;
3024 * Constant rate factor maximum
3025 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
3026 * than crf_max, even if doing so would violate VBV restrictions.
3027 * - encoding: Set by user.
3028 * - decoding: unused
3030 attribute_deprecated float crf_max;
3033 int log_level_offset;
3035 #if FF_API_FLAC_GLOBAL_OPTS
3037 * Determine which LPC analysis algorithm to use.
3038 * - encoding: Set by user
3039 * - decoding: unused
3041 attribute_deprecated enum AVLPCType lpc_type;
3044 * Number of passes to use for Cholesky factorization during LPC analysis
3045 * - encoding: Set by user
3046 * - decoding: unused
3048 attribute_deprecated int lpc_passes;
3053 * Indicates number of picture subdivisions. Used for parallelized
3055 * - encoding: Set by user
3056 * - decoding: unused
3061 * Header containing style information for text subtitles.
3062 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3063 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3064 * the Format line following. It shouldn't include any Dialogue line.
3065 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3066 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3068 uint8_t *subtitle_header;
3069 int subtitle_header_size;
3072 * Current packet as passed into the decoder, to avoid having
3073 * to pass the packet into every function. Currently only valid
3074 * inside lavc and get/release_buffer callbacks.
3075 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3076 * - encoding: unused
3080 #if FF_API_INTERNAL_CONTEXT
3082 * Whether this is a copy of the context which had init() called on it.
3083 * This is used by multithreading - shared tables and picture pointers
3084 * should be freed from the original context only.
3085 * - encoding: Set by libavcodec.
3086 * - decoding: Set by libavcodec.
3088 * @deprecated this field has been moved to an internal context
3090 attribute_deprecated int is_copy;
3094 * Which multithreading methods to use.
3095 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3096 * so clients which cannot provide future frames should not use it.
3098 * - encoding: Set by user, otherwise the default is used.
3099 * - decoding: Set by user, otherwise the default is used.
3102 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3103 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3106 * Which multithreading methods are in use by the codec.
3107 * - encoding: Set by libavcodec.
3108 * - decoding: Set by libavcodec.
3110 int active_thread_type;
3113 * Set by the client if its custom get_buffer() callback can be called
3114 * from another thread, which allows faster multithreaded decoding.
3115 * draw_horiz_band() will be called from other threads regardless of this setting.
3116 * Ignored if the default get_buffer() is used.
3117 * - encoding: Set by user.
3118 * - decoding: Set by user.
3120 int thread_safe_callbacks;
3123 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3124 * Used for compliant TS muxing.
3125 * - encoding: Set by libavcodec.
3126 * - decoding: unused.
3131 * Type of service that the audio stream conveys.
3132 * - encoding: Set by user.
3133 * - decoding: Set by libavcodec.
3135 enum AVAudioServiceType audio_service_type;
3138 * desired sample format
3139 * - encoding: Not used.
3140 * - decoding: Set by user.
3141 * Decoder will decode to this format if it can.
3143 enum AVSampleFormat request_sample_fmt;
3146 * Error recognition; may misdetect some more or less valid parts as errors.
3147 * - encoding: unused
3148 * - decoding: Set by user.
3150 int err_recognition;
3151 #define AV_EF_CRCCHECK (1<<0)
3152 #define AV_EF_BITSTREAM (1<<1)
3153 #define AV_EF_BUFFER (1<<2)
3154 #define AV_EF_EXPLODE (1<<3)
3156 #define AV_EF_CAREFUL (1<<16)
3157 #define AV_EF_COMPLIANT (1<<17)
3158 #define AV_EF_AGGRESSIVE (1<<18)
3161 * Private context used for internal data.
3163 * Unlike priv_data, this is not codec-specific. It is used in general
3164 * libavcodec functions.
3166 struct AVCodecInternal *internal;
3169 * Current statistics for PTS correction.
3170 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3171 * - encoding: unused
3173 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3174 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3175 int64_t pts_correction_last_pts; /// PTS of the last frame
3176 int64_t pts_correction_last_dts; /// DTS of the last frame
3183 typedef struct AVProfile {
3185 const char *name; ///< short name for the profile
3188 typedef struct AVCodecDefault AVCodecDefault;
3193 typedef struct AVCodec {
3195 * Name of the codec implementation.
3196 * The name is globally unique among encoders and among decoders (but an
3197 * encoder and a decoder can share the same name).
3198 * This is the primary way to find a codec from the user perspective.
3201 enum AVMediaType type;
3204 int (*init)(AVCodecContext *);
3205 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3206 int (*close)(AVCodecContext *);
3207 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3209 * Codec capabilities.
3213 struct AVCodec *next;
3216 * Will be called when seeking
3218 void (*flush)(AVCodecContext *);
3219 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3220 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3222 * Descriptive name for the codec, meant to be more human readable than name.
3223 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3225 const char *long_name;
3226 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3227 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3228 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3229 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3230 const AVClass *priv_class; ///< AVClass for the private context
3231 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3234 * @name Frame-level threading support functions
3238 * If defined, called on thread contexts when they are created.
3239 * If the codec allocates writable tables in init(), re-allocate them here.
3240 * priv_data will be set to a copy of the original.
3242 int (*init_thread_copy)(AVCodecContext *);
3244 * Copy necessary context variables from a previous thread context to the current one.
3245 * If not defined, the next thread will start automatically; otherwise, the codec
3246 * must call ff_thread_finish_setup().
3248 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3250 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3254 * Private codec-specific defaults.
3256 const AVCodecDefault *defaults;
3259 * Initialize codec static data, called from avcodec_register().
3261 void (*init_static_data)(struct AVCodec *codec);
3267 typedef struct AVHWAccel {
3269 * Name of the hardware accelerated codec.
3270 * The name is globally unique among encoders and among decoders (but an
3271 * encoder and a decoder can share the same name).
3276 * Type of codec implemented by the hardware accelerator.
3278 * See AVMEDIA_TYPE_xxx
3280 enum AVMediaType type;
3283 * Codec implemented by the hardware accelerator.
3290 * Supported pixel format.
3292 * Only hardware accelerated formats are supported here.
3294 enum PixelFormat pix_fmt;
3297 * Hardware accelerated codec capabilities.
3298 * see FF_HWACCEL_CODEC_CAP_*
3302 struct AVHWAccel *next;
3305 * Called at the beginning of each frame or field picture.
3307 * Meaningful frame information (codec specific) is guaranteed to
3308 * be parsed at this point. This function is mandatory.
3310 * Note that buf can be NULL along with buf_size set to 0.
3311 * Otherwise, this means the whole frame is available at this point.
3313 * @param avctx the codec context
3314 * @param buf the frame data buffer base
3315 * @param buf_size the size of the frame in bytes
3316 * @return zero if successful, a negative value otherwise
3318 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3321 * Callback for each slice.
3323 * Meaningful slice information (codec specific) is guaranteed to
3324 * be parsed at this point. This function is mandatory.
3326 * @param avctx the codec context
3327 * @param buf the slice data buffer base
3328 * @param buf_size the size of the slice in bytes
3329 * @return zero if successful, a negative value otherwise
3331 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3334 * Called at the end of each frame or field picture.
3336 * The whole picture is parsed at this point and can now be sent
3337 * to the hardware accelerator. This function is mandatory.
3339 * @param avctx the codec context
3340 * @return zero if successful, a negative value otherwise
3342 int (*end_frame)(AVCodecContext *avctx);
3345 * Size of HW accelerator private data.
3347 * Private data is allocated with av_mallocz() before
3348 * AVCodecContext.get_buffer() and deallocated after
3349 * AVCodecContext.release_buffer().
3355 * four components are given, that's all.
3356 * the last component is alpha
3358 typedef struct AVPicture {
3359 uint8_t *data[AV_NUM_DATA_POINTERS];
3360 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3363 #define AVPALETTE_SIZE 1024
3364 #define AVPALETTE_COUNT 256
3365 #if FF_API_PALETTE_CONTROL
3368 * This structure defines a method for communicating palette changes
3369 * between and demuxer and a decoder.
3371 * @deprecated Use AVPacket to send palette changes instead.
3372 * This is totally broken.
3374 typedef struct AVPaletteControl {
3376 /* Demuxer sets this to 1 to indicate the palette has changed;
3377 * decoder resets to 0. */
3378 int palette_changed;
3380 /* 4-byte ARGB palette entries, stored in native byte order; note that
3381 * the individual palette components should be on a 8-bit scale; if
3382 * the palette data comes from an IBM VGA native format, the component
3383 * data is probably 6 bits in size and needs to be scaled. */
3384 unsigned int palette[AVPALETTE_COUNT];
3386 } AVPaletteControl attribute_deprecated;
3389 enum AVSubtitleType {
3392 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3395 * Plain text, the text field must be set by the decoder and is
3396 * authoritative. ass and pict fields may contain approximations.
3401 * Formatted text, the ass field must be set by the decoder and is
3402 * authoritative. pict and text fields may contain approximations.
3407 typedef struct AVSubtitleRect {
3408 int x; ///< top left corner of pict, undefined when pict is not set
3409 int y; ///< top left corner of pict, undefined when pict is not set
3410 int w; ///< width of pict, undefined when pict is not set
3411 int h; ///< height of pict, undefined when pict is not set
3412 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3415 * data+linesize for the bitmap of this subtitle.
3416 * can be set for text/ass as well once they where rendered
3419 enum AVSubtitleType type;
3421 char *text; ///< 0 terminated plain UTF-8 text
3424 * 0 terminated ASS/SSA compatible event line.
3425 * The pressentation of this is unaffected by the other values in this
3431 typedef struct AVSubtitle {
3432 uint16_t format; /* 0 = graphics */
3433 uint32_t start_display_time; /* relative to packet pts, in ms */
3434 uint32_t end_display_time; /* relative to packet pts, in ms */
3436 AVSubtitleRect **rects;
3437 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3440 /* packet functions */
3443 * @deprecated use NULL instead
3445 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3448 * Default packet destructor.
3450 void av_destruct_packet(AVPacket *pkt);
3453 * Initialize optional fields of a packet with default values.
3457 void av_init_packet(AVPacket *pkt);
3460 * Allocate the payload of a packet and initialize its fields with
3464 * @param size wanted payload size
3465 * @return 0 if OK, AVERROR_xxx otherwise
3467 int av_new_packet(AVPacket *pkt, int size);
3470 * Reduce packet size, correctly zeroing padding
3473 * @param size new size
3475 void av_shrink_packet(AVPacket *pkt, int size);
3478 * Increase packet size, correctly zeroing padding
3481 * @param grow_by number of bytes by which to increase the size of the packet
3483 int av_grow_packet(AVPacket *pkt, int grow_by);
3486 * @warning This is a hack - the packet memory allocation stuff is broken. The
3487 * packet is allocated if it was not really allocated.
3489 int av_dup_packet(AVPacket *pkt);
3494 * @param pkt packet to free
3496 void av_free_packet(AVPacket *pkt);
3499 * Allocate new information of a packet.
3502 * @param type side information type
3503 * @param size side information size
3504 * @return pointer to fresh allocated data or NULL otherwise
3506 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3510 * Get side information from packet.
3513 * @param type desired side information type
3514 * @param size pointer for side information size to store (optional)
3515 * @return pointer to data if present or NULL otherwise
3517 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3520 int av_packet_merge_side_data(AVPacket *pkt);
3522 int av_packet_split_side_data(AVPacket *pkt);
3527 struct ReSampleContext;
3528 struct AVResampleContext;
3530 typedef struct ReSampleContext ReSampleContext;
3533 * Initialize audio resampling context.
3535 * @param output_channels number of output channels
3536 * @param input_channels number of input channels
3537 * @param output_rate output sample rate
3538 * @param input_rate input sample rate
3539 * @param sample_fmt_out requested output sample format
3540 * @param sample_fmt_in input sample format
3541 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3542 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3543 * @param linear if 1 then the used FIR filter will be linearly interpolated
3544 between the 2 closest, if 0 the closest will be used
3545 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3546 * @return allocated ReSampleContext, NULL if error occurred
3548 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3549 int output_rate, int input_rate,
3550 enum AVSampleFormat sample_fmt_out,
3551 enum AVSampleFormat sample_fmt_in,
3552 int filter_length, int log2_phase_count,
3553 int linear, double cutoff);
3555 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3558 * Free resample context.
3560 * @param s a non-NULL pointer to a resample context previously
3561 * created with av_audio_resample_init()
3563 void audio_resample_close(ReSampleContext *s);
3567 * Initialize an audio resampler.
3568 * Note, if either rate is not an integer then simply scale both rates up so they are.
3569 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3570 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3571 * @param linear If 1 then the used FIR filter will be linearly interpolated
3572 between the 2 closest, if 0 the closest will be used
3573 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3575 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3578 * Resample an array of samples using a previously configured context.
3579 * @param src an array of unconsumed samples
3580 * @param consumed the number of samples of src which have been consumed are returned here
3581 * @param src_size the number of unconsumed samples available
3582 * @param dst_size the amount of space in samples available in dst
3583 * @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.
3584 * @return the number of samples written in dst or -1 if an error occurred
3586 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3590 * Compensate samplerate/timestamp drift. The compensation is done by changing
3591 * the resampler parameters, so no audible clicks or similar distortions occur
3592 * @param compensation_distance distance in output samples over which the compensation should be performed
3593 * @param sample_delta number of output samples which should be output less
3595 * example: av_resample_compensate(c, 10, 500)
3596 * here instead of 510 samples only 500 samples would be output
3598 * note, due to rounding the actual compensation might be slightly different,
3599 * especially if the compensation_distance is large and the in_rate used during init is small
3601 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3602 void av_resample_close(struct AVResampleContext *c);
3605 * Allocate memory for a picture. Call avpicture_free() to free it.
3607 * @see avpicture_fill()
3609 * @param picture the picture to be filled in
3610 * @param pix_fmt the format of the picture
3611 * @param width the width of the picture
3612 * @param height the height of the picture
3613 * @return zero if successful, a negative value if not
3615 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3618 * Free a picture previously allocated by avpicture_alloc().
3619 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3622 * @param picture the AVPicture to be freed
3624 void avpicture_free(AVPicture *picture);
3627 * Fill in the AVPicture fields.
3628 * The fields of the given AVPicture are filled in by using the 'ptr' address
3629 * which points to the image data buffer. Depending on the specified picture
3630 * format, one or multiple image data pointers and line sizes will be set.
3631 * If a planar format is specified, several pointers will be set pointing to
3632 * the different picture planes and the line sizes of the different planes
3633 * will be stored in the lines_sizes array.
3634 * Call with ptr == NULL to get the required size for the ptr buffer.
3636 * To allocate the buffer and fill in the AVPicture fields in one call,
3637 * use avpicture_alloc().
3639 * @param picture AVPicture whose fields are to be filled in
3640 * @param ptr Buffer which will contain or contains the actual image data
3641 * @param pix_fmt The format in which the picture data is stored.
3642 * @param width the width of the image in pixels
3643 * @param height the height of the image in pixels
3644 * @return size of the image data in bytes
3646 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3647 enum PixelFormat pix_fmt, int width, int height);
3650 * Copy pixel data from an AVPicture into a buffer.
3651 * The data is stored compactly, without any gaps for alignment or padding
3652 * which may be applied by avpicture_fill().
3654 * @see avpicture_get_size()
3656 * @param[in] src AVPicture containing image data
3657 * @param[in] pix_fmt The format in which the picture data is stored.
3658 * @param[in] width the width of the image in pixels.
3659 * @param[in] height the height of the image in pixels.
3660 * @param[out] dest A buffer into which picture data will be copied.
3661 * @param[in] dest_size The size of 'dest'.
3662 * @return The number of bytes written to dest, or a negative value (error code) on error.
3664 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3665 unsigned char *dest, int dest_size);
3668 * Calculate the size in bytes that a picture of the given width and height
3669 * would occupy if stored in the given picture format.
3670 * Note that this returns the size of a compact representation as generated
3671 * by avpicture_layout(), which can be smaller than the size required for e.g.
3674 * @param pix_fmt the given picture format
3675 * @param width the width of the image
3676 * @param height the height of the image
3677 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3679 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3680 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3683 * Get the name of a codec.
3684 * @return a static string identifying the codec; never NULL
3686 const char *avcodec_get_name(enum CodecID id);
3688 #if FF_API_GET_PIX_FMT_NAME
3690 * Return the short name for a pixel format.
3692 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3693 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3695 attribute_deprecated
3696 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3699 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3702 * Return a value representing the fourCC code associated to the
3703 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3706 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3709 * Put a string representing the codec tag codec_tag in buf.
3711 * @param buf_size size in bytes of buf
3712 * @return the length of the string that would have been generated if
3713 * enough space had been available, excluding the trailing null
3715 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3717 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3718 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3719 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3720 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3721 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3722 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3725 * Compute what kind of losses will occur when converting from one specific
3726 * pixel format to another.
3727 * When converting from one pixel format to another, information loss may occur.
3728 * For example, when converting from RGB24 to GRAY, the color information will
3729 * be lost. Similarly, other losses occur when converting from some formats to
3730 * other formats. These losses can involve loss of chroma, but also loss of
3731 * resolution, loss of color depth, loss due to the color space conversion, loss
3732 * of the alpha bits or loss due to color quantization.
3733 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3734 * which will occur when converting from one pixel format to another.
3736 * @param[in] dst_pix_fmt destination pixel format
3737 * @param[in] src_pix_fmt source pixel format
3738 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3739 * @return Combination of flags informing you what kind of losses will occur
3740 * (maximum loss for an invalid dst_pix_fmt).
3742 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3746 * Find the best pixel format to convert to given a certain source pixel
3747 * format. When converting from one pixel format to another, information loss
3748 * may occur. For example, when converting from RGB24 to GRAY, the color
3749 * information will be lost. Similarly, other losses occur when converting from
3750 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3751 * the given pixel formats should be used to suffer the least amount of loss.
3752 * The pixel formats from which it chooses one, are determined by the
3753 * pix_fmt_mask parameter.
3755 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3758 * src_pix_fmt = PIX_FMT_YUV420P;
3759 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3760 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3763 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3764 * @param[in] src_pix_fmt source pixel format
3765 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3766 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3767 * @return The best pixel format to convert to or -1 if none was found.
3769 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3770 int has_alpha, int *loss_ptr);
3773 * Find the best pixel format to convert to given a certain source pixel
3774 * format and a selection of two destination pixel formats. When converting from
3775 * one pixel format to another, information loss may occur. For example, when converting
3776 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3777 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3778 * the given pixel formats should be used to suffer the least amount of loss.
3780 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3784 * src_pix_fmt = PIX_FMT_YUV420P;
3785 * dst_pix_fmt1= PIX_FMT_RGB24;
3786 * dst_pix_fmt2= PIX_FMT_GRAY8;
3787 * dst_pix_fmt3= PIX_FMT_RGB8;
3788 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3789 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3790 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3793 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3794 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3795 * @param[in] src_pix_fmt Source pixel format
3796 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3797 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3798 * NULL or value of zero means we care about all losses. Out: the loss
3799 * that occurs when converting from src to selected dst pixel format.
3800 * @return The best pixel format to convert to or -1 if none was found.
3802 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3803 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3805 #if FF_API_GET_ALPHA_INFO
3806 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3807 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3810 * Tell if an image really has transparent alpha values.
3811 * @return ored mask of FF_ALPHA_xxx constants
3813 attribute_deprecated
3814 int img_get_alpha_info(const AVPicture *src,
3815 enum PixelFormat pix_fmt, int width, int height);
3818 /* deinterlace a picture */
3819 /* deinterlace - if not supported return -1 */
3820 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3821 enum PixelFormat pix_fmt, int width, int height);
3823 /* external high level API */
3826 * If c is NULL, returns the first registered codec,
3827 * if c is non-NULL, returns the next registered codec after c,
3828 * or NULL if c is the last one.
3830 AVCodec *av_codec_next(AVCodec *c);
3833 * Return the LIBAVCODEC_VERSION_INT constant.
3835 unsigned avcodec_version(void);
3838 * Return the libavcodec build-time configuration.
3840 const char *avcodec_configuration(void);
3843 * Return the libavcodec license.
3845 const char *avcodec_license(void);
3847 #if FF_API_AVCODEC_INIT
3849 * @deprecated this function is called automatically from avcodec_register()
3850 * and avcodec_register_all(), there is no need to call it manually
3852 attribute_deprecated
3853 void avcodec_init(void);
3857 * Register the codec codec and initialize libavcodec.
3859 * @warning either this function or avcodec_register_all() must be called
3860 * before any other libavcodec functions.
3862 * @see avcodec_register_all()
3864 void avcodec_register(AVCodec *codec);
3867 * Find a registered encoder with a matching codec ID.
3869 * @param id CodecID of the requested encoder
3870 * @return An encoder if one was found, NULL otherwise.
3872 AVCodec *avcodec_find_encoder(enum CodecID id);
3875 * Find a registered encoder with the specified name.
3877 * @param name name of the requested encoder
3878 * @return An encoder if one was found, NULL otherwise.
3880 AVCodec *avcodec_find_encoder_by_name(const char *name);
3883 * Find a registered decoder with a matching codec ID.
3885 * @param id CodecID of the requested decoder
3886 * @return A decoder if one was found, NULL otherwise.
3888 AVCodec *avcodec_find_decoder(enum CodecID id);
3891 * Find a registered decoder with the specified name.
3893 * @param name name of the requested decoder
3894 * @return A decoder if one was found, NULL otherwise.
3896 AVCodec *avcodec_find_decoder_by_name(const char *name);
3897 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3900 * Return a name for the specified profile, if available.
3902 * @param codec the codec that is searched for the given profile
3903 * @param profile the profile value for which a name is requested
3904 * @return A name for the profile if found, NULL otherwise.
3906 const char *av_get_profile_name(const AVCodec *codec, int profile);
3908 #if FF_API_ALLOC_CONTEXT
3910 * Set the fields of the given AVCodecContext to default values.
3912 * @param s The AVCodecContext of which the fields should be set to default values.
3913 * @deprecated use avcodec_get_context_defaults3
3915 attribute_deprecated
3916 void avcodec_get_context_defaults(AVCodecContext *s);
3918 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3919 * we WILL change its arguments and name a few times! */
3920 attribute_deprecated
3921 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3925 * Set the fields of the given AVCodecContext to default values corresponding
3926 * to the given codec (defaults may be codec-dependent).
3928 * Do not call this function if a non-NULL codec has been passed
3929 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3930 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3931 * different codec on this AVCodecContext.
3933 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3935 #if FF_API_ALLOC_CONTEXT
3937 * Allocate an AVCodecContext and set its fields to default values. The
3938 * resulting struct can be deallocated by simply calling av_free().
3940 * @return An AVCodecContext filled with default values or NULL on failure.
3941 * @see avcodec_get_context_defaults
3943 * @deprecated use avcodec_alloc_context3()
3945 attribute_deprecated
3946 AVCodecContext *avcodec_alloc_context(void);
3948 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3949 * we WILL change its arguments and name a few times! */
3950 attribute_deprecated
3951 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3955 * Allocate an AVCodecContext and set its fields to default values. The
3956 * resulting struct can be deallocated by simply calling av_free().
3958 * @param codec if non-NULL, allocate private data and initialize defaults
3959 * for the given codec. It is illegal to then call avcodec_open2()
3960 * with a different codec.
3962 * @return An AVCodecContext filled with default values or NULL on failure.
3963 * @see avcodec_get_context_defaults
3965 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3968 * Copy the settings of the source AVCodecContext into the destination
3969 * AVCodecContext. The resulting destination codec context will be
3970 * unopened, i.e. you are required to call avcodec_open2() before you
3971 * can use this AVCodecContext to decode/encode video/audio data.
3973 * @param dest target codec context, should be initialized with
3974 * avcodec_alloc_context3(), but otherwise uninitialized
3975 * @param src source codec context
3976 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3978 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3981 * Set the fields of the given AVFrame to default values.
3983 * @param pic The AVFrame of which the fields should be set to default values.
3985 void avcodec_get_frame_defaults(AVFrame *pic);
3988 * Allocate an AVFrame and set its fields to default values. The resulting
3989 * struct can be deallocated by simply calling av_free().
3991 * @return An AVFrame filled with default values or NULL on failure.
3992 * @see avcodec_get_frame_defaults
3994 AVFrame *avcodec_alloc_frame(void);
3996 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3997 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3998 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4001 * Return the amount of padding in pixels which the get_buffer callback must
4002 * provide around the edge of the image for codecs which do not have the
4003 * CODEC_FLAG_EMU_EDGE flag.
4005 * @return Required padding in pixels.
4007 unsigned avcodec_get_edge_width(void);
4009 * Modify width and height values so that they will result in a memory
4010 * buffer that is acceptable for the codec if you do not use any horizontal
4013 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4014 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4015 * according to avcodec_get_edge_width() before.
4017 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4019 * Modify width and height values so that they will result in a memory
4020 * buffer that is acceptable for the codec if you also ensure that all
4021 * line sizes are a multiple of the respective linesize_align[i].
4023 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4024 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4025 * according to avcodec_get_edge_width() before.
4027 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4028 int linesize_align[AV_NUM_DATA_POINTERS]);
4030 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4032 #if FF_API_THREAD_INIT
4034 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
4036 attribute_deprecated
4037 int avcodec_thread_init(AVCodecContext *s, int thread_count);
4040 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4041 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4042 //FIXME func typedef
4044 #if FF_API_AVCODEC_OPEN
4046 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4047 * function the context has to be allocated.
4049 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4050 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4051 * retrieving a codec.
4053 * @warning This function is not thread safe!
4056 * avcodec_register_all();
4057 * codec = avcodec_find_decoder(CODEC_ID_H264);
4061 * context = avcodec_alloc_context3(codec);
4063 * if (avcodec_open(context, codec) < 0)
4067 * @param avctx The context which will be set up to use the given codec.
4068 * @param codec The codec to use within the context.
4069 * @return zero on success, a negative value on error
4070 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
4072 * @deprecated use avcodec_open2
4074 attribute_deprecated
4075 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
4079 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4080 * function the context has to be allocated with avcodec_alloc_context3().
4082 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4083 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4084 * retrieving a codec.
4086 * @warning This function is not thread safe!
4089 * avcodec_register_all();
4090 * av_dict_set(&opts, "b", "2.5M", 0);
4091 * codec = avcodec_find_decoder(CODEC_ID_H264);
4095 * context = avcodec_alloc_context3(codec);
4097 * if (avcodec_open2(context, codec, opts) < 0)
4101 * @param avctx The context to initialize.
4102 * @param options A dictionary filled with AVCodecContext and codec-private options.
4103 * On return this object will be filled with options that were not found.
4105 * @return zero on success, a negative value on error
4106 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4107 * av_dict_set(), av_opt_find().
4109 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
4111 #if FF_API_OLD_DECODE_AUDIO
4113 * Wrapper function which calls avcodec_decode_audio4.
4115 * @deprecated Use avcodec_decode_audio4 instead.
4117 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4118 * Some decoders may support multiple frames in a single AVPacket, such
4119 * decoders would then just decode the first frame. In this case,
4120 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4121 * the remaining data in order to decode the second frame etc.
4123 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4124 * decompressed frame size in bytes.
4126 * @warning You must set frame_size_ptr to the allocated size of the
4127 * output buffer before calling avcodec_decode_audio3().
4129 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4130 * the actual read bytes because some optimized bitstream readers read 32 or 64
4131 * bits at once and could read over the end.
4133 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4134 * no overreading happens for damaged MPEG streams.
4136 * @note You might have to align the input buffer avpkt->data and output buffer
4137 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4138 * necessary at all, on others it won't work at all if not aligned and on others
4139 * it will work but it will have an impact on performance.
4141 * In practice, avpkt->data should have 4 byte alignment at minimum and
4142 * samples should be 16 byte aligned unless the CPU doesn't need it
4143 * (AltiVec and SSE do).
4145 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4146 * between input and output, these need to be fed with avpkt->data=NULL,
4147 * avpkt->size=0 at the end to return the remaining frames.
4149 * @param avctx the codec context
4150 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4151 * If the sample format is planar, each channel plane will
4152 * be the same size, with no padding between channels.
4153 * @param[in,out] frame_size_ptr the output buffer size in bytes
4154 * @param[in] avpkt The input AVPacket containing the input buffer.
4155 * You can create such packet with av_init_packet() and by then setting
4156 * data and size, some decoders might in addition need other fields.
4157 * All decoders are designed to use the least fields possible though.
4158 * @return On error a negative value is returned, otherwise the number of bytes
4159 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4161 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4162 int *frame_size_ptr,
4167 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4169 * Some decoders may support multiple frames in a single AVPacket. Such
4170 * decoders would then just decode the first frame. In this case,
4171 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4172 * the remaining data in order to decode the second frame, etc...
4173 * Even if no frames are returned, the packet needs to be fed to the decoder
4174 * with remaining data until it is completely consumed or an error occurs.
4176 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4177 * larger than the actual read bytes because some optimized bitstream
4178 * readers read 32 or 64 bits at once and could read over the end.
4180 * @note You might have to align the input buffer. The alignment requirements
4181 * depend on the CPU and the decoder.
4183 * @param avctx the codec context
4184 * @param[out] frame The AVFrame in which to store decoded audio samples.
4185 * Decoders request a buffer of a particular size by setting
4186 * AVFrame.nb_samples prior to calling get_buffer(). The
4187 * decoder may, however, only utilize part of the buffer by
4188 * setting AVFrame.nb_samples to a smaller value in the
4190 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4192 * @param[in] avpkt The input AVPacket containing the input buffer.
4193 * At least avpkt->data and avpkt->size should be set. Some
4194 * decoders might also require additional fields to be set.
4195 * @return A negative error code is returned if an error occurred during
4196 * decoding, otherwise the number of bytes consumed from the input
4197 * AVPacket is returned.
4199 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4200 int *got_frame_ptr, AVPacket *avpkt);
4203 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4204 * Some decoders may support multiple frames in a single AVPacket, such
4205 * decoders would then just decode the first frame.
4207 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4208 * the actual read bytes because some optimized bitstream readers read 32 or 64
4209 * bits at once and could read over the end.
4211 * @warning The end of the input buffer buf should be set to 0 to ensure that
4212 * no overreading happens for damaged MPEG streams.
4214 * @note You might have to align the input buffer avpkt->data.
4215 * The alignment requirements depend on the CPU: on some CPUs it isn't
4216 * necessary at all, on others it won't work at all if not aligned and on others
4217 * it will work but it will have an impact on performance.
4219 * In practice, avpkt->data should have 4 byte alignment at minimum.
4221 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4222 * between input and output, these need to be fed with avpkt->data=NULL,
4223 * avpkt->size=0 at the end to return the remaining frames.
4225 * @param avctx the codec context
4226 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4227 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4228 * allocate memory for the actual bitmap.
4229 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4230 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4231 * decodes and the decoder tells the user once it does not need the data anymore,
4232 * the user app can at this point free/reuse/keep the memory as it sees fit.
4234 * @param[in] avpkt The input AVpacket containing the input buffer.
4235 * You can create such packet with av_init_packet() and by then setting
4236 * data and size, some decoders might in addition need other fields like
4237 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4239 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4240 * @return On error a negative value is returned, otherwise the number of bytes
4241 * used or zero if no frame could be decompressed.
4243 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4244 int *got_picture_ptr,
4248 * Decode a subtitle message.
4249 * Return a negative value on error, otherwise return the number of bytes used.
4250 * If no subtitle could be decompressed, got_sub_ptr is zero.
4251 * Otherwise, the subtitle is stored in *sub.
4252 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4253 * simplicity, because the performance difference is expect to be negligible
4254 * and reusing a get_buffer written for video codecs would probably perform badly
4255 * due to a potentially very different allocation pattern.
4257 * @param avctx the codec context
4258 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4259 freed with avsubtitle_free if *got_sub_ptr is set.
4260 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4261 * @param[in] avpkt The input AVPacket containing the input buffer.
4263 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4268 * Free all allocated data in the given subtitle struct.
4270 * @param sub AVSubtitle to free.
4272 void avsubtitle_free(AVSubtitle *sub);
4275 * Encode an audio frame from samples into buf.
4277 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4278 * However, for PCM audio the user will know how much space is needed
4279 * because it depends on the value passed in buf_size as described
4280 * below. In that case a lower value can be used.
4282 * @param avctx the codec context
4283 * @param[out] buf the output buffer
4284 * @param[in] buf_size the output buffer size
4285 * @param[in] samples the input buffer containing the samples
4286 * The number of samples read from this buffer is frame_size*channels,
4287 * both of which are defined in avctx.
4288 * For PCM audio the number of samples read from samples is equal to
4289 * buf_size * input_sample_size / output_sample_size.
4290 * @return On error a negative value is returned, on success zero or the number
4291 * of bytes used to encode the data read from the input buffer.
4293 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4294 const short *samples);
4297 * Encode a video frame from pict into buf.
4298 * The input picture should be
4299 * stored using a specific format, namely avctx.pix_fmt.
4301 * @param avctx the codec context
4302 * @param[out] buf the output buffer for the bitstream of encoded frame
4303 * @param[in] buf_size the size of the output buffer in bytes
4304 * @param[in] pict the input picture to encode
4305 * @return On error a negative value is returned, on success zero or the number
4306 * of bytes used from the output buffer.
4308 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4309 const AVFrame *pict);
4310 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4311 const AVSubtitle *sub);
4313 int avcodec_close(AVCodecContext *avctx);
4316 * Register all the codecs, parsers and bitstream filters which were enabled at
4317 * configuration time. If you do not call this function you can select exactly
4318 * which formats you want to support, by using the individual registration
4321 * @see avcodec_register
4322 * @see av_register_codec_parser
4323 * @see av_register_bitstream_filter
4325 void avcodec_register_all(void);
4328 * Flush buffers, should be called when seeking or when switching to a different stream.
4330 void avcodec_flush_buffers(AVCodecContext *avctx);
4332 void avcodec_default_free_buffers(AVCodecContext *s);
4334 /* misc useful functions */
4336 #if FF_API_OLD_FF_PICT_TYPES
4338 * Return a single letter to describe the given picture type pict_type.
4340 * @param[in] pict_type the picture type
4341 * @return A single character representing the picture type.
4342 * @deprecated Use av_get_picture_type_char() instead.
4344 attribute_deprecated
4345 char av_get_pict_type_char(int pict_type);
4349 * Return codec bits per sample.
4351 * @param[in] codec_id the codec
4352 * @return Number of bits per sample or zero if unknown for the given codec.
4354 int av_get_bits_per_sample(enum CodecID codec_id);
4356 #if FF_API_OLD_SAMPLE_FMT
4358 * @deprecated Use av_get_bytes_per_sample() instead.
4360 attribute_deprecated
4361 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4365 typedef struct AVCodecParserContext {
4367 struct AVCodecParser *parser;
4368 int64_t frame_offset; /* offset of the current frame */
4369 int64_t cur_offset; /* current offset
4370 (incremented by each av_parser_parse()) */
4371 int64_t next_frame_offset; /* offset of the next frame */
4373 int pict_type; /* XXX: Put it back in AVCodecContext. */
4375 * This field is used for proper frame duration computation in lavf.
4376 * It signals, how much longer the frame duration of the current frame
4377 * is compared to normal frame duration.
4379 * frame_duration = (1 + repeat_pict) * time_base
4381 * It is used by codecs like H.264 to display telecined material.
4383 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4384 int64_t pts; /* pts of the current frame */
4385 int64_t dts; /* dts of the current frame */
4390 int fetch_timestamp;
4392 #define AV_PARSER_PTS_NB 4
4393 int cur_frame_start_index;
4394 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4395 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4396 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4399 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4400 #define PARSER_FLAG_ONCE 0x0002
4401 /// Set if the parser has a valid file offset
4402 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4404 int64_t offset; ///< byte offset from starting packet start
4405 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4408 * Set by parser to 1 for key frames and 0 for non-key frames.
4409 * It is initialized to -1, so if the parser doesn't set this flag,
4410 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4416 * Time difference in stream time base units from the pts of this
4417 * packet to the point at which the output from the decoder has converged
4418 * independent from the availability of previous frames. That is, the
4419 * frames are virtually identical no matter if decoding started from
4420 * the very first frame or from this keyframe.
4421 * Is AV_NOPTS_VALUE if unknown.
4422 * This field is not the display duration of the current frame.
4423 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4426 * The purpose of this field is to allow seeking in streams that have no
4427 * keyframes in the conventional sense. It corresponds to the
4428 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4429 * essential for some types of subtitle streams to ensure that all
4430 * subtitles are correctly displayed after seeking.
4432 int64_t convergence_duration;
4434 // Timestamp generation support:
4436 * Synchronization point for start of timestamp generation.
4438 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4441 * For example, this corresponds to presence of H.264 buffering period
4447 * Offset of the current timestamp against last timestamp sync point in
4448 * units of AVCodecContext.time_base.
4450 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4451 * contain a valid timestamp offset.
4453 * Note that the timestamp of sync point has usually a nonzero
4454 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4455 * the next frame after timestamp sync point will be usually 1.
4457 * For example, this corresponds to H.264 cpb_removal_delay.
4459 int dts_ref_dts_delta;
4462 * Presentation delay of current frame in units of AVCodecContext.time_base.
4464 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4465 * contain valid non-negative timestamp delta (presentation time of a frame
4466 * must not lie in the past).
4468 * This delay represents the difference between decoding and presentation
4469 * time of the frame.
4471 * For example, this corresponds to H.264 dpb_output_delay.
4476 * Position of the packet in file.
4478 * Analogous to cur_frame_pts/dts
4480 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4483 * Byte position of currently parsed frame in stream.
4488 * Previous frame byte position.
4491 } AVCodecParserContext;
4493 typedef struct AVCodecParser {
4494 int codec_ids[5]; /* several codec IDs are permitted */
4496 int (*parser_init)(AVCodecParserContext *s);
4497 int (*parser_parse)(AVCodecParserContext *s,
4498 AVCodecContext *avctx,
4499 const uint8_t **poutbuf, int *poutbuf_size,
4500 const uint8_t *buf, int buf_size);
4501 void (*parser_close)(AVCodecParserContext *s);
4502 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4503 struct AVCodecParser *next;
4506 AVCodecParser *av_parser_next(AVCodecParser *c);
4508 void av_register_codec_parser(AVCodecParser *parser);
4509 AVCodecParserContext *av_parser_init(int codec_id);
4514 * @param s parser context.
4515 * @param avctx codec context.
4516 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4517 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4518 * @param buf input buffer.
4519 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4520 * @param pts input presentation timestamp.
4521 * @param dts input decoding timestamp.
4522 * @param pos input byte position in stream.
4523 * @return the number of bytes of the input bitstream used.
4528 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4535 * decode_frame(data, size);
4539 int av_parser_parse2(AVCodecParserContext *s,
4540 AVCodecContext *avctx,
4541 uint8_t **poutbuf, int *poutbuf_size,
4542 const uint8_t *buf, int buf_size,
4543 int64_t pts, int64_t dts,
4546 int av_parser_change(AVCodecParserContext *s,
4547 AVCodecContext *avctx,
4548 uint8_t **poutbuf, int *poutbuf_size,
4549 const uint8_t *buf, int buf_size, int keyframe);
4550 void av_parser_close(AVCodecParserContext *s);
4553 typedef struct AVBitStreamFilterContext {
4555 struct AVBitStreamFilter *filter;
4556 AVCodecParserContext *parser;
4557 struct AVBitStreamFilterContext *next;
4558 } AVBitStreamFilterContext;
4561 typedef struct AVBitStreamFilter {
4564 int (*filter)(AVBitStreamFilterContext *bsfc,
4565 AVCodecContext *avctx, const char *args,
4566 uint8_t **poutbuf, int *poutbuf_size,
4567 const uint8_t *buf, int buf_size, int keyframe);
4568 void (*close)(AVBitStreamFilterContext *bsfc);
4569 struct AVBitStreamFilter *next;
4570 } AVBitStreamFilter;
4572 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4573 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4574 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4575 AVCodecContext *avctx, const char *args,
4576 uint8_t **poutbuf, int *poutbuf_size,
4577 const uint8_t *buf, int buf_size, int keyframe);
4578 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4580 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4585 * Reallocate the given block if it is not large enough, otherwise do nothing.
4589 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4592 * Allocate a buffer, reusing the given one if large enough.
4594 * Contrary to av_fast_realloc the current buffer contents might not be
4595 * preserved and on error the old buffer is freed, thus no special
4596 * handling to avoid memleaks is necessary.
4598 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4599 * @param size size of the buffer *ptr points to
4600 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4601 * *size 0 if an error occurred.
4603 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4606 * Copy image src to dst. Wraps av_picture_data_copy() above.
4608 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4609 enum PixelFormat pix_fmt, int width, int height);
4612 * Crop image top and left side.
4614 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4615 enum PixelFormat pix_fmt, int top_band, int left_band);
4620 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4621 int padtop, int padbottom, int padleft, int padright, int *color);
4624 * Encode extradata length to a buffer. Used by xiph codecs.
4626 * @param s buffer to write to; must be at least (v/255+1) bytes long
4627 * @param v size of extradata in bytes
4628 * @return number of bytes written to the buffer.
4630 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4633 * Log a generic warning message about a missing feature. This function is
4634 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4635 * only, and would normally not be used by applications.
4636 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4637 * a pointer to an AVClass struct
4638 * @param[in] feature string containing the name of the missing feature
4639 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4640 * If want_sample is non-zero, additional verbage will be added to the log
4641 * message which tells the user how to report samples to the development
4644 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4647 * Log a generic warning message asking for a sample. This function is
4648 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4649 * only, and would normally not be used by applications.
4650 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4651 * a pointer to an AVClass struct
4652 * @param[in] msg string containing an optional message, or NULL if no message
4654 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4657 * Register the hardware accelerator hwaccel.
4659 void av_register_hwaccel(AVHWAccel *hwaccel);
4662 * If hwaccel is NULL, returns the first registered hardware accelerator,
4663 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4664 * after hwaccel, or NULL if hwaccel is the last one.
4666 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4670 * Lock operation used by lockmgr
4673 AV_LOCK_CREATE, ///< Create a mutex
4674 AV_LOCK_OBTAIN, ///< Lock the mutex
4675 AV_LOCK_RELEASE, ///< Unlock the mutex
4676 AV_LOCK_DESTROY, ///< Free mutex resources
4680 * Register a user provided lock manager supporting the operations
4681 * specified by AVLockOp. mutex points to a (void *) where the
4682 * lockmgr should store/get a pointer to a user allocated mutex. It's
4683 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4685 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4686 * callback during the call to av_lockmgr_register().
4687 * Thus, the application must be prepared to handle that.
4688 * If cb is set to NULL the lockmgr will be unregistered.
4689 * Also note that during unregistration the previously registered
4690 * lockmgr callback may also be invoked.
4692 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4695 * Get the type of the given codec.
4697 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4700 * Get the AVClass for AVCodecContext. It can be used in combination with
4701 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4703 * @see av_opt_find().
4705 const AVClass *avcodec_get_class(void);
4708 * Get the AVClass for AVFrame. It can be used in combination with
4709 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4711 * @see av_opt_find().
4713 const AVClass *avcodec_get_frame_class(void);
4715 #endif /* AVCODEC_AVCODEC_H */