2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs.
57 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58 CODEC_ID_MPEG2VIDEO_XVMC,
95 CODEC_ID_INTERPLAY_VIDEO,
107 CODEC_ID_TRUEMOTION1,
134 CODEC_ID_TRUEMOTION2,
151 CODEC_ID_DSICINVIDEO,
152 CODEC_ID_TIERTEXSEQVIDEO,
161 CODEC_ID_BETHSOFTVID,
179 CODEC_ID_MOTIONPIXELS,
197 CODEC_ID_IFF_BYTERUN1,
214 /* various PCM "codecs" */
215 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
216 CODEC_ID_PCM_S16LE= 0x10000,
232 CODEC_ID_PCM_S24DAUD,
234 CODEC_ID_PCM_S16LE_PLANAR,
244 /* various ADPCM codecs */
245 CODEC_ID_ADPCM_IMA_QT= 0x11000,
246 CODEC_ID_ADPCM_IMA_WAV,
247 CODEC_ID_ADPCM_IMA_DK3,
248 CODEC_ID_ADPCM_IMA_DK4,
249 CODEC_ID_ADPCM_IMA_WS,
250 CODEC_ID_ADPCM_IMA_SMJPEG,
259 CODEC_ID_ADPCM_YAMAHA,
260 CODEC_ID_ADPCM_SBPRO_4,
261 CODEC_ID_ADPCM_SBPRO_3,
262 CODEC_ID_ADPCM_SBPRO_2,
264 CODEC_ID_ADPCM_IMA_AMV,
265 CODEC_ID_ADPCM_EA_R1,
266 CODEC_ID_ADPCM_EA_R3,
267 CODEC_ID_ADPCM_EA_R2,
268 CODEC_ID_ADPCM_IMA_EA_SEAD,
269 CODEC_ID_ADPCM_IMA_EA_EACS,
270 CODEC_ID_ADPCM_EA_XAS,
271 CODEC_ID_ADPCM_EA_MAXIS_XA,
272 CODEC_ID_ADPCM_IMA_ISS,
276 CODEC_ID_AMR_NB= 0x12000,
279 /* RealAudio codecs*/
280 CODEC_ID_RA_144= 0x13000,
283 /* various DPCM codecs */
284 CODEC_ID_ROQ_DPCM= 0x14000,
285 CODEC_ID_INTERPLAY_DPCM,
290 CODEC_ID_MP2= 0x15000,
291 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
309 CODEC_ID_WESTWOOD_SND1,
310 CODEC_ID_GSM, ///< as in Berlin toast format
318 CODEC_ID_DSICINAUDIO,
322 CODEC_ID_GSM_MS, /* as found in WAV */
331 CODEC_ID_WMALOSSLESS,
340 CODEC_ID_BINKAUDIO_RDFT,
341 CODEC_ID_BINKAUDIO_DCT,
345 /* subtitle codecs */
346 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
347 CODEC_ID_DVD_SUBTITLE= 0x17000,
348 CODEC_ID_DVB_SUBTITLE,
349 CODEC_ID_TEXT, ///< raw UTF-8 text
353 CODEC_ID_HDMV_PGS_SUBTITLE,
354 CODEC_ID_DVB_TELETEXT,
357 /* other specific kind of codecs (generally used for attachments) */
358 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
359 CODEC_ID_TTF= 0x18000,
361 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
363 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
364 * stream (only used by libavformat) */
365 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
368 #if FF_API_OLD_SAMPLE_FMT
369 #define SampleFormat AVSampleFormat
371 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
372 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
373 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
374 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
375 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
376 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
377 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
380 #if FF_API_OLD_AUDIOCONVERT
381 #include "libavutil/audioconvert.h"
383 /* Audio channel masks */
384 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
385 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
386 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
387 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
388 #define CH_BACK_LEFT AV_CH_BACK_LEFT
389 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
390 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
391 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
392 #define CH_BACK_CENTER AV_CH_BACK_CENTER
393 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
394 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
395 #define CH_TOP_CENTER AV_CH_TOP_CENTER
396 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
397 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
398 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
399 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
400 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
401 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
402 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
403 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
405 /** Channel mask value used for AVCodecContext.request_channel_layout
406 to indicate that the user requests the channel order of the decoder output
407 to be the native codec channel order. */
408 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
410 /* Audio channel convenience macros */
411 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
412 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
413 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
414 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
415 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
416 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
417 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
418 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
419 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
420 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
421 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
422 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
423 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
424 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
425 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
432 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
433 * This is mainly needed because some optimized bitstream readers read
434 * 32 or 64 bit at once and could read over the end.<br>
435 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
436 * MPEG bitstreams could cause overread and segfault.
438 #define FF_INPUT_BUFFER_PADDING_SIZE 8
441 * minimum encoding buffer size
442 * Used to avoid some checks during header writing.
444 #define FF_MIN_BUFFER_SIZE 16384
448 * motion estimation type.
451 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
455 ME_EPZS, ///< enhanced predictive zonal search
456 ME_X1, ///< reserved for experiments
457 ME_HEX, ///< hexagon based search
458 ME_UMH, ///< uneven multi-hexagon search
459 ME_ITER, ///< iterative search
460 ME_TESA, ///< transformed exhaustive search algorithm
464 /* We leave some space between them for extensions (drop some
465 * keyframes for intra-only or drop just some bidir frames). */
466 AVDISCARD_NONE =-16, ///< discard nothing
467 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
468 AVDISCARD_NONREF = 8, ///< discard all non reference
469 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
470 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
471 AVDISCARD_ALL = 48, ///< discard all
474 enum AVColorPrimaries{
475 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
476 AVCOL_PRI_UNSPECIFIED=2,
478 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
479 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
480 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
482 AVCOL_PRI_NB , ///< Not part of ABI
485 enum AVColorTransferCharacteristic{
486 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
487 AVCOL_TRC_UNSPECIFIED=2,
488 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
489 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
490 AVCOL_TRC_NB , ///< Not part of ABI
495 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
496 AVCOL_SPC_UNSPECIFIED=2,
498 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
499 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
500 AVCOL_SPC_SMPTE240M =7,
501 AVCOL_SPC_NB , ///< Not part of ABI
505 AVCOL_RANGE_UNSPECIFIED=0,
506 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
507 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
508 AVCOL_RANGE_NB , ///< Not part of ABI
512 * X X 3 4 X X are luma samples,
513 * 1 2 1-6 are possible chroma positions
514 * X X 5 6 X 0 is undefined/unknown position
516 enum AVChromaLocation{
517 AVCHROMA_LOC_UNSPECIFIED=0,
518 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
519 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
520 AVCHROMA_LOC_TOPLEFT =3, ///< DV
522 AVCHROMA_LOC_BOTTOMLEFT =5,
523 AVCHROMA_LOC_BOTTOM =6,
524 AVCHROMA_LOC_NB , ///< Not part of ABI
527 #if FF_API_FLAC_GLOBAL_OPTS
531 attribute_deprecated enum AVLPCType {
532 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
533 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
534 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
535 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
536 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
537 AV_LPC_TYPE_NB , ///< Not part of ABI
541 enum AVAudioServiceType {
542 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
543 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
544 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
545 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
546 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
547 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
548 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
549 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
550 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
551 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
554 typedef struct RcOverride{
557 int qscale; // If this is 0 then quality_factor will be used instead.
558 float quality_factor;
561 #define FF_MAX_B_FRAMES 16
564 These flags can be passed in AVCodecContext.flags before initialization.
565 Note: Not everything is supported yet.
568 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
569 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
570 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
571 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
572 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
574 * The parent program guarantees that the input for B-frames containing
575 * streams is not written to for at least s->max_b_frames+1 frames, if
576 * this is not set the input will be copied.
578 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
579 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
580 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
581 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
582 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
583 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
584 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
585 location instead of only at frame boundaries. */
586 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
587 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
588 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
589 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
590 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
591 /* Fx : Flag for h263+ extra options */
592 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
593 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
594 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
595 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
596 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
597 #define CODEC_FLAG_CLOSED_GOP 0x80000000
598 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
599 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
600 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
601 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
602 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
603 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
605 * @defgroup deprecated_flags Deprecated codec flags
606 * Use corresponding private codec options instead.
609 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
610 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
611 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
612 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
613 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
614 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
615 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
616 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
617 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
618 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
619 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
621 #if FF_API_MJPEG_GLOBAL_OPTS
622 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
624 #if FF_API_X264_GLOBAL_OPTS
625 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
626 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
627 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
628 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
629 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
630 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
631 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
632 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
633 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
634 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
635 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
637 #if FF_API_SNOW_GLOBAL_OPTS
638 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
640 #if FF_API_LAME_GLOBAL_OPTS
641 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
647 /* Unsupported options :
648 * Syntax Arithmetic coding (SAC)
649 * Reference Picture Selection
650 * Independent Segment Decoding */
652 /* codec capabilities */
654 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
656 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
657 * If not set, it might not use get_buffer() at all or use operations that
658 * assume the buffer was allocated by avcodec_default_get_buffer.
660 #define CODEC_CAP_DR1 0x0002
661 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
662 #define CODEC_CAP_PARSE_ONLY 0x0004
663 #define CODEC_CAP_TRUNCATED 0x0008
664 /* Codec can export data for HW decoding (XvMC). */
665 #define CODEC_CAP_HWACCEL 0x0010
667 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
668 * If this is not set, the codec is guaranteed to never be fed with NULL data.
670 #define CODEC_CAP_DELAY 0x0020
672 * Codec can be fed a final frame with a smaller size.
673 * This can be used to prevent truncation of the last audio samples.
675 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
677 * Codec can export data for HW decoding (VDPAU).
679 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
681 * Codec can output multiple frames per AVPacket
682 * Normally demuxers return one frame at a time, demuxers which do not do
683 * are connected to a parser to split what they return into proper frames.
684 * This flag is reserved to the very rare category of codecs which have a
685 * bitstream that cannot be split into frames without timeconsuming
686 * operations like full decoding. Demuxers carring such bitstreams thus
687 * may return multiple frames in a packet. This has many disadvantages like
688 * prohibiting stream copy in many cases thus it should only be considered
691 #define CODEC_CAP_SUBFRAMES 0x0100
693 * Codec is experimental and is thus avoided in favor of non experimental
696 #define CODEC_CAP_EXPERIMENTAL 0x0200
698 * Codec should fill in channel configuration and samplerate instead of container
700 #define CODEC_CAP_CHANNEL_CONF 0x0400
702 * Codec is able to deal with negative linesizes
704 #define CODEC_CAP_NEG_LINESIZES 0x0800
706 * Codec supports frame-level multithreading.
708 #define CODEC_CAP_FRAME_THREADS 0x1000
710 * Codec supports slice-based (or partition-based) multithreading.
712 #define CODEC_CAP_SLICE_THREADS 0x2000
714 //The following defines may change, don't expect compatibility if you use them.
715 #define MB_TYPE_INTRA4x4 0x0001
716 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
717 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
718 #define MB_TYPE_16x16 0x0008
719 #define MB_TYPE_16x8 0x0010
720 #define MB_TYPE_8x16 0x0020
721 #define MB_TYPE_8x8 0x0040
722 #define MB_TYPE_INTERLACED 0x0080
723 #define MB_TYPE_DIRECT2 0x0100 //FIXME
724 #define MB_TYPE_ACPRED 0x0200
725 #define MB_TYPE_GMC 0x0400
726 #define MB_TYPE_SKIP 0x0800
727 #define MB_TYPE_P0L0 0x1000
728 #define MB_TYPE_P1L0 0x2000
729 #define MB_TYPE_P0L1 0x4000
730 #define MB_TYPE_P1L1 0x8000
731 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
732 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
733 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
734 #define MB_TYPE_QUANT 0x00010000
735 #define MB_TYPE_CBP 0x00020000
736 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
740 * This specifies the area which should be displayed.
741 * Note there may be multiple such areas for one frame.
743 typedef struct AVPanScan{
746 * - encoding: Set by user.
747 * - decoding: Set by libavcodec.
752 * width and height in 1/16 pel
753 * - encoding: Set by user.
754 * - decoding: Set by libavcodec.
760 * position of the top left corner in 1/16 pel for up to 3 fields/frames
761 * - encoding: Set by user.
762 * - decoding: Set by libavcodec.
764 int16_t position[3][2];
767 #define FF_QSCALE_TYPE_MPEG1 0
768 #define FF_QSCALE_TYPE_MPEG2 1
769 #define FF_QSCALE_TYPE_H264 2
770 #define FF_QSCALE_TYPE_VP56 3
772 #define FF_BUFFER_TYPE_INTERNAL 1
773 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
774 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
775 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
777 #if FF_API_OLD_FF_PICT_TYPES
778 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
779 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
780 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
781 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
782 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
783 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
784 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
785 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
788 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
789 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
790 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
791 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
793 enum AVPacketSideDataType {
797 typedef struct AVPacket {
799 * Presentation timestamp in AVStream->time_base units; the time at which
800 * the decompressed packet will be presented to the user.
801 * Can be AV_NOPTS_VALUE if it is not stored in the file.
802 * pts MUST be larger or equal to dts as presentation cannot happen before
803 * decompression, unless one wants to view hex dumps. Some formats misuse
804 * the terms dts and pts/cts to mean something different. Such timestamps
805 * must be converted to true pts/dts before they are stored in AVPacket.
809 * Decompression timestamp in AVStream->time_base units; the time at which
810 * the packet is decompressed.
811 * Can be AV_NOPTS_VALUE if it is not stored in the file.
818 * A combination of AV_PKT_FLAG values
822 * Additional packet data that can be provided by the container.
823 * Packet can contain several types of side information.
828 enum AVPacketSideDataType type;
833 * Duration of this packet in AVStream->time_base units, 0 if unknown.
834 * Equals next_pts - this_pts in presentation order.
837 void (*destruct)(struct AVPacket *);
839 int64_t pos; ///< byte position in stream, -1 if unknown
842 * Time difference in AVStream->time_base units from the pts of this
843 * packet to the point at which the output from the decoder has converged
844 * independent from the availability of previous frames. That is, the
845 * frames are virtually identical no matter if decoding started from
846 * the very first frame or from this keyframe.
847 * Is AV_NOPTS_VALUE if unknown.
848 * This field is not the display duration of the current packet.
849 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
852 * The purpose of this field is to allow seeking in streams that have no
853 * keyframes in the conventional sense. It corresponds to the
854 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
855 * essential for some types of subtitle streams to ensure that all
856 * subtitles are correctly displayed after seeking.
858 int64_t convergence_duration;
860 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
861 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
865 * New fields can be added to the end of AVFRAME with minor version
866 * bumps. Removal, reordering and changes to existing fields require
867 * a major version bump.
868 * sizeof(AVFrame) must not be used outside libav*.
870 typedef struct AVFrame {
872 * pointer to the picture planes.
873 * This might be different from the first allocated byte
880 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
881 * This isn't used by libavcodec unless the default get/release_buffer() is used.
887 * 1 -> keyframe, 0-> not
888 * - encoding: Set by libavcodec.
889 * - decoding: Set by libavcodec.
894 * Picture type of the frame, see ?_TYPE below.
895 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
896 * - decoding: Set by libavcodec.
898 enum AVPictureType pict_type;
901 * presentation timestamp in time_base units (time when frame should be shown to user)
902 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
903 * - encoding: MUST be set by user.
904 * - decoding: Set by libavcodec.
909 * picture number in bitstream order
911 * - decoding: Set by libavcodec.
913 int coded_picture_number;
915 * picture number in display order
917 * - decoding: Set by libavcodec.
919 int display_picture_number;
922 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
923 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
924 * - decoding: Set by libavcodec.
929 * buffer age (1->was last buffer and dint change, 2->..., ...).
930 * Set to INT_MAX if the buffer has not been used yet.
932 * - decoding: MUST be set by get_buffer().
937 * is this picture used as reference
938 * The values for this are the same as the MpegEncContext.picture_structure
939 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
940 * Set to 4 for delayed, non-reference frames.
942 * - decoding: Set by libavcodec. (before get_buffer() call)).
949 * - decoding: Set by libavcodec.
951 int8_t *qscale_table;
955 * - decoding: Set by libavcodec.
960 * mbskip_table[mb]>=1 if MB didn't change
961 * stride= mb_width = (width+15)>>4
963 * - decoding: Set by libavcodec.
965 uint8_t *mbskip_table;
968 * motion vector table
971 * int mv_sample_log2= 4 - motion_subsample_log2;
972 * int mb_width= (width+15)>>4;
973 * int mv_stride= (mb_width << mv_sample_log2) + 1;
974 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
976 * - encoding: Set by user.
977 * - decoding: Set by libavcodec.
979 int16_t (*motion_val[2])[2];
982 * macroblock type table
983 * mb_type_base + mb_width + 2
984 * - encoding: Set by user.
985 * - decoding: Set by libavcodec.
990 * log2 of the size of the block which a single vector in motion_val represents:
991 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
993 * - decoding: Set by libavcodec.
995 uint8_t motion_subsample_log2;
998 * for some private data of the user
1000 * - decoding: Set by user.
1006 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1007 * - decoding: unused
1012 * type of the buffer (to keep track of who has to deallocate data[*])
1013 * - encoding: Set by the one who allocates it.
1014 * - decoding: Set by the one who allocates it.
1015 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1020 * When decoding, this signals how much the picture must be delayed.
1021 * extra_delay = repeat_pict / (2*fps)
1022 * - encoding: unused
1023 * - decoding: Set by libavcodec.
1033 * The content of the picture is interlaced.
1034 * - encoding: Set by user.
1035 * - decoding: Set by libavcodec. (default 0)
1037 int interlaced_frame;
1040 * If the content is interlaced, is top field displayed first.
1041 * - encoding: Set by user.
1042 * - decoding: Set by libavcodec.
1044 int top_field_first;
1048 * - encoding: Set by user.
1049 * - decoding: Set by libavcodec.
1051 AVPanScan *pan_scan;
1054 * Tell user application that palette has changed from previous frame.
1055 * - encoding: ??? (no palette-enabled encoder yet)
1056 * - decoding: Set by libavcodec. (default 0).
1058 int palette_has_changed;
1061 * codec suggestion on buffer type if != 0
1062 * - encoding: unused
1063 * - decoding: Set by libavcodec. (before get_buffer() call)).
1069 * - encoding: unused
1070 * - decoding: Set by libavcodec.
1075 * motion reference frame index
1076 * the order in which these are stored can depend on the codec.
1077 * - encoding: Set by user.
1078 * - decoding: Set by libavcodec.
1080 int8_t *ref_index[2];
1083 * reordered opaque 64bit (generally an integer or a double precision float
1084 * PTS but can be anything).
1085 * The user sets AVCodecContext.reordered_opaque to represent the input at
1087 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1088 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1089 * @deprecated in favor of pkt_pts
1090 * - encoding: unused
1091 * - decoding: Read by user.
1093 int64_t reordered_opaque;
1096 * hardware accelerator private data (Libav-allocated)
1097 * - encoding: unused
1098 * - decoding: Set by libavcodec
1100 void *hwaccel_picture_private;
1103 * reordered pts from the last AVPacket that has been input into the decoder
1104 * - encoding: unused
1105 * - decoding: Read by user.
1110 * dts from the last AVPacket that has been input into the decoder
1111 * - encoding: unused
1112 * - decoding: Read by user.
1117 * the AVCodecContext which ff_thread_get_buffer() was last called on
1118 * - encoding: Set by libavcodec.
1119 * - decoding: Set by libavcodec.
1121 struct AVCodecContext *owner;
1124 * used by multithreading to store frame-specific info
1125 * - encoding: Set by libavcodec.
1126 * - decoding: Set by libavcodec.
1128 void *thread_opaque;
1132 * main external API structure.
1133 * New fields can be added to the end with minor version bumps.
1134 * Removal, reordering and changes to existing fields require a major
1136 * sizeof(AVCodecContext) must not be used outside libav*.
1138 typedef struct AVCodecContext {
1140 * information on struct for av_log
1141 * - set by avcodec_alloc_context
1143 const AVClass *av_class;
1145 * the average bitrate
1146 * - encoding: Set by user; unused for constant quantizer encoding.
1147 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1152 * number of bits the bitstream is allowed to diverge from the reference.
1153 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1154 * - encoding: Set by user; unused for constant quantizer encoding.
1155 * - decoding: unused
1157 int bit_rate_tolerance;
1161 * - encoding: Set by user.
1162 * - decoding: Set by user.
1167 * Some codecs need additional format info. It is stored here.
1168 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1169 * specific codec MUST set it correctly otherwise stream copy breaks.
1170 * In general use of this field by muxers is not recommanded.
1171 * - encoding: Set by libavcodec.
1172 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1177 * Motion estimation algorithm used for video coding.
1178 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1179 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1180 * - encoding: MUST be set by user.
1181 * - decoding: unused
1186 * some codecs need / can use extradata like Huffman tables.
1187 * mjpeg: Huffman tables
1188 * rv10: additional flags
1189 * mpeg4: global headers (they can be in the bitstream or here)
1190 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1191 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1192 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1193 * - encoding: Set/allocated/freed by libavcodec.
1194 * - decoding: Set/allocated/freed by user.
1200 * This is the fundamental unit of time (in seconds) in terms
1201 * of which frame timestamps are represented. For fixed-fps content,
1202 * timebase should be 1/framerate and timestamp increments should be
1204 * - encoding: MUST be set by user.
1205 * - decoding: Set by libavcodec.
1207 AVRational time_base;
1211 * picture width / height.
1212 * - encoding: MUST be set by user.
1213 * - decoding: Set by libavcodec.
1214 * Note: For compatibility it is possible to set this instead of
1215 * coded_width/height before decoding.
1219 #define FF_ASPECT_EXTENDED 15
1222 * the number of pictures in a group of pictures, or 0 for intra_only
1223 * - encoding: Set by user.
1224 * - decoding: unused
1229 * Pixel format, see PIX_FMT_xxx.
1230 * May be set by the demuxer if known from headers.
1231 * May be overriden by the decoder if it knows better.
1232 * - encoding: Set by user.
1233 * - decoding: Set by user if known, overridden by libavcodec if known
1235 enum PixelFormat pix_fmt;
1238 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1239 * decoder to draw a horizontal band. It improves cache usage. Not
1240 * all codecs can do that. You must check the codec capabilities
1242 * When multithreading is used, it may be called from multiple threads
1243 * at the same time; threads might draw different parts of the same AVFrame,
1244 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1246 * The function is also used by hardware acceleration APIs.
1247 * It is called at least once during frame decoding to pass
1248 * the data needed for hardware render.
1249 * In that mode instead of pixel data, AVFrame points to
1250 * a structure specific to the acceleration API. The application
1251 * reads the structure and can change some fields to indicate progress
1253 * - encoding: unused
1254 * - decoding: Set by user.
1255 * @param height the height of the slice
1256 * @param y the y position of the slice
1257 * @param type 1->top field, 2->bottom field, 3->frame
1258 * @param offset offset into the AVFrame.data from which the slice should be read
1260 void (*draw_horiz_band)(struct AVCodecContext *s,
1261 const AVFrame *src, int offset[4],
1262 int y, int type, int height);
1265 int sample_rate; ///< samples per second
1266 int channels; ///< number of audio channels
1269 * audio sample format
1270 * - encoding: Set by user.
1271 * - decoding: Set by libavcodec.
1273 enum AVSampleFormat sample_fmt; ///< sample format
1275 /* The following data should not be initialized. */
1277 * Samples per packet, initialized when calling 'init'.
1280 int frame_number; ///< audio or video frame number
1283 * Number of frames the decoded output will be delayed relative to
1284 * the encoded input.
1285 * - encoding: Set by libavcodec.
1286 * - decoding: unused
1290 /* - encoding parameters */
1291 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1292 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1296 * - encoding: Set by user.
1297 * - decoding: unused
1303 * - encoding: Set by user.
1304 * - decoding: unused
1309 * maximum quantizer difference between frames
1310 * - encoding: Set by user.
1311 * - decoding: unused
1316 * maximum number of B-frames between non-B-frames
1317 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1318 * - encoding: Set by user.
1319 * - decoding: unused
1324 * qscale factor between IP and B-frames
1325 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1326 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1327 * - encoding: Set by user.
1328 * - decoding: unused
1330 float b_quant_factor;
1332 /** obsolete FIXME remove */
1334 #define FF_RC_STRATEGY_XVID 1
1336 int b_frame_strategy;
1338 struct AVCodec *codec;
1342 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1343 /* do its best to deliver a chunk with size */
1344 /* below rtp_payload_size, the chunk will start */
1345 /* with a start code on some codecs like H.263. */
1346 /* This doesn't take account of any particular */
1347 /* headers inside the transmitted RTP payload. */
1350 /* The RTP callback: This function is called */
1351 /* every time the encoder has a packet to send. */
1352 /* It depends on the encoder if the data starts */
1353 /* with a Start Code (it should). H.263 does. */
1354 /* mb_nb contains the number of macroblocks */
1355 /* encoded in the RTP payload. */
1356 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1358 /* statistics, used for 2-pass encoding */
1369 * number of bits used for the previously encoded frame
1370 * - encoding: Set by libavcodec.
1371 * - decoding: unused
1376 * Private data of the user, can be used to carry app specific stuff.
1377 * - encoding: Set by user.
1378 * - decoding: Set by user.
1382 char codec_name[32];
1383 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1384 enum CodecID codec_id; /* see CODEC_ID_xxx */
1387 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1388 * This is used to work around some encoder bugs.
1389 * A demuxer should set this to what is stored in the field used to identify the codec.
1390 * If there are multiple such fields in a container then the demuxer should choose the one
1391 * which maximizes the information about the used codec.
1392 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1393 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1394 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1396 * - encoding: Set by user, if not then the default based on codec_id will be used.
1397 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1399 unsigned int codec_tag;
1402 * Work around bugs in encoders which sometimes cannot be detected automatically.
1403 * - encoding: Set by user
1404 * - decoding: Set by user
1406 int workaround_bugs;
1407 #define FF_BUG_AUTODETECT 1 ///< autodetection
1408 #define FF_BUG_OLD_MSMPEG4 2
1409 #define FF_BUG_XVID_ILACE 4
1410 #define FF_BUG_UMP4 8
1411 #define FF_BUG_NO_PADDING 16
1412 #define FF_BUG_AMV 32
1413 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1414 #define FF_BUG_QPEL_CHROMA 64
1415 #define FF_BUG_STD_QPEL 128
1416 #define FF_BUG_QPEL_CHROMA2 256
1417 #define FF_BUG_DIRECT_BLOCKSIZE 512
1418 #define FF_BUG_EDGE 1024
1419 #define FF_BUG_HPEL_CHROMA 2048
1420 #define FF_BUG_DC_CLIP 4096
1421 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1422 #define FF_BUG_TRUNCATED 16384
1423 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1426 * luma single coefficient elimination threshold
1427 * - encoding: Set by user.
1428 * - decoding: unused
1430 int luma_elim_threshold;
1433 * chroma single coeff elimination threshold
1434 * - encoding: Set by user.
1435 * - decoding: unused
1437 int chroma_elim_threshold;
1440 * strictly follow the standard (MPEG4, ...).
1441 * - encoding: Set by user.
1442 * - decoding: Set by user.
1443 * Setting this to STRICT or higher means the encoder and decoder will
1444 * generally do stupid things, whereas setting it to unofficial or lower
1445 * will mean the encoder might produce output that is not supported by all
1446 * spec-compliant decoders. Decoders don't differentiate between normal,
1447 * unofficial and experimental (that is, they always try to decode things
1448 * when they can) unless they are explicitly asked to behave stupidly
1449 * (=strictly conform to the specs)
1451 int strict_std_compliance;
1452 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1453 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1454 #define FF_COMPLIANCE_NORMAL 0
1455 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1456 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1459 * qscale offset between IP and B-frames
1460 * - encoding: Set by user.
1461 * - decoding: unused
1463 float b_quant_offset;
1466 * Error recognition; higher values will detect more errors but may
1467 * misdetect some more or less valid parts as errors.
1468 * - encoding: unused
1469 * - decoding: Set by user.
1471 int error_recognition;
1472 #define FF_ER_CAREFUL 1
1473 #define FF_ER_COMPLIANT 2
1474 #define FF_ER_AGGRESSIVE 3
1475 #if FF_API_VERY_AGGRESSIVE
1476 #define FF_ER_VERY_AGGRESSIVE 4
1477 #define FF_ER_EXPLODE 5
1479 #define FF_ER_EXPLODE 4
1480 #endif /* FF_API_VERY_AGGRESSIVE */
1483 * Called at the beginning of each frame to get a buffer for it.
1484 * If pic.reference is set then the frame will be read later by libavcodec.
1485 * avcodec_align_dimensions2() should be used to find the required width and
1486 * height, as they normally need to be rounded up to the next multiple of 16.
1487 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1488 * avcodec_default_get_buffer() instead of providing buffers allocated by
1490 * If frame multithreading is used and thread_safe_callbacks is set,
1491 * it may be called from a different thread, but not from more than one at once.
1492 * Does not need to be reentrant.
1493 * - encoding: unused
1494 * - decoding: Set by libavcodec, user can override.
1496 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1499 * Called to release buffers which were allocated with get_buffer.
1500 * A released buffer can be reused in get_buffer().
1501 * pic.data[*] must be set to NULL.
1502 * May be called from a different thread if frame multithreading is used,
1503 * but not by more than one thread at once, so does not need to be reentrant.
1504 * - encoding: unused
1505 * - decoding: Set by libavcodec, user can override.
1507 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1510 * Size of the frame reordering buffer in the decoder.
1511 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1512 * - encoding: Set by libavcodec.
1513 * - decoding: Set by libavcodec.
1518 * number of bytes per packet if constant and known or 0
1519 * Used by some WAV based audio codecs.
1523 int parse_only; /* - decoding only: If true, only parsing is done
1524 (function avcodec_parse_frame()). The frame
1525 data is returned. Only MPEG codecs support this now. */
1528 * 0-> h263 quant 1-> mpeg quant
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * pass1 encoding statistics output buffer
1536 * - encoding: Set by libavcodec.
1537 * - decoding: unused
1542 * pass2 encoding statistics input buffer
1543 * Concatenated stuff from stats_out of pass1 should be placed here.
1544 * - encoding: Allocated/set/freed by user.
1545 * - decoding: unused
1550 * ratecontrol qmin qmax limiting method
1551 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1552 * - encoding: Set by user.
1553 * - decoding: unused
1561 * ratecontrol override, see RcOverride
1562 * - encoding: Allocated/set/freed by user.
1563 * - decoding: unused
1565 RcOverride *rc_override;
1566 int rc_override_count;
1569 * rate control equation
1570 * - encoding: Set by user
1571 * - decoding: unused
1577 * - encoding: Set by user.
1578 * - decoding: unused
1584 * - encoding: Set by user.
1585 * - decoding: unused
1590 * decoder bitstream buffer size
1591 * - encoding: Set by user.
1592 * - decoding: unused
1595 float rc_buffer_aggressivity;
1598 * qscale factor between P and I-frames
1599 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1600 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1601 * - encoding: Set by user.
1602 * - decoding: unused
1604 float i_quant_factor;
1607 * qscale offset between P and I-frames
1608 * - encoding: Set by user.
1609 * - decoding: unused
1611 float i_quant_offset;
1614 * initial complexity for pass1 ratecontrol
1615 * - encoding: Set by user.
1616 * - decoding: unused
1618 float rc_initial_cplx;
1621 * DCT algorithm, see FF_DCT_* below
1622 * - encoding: Set by user.
1623 * - decoding: unused
1626 #define FF_DCT_AUTO 0
1627 #define FF_DCT_FASTINT 1
1628 #define FF_DCT_INT 2
1629 #define FF_DCT_MMX 3
1630 #define FF_DCT_MLIB 4
1631 #define FF_DCT_ALTIVEC 5
1632 #define FF_DCT_FAAN 6
1635 * luminance masking (0-> disabled)
1636 * - encoding: Set by user.
1637 * - decoding: unused
1642 * temporary complexity masking (0-> disabled)
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 float temporal_cplx_masking;
1649 * spatial complexity masking (0-> disabled)
1650 * - encoding: Set by user.
1651 * - decoding: unused
1653 float spatial_cplx_masking;
1656 * p block masking (0-> disabled)
1657 * - encoding: Set by user.
1658 * - decoding: unused
1663 * darkness masking (0-> disabled)
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * IDCT algorithm, see FF_IDCT_* below.
1671 * - encoding: Set by user.
1672 * - decoding: Set by user.
1675 #define FF_IDCT_AUTO 0
1676 #define FF_IDCT_INT 1
1677 #define FF_IDCT_SIMPLE 2
1678 #define FF_IDCT_SIMPLEMMX 3
1679 #define FF_IDCT_LIBMPEG2MMX 4
1680 #define FF_IDCT_PS2 5
1681 #define FF_IDCT_MLIB 6
1682 #define FF_IDCT_ARM 7
1683 #define FF_IDCT_ALTIVEC 8
1684 #define FF_IDCT_SH4 9
1685 #define FF_IDCT_SIMPLEARM 10
1686 #define FF_IDCT_H264 11
1687 #define FF_IDCT_VP3 12
1688 #define FF_IDCT_IPP 13
1689 #define FF_IDCT_XVIDMMX 14
1690 #define FF_IDCT_CAVS 15
1691 #define FF_IDCT_SIMPLEARMV5TE 16
1692 #define FF_IDCT_SIMPLEARMV6 17
1693 #define FF_IDCT_SIMPLEVIS 18
1694 #define FF_IDCT_WMV2 19
1695 #define FF_IDCT_FAAN 20
1696 #define FF_IDCT_EA 21
1697 #define FF_IDCT_SIMPLENEON 22
1698 #define FF_IDCT_SIMPLEALPHA 23
1699 #define FF_IDCT_BINK 24
1703 * - encoding: Set by libavcodec.
1704 * - decoding: Set by user (or 0).
1708 * slice offsets in the frame in bytes
1709 * - encoding: Set/allocated by libavcodec.
1710 * - decoding: Set/allocated by user (or NULL).
1715 * error concealment flags
1716 * - encoding: unused
1717 * - decoding: Set by user.
1719 int error_concealment;
1720 #define FF_EC_GUESS_MVS 1
1721 #define FF_EC_DEBLOCK 2
1724 * dsp_mask could be add used to disable unwanted CPU features
1725 * CPU features (i.e. MMX, SSE. ...)
1727 * With the FORCE flag you may instead enable given CPU features.
1728 * (Dangerous: Usable in case of misdetection, improper usage however will
1729 * result into program crash.)
1734 * bits per sample/pixel from the demuxer (needed for huffyuv).
1735 * - encoding: Set by libavcodec.
1736 * - decoding: Set by user.
1738 int bits_per_coded_sample;
1741 * prediction method (needed for huffyuv)
1742 * - encoding: Set by user.
1743 * - decoding: unused
1745 int prediction_method;
1746 #define FF_PRED_LEFT 0
1747 #define FF_PRED_PLANE 1
1748 #define FF_PRED_MEDIAN 2
1751 * sample aspect ratio (0 if unknown)
1752 * That is the width of a pixel divided by the height of the pixel.
1753 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1754 * - encoding: Set by user.
1755 * - decoding: Set by libavcodec.
1757 AVRational sample_aspect_ratio;
1760 * the picture in the bitstream
1761 * - encoding: Set by libavcodec.
1762 * - decoding: Set by libavcodec.
1764 AVFrame *coded_frame;
1768 * - encoding: Set by user.
1769 * - decoding: Set by user.
1772 #define FF_DEBUG_PICT_INFO 1
1773 #define FF_DEBUG_RC 2
1774 #define FF_DEBUG_BITSTREAM 4
1775 #define FF_DEBUG_MB_TYPE 8
1776 #define FF_DEBUG_QP 16
1777 #define FF_DEBUG_MV 32
1778 #define FF_DEBUG_DCT_COEFF 0x00000040
1779 #define FF_DEBUG_SKIP 0x00000080
1780 #define FF_DEBUG_STARTCODE 0x00000100
1781 #define FF_DEBUG_PTS 0x00000200
1782 #define FF_DEBUG_ER 0x00000400
1783 #define FF_DEBUG_MMCO 0x00000800
1784 #define FF_DEBUG_BUGS 0x00001000
1785 #define FF_DEBUG_VIS_QP 0x00002000
1786 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1787 #define FF_DEBUG_BUFFERS 0x00008000
1788 #define FF_DEBUG_THREADS 0x00010000
1792 * - encoding: Set by user.
1793 * - decoding: Set by user.
1796 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1797 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1798 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1802 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1803 * - decoding: unused
1808 * motion estimation comparison function
1809 * - encoding: Set by user.
1810 * - decoding: unused
1814 * subpixel motion estimation comparison function
1815 * - encoding: Set by user.
1816 * - decoding: unused
1820 * macroblock comparison function (not supported yet)
1821 * - encoding: Set by user.
1822 * - decoding: unused
1826 * interlaced DCT comparison function
1827 * - encoding: Set by user.
1828 * - decoding: unused
1831 #define FF_CMP_SAD 0
1832 #define FF_CMP_SSE 1
1833 #define FF_CMP_SATD 2
1834 #define FF_CMP_DCT 3
1835 #define FF_CMP_PSNR 4
1836 #define FF_CMP_BIT 5
1838 #define FF_CMP_ZERO 7
1839 #define FF_CMP_VSAD 8
1840 #define FF_CMP_VSSE 9
1841 #define FF_CMP_NSSE 10
1842 #define FF_CMP_W53 11
1843 #define FF_CMP_W97 12
1844 #define FF_CMP_DCTMAX 13
1845 #define FF_CMP_DCT264 14
1846 #define FF_CMP_CHROMA 256
1849 * ME diamond size & shape
1850 * - encoding: Set by user.
1851 * - decoding: unused
1856 * amount of previous MV predictors (2a+1 x 2a+1 square)
1857 * - encoding: Set by user.
1858 * - decoding: unused
1860 int last_predictor_count;
1863 * prepass for motion estimation
1864 * - encoding: Set by user.
1865 * - decoding: unused
1870 * motion estimation prepass comparison function
1871 * - encoding: Set by user.
1872 * - decoding: unused
1877 * ME prepass diamond size & shape
1878 * - encoding: Set by user.
1879 * - decoding: unused
1885 * - encoding: Set by user.
1886 * - decoding: unused
1888 int me_subpel_quality;
1891 * callback to negotiate the pixelFormat
1892 * @param fmt is the list of formats which are supported by the codec,
1893 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1894 * The first is always the native one.
1895 * @return the chosen format
1896 * - encoding: unused
1897 * - decoding: Set by user, if not set the native format will be chosen.
1899 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1902 * DTG active format information (additional aspect ratio
1903 * information only used in DVB MPEG-2 transport streams)
1906 * - encoding: unused
1907 * - decoding: Set by decoder.
1909 int dtg_active_format;
1910 #define FF_DTG_AFD_SAME 8
1911 #define FF_DTG_AFD_4_3 9
1912 #define FF_DTG_AFD_16_9 10
1913 #define FF_DTG_AFD_14_9 11
1914 #define FF_DTG_AFD_4_3_SP_14_9 13
1915 #define FF_DTG_AFD_16_9_SP_14_9 14
1916 #define FF_DTG_AFD_SP_4_3 15
1919 * maximum motion estimation search range in subpel units
1920 * If 0 then no limit.
1922 * - encoding: Set by user.
1923 * - decoding: unused
1928 * intra quantizer bias
1929 * - encoding: Set by user.
1930 * - decoding: unused
1932 int intra_quant_bias;
1933 #define FF_DEFAULT_QUANT_BIAS 999999
1936 * inter quantizer bias
1937 * - encoding: Set by user.
1938 * - decoding: unused
1940 int inter_quant_bias;
1944 * - encoding: unused
1945 * - decoding: Which clrtable should be used for 8bit RGB images.
1946 * Tables have to be stored somewhere. FIXME
1951 * internal_buffer count
1952 * Don't touch, used by libavcodec default_get_buffer().
1954 int internal_buffer_count;
1958 * Don't touch, used by libavcodec default_get_buffer().
1960 void *internal_buffer;
1963 * Global quality for codecs which cannot change it per frame.
1964 * This should be proportional to MPEG-1/2/4 qscale.
1965 * - encoding: Set by user.
1966 * - decoding: unused
1970 #define FF_CODER_TYPE_VLC 0
1971 #define FF_CODER_TYPE_AC 1
1972 #define FF_CODER_TYPE_RAW 2
1973 #define FF_CODER_TYPE_RLE 3
1974 #define FF_CODER_TYPE_DEFLATE 4
1977 * - encoding: Set by user.
1978 * - decoding: unused
1984 * - encoding: Set by user.
1985 * - decoding: unused
1991 * - encoding: unused
1992 * - decoding: Set by user.
1994 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1999 * - encoding: unused
2000 * - decoding: Set by user.
2003 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2004 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2005 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2008 * XVideo Motion Acceleration
2009 * - encoding: forbidden
2010 * - decoding: set by decoder
2012 int xvmc_acceleration;
2015 * macroblock decision mode
2016 * - encoding: Set by user.
2017 * - decoding: unused
2020 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2021 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2022 #define FF_MB_DECISION_RD 2 ///< rate distortion
2025 * custom intra quantization matrix
2026 * - encoding: Set by user, can be NULL.
2027 * - decoding: Set by libavcodec.
2029 uint16_t *intra_matrix;
2032 * custom inter quantization matrix
2033 * - encoding: Set by user, can be NULL.
2034 * - decoding: Set by libavcodec.
2036 uint16_t *inter_matrix;
2039 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2040 * This is used to work around some encoder bugs.
2041 * - encoding: unused
2042 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2044 unsigned int stream_codec_tag;
2047 * scene change detection threshold
2048 * 0 is default, larger means fewer detected scene changes.
2049 * - encoding: Set by user.
2050 * - decoding: unused
2052 int scenechange_threshold;
2055 * minimum Lagrange multipler
2056 * - encoding: Set by user.
2057 * - decoding: unused
2062 * maximum Lagrange multipler
2063 * - encoding: Set by user.
2064 * - decoding: unused
2068 #if FF_API_PALETTE_CONTROL
2070 * palette control structure
2071 * - encoding: ??? (no palette-enabled encoder yet)
2072 * - decoding: Set by user.
2074 struct AVPaletteControl *palctrl;
2078 * noise reduction strength
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 int noise_reduction;
2085 * Called at the beginning of a frame to get cr buffer for it.
2086 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2087 * libavcodec will pass previous buffer in pic, function should return
2088 * same buffer or new buffer with old frame "painted" into it.
2089 * If pic.data[0] == NULL must behave like get_buffer().
2090 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2091 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2093 * - encoding: unused
2094 * - decoding: Set by libavcodec, user can override.
2096 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2099 * Number of bits which should be loaded into the rc buffer before decoding starts.
2100 * - encoding: Set by user.
2101 * - decoding: unused
2103 int rc_initial_buffer_occupancy;
2107 * - encoding: Set by user.
2108 * - decoding: unused
2110 int inter_threshold;
2114 * - encoding: Set by user.
2115 * - decoding: Set by user.
2120 * Simulates errors in the bitstream to test error concealment.
2121 * - encoding: Set by user.
2122 * - decoding: unused
2126 #if FF_API_ANTIALIAS_ALGO
2128 * MP3 antialias algorithm, see FF_AA_* below.
2129 * - encoding: unused
2130 * - decoding: Set by user.
2132 attribute_deprecated int antialias_algo;
2133 #define FF_AA_AUTO 0
2134 #define FF_AA_FASTINT 1 //not implemented yet
2136 #define FF_AA_FLOAT 3
2140 * quantizer noise shaping
2141 * - encoding: Set by user.
2142 * - decoding: unused
2144 int quantizer_noise_shaping;
2148 * is used to decide how many independent tasks should be passed to execute()
2149 * - encoding: Set by user.
2150 * - decoding: Set by user.
2155 * The codec may call this to execute several independent things.
2156 * It will return only after finishing all tasks.
2157 * The user may replace this with some multithreaded implementation,
2158 * the default implementation will execute the parts serially.
2159 * @param count the number of things to execute
2160 * - encoding: Set by libavcodec, user can override.
2161 * - decoding: Set by libavcodec, user can override.
2163 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2167 * Can be used by execute() to store some per AVCodecContext stuff.
2168 * - encoding: set by execute()
2169 * - decoding: set by execute()
2171 void *thread_opaque;
2174 * Motion estimation threshold below which no motion estimation is
2175 * performed, but instead the user specified motion vectors are used.
2177 * - encoding: Set by user.
2178 * - decoding: unused
2183 * Macroblock threshold below which the user specified macroblock types will be used.
2184 * - encoding: Set by user.
2185 * - decoding: unused
2190 * precision of the intra DC coefficient - 8
2191 * - encoding: Set by user.
2192 * - decoding: unused
2194 int intra_dc_precision;
2197 * noise vs. sse weight for the nsse comparsion function
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * Number of macroblock rows at the top which are skipped.
2205 * - encoding: unused
2206 * - decoding: Set by user.
2211 * Number of macroblock rows at the bottom which are skipped.
2212 * - encoding: unused
2213 * - decoding: Set by user.
2219 * - encoding: Set by user.
2220 * - decoding: Set by libavcodec.
2223 #define FF_PROFILE_UNKNOWN -99
2224 #define FF_PROFILE_RESERVED -100
2226 #define FF_PROFILE_AAC_MAIN 0
2227 #define FF_PROFILE_AAC_LOW 1
2228 #define FF_PROFILE_AAC_SSR 2
2229 #define FF_PROFILE_AAC_LTP 3
2231 #define FF_PROFILE_DTS 20
2232 #define FF_PROFILE_DTS_ES 30
2233 #define FF_PROFILE_DTS_96_24 40
2234 #define FF_PROFILE_DTS_HD_HRA 50
2235 #define FF_PROFILE_DTS_HD_MA 60
2237 #define FF_PROFILE_MPEG2_422 0
2238 #define FF_PROFILE_MPEG2_HIGH 1
2239 #define FF_PROFILE_MPEG2_SS 2
2240 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2241 #define FF_PROFILE_MPEG2_MAIN 4
2242 #define FF_PROFILE_MPEG2_SIMPLE 5
2244 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2245 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2247 #define FF_PROFILE_H264_BASELINE 66
2248 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2249 #define FF_PROFILE_H264_MAIN 77
2250 #define FF_PROFILE_H264_EXTENDED 88
2251 #define FF_PROFILE_H264_HIGH 100
2252 #define FF_PROFILE_H264_HIGH_10 110
2253 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2254 #define FF_PROFILE_H264_HIGH_422 122
2255 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2256 #define FF_PROFILE_H264_HIGH_444 144
2257 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2258 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2259 #define FF_PROFILE_H264_CAVLC_444 44
2261 #define FF_PROFILE_VC1_SIMPLE 0
2262 #define FF_PROFILE_VC1_MAIN 1
2263 #define FF_PROFILE_VC1_COMPLEX 2
2264 #define FF_PROFILE_VC1_ADVANCED 3
2266 #define FF_PROFILE_MPEG4_SIMPLE 0
2267 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2268 #define FF_PROFILE_MPEG4_CORE 2
2269 #define FF_PROFILE_MPEG4_MAIN 3
2270 #define FF_PROFILE_MPEG4_N_BIT 4
2271 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2272 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2273 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2274 #define FF_PROFILE_MPEG4_HYBRID 8
2275 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2276 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2277 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2278 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2279 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2280 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2281 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2285 * - encoding: Set by user.
2286 * - decoding: Set by libavcodec.
2289 #define FF_LEVEL_UNKNOWN -99
2292 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2293 * - encoding: unused
2294 * - decoding: Set by user.
2299 * Bitstream width / height, may be different from width/height if lowres enabled.
2300 * - encoding: unused
2301 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2303 int coded_width, coded_height;
2306 * frame skip threshold
2307 * - encoding: Set by user.
2308 * - decoding: unused
2310 int frame_skip_threshold;
2314 * - encoding: Set by user.
2315 * - decoding: unused
2317 int frame_skip_factor;
2320 * frame skip exponent
2321 * - encoding: Set by user.
2322 * - decoding: unused
2327 * frame skip comparison function
2328 * - encoding: Set by user.
2329 * - decoding: unused
2334 * Border processing masking, raises the quantizer for mbs on the borders
2336 * - encoding: Set by user.
2337 * - decoding: unused
2339 float border_masking;
2342 * minimum MB lagrange multipler
2343 * - encoding: Set by user.
2344 * - decoding: unused
2349 * maximum MB lagrange multipler
2350 * - encoding: Set by user.
2351 * - decoding: unused
2357 * - encoding: Set by user.
2358 * - decoding: unused
2360 int me_penalty_compensation;
2364 * - encoding: unused
2365 * - decoding: Set by user.
2367 enum AVDiscard skip_loop_filter;
2371 * - encoding: unused
2372 * - decoding: Set by user.
2374 enum AVDiscard skip_idct;
2378 * - encoding: unused
2379 * - decoding: Set by user.
2381 enum AVDiscard skip_frame;
2385 * - encoding: Set by user.
2386 * - decoding: unused
2392 * - encoding: Set by user.
2393 * - decoding: unused
2397 #if FF_API_X264_GLOBAL_OPTS
2399 * constant rate factor - quality-based VBR - values ~correspond to qps
2400 * - encoding: Set by user.
2401 * - decoding: unused
2402 * @deprecated use 'crf' libx264 private option
2404 attribute_deprecated float crf;
2407 * constant quantization parameter rate control method
2408 * - encoding: Set by user.
2409 * - decoding: unused
2410 * @deprecated use 'cqp' libx264 private option
2412 attribute_deprecated int cqp;
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * number of reference frames
2424 * - encoding: Set by user.
2425 * - decoding: Set by lavc.
2430 * chroma qp offset from luma
2431 * - encoding: Set by user.
2432 * - decoding: unused
2436 #if FF_API_X264_GLOBAL_OPTS
2438 * Influences how often B-frames are used.
2439 * - encoding: Set by user.
2440 * - decoding: unused
2442 attribute_deprecated int bframebias;
2446 * trellis RD quantization
2447 * - encoding: Set by user.
2448 * - decoding: unused
2453 * Reduce fluctuations in qp (before curve compression).
2454 * - encoding: Set by user.
2455 * - decoding: unused
2457 float complexityblur;
2459 #if FF_API_X264_GLOBAL_OPTS
2461 * in-loop deblocking filter alphac0 parameter
2462 * alpha is in the range -6...6
2463 * - encoding: Set by user.
2464 * - decoding: unused
2466 attribute_deprecated int deblockalpha;
2469 * in-loop deblocking filter beta parameter
2470 * beta is in the range -6...6
2471 * - encoding: Set by user.
2472 * - decoding: unused
2474 attribute_deprecated int deblockbeta;
2478 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2479 * - encoding: Set by user.
2480 * - decoding: unused
2483 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2484 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2485 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2486 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2487 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2490 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * Audio cutoff bandwidth (0 means "automatic")
2498 * - encoding: Set by user.
2499 * - decoding: unused
2504 * Multiplied by qscale for each frame and added to scene_change_score.
2505 * - encoding: Set by user.
2506 * - decoding: unused
2508 int scenechange_factor;
2512 * Note: Value depends upon the compare function used for fullpel ME.
2513 * - encoding: Set by user.
2514 * - decoding: unused
2519 * Adjusts sensitivity of b_frame_strategy 1.
2520 * - encoding: Set by user.
2521 * - decoding: unused
2526 * - encoding: Set by user.
2527 * - decoding: unused
2529 int compression_level;
2530 #define FF_COMPRESSION_DEFAULT -1
2533 * - encoding: Set by user.
2534 * - decoding: unused
2536 int min_prediction_order;
2539 * - encoding: Set by user.
2540 * - decoding: unused
2542 int max_prediction_order;
2544 #if FF_API_FLAC_GLOBAL_OPTS
2546 * @name FLAC options
2547 * @deprecated Use FLAC encoder private options instead.
2552 * LPC coefficient precision - used by FLAC encoder
2553 * - encoding: Set by user.
2554 * - decoding: unused
2556 attribute_deprecated int lpc_coeff_precision;
2559 * search method for selecting prediction order
2560 * - encoding: Set by user.
2561 * - decoding: unused
2563 attribute_deprecated int prediction_order_method;
2566 * - encoding: Set by user.
2567 * - decoding: unused
2569 attribute_deprecated int min_partition_order;
2572 * - encoding: Set by user.
2573 * - decoding: unused
2575 attribute_deprecated int max_partition_order;
2582 * GOP timecode frame start number, in non drop frame format
2583 * - encoding: Set by user.
2584 * - decoding: unused
2586 int64_t timecode_frame_start;
2588 #if FF_API_REQUEST_CHANNELS
2590 * Decoder should decode to this many channels if it can (0 for default)
2591 * - encoding: unused
2592 * - decoding: Set by user.
2593 * @deprecated Deprecated in favor of request_channel_layout.
2595 int request_channels;
2598 #if FF_API_DRC_SCALE
2600 * Percentage of dynamic range compression to be applied by the decoder.
2601 * The default value is 1.0, corresponding to full compression.
2602 * - encoding: unused
2603 * - decoding: Set by user.
2604 * @deprecated use AC3 decoder private option instead.
2606 attribute_deprecated float drc_scale;
2610 * opaque 64bit number (generally a PTS) that will be reordered and
2611 * output in AVFrame.reordered_opaque
2612 * @deprecated in favor of pkt_pts
2613 * - encoding: unused
2614 * - decoding: Set by user.
2616 int64_t reordered_opaque;
2619 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2620 * - encoding: set by user.
2621 * - decoding: set by libavcodec.
2623 int bits_per_raw_sample;
2626 * Audio channel layout.
2627 * - encoding: set by user.
2628 * - decoding: set by libavcodec.
2630 int64_t channel_layout;
2633 * Request decoder to use this channel layout if it can (0 for default)
2634 * - encoding: unused
2635 * - decoding: Set by user.
2637 int64_t request_channel_layout;
2640 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2641 * - encoding: Set by user.
2642 * - decoding: unused.
2644 float rc_max_available_vbv_use;
2647 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2648 * - encoding: Set by user.
2649 * - decoding: unused.
2651 float rc_min_vbv_overflow_use;
2654 * Hardware accelerator in use
2655 * - encoding: unused.
2656 * - decoding: Set by libavcodec
2658 struct AVHWAccel *hwaccel;
2661 * For some codecs, the time base is closer to the field rate than the frame rate.
2662 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2663 * if no telecine is used ...
2665 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2667 int ticks_per_frame;
2670 * Hardware accelerator context.
2671 * For some hardware accelerators, a global context needs to be
2672 * provided by the user. In that case, this holds display-dependent
2673 * data Libav cannot instantiate itself. Please refer to the
2674 * Libav HW accelerator documentation to know how to fill this
2675 * is. e.g. for VA API, this is a struct vaapi_context.
2676 * - encoding: unused
2677 * - decoding: Set by user
2679 void *hwaccel_context;
2682 * Chromaticity coordinates of the source primaries.
2683 * - encoding: Set by user
2684 * - decoding: Set by libavcodec
2686 enum AVColorPrimaries color_primaries;
2689 * Color Transfer Characteristic.
2690 * - encoding: Set by user
2691 * - decoding: Set by libavcodec
2693 enum AVColorTransferCharacteristic color_trc;
2696 * YUV colorspace type.
2697 * - encoding: Set by user
2698 * - decoding: Set by libavcodec
2700 enum AVColorSpace colorspace;
2703 * MPEG vs JPEG YUV range.
2704 * - encoding: Set by user
2705 * - decoding: Set by libavcodec
2707 enum AVColorRange color_range;
2710 * This defines the location of chroma samples.
2711 * - encoding: Set by user
2712 * - decoding: Set by libavcodec
2714 enum AVChromaLocation chroma_sample_location;
2717 * The codec may call this to execute several independent things.
2718 * It will return only after finishing all tasks.
2719 * The user may replace this with some multithreaded implementation,
2720 * the default implementation will execute the parts serially.
2721 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2722 * @param c context passed also to func
2723 * @param count the number of things to execute
2724 * @param arg2 argument passed unchanged to func
2725 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2726 * @param func function that will be called count times, with jobnr from 0 to count-1.
2727 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2728 * two instances of func executing at the same time will have the same threadnr.
2729 * @return always 0 currently, but code should handle a future improvement where when any call to func
2730 * returns < 0 no further calls to func may be done and < 0 is returned.
2731 * - encoding: Set by libavcodec, user can override.
2732 * - decoding: Set by libavcodec, user can override.
2734 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2736 #if FF_API_X264_GLOBAL_OPTS
2738 * explicit P-frame weighted prediction analysis method
2740 * 1: fast blind weighting (one reference duplicate with -1 offset)
2741 * 2: smart weighting (full fade detection analysis)
2742 * - encoding: Set by user.
2743 * - decoding: unused
2745 attribute_deprecated int weighted_p_pred;
2750 * 1: Variance AQ (complexity mask)
2751 * 2: Auto-variance AQ (experimental)
2752 * - encoding: Set by user
2753 * - decoding: unused
2755 attribute_deprecated int aq_mode;
2759 * Reduces blocking and blurring in flat and textured areas.
2760 * - encoding: Set by user
2761 * - decoding: unused
2763 attribute_deprecated float aq_strength;
2767 * Strength of psychovisual optimization
2768 * - encoding: Set by user
2769 * - decoding: unused
2771 attribute_deprecated float psy_rd;
2775 * Strength of psychovisual optimization
2776 * - encoding: Set by user
2777 * - decoding: unused
2779 attribute_deprecated float psy_trellis;
2783 * Number of frames for frametype and ratecontrol lookahead
2784 * - encoding: Set by user
2785 * - decoding: unused
2787 attribute_deprecated int rc_lookahead;
2790 * Constant rate factor maximum
2791 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2792 * than crf_max, even if doing so would violate VBV restrictions.
2793 * - encoding: Set by user.
2794 * - decoding: unused
2796 attribute_deprecated float crf_max;
2799 int log_level_offset;
2801 #if FF_API_FLAC_GLOBAL_OPTS
2803 * Determines which LPC analysis algorithm to use.
2804 * - encoding: Set by user
2805 * - decoding: unused
2807 attribute_deprecated enum AVLPCType lpc_type;
2810 * Number of passes to use for Cholesky factorization during LPC analysis
2811 * - encoding: Set by user
2812 * - decoding: unused
2814 attribute_deprecated int lpc_passes;
2819 * Indicates number of picture subdivisions. Used for parallelized
2821 * - encoding: Set by user
2822 * - decoding: unused
2827 * Header containing style information for text subtitles.
2828 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2829 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2830 * the Format line following. It shouldn't include any Dialogue line.
2831 * - encoding: Set/allocated/freed by user (before avcodec_open())
2832 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2834 uint8_t *subtitle_header;
2835 int subtitle_header_size;
2838 * Current packet as passed into the decoder, to avoid having
2839 * to pass the packet into every function. Currently only valid
2840 * inside lavc and get/release_buffer callbacks.
2841 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2842 * - encoding: unused
2847 * Whether this is a copy of the context which had init() called on it.
2848 * This is used by multithreading - shared tables and picture pointers
2849 * should be freed from the original context only.
2850 * - encoding: Set by libavcodec.
2851 * - decoding: Set by libavcodec.
2856 * Which multithreading methods to use.
2857 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2858 * so clients which cannot provide future frames should not use it.
2860 * - encoding: Set by user, otherwise the default is used.
2861 * - decoding: Set by user, otherwise the default is used.
2864 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2865 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2868 * Which multithreading methods are in use by the codec.
2869 * - encoding: Set by libavcodec.
2870 * - decoding: Set by libavcodec.
2872 int active_thread_type;
2875 * Set by the client if its custom get_buffer() callback can be called
2876 * from another thread, which allows faster multithreaded decoding.
2877 * draw_horiz_band() will be called from other threads regardless of this setting.
2878 * Ignored if the default get_buffer() is used.
2879 * - encoding: Set by user.
2880 * - decoding: Set by user.
2882 int thread_safe_callbacks;
2885 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2886 * Used for compliant TS muxing.
2887 * - encoding: Set by libavcodec.
2888 * - decoding: unused.
2893 * Type of service that the audio stream conveys.
2894 * - encoding: Set by user.
2895 * - decoding: Set by libavcodec.
2897 enum AVAudioServiceType audio_service_type;
2900 * Used to request a sample format from the decoder.
2901 * - encoding: unused.
2902 * - decoding: Set by user.
2904 enum AVSampleFormat request_sample_fmt;
2910 typedef struct AVProfile {
2912 const char *name; ///< short name for the profile
2915 typedef struct AVCodecDefault AVCodecDefault;
2920 typedef struct AVCodec {
2922 * Name of the codec implementation.
2923 * The name is globally unique among encoders and among decoders (but an
2924 * encoder and a decoder can share the same name).
2925 * This is the primary way to find a codec from the user perspective.
2928 enum AVMediaType type;
2931 int (*init)(AVCodecContext *);
2932 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2933 int (*close)(AVCodecContext *);
2934 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2936 * Codec capabilities.
2940 struct AVCodec *next;
2943 * Will be called when seeking
2945 void (*flush)(AVCodecContext *);
2946 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2947 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2949 * Descriptive name for the codec, meant to be more human readable than name.
2950 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2952 const char *long_name;
2953 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2954 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2955 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2956 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2957 const AVClass *priv_class; ///< AVClass for the private context
2958 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2961 * @name Frame-level threading support functions
2965 * If defined, called on thread contexts when they are created.
2966 * If the codec allocates writable tables in init(), re-allocate them here.
2967 * priv_data will be set to a copy of the original.
2969 int (*init_thread_copy)(AVCodecContext *);
2971 * Copy necessary context variables from a previous thread context to the current one.
2972 * If not defined, the next thread will start automatically; otherwise, the codec
2973 * must call ff_thread_finish_setup().
2975 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2977 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2981 * Private codec-specific defaults.
2983 const AVCodecDefault *defaults;
2989 typedef struct AVHWAccel {
2991 * Name of the hardware accelerated codec.
2992 * The name is globally unique among encoders and among decoders (but an
2993 * encoder and a decoder can share the same name).
2998 * Type of codec implemented by the hardware accelerator.
3000 * See AVMEDIA_TYPE_xxx
3002 enum AVMediaType type;
3005 * Codec implemented by the hardware accelerator.
3012 * Supported pixel format.
3014 * Only hardware accelerated formats are supported here.
3016 enum PixelFormat pix_fmt;
3019 * Hardware accelerated codec capabilities.
3020 * see FF_HWACCEL_CODEC_CAP_*
3024 struct AVHWAccel *next;
3027 * Called at the beginning of each frame or field picture.
3029 * Meaningful frame information (codec specific) is guaranteed to
3030 * be parsed at this point. This function is mandatory.
3032 * Note that buf can be NULL along with buf_size set to 0.
3033 * Otherwise, this means the whole frame is available at this point.
3035 * @param avctx the codec context
3036 * @param buf the frame data buffer base
3037 * @param buf_size the size of the frame in bytes
3038 * @return zero if successful, a negative value otherwise
3040 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3043 * Callback for each slice.
3045 * Meaningful slice information (codec specific) is guaranteed to
3046 * be parsed at this point. This function is mandatory.
3048 * @param avctx the codec context
3049 * @param buf the slice data buffer base
3050 * @param buf_size the size of the slice in bytes
3051 * @return zero if successful, a negative value otherwise
3053 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3056 * Called at the end of each frame or field picture.
3058 * The whole picture is parsed at this point and can now be sent
3059 * to the hardware accelerator. This function is mandatory.
3061 * @param avctx the codec context
3062 * @return zero if successful, a negative value otherwise
3064 int (*end_frame)(AVCodecContext *avctx);
3067 * Size of HW accelerator private data.
3069 * Private data is allocated with av_mallocz() before
3070 * AVCodecContext.get_buffer() and deallocated after
3071 * AVCodecContext.release_buffer().
3077 * four components are given, that's all.
3078 * the last component is alpha
3080 typedef struct AVPicture {
3082 int linesize[4]; ///< number of bytes per line
3085 #if FF_API_PALETTE_CONTROL
3088 * This structure defines a method for communicating palette changes
3089 * between and demuxer and a decoder.
3091 * @deprecated Use AVPacket to send palette changes instead.
3092 * This is totally broken.
3094 #define AVPALETTE_SIZE 1024
3095 #define AVPALETTE_COUNT 256
3096 typedef struct AVPaletteControl {
3098 /* Demuxer sets this to 1 to indicate the palette has changed;
3099 * decoder resets to 0. */
3100 int palette_changed;
3102 /* 4-byte ARGB palette entries, stored in native byte order; note that
3103 * the individual palette components should be on a 8-bit scale; if
3104 * the palette data comes from an IBM VGA native format, the component
3105 * data is probably 6 bits in size and needs to be scaled. */
3106 unsigned int palette[AVPALETTE_COUNT];
3108 } AVPaletteControl attribute_deprecated;
3111 enum AVSubtitleType {
3114 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3117 * Plain text, the text field must be set by the decoder and is
3118 * authoritative. ass and pict fields may contain approximations.
3123 * Formatted text, the ass field must be set by the decoder and is
3124 * authoritative. pict and text fields may contain approximations.
3129 typedef struct AVSubtitleRect {
3130 int x; ///< top left corner of pict, undefined when pict is not set
3131 int y; ///< top left corner of pict, undefined when pict is not set
3132 int w; ///< width of pict, undefined when pict is not set
3133 int h; ///< height of pict, undefined when pict is not set
3134 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3137 * data+linesize for the bitmap of this subtitle.
3138 * can be set for text/ass as well once they where rendered
3141 enum AVSubtitleType type;
3143 char *text; ///< 0 terminated plain UTF-8 text
3146 * 0 terminated ASS/SSA compatible event line.
3147 * The pressentation of this is unaffected by the other values in this
3153 typedef struct AVSubtitle {
3154 uint16_t format; /* 0 = graphics */
3155 uint32_t start_display_time; /* relative to packet pts, in ms */
3156 uint32_t end_display_time; /* relative to packet pts, in ms */
3158 AVSubtitleRect **rects;
3159 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3162 /* packet functions */
3165 * @deprecated use NULL instead
3167 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3170 * Default packet destructor.
3172 void av_destruct_packet(AVPacket *pkt);
3175 * Initialize optional fields of a packet with default values.
3179 void av_init_packet(AVPacket *pkt);
3182 * Allocate the payload of a packet and initialize its fields with
3186 * @param size wanted payload size
3187 * @return 0 if OK, AVERROR_xxx otherwise
3189 int av_new_packet(AVPacket *pkt, int size);
3192 * Reduce packet size, correctly zeroing padding
3195 * @param size new size
3197 void av_shrink_packet(AVPacket *pkt, int size);
3200 * Increase packet size, correctly zeroing padding
3203 * @param grow_by number of bytes by which to increase the size of the packet
3205 int av_grow_packet(AVPacket *pkt, int grow_by);
3208 * @warning This is a hack - the packet memory allocation stuff is broken. The
3209 * packet is allocated if it was not really allocated.
3211 int av_dup_packet(AVPacket *pkt);
3216 * @param pkt packet to free
3218 void av_free_packet(AVPacket *pkt);
3221 * Allocate new information of a packet.
3224 * @param type side information type
3225 * @param size side information size
3226 * @return pointer to fresh allocated data or NULL otherwise
3228 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3232 * Get side information from packet.
3235 * @param type desired side information type
3236 * @param size pointer for side information size to store (optional)
3237 * @return pointer to data if present or NULL otherwise
3239 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3244 struct ReSampleContext;
3245 struct AVResampleContext;
3247 typedef struct ReSampleContext ReSampleContext;
3250 * Initialize audio resampling context.
3252 * @param output_channels number of output channels
3253 * @param input_channels number of input channels
3254 * @param output_rate output sample rate
3255 * @param input_rate input sample rate
3256 * @param sample_fmt_out requested output sample format
3257 * @param sample_fmt_in input sample format
3258 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3259 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3260 * @param linear if 1 then the used FIR filter will be linearly interpolated
3261 between the 2 closest, if 0 the closest will be used
3262 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3263 * @return allocated ReSampleContext, NULL if error occured
3265 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3266 int output_rate, int input_rate,
3267 enum AVSampleFormat sample_fmt_out,
3268 enum AVSampleFormat sample_fmt_in,
3269 int filter_length, int log2_phase_count,
3270 int linear, double cutoff);
3272 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3275 * Free resample context.
3277 * @param s a non-NULL pointer to a resample context previously
3278 * created with av_audio_resample_init()
3280 void audio_resample_close(ReSampleContext *s);
3284 * Initialize an audio resampler.
3285 * Note, if either rate is not an integer then simply scale both rates up so they are.
3286 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3287 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3288 * @param linear If 1 then the used FIR filter will be linearly interpolated
3289 between the 2 closest, if 0 the closest will be used
3290 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3292 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3295 * Resample an array of samples using a previously configured context.
3296 * @param src an array of unconsumed samples
3297 * @param consumed the number of samples of src which have been consumed are returned here
3298 * @param src_size the number of unconsumed samples available
3299 * @param dst_size the amount of space in samples available in dst
3300 * @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.
3301 * @return the number of samples written in dst or -1 if an error occurred
3303 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3307 * Compensate samplerate/timestamp drift. The compensation is done by changing
3308 * the resampler parameters, so no audible clicks or similar distortions occur
3309 * @param compensation_distance distance in output samples over which the compensation should be performed
3310 * @param sample_delta number of output samples which should be output less
3312 * example: av_resample_compensate(c, 10, 500)
3313 * here instead of 510 samples only 500 samples would be output
3315 * note, due to rounding the actual compensation might be slightly different,
3316 * especially if the compensation_distance is large and the in_rate used during init is small
3318 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3319 void av_resample_close(struct AVResampleContext *c);
3322 * Allocate memory for a picture. Call avpicture_free() to free it.
3324 * @see avpicture_fill()
3326 * @param picture the picture to be filled in
3327 * @param pix_fmt the format of the picture
3328 * @param width the width of the picture
3329 * @param height the height of the picture
3330 * @return zero if successful, a negative value if not
3332 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3335 * Free a picture previously allocated by avpicture_alloc().
3336 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3339 * @param picture the AVPicture to be freed
3341 void avpicture_free(AVPicture *picture);
3344 * Fill in the AVPicture fields.
3345 * The fields of the given AVPicture are filled in by using the 'ptr' address
3346 * which points to the image data buffer. Depending on the specified picture
3347 * format, one or multiple image data pointers and line sizes will be set.
3348 * If a planar format is specified, several pointers will be set pointing to
3349 * the different picture planes and the line sizes of the different planes
3350 * will be stored in the lines_sizes array.
3351 * Call with ptr == NULL to get the required size for the ptr buffer.
3353 * To allocate the buffer and fill in the AVPicture fields in one call,
3354 * use avpicture_alloc().
3356 * @param picture AVPicture whose fields are to be filled in
3357 * @param ptr Buffer which will contain or contains the actual image data
3358 * @param pix_fmt The format in which the picture data is stored.
3359 * @param width the width of the image in pixels
3360 * @param height the height of the image in pixels
3361 * @return size of the image data in bytes
3363 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3364 enum PixelFormat pix_fmt, int width, int height);
3367 * Copy pixel data from an AVPicture into a buffer.
3368 * The data is stored compactly, without any gaps for alignment or padding
3369 * which may be applied by avpicture_fill().
3371 * @see avpicture_get_size()
3373 * @param[in] src AVPicture containing image data
3374 * @param[in] pix_fmt The format in which the picture data is stored.
3375 * @param[in] width the width of the image in pixels.
3376 * @param[in] height the height of the image in pixels.
3377 * @param[out] dest A buffer into which picture data will be copied.
3378 * @param[in] dest_size The size of 'dest'.
3379 * @return The number of bytes written to dest, or a negative value (error code) on error.
3381 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3382 unsigned char *dest, int dest_size);
3385 * Calculate the size in bytes that a picture of the given width and height
3386 * would occupy if stored in the given picture format.
3387 * Note that this returns the size of a compact representation as generated
3388 * by avpicture_layout(), which can be smaller than the size required for e.g.
3391 * @param pix_fmt the given picture format
3392 * @param width the width of the image
3393 * @param height the height of the image
3394 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3396 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3397 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3399 #if FF_API_GET_PIX_FMT_NAME
3401 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3403 attribute_deprecated
3404 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3407 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3410 * Return a value representing the fourCC code associated to the
3411 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3414 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3417 * Put a string representing the codec tag codec_tag in buf.
3419 * @param buf_size size in bytes of buf
3420 * @return the length of the string that would have been generated if
3421 * enough space had been available, excluding the trailing null
3423 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3425 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3426 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3427 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3428 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3429 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3430 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3433 * Compute what kind of losses will occur when converting from one specific
3434 * pixel format to another.
3435 * When converting from one pixel format to another, information loss may occur.
3436 * For example, when converting from RGB24 to GRAY, the color information will
3437 * be lost. Similarly, other losses occur when converting from some formats to
3438 * other formats. These losses can involve loss of chroma, but also loss of
3439 * resolution, loss of color depth, loss due to the color space conversion, loss
3440 * of the alpha bits or loss due to color quantization.
3441 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3442 * which will occur when converting from one pixel format to another.
3444 * @param[in] dst_pix_fmt destination pixel format
3445 * @param[in] src_pix_fmt source pixel format
3446 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3447 * @return Combination of flags informing you what kind of losses will occur.
3449 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3453 * Find the best pixel format to convert to given a certain source pixel
3454 * format. When converting from one pixel format to another, information loss
3455 * may occur. For example, when converting from RGB24 to GRAY, the color
3456 * information will be lost. Similarly, other losses occur when converting from
3457 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3458 * the given pixel formats should be used to suffer the least amount of loss.
3459 * The pixel formats from which it chooses one, are determined by the
3460 * pix_fmt_mask parameter.
3463 * src_pix_fmt = PIX_FMT_YUV420P;
3464 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3465 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3468 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3469 * @param[in] src_pix_fmt source pixel format
3470 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3471 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3472 * @return The best pixel format to convert to or -1 if none was found.
3474 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3475 int has_alpha, int *loss_ptr);
3477 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3478 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3481 * Tell if an image really has transparent alpha values.
3482 * @return ored mask of FF_ALPHA_xxx constants
3484 int img_get_alpha_info(const AVPicture *src,
3485 enum PixelFormat pix_fmt, int width, int height);
3487 /* deinterlace a picture */
3488 /* deinterlace - if not supported return -1 */
3489 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3490 enum PixelFormat pix_fmt, int width, int height);
3492 /* external high level API */
3495 * If c is NULL, returns the first registered codec,
3496 * if c is non-NULL, returns the next registered codec after c,
3497 * or NULL if c is the last one.
3499 AVCodec *av_codec_next(AVCodec *c);
3502 * Return the LIBAVCODEC_VERSION_INT constant.
3504 unsigned avcodec_version(void);
3507 * Return the libavcodec build-time configuration.
3509 const char *avcodec_configuration(void);
3512 * Return the libavcodec license.
3514 const char *avcodec_license(void);
3516 #if FF_API_AVCODEC_INIT
3518 * @deprecated this function is called automatically from avcodec_register()
3519 * and avcodec_register_all(), there is no need to call it manually
3521 attribute_deprecated
3522 void avcodec_init(void);
3526 * Register the codec codec and initialize libavcodec.
3528 * @warning either this function or avcodec_register_all() must be called
3529 * before any other libavcodec functions.
3531 * @see avcodec_register_all()
3533 void avcodec_register(AVCodec *codec);
3536 * Find a registered encoder with a matching codec ID.
3538 * @param id CodecID of the requested encoder
3539 * @return An encoder if one was found, NULL otherwise.
3541 AVCodec *avcodec_find_encoder(enum CodecID id);
3544 * Find a registered encoder with the specified name.
3546 * @param name name of the requested encoder
3547 * @return An encoder if one was found, NULL otherwise.
3549 AVCodec *avcodec_find_encoder_by_name(const char *name);
3552 * Find a registered decoder with a matching codec ID.
3554 * @param id CodecID of the requested decoder
3555 * @return A decoder if one was found, NULL otherwise.
3557 AVCodec *avcodec_find_decoder(enum CodecID id);
3560 * Find a registered decoder with the specified name.
3562 * @param name name of the requested decoder
3563 * @return A decoder if one was found, NULL otherwise.
3565 AVCodec *avcodec_find_decoder_by_name(const char *name);
3566 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3569 * Return a name for the specified profile, if available.
3571 * @param codec the codec that is searched for the given profile
3572 * @param profile the profile value for which a name is requested
3573 * @return A name for the profile if found, NULL otherwise.
3575 const char *av_get_profile_name(const AVCodec *codec, int profile);
3578 * Set the fields of the given AVCodecContext to default values.
3580 * @param s The AVCodecContext of which the fields should be set to default values.
3582 void avcodec_get_context_defaults(AVCodecContext *s);
3584 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3585 * we WILL change its arguments and name a few times! */
3586 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3588 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3589 * we WILL change its arguments and name a few times! */
3590 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3592 #if FF_API_ALLOC_CONTEXT
3594 * Allocate an AVCodecContext and set its fields to default values. The
3595 * resulting struct can be deallocated by simply calling av_free().
3597 * @return An AVCodecContext filled with default values or NULL on failure.
3598 * @see avcodec_get_context_defaults
3600 * @deprecated use avcodec_alloc_context3()
3602 attribute_deprecated
3603 AVCodecContext *avcodec_alloc_context(void);
3605 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3606 * we WILL change its arguments and name a few times! */
3607 attribute_deprecated
3608 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3612 * Allocate an AVCodecContext and set its fields to default values. The
3613 * resulting struct can be deallocated by simply calling av_free().
3615 * @param codec if non-NULL, allocate private data and initialize defaults
3616 * for the given codec. It is illegal to then call avcodec_open()
3617 * with a different codec.
3619 * @return An AVCodecContext filled with default values or NULL on failure.
3620 * @see avcodec_get_context_defaults
3622 * @deprecated use avcodec_alloc_context3()
3624 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3627 * Copy the settings of the source AVCodecContext into the destination
3628 * AVCodecContext. The resulting destination codec context will be
3629 * unopened, i.e. you are required to call avcodec_open() before you
3630 * can use this AVCodecContext to decode/encode video/audio data.
3632 * @param dest target codec context, should be initialized with
3633 * avcodec_alloc_context3(), but otherwise uninitialized
3634 * @param src source codec context
3635 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3637 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3640 * Set the fields of the given AVFrame to default values.
3642 * @param pic The AVFrame of which the fields should be set to default values.
3644 void avcodec_get_frame_defaults(AVFrame *pic);
3647 * Allocate an AVFrame and set its fields to default values. The resulting
3648 * struct can be deallocated by simply calling av_free().
3650 * @return An AVFrame filled with default values or NULL on failure.
3651 * @see avcodec_get_frame_defaults
3653 AVFrame *avcodec_alloc_frame(void);
3655 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3656 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3657 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3660 * Return the amount of padding in pixels which the get_buffer callback must
3661 * provide around the edge of the image for codecs which do not have the
3662 * CODEC_FLAG_EMU_EDGE flag.
3664 * @return Required padding in pixels.
3666 unsigned avcodec_get_edge_width(void);
3668 * Modify width and height values so that they will result in a memory
3669 * buffer that is acceptable for the codec if you do not use any horizontal
3672 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3673 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3674 * according to avcodec_get_edge_width() before.
3676 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3678 * Modify width and height values so that they will result in a memory
3679 * buffer that is acceptable for the codec if you also ensure that all
3680 * line sizes are a multiple of the respective linesize_align[i].
3682 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3683 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3684 * according to avcodec_get_edge_width() before.
3686 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3687 int linesize_align[4]);
3689 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3691 #if FF_API_THREAD_INIT
3693 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3695 attribute_deprecated
3696 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3699 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3700 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3701 //FIXME func typedef
3703 #if FF_API_AVCODEC_OPEN
3705 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3706 * function the context has to be allocated.
3708 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3709 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3710 * retrieving a codec.
3712 * @warning This function is not thread safe!
3715 * avcodec_register_all();
3716 * codec = avcodec_find_decoder(CODEC_ID_H264);
3720 * context = avcodec_alloc_context3(codec);
3722 * if (avcodec_open(context, codec) < 0)
3726 * @param avctx The context which will be set up to use the given codec.
3727 * @param codec The codec to use within the context.
3728 * @return zero on success, a negative value on error
3729 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3731 * @deprecated use avcodec_open2
3733 attribute_deprecated
3734 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3738 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3739 * function the context has to be allocated with avcodec_alloc_context().
3741 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3742 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3743 * retrieving a codec.
3745 * @warning This function is not thread safe!
3748 * avcodec_register_all();
3749 * av_dict_set(&opts, "b", "2.5M", 0);
3750 * codec = avcodec_find_decoder(CODEC_ID_H264);
3754 * context = avcodec_alloc_context();
3756 * if (avcodec_open(context, codec, opts) < 0)
3760 * @param avctx The context to initialize.
3761 * @param options A dictionary filled with AVCodecContext and codec-private options.
3762 * On return this object will be filled with options that were not found.
3764 * @return zero on success, a negative value on error
3765 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3766 * av_dict_set(), av_opt_find().
3768 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3771 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3772 * Some decoders may support multiple frames in a single AVPacket, such
3773 * decoders would then just decode the first frame. In this case,
3774 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3775 * the remaining data in order to decode the second frame etc.
3777 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3778 * decompressed frame size in bytes.
3780 * @warning You must set frame_size_ptr to the allocated size of the
3781 * output buffer before calling avcodec_decode_audio3().
3783 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3784 * the actual read bytes because some optimized bitstream readers read 32 or 64
3785 * bits at once and could read over the end.
3787 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3788 * no overreading happens for damaged MPEG streams.
3790 * @note You might have to align the input buffer avpkt->data and output buffer
3791 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3792 * necessary at all, on others it won't work at all if not aligned and on others
3793 * it will work but it will have an impact on performance.
3795 * In practice, avpkt->data should have 4 byte alignment at minimum and
3796 * samples should be 16 byte aligned unless the CPU doesn't need it
3797 * (AltiVec and SSE do).
3799 * @param avctx the codec context
3800 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3801 * @param[in,out] frame_size_ptr the output buffer size in bytes
3802 * @param[in] avpkt The input AVPacket containing the input buffer.
3803 * You can create such packet with av_init_packet() and by then setting
3804 * data and size, some decoders might in addition need other fields.
3805 * All decoders are designed to use the least fields possible though.
3806 * @return On error a negative value is returned, otherwise the number of bytes
3807 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3809 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3810 int *frame_size_ptr,
3814 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3815 * Some decoders may support multiple frames in a single AVPacket, such
3816 * decoders would then just decode the first frame.
3818 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3819 * the actual read bytes because some optimized bitstream readers read 32 or 64
3820 * bits at once and could read over the end.
3822 * @warning The end of the input buffer buf should be set to 0 to ensure that
3823 * no overreading happens for damaged MPEG streams.
3825 * @note You might have to align the input buffer avpkt->data.
3826 * The alignment requirements depend on the CPU: on some CPUs it isn't
3827 * necessary at all, on others it won't work at all if not aligned and on others
3828 * it will work but it will have an impact on performance.
3830 * In practice, avpkt->data should have 4 byte alignment at minimum.
3832 * @note Some codecs have a delay between input and output, these need to be
3833 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3835 * @param avctx the codec context
3836 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3837 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3838 * allocate memory for the actual bitmap.
3839 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3840 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3841 * decodes and the decoder tells the user once it does not need the data anymore,
3842 * the user app can at this point free/reuse/keep the memory as it sees fit.
3844 * @param[in] avpkt The input AVpacket containing the input buffer.
3845 * You can create such packet with av_init_packet() and by then setting
3846 * data and size, some decoders might in addition need other fields like
3847 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3849 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3850 * @return On error a negative value is returned, otherwise the number of bytes
3851 * used or zero if no frame could be decompressed.
3853 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3854 int *got_picture_ptr,
3858 * Decode a subtitle message.
3859 * Return a negative value on error, otherwise return the number of bytes used.
3860 * If no subtitle could be decompressed, got_sub_ptr is zero.
3861 * Otherwise, the subtitle is stored in *sub.
3862 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3863 * simplicity, because the performance difference is expect to be negligible
3864 * and reusing a get_buffer written for video codecs would probably perform badly
3865 * due to a potentially very different allocation pattern.
3867 * @param avctx the codec context
3868 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3869 freed with avsubtitle_free if *got_sub_ptr is set.
3870 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3871 * @param[in] avpkt The input AVPacket containing the input buffer.
3873 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3878 * Frees all allocated data in the given subtitle struct.
3880 * @param sub AVSubtitle to free.
3882 void avsubtitle_free(AVSubtitle *sub);
3884 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3886 uint8_t *buf, int buf_size);
3889 * Encode an audio frame from samples into buf.
3891 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3892 * However, for PCM audio the user will know how much space is needed
3893 * because it depends on the value passed in buf_size as described
3894 * below. In that case a lower value can be used.
3896 * @param avctx the codec context
3897 * @param[out] buf the output buffer
3898 * @param[in] buf_size the output buffer size
3899 * @param[in] samples the input buffer containing the samples
3900 * The number of samples read from this buffer is frame_size*channels,
3901 * both of which are defined in avctx.
3902 * For PCM audio the number of samples read from samples is equal to
3903 * buf_size * input_sample_size / output_sample_size.
3904 * @return On error a negative value is returned, on success zero or the number
3905 * of bytes used to encode the data read from the input buffer.
3907 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3908 const short *samples);
3911 * Encode a video frame from pict into buf.
3912 * The input picture should be
3913 * stored using a specific format, namely avctx.pix_fmt.
3915 * @param avctx the codec context
3916 * @param[out] buf the output buffer for the bitstream of encoded frame
3917 * @param[in] buf_size the size of the output buffer in bytes
3918 * @param[in] pict the input picture to encode
3919 * @return On error a negative value is returned, on success zero or the number
3920 * of bytes used from the output buffer.
3922 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3923 const AVFrame *pict);
3924 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3925 const AVSubtitle *sub);
3927 int avcodec_close(AVCodecContext *avctx);
3930 * Register all the codecs, parsers and bitstream filters which were enabled at
3931 * configuration time. If you do not call this function you can select exactly
3932 * which formats you want to support, by using the individual registration
3935 * @see avcodec_register
3936 * @see av_register_codec_parser
3937 * @see av_register_bitstream_filter
3939 void avcodec_register_all(void);
3942 * Flush buffers, should be called when seeking or when switching to a different stream.
3944 void avcodec_flush_buffers(AVCodecContext *avctx);
3946 void avcodec_default_free_buffers(AVCodecContext *s);
3948 /* misc useful functions */
3950 #if FF_API_OLD_FF_PICT_TYPES
3952 * Return a single letter to describe the given picture type pict_type.
3954 * @param[in] pict_type the picture type
3955 * @return A single character representing the picture type.
3956 * @deprecated Use av_get_picture_type_char() instead.
3958 attribute_deprecated
3959 char av_get_pict_type_char(int pict_type);
3963 * Return codec bits per sample.
3965 * @param[in] codec_id the codec
3966 * @return Number of bits per sample or zero if unknown for the given codec.
3968 int av_get_bits_per_sample(enum CodecID codec_id);
3970 #if FF_API_OLD_SAMPLE_FMT
3972 * @deprecated Use av_get_bytes_per_sample() instead.
3974 attribute_deprecated
3975 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3979 typedef struct AVCodecParserContext {
3981 struct AVCodecParser *parser;
3982 int64_t frame_offset; /* offset of the current frame */
3983 int64_t cur_offset; /* current offset
3984 (incremented by each av_parser_parse()) */
3985 int64_t next_frame_offset; /* offset of the next frame */
3987 int pict_type; /* XXX: Put it back in AVCodecContext. */
3989 * This field is used for proper frame duration computation in lavf.
3990 * It signals, how much longer the frame duration of the current frame
3991 * is compared to normal frame duration.
3993 * frame_duration = (1 + repeat_pict) * time_base
3995 * It is used by codecs like H.264 to display telecined material.
3997 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3998 int64_t pts; /* pts of the current frame */
3999 int64_t dts; /* dts of the current frame */
4004 int fetch_timestamp;
4006 #define AV_PARSER_PTS_NB 4
4007 int cur_frame_start_index;
4008 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4009 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4010 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4013 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4014 #define PARSER_FLAG_ONCE 0x0002
4015 /// Set if the parser has a valid file offset
4016 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4018 int64_t offset; ///< byte offset from starting packet start
4019 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4022 * Set by parser to 1 for key frames and 0 for non-key frames.
4023 * It is initialized to -1, so if the parser doesn't set this flag,
4024 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4030 * Time difference in stream time base units from the pts of this
4031 * packet to the point at which the output from the decoder has converged
4032 * independent from the availability of previous frames. That is, the
4033 * frames are virtually identical no matter if decoding started from
4034 * the very first frame or from this keyframe.
4035 * Is AV_NOPTS_VALUE if unknown.
4036 * This field is not the display duration of the current frame.
4037 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4040 * The purpose of this field is to allow seeking in streams that have no
4041 * keyframes in the conventional sense. It corresponds to the
4042 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4043 * essential for some types of subtitle streams to ensure that all
4044 * subtitles are correctly displayed after seeking.
4046 int64_t convergence_duration;
4048 // Timestamp generation support:
4050 * Synchronization point for start of timestamp generation.
4052 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4055 * For example, this corresponds to presence of H.264 buffering period
4061 * Offset of the current timestamp against last timestamp sync point in
4062 * units of AVCodecContext.time_base.
4064 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4065 * contain a valid timestamp offset.
4067 * Note that the timestamp of sync point has usually a nonzero
4068 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4069 * the next frame after timestamp sync point will be usually 1.
4071 * For example, this corresponds to H.264 cpb_removal_delay.
4073 int dts_ref_dts_delta;
4076 * Presentation delay of current frame in units of AVCodecContext.time_base.
4078 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4079 * contain valid non-negative timestamp delta (presentation time of a frame
4080 * must not lie in the past).
4082 * This delay represents the difference between decoding and presentation
4083 * time of the frame.
4085 * For example, this corresponds to H.264 dpb_output_delay.
4090 * Position of the packet in file.
4092 * Analogous to cur_frame_pts/dts
4094 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4097 * Byte position of currently parsed frame in stream.
4102 * Previous frame byte position.
4105 } AVCodecParserContext;
4107 typedef struct AVCodecParser {
4108 int codec_ids[5]; /* several codec IDs are permitted */
4110 int (*parser_init)(AVCodecParserContext *s);
4111 int (*parser_parse)(AVCodecParserContext *s,
4112 AVCodecContext *avctx,
4113 const uint8_t **poutbuf, int *poutbuf_size,
4114 const uint8_t *buf, int buf_size);
4115 void (*parser_close)(AVCodecParserContext *s);
4116 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4117 struct AVCodecParser *next;
4120 AVCodecParser *av_parser_next(AVCodecParser *c);
4122 void av_register_codec_parser(AVCodecParser *parser);
4123 AVCodecParserContext *av_parser_init(int codec_id);
4128 * @param s parser context.
4129 * @param avctx codec context.
4130 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4131 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4132 * @param buf input buffer.
4133 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4134 * @param pts input presentation timestamp.
4135 * @param dts input decoding timestamp.
4136 * @param pos input byte position in stream.
4137 * @return the number of bytes of the input bitstream used.
4142 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4149 * decode_frame(data, size);
4153 int av_parser_parse2(AVCodecParserContext *s,
4154 AVCodecContext *avctx,
4155 uint8_t **poutbuf, int *poutbuf_size,
4156 const uint8_t *buf, int buf_size,
4157 int64_t pts, int64_t dts,
4160 int av_parser_change(AVCodecParserContext *s,
4161 AVCodecContext *avctx,
4162 uint8_t **poutbuf, int *poutbuf_size,
4163 const uint8_t *buf, int buf_size, int keyframe);
4164 void av_parser_close(AVCodecParserContext *s);
4167 typedef struct AVBitStreamFilterContext {
4169 struct AVBitStreamFilter *filter;
4170 AVCodecParserContext *parser;
4171 struct AVBitStreamFilterContext *next;
4172 } AVBitStreamFilterContext;
4175 typedef struct AVBitStreamFilter {
4178 int (*filter)(AVBitStreamFilterContext *bsfc,
4179 AVCodecContext *avctx, const char *args,
4180 uint8_t **poutbuf, int *poutbuf_size,
4181 const uint8_t *buf, int buf_size, int keyframe);
4182 void (*close)(AVBitStreamFilterContext *bsfc);
4183 struct AVBitStreamFilter *next;
4184 } AVBitStreamFilter;
4186 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4187 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4188 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4189 AVCodecContext *avctx, const char *args,
4190 uint8_t **poutbuf, int *poutbuf_size,
4191 const uint8_t *buf, int buf_size, int keyframe);
4192 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4194 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4199 * Reallocate the given block if it is not large enough, otherwise do nothing.
4203 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4206 * Allocate a buffer, reusing the given one if large enough.
4208 * Contrary to av_fast_realloc the current buffer contents might not be
4209 * preserved and on error the old buffer is freed, thus no special
4210 * handling to avoid memleaks is necessary.
4212 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4213 * @param size size of the buffer *ptr points to
4214 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4215 * *size 0 if an error occurred.
4217 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4220 * Copy image src to dst. Wraps av_picture_data_copy() above.
4222 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4223 enum PixelFormat pix_fmt, int width, int height);
4226 * Crop image top and left side.
4228 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4229 enum PixelFormat pix_fmt, int top_band, int left_band);
4234 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4235 int padtop, int padbottom, int padleft, int padright, int *color);
4238 * Encode extradata length to a buffer. Used by xiph codecs.
4240 * @param s buffer to write to; must be at least (v/255+1) bytes long
4241 * @param v size of extradata in bytes
4242 * @return number of bytes written to the buffer.
4244 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4247 * Logs a generic warning message about a missing feature. This function is
4248 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4249 * only, and would normally not be used by applications.
4250 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4251 * a pointer to an AVClass struct
4252 * @param[in] feature string containing the name of the missing feature
4253 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4254 * If want_sample is non-zero, additional verbage will be added to the log
4255 * message which tells the user how to report samples to the development
4258 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4261 * Log a generic warning message asking for a sample. This function is
4262 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4263 * only, and would normally not be used by applications.
4264 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4265 * a pointer to an AVClass struct
4266 * @param[in] msg string containing an optional message, or NULL if no message
4268 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4271 * Register the hardware accelerator hwaccel.
4273 void av_register_hwaccel(AVHWAccel *hwaccel);
4276 * If hwaccel is NULL, returns the first registered hardware accelerator,
4277 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4278 * after hwaccel, or NULL if hwaccel is the last one.
4280 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4284 * Lock operation used by lockmgr
4287 AV_LOCK_CREATE, ///< Create a mutex
4288 AV_LOCK_OBTAIN, ///< Lock the mutex
4289 AV_LOCK_RELEASE, ///< Unlock the mutex
4290 AV_LOCK_DESTROY, ///< Free mutex resources
4294 * Register a user provided lock manager supporting the operations
4295 * specified by AVLockOp. mutex points to a (void *) where the
4296 * lockmgr should store/get a pointer to a user allocated mutex. It's
4297 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4299 * @param cb User defined callback. Note: Libav may invoke calls to this
4300 * callback during the call to av_lockmgr_register().
4301 * Thus, the application must be prepared to handle that.
4302 * If cb is set to NULL the lockmgr will be unregistered.
4303 * Also note that during unregistration the previously registered
4304 * lockmgr callback may also be invoked.
4306 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4309 * Get the type of the given codec.
4311 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4314 * Get the AVClass for AVCodecContext. It can be used in combination with
4315 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4317 * @see av_opt_find().
4319 const AVClass *avcodec_get_class(void);
4321 #endif /* AVCODEC_AVCODEC_H */