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
795 * Codec supports changed parameters at any point.
797 #define CODEC_CAP_PARAM_CHANGE 0x4000
799 * Codec supports avctx->thread_count == 0 (auto).
801 #define CODEC_CAP_AUTO_THREADS 0x8000
805 #define CODEC_CAP_LOSSLESS 0x80000000
807 //The following defines may change, don't expect compatibility if you use them.
808 #define MB_TYPE_INTRA4x4 0x0001
809 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
810 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
811 #define MB_TYPE_16x16 0x0008
812 #define MB_TYPE_16x8 0x0010
813 #define MB_TYPE_8x16 0x0020
814 #define MB_TYPE_8x8 0x0040
815 #define MB_TYPE_INTERLACED 0x0080
816 #define MB_TYPE_DIRECT2 0x0100 //FIXME
817 #define MB_TYPE_ACPRED 0x0200
818 #define MB_TYPE_GMC 0x0400
819 #define MB_TYPE_SKIP 0x0800
820 #define MB_TYPE_P0L0 0x1000
821 #define MB_TYPE_P1L0 0x2000
822 #define MB_TYPE_P0L1 0x4000
823 #define MB_TYPE_P1L1 0x8000
824 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
825 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
826 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
827 #define MB_TYPE_QUANT 0x00010000
828 #define MB_TYPE_CBP 0x00020000
829 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
833 * This specifies the area which should be displayed.
834 * Note there may be multiple such areas for one frame.
836 typedef struct AVPanScan{
839 * - encoding: Set by user.
840 * - decoding: Set by libavcodec.
845 * width and height in 1/16 pel
846 * - encoding: Set by user.
847 * - decoding: Set by libavcodec.
853 * position of the top left corner in 1/16 pel for up to 3 fields/frames
854 * - encoding: Set by user.
855 * - decoding: Set by libavcodec.
857 int16_t position[3][2];
860 #define FF_QSCALE_TYPE_MPEG1 0
861 #define FF_QSCALE_TYPE_MPEG2 1
862 #define FF_QSCALE_TYPE_H264 2
863 #define FF_QSCALE_TYPE_VP56 3
865 #define FF_BUFFER_TYPE_INTERNAL 1
866 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
867 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
868 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
870 #if FF_API_OLD_FF_PICT_TYPES
871 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
872 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
873 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
874 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
875 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
876 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
877 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
878 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
881 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
882 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
883 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
884 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
886 enum AVPacketSideDataType {
888 AV_PKT_DATA_NEW_EXTRADATA,
889 AV_PKT_DATA_PARAM_CHANGE,
892 typedef struct AVPacket {
894 * Presentation timestamp in AVStream->time_base units; the time at which
895 * the decompressed packet will be presented to the user.
896 * Can be AV_NOPTS_VALUE if it is not stored in the file.
897 * pts MUST be larger or equal to dts as presentation cannot happen before
898 * decompression, unless one wants to view hex dumps. Some formats misuse
899 * the terms dts and pts/cts to mean something different. Such timestamps
900 * must be converted to true pts/dts before they are stored in AVPacket.
904 * Decompression timestamp in AVStream->time_base units; the time at which
905 * the packet is decompressed.
906 * Can be AV_NOPTS_VALUE if it is not stored in the file.
913 * A combination of AV_PKT_FLAG values
917 * Additional packet data that can be provided by the container.
918 * Packet can contain several types of side information.
923 enum AVPacketSideDataType type;
928 * Duration of this packet in AVStream->time_base units, 0 if unknown.
929 * Equals next_pts - this_pts in presentation order.
932 void (*destruct)(struct AVPacket *);
934 int64_t pos; ///< byte position in stream, -1 if unknown
937 * Time difference in AVStream->time_base units from the pts of this
938 * packet to the point at which the output from the decoder has converged
939 * independent from the availability of previous frames. That is, the
940 * frames are virtually identical no matter if decoding started from
941 * the very first frame or from this keyframe.
942 * Is AV_NOPTS_VALUE if unknown.
943 * This field is not the display duration of the current packet.
944 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
947 * The purpose of this field is to allow seeking in streams that have no
948 * keyframes in the conventional sense. It corresponds to the
949 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
950 * essential for some types of subtitle streams to ensure that all
951 * subtitles are correctly displayed after seeking.
953 int64_t convergence_duration;
955 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
956 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
959 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
961 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
962 * s32le channel_count
963 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
964 * u64le channel_layout
965 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
967 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
972 enum AVSideDataParamChangeFlags {
973 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
974 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
975 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
976 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
981 * New fields can be added to the end of AVFRAME with minor version
982 * bumps. Similarly fields that are marked as to be only accessed by
983 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
984 * without breaking compatibility with each other.
985 * Removal, reordering and changes in the remaining cases require
986 * a major version bump.
987 * sizeof(AVFrame) must not be used outside libavcodec.
989 typedef struct AVFrame {
990 #if FF_API_DATA_POINTERS
991 #define AV_NUM_DATA_POINTERS 4
993 #define AV_NUM_DATA_POINTERS 8
996 * pointer to the picture/channel planes.
997 * This might be different from the first allocated byte
998 * - encoding: Set by user
999 * - decoding: set by AVCodecContext.get_buffer()
1001 uint8_t *data[AV_NUM_DATA_POINTERS];
1004 * Size, in bytes, of the data for each picture/channel plane.
1006 * For audio, only linesize[0] may be set. For planar audio, each channel
1007 * plane must be the same size.
1009 * - encoding: Set by user (video only)
1010 * - decoding: set by AVCodecContext.get_buffer()
1012 int linesize[AV_NUM_DATA_POINTERS];
1015 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1016 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1020 uint8_t *base[AV_NUM_DATA_POINTERS];
1022 * 1 -> keyframe, 0-> not
1023 * - encoding: Set by libavcodec.
1024 * - decoding: Set by libavcodec.
1029 * Picture type of the frame, see ?_TYPE below.
1030 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1031 * - decoding: Set by libavcodec.
1033 enum AVPictureType pict_type;
1036 * presentation timestamp in time_base units (time when frame should be shown to user)
1037 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1038 * - encoding: MUST be set by user.
1039 * - decoding: Set by libavcodec.
1044 * picture number in bitstream order
1045 * - encoding: set by
1046 * - decoding: Set by libavcodec.
1048 int coded_picture_number;
1050 * picture number in display order
1051 * - encoding: set by
1052 * - decoding: Set by libavcodec.
1054 int display_picture_number;
1057 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1058 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1059 * - decoding: Set by libavcodec.
1063 #if FF_API_AVFRAME_AGE
1065 * @deprecated unused
1067 attribute_deprecated int age;
1071 * is this picture used as reference
1072 * The values for this are the same as the MpegEncContext.picture_structure
1073 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1074 * Set to 4 for delayed, non-reference frames.
1075 * - encoding: unused
1076 * - decoding: Set by libavcodec. (before get_buffer() call)).
1082 * - encoding: unused
1083 * - decoding: Set by libavcodec.
1085 int8_t *qscale_table;
1088 * - encoding: unused
1089 * - decoding: Set by libavcodec.
1094 * mbskip_table[mb]>=1 if MB didn't change
1095 * stride= mb_width = (width+15)>>4
1096 * - encoding: unused
1097 * - decoding: Set by libavcodec.
1099 uint8_t *mbskip_table;
1102 * motion vector table
1105 * int mv_sample_log2= 4 - motion_subsample_log2;
1106 * int mb_width= (width+15)>>4;
1107 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1108 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1110 * - encoding: Set by user.
1111 * - decoding: Set by libavcodec.
1113 int16_t (*motion_val[2])[2];
1116 * macroblock type table
1117 * mb_type_base + mb_width + 2
1118 * - encoding: Set by user.
1119 * - decoding: Set by libavcodec.
1124 * log2 of the size of the block which a single vector in motion_val represents:
1125 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1126 * - encoding: unused
1127 * - decoding: Set by libavcodec.
1129 uint8_t motion_subsample_log2;
1132 * for some private data of the user
1133 * - encoding: unused
1134 * - decoding: Set by user.
1140 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1141 * - decoding: unused
1143 uint64_t error[AV_NUM_DATA_POINTERS];
1146 * type of the buffer (to keep track of who has to deallocate data[*])
1147 * - encoding: Set by the one who allocates it.
1148 * - decoding: Set by the one who allocates it.
1149 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1154 * When decoding, this signals how much the picture must be delayed.
1155 * extra_delay = repeat_pict / (2*fps)
1156 * - encoding: unused
1157 * - decoding: Set by libavcodec.
1167 * The content of the picture is interlaced.
1168 * - encoding: Set by user.
1169 * - decoding: Set by libavcodec. (default 0)
1171 int interlaced_frame;
1174 * If the content is interlaced, is top field displayed first.
1175 * - encoding: Set by user.
1176 * - decoding: Set by libavcodec.
1178 int top_field_first;
1182 * - encoding: Set by user.
1183 * - decoding: Set by libavcodec.
1185 AVPanScan *pan_scan;
1188 * Tell user application that palette has changed from previous frame.
1189 * - encoding: ??? (no palette-enabled encoder yet)
1190 * - decoding: Set by libavcodec. (default 0).
1192 int palette_has_changed;
1195 * codec suggestion on buffer type if != 0
1196 * - encoding: unused
1197 * - decoding: Set by libavcodec. (before get_buffer() call)).
1203 * - encoding: unused
1204 * - decoding: Set by libavcodec.
1209 * motion reference frame index
1210 * the order in which these are stored can depend on the codec.
1211 * - encoding: Set by user.
1212 * - decoding: Set by libavcodec.
1214 int8_t *ref_index[2];
1217 * reordered opaque 64bit (generally an integer or a double precision float
1218 * PTS but can be anything).
1219 * The user sets AVCodecContext.reordered_opaque to represent the input at
1221 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1222 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1223 * @deprecated in favor of pkt_pts
1224 * - encoding: unused
1225 * - decoding: Read by user.
1227 int64_t reordered_opaque;
1230 * hardware accelerator private data (FFmpeg-allocated)
1231 * - encoding: unused
1232 * - decoding: Set by libavcodec
1234 void *hwaccel_picture_private;
1237 * reordered pts from the last AVPacket that has been input into the decoder
1238 * - encoding: unused
1239 * - decoding: Read by user.
1244 * dts from the last AVPacket that has been input into the decoder
1245 * - encoding: unused
1246 * - decoding: Read by user.
1251 * the AVCodecContext which ff_thread_get_buffer() was last called on
1252 * - encoding: Set by libavcodec.
1253 * - decoding: Set by libavcodec.
1255 struct AVCodecContext *owner;
1258 * used by multithreading to store frame-specific info
1259 * - encoding: Set by libavcodec.
1260 * - decoding: Set by libavcodec.
1262 void *thread_opaque;
1265 * number of audio samples (per channel) described by this frame
1266 * - encoding: unused
1267 * - decoding: Set by libavcodec
1272 * pointers to the data planes/channels.
1274 * For video, this should simply point to data[].
1276 * For planar audio, each channel has a separate data pointer, and
1277 * linesize[0] contains the size of each channel buffer.
1278 * For packed audio, there is just one data pointer, and linesize[0]
1279 * contains the total size of the buffer for all channels.
1281 * Note: Both data and extended_data will always be set by get_buffer(),
1282 * but for planar audio with more channels that can fit in data,
1283 * extended_data must be used by the decoder in order to access all
1287 * decoding: set by AVCodecContext.get_buffer()
1289 uint8_t **extended_data;
1292 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1293 * - encoding: unused
1294 * - decoding: Read by user.
1296 AVRational sample_aspect_ratio;
1299 * width and height of the video frame
1300 * - encoding: unused
1301 * - decoding: Read by user.
1306 * format of the frame, -1 if unknown or unset
1307 * Values correspond to enum PixelFormat for video frames,
1308 * enum AVSampleFormat for audio)
1309 * - encoding: unused
1310 * - decoding: Read by user.
1315 * frame timestamp estimated using various heuristics, in stream time base
1316 * Code outside libavcodec should access this field using:
1317 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1318 * - encoding: unused
1319 * - decoding: set by libavcodec, read by user.
1321 int64_t best_effort_timestamp;
1324 * reordered pos from the last AVPacket that has been input into the decoder
1325 * Code outside libavcodec should access this field using:
1326 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1327 * - encoding: unused
1328 * - decoding: Read by user.
1334 struct AVCodecInternal;
1338 AV_FIELD_PROGRESSIVE,
1339 AV_FIELD_TT, //< Top coded_first, top displayed first
1340 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1341 AV_FIELD_TB, //< Top coded first, bottom displayed first
1342 AV_FIELD_BT, //< Bottom coded first, top displayed first
1346 * main external API structure.
1347 * New fields can be added to the end with minor version bumps.
1348 * Removal, reordering and changes to existing fields require a major
1350 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1352 * sizeof(AVCodecContext) must not be used outside libav*.
1354 typedef struct AVCodecContext {
1356 * information on struct for av_log
1357 * - set by avcodec_alloc_context3
1359 const AVClass *av_class;
1361 * the average bitrate
1362 * - encoding: Set by user; unused for constant quantizer encoding.
1363 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1368 * number of bits the bitstream is allowed to diverge from the reference.
1369 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1370 * - encoding: Set by user; unused for constant quantizer encoding.
1371 * - decoding: unused
1373 int bit_rate_tolerance;
1377 * - encoding: Set by user.
1378 * - decoding: Set by user.
1383 * Some codecs need additional format info. It is stored here.
1384 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1385 * specific codec MUST set it correctly otherwise stream copy breaks.
1386 * In general use of this field by muxers is not recommended.
1387 * - encoding: Set by libavcodec.
1388 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1393 * Motion estimation algorithm used for video coding.
1394 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1395 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1396 * - encoding: MUST be set by user.
1397 * - decoding: unused
1402 * some codecs need / can use extradata like Huffman tables.
1403 * mjpeg: Huffman tables
1404 * rv10: additional flags
1405 * mpeg4: global headers (they can be in the bitstream or here)
1406 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1407 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1408 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1409 * - encoding: Set/allocated/freed by libavcodec.
1410 * - decoding: Set/allocated/freed by user.
1416 * This is the fundamental unit of time (in seconds) in terms
1417 * of which frame timestamps are represented. For fixed-fps content,
1418 * timebase should be 1/framerate and timestamp increments should be
1420 * - encoding: MUST be set by user.
1421 * - decoding: Set by libavcodec.
1423 AVRational time_base;
1427 * picture width / height.
1428 * - encoding: MUST be set by user.
1429 * - decoding: Set by libavcodec.
1430 * Note: For compatibility it is possible to set this instead of
1431 * coded_width/height before decoding.
1435 #define FF_ASPECT_EXTENDED 15
1438 * the number of pictures in a group of pictures, or 0 for intra_only
1439 * - encoding: Set by user.
1440 * - decoding: unused
1445 * Pixel format, see PIX_FMT_xxx.
1446 * May be set by the demuxer if known from headers.
1447 * May be overriden by the decoder if it knows better.
1448 * - encoding: Set by user.
1449 * - decoding: Set by user if known, overridden by libavcodec if known
1451 enum PixelFormat pix_fmt;
1454 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1455 * decoder to draw a horizontal band. It improves cache usage. Not
1456 * all codecs can do that. You must check the codec capabilities
1458 * When multithreading is used, it may be called from multiple threads
1459 * at the same time; threads might draw different parts of the same AVFrame,
1460 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1462 * The function is also used by hardware acceleration APIs.
1463 * It is called at least once during frame decoding to pass
1464 * the data needed for hardware render.
1465 * In that mode instead of pixel data, AVFrame points to
1466 * a structure specific to the acceleration API. The application
1467 * reads the structure and can change some fields to indicate progress
1469 * - encoding: unused
1470 * - decoding: Set by user.
1471 * @param height the height of the slice
1472 * @param y the y position of the slice
1473 * @param type 1->top field, 2->bottom field, 3->frame
1474 * @param offset offset into the AVFrame.data from which the slice should be read
1476 void (*draw_horiz_band)(struct AVCodecContext *s,
1477 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1478 int y, int type, int height);
1481 int sample_rate; ///< samples per second
1482 int channels; ///< number of audio channels
1485 * audio sample format
1486 * - encoding: Set by user.
1487 * - decoding: Set by libavcodec.
1489 enum AVSampleFormat sample_fmt; ///< sample format
1491 /* The following data should not be initialized. */
1493 * Samples per packet, initialized when calling 'init'.
1496 int frame_number; ///< audio or video frame number
1499 * Encoding: Number of frames delay there will be from the encoder input to
1500 * the decoder output. (we assume the decoder matches the spec)
1501 * Decoding: Number of frames delay in addition to what a standard decoder
1502 * as specified in the spec would produce.
1503 * - encoding: Set by libavcodec.
1504 * - decoding: Set by libavcodec.
1508 /* - encoding parameters */
1509 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1510 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1514 * - encoding: Set by user.
1515 * - decoding: unused
1521 * - encoding: Set by user.
1522 * - decoding: unused
1527 * maximum quantizer difference between frames
1528 * - encoding: Set by user.
1529 * - decoding: unused
1534 * maximum number of B-frames between non-B-frames
1535 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1536 * - encoding: Set by user.
1537 * - decoding: unused
1542 * qscale factor between IP and B-frames
1543 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1544 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1545 * - encoding: Set by user.
1546 * - decoding: unused
1548 float b_quant_factor;
1550 /** obsolete FIXME remove */
1552 #define FF_RC_STRATEGY_XVID 1
1554 int b_frame_strategy;
1556 struct AVCodec *codec;
1560 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1561 /* do its best to deliver a chunk with size */
1562 /* below rtp_payload_size, the chunk will start */
1563 /* with a start code on some codecs like H.263. */
1564 /* This doesn't take account of any particular */
1565 /* headers inside the transmitted RTP payload. */
1568 /* The RTP callback: This function is called */
1569 /* every time the encoder has a packet to send. */
1570 /* It depends on the encoder if the data starts */
1571 /* with a Start Code (it should). H.263 does. */
1572 /* mb_nb contains the number of macroblocks */
1573 /* encoded in the RTP payload. */
1574 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1576 /* statistics, used for 2-pass encoding */
1587 * number of bits used for the previously encoded frame
1588 * - encoding: Set by libavcodec.
1589 * - decoding: unused
1594 * Private data of the user, can be used to carry app specific stuff.
1595 * - encoding: Set by user.
1596 * - decoding: Set by user.
1600 char codec_name[32];
1601 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1602 enum CodecID codec_id; /* see CODEC_ID_xxx */
1605 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1606 * This is used to work around some encoder bugs.
1607 * A demuxer should set this to what is stored in the field used to identify the codec.
1608 * If there are multiple such fields in a container then the demuxer should choose the one
1609 * which maximizes the information about the used codec.
1610 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1611 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1612 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1614 * - encoding: Set by user, if not then the default based on codec_id will be used.
1615 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1617 unsigned int codec_tag;
1620 * Work around bugs in encoders which sometimes cannot be detected automatically.
1621 * - encoding: Set by user
1622 * - decoding: Set by user
1624 int workaround_bugs;
1625 #define FF_BUG_AUTODETECT 1 ///< autodetection
1626 #define FF_BUG_OLD_MSMPEG4 2
1627 #define FF_BUG_XVID_ILACE 4
1628 #define FF_BUG_UMP4 8
1629 #define FF_BUG_NO_PADDING 16
1630 #define FF_BUG_AMV 32
1631 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1632 #define FF_BUG_QPEL_CHROMA 64
1633 #define FF_BUG_STD_QPEL 128
1634 #define FF_BUG_QPEL_CHROMA2 256
1635 #define FF_BUG_DIRECT_BLOCKSIZE 512
1636 #define FF_BUG_EDGE 1024
1637 #define FF_BUG_HPEL_CHROMA 2048
1638 #define FF_BUG_DC_CLIP 4096
1639 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1640 #define FF_BUG_TRUNCATED 16384
1641 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1644 * luma single coefficient elimination threshold
1645 * - encoding: Set by user.
1646 * - decoding: unused
1648 int luma_elim_threshold;
1651 * chroma single coeff elimination threshold
1652 * - encoding: Set by user.
1653 * - decoding: unused
1655 int chroma_elim_threshold;
1658 * strictly follow the standard (MPEG4, ...).
1659 * - encoding: Set by user.
1660 * - decoding: Set by user.
1661 * Setting this to STRICT or higher means the encoder and decoder will
1662 * generally do stupid things, whereas setting it to unofficial or lower
1663 * will mean the encoder might produce output that is not supported by all
1664 * spec-compliant decoders. Decoders don't differentiate between normal,
1665 * unofficial and experimental (that is, they always try to decode things
1666 * when they can) unless they are explicitly asked to behave stupidly
1667 * (=strictly conform to the specs)
1669 int strict_std_compliance;
1670 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1671 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1672 #define FF_COMPLIANCE_NORMAL 0
1673 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1674 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1677 * qscale offset between IP and B-frames
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 float b_quant_offset;
1685 * Error recognition; higher values will detect more errors but may
1686 * misdetect some more or less valid parts as errors.
1687 * - encoding: unused
1688 * - decoding: Set by user.
1690 attribute_deprecated int error_recognition;
1691 #define FF_ER_CAREFUL 1
1692 #define FF_ER_COMPLIANT 2
1693 #define FF_ER_AGGRESSIVE 3
1694 #define FF_ER_VERY_AGGRESSIVE 4
1695 #define FF_ER_EXPLODE 5
1696 #endif /* FF_API_ER */
1699 * Called at the beginning of each frame to get a buffer for it.
1701 * The function will set AVFrame.data[], AVFrame.linesize[].
1702 * AVFrame.extended_data[] must also be set, but it should be the same as
1703 * AVFrame.data[] except for planar audio with more channels than can fit
1704 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1705 * many data pointers as it can hold.
1707 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1708 * avcodec_default_get_buffer() instead of providing buffers allocated by
1711 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1712 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1713 * but if get_buffer() is overridden then alignment considerations should
1714 * be taken into account.
1716 * @see avcodec_default_get_buffer()
1720 * If pic.reference is set then the frame will be read later by libavcodec.
1721 * avcodec_align_dimensions2() should be used to find the required width and
1722 * height, as they normally need to be rounded up to the next multiple of 16.
1724 * If frame multithreading is used and thread_safe_callbacks is set,
1725 * it may be called from a different thread, but not from more than one at
1726 * once. Does not need to be reentrant.
1728 * @see release_buffer(), reget_buffer()
1729 * @see avcodec_align_dimensions2()
1733 * Decoders request a buffer of a particular size by setting
1734 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1735 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1736 * to a smaller value in the output frame.
1738 * Decoders cannot use the buffer after returning from
1739 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1740 * is assumed to be released immediately upon return.
1742 * As a convenience, av_samples_get_buffer_size() and
1743 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1744 * functions to find the required data size and to fill data pointers and
1745 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1746 * since all planes must be the same size.
1748 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1750 * - encoding: unused
1751 * - decoding: Set by libavcodec, user can override.
1753 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1756 * Called to release buffers which were allocated with get_buffer.
1757 * A released buffer can be reused in get_buffer().
1758 * pic.data[*] must be set to NULL.
1759 * May be called from a different thread if frame multithreading is used,
1760 * but not by more than one thread at once, so does not need to be reentrant.
1761 * - encoding: unused
1762 * - decoding: Set by libavcodec, user can override.
1764 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1767 * Size of the frame reordering buffer in the decoder.
1768 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1769 * - encoding: Set by libavcodec.
1770 * - decoding: Set by libavcodec.
1775 * number of bytes per packet if constant and known or 0
1776 * Used by some WAV based audio codecs.
1780 #if FF_API_PARSE_FRAME
1782 * If true, only parsing is done. The frame data is returned.
1783 * Only MPEG audio decoders support this now.
1784 * - encoding: unused
1785 * - decoding: Set by user
1787 attribute_deprecated int parse_only;
1791 * 0-> h263 quant 1-> mpeg quant
1792 * - encoding: Set by user.
1793 * - decoding: unused
1798 * pass1 encoding statistics output buffer
1799 * - encoding: Set by libavcodec.
1800 * - decoding: unused
1805 * pass2 encoding statistics input buffer
1806 * Concatenated stuff from stats_out of pass1 should be placed here.
1807 * - encoding: Allocated/set/freed by user.
1808 * - decoding: unused
1813 * ratecontrol qmin qmax limiting method
1814 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1815 * - encoding: Set by user.
1816 * - decoding: unused
1824 * ratecontrol override, see RcOverride
1825 * - encoding: Allocated/set/freed by user.
1826 * - decoding: unused
1828 RcOverride *rc_override;
1829 int rc_override_count;
1832 * rate control equation
1833 * - encoding: Set by user
1834 * - decoding: unused
1840 * - encoding: Set by user.
1841 * - decoding: unused
1847 * - encoding: Set by user.
1848 * - decoding: unused
1853 * decoder bitstream buffer size
1854 * - encoding: Set by user.
1855 * - decoding: unused
1858 float rc_buffer_aggressivity;
1861 * qscale factor between P and I-frames
1862 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1863 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1864 * - encoding: Set by user.
1865 * - decoding: unused
1867 float i_quant_factor;
1870 * qscale offset between P and I-frames
1871 * - encoding: Set by user.
1872 * - decoding: unused
1874 float i_quant_offset;
1877 * initial complexity for pass1 ratecontrol
1878 * - encoding: Set by user.
1879 * - decoding: unused
1881 float rc_initial_cplx;
1884 * DCT algorithm, see FF_DCT_* below
1885 * - encoding: Set by user.
1886 * - decoding: unused
1889 #define FF_DCT_AUTO 0
1890 #define FF_DCT_FASTINT 1
1891 #define FF_DCT_INT 2
1892 #define FF_DCT_MMX 3
1893 #define FF_DCT_MLIB 4
1894 #define FF_DCT_ALTIVEC 5
1895 #define FF_DCT_FAAN 6
1898 * luminance masking (0-> disabled)
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * temporary complexity masking (0-> disabled)
1906 * - encoding: Set by user.
1907 * - decoding: unused
1909 float temporal_cplx_masking;
1912 * spatial complexity masking (0-> disabled)
1913 * - encoding: Set by user.
1914 * - decoding: unused
1916 float spatial_cplx_masking;
1919 * p block masking (0-> disabled)
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * darkness masking (0-> disabled)
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * IDCT algorithm, see FF_IDCT_* below.
1934 * - encoding: Set by user.
1935 * - decoding: Set by user.
1938 #define FF_IDCT_AUTO 0
1939 #define FF_IDCT_INT 1
1940 #define FF_IDCT_SIMPLE 2
1941 #define FF_IDCT_SIMPLEMMX 3
1942 #define FF_IDCT_LIBMPEG2MMX 4
1943 #define FF_IDCT_PS2 5
1944 #define FF_IDCT_MLIB 6
1945 #define FF_IDCT_ARM 7
1946 #define FF_IDCT_ALTIVEC 8
1947 #define FF_IDCT_SH4 9
1948 #define FF_IDCT_SIMPLEARM 10
1949 #define FF_IDCT_H264 11
1950 #define FF_IDCT_VP3 12
1951 #define FF_IDCT_IPP 13
1952 #define FF_IDCT_XVIDMMX 14
1953 #define FF_IDCT_CAVS 15
1954 #define FF_IDCT_SIMPLEARMV5TE 16
1955 #define FF_IDCT_SIMPLEARMV6 17
1956 #define FF_IDCT_SIMPLEVIS 18
1957 #define FF_IDCT_WMV2 19
1958 #define FF_IDCT_FAAN 20
1959 #define FF_IDCT_EA 21
1960 #define FF_IDCT_SIMPLENEON 22
1961 #define FF_IDCT_SIMPLEALPHA 23
1962 #define FF_IDCT_BINK 24
1966 * - encoding: Set by libavcodec.
1967 * - decoding: Set by user (or 0).
1971 * slice offsets in the frame in bytes
1972 * - encoding: Set/allocated by libavcodec.
1973 * - decoding: Set/allocated by user (or NULL).
1978 * error concealment flags
1979 * - encoding: unused
1980 * - decoding: Set by user.
1982 int error_concealment;
1983 #define FF_EC_GUESS_MVS 1
1984 #define FF_EC_DEBLOCK 2
1987 * dsp_mask could be add used to disable unwanted CPU features
1988 * CPU features (i.e. MMX, SSE. ...)
1990 * With the FORCE flag you may instead enable given CPU features.
1991 * (Dangerous: Usable in case of misdetection, improper usage however will
1992 * result into program crash.)
1997 * bits per sample/pixel from the demuxer (needed for huffyuv).
1998 * - encoding: Set by libavcodec.
1999 * - decoding: Set by user.
2001 int bits_per_coded_sample;
2004 * prediction method (needed for huffyuv)
2005 * - encoding: Set by user.
2006 * - decoding: unused
2008 int prediction_method;
2009 #define FF_PRED_LEFT 0
2010 #define FF_PRED_PLANE 1
2011 #define FF_PRED_MEDIAN 2
2014 * sample aspect ratio (0 if unknown)
2015 * That is the width of a pixel divided by the height of the pixel.
2016 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2017 * - encoding: Set by user.
2018 * - decoding: Set by libavcodec.
2020 AVRational sample_aspect_ratio;
2023 * the picture in the bitstream
2024 * - encoding: Set by libavcodec.
2025 * - decoding: Set by libavcodec.
2027 AVFrame *coded_frame;
2031 * - encoding: Set by user.
2032 * - decoding: Set by user.
2035 #define FF_DEBUG_PICT_INFO 1
2036 #define FF_DEBUG_RC 2
2037 #define FF_DEBUG_BITSTREAM 4
2038 #define FF_DEBUG_MB_TYPE 8
2039 #define FF_DEBUG_QP 16
2040 #define FF_DEBUG_MV 32
2041 #define FF_DEBUG_DCT_COEFF 0x00000040
2042 #define FF_DEBUG_SKIP 0x00000080
2043 #define FF_DEBUG_STARTCODE 0x00000100
2044 #define FF_DEBUG_PTS 0x00000200
2045 #define FF_DEBUG_ER 0x00000400
2046 #define FF_DEBUG_MMCO 0x00000800
2047 #define FF_DEBUG_BUGS 0x00001000
2048 #define FF_DEBUG_VIS_QP 0x00002000
2049 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2050 #define FF_DEBUG_BUFFERS 0x00008000
2051 #define FF_DEBUG_THREADS 0x00010000
2055 * - encoding: Set by user.
2056 * - decoding: Set by user.
2059 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2060 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2061 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2065 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2066 * - decoding: unused
2068 uint64_t error[AV_NUM_DATA_POINTERS];
2071 * motion estimation comparison function
2072 * - encoding: Set by user.
2073 * - decoding: unused
2077 * subpixel motion estimation comparison function
2078 * - encoding: Set by user.
2079 * - decoding: unused
2083 * macroblock comparison function (not supported yet)
2084 * - encoding: Set by user.
2085 * - decoding: unused
2089 * interlaced DCT comparison function
2090 * - encoding: Set by user.
2091 * - decoding: unused
2094 #define FF_CMP_SAD 0
2095 #define FF_CMP_SSE 1
2096 #define FF_CMP_SATD 2
2097 #define FF_CMP_DCT 3
2098 #define FF_CMP_PSNR 4
2099 #define FF_CMP_BIT 5
2101 #define FF_CMP_ZERO 7
2102 #define FF_CMP_VSAD 8
2103 #define FF_CMP_VSSE 9
2104 #define FF_CMP_NSSE 10
2105 #define FF_CMP_W53 11
2106 #define FF_CMP_W97 12
2107 #define FF_CMP_DCTMAX 13
2108 #define FF_CMP_DCT264 14
2109 #define FF_CMP_CHROMA 256
2112 * ME diamond size & shape
2113 * - encoding: Set by user.
2114 * - decoding: unused
2119 * amount of previous MV predictors (2a+1 x 2a+1 square)
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int last_predictor_count;
2126 * prepass for motion estimation
2127 * - encoding: Set by user.
2128 * - decoding: unused
2133 * motion estimation prepass comparison function
2134 * - encoding: Set by user.
2135 * - decoding: unused
2140 * ME prepass diamond size & shape
2141 * - encoding: Set by user.
2142 * - decoding: unused
2148 * - encoding: Set by user.
2149 * - decoding: unused
2151 int me_subpel_quality;
2154 * callback to negotiate the pixelFormat
2155 * @param fmt is the list of formats which are supported by the codec,
2156 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2157 * The first is always the native one.
2158 * @return the chosen format
2159 * - encoding: unused
2160 * - decoding: Set by user, if not set the native format will be chosen.
2162 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2165 * DTG active format information (additional aspect ratio
2166 * information only used in DVB MPEG-2 transport streams)
2169 * - encoding: unused
2170 * - decoding: Set by decoder.
2172 int dtg_active_format;
2173 #define FF_DTG_AFD_SAME 8
2174 #define FF_DTG_AFD_4_3 9
2175 #define FF_DTG_AFD_16_9 10
2176 #define FF_DTG_AFD_14_9 11
2177 #define FF_DTG_AFD_4_3_SP_14_9 13
2178 #define FF_DTG_AFD_16_9_SP_14_9 14
2179 #define FF_DTG_AFD_SP_4_3 15
2182 * maximum motion estimation search range in subpel units
2183 * If 0 then no limit.
2185 * - encoding: Set by user.
2186 * - decoding: unused
2191 * intra quantizer bias
2192 * - encoding: Set by user.
2193 * - decoding: unused
2195 int intra_quant_bias;
2196 #define FF_DEFAULT_QUANT_BIAS 999999
2199 * inter quantizer bias
2200 * - encoding: Set by user.
2201 * - decoding: unused
2203 int inter_quant_bias;
2207 * - encoding: unused
2208 * - decoding: Which clrtable should be used for 8bit RGB images.
2209 * Tables have to be stored somewhere. FIXME
2213 #if FF_API_INTERNAL_CONTEXT
2215 * internal_buffer count
2216 * Don't touch, used by libavcodec default_get_buffer().
2217 * @deprecated this field was moved to an internal context
2219 attribute_deprecated int internal_buffer_count;
2223 * Don't touch, used by libavcodec default_get_buffer().
2224 * @deprecated this field was moved to an internal context
2226 attribute_deprecated void *internal_buffer;
2230 * Global quality for codecs which cannot change it per frame.
2231 * This should be proportional to MPEG-1/2/4 qscale.
2232 * - encoding: Set by user.
2233 * - decoding: unused
2237 #define FF_CODER_TYPE_VLC 0
2238 #define FF_CODER_TYPE_AC 1
2239 #define FF_CODER_TYPE_RAW 2
2240 #define FF_CODER_TYPE_RLE 3
2241 #define FF_CODER_TYPE_DEFLATE 4
2244 * - encoding: Set by user.
2245 * - decoding: unused
2251 * - encoding: Set by user.
2252 * - decoding: unused
2258 * - encoding: unused
2259 * - decoding: Set by user.
2261 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2266 * - encoding: unused
2267 * - decoding: Set by user.
2270 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2271 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2272 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2275 * XVideo Motion Acceleration
2276 * - encoding: forbidden
2277 * - decoding: set by decoder
2279 int xvmc_acceleration;
2282 * macroblock decision mode
2283 * - encoding: Set by user.
2284 * - decoding: unused
2287 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2288 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2289 #define FF_MB_DECISION_RD 2 ///< rate distortion
2292 * custom intra quantization matrix
2293 * - encoding: Set by user, can be NULL.
2294 * - decoding: Set by libavcodec.
2296 uint16_t *intra_matrix;
2299 * custom inter quantization matrix
2300 * - encoding: Set by user, can be NULL.
2301 * - decoding: Set by libavcodec.
2303 uint16_t *inter_matrix;
2306 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2307 * This is used to work around some encoder bugs.
2308 * - encoding: unused
2309 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2311 unsigned int stream_codec_tag;
2314 * scene change detection threshold
2315 * 0 is default, larger means fewer detected scene changes.
2316 * - encoding: Set by user.
2317 * - decoding: unused
2319 int scenechange_threshold;
2322 * minimum Lagrange multipler
2323 * - encoding: Set by user.
2324 * - decoding: unused
2329 * maximum Lagrange multipler
2330 * - encoding: Set by user.
2331 * - decoding: unused
2335 #if FF_API_PALETTE_CONTROL
2337 * palette control structure
2338 * - encoding: ??? (no palette-enabled encoder yet)
2339 * - decoding: Set by user.
2341 struct AVPaletteControl *palctrl;
2345 * noise reduction strength
2346 * - encoding: Set by user.
2347 * - decoding: unused
2349 int noise_reduction;
2352 * Called at the beginning of a frame to get cr buffer for it.
2353 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2354 * libavcodec will pass previous buffer in pic, function should return
2355 * same buffer or new buffer with old frame "painted" into it.
2356 * If pic.data[0] == NULL must behave like get_buffer().
2357 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2358 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2360 * - encoding: unused
2361 * - decoding: Set by libavcodec, user can override.
2363 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2366 * Number of bits which should be loaded into the rc buffer before decoding starts.
2367 * - encoding: Set by user.
2368 * - decoding: unused
2370 int rc_initial_buffer_occupancy;
2374 * - encoding: Set by user.
2375 * - decoding: unused
2377 int inter_threshold;
2381 * - encoding: Set by user.
2382 * - decoding: Set by user.
2387 * Simulates errors in the bitstream to test error concealment.
2388 * - encoding: Set by user.
2389 * - decoding: unused
2393 #if FF_API_ANTIALIAS_ALGO
2395 * MP3 antialias algorithm, see FF_AA_* below.
2396 * - encoding: unused
2397 * - decoding: Set by user.
2399 attribute_deprecated int antialias_algo;
2400 #define FF_AA_AUTO 0
2401 #define FF_AA_FASTINT 1 //not implemented yet
2403 #define FF_AA_FLOAT 3
2407 * quantizer noise shaping
2408 * - encoding: Set by user.
2409 * - decoding: unused
2411 int quantizer_noise_shaping;
2415 * is used to decide how many independent tasks should be passed to execute()
2416 * - encoding: Set by user.
2417 * - decoding: Set by user.
2422 * The codec may call this to execute several independent things.
2423 * It will return only after finishing all tasks.
2424 * The user may replace this with some multithreaded implementation,
2425 * the default implementation will execute the parts serially.
2426 * @param count the number of things to execute
2427 * - encoding: Set by libavcodec, user can override.
2428 * - decoding: Set by libavcodec, user can override.
2430 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2434 * Can be used by execute() to store some per AVCodecContext stuff.
2435 * - encoding: set by execute()
2436 * - decoding: set by execute()
2438 void *thread_opaque;
2441 * Motion estimation threshold below which no motion estimation is
2442 * performed, but instead the user specified motion vectors are used.
2444 * - encoding: Set by user.
2445 * - decoding: unused
2450 * Macroblock threshold below which the user specified macroblock types will be used.
2451 * - encoding: Set by user.
2452 * - decoding: unused
2457 * precision of the intra DC coefficient - 8
2458 * - encoding: Set by user.
2459 * - decoding: unused
2461 int intra_dc_precision;
2464 * noise vs. sse weight for the nsse comparsion function
2465 * - encoding: Set by user.
2466 * - decoding: unused
2471 * Number of macroblock rows at the top which are skipped.
2472 * - encoding: unused
2473 * - decoding: Set by user.
2478 * Number of macroblock rows at the bottom which are skipped.
2479 * - encoding: unused
2480 * - decoding: Set by user.
2486 * - encoding: Set by user.
2487 * - decoding: Set by libavcodec.
2490 #define FF_PROFILE_UNKNOWN -99
2491 #define FF_PROFILE_RESERVED -100
2493 #define FF_PROFILE_AAC_MAIN 0
2494 #define FF_PROFILE_AAC_LOW 1
2495 #define FF_PROFILE_AAC_SSR 2
2496 #define FF_PROFILE_AAC_LTP 3
2498 #define FF_PROFILE_DTS 20
2499 #define FF_PROFILE_DTS_ES 30
2500 #define FF_PROFILE_DTS_96_24 40
2501 #define FF_PROFILE_DTS_HD_HRA 50
2502 #define FF_PROFILE_DTS_HD_MA 60
2504 #define FF_PROFILE_MPEG2_422 0
2505 #define FF_PROFILE_MPEG2_HIGH 1
2506 #define FF_PROFILE_MPEG2_SS 2
2507 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2508 #define FF_PROFILE_MPEG2_MAIN 4
2509 #define FF_PROFILE_MPEG2_SIMPLE 5
2511 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2512 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2514 #define FF_PROFILE_H264_BASELINE 66
2515 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2516 #define FF_PROFILE_H264_MAIN 77
2517 #define FF_PROFILE_H264_EXTENDED 88
2518 #define FF_PROFILE_H264_HIGH 100
2519 #define FF_PROFILE_H264_HIGH_10 110
2520 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2521 #define FF_PROFILE_H264_HIGH_422 122
2522 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2523 #define FF_PROFILE_H264_HIGH_444 144
2524 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2525 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2526 #define FF_PROFILE_H264_CAVLC_444 44
2528 #define FF_PROFILE_VC1_SIMPLE 0
2529 #define FF_PROFILE_VC1_MAIN 1
2530 #define FF_PROFILE_VC1_COMPLEX 2
2531 #define FF_PROFILE_VC1_ADVANCED 3
2533 #define FF_PROFILE_MPEG4_SIMPLE 0
2534 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2535 #define FF_PROFILE_MPEG4_CORE 2
2536 #define FF_PROFILE_MPEG4_MAIN 3
2537 #define FF_PROFILE_MPEG4_N_BIT 4
2538 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2539 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2540 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2541 #define FF_PROFILE_MPEG4_HYBRID 8
2542 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2543 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2544 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2545 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2546 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2547 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2548 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2552 * - encoding: Set by user.
2553 * - decoding: Set by libavcodec.
2556 #define FF_LEVEL_UNKNOWN -99
2559 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2560 * - encoding: unused
2561 * - decoding: Set by user.
2566 * Bitstream width / height, may be different from width/height if lowres enabled.
2567 * - encoding: unused
2568 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2570 int coded_width, coded_height;
2573 * frame skip threshold
2574 * - encoding: Set by user.
2575 * - decoding: unused
2577 int frame_skip_threshold;
2581 * - encoding: Set by user.
2582 * - decoding: unused
2584 int frame_skip_factor;
2587 * frame skip exponent
2588 * - encoding: Set by user.
2589 * - decoding: unused
2594 * frame skip comparison function
2595 * - encoding: Set by user.
2596 * - decoding: unused
2601 * Border processing masking, raises the quantizer for mbs on the borders
2603 * - encoding: Set by user.
2604 * - decoding: unused
2606 float border_masking;
2609 * minimum MB lagrange multipler
2610 * - encoding: Set by user.
2611 * - decoding: unused
2616 * maximum MB lagrange multipler
2617 * - encoding: Set by user.
2618 * - decoding: unused
2624 * - encoding: Set by user.
2625 * - decoding: unused
2627 int me_penalty_compensation;
2631 * - encoding: unused
2632 * - decoding: Set by user.
2634 enum AVDiscard skip_loop_filter;
2638 * - encoding: unused
2639 * - decoding: Set by user.
2641 enum AVDiscard skip_idct;
2645 * - encoding: unused
2646 * - decoding: Set by user.
2648 enum AVDiscard skip_frame;
2652 * - encoding: Set by user.
2653 * - decoding: unused
2659 * - encoding: Set by user.
2660 * - decoding: unused
2664 #if FF_API_X264_GLOBAL_OPTS
2666 * constant rate factor - quality-based VBR - values ~correspond to qps
2667 * - encoding: Set by user.
2668 * - decoding: unused
2669 * @deprecated use 'crf' libx264 private option
2671 attribute_deprecated float crf;
2674 * constant quantization parameter rate control method
2675 * - encoding: Set by user.
2676 * - decoding: unused
2677 * @deprecated use 'cqp' libx264 private option
2679 attribute_deprecated int cqp;
2684 * - encoding: Set by user.
2685 * - decoding: unused
2690 * number of reference frames
2691 * - encoding: Set by user.
2692 * - decoding: Set by lavc.
2697 * chroma qp offset from luma
2698 * - encoding: Set by user.
2699 * - decoding: unused
2703 #if FF_API_X264_GLOBAL_OPTS
2705 * Influence how often B-frames are used.
2706 * - encoding: Set by user.
2707 * - decoding: unused
2709 attribute_deprecated int bframebias;
2713 * trellis RD quantization
2714 * - encoding: Set by user.
2715 * - decoding: unused
2719 #if FF_API_X264_GLOBAL_OPTS
2721 * Reduce fluctuations in qp (before curve compression).
2722 * - encoding: Set by user.
2723 * - decoding: unused
2725 attribute_deprecated float complexityblur;
2728 * in-loop deblocking filter alphac0 parameter
2729 * alpha is in the range -6...6
2730 * - encoding: Set by user.
2731 * - decoding: unused
2733 attribute_deprecated int deblockalpha;
2736 * in-loop deblocking filter beta parameter
2737 * beta is in the range -6...6
2738 * - encoding: Set by user.
2739 * - decoding: unused
2741 attribute_deprecated int deblockbeta;
2744 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2745 * - encoding: Set by user.
2746 * - decoding: unused
2748 attribute_deprecated int partitions;
2749 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2750 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2751 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2752 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2753 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2756 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2757 * - encoding: Set by user.
2758 * - decoding: unused
2760 attribute_deprecated int directpred;
2764 * Audio cutoff bandwidth (0 means "automatic")
2765 * - encoding: Set by user.
2766 * - decoding: unused
2771 * Multiplied by qscale for each frame and added to scene_change_score.
2772 * - encoding: Set by user.
2773 * - decoding: unused
2775 int scenechange_factor;
2779 * Note: Value depends upon the compare function used for fullpel ME.
2780 * - encoding: Set by user.
2781 * - decoding: unused
2786 * Adjust sensitivity of b_frame_strategy 1.
2787 * - encoding: Set by user.
2788 * - decoding: unused
2793 * - encoding: Set by user.
2794 * - decoding: unused
2796 int compression_level;
2797 #define FF_COMPRESSION_DEFAULT -1
2800 * - encoding: Set by user.
2801 * - decoding: unused
2803 int min_prediction_order;
2806 * - encoding: Set by user.
2807 * - decoding: unused
2809 int max_prediction_order;
2811 #if FF_API_FLAC_GLOBAL_OPTS
2813 * @name FLAC options
2814 * @deprecated Use FLAC encoder private options instead.
2819 * LPC coefficient precision - used by FLAC encoder
2820 * - encoding: Set by user.
2821 * - decoding: unused
2823 attribute_deprecated int lpc_coeff_precision;
2826 * search method for selecting prediction order
2827 * - encoding: Set by user.
2828 * - decoding: unused
2830 attribute_deprecated int prediction_order_method;
2833 * - encoding: Set by user.
2834 * - decoding: unused
2836 attribute_deprecated int min_partition_order;
2839 * - encoding: Set by user.
2840 * - decoding: unused
2842 attribute_deprecated int max_partition_order;
2849 * GOP timecode frame start number
2850 * - encoding: Set by user, in non drop frame format
2851 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2853 int64_t timecode_frame_start;
2855 #if FF_API_REQUEST_CHANNELS
2857 * Decoder should decode to this many channels if it can (0 for default)
2858 * - encoding: unused
2859 * - decoding: Set by user.
2860 * @deprecated Deprecated in favor of request_channel_layout.
2862 int request_channels;
2865 #if FF_API_DRC_SCALE
2867 * Percentage of dynamic range compression to be applied by the decoder.
2868 * The default value is 1.0, corresponding to full compression.
2869 * - encoding: unused
2870 * - decoding: Set by user.
2871 * @deprecated use AC3 decoder private option instead.
2873 attribute_deprecated float drc_scale;
2877 * opaque 64bit number (generally a PTS) that will be reordered and
2878 * output in AVFrame.reordered_opaque
2879 * @deprecated in favor of pkt_pts
2880 * - encoding: unused
2881 * - decoding: Set by user.
2883 int64_t reordered_opaque;
2886 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2887 * - encoding: set by user.
2888 * - decoding: set by libavcodec.
2890 int bits_per_raw_sample;
2893 * Audio channel layout.
2894 * - encoding: set by user.
2895 * - decoding: set by user, may be overwritten by libavcodec.
2897 uint64_t channel_layout;
2900 * Request decoder to use this channel layout if it can (0 for default)
2901 * - encoding: unused
2902 * - decoding: Set by user.
2904 uint64_t request_channel_layout;
2907 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2908 * - encoding: Set by user.
2909 * - decoding: unused.
2911 float rc_max_available_vbv_use;
2914 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2915 * - encoding: Set by user.
2916 * - decoding: unused.
2918 float rc_min_vbv_overflow_use;
2921 * Hardware accelerator in use
2922 * - encoding: unused.
2923 * - decoding: Set by libavcodec
2925 struct AVHWAccel *hwaccel;
2928 * For some codecs, the time base is closer to the field rate than the frame rate.
2929 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2930 * if no telecine is used ...
2932 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2934 int ticks_per_frame;
2937 * Hardware accelerator context.
2938 * For some hardware accelerators, a global context needs to be
2939 * provided by the user. In that case, this holds display-dependent
2940 * data FFmpeg cannot instantiate itself. Please refer to the
2941 * FFmpeg HW accelerator documentation to know how to fill this
2942 * is. e.g. for VA API, this is a struct vaapi_context.
2943 * - encoding: unused
2944 * - decoding: Set by user
2946 void *hwaccel_context;
2949 * Chromaticity coordinates of the source primaries.
2950 * - encoding: Set by user
2951 * - decoding: Set by libavcodec
2953 enum AVColorPrimaries color_primaries;
2956 * Color Transfer Characteristic.
2957 * - encoding: Set by user
2958 * - decoding: Set by libavcodec
2960 enum AVColorTransferCharacteristic color_trc;
2963 * YUV colorspace type.
2964 * - encoding: Set by user
2965 * - decoding: Set by libavcodec
2967 enum AVColorSpace colorspace;
2970 * MPEG vs JPEG YUV range.
2971 * - encoding: Set by user
2972 * - decoding: Set by libavcodec
2974 enum AVColorRange color_range;
2977 * This defines the location of chroma samples.
2978 * - encoding: Set by user
2979 * - decoding: Set by libavcodec
2981 enum AVChromaLocation chroma_sample_location;
2984 * The codec may call this to execute several independent things.
2985 * It will return only after finishing all tasks.
2986 * The user may replace this with some multithreaded implementation,
2987 * the default implementation will execute the parts serially.
2988 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2989 * @param c context passed also to func
2990 * @param count the number of things to execute
2991 * @param arg2 argument passed unchanged to func
2992 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2993 * @param func function that will be called count times, with jobnr from 0 to count-1.
2994 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2995 * two instances of func executing at the same time will have the same threadnr.
2996 * @return always 0 currently, but code should handle a future improvement where when any call to func
2997 * returns < 0 no further calls to func may be done and < 0 is returned.
2998 * - encoding: Set by libavcodec, user can override.
2999 * - decoding: Set by libavcodec, user can override.
3001 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3003 #if FF_API_X264_GLOBAL_OPTS
3005 * explicit P-frame weighted prediction analysis method
3007 * 1: fast blind weighting (one reference duplicate with -1 offset)
3008 * 2: smart weighting (full fade detection analysis)
3009 * - encoding: Set by user.
3010 * - decoding: unused
3012 attribute_deprecated int weighted_p_pred;
3017 * 1: Variance AQ (complexity mask)
3018 * 2: Auto-variance AQ (experimental)
3019 * - encoding: Set by user
3020 * - decoding: unused
3022 attribute_deprecated int aq_mode;
3026 * Reduces blocking and blurring in flat and textured areas.
3027 * - encoding: Set by user
3028 * - decoding: unused
3030 attribute_deprecated float aq_strength;
3034 * Strength of psychovisual optimization
3035 * - encoding: Set by user
3036 * - decoding: unused
3038 attribute_deprecated float psy_rd;
3042 * Strength of psychovisual optimization
3043 * - encoding: Set by user
3044 * - decoding: unused
3046 attribute_deprecated float psy_trellis;
3050 * Number of frames for frametype and ratecontrol lookahead
3051 * - encoding: Set by user
3052 * - decoding: unused
3054 attribute_deprecated int rc_lookahead;
3057 * Constant rate factor maximum
3058 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
3059 * than crf_max, even if doing so would violate VBV restrictions.
3060 * - encoding: Set by user.
3061 * - decoding: unused
3063 attribute_deprecated float crf_max;
3066 int log_level_offset;
3068 #if FF_API_FLAC_GLOBAL_OPTS
3070 * Determine which LPC analysis algorithm to use.
3071 * - encoding: Set by user
3072 * - decoding: unused
3074 attribute_deprecated enum AVLPCType lpc_type;
3077 * Number of passes to use for Cholesky factorization during LPC analysis
3078 * - encoding: Set by user
3079 * - decoding: unused
3081 attribute_deprecated int lpc_passes;
3086 * Indicates number of picture subdivisions. Used for parallelized
3088 * - encoding: Set by user
3089 * - decoding: unused
3094 * Header containing style information for text subtitles.
3095 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3096 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3097 * the Format line following. It shouldn't include any Dialogue line.
3098 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3099 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3101 uint8_t *subtitle_header;
3102 int subtitle_header_size;
3105 * Current packet as passed into the decoder, to avoid having
3106 * to pass the packet into every function. Currently only valid
3107 * inside lavc and get/release_buffer callbacks.
3108 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3109 * - encoding: unused
3113 #if FF_API_INTERNAL_CONTEXT
3115 * Whether this is a copy of the context which had init() called on it.
3116 * This is used by multithreading - shared tables and picture pointers
3117 * should be freed from the original context only.
3118 * - encoding: Set by libavcodec.
3119 * - decoding: Set by libavcodec.
3121 * @deprecated this field has been moved to an internal context
3123 attribute_deprecated int is_copy;
3127 * Which multithreading methods to use.
3128 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3129 * so clients which cannot provide future frames should not use it.
3131 * - encoding: Set by user, otherwise the default is used.
3132 * - decoding: Set by user, otherwise the default is used.
3135 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
3136 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
3139 * Which multithreading methods are in use by the codec.
3140 * - encoding: Set by libavcodec.
3141 * - decoding: Set by libavcodec.
3143 int active_thread_type;
3146 * Set by the client if its custom get_buffer() callback can be called
3147 * from another thread, which allows faster multithreaded decoding.
3148 * draw_horiz_band() will be called from other threads regardless of this setting.
3149 * Ignored if the default get_buffer() is used.
3150 * - encoding: Set by user.
3151 * - decoding: Set by user.
3153 int thread_safe_callbacks;
3156 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3157 * Used for compliant TS muxing.
3158 * - encoding: Set by libavcodec.
3159 * - decoding: unused.
3164 * Type of service that the audio stream conveys.
3165 * - encoding: Set by user.
3166 * - decoding: Set by libavcodec.
3168 enum AVAudioServiceType audio_service_type;
3171 * desired sample format
3172 * - encoding: Not used.
3173 * - decoding: Set by user.
3174 * Decoder will decode to this format if it can.
3176 enum AVSampleFormat request_sample_fmt;
3179 * Error recognition; may misdetect some more or less valid parts as errors.
3180 * - encoding: unused
3181 * - decoding: Set by user.
3183 int err_recognition;
3184 #define AV_EF_CRCCHECK (1<<0)
3185 #define AV_EF_BITSTREAM (1<<1)
3186 #define AV_EF_BUFFER (1<<2)
3187 #define AV_EF_EXPLODE (1<<3)
3189 #define AV_EF_CAREFUL (1<<16)
3190 #define AV_EF_COMPLIANT (1<<17)
3191 #define AV_EF_AGGRESSIVE (1<<18)
3194 * Private context used for internal data.
3196 * Unlike priv_data, this is not codec-specific. It is used in general
3197 * libavcodec functions.
3199 struct AVCodecInternal *internal;
3202 * - encoding: set by libavcodec
3203 * - decoding: Set by libavcodec
3205 enum AVFieldOrder field_order;
3208 * Current statistics for PTS correction.
3209 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3210 * - encoding: unused
3212 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3213 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3214 int64_t pts_correction_last_pts; /// PTS of the last frame
3215 int64_t pts_correction_last_dts; /// DTS of the last frame
3222 typedef struct AVProfile {
3224 const char *name; ///< short name for the profile
3227 typedef struct AVCodecDefault AVCodecDefault;
3232 typedef struct AVCodec {
3234 * Name of the codec implementation.
3235 * The name is globally unique among encoders and among decoders (but an
3236 * encoder and a decoder can share the same name).
3237 * This is the primary way to find a codec from the user perspective.
3240 enum AVMediaType type;
3243 int (*init)(AVCodecContext *);
3244 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3245 int (*close)(AVCodecContext *);
3246 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3248 * Codec capabilities.
3252 struct AVCodec *next;
3255 * Will be called when seeking
3257 void (*flush)(AVCodecContext *);
3258 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3259 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3261 * Descriptive name for the codec, meant to be more human readable than name.
3262 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3264 const char *long_name;
3265 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3266 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3267 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3268 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3269 const AVClass *priv_class; ///< AVClass for the private context
3270 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3273 * @name Frame-level threading support functions
3277 * If defined, called on thread contexts when they are created.
3278 * If the codec allocates writable tables in init(), re-allocate them here.
3279 * priv_data will be set to a copy of the original.
3281 int (*init_thread_copy)(AVCodecContext *);
3283 * Copy necessary context variables from a previous thread context to the current one.
3284 * If not defined, the next thread will start automatically; otherwise, the codec
3285 * must call ff_thread_finish_setup().
3287 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3289 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3293 * Private codec-specific defaults.
3295 const AVCodecDefault *defaults;
3298 * Initialize codec static data, called from avcodec_register().
3300 void (*init_static_data)(struct AVCodec *codec);
3306 typedef struct AVHWAccel {
3308 * Name of the hardware accelerated codec.
3309 * The name is globally unique among encoders and among decoders (but an
3310 * encoder and a decoder can share the same name).
3315 * Type of codec implemented by the hardware accelerator.
3317 * See AVMEDIA_TYPE_xxx
3319 enum AVMediaType type;
3322 * Codec implemented by the hardware accelerator.
3329 * Supported pixel format.
3331 * Only hardware accelerated formats are supported here.
3333 enum PixelFormat pix_fmt;
3336 * Hardware accelerated codec capabilities.
3337 * see FF_HWACCEL_CODEC_CAP_*
3341 struct AVHWAccel *next;
3344 * Called at the beginning of each frame or field picture.
3346 * Meaningful frame information (codec specific) is guaranteed to
3347 * be parsed at this point. This function is mandatory.
3349 * Note that buf can be NULL along with buf_size set to 0.
3350 * Otherwise, this means the whole frame is available at this point.
3352 * @param avctx the codec context
3353 * @param buf the frame data buffer base
3354 * @param buf_size the size of the frame in bytes
3355 * @return zero if successful, a negative value otherwise
3357 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3360 * Callback for each slice.
3362 * Meaningful slice information (codec specific) is guaranteed to
3363 * be parsed at this point. This function is mandatory.
3365 * @param avctx the codec context
3366 * @param buf the slice data buffer base
3367 * @param buf_size the size of the slice in bytes
3368 * @return zero if successful, a negative value otherwise
3370 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3373 * Called at the end of each frame or field picture.
3375 * The whole picture is parsed at this point and can now be sent
3376 * to the hardware accelerator. This function is mandatory.
3378 * @param avctx the codec context
3379 * @return zero if successful, a negative value otherwise
3381 int (*end_frame)(AVCodecContext *avctx);
3384 * Size of HW accelerator private data.
3386 * Private data is allocated with av_mallocz() before
3387 * AVCodecContext.get_buffer() and deallocated after
3388 * AVCodecContext.release_buffer().
3394 * four components are given, that's all.
3395 * the last component is alpha
3397 typedef struct AVPicture {
3398 uint8_t *data[AV_NUM_DATA_POINTERS];
3399 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3402 #define AVPALETTE_SIZE 1024
3403 #define AVPALETTE_COUNT 256
3404 #if FF_API_PALETTE_CONTROL
3407 * This structure defines a method for communicating palette changes
3408 * between and demuxer and a decoder.
3410 * @deprecated Use AVPacket to send palette changes instead.
3411 * This is totally broken.
3413 typedef struct AVPaletteControl {
3415 /* Demuxer sets this to 1 to indicate the palette has changed;
3416 * decoder resets to 0. */
3417 int palette_changed;
3419 /* 4-byte ARGB palette entries, stored in native byte order; note that
3420 * the individual palette components should be on a 8-bit scale; if
3421 * the palette data comes from an IBM VGA native format, the component
3422 * data is probably 6 bits in size and needs to be scaled. */
3423 unsigned int palette[AVPALETTE_COUNT];
3425 } AVPaletteControl attribute_deprecated;
3428 enum AVSubtitleType {
3431 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3434 * Plain text, the text field must be set by the decoder and is
3435 * authoritative. ass and pict fields may contain approximations.
3440 * Formatted text, the ass field must be set by the decoder and is
3441 * authoritative. pict and text fields may contain approximations.
3446 typedef struct AVSubtitleRect {
3447 int x; ///< top left corner of pict, undefined when pict is not set
3448 int y; ///< top left corner of pict, undefined when pict is not set
3449 int w; ///< width of pict, undefined when pict is not set
3450 int h; ///< height of pict, undefined when pict is not set
3451 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3454 * data+linesize for the bitmap of this subtitle.
3455 * can be set for text/ass as well once they where rendered
3458 enum AVSubtitleType type;
3460 char *text; ///< 0 terminated plain UTF-8 text
3463 * 0 terminated ASS/SSA compatible event line.
3464 * The pressentation of this is unaffected by the other values in this
3470 typedef struct AVSubtitle {
3471 uint16_t format; /* 0 = graphics */
3472 uint32_t start_display_time; /* relative to packet pts, in ms */
3473 uint32_t end_display_time; /* relative to packet pts, in ms */
3475 AVSubtitleRect **rects;
3476 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3479 /* packet functions */
3482 * @deprecated use NULL instead
3484 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3487 * Default packet destructor.
3489 void av_destruct_packet(AVPacket *pkt);
3492 * Initialize optional fields of a packet with default values.
3496 void av_init_packet(AVPacket *pkt);
3499 * Allocate the payload of a packet and initialize its fields with
3503 * @param size wanted payload size
3504 * @return 0 if OK, AVERROR_xxx otherwise
3506 int av_new_packet(AVPacket *pkt, int size);
3509 * Reduce packet size, correctly zeroing padding
3512 * @param size new size
3514 void av_shrink_packet(AVPacket *pkt, int size);
3517 * Increase packet size, correctly zeroing padding
3520 * @param grow_by number of bytes by which to increase the size of the packet
3522 int av_grow_packet(AVPacket *pkt, int grow_by);
3525 * @warning This is a hack - the packet memory allocation stuff is broken. The
3526 * packet is allocated if it was not really allocated.
3528 int av_dup_packet(AVPacket *pkt);
3533 * @param pkt packet to free
3535 void av_free_packet(AVPacket *pkt);
3538 * Allocate new information of a packet.
3541 * @param type side information type
3542 * @param size side information size
3543 * @return pointer to fresh allocated data or NULL otherwise
3545 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3549 * Get side information from packet.
3552 * @param type desired side information type
3553 * @param size pointer for side information size to store (optional)
3554 * @return pointer to data if present or NULL otherwise
3556 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3559 int av_packet_merge_side_data(AVPacket *pkt);
3561 int av_packet_split_side_data(AVPacket *pkt);
3566 struct ReSampleContext;
3567 struct AVResampleContext;
3569 typedef struct ReSampleContext ReSampleContext;
3572 * Initialize audio resampling context.
3574 * @param output_channels number of output channels
3575 * @param input_channels number of input channels
3576 * @param output_rate output sample rate
3577 * @param input_rate input sample rate
3578 * @param sample_fmt_out requested output sample format
3579 * @param sample_fmt_in input sample format
3580 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3581 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3582 * @param linear if 1 then the used FIR filter will be linearly interpolated
3583 between the 2 closest, if 0 the closest will be used
3584 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3585 * @return allocated ReSampleContext, NULL if error occurred
3587 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3588 int output_rate, int input_rate,
3589 enum AVSampleFormat sample_fmt_out,
3590 enum AVSampleFormat sample_fmt_in,
3591 int filter_length, int log2_phase_count,
3592 int linear, double cutoff);
3594 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3597 * Free resample context.
3599 * @param s a non-NULL pointer to a resample context previously
3600 * created with av_audio_resample_init()
3602 void audio_resample_close(ReSampleContext *s);
3606 * Initialize an audio resampler.
3607 * Note, if either rate is not an integer then simply scale both rates up so they are.
3608 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3609 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3610 * @param linear If 1 then the used FIR filter will be linearly interpolated
3611 between the 2 closest, if 0 the closest will be used
3612 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3614 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3617 * Resample an array of samples using a previously configured context.
3618 * @param src an array of unconsumed samples
3619 * @param consumed the number of samples of src which have been consumed are returned here
3620 * @param src_size the number of unconsumed samples available
3621 * @param dst_size the amount of space in samples available in dst
3622 * @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.
3623 * @return the number of samples written in dst or -1 if an error occurred
3625 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3629 * Compensate samplerate/timestamp drift. The compensation is done by changing
3630 * the resampler parameters, so no audible clicks or similar distortions occur
3631 * @param compensation_distance distance in output samples over which the compensation should be performed
3632 * @param sample_delta number of output samples which should be output less
3634 * example: av_resample_compensate(c, 10, 500)
3635 * here instead of 510 samples only 500 samples would be output
3637 * note, due to rounding the actual compensation might be slightly different,
3638 * especially if the compensation_distance is large and the in_rate used during init is small
3640 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3641 void av_resample_close(struct AVResampleContext *c);
3644 * Allocate memory for a picture. Call avpicture_free() to free it.
3646 * @see avpicture_fill()
3648 * @param picture the picture to be filled in
3649 * @param pix_fmt the format of the picture
3650 * @param width the width of the picture
3651 * @param height the height of the picture
3652 * @return zero if successful, a negative value if not
3654 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3657 * Free a picture previously allocated by avpicture_alloc().
3658 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3661 * @param picture the AVPicture to be freed
3663 void avpicture_free(AVPicture *picture);
3666 * Fill in the AVPicture fields.
3667 * The fields of the given AVPicture are filled in by using the 'ptr' address
3668 * which points to the image data buffer. Depending on the specified picture
3669 * format, one or multiple image data pointers and line sizes will be set.
3670 * If a planar format is specified, several pointers will be set pointing to
3671 * the different picture planes and the line sizes of the different planes
3672 * will be stored in the lines_sizes array.
3673 * Call with ptr == NULL to get the required size for the ptr buffer.
3675 * To allocate the buffer and fill in the AVPicture fields in one call,
3676 * use avpicture_alloc().
3678 * @param picture AVPicture whose fields are to be filled in
3679 * @param ptr Buffer which will contain or contains the actual image data
3680 * @param pix_fmt The format in which the picture data is stored.
3681 * @param width the width of the image in pixels
3682 * @param height the height of the image in pixels
3683 * @return size of the image data in bytes
3685 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3686 enum PixelFormat pix_fmt, int width, int height);
3689 * Copy pixel data from an AVPicture into a buffer.
3690 * The data is stored compactly, without any gaps for alignment or padding
3691 * which may be applied by avpicture_fill().
3693 * @see avpicture_get_size()
3695 * @param[in] src AVPicture containing image data
3696 * @param[in] pix_fmt The format in which the picture data is stored.
3697 * @param[in] width the width of the image in pixels.
3698 * @param[in] height the height of the image in pixels.
3699 * @param[out] dest A buffer into which picture data will be copied.
3700 * @param[in] dest_size The size of 'dest'.
3701 * @return The number of bytes written to dest, or a negative value (error code) on error.
3703 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3704 unsigned char *dest, int dest_size);
3707 * Calculate the size in bytes that a picture of the given width and height
3708 * would occupy if stored in the given picture format.
3709 * Note that this returns the size of a compact representation as generated
3710 * by avpicture_layout(), which can be smaller than the size required for e.g.
3713 * @param pix_fmt the given picture format
3714 * @param width the width of the image
3715 * @param height the height of the image
3716 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3718 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3719 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3722 * Get the name of a codec.
3723 * @return a static string identifying the codec; never NULL
3725 const char *avcodec_get_name(enum CodecID id);
3727 #if FF_API_GET_PIX_FMT_NAME
3729 * Return the short name for a pixel format.
3731 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3732 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3734 attribute_deprecated
3735 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3738 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3741 * Return a value representing the fourCC code associated to the
3742 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3745 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3748 * Put a string representing the codec tag codec_tag in buf.
3750 * @param buf_size size in bytes of buf
3751 * @return the length of the string that would have been generated if
3752 * enough space had been available, excluding the trailing null
3754 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3756 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3757 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3758 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3759 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3760 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3761 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3764 * Compute what kind of losses will occur when converting from one specific
3765 * pixel format to another.
3766 * When converting from one pixel format to another, information loss may occur.
3767 * For example, when converting from RGB24 to GRAY, the color information will
3768 * be lost. Similarly, other losses occur when converting from some formats to
3769 * other formats. These losses can involve loss of chroma, but also loss of
3770 * resolution, loss of color depth, loss due to the color space conversion, loss
3771 * of the alpha bits or loss due to color quantization.
3772 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3773 * which will occur when converting from one pixel format to another.
3775 * @param[in] dst_pix_fmt destination pixel format
3776 * @param[in] src_pix_fmt source pixel format
3777 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3778 * @return Combination of flags informing you what kind of losses will occur
3779 * (maximum loss for an invalid dst_pix_fmt).
3781 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3785 * Find the best pixel format to convert to given a certain source pixel
3786 * format. When converting from one pixel format to another, information loss
3787 * may occur. For example, when converting from RGB24 to GRAY, the color
3788 * information will be lost. Similarly, other losses occur when converting from
3789 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3790 * the given pixel formats should be used to suffer the least amount of loss.
3791 * The pixel formats from which it chooses one, are determined by the
3792 * pix_fmt_mask parameter.
3794 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3797 * src_pix_fmt = PIX_FMT_YUV420P;
3798 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3799 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3802 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3803 * @param[in] src_pix_fmt source pixel format
3804 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3805 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3806 * @return The best pixel format to convert to or -1 if none was found.
3808 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3809 int has_alpha, int *loss_ptr);
3812 * Find the best pixel format to convert to given a certain source pixel
3813 * format and a selection of two destination pixel formats. When converting from
3814 * one pixel format to another, information loss may occur. For example, when converting
3815 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3816 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3817 * the given pixel formats should be used to suffer the least amount of loss.
3819 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3823 * src_pix_fmt = PIX_FMT_YUV420P;
3824 * dst_pix_fmt1= PIX_FMT_RGB24;
3825 * dst_pix_fmt2= PIX_FMT_GRAY8;
3826 * dst_pix_fmt3= PIX_FMT_RGB8;
3827 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3828 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3829 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3832 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3833 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3834 * @param[in] src_pix_fmt Source pixel format
3835 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3836 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3837 * NULL or value of zero means we care about all losses. Out: the loss
3838 * that occurs when converting from src to selected dst pixel format.
3839 * @return The best pixel format to convert to or -1 if none was found.
3841 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3842 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3844 #if FF_API_GET_ALPHA_INFO
3845 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3846 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3849 * Tell if an image really has transparent alpha values.
3850 * @return ored mask of FF_ALPHA_xxx constants
3852 attribute_deprecated
3853 int img_get_alpha_info(const AVPicture *src,
3854 enum PixelFormat pix_fmt, int width, int height);
3857 /* deinterlace a picture */
3858 /* deinterlace - if not supported return -1 */
3859 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3860 enum PixelFormat pix_fmt, int width, int height);
3862 /* external high level API */
3865 * If c is NULL, returns the first registered codec,
3866 * if c is non-NULL, returns the next registered codec after c,
3867 * or NULL if c is the last one.
3869 AVCodec *av_codec_next(AVCodec *c);
3872 * Return the LIBAVCODEC_VERSION_INT constant.
3874 unsigned avcodec_version(void);
3877 * Return the libavcodec build-time configuration.
3879 const char *avcodec_configuration(void);
3882 * Return the libavcodec license.
3884 const char *avcodec_license(void);
3886 #if FF_API_AVCODEC_INIT
3888 * @deprecated this function is called automatically from avcodec_register()
3889 * and avcodec_register_all(), there is no need to call it manually
3891 attribute_deprecated
3892 void avcodec_init(void);
3896 * Register the codec codec and initialize libavcodec.
3898 * @warning either this function or avcodec_register_all() must be called
3899 * before any other libavcodec functions.
3901 * @see avcodec_register_all()
3903 void avcodec_register(AVCodec *codec);
3906 * Find a registered encoder with a matching codec ID.
3908 * @param id CodecID of the requested encoder
3909 * @return An encoder if one was found, NULL otherwise.
3911 AVCodec *avcodec_find_encoder(enum CodecID id);
3914 * Find a registered encoder with the specified name.
3916 * @param name name of the requested encoder
3917 * @return An encoder if one was found, NULL otherwise.
3919 AVCodec *avcodec_find_encoder_by_name(const char *name);
3922 * Find a registered decoder with a matching codec ID.
3924 * @param id CodecID of the requested decoder
3925 * @return A decoder if one was found, NULL otherwise.
3927 AVCodec *avcodec_find_decoder(enum CodecID id);
3930 * Find a registered decoder with the specified name.
3932 * @param name name of the requested decoder
3933 * @return A decoder if one was found, NULL otherwise.
3935 AVCodec *avcodec_find_decoder_by_name(const char *name);
3936 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3939 * Return a name for the specified profile, if available.
3941 * @param codec the codec that is searched for the given profile
3942 * @param profile the profile value for which a name is requested
3943 * @return A name for the profile if found, NULL otherwise.
3945 const char *av_get_profile_name(const AVCodec *codec, int profile);
3947 #if FF_API_ALLOC_CONTEXT
3949 * Set the fields of the given AVCodecContext to default values.
3951 * @param s The AVCodecContext of which the fields should be set to default values.
3952 * @deprecated use avcodec_get_context_defaults3
3954 attribute_deprecated
3955 void avcodec_get_context_defaults(AVCodecContext *s);
3957 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3958 * we WILL change its arguments and name a few times! */
3959 attribute_deprecated
3960 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3964 * Set the fields of the given AVCodecContext to default values corresponding
3965 * to the given codec (defaults may be codec-dependent).
3967 * Do not call this function if a non-NULL codec has been passed
3968 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3969 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3970 * different codec on this AVCodecContext.
3972 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3974 #if FF_API_ALLOC_CONTEXT
3976 * Allocate an AVCodecContext and set its fields to default values. The
3977 * resulting struct can be deallocated by simply calling av_free().
3979 * @return An AVCodecContext filled with default values or NULL on failure.
3980 * @see avcodec_get_context_defaults
3982 * @deprecated use avcodec_alloc_context3()
3984 attribute_deprecated
3985 AVCodecContext *avcodec_alloc_context(void);
3987 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3988 * we WILL change its arguments and name a few times! */
3989 attribute_deprecated
3990 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3994 * Allocate an AVCodecContext and set its fields to default values. The
3995 * resulting struct can be deallocated by simply calling av_free().
3997 * @param codec if non-NULL, allocate private data and initialize defaults
3998 * for the given codec. It is illegal to then call avcodec_open2()
3999 * with a different codec.
4001 * @return An AVCodecContext filled with default values or NULL on failure.
4002 * @see avcodec_get_context_defaults
4004 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
4007 * Copy the settings of the source AVCodecContext into the destination
4008 * AVCodecContext. The resulting destination codec context will be
4009 * unopened, i.e. you are required to call avcodec_open2() before you
4010 * can use this AVCodecContext to decode/encode video/audio data.
4012 * @param dest target codec context, should be initialized with
4013 * avcodec_alloc_context3(), but otherwise uninitialized
4014 * @param src source codec context
4015 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4017 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4020 * Set the fields of the given AVFrame to default values.
4022 * @param pic The AVFrame of which the fields should be set to default values.
4024 void avcodec_get_frame_defaults(AVFrame *pic);
4027 * Allocate an AVFrame and set its fields to default values. The resulting
4028 * struct can be deallocated by simply calling av_free().
4030 * @return An AVFrame filled with default values or NULL on failure.
4031 * @see avcodec_get_frame_defaults
4033 AVFrame *avcodec_alloc_frame(void);
4035 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
4036 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
4037 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
4040 * Return the amount of padding in pixels which the get_buffer callback must
4041 * provide around the edge of the image for codecs which do not have the
4042 * CODEC_FLAG_EMU_EDGE flag.
4044 * @return Required padding in pixels.
4046 unsigned avcodec_get_edge_width(void);
4048 * Modify width and height values so that they will result in a memory
4049 * buffer that is acceptable for the codec if you do not use any horizontal
4052 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4053 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4054 * according to avcodec_get_edge_width() before.
4056 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4058 * Modify width and height values so that they will result in a memory
4059 * buffer that is acceptable for the codec if you also ensure that all
4060 * line sizes are a multiple of the respective linesize_align[i].
4062 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
4063 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
4064 * according to avcodec_get_edge_width() before.
4066 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4067 int linesize_align[AV_NUM_DATA_POINTERS]);
4069 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4071 #if FF_API_THREAD_INIT
4073 * @deprecated Set s->thread_count before calling avcodec_open2() instead of calling this.
4075 attribute_deprecated
4076 int avcodec_thread_init(AVCodecContext *s, int thread_count);
4079 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4080 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4081 //FIXME func typedef
4083 #if FF_API_AVCODEC_OPEN
4085 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4086 * function the context has to be allocated.
4088 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4089 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4090 * retrieving a codec.
4092 * @warning This function is not thread safe!
4095 * avcodec_register_all();
4096 * codec = avcodec_find_decoder(CODEC_ID_H264);
4100 * context = avcodec_alloc_context3(codec);
4102 * if (avcodec_open(context, codec) < 0)
4106 * @param avctx The context which will be set up to use the given codec.
4107 * @param codec The codec to use within the context.
4108 * @return zero on success, a negative value on error
4109 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
4111 * @deprecated use avcodec_open2
4113 attribute_deprecated
4114 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
4118 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4119 * function the context has to be allocated with avcodec_alloc_context3().
4121 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4122 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4123 * retrieving a codec.
4125 * @warning This function is not thread safe!
4128 * avcodec_register_all();
4129 * av_dict_set(&opts, "b", "2.5M", 0);
4130 * codec = avcodec_find_decoder(CODEC_ID_H264);
4134 * context = avcodec_alloc_context3(codec);
4136 * if (avcodec_open2(context, codec, opts) < 0)
4140 * @param avctx The context to initialize.
4141 * @param options A dictionary filled with AVCodecContext and codec-private options.
4142 * On return this object will be filled with options that were not found.
4144 * @return zero on success, a negative value on error
4145 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4146 * av_dict_set(), av_opt_find().
4148 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
4150 #if FF_API_OLD_DECODE_AUDIO
4152 * Wrapper function which calls avcodec_decode_audio4.
4154 * @deprecated Use avcodec_decode_audio4 instead.
4156 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
4157 * Some decoders may support multiple frames in a single AVPacket, such
4158 * decoders would then just decode the first frame. In this case,
4159 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
4160 * the remaining data in order to decode the second frame etc.
4162 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
4163 * decompressed frame size in bytes.
4165 * @warning You must set frame_size_ptr to the allocated size of the
4166 * output buffer before calling avcodec_decode_audio3().
4168 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4169 * the actual read bytes because some optimized bitstream readers read 32 or 64
4170 * bits at once and could read over the end.
4172 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
4173 * no overreading happens for damaged MPEG streams.
4175 * @note You might have to align the input buffer avpkt->data and output buffer
4176 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
4177 * necessary at all, on others it won't work at all if not aligned and on others
4178 * it will work but it will have an impact on performance.
4180 * In practice, avpkt->data should have 4 byte alignment at minimum and
4181 * samples should be 16 byte aligned unless the CPU doesn't need it
4182 * (AltiVec and SSE do).
4184 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4185 * between input and output, these need to be fed with avpkt->data=NULL,
4186 * avpkt->size=0 at the end to return the remaining frames.
4188 * @param avctx the codec context
4189 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4190 * If the sample format is planar, each channel plane will
4191 * be the same size, with no padding between channels.
4192 * @param[in,out] frame_size_ptr the output buffer size in bytes
4193 * @param[in] avpkt The input AVPacket containing the input buffer.
4194 * You can create such packet with av_init_packet() and by then setting
4195 * data and size, some decoders might in addition need other fields.
4196 * All decoders are designed to use the least fields possible though.
4197 * @return On error a negative value is returned, otherwise the number of bytes
4198 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4200 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4201 int *frame_size_ptr,
4206 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4208 * Some decoders may support multiple frames in a single AVPacket. Such
4209 * decoders would then just decode the first frame. In this case,
4210 * avcodec_decode_audio4 has to be called again with an AVPacket containing
4211 * the remaining data in order to decode the second frame, etc...
4212 * Even if no frames are returned, the packet needs to be fed to the decoder
4213 * with remaining data until it is completely consumed or an error occurs.
4215 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
4216 * larger than the actual read bytes because some optimized bitstream
4217 * readers read 32 or 64 bits at once and could read over the end.
4219 * @note You might have to align the input buffer. The alignment requirements
4220 * depend on the CPU and the decoder.
4222 * @param avctx the codec context
4223 * @param[out] frame The AVFrame in which to store decoded audio samples.
4224 * Decoders request a buffer of a particular size by setting
4225 * AVFrame.nb_samples prior to calling get_buffer(). The
4226 * decoder may, however, only utilize part of the buffer by
4227 * setting AVFrame.nb_samples to a smaller value in the
4229 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4231 * @param[in] avpkt The input AVPacket containing the input buffer.
4232 * At least avpkt->data and avpkt->size should be set. Some
4233 * decoders might also require additional fields to be set.
4234 * @return A negative error code is returned if an error occurred during
4235 * decoding, otherwise the number of bytes consumed from the input
4236 * AVPacket is returned.
4238 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4239 int *got_frame_ptr, AVPacket *avpkt);
4242 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4243 * Some decoders may support multiple frames in a single AVPacket, such
4244 * decoders would then just decode the first frame.
4246 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4247 * the actual read bytes because some optimized bitstream readers read 32 or 64
4248 * bits at once and could read over the end.
4250 * @warning The end of the input buffer buf should be set to 0 to ensure that
4251 * no overreading happens for damaged MPEG streams.
4253 * @note You might have to align the input buffer avpkt->data.
4254 * The alignment requirements depend on the CPU: on some CPUs it isn't
4255 * necessary at all, on others it won't work at all if not aligned and on others
4256 * it will work but it will have an impact on performance.
4258 * In practice, avpkt->data should have 4 byte alignment at minimum.
4260 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4261 * between input and output, these need to be fed with avpkt->data=NULL,
4262 * avpkt->size=0 at the end to return the remaining frames.
4264 * @param avctx the codec context
4265 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4266 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4267 * allocate memory for the actual bitmap.
4268 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4269 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4270 * decodes and the decoder tells the user once it does not need the data anymore,
4271 * the user app can at this point free/reuse/keep the memory as it sees fit.
4273 * @param[in] avpkt The input AVpacket containing the input buffer.
4274 * You can create such packet with av_init_packet() and by then setting
4275 * data and size, some decoders might in addition need other fields like
4276 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4278 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4279 * @return On error a negative value is returned, otherwise the number of bytes
4280 * used or zero if no frame could be decompressed.
4282 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4283 int *got_picture_ptr,
4287 * Decode a subtitle message.
4288 * Return a negative value on error, otherwise return the number of bytes used.
4289 * If no subtitle could be decompressed, got_sub_ptr is zero.
4290 * Otherwise, the subtitle is stored in *sub.
4291 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4292 * simplicity, because the performance difference is expect to be negligible
4293 * and reusing a get_buffer written for video codecs would probably perform badly
4294 * due to a potentially very different allocation pattern.
4296 * @param avctx the codec context
4297 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4298 freed with avsubtitle_free if *got_sub_ptr is set.
4299 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4300 * @param[in] avpkt The input AVPacket containing the input buffer.
4302 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4307 * Free all allocated data in the given subtitle struct.
4309 * @param sub AVSubtitle to free.
4311 void avsubtitle_free(AVSubtitle *sub);
4314 * Encode an audio frame from samples into buf.
4316 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4317 * However, for PCM audio the user will know how much space is needed
4318 * because it depends on the value passed in buf_size as described
4319 * below. In that case a lower value can be used.
4321 * @param avctx the codec context
4322 * @param[out] buf the output buffer
4323 * @param[in] buf_size the output buffer size
4324 * @param[in] samples the input buffer containing the samples
4325 * The number of samples read from this buffer is frame_size*channels,
4326 * both of which are defined in avctx.
4327 * For PCM audio the number of samples read from samples is equal to
4328 * buf_size * input_sample_size / output_sample_size.
4329 * @return On error a negative value is returned, on success zero or the number
4330 * of bytes used to encode the data read from the input buffer.
4332 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4333 const short *samples);
4336 * Encode a video frame from pict into buf.
4337 * The input picture should be
4338 * stored using a specific format, namely avctx.pix_fmt.
4340 * @param avctx the codec context
4341 * @param[out] buf the output buffer for the bitstream of encoded frame
4342 * @param[in] buf_size the size of the output buffer in bytes
4343 * @param[in] pict the input picture to encode
4344 * @return On error a negative value is returned, on success zero or the number
4345 * of bytes used from the output buffer.
4347 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4348 const AVFrame *pict);
4349 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4350 const AVSubtitle *sub);
4352 int avcodec_close(AVCodecContext *avctx);
4355 * Register all the codecs, parsers and bitstream filters which were enabled at
4356 * configuration time. If you do not call this function you can select exactly
4357 * which formats you want to support, by using the individual registration
4360 * @see avcodec_register
4361 * @see av_register_codec_parser
4362 * @see av_register_bitstream_filter
4364 void avcodec_register_all(void);
4367 * Flush buffers, should be called when seeking or when switching to a different stream.
4369 void avcodec_flush_buffers(AVCodecContext *avctx);
4371 void avcodec_default_free_buffers(AVCodecContext *s);
4373 /* misc useful functions */
4375 #if FF_API_OLD_FF_PICT_TYPES
4377 * Return a single letter to describe the given picture type pict_type.
4379 * @param[in] pict_type the picture type
4380 * @return A single character representing the picture type.
4381 * @deprecated Use av_get_picture_type_char() instead.
4383 attribute_deprecated
4384 char av_get_pict_type_char(int pict_type);
4388 * Return codec bits per sample.
4390 * @param[in] codec_id the codec
4391 * @return Number of bits per sample or zero if unknown for the given codec.
4393 int av_get_bits_per_sample(enum CodecID codec_id);
4395 #if FF_API_OLD_SAMPLE_FMT
4397 * @deprecated Use av_get_bytes_per_sample() instead.
4399 attribute_deprecated
4400 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4404 typedef struct AVCodecParserContext {
4406 struct AVCodecParser *parser;
4407 int64_t frame_offset; /* offset of the current frame */
4408 int64_t cur_offset; /* current offset
4409 (incremented by each av_parser_parse()) */
4410 int64_t next_frame_offset; /* offset of the next frame */
4412 int pict_type; /* XXX: Put it back in AVCodecContext. */
4414 * This field is used for proper frame duration computation in lavf.
4415 * It signals, how much longer the frame duration of the current frame
4416 * is compared to normal frame duration.
4418 * frame_duration = (1 + repeat_pict) * time_base
4420 * It is used by codecs like H.264 to display telecined material.
4422 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4423 int64_t pts; /* pts of the current frame */
4424 int64_t dts; /* dts of the current frame */
4429 int fetch_timestamp;
4431 #define AV_PARSER_PTS_NB 4
4432 int cur_frame_start_index;
4433 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4434 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4435 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4438 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4439 #define PARSER_FLAG_ONCE 0x0002
4440 /// Set if the parser has a valid file offset
4441 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4443 int64_t offset; ///< byte offset from starting packet start
4444 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4447 * Set by parser to 1 for key frames and 0 for non-key frames.
4448 * It is initialized to -1, so if the parser doesn't set this flag,
4449 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4455 * Time difference in stream time base units from the pts of this
4456 * packet to the point at which the output from the decoder has converged
4457 * independent from the availability of previous frames. That is, the
4458 * frames are virtually identical no matter if decoding started from
4459 * the very first frame or from this keyframe.
4460 * Is AV_NOPTS_VALUE if unknown.
4461 * This field is not the display duration of the current frame.
4462 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4465 * The purpose of this field is to allow seeking in streams that have no
4466 * keyframes in the conventional sense. It corresponds to the
4467 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4468 * essential for some types of subtitle streams to ensure that all
4469 * subtitles are correctly displayed after seeking.
4471 int64_t convergence_duration;
4473 // Timestamp generation support:
4475 * Synchronization point for start of timestamp generation.
4477 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4480 * For example, this corresponds to presence of H.264 buffering period
4486 * Offset of the current timestamp against last timestamp sync point in
4487 * units of AVCodecContext.time_base.
4489 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4490 * contain a valid timestamp offset.
4492 * Note that the timestamp of sync point has usually a nonzero
4493 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4494 * the next frame after timestamp sync point will be usually 1.
4496 * For example, this corresponds to H.264 cpb_removal_delay.
4498 int dts_ref_dts_delta;
4501 * Presentation delay of current frame in units of AVCodecContext.time_base.
4503 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4504 * contain valid non-negative timestamp delta (presentation time of a frame
4505 * must not lie in the past).
4507 * This delay represents the difference between decoding and presentation
4508 * time of the frame.
4510 * For example, this corresponds to H.264 dpb_output_delay.
4515 * Position of the packet in file.
4517 * Analogous to cur_frame_pts/dts
4519 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4522 * Byte position of currently parsed frame in stream.
4527 * Previous frame byte position.
4530 } AVCodecParserContext;
4532 typedef struct AVCodecParser {
4533 int codec_ids[5]; /* several codec IDs are permitted */
4535 int (*parser_init)(AVCodecParserContext *s);
4536 int (*parser_parse)(AVCodecParserContext *s,
4537 AVCodecContext *avctx,
4538 const uint8_t **poutbuf, int *poutbuf_size,
4539 const uint8_t *buf, int buf_size);
4540 void (*parser_close)(AVCodecParserContext *s);
4541 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4542 struct AVCodecParser *next;
4545 AVCodecParser *av_parser_next(AVCodecParser *c);
4547 void av_register_codec_parser(AVCodecParser *parser);
4548 AVCodecParserContext *av_parser_init(int codec_id);
4553 * @param s parser context.
4554 * @param avctx codec context.
4555 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4556 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4557 * @param buf input buffer.
4558 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4559 * @param pts input presentation timestamp.
4560 * @param dts input decoding timestamp.
4561 * @param pos input byte position in stream.
4562 * @return the number of bytes of the input bitstream used.
4567 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4574 * decode_frame(data, size);
4578 int av_parser_parse2(AVCodecParserContext *s,
4579 AVCodecContext *avctx,
4580 uint8_t **poutbuf, int *poutbuf_size,
4581 const uint8_t *buf, int buf_size,
4582 int64_t pts, int64_t dts,
4585 int av_parser_change(AVCodecParserContext *s,
4586 AVCodecContext *avctx,
4587 uint8_t **poutbuf, int *poutbuf_size,
4588 const uint8_t *buf, int buf_size, int keyframe);
4589 void av_parser_close(AVCodecParserContext *s);
4592 typedef struct AVBitStreamFilterContext {
4594 struct AVBitStreamFilter *filter;
4595 AVCodecParserContext *parser;
4596 struct AVBitStreamFilterContext *next;
4597 } AVBitStreamFilterContext;
4600 typedef struct AVBitStreamFilter {
4603 int (*filter)(AVBitStreamFilterContext *bsfc,
4604 AVCodecContext *avctx, const char *args,
4605 uint8_t **poutbuf, int *poutbuf_size,
4606 const uint8_t *buf, int buf_size, int keyframe);
4607 void (*close)(AVBitStreamFilterContext *bsfc);
4608 struct AVBitStreamFilter *next;
4609 } AVBitStreamFilter;
4611 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4612 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4613 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4614 AVCodecContext *avctx, const char *args,
4615 uint8_t **poutbuf, int *poutbuf_size,
4616 const uint8_t *buf, int buf_size, int keyframe);
4617 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4619 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4624 * Reallocate the given block if it is not large enough, otherwise do nothing.
4628 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4631 * Allocate a buffer, reusing the given one if large enough.
4633 * Contrary to av_fast_realloc the current buffer contents might not be
4634 * preserved and on error the old buffer is freed, thus no special
4635 * handling to avoid memleaks is necessary.
4637 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4638 * @param size size of the buffer *ptr points to
4639 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4640 * *size 0 if an error occurred.
4642 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4645 * Copy image src to dst. Wraps av_picture_data_copy() above.
4647 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4648 enum PixelFormat pix_fmt, int width, int height);
4651 * Crop image top and left side.
4653 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4654 enum PixelFormat pix_fmt, int top_band, int left_band);
4659 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4660 int padtop, int padbottom, int padleft, int padright, int *color);
4663 * Encode extradata length to a buffer. Used by xiph codecs.
4665 * @param s buffer to write to; must be at least (v/255+1) bytes long
4666 * @param v size of extradata in bytes
4667 * @return number of bytes written to the buffer.
4669 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4672 * Log a generic warning message about a missing feature. This function is
4673 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4674 * only, and would normally not be used by applications.
4675 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4676 * a pointer to an AVClass struct
4677 * @param[in] feature string containing the name of the missing feature
4678 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4679 * If want_sample is non-zero, additional verbage will be added to the log
4680 * message which tells the user how to report samples to the development
4683 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4686 * Log a generic warning message asking for a sample. This function is
4687 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4688 * only, and would normally not be used by applications.
4689 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4690 * a pointer to an AVClass struct
4691 * @param[in] msg string containing an optional message, or NULL if no message
4693 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4696 * Register the hardware accelerator hwaccel.
4698 void av_register_hwaccel(AVHWAccel *hwaccel);
4701 * If hwaccel is NULL, returns the first registered hardware accelerator,
4702 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4703 * after hwaccel, or NULL if hwaccel is the last one.
4705 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4709 * Lock operation used by lockmgr
4712 AV_LOCK_CREATE, ///< Create a mutex
4713 AV_LOCK_OBTAIN, ///< Lock the mutex
4714 AV_LOCK_RELEASE, ///< Unlock the mutex
4715 AV_LOCK_DESTROY, ///< Free mutex resources
4719 * Register a user provided lock manager supporting the operations
4720 * specified by AVLockOp. mutex points to a (void *) where the
4721 * lockmgr should store/get a pointer to a user allocated mutex. It's
4722 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4724 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4725 * callback during the call to av_lockmgr_register().
4726 * Thus, the application must be prepared to handle that.
4727 * If cb is set to NULL the lockmgr will be unregistered.
4728 * Also note that during unregistration the previously registered
4729 * lockmgr callback may also be invoked.
4731 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4734 * Get the type of the given codec.
4736 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4739 * Get the AVClass for AVCodecContext. It can be used in combination with
4740 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4742 * @see av_opt_find().
4744 const AVClass *avcodec_get_class(void);
4747 * Get the AVClass for AVFrame. It can be used in combination with
4748 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4750 * @see av_opt_find().
4752 const AVClass *avcodec_get_frame_class(void);
4754 #endif /* AVCODEC_AVCODEC_H */