2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
34 #include "libavcodec/version.h"
36 #if LIBAVCODEC_VERSION_MAJOR < 53
37 # define FF_INTERNALC_MEM_TYPE unsigned int
39 # define FF_INTERNALC_MEM_TYPE size_t
43 * Identify the syntax and semantics of the bitstream.
44 * The principle is roughly:
45 * Two decoders with the same ID can decode the same streams.
46 * Two encoders with the same ID can encode compatible streams.
47 * There may be slight deviations from the principle due to implementation
50 * If you add a codec ID to this list, add it so that
51 * 1. no value of a existing codec ID changes (that would break ABI),
52 * 2. it is as close as possible to similar codecs.
59 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
60 CODEC_ID_MPEG2VIDEO_XVMC,
97 CODEC_ID_INTERPLAY_VIDEO,
109 CODEC_ID_TRUEMOTION1,
120 #if LIBAVCODEC_VERSION_MAJOR < 53
139 CODEC_ID_TRUEMOTION2,
156 CODEC_ID_DSICINVIDEO,
157 CODEC_ID_TIERTEXSEQVIDEO,
166 CODEC_ID_BETHSOFTVID,
184 CODEC_ID_MOTIONPIXELS,
202 CODEC_ID_IFF_BYTERUN1,
217 /* various PCM "codecs" */
218 CODEC_ID_PCM_S16LE= 0x10000,
234 CODEC_ID_PCM_S24DAUD,
236 CODEC_ID_PCM_S16LE_PLANAR,
245 /* various ADPCM codecs */
246 CODEC_ID_ADPCM_IMA_QT= 0x11000,
247 CODEC_ID_ADPCM_IMA_WAV,
248 CODEC_ID_ADPCM_IMA_DK3,
249 CODEC_ID_ADPCM_IMA_DK4,
250 CODEC_ID_ADPCM_IMA_WS,
251 CODEC_ID_ADPCM_IMA_SMJPEG,
260 CODEC_ID_ADPCM_YAMAHA,
261 CODEC_ID_ADPCM_SBPRO_4,
262 CODEC_ID_ADPCM_SBPRO_3,
263 CODEC_ID_ADPCM_SBPRO_2,
265 CODEC_ID_ADPCM_IMA_AMV,
266 CODEC_ID_ADPCM_EA_R1,
267 CODEC_ID_ADPCM_EA_R3,
268 CODEC_ID_ADPCM_EA_R2,
269 CODEC_ID_ADPCM_IMA_EA_SEAD,
270 CODEC_ID_ADPCM_IMA_EA_EACS,
271 CODEC_ID_ADPCM_EA_XAS,
272 CODEC_ID_ADPCM_EA_MAXIS_XA,
273 CODEC_ID_ADPCM_IMA_ISS,
277 CODEC_ID_AMR_NB= 0x12000,
280 /* RealAudio codecs*/
281 CODEC_ID_RA_144= 0x13000,
284 /* various DPCM codecs */
285 CODEC_ID_ROQ_DPCM= 0x14000,
286 CODEC_ID_INTERPLAY_DPCM,
291 CODEC_ID_MP2= 0x15000,
292 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
310 CODEC_ID_WESTWOOD_SND1,
311 CODEC_ID_GSM, ///< as in Berlin toast format
319 CODEC_ID_DSICINAUDIO,
323 CODEC_ID_GSM_MS, /* as found in WAV */
332 CODEC_ID_WMALOSSLESS,
341 CODEC_ID_BINKAUDIO_RDFT,
342 CODEC_ID_BINKAUDIO_DCT,
346 /* 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,
358 /* other specific kind of codecs (generally used for attachments) */
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 LIBAVCODEC_VERSION_MAJOR < 53
369 #define CodecType AVMediaType
371 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
372 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
373 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
374 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
375 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
376 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
377 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
380 #if FF_API_OLD_SAMPLE_FMT
381 #define SampleFormat AVSampleFormat
383 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
384 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
385 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
386 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
387 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
388 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
389 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
392 #if FF_API_OLD_AUDIOCONVERT
393 #include "libavutil/audioconvert.h"
395 /* Audio channel masks */
396 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
397 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
398 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
399 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
400 #define CH_BACK_LEFT AV_CH_BACK_LEFT
401 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
402 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
403 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
404 #define CH_BACK_CENTER AV_CH_BACK_CENTER
405 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
406 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
407 #define CH_TOP_CENTER AV_CH_TOP_CENTER
408 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
409 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
410 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
411 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
412 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
413 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
414 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
415 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
417 /** Channel mask value used for AVCodecContext.request_channel_layout
418 to indicate that the user requests the channel order of the decoder output
419 to be the native codec channel order. */
420 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
422 /* Audio channel convenience macros */
423 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
424 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
425 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
426 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
427 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
428 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
429 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
430 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
431 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
432 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
433 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
434 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
435 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
436 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
437 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
441 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
444 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
445 * This is mainly needed because some optimized bitstream readers read
446 * 32 or 64 bit at once and could read over the end.<br>
447 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
448 * MPEG bitstreams could cause overread and segfault.
450 #define FF_INPUT_BUFFER_PADDING_SIZE 8
453 * minimum encoding buffer size
454 * Used to avoid some checks during header writing.
456 #define FF_MIN_BUFFER_SIZE 16384
460 * motion estimation type.
463 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
467 ME_EPZS, ///< enhanced predictive zonal search
468 ME_X1, ///< reserved for experiments
469 ME_HEX, ///< hexagon based search
470 ME_UMH, ///< uneven multi-hexagon search
471 ME_ITER, ///< iterative search
472 ME_TESA, ///< transformed exhaustive search algorithm
476 /* We leave some space between them for extensions (drop some
477 * keyframes for intra-only or drop just some bidir frames). */
478 AVDISCARD_NONE =-16, ///< discard nothing
479 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
480 AVDISCARD_NONREF = 8, ///< discard all non reference
481 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
482 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
483 AVDISCARD_ALL = 48, ///< discard all
486 enum AVColorPrimaries{
487 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
488 AVCOL_PRI_UNSPECIFIED=2,
490 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
491 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
492 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
494 AVCOL_PRI_NB , ///< Not part of ABI
497 enum AVColorTransferCharacteristic{
498 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
499 AVCOL_TRC_UNSPECIFIED=2,
500 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
501 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
502 AVCOL_TRC_NB , ///< Not part of ABI
507 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
508 AVCOL_SPC_UNSPECIFIED=2,
510 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
511 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
512 AVCOL_SPC_SMPTE240M =7,
513 AVCOL_SPC_NB , ///< Not part of ABI
517 AVCOL_RANGE_UNSPECIFIED=0,
518 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
519 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
520 AVCOL_RANGE_NB , ///< Not part of ABI
524 * X X 3 4 X X are luma samples,
525 * 1 2 1-6 are possible chroma positions
526 * X X 5 6 X 0 is undefined/unknown position
528 enum AVChromaLocation{
529 AVCHROMA_LOC_UNSPECIFIED=0,
530 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
531 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
532 AVCHROMA_LOC_TOPLEFT =3, ///< DV
534 AVCHROMA_LOC_BOTTOMLEFT =5,
535 AVCHROMA_LOC_BOTTOM =6,
536 AVCHROMA_LOC_NB , ///< Not part of ABI
543 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
544 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
545 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
546 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
547 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
548 AV_LPC_TYPE_NB , ///< Not part of ABI
551 enum AVAudioServiceType {
552 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
553 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
554 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
555 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
556 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
557 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
558 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
559 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
560 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
561 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
564 typedef struct RcOverride{
567 int qscale; // If this is 0 then quality_factor will be used instead.
568 float quality_factor;
571 #define FF_MAX_B_FRAMES 16
574 These flags can be passed in AVCodecContext.flags before initialization.
575 Note: Not everything is supported yet.
578 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
579 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
580 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
581 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
582 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
583 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
585 * The parent program guarantees that the input for B-frames containing
586 * streams is not written to for at least s->max_b_frames+1 frames, if
587 * this is not set the input will be copied.
589 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
590 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
591 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
592 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
593 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
594 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
595 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
596 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
597 location instead of only at frame boundaries. */
598 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
599 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
600 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
601 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
602 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
603 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
604 /* Fx : Flag for h263+ extra options */
605 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
606 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
607 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
608 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
609 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
610 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
611 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
612 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
613 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
614 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
615 #define CODEC_FLAG_CLOSED_GOP 0x80000000
616 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
617 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
618 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
619 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
620 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
621 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
622 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
623 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
624 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
625 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
626 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
627 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
628 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
629 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
630 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
631 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
632 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
633 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
634 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
635 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
636 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
637 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
639 /* Unsupported options :
640 * Syntax Arithmetic coding (SAC)
641 * Reference Picture Selection
642 * Independent Segment Decoding */
644 /* codec capabilities */
646 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
648 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
649 * If not set, it might not use get_buffer() at all or use operations that
650 * assume the buffer was allocated by avcodec_default_get_buffer.
652 #define CODEC_CAP_DR1 0x0002
653 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
654 #define CODEC_CAP_PARSE_ONLY 0x0004
655 #define CODEC_CAP_TRUNCATED 0x0008
656 /* Codec can export data for HW decoding (XvMC). */
657 #define CODEC_CAP_HWACCEL 0x0010
659 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
660 * If this is not set, the codec is guaranteed to never be fed with NULL data.
662 #define CODEC_CAP_DELAY 0x0020
664 * Codec can be fed a final frame with a smaller size.
665 * This can be used to prevent truncation of the last audio samples.
667 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
669 * Codec can export data for HW decoding (VDPAU).
671 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
673 * Codec can output multiple frames per AVPacket
674 * Normally demuxers return one frame at a time, demuxers which do not do
675 * are connected to a parser to split what they return into proper frames.
676 * This flag is reserved to the very rare category of codecs which have a
677 * bitstream that cannot be split into frames without timeconsuming
678 * operations like full decoding. Demuxers carring such bitstreams thus
679 * may return multiple frames in a packet. This has many disadvantages like
680 * prohibiting stream copy in many cases thus it should only be considered
683 #define CODEC_CAP_SUBFRAMES 0x0100
685 * Codec is experimental and is thus avoided in favor of non experimental
688 #define CODEC_CAP_EXPERIMENTAL 0x0200
690 * Codec should fill in channel configuration and samplerate instead of container
692 #define CODEC_CAP_CHANNEL_CONF 0x0400
695 * Codec is able to deal with negative linesizes
697 #define CODEC_CAP_NEG_LINESIZES 0x0800
700 * Codec supports frame-level multithreading.
702 #define CODEC_CAP_FRAME_THREADS 0x1000
704 //The following defines may change, don't expect compatibility if you use them.
705 #define MB_TYPE_INTRA4x4 0x0001
706 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
707 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
708 #define MB_TYPE_16x16 0x0008
709 #define MB_TYPE_16x8 0x0010
710 #define MB_TYPE_8x16 0x0020
711 #define MB_TYPE_8x8 0x0040
712 #define MB_TYPE_INTERLACED 0x0080
713 #define MB_TYPE_DIRECT2 0x0100 //FIXME
714 #define MB_TYPE_ACPRED 0x0200
715 #define MB_TYPE_GMC 0x0400
716 #define MB_TYPE_SKIP 0x0800
717 #define MB_TYPE_P0L0 0x1000
718 #define MB_TYPE_P1L0 0x2000
719 #define MB_TYPE_P0L1 0x4000
720 #define MB_TYPE_P1L1 0x8000
721 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
722 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
723 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
724 #define MB_TYPE_QUANT 0x00010000
725 #define MB_TYPE_CBP 0x00020000
726 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
730 * This specifies the area which should be displayed.
731 * Note there may be multiple such areas for one frame.
733 typedef struct AVPanScan{
736 * - encoding: Set by user.
737 * - decoding: Set by libavcodec.
742 * width and height in 1/16 pel
743 * - encoding: Set by user.
744 * - decoding: Set by libavcodec.
750 * position of the top left corner in 1/16 pel for up to 3 fields/frames
751 * - encoding: Set by user.
752 * - decoding: Set by libavcodec.
754 int16_t position[3][2];
757 #define FF_COMMON_FRAME \
759 * pointer to the picture planes.\
760 * This might be different from the first allocated byte\
767 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
768 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
774 * 1 -> keyframe, 0-> not\
775 * - encoding: Set by libavcodec.\
776 * - decoding: Set by libavcodec.\
781 * Picture type of the frame, see ?_TYPE below.\
782 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
783 * - decoding: Set by libavcodec.\
788 * presentation timestamp in time_base units (time when frame should be shown to user)\
789 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
790 * - encoding: MUST be set by user.\
791 * - decoding: Set by libavcodec.\
796 * picture number in bitstream order\
797 * - encoding: set by\
798 * - decoding: Set by libavcodec.\
800 int coded_picture_number;\
802 * picture number in display order\
803 * - encoding: set by\
804 * - decoding: Set by libavcodec.\
806 int display_picture_number;\
809 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
810 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
811 * - decoding: Set by libavcodec.\
816 * buffer age (1->was last buffer and dint change, 2->..., ...).\
817 * Set to INT_MAX if the buffer has not been used yet.\
818 * - encoding: unused\
819 * - decoding: MUST be set by get_buffer().\
824 * is this picture used as reference\
825 * The values for this are the same as the MpegEncContext.picture_structure\
826 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
827 * Set to 4 for delayed, non-reference frames.\
828 * - encoding: unused\
829 * - decoding: Set by libavcodec. (before get_buffer() call)).\
835 * - encoding: unused\
836 * - decoding: Set by libavcodec.\
838 int8_t *qscale_table;\
841 * - encoding: unused\
842 * - decoding: Set by libavcodec.\
847 * mbskip_table[mb]>=1 if MB didn't change\
848 * stride= mb_width = (width+15)>>4\
849 * - encoding: unused\
850 * - decoding: Set by libavcodec.\
852 uint8_t *mbskip_table;\
855 * motion vector table\
858 * int mv_sample_log2= 4 - motion_subsample_log2;\
859 * int mb_width= (width+15)>>4;\
860 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
861 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
863 * - encoding: Set by user.\
864 * - decoding: Set by libavcodec.\
866 int16_t (*motion_val[2])[2];\
869 * macroblock type table\
870 * mb_type_base + mb_width + 2\
871 * - encoding: Set by user.\
872 * - decoding: Set by libavcodec.\
877 * log2 of the size of the block which a single vector in motion_val represents: \
878 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
879 * - encoding: unused\
880 * - decoding: Set by libavcodec.\
882 uint8_t motion_subsample_log2;\
885 * for some private data of the user\
886 * - encoding: unused\
887 * - decoding: Set by user.\
893 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
894 * - decoding: unused\
899 * type of the buffer (to keep track of who has to deallocate data[*])\
900 * - encoding: Set by the one who allocates it.\
901 * - decoding: Set by the one who allocates it.\
902 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
907 * When decoding, this signals how much the picture must be delayed.\
908 * extra_delay = repeat_pict / (2*fps)\
909 * - encoding: unused\
910 * - decoding: Set by libavcodec.\
920 * The content of the picture is interlaced.\
921 * - encoding: Set by user.\
922 * - decoding: Set by libavcodec. (default 0)\
924 int interlaced_frame;\
927 * If the content is interlaced, is top field displayed first.\
928 * - encoding: Set by user.\
929 * - decoding: Set by libavcodec.\
931 int top_field_first;\
935 * - encoding: Set by user.\
936 * - decoding: Set by libavcodec.\
938 AVPanScan *pan_scan;\
941 * Tell user application that palette has changed from previous frame.\
942 * - encoding: ??? (no palette-enabled encoder yet)\
943 * - decoding: Set by libavcodec. (default 0).\
945 int palette_has_changed;\
948 * codec suggestion on buffer type if != 0\
949 * - encoding: unused\
950 * - decoding: Set by libavcodec. (before get_buffer() call)).\
956 * - encoding: unused\
957 * - decoding: Set by libavcodec.\
962 * motion reference frame index\
963 * the order in which these are stored can depend on the codec.\
964 * - encoding: Set by user.\
965 * - decoding: Set by libavcodec.\
967 int8_t *ref_index[2];\
970 * reordered opaque 64bit (generally an integer or a double precision float\
971 * PTS but can be anything). \
972 * The user sets AVCodecContext.reordered_opaque to represent the input at\
974 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
975 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
976 * @deprecated in favor of pkt_pts\
977 * - encoding: unused\
978 * - decoding: Read by user.\
980 int64_t reordered_opaque;\
983 * hardware accelerator private data (FFmpeg allocated)\
984 * - encoding: unused\
985 * - decoding: Set by libavcodec\
987 void *hwaccel_picture_private;\
990 * reordered pts from the last AVPacket that has been input into the decoder\
991 * - encoding: unused\
992 * - decoding: Read by user.\
997 * dts from the last AVPacket that has been input into the decoder\
998 * - encoding: unused\
999 * - decoding: Read by user.\
1004 * the AVCodecContext which ff_thread_get_buffer() was last called on\
1005 * - encoding: Set by libavcodec.\
1006 * - decoding: Set by libavcodec.\
1008 struct AVCodecContext *owner;\
1011 * used by multithreading to store frame-specific info\
1012 * - encoding: Set by libavcodec.\
1013 * - decoding: Set by libavcodec.\
1015 void *thread_opaque;\
1018 * frame timestamp estimated using various heuristics, in stream time base\
1019 * - encoding: unused\
1020 * - decoding: set by libavcodec, read by user.\
1022 int64_t best_effort_timestamp;\
1025 #define FF_QSCALE_TYPE_MPEG1 0
1026 #define FF_QSCALE_TYPE_MPEG2 1
1027 #define FF_QSCALE_TYPE_H264 2
1028 #define FF_QSCALE_TYPE_VP56 3
1030 #define FF_BUFFER_TYPE_INTERNAL 1
1031 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1032 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1033 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1036 #define FF_I_TYPE 1 ///< Intra
1037 #define FF_P_TYPE 2 ///< Predicted
1038 #define FF_B_TYPE 3 ///< Bi-dir predicted
1039 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1040 #define FF_SI_TYPE 5 ///< Switching Intra
1041 #define FF_SP_TYPE 6 ///< Switching Predicted
1042 #define FF_BI_TYPE 7
1044 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1045 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1046 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1047 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1049 typedef struct AVPacket {
1051 * Presentation timestamp in AVStream->time_base units; the time at which
1052 * the decompressed packet will be presented to the user.
1053 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1054 * pts MUST be larger or equal to dts as presentation cannot happen before
1055 * decompression, unless one wants to view hex dumps. Some formats misuse
1056 * the terms dts and pts/cts to mean something different. Such timestamps
1057 * must be converted to true pts/dts before they are stored in AVPacket.
1061 * Decompression timestamp in AVStream->time_base units; the time at which
1062 * the packet is decompressed.
1063 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1071 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1072 * Equals next_pts - this_pts in presentation order.
1075 void (*destruct)(struct AVPacket *);
1077 int64_t pos; ///< byte position in stream, -1 if unknown
1080 * Time difference in AVStream->time_base units from the pts of this
1081 * packet to the point at which the output from the decoder has converged
1082 * independent from the availability of previous frames. That is, the
1083 * frames are virtually identical no matter if decoding started from
1084 * the very first frame or from this keyframe.
1085 * Is AV_NOPTS_VALUE if unknown.
1086 * This field is not the display duration of the current packet.
1087 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1090 * The purpose of this field is to allow seeking in streams that have no
1091 * keyframes in the conventional sense. It corresponds to the
1092 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1093 * essential for some types of subtitle streams to ensure that all
1094 * subtitles are correctly displayed after seeking.
1096 int64_t convergence_duration;
1098 #define AV_PKT_FLAG_KEY 0x0001
1099 #if LIBAVCODEC_VERSION_MAJOR < 53
1100 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1104 * Audio Video Frame.
1105 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1107 * Removal, reordering and changes to existing fields require a major
1108 * version bump. No fields should be added into AVFrame before or after
1110 * sizeof(AVFrame) must not be used outside libav*.
1112 typedef struct AVFrame {
1117 * main external API structure.
1118 * New fields can be added to the end with minor version bumps.
1119 * Removal, reordering and changes to existing fields require a major
1121 * sizeof(AVCodecContext) must not be used outside libav*.
1123 typedef struct AVCodecContext {
1125 * information on struct for av_log
1126 * - set by avcodec_alloc_context
1128 const AVClass *av_class;
1130 * the average bitrate
1131 * - encoding: Set by user; unused for constant quantizer encoding.
1132 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1137 * number of bits the bitstream is allowed to diverge from the reference.
1138 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1139 * - encoding: Set by user; unused for constant quantizer encoding.
1140 * - decoding: unused
1142 int bit_rate_tolerance;
1146 * - encoding: Set by user.
1147 * - decoding: Set by user.
1152 * Some codecs need additional format info. It is stored here.
1153 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1154 * specific codec MUST set it correctly otherwise stream copy breaks.
1155 * In general use of this field by muxers is not recommanded.
1156 * - encoding: Set by libavcodec.
1157 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1162 * Motion estimation algorithm used for video coding.
1163 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1164 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1165 * - encoding: MUST be set by user.
1166 * - decoding: unused
1171 * some codecs need / can use extradata like Huffman tables.
1172 * mjpeg: Huffman tables
1173 * rv10: additional flags
1174 * mpeg4: global headers (they can be in the bitstream or here)
1175 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1176 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1177 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1178 * - encoding: Set/allocated/freed by libavcodec.
1179 * - decoding: Set/allocated/freed by user.
1185 * This is the fundamental unit of time (in seconds) in terms
1186 * of which frame timestamps are represented. For fixed-fps content,
1187 * timebase should be 1/framerate and timestamp increments should be
1189 * - encoding: MUST be set by user.
1190 * - decoding: Set by libavcodec.
1192 AVRational time_base;
1196 * picture width / height.
1197 * - encoding: MUST be set by user.
1198 * - decoding: Set by libavcodec.
1199 * Note: For compatibility it is possible to set this instead of
1200 * coded_width/height before decoding.
1204 #define FF_ASPECT_EXTENDED 15
1207 * the number of pictures in a group of pictures, or 0 for intra_only
1208 * - encoding: Set by user.
1209 * - decoding: unused
1214 * Pixel format, see PIX_FMT_xxx.
1215 * May be set by the demuxer if known from headers.
1216 * May be overriden by the decoder if it knows better.
1217 * - encoding: Set by user.
1218 * - decoding: Set by user if known, overridden by libavcodec if known
1220 enum PixelFormat pix_fmt;
1224 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1225 * has to read frames at native frame rate.
1226 * - encoding: Set by user.
1227 * - decoding: unused
1229 attribute_deprecated int rate_emu;
1233 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1234 * decoder to draw a horizontal band. It improves cache usage. Not
1235 * all codecs can do that. You must check the codec capabilities
1237 * When multithreading is used, it may be called from multiple threads
1238 * at the same time; threads might draw different parts of the same AVFrame,
1239 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1241 * The function is also used by hardware acceleration APIs.
1242 * It is called at least once during frame decoding to pass
1243 * the data needed for hardware render.
1244 * In that mode instead of pixel data, AVFrame points to
1245 * a structure specific to the acceleration API. The application
1246 * reads the structure and can change some fields to indicate progress
1248 * - encoding: unused
1249 * - decoding: Set by user.
1250 * @param height the height of the slice
1251 * @param y the y position of the slice
1252 * @param type 1->top field, 2->bottom field, 3->frame
1253 * @param offset offset into the AVFrame.data from which the slice should be read
1255 void (*draw_horiz_band)(struct AVCodecContext *s,
1256 const AVFrame *src, int offset[4],
1257 int y, int type, int height);
1260 int sample_rate; ///< samples per second
1261 int channels; ///< number of audio channels
1264 * audio sample format
1265 * - encoding: Set by user.
1266 * - decoding: Set by libavcodec.
1268 enum AVSampleFormat sample_fmt; ///< sample format
1270 /* The following data should not be initialized. */
1272 * Samples per packet, initialized when calling 'init'.
1275 int frame_number; ///< audio or video frame number
1276 #if LIBAVCODEC_VERSION_MAJOR < 53
1277 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1281 * Number of frames the decoded output will be delayed relative to
1282 * the encoded input.
1283 * - encoding: Set by libavcodec.
1284 * - decoding: unused
1288 /* - encoding parameters */
1289 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1290 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1294 * - encoding: Set by user.
1295 * - decoding: unused
1301 * - encoding: Set by user.
1302 * - decoding: unused
1307 * maximum quantizer difference between frames
1308 * - encoding: Set by user.
1309 * - decoding: unused
1314 * maximum number of B-frames between non-B-frames
1315 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1316 * - encoding: Set by user.
1317 * - decoding: unused
1322 * qscale factor between IP and B-frames
1323 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1324 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 float b_quant_factor;
1330 /** obsolete FIXME remove */
1332 #define FF_RC_STRATEGY_XVID 1
1334 int b_frame_strategy;
1339 * - encoding: unused
1340 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1341 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1343 attribute_deprecated int hurry_up;
1346 struct AVCodec *codec;
1350 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1351 /* do its best to deliver a chunk with size */
1352 /* below rtp_payload_size, the chunk will start */
1353 /* with a start code on some codecs like H.263. */
1354 /* This doesn't take account of any particular */
1355 /* headers inside the transmitted RTP payload. */
1358 /* The RTP callback: This function is called */
1359 /* every time the encoder has a packet to send. */
1360 /* It depends on the encoder if the data starts */
1361 /* with a Start Code (it should). H.263 does. */
1362 /* mb_nb contains the number of macroblocks */
1363 /* encoded in the RTP payload. */
1364 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1366 /* statistics, used for 2-pass encoding */
1377 * number of bits used for the previously encoded frame
1378 * - encoding: Set by libavcodec.
1379 * - decoding: unused
1384 * Private data of the user, can be used to carry app specific stuff.
1385 * - encoding: Set by user.
1386 * - decoding: Set by user.
1390 char codec_name[32];
1391 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1392 enum CodecID codec_id; /* see CODEC_ID_xxx */
1395 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1396 * This is used to work around some encoder bugs.
1397 * A demuxer should set this to what is stored in the field used to identify the codec.
1398 * If there are multiple such fields in a container then the demuxer should choose the one
1399 * which maximizes the information about the used codec.
1400 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1401 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1402 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1404 * - encoding: Set by user, if not then the default based on codec_id will be used.
1405 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1407 unsigned int codec_tag;
1410 * Work around bugs in encoders which sometimes cannot be detected automatically.
1411 * - encoding: Set by user
1412 * - decoding: Set by user
1414 int workaround_bugs;
1415 #define FF_BUG_AUTODETECT 1 ///< autodetection
1416 #define FF_BUG_OLD_MSMPEG4 2
1417 #define FF_BUG_XVID_ILACE 4
1418 #define FF_BUG_UMP4 8
1419 #define FF_BUG_NO_PADDING 16
1420 #define FF_BUG_AMV 32
1421 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1422 #define FF_BUG_QPEL_CHROMA 64
1423 #define FF_BUG_STD_QPEL 128
1424 #define FF_BUG_QPEL_CHROMA2 256
1425 #define FF_BUG_DIRECT_BLOCKSIZE 512
1426 #define FF_BUG_EDGE 1024
1427 #define FF_BUG_HPEL_CHROMA 2048
1428 #define FF_BUG_DC_CLIP 4096
1429 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1430 #define FF_BUG_TRUNCATED 16384
1431 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1434 * luma single coefficient elimination threshold
1435 * - encoding: Set by user.
1436 * - decoding: unused
1438 int luma_elim_threshold;
1441 * chroma single coeff elimination threshold
1442 * - encoding: Set by user.
1443 * - decoding: unused
1445 int chroma_elim_threshold;
1448 * strictly follow the standard (MPEG4, ...).
1449 * - encoding: Set by user.
1450 * - decoding: Set by user.
1451 * Setting this to STRICT or higher means the encoder and decoder will
1452 * generally do stupid things, whereas setting it to unofficial or lower
1453 * will mean the encoder might produce output that is not supported by all
1454 * spec-compliant decoders. Decoders don't differentiate between normal,
1455 * unofficial and experimental (that is, they always try to decode things
1456 * when they can) unless they are explicitly asked to behave stupidly
1457 * (=strictly conform to the specs)
1459 int strict_std_compliance;
1460 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1461 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1462 #define FF_COMPLIANCE_NORMAL 0
1463 #if FF_API_INOFFICIAL
1464 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1466 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1467 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1470 * qscale offset between IP and B-frames
1471 * - encoding: Set by user.
1472 * - decoding: unused
1474 float b_quant_offset;
1477 * Error recognization; higher values will detect more errors but may
1478 * misdetect some more or less valid parts as errors.
1479 * - encoding: unused
1480 * - decoding: Set by user.
1482 int error_recognition;
1483 #define FF_ER_CAREFUL 1
1484 #define FF_ER_COMPLIANT 2
1485 #define FF_ER_AGGRESSIVE 3
1486 #define FF_ER_VERY_AGGRESSIVE 4
1489 * Called at the beginning of each frame to get a buffer for it.
1490 * If pic.reference is set then the frame will be read later by libavcodec.
1491 * avcodec_align_dimensions2() should be used to find the required width and
1492 * height, as they normally need to be rounded up to the next multiple of 16.
1493 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1494 * avcodec_default_get_buffer() instead of providing buffers allocated by
1496 * If frame multithreading is used and thread_safe_callbacks is set,
1497 * it may be called from a different thread, but not from more than one at once.
1498 * Does not need to be reentrant.
1499 * - encoding: unused
1500 * - decoding: Set by libavcodec, user can override.
1502 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1505 * Called to release buffers which were allocated with get_buffer.
1506 * A released buffer can be reused in get_buffer().
1507 * pic.data[*] must be set to NULL.
1508 * May be called from a different thread if frame multithreading is used,
1509 * but not by more than one thread at once, so does not need to be reentrant.
1510 * - encoding: unused
1511 * - decoding: Set by libavcodec, user can override.
1513 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1516 * Size of the frame reordering buffer in the decoder.
1517 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1518 * - encoding: Set by libavcodec.
1519 * - decoding: Set by libavcodec.
1524 * number of bytes per packet if constant and known or 0
1525 * Used by some WAV based audio codecs.
1529 int parse_only; /* - decoding only: If true, only parsing is done
1530 (function avcodec_parse_frame()). The frame
1531 data is returned. Only MPEG codecs support this now. */
1534 * 0-> h263 quant 1-> mpeg quant
1535 * - encoding: Set by user.
1536 * - decoding: unused
1541 * pass1 encoding statistics output buffer
1542 * - encoding: Set by libavcodec.
1543 * - decoding: unused
1548 * pass2 encoding statistics input buffer
1549 * Concatenated stuff from stats_out of pass1 should be placed here.
1550 * - encoding: Allocated/set/freed by user.
1551 * - decoding: unused
1556 * ratecontrol qmin qmax limiting method
1557 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1558 * - encoding: Set by user.
1559 * - decoding: unused
1567 * ratecontrol override, see RcOverride
1568 * - encoding: Allocated/set/freed by user.
1569 * - decoding: unused
1571 RcOverride *rc_override;
1572 int rc_override_count;
1575 * rate control equation
1576 * - encoding: Set by user
1577 * - decoding: unused
1583 * - encoding: Set by user.
1584 * - decoding: unused
1590 * - encoding: Set by user.
1591 * - decoding: unused
1596 * decoder bitstream buffer size
1597 * - encoding: Set by user.
1598 * - decoding: unused
1601 float rc_buffer_aggressivity;
1604 * qscale factor between P and I-frames
1605 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1606 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 float i_quant_factor;
1613 * qscale offset between P and I-frames
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 float i_quant_offset;
1620 * initial complexity for pass1 ratecontrol
1621 * - encoding: Set by user.
1622 * - decoding: unused
1624 float rc_initial_cplx;
1627 * DCT algorithm, see FF_DCT_* below
1628 * - encoding: Set by user.
1629 * - decoding: unused
1632 #define FF_DCT_AUTO 0
1633 #define FF_DCT_FASTINT 1
1634 #define FF_DCT_INT 2
1635 #define FF_DCT_MMX 3
1636 #define FF_DCT_MLIB 4
1637 #define FF_DCT_ALTIVEC 5
1638 #define FF_DCT_FAAN 6
1641 * luminance masking (0-> disabled)
1642 * - encoding: Set by user.
1643 * - decoding: unused
1648 * temporary complexity masking (0-> disabled)
1649 * - encoding: Set by user.
1650 * - decoding: unused
1652 float temporal_cplx_masking;
1655 * spatial complexity masking (0-> disabled)
1656 * - encoding: Set by user.
1657 * - decoding: unused
1659 float spatial_cplx_masking;
1662 * p block masking (0-> disabled)
1663 * - encoding: Set by user.
1664 * - decoding: unused
1669 * darkness masking (0-> disabled)
1670 * - encoding: Set by user.
1671 * - decoding: unused
1676 * IDCT algorithm, see FF_IDCT_* below.
1677 * - encoding: Set by user.
1678 * - decoding: Set by user.
1681 #define FF_IDCT_AUTO 0
1682 #define FF_IDCT_INT 1
1683 #define FF_IDCT_SIMPLE 2
1684 #define FF_IDCT_SIMPLEMMX 3
1685 #define FF_IDCT_LIBMPEG2MMX 4
1686 #define FF_IDCT_PS2 5
1687 #define FF_IDCT_MLIB 6
1688 #define FF_IDCT_ARM 7
1689 #define FF_IDCT_ALTIVEC 8
1690 #define FF_IDCT_SH4 9
1691 #define FF_IDCT_SIMPLEARM 10
1692 #define FF_IDCT_H264 11
1693 #define FF_IDCT_VP3 12
1694 #define FF_IDCT_IPP 13
1695 #define FF_IDCT_XVIDMMX 14
1696 #define FF_IDCT_CAVS 15
1697 #define FF_IDCT_SIMPLEARMV5TE 16
1698 #define FF_IDCT_SIMPLEARMV6 17
1699 #define FF_IDCT_SIMPLEVIS 18
1700 #define FF_IDCT_WMV2 19
1701 #define FF_IDCT_FAAN 20
1702 #define FF_IDCT_EA 21
1703 #define FF_IDCT_SIMPLENEON 22
1704 #define FF_IDCT_SIMPLEALPHA 23
1705 #define FF_IDCT_BINK 24
1709 * - encoding: Set by libavcodec.
1710 * - decoding: Set by user (or 0).
1714 * slice offsets in the frame in bytes
1715 * - encoding: Set/allocated by libavcodec.
1716 * - decoding: Set/allocated by user (or NULL).
1721 * error concealment flags
1722 * - encoding: unused
1723 * - decoding: Set by user.
1725 int error_concealment;
1726 #define FF_EC_GUESS_MVS 1
1727 #define FF_EC_DEBLOCK 2
1730 * dsp_mask could be add used to disable unwanted CPU features
1731 * CPU features (i.e. MMX, SSE. ...)
1733 * With the FORCE flag you may instead enable given CPU features.
1734 * (Dangerous: Usable in case of misdetection, improper usage however will
1735 * result into program crash.)
1740 #define FF_MM_FORCE AV_CPU_FLAG_FORCE
1741 #define FF_MM_MMX AV_CPU_FLAG_MMX
1742 #define FF_MM_3DNOW AV_CPU_FLAG_3DNOW
1743 #define FF_MM_MMXEXT AV_CPU_FLAG_MMX2
1744 #define FF_MM_MMX2 AV_CPU_FLAG_MMX2
1745 #define FF_MM_SSE AV_CPU_FLAG_SSE
1746 #define FF_MM_SSE2 AV_CPU_FLAG_SSE2
1747 #define FF_MM_SSE2SLOW AV_CPU_FLAG_SSE2SLOW
1748 #define FF_MM_3DNOWEXT AV_CPU_FLAG_3DNOWEXT
1749 #define FF_MM_SSE3 AV_CPU_FLAG_SSE3
1750 #define FF_MM_SSE3SLOW AV_CPU_FLAG_SSE3SLOW
1751 #define FF_MM_SSSE3 AV_CPU_FLAG_SSSE3
1752 #define FF_MM_SSE4 AV_CPU_FLAG_SSE4
1753 #define FF_MM_SSE42 AV_CPU_FLAG_SSE42
1754 #define FF_MM_IWMMXT AV_CPU_FLAG_IWMMXT
1755 #define FF_MM_ALTIVEC AV_CPU_FLAG_ALTIVEC
1759 * bits per sample/pixel from the demuxer (needed for huffyuv).
1760 * - encoding: Set by libavcodec.
1761 * - decoding: Set by user.
1763 int bits_per_coded_sample;
1766 * prediction method (needed for huffyuv)
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 int prediction_method;
1771 #define FF_PRED_LEFT 0
1772 #define FF_PRED_PLANE 1
1773 #define FF_PRED_MEDIAN 2
1776 * sample aspect ratio (0 if unknown)
1777 * That is the width of a pixel divided by the height of the pixel.
1778 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1779 * - encoding: Set by user.
1780 * - decoding: Set by libavcodec.
1782 AVRational sample_aspect_ratio;
1785 * the picture in the bitstream
1786 * - encoding: Set by libavcodec.
1787 * - decoding: Set by libavcodec.
1789 AVFrame *coded_frame;
1793 * - encoding: Set by user.
1794 * - decoding: Set by user.
1797 #define FF_DEBUG_PICT_INFO 1
1798 #define FF_DEBUG_RC 2
1799 #define FF_DEBUG_BITSTREAM 4
1800 #define FF_DEBUG_MB_TYPE 8
1801 #define FF_DEBUG_QP 16
1802 #define FF_DEBUG_MV 32
1803 #define FF_DEBUG_DCT_COEFF 0x00000040
1804 #define FF_DEBUG_SKIP 0x00000080
1805 #define FF_DEBUG_STARTCODE 0x00000100
1806 #define FF_DEBUG_PTS 0x00000200
1807 #define FF_DEBUG_ER 0x00000400
1808 #define FF_DEBUG_MMCO 0x00000800
1809 #define FF_DEBUG_BUGS 0x00001000
1810 #define FF_DEBUG_VIS_QP 0x00002000
1811 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1812 #define FF_DEBUG_BUFFERS 0x00008000
1813 #define FF_DEBUG_THREADS 0x00010000
1817 * - encoding: Set by user.
1818 * - decoding: Set by user.
1821 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1822 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1823 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1827 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1828 * - decoding: unused
1834 * minimum MB quantizer
1835 * - encoding: unused
1836 * - decoding: unused
1838 attribute_deprecated int mb_qmin;
1841 * maximum MB quantizer
1842 * - encoding: unused
1843 * - decoding: unused
1845 attribute_deprecated int mb_qmax;
1849 * motion estimation comparison function
1850 * - encoding: Set by user.
1851 * - decoding: unused
1855 * subpixel motion estimation comparison function
1856 * - encoding: Set by user.
1857 * - decoding: unused
1861 * macroblock comparison function (not supported yet)
1862 * - encoding: Set by user.
1863 * - decoding: unused
1867 * interlaced DCT comparison function
1868 * - encoding: Set by user.
1869 * - decoding: unused
1872 #define FF_CMP_SAD 0
1873 #define FF_CMP_SSE 1
1874 #define FF_CMP_SATD 2
1875 #define FF_CMP_DCT 3
1876 #define FF_CMP_PSNR 4
1877 #define FF_CMP_BIT 5
1879 #define FF_CMP_ZERO 7
1880 #define FF_CMP_VSAD 8
1881 #define FF_CMP_VSSE 9
1882 #define FF_CMP_NSSE 10
1883 #define FF_CMP_W53 11
1884 #define FF_CMP_W97 12
1885 #define FF_CMP_DCTMAX 13
1886 #define FF_CMP_DCT264 14
1887 #define FF_CMP_CHROMA 256
1890 * ME diamond size & shape
1891 * - encoding: Set by user.
1892 * - decoding: unused
1897 * amount of previous MV predictors (2a+1 x 2a+1 square)
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 int last_predictor_count;
1904 * prepass for motion estimation
1905 * - encoding: Set by user.
1906 * - decoding: unused
1911 * motion estimation prepass comparison function
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * ME prepass diamond size & shape
1919 * - encoding: Set by user.
1920 * - decoding: unused
1926 * - encoding: Set by user.
1927 * - decoding: unused
1929 int me_subpel_quality;
1932 * callback to negotiate the pixelFormat
1933 * @param fmt is the list of formats which are supported by the codec,
1934 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1935 * The first is always the native one.
1936 * @return the chosen format
1937 * - encoding: unused
1938 * - decoding: Set by user, if not set the native format will be chosen.
1940 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1943 * DTG active format information (additional aspect ratio
1944 * information only used in DVB MPEG-2 transport streams)
1947 * - encoding: unused
1948 * - decoding: Set by decoder.
1950 int dtg_active_format;
1951 #define FF_DTG_AFD_SAME 8
1952 #define FF_DTG_AFD_4_3 9
1953 #define FF_DTG_AFD_16_9 10
1954 #define FF_DTG_AFD_14_9 11
1955 #define FF_DTG_AFD_4_3_SP_14_9 13
1956 #define FF_DTG_AFD_16_9_SP_14_9 14
1957 #define FF_DTG_AFD_SP_4_3 15
1960 * maximum motion estimation search range in subpel units
1961 * If 0 then no limit.
1963 * - encoding: Set by user.
1964 * - decoding: unused
1969 * intra quantizer bias
1970 * - encoding: Set by user.
1971 * - decoding: unused
1973 int intra_quant_bias;
1974 #define FF_DEFAULT_QUANT_BIAS 999999
1977 * inter quantizer bias
1978 * - encoding: Set by user.
1979 * - decoding: unused
1981 int inter_quant_bias;
1985 * - encoding: unused
1986 * - decoding: Which clrtable should be used for 8bit RGB images.
1987 * Tables have to be stored somewhere. FIXME
1992 * internal_buffer count
1993 * Don't touch, used by libavcodec default_get_buffer().
1995 int internal_buffer_count;
1999 * Don't touch, used by libavcodec default_get_buffer().
2001 void *internal_buffer;
2004 * Global quality for codecs which cannot change it per frame.
2005 * This should be proportional to MPEG-1/2/4 qscale.
2006 * - encoding: Set by user.
2007 * - decoding: unused
2011 #define FF_CODER_TYPE_VLC 0
2012 #define FF_CODER_TYPE_AC 1
2013 #define FF_CODER_TYPE_RAW 2
2014 #define FF_CODER_TYPE_RLE 3
2015 #define FF_CODER_TYPE_DEFLATE 4
2018 * - encoding: Set by user.
2019 * - decoding: unused
2025 * - encoding: Set by user.
2026 * - decoding: unused
2032 * - encoding: unused
2033 * - decoding: Set by user.
2035 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2040 * - encoding: unused
2041 * - decoding: Set by user.
2044 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2045 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2046 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2049 * XVideo Motion Acceleration
2050 * - encoding: forbidden
2051 * - decoding: set by decoder
2053 int xvmc_acceleration;
2056 * macroblock decision mode
2057 * - encoding: Set by user.
2058 * - decoding: unused
2061 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2062 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2063 #define FF_MB_DECISION_RD 2 ///< rate distortion
2066 * custom intra quantization matrix
2067 * - encoding: Set by user, can be NULL.
2068 * - decoding: Set by libavcodec.
2070 uint16_t *intra_matrix;
2073 * custom inter quantization matrix
2074 * - encoding: Set by user, can be NULL.
2075 * - decoding: Set by libavcodec.
2077 uint16_t *inter_matrix;
2080 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2081 * This is used to work around some encoder bugs.
2082 * - encoding: unused
2083 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2085 unsigned int stream_codec_tag;
2088 * scene change detection threshold
2089 * 0 is default, larger means fewer detected scene changes.
2090 * - encoding: Set by user.
2091 * - decoding: unused
2093 int scenechange_threshold;
2096 * minimum Lagrange multipler
2097 * - encoding: Set by user.
2098 * - decoding: unused
2103 * maximum Lagrange multipler
2104 * - encoding: Set by user.
2105 * - decoding: unused
2109 #if FF_API_PALETTE_CONTROL
2111 * palette control structure
2112 * - encoding: ??? (no palette-enabled encoder yet)
2113 * - decoding: Set by user.
2115 struct AVPaletteControl *palctrl;
2119 * noise reduction strength
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int noise_reduction;
2126 * Called at the beginning of a frame to get cr buffer for it.
2127 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2128 * libavcodec will pass previous buffer in pic, function should return
2129 * same buffer or new buffer with old frame "painted" into it.
2130 * If pic.data[0] == NULL must behave like get_buffer().
2131 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2132 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2134 * - encoding: unused
2135 * - decoding: Set by libavcodec, user can override.
2137 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2140 * Number of bits which should be loaded into the rc buffer before decoding starts.
2141 * - encoding: Set by user.
2142 * - decoding: unused
2144 int rc_initial_buffer_occupancy;
2148 * - encoding: Set by user.
2149 * - decoding: unused
2151 int inter_threshold;
2155 * - encoding: Set by user.
2156 * - decoding: Set by user.
2161 * Simulates errors in the bitstream to test error concealment.
2162 * - encoding: Set by user.
2163 * - decoding: unused
2167 #if FF_API_ANTIALIAS_ALGO
2169 * MP3 antialias algorithm, see FF_AA_* below.
2170 * - encoding: unused
2171 * - decoding: Set by user.
2173 attribute_deprecated int antialias_algo;
2174 #define FF_AA_AUTO 0
2175 #define FF_AA_FASTINT 1 //not implemented yet
2177 #define FF_AA_FLOAT 3
2181 * quantizer noise shaping
2182 * - encoding: Set by user.
2183 * - decoding: unused
2185 int quantizer_noise_shaping;
2189 * is used to decide how many independent tasks should be passed to execute()
2190 * - encoding: Set by user.
2191 * - decoding: Set by user.
2196 * The codec may call this to execute several independent things.
2197 * It will return only after finishing all tasks.
2198 * The user may replace this with some multithreaded implementation,
2199 * the default implementation will execute the parts serially.
2200 * @param count the number of things to execute
2201 * - encoding: Set by libavcodec, user can override.
2202 * - decoding: Set by libavcodec, user can override.
2204 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2208 * Can be used by execute() to store some per AVCodecContext stuff.
2209 * - encoding: set by execute()
2210 * - decoding: set by execute()
2212 void *thread_opaque;
2215 * Motion estimation threshold below which no motion estimation is
2216 * performed, but instead the user specified motion vectors are used.
2218 * - encoding: Set by user.
2219 * - decoding: unused
2224 * Macroblock threshold below which the user specified macroblock types will be used.
2225 * - encoding: Set by user.
2226 * - decoding: unused
2231 * precision of the intra DC coefficient - 8
2232 * - encoding: Set by user.
2233 * - decoding: unused
2235 int intra_dc_precision;
2238 * noise vs. sse weight for the nsse comparsion function
2239 * - encoding: Set by user.
2240 * - decoding: unused
2245 * Number of macroblock rows at the top which are skipped.
2246 * - encoding: unused
2247 * - decoding: Set by user.
2252 * Number of macroblock rows at the bottom which are skipped.
2253 * - encoding: unused
2254 * - decoding: Set by user.
2260 * - encoding: Set by user.
2261 * - decoding: Set by libavcodec.
2264 #define FF_PROFILE_UNKNOWN -99
2265 #define FF_PROFILE_RESERVED -100
2267 #define FF_PROFILE_AAC_MAIN 0
2268 #define FF_PROFILE_AAC_LOW 1
2269 #define FF_PROFILE_AAC_SSR 2
2270 #define FF_PROFILE_AAC_LTP 3
2272 #define FF_PROFILE_DTS 20
2273 #define FF_PROFILE_DTS_ES 30
2274 #define FF_PROFILE_DTS_96_24 40
2275 #define FF_PROFILE_DTS_HD_HRA 50
2276 #define FF_PROFILE_DTS_HD_MA 60
2278 #define FF_PROFILE_MPEG2_422 0
2279 #define FF_PROFILE_MPEG2_HIGH 1
2280 #define FF_PROFILE_MPEG2_SS 2
2281 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2282 #define FF_PROFILE_MPEG2_MAIN 4
2283 #define FF_PROFILE_MPEG2_SIMPLE 5
2285 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2286 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2288 #define FF_PROFILE_H264_BASELINE 66
2289 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2290 #define FF_PROFILE_H264_MAIN 77
2291 #define FF_PROFILE_H264_EXTENDED 88
2292 #define FF_PROFILE_H264_HIGH 100
2293 #define FF_PROFILE_H264_HIGH_10 110
2294 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2295 #define FF_PROFILE_H264_HIGH_422 122
2296 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2297 #define FF_PROFILE_H264_HIGH_444 144
2298 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2299 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2300 #define FF_PROFILE_H264_CAVLC_444 44
2302 #define FF_PROFILE_VC1_SIMPLE 0
2303 #define FF_PROFILE_VC1_MAIN 1
2304 #define FF_PROFILE_VC1_COMPLEX 2
2305 #define FF_PROFILE_VC1_ADVANCED 3
2309 * - encoding: Set by user.
2310 * - decoding: Set by libavcodec.
2313 #define FF_LEVEL_UNKNOWN -99
2316 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2317 * - encoding: unused
2318 * - decoding: Set by user.
2323 * Bitstream width / height, may be different from width/height if lowres
2324 * or other things are used.
2325 * - encoding: unused
2326 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2328 int coded_width, coded_height;
2331 * frame skip threshold
2332 * - encoding: Set by user.
2333 * - decoding: unused
2335 int frame_skip_threshold;
2339 * - encoding: Set by user.
2340 * - decoding: unused
2342 int frame_skip_factor;
2345 * frame skip exponent
2346 * - encoding: Set by user.
2347 * - decoding: unused
2352 * frame skip comparison function
2353 * - encoding: Set by user.
2354 * - decoding: unused
2359 * Border processing masking, raises the quantizer for mbs on the borders
2361 * - encoding: Set by user.
2362 * - decoding: unused
2364 float border_masking;
2367 * minimum MB lagrange multipler
2368 * - encoding: Set by user.
2369 * - decoding: unused
2374 * maximum MB lagrange multipler
2375 * - encoding: Set by user.
2376 * - decoding: unused
2382 * - encoding: Set by user.
2383 * - decoding: unused
2385 int me_penalty_compensation;
2389 * - encoding: unused
2390 * - decoding: Set by user.
2392 enum AVDiscard skip_loop_filter;
2396 * - encoding: unused
2397 * - decoding: Set by user.
2399 enum AVDiscard skip_idct;
2403 * - encoding: unused
2404 * - decoding: Set by user.
2406 enum AVDiscard skip_frame;
2410 * - encoding: Set by user.
2411 * - decoding: unused
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * constant rate factor - quality-based VBR - values ~correspond to qps
2424 * - encoding: Set by user.
2425 * - decoding: unused
2430 * constant quantization parameter rate control method
2431 * - encoding: Set by user.
2432 * - decoding: unused
2438 * - encoding: Set by user.
2439 * - decoding: unused
2444 * number of reference frames
2445 * - encoding: Set by user.
2446 * - decoding: Set by lavc.
2451 * chroma qp offset from luma
2452 * - encoding: Set by user.
2453 * - decoding: unused
2458 * Influences how often B-frames are used.
2459 * - encoding: Set by user.
2460 * - decoding: unused
2465 * trellis RD quantization
2466 * - encoding: Set by user.
2467 * - decoding: unused
2472 * Reduce fluctuations in qp (before curve compression).
2473 * - encoding: Set by user.
2474 * - decoding: unused
2476 float complexityblur;
2479 * in-loop deblocking filter alphac0 parameter
2480 * alpha is in the range -6...6
2481 * - encoding: Set by user.
2482 * - decoding: unused
2487 * in-loop deblocking filter beta parameter
2488 * beta is in the range -6...6
2489 * - encoding: Set by user.
2490 * - decoding: unused
2495 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2496 * - encoding: Set by user.
2497 * - decoding: unused
2500 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2501 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2502 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2503 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2504 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2507 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2508 * - encoding: Set by user.
2509 * - decoding: unused
2514 * Audio cutoff bandwidth (0 means "automatic")
2515 * - encoding: Set by user.
2516 * - decoding: unused
2521 * Multiplied by qscale for each frame and added to scene_change_score.
2522 * - encoding: Set by user.
2523 * - decoding: unused
2525 int scenechange_factor;
2529 * Note: Value depends upon the compare function used for fullpel ME.
2530 * - encoding: Set by user.
2531 * - decoding: unused
2536 * Adjusts sensitivity of b_frame_strategy 1.
2537 * - encoding: Set by user.
2538 * - decoding: unused
2543 * - encoding: Set by user.
2544 * - decoding: unused
2546 int compression_level;
2547 #define FF_COMPRESSION_DEFAULT -1
2551 * Sets whether to use LPC mode - used by FLAC encoder.
2552 * - encoding: Set by user.
2553 * - decoding: unused
2554 * @deprecated Deprecated in favor of lpc_type and lpc_passes.
2560 * LPC coefficient precision - used by FLAC encoder
2561 * - encoding: Set by user.
2562 * - decoding: unused
2564 int lpc_coeff_precision;
2567 * - encoding: Set by user.
2568 * - decoding: unused
2570 int min_prediction_order;
2573 * - encoding: Set by user.
2574 * - decoding: unused
2576 int max_prediction_order;
2579 * search method for selecting prediction order
2580 * - encoding: Set by user.
2581 * - decoding: unused
2583 int prediction_order_method;
2586 * - encoding: Set by user.
2587 * - decoding: unused
2589 int min_partition_order;
2592 * - encoding: Set by user.
2593 * - decoding: unused
2595 int max_partition_order;
2598 * GOP timecode frame start number, in non drop frame format
2599 * - encoding: Set by user.
2600 * - decoding: unused
2602 int64_t timecode_frame_start;
2604 #if FF_API_REQUEST_CHANNELS
2606 * Decoder should decode to this many channels if it can (0 for default)
2607 * - encoding: unused
2608 * - decoding: Set by user.
2609 * @deprecated Deprecated in favor of request_channel_layout.
2611 int request_channels;
2615 * Percentage of dynamic range compression to be applied by the decoder.
2616 * The default value is 1.0, corresponding to full compression.
2617 * - encoding: unused
2618 * - decoding: Set by user.
2623 * opaque 64bit number (generally a PTS) that will be reordered and
2624 * output in AVFrame.reordered_opaque
2625 * @deprecated in favor of pkt_pts
2626 * - encoding: unused
2627 * - decoding: Set by user.
2629 int64_t reordered_opaque;
2632 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2633 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2634 * - encoding: set by user.
2635 * - decoding: set by libavcodec.
2637 int bits_per_raw_sample;
2640 * Audio channel layout.
2641 * - encoding: set by user.
2642 * - decoding: set by libavcodec.
2644 int64_t channel_layout;
2647 * Request decoder to use this channel layout if it can (0 for default)
2648 * - encoding: unused
2649 * - decoding: Set by user.
2651 int64_t request_channel_layout;
2654 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2655 * - encoding: Set by user.
2656 * - decoding: unused.
2658 float rc_max_available_vbv_use;
2661 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2662 * - encoding: Set by user.
2663 * - decoding: unused.
2665 float rc_min_vbv_overflow_use;
2668 * Hardware accelerator in use
2669 * - encoding: unused.
2670 * - decoding: Set by libavcodec
2672 struct AVHWAccel *hwaccel;
2675 * For some codecs, the time base is closer to the field rate than the frame rate.
2676 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2677 * if no telecine is used ...
2679 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2681 int ticks_per_frame;
2684 * Hardware accelerator context.
2685 * For some hardware accelerators, a global context needs to be
2686 * provided by the user. In that case, this holds display-dependent
2687 * data FFmpeg cannot instantiate itself. Please refer to the
2688 * FFmpeg HW accelerator documentation to know how to fill this
2689 * is. e.g. for VA API, this is a struct vaapi_context.
2690 * - encoding: unused
2691 * - decoding: Set by user
2693 void *hwaccel_context;
2696 * Chromaticity coordinates of the source primaries.
2697 * - encoding: Set by user
2698 * - decoding: Set by libavcodec
2700 enum AVColorPrimaries color_primaries;
2703 * Color Transfer Characteristic.
2704 * - encoding: Set by user
2705 * - decoding: Set by libavcodec
2707 enum AVColorTransferCharacteristic color_trc;
2710 * YUV colorspace type.
2711 * - encoding: Set by user
2712 * - decoding: Set by libavcodec
2714 enum AVColorSpace colorspace;
2717 * MPEG vs JPEG YUV range.
2718 * - encoding: Set by user
2719 * - decoding: Set by libavcodec
2721 enum AVColorRange color_range;
2724 * This defines the location of chroma samples.
2725 * - encoding: Set by user
2726 * - decoding: Set by libavcodec
2728 enum AVChromaLocation chroma_sample_location;
2731 * The codec may call this to execute several independent things.
2732 * It will return only after finishing all tasks.
2733 * The user may replace this with some multithreaded implementation,
2734 * the default implementation will execute the parts serially.
2735 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2736 * @param c context passed also to func
2737 * @param count the number of things to execute
2738 * @param arg2 argument passed unchanged to func
2739 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2740 * @param func function that will be called count times, with jobnr from 0 to count-1.
2741 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2742 * two instances of func executing at the same time will have the same threadnr.
2743 * @return always 0 currently, but code should handle a future improvement where when any call to func
2744 * returns < 0 no further calls to func may be done and < 0 is returned.
2745 * - encoding: Set by libavcodec, user can override.
2746 * - decoding: Set by libavcodec, user can override.
2748 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2751 * explicit P-frame weighted prediction analysis method
2753 * 1: fast blind weighting (one reference duplicate with -1 offset)
2754 * 2: smart weighting (full fade detection analysis)
2755 * - encoding: Set by user.
2756 * - decoding: unused
2758 int weighted_p_pred;
2763 * 1: Variance AQ (complexity mask)
2764 * 2: Auto-variance AQ (experimental)
2765 * - encoding: Set by user
2766 * - decoding: unused
2772 * Reduces blocking and blurring in flat and textured areas.
2773 * - encoding: Set by user
2774 * - decoding: unused
2780 * Strength of psychovisual optimization
2781 * - encoding: Set by user
2782 * - decoding: unused
2788 * Strength of psychovisual optimization
2789 * - encoding: Set by user
2790 * - decoding: unused
2796 * Number of frames for frametype and ratecontrol lookahead
2797 * - encoding: Set by user
2798 * - decoding: unused
2803 * Constant rate factor maximum
2804 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2805 * than crf_max, even if doing so would violate VBV restrictions.
2806 * - encoding: Set by user.
2807 * - decoding: unused
2811 int log_level_offset;
2814 * Determines which LPC analysis algorithm to use.
2815 * - encoding: Set by user
2816 * - decoding: unused
2818 enum AVLPCType lpc_type;
2821 * Number of passes to use for Cholesky factorization during LPC analysis
2822 * - encoding: Set by user
2823 * - decoding: unused
2829 * Indicates number of picture subdivisions. Used for parallelized
2831 * - encoding: Set by user
2832 * - decoding: unused
2837 * Header containing style information for text subtitles.
2838 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2839 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2840 * the Format line following. It shouldn't include any Dialogue line.
2841 * - encoding: Set/allocated/freed by user (before avcodec_open())
2842 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2844 uint8_t *subtitle_header;
2845 int subtitle_header_size;
2848 * Current packet as passed into the decoder, to avoid having
2849 * to pass the packet into every function. Currently only valid
2850 * inside lavc and get/release_buffer callbacks.
2851 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2852 * - encoding: unused
2857 * Whether this is a copy of the context which had init() called on it.
2858 * This is used by multithreading - shared tables and picture pointers
2859 * should be freed from the original context only.
2860 * - encoding: Set by libavcodec.
2861 * - decoding: Set by libavcodec.
2866 * Which multithreading methods to use.
2867 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2868 * so clients which cannot provide future frames should not use it.
2870 * - encoding: Set by user, otherwise the default is used.
2871 * - decoding: Set by user, otherwise the default is used.
2874 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2875 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2878 * Which multithreading methods are in use by the codec.
2879 * - encoding: Set by libavcodec.
2880 * - decoding: Set by libavcodec.
2882 int active_thread_type;
2885 * Set by the client if its custom get_buffer() callback can be called
2886 * from another thread, which allows faster multithreaded decoding.
2887 * draw_horiz_band() will be called from other threads regardless of this setting.
2888 * Ignored if the default get_buffer() is used.
2889 * - encoding: Set by user.
2890 * - decoding: Set by user.
2892 int thread_safe_callbacks;
2895 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2896 * Used for compliant TS muxing.
2897 * - encoding: Set by libavcodec.
2898 * - decoding: unused.
2903 * Type of service that the audio stream conveys.
2904 * - encoding: Set by user.
2905 * - decoding: Set by libavcodec.
2907 enum AVAudioServiceType audio_service_type;
2910 * Current statistics for PTS correction.
2911 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2912 * - encoding: unused
2914 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2915 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2916 int64_t pts_correction_last_pts; /// PTS of the last frame
2917 int64_t pts_correction_last_dts; /// DTS of the last frame
2924 typedef struct AVProfile {
2926 const char *name; ///< short name for the profile
2932 typedef struct AVCodec {
2934 * Name of the codec implementation.
2935 * The name is globally unique among encoders and among decoders (but an
2936 * encoder and a decoder can share the same name).
2937 * This is the primary way to find a codec from the user perspective.
2940 enum AVMediaType type;
2943 int (*init)(AVCodecContext *);
2944 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2945 int (*close)(AVCodecContext *);
2946 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2948 * Codec capabilities.
2952 struct AVCodec *next;
2955 * Will be called when seeking
2957 void (*flush)(AVCodecContext *);
2958 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2959 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2961 * Descriptive name for the codec, meant to be more human readable than name.
2962 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2964 const char *long_name;
2965 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2966 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2967 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2968 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2970 AVClass *priv_class; ///< AVClass for the private context
2972 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2975 * @defgroup framethreading Frame-level threading support functions.
2979 * If defined, called on thread contexts when they are created.
2980 * If the codec allocates writable tables in init(), re-allocate them here.
2981 * priv_data will be set to a copy of the original.
2983 int (*init_thread_copy)(AVCodecContext *);
2985 * Copy necessary context variables from a previous thread context to the current one.
2986 * If not defined, the next thread will start automatically; otherwise, the codec
2987 * must call ff_thread_finish_setup().
2989 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2991 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2998 typedef struct AVHWAccel {
3000 * Name of the hardware accelerated codec.
3001 * The name is globally unique among encoders and among decoders (but an
3002 * encoder and a decoder can share the same name).
3007 * Type of codec implemented by the hardware accelerator.
3009 * See AVMEDIA_TYPE_xxx
3011 enum AVMediaType type;
3014 * Codec implemented by the hardware accelerator.
3021 * Supported pixel format.
3023 * Only hardware accelerated formats are supported here.
3025 enum PixelFormat pix_fmt;
3028 * Hardware accelerated codec capabilities.
3029 * see FF_HWACCEL_CODEC_CAP_*
3033 struct AVHWAccel *next;
3036 * Called at the beginning of each frame or field picture.
3038 * Meaningful frame information (codec specific) is guaranteed to
3039 * be parsed at this point. This function is mandatory.
3041 * Note that buf can be NULL along with buf_size set to 0.
3042 * Otherwise, this means the whole frame is available at this point.
3044 * @param avctx the codec context
3045 * @param buf the frame data buffer base
3046 * @param buf_size the size of the frame in bytes
3047 * @return zero if successful, a negative value otherwise
3049 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3052 * Callback for each slice.
3054 * Meaningful slice information (codec specific) is guaranteed to
3055 * be parsed at this point. This function is mandatory.
3057 * @param avctx the codec context
3058 * @param buf the slice data buffer base
3059 * @param buf_size the size of the slice in bytes
3060 * @return zero if successful, a negative value otherwise
3062 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3065 * Called at the end of each frame or field picture.
3067 * The whole picture is parsed at this point and can now be sent
3068 * to the hardware accelerator. This function is mandatory.
3070 * @param avctx the codec context
3071 * @return zero if successful, a negative value otherwise
3073 int (*end_frame)(AVCodecContext *avctx);
3076 * Size of HW accelerator private data.
3078 * Private data is allocated with av_mallocz() before
3079 * AVCodecContext.get_buffer() and deallocated after
3080 * AVCodecContext.release_buffer().
3086 * four components are given, that's all.
3087 * the last component is alpha
3089 typedef struct AVPicture {
3091 int linesize[4]; ///< number of bytes per line
3094 #if FF_API_PALETTE_CONTROL
3097 * This structure defines a method for communicating palette changes
3098 * between and demuxer and a decoder.
3100 * @deprecated Use AVPacket to send palette changes instead.
3101 * This is totally broken.
3103 #define AVPALETTE_SIZE 1024
3104 #define AVPALETTE_COUNT 256
3105 typedef struct AVPaletteControl {
3107 /* Demuxer sets this to 1 to indicate the palette has changed;
3108 * decoder resets to 0. */
3109 int palette_changed;
3111 /* 4-byte ARGB palette entries, stored in native byte order; note that
3112 * the individual palette components should be on a 8-bit scale; if
3113 * the palette data comes from an IBM VGA native format, the component
3114 * data is probably 6 bits in size and needs to be scaled. */
3115 unsigned int palette[AVPALETTE_COUNT];
3117 } AVPaletteControl attribute_deprecated;
3120 enum AVSubtitleType {
3123 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3126 * Plain text, the text field must be set by the decoder and is
3127 * authoritative. ass and pict fields may contain approximations.
3132 * Formatted text, the ass field must be set by the decoder and is
3133 * authoritative. pict and text fields may contain approximations.
3138 typedef struct AVSubtitleRect {
3139 int x; ///< top left corner of pict, undefined when pict is not set
3140 int y; ///< top left corner of pict, undefined when pict is not set
3141 int w; ///< width of pict, undefined when pict is not set
3142 int h; ///< height of pict, undefined when pict is not set
3143 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3146 * data+linesize for the bitmap of this subtitle.
3147 * can be set for text/ass as well once they where rendered
3150 enum AVSubtitleType type;
3152 char *text; ///< 0 terminated plain UTF-8 text
3155 * 0 terminated ASS/SSA compatible event line.
3156 * The pressentation of this is unaffected by the other values in this
3162 typedef struct AVSubtitle {
3163 uint16_t format; /* 0 = graphics */
3164 uint32_t start_display_time; /* relative to packet pts, in ms */
3165 uint32_t end_display_time; /* relative to packet pts, in ms */
3167 AVSubtitleRect **rects;
3168 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3171 /* packet functions */
3174 * @deprecated use NULL instead
3176 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3179 * Default packet destructor.
3181 void av_destruct_packet(AVPacket *pkt);
3184 * Initialize optional fields of a packet with default values.
3188 void av_init_packet(AVPacket *pkt);
3191 * Allocate the payload of a packet and initialize its fields with
3195 * @param size wanted payload size
3196 * @return 0 if OK, AVERROR_xxx otherwise
3198 int av_new_packet(AVPacket *pkt, int size);
3201 * Reduce packet size, correctly zeroing padding
3204 * @param size new size
3206 void av_shrink_packet(AVPacket *pkt, int size);
3209 * Increase packet size, correctly zeroing padding
3212 * @param grow_by number of bytes by which to increase the size of the packet
3214 int av_grow_packet(AVPacket *pkt, int grow_by);
3217 * @warning This is a hack - the packet memory allocation stuff is broken. The
3218 * packet is allocated if it was not really allocated.
3220 int av_dup_packet(AVPacket *pkt);
3225 * @param pkt packet to free
3227 void av_free_packet(AVPacket *pkt);
3231 struct ReSampleContext;
3232 struct AVResampleContext;
3234 typedef struct ReSampleContext ReSampleContext;
3236 #if FF_API_AUDIO_OLD
3238 * @deprecated Use av_audio_resample_init() instead.
3240 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
3241 int output_rate, int input_rate);
3245 * Initialize audio resampling context.
3247 * @param output_channels number of output channels
3248 * @param input_channels number of input channels
3249 * @param output_rate output sample rate
3250 * @param input_rate input sample rate
3251 * @param sample_fmt_out requested output sample format
3252 * @param sample_fmt_in input sample format
3253 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3254 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3255 * @param linear if 1 then the used FIR filter will be linearly interpolated
3256 between the 2 closest, if 0 the closest will be used
3257 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3258 * @return allocated ReSampleContext, NULL if error occured
3260 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3261 int output_rate, int input_rate,
3262 enum AVSampleFormat sample_fmt_out,
3263 enum AVSampleFormat sample_fmt_in,
3264 int filter_length, int log2_phase_count,
3265 int linear, double cutoff);
3267 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3270 * Free resample context.
3272 * @param s a non-NULL pointer to a resample context previously
3273 * created with av_audio_resample_init()
3275 void audio_resample_close(ReSampleContext *s);
3279 * Initialize an audio resampler.
3280 * Note, if either rate is not an integer then simply scale both rates up so they are.
3281 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3282 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3283 * @param linear If 1 then the used FIR filter will be linearly interpolated
3284 between the 2 closest, if 0 the closest will be used
3285 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3287 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3290 * Resample an array of samples using a previously configured context.
3291 * @param src an array of unconsumed samples
3292 * @param consumed the number of samples of src which have been consumed are returned here
3293 * @param src_size the number of unconsumed samples available
3294 * @param dst_size the amount of space in samples available in dst
3295 * @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.
3296 * @return the number of samples written in dst or -1 if an error occurred
3298 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3302 * Compensate samplerate/timestamp drift. The compensation is done by changing
3303 * the resampler parameters, so no audible clicks or similar distortions occur
3304 * @param compensation_distance distance in output samples over which the compensation should be performed
3305 * @param sample_delta number of output samples which should be output less
3307 * example: av_resample_compensate(c, 10, 500)
3308 * here instead of 510 samples only 500 samples would be output
3310 * note, due to rounding the actual compensation might be slightly different,
3311 * especially if the compensation_distance is large and the in_rate used during init is small
3313 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3314 void av_resample_close(struct AVResampleContext *c);
3317 * Allocate memory for a picture. Call avpicture_free() to free it.
3319 * \see avpicture_fill()
3321 * @param picture the picture to be filled in
3322 * @param pix_fmt the format of the picture
3323 * @param width the width of the picture
3324 * @param height the height of the picture
3325 * @return zero if successful, a negative value if not
3327 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3330 * Free a picture previously allocated by avpicture_alloc().
3331 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3334 * @param picture the AVPicture to be freed
3336 void avpicture_free(AVPicture *picture);
3339 * Fill in the AVPicture fields.
3340 * The fields of the given AVPicture are filled in by using the 'ptr' address
3341 * which points to the image data buffer. Depending on the specified picture
3342 * format, one or multiple image data pointers and line sizes will be set.
3343 * If a planar format is specified, several pointers will be set pointing to
3344 * the different picture planes and the line sizes of the different planes
3345 * will be stored in the lines_sizes array.
3346 * Call with ptr == NULL to get the required size for the ptr buffer.
3348 * To allocate the buffer and fill in the AVPicture fields in one call,
3349 * use avpicture_alloc().
3351 * @param picture AVPicture whose fields are to be filled in
3352 * @param ptr Buffer which will contain or contains the actual image data
3353 * @param pix_fmt The format in which the picture data is stored.
3354 * @param width the width of the image in pixels
3355 * @param height the height of the image in pixels
3356 * @return size of the image data in bytes
3358 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3359 enum PixelFormat pix_fmt, int width, int height);
3362 * Copy pixel data from an AVPicture into a buffer.
3363 * The data is stored compactly, without any gaps for alignment or padding
3364 * which may be applied by avpicture_fill().
3366 * \see avpicture_get_size()
3368 * @param[in] src AVPicture containing image data
3369 * @param[in] pix_fmt The format in which the picture data is stored.
3370 * @param[in] width the width of the image in pixels.
3371 * @param[in] height the height of the image in pixels.
3372 * @param[out] dest A buffer into which picture data will be copied.
3373 * @param[in] dest_size The size of 'dest'.
3374 * @return The number of bytes written to dest, or a negative value (error code) on error.
3376 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3377 unsigned char *dest, int dest_size);
3380 * Calculate the size in bytes that a picture of the given width and height
3381 * would occupy if stored in the given picture format.
3382 * Note that this returns the size of a compact representation as generated
3383 * by avpicture_layout(), which can be smaller than the size required for e.g.
3386 * @param pix_fmt the given picture format
3387 * @param width the width of the image
3388 * @param height the height of the image
3389 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3391 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3392 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3395 * Return the short name for a pixel format.
3397 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3399 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3401 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3403 #if LIBAVCODEC_VERSION_MAJOR < 53
3405 * Return the pixel format corresponding to the name name.
3407 * If there is no pixel format with name name, then look for a
3408 * pixel format with the name corresponding to the native endian
3410 * For example in a little-endian system, first look for "gray16",
3411 * then for "gray16le".
3413 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3415 * @deprecated Deprecated in favor of av_get_pix_fmt().
3417 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3421 * Return a value representing the fourCC code associated to the
3422 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3425 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3428 * Put a string representing the codec tag codec_tag in buf.
3430 * @param buf_size size in bytes of buf
3431 * @return the length of the string that would have been generated if
3432 * enough space had been available, excluding the trailing null
3434 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3436 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3437 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3438 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3439 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3440 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3441 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3444 * Compute what kind of losses will occur when converting from one specific
3445 * pixel format to another.
3446 * When converting from one pixel format to another, information loss may occur.
3447 * For example, when converting from RGB24 to GRAY, the color information will
3448 * be lost. Similarly, other losses occur when converting from some formats to
3449 * other formats. These losses can involve loss of chroma, but also loss of
3450 * resolution, loss of color depth, loss due to the color space conversion, loss
3451 * of the alpha bits or loss due to color quantization.
3452 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3453 * which will occur when converting from one pixel format to another.
3455 * @param[in] dst_pix_fmt destination pixel format
3456 * @param[in] src_pix_fmt source pixel format
3457 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3458 * @return Combination of flags informing you what kind of losses will occur.
3460 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3464 * Find the best pixel format to convert to given a certain source pixel
3465 * format. When converting from one pixel format to another, information loss
3466 * may occur. For example, when converting from RGB24 to GRAY, the color
3467 * information will be lost. Similarly, other losses occur when converting from
3468 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3469 * the given pixel formats should be used to suffer the least amount of loss.
3470 * The pixel formats from which it chooses one, are determined by the
3471 * pix_fmt_mask parameter.
3474 * src_pix_fmt = PIX_FMT_YUV420P;
3475 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3476 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3479 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3480 * @param[in] src_pix_fmt source pixel format
3481 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3482 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3483 * @return The best pixel format to convert to or -1 if none was found.
3485 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3486 int has_alpha, int *loss_ptr);
3488 #if LIBAVCODEC_VERSION_MAJOR < 53
3490 * @deprecated Use av_get_pix_fmt_string() instead.
3492 attribute_deprecated
3493 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3496 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3497 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3500 * Tell if an image really has transparent alpha values.
3501 * @return ored mask of FF_ALPHA_xxx constants
3503 int img_get_alpha_info(const AVPicture *src,
3504 enum PixelFormat pix_fmt, int width, int height);
3506 /* deinterlace a picture */
3507 /* deinterlace - if not supported return -1 */
3508 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3509 enum PixelFormat pix_fmt, int width, int height);
3511 /* external high level API */
3514 * If c is NULL, returns the first registered codec,
3515 * if c is non-NULL, returns the next registered codec after c,
3516 * or NULL if c is the last one.
3518 AVCodec *av_codec_next(AVCodec *c);
3521 * Return the LIBAVCODEC_VERSION_INT constant.
3523 unsigned avcodec_version(void);
3526 * Return the libavcodec build-time configuration.
3528 const char *avcodec_configuration(void);
3531 * Return the libavcodec license.
3533 const char *avcodec_license(void);
3536 * Initialize libavcodec.
3537 * If called more than once, does nothing.
3539 * @warning This function must be called before any other libavcodec
3542 * @warning This function is not thread-safe.
3544 void avcodec_init(void);
3546 #if LIBAVCODEC_VERSION_MAJOR < 53
3548 * @deprecated Deprecated in favor of avcodec_register().
3550 attribute_deprecated void register_avcodec(AVCodec *codec);
3554 * Register the codec codec and initialize libavcodec.
3556 * @see avcodec_init(), avcodec_register_all()
3558 void avcodec_register(AVCodec *codec);
3561 * Find a registered encoder with a matching codec ID.
3563 * @param id CodecID of the requested encoder
3564 * @return An encoder if one was found, NULL otherwise.
3566 AVCodec *avcodec_find_encoder(enum CodecID id);
3569 * Find a registered encoder with the specified name.
3571 * @param name name of the requested encoder
3572 * @return An encoder if one was found, NULL otherwise.
3574 AVCodec *avcodec_find_encoder_by_name(const char *name);
3577 * Find a registered decoder with a matching codec ID.
3579 * @param id CodecID of the requested decoder
3580 * @return A decoder if one was found, NULL otherwise.
3582 AVCodec *avcodec_find_decoder(enum CodecID id);
3585 * Find a registered decoder with the specified name.
3587 * @param name name of the requested decoder
3588 * @return A decoder if one was found, NULL otherwise.
3590 AVCodec *avcodec_find_decoder_by_name(const char *name);
3591 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3594 * Return a name for the specified profile, if available.
3596 * @param codec the codec that is searched for the given profile
3597 * @param profile the profile value for which a name is requested
3598 * @return A name for the profile if found, NULL otherwise.
3600 const char *av_get_profile_name(const AVCodec *codec, int profile);
3603 * Set the fields of the given AVCodecContext to default values.
3605 * @param s The AVCodecContext of which the fields should be set to default values.
3607 void avcodec_get_context_defaults(AVCodecContext *s);
3609 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3610 * we WILL change its arguments and name a few times! */
3611 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3613 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3614 * we WILL change its arguments and name a few times! */
3615 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3618 * Allocate an AVCodecContext and set its fields to default values. The
3619 * resulting struct can be deallocated by simply calling av_free().
3621 * @return An AVCodecContext filled with default values or NULL on failure.
3622 * @see avcodec_get_context_defaults
3624 AVCodecContext *avcodec_alloc_context(void);
3626 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3627 * we WILL change its arguments and name a few times! */
3628 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3630 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3631 * we WILL change its arguments and name a few times! */
3632 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3635 * Copy the settings of the source AVCodecContext into the destination
3636 * AVCodecContext. The resulting destination codec context will be
3637 * unopened, i.e. you are required to call avcodec_open() before you
3638 * can use this AVCodecContext to decode/encode video/audio data.
3640 * @param dest target codec context, should be initialized with
3641 * avcodec_alloc_context(), but otherwise uninitialized
3642 * @param src source codec context
3643 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3645 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3648 * Set the fields of the given AVFrame to default values.
3650 * @param pic The AVFrame of which the fields should be set to default values.
3652 void avcodec_get_frame_defaults(AVFrame *pic);
3655 * Allocate an AVFrame and set its fields to default values. The resulting
3656 * struct can be deallocated by simply calling av_free().
3658 * @return An AVFrame filled with default values or NULL on failure.
3659 * @see avcodec_get_frame_defaults
3661 AVFrame *avcodec_alloc_frame(void);
3663 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3664 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3665 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3668 * Return the amount of padding in pixels which the get_buffer callback must
3669 * provide around the edge of the image for codecs which do not have the
3670 * CODEC_FLAG_EMU_EDGE flag.
3672 * @return Required padding in pixels.
3674 unsigned avcodec_get_edge_width(void);
3676 * Modify width and height values so that they will result in a memory
3677 * buffer that is acceptable for the codec if you do not use any horizontal
3680 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3681 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3682 * according to avcodec_get_edge_width() before.
3684 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3686 * Modify width and height values so that they will result in a memory
3687 * buffer that is acceptable for the codec if you also ensure that all
3688 * line sizes are a multiple of the respective linesize_align[i].
3690 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3691 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3692 * according to avcodec_get_edge_width() before.
3694 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3695 int linesize_align[4]);
3697 #if LIBAVCODEC_VERSION_MAJOR < 53
3699 * @deprecated Deprecated in favor of av_check_image_size().
3701 attribute_deprecated
3702 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3705 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3707 #if LIBAVCODEC_VERSION_MAJOR < 53
3709 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3711 attribute_deprecated
3712 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3713 void avcodec_thread_free(AVCodecContext *s);
3715 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3716 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3717 //FIXME func typedef
3720 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3721 * function the context has to be allocated.
3723 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3724 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3725 * retrieving a codec.
3727 * @warning This function is not thread safe!
3730 * avcodec_register_all();
3731 * codec = avcodec_find_decoder(CODEC_ID_H264);
3735 * context = avcodec_alloc_context();
3737 * if (avcodec_open(context, codec) < 0)
3741 * @param avctx The context which will be set up to use the given codec.
3742 * @param codec The codec to use within the context.
3743 * @return zero on success, a negative value on error
3744 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3746 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3748 #if FF_API_AUDIO_OLD
3750 * Decode an audio frame from buf into samples.
3751 * Wrapper function which calls avcodec_decode_audio3.
3753 * @deprecated Use avcodec_decode_audio3 instead.
3754 * @param avctx the codec context
3755 * @param[out] samples the output buffer
3756 * @param[in,out] frame_size_ptr the output buffer size in bytes
3757 * @param[in] buf the input buffer
3758 * @param[in] buf_size the input buffer size in bytes
3759 * @return On error a negative value is returned, otherwise the number of bytes
3760 * used or zero if no frame could be decompressed.
3762 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3763 int *frame_size_ptr,
3764 const uint8_t *buf, int buf_size);
3768 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3769 * Some decoders may support multiple frames in a single AVPacket, such
3770 * decoders would then just decode the first frame. In this case,
3771 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3772 * the remaining data in order to decode the second frame etc.
3774 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3775 * decompressed frame size in bytes.
3777 * @warning You must set frame_size_ptr to the allocated size of the
3778 * output buffer before calling avcodec_decode_audio3().
3780 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3781 * the actual read bytes because some optimized bitstream readers read 32 or 64
3782 * bits at once and could read over the end.
3784 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3785 * no overreading happens for damaged MPEG streams.
3787 * @note You might have to align the input buffer avpkt->data and output buffer
3788 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3789 * necessary at all, on others it won't work at all if not aligned and on others
3790 * it will work but it will have an impact on performance.
3792 * In practice, avpkt->data should have 4 byte alignment at minimum and
3793 * samples should be 16 byte aligned unless the CPU doesn't need it
3794 * (AltiVec and SSE do).
3796 * @param avctx the codec context
3797 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3798 * @param[in,out] frame_size_ptr the output buffer size in bytes
3799 * @param[in] avpkt The input AVPacket containing the input buffer.
3800 * You can create such packet with av_init_packet() and by then setting
3801 * data and size, some decoders might in addition need other fields.
3802 * All decoders are designed to use the least fields possible though.
3803 * @return On error a negative value is returned, otherwise the number of bytes
3804 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3806 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3807 int *frame_size_ptr,
3810 #if FF_API_VIDEO_OLD
3812 * Decode a video frame from buf into picture.
3813 * Wrapper function which calls avcodec_decode_video2.
3815 * @deprecated Use avcodec_decode_video2 instead.
3816 * @param avctx the codec context
3817 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3818 * @param[in] buf the input buffer
3819 * @param[in] buf_size the size of the input buffer in bytes
3820 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3821 * @return On error a negative value is returned, otherwise the number of bytes
3822 * used or zero if no frame could be decompressed.
3824 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3825 int *got_picture_ptr,
3826 const uint8_t *buf, int buf_size);
3830 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3831 * Some decoders may support multiple frames in a single AVPacket, such
3832 * decoders would then just decode the first frame.
3834 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3835 * the actual read bytes because some optimized bitstream readers read 32 or 64
3836 * bits at once and could read over the end.
3838 * @warning The end of the input buffer buf should be set to 0 to ensure that
3839 * no overreading happens for damaged MPEG streams.
3841 * @note You might have to align the input buffer avpkt->data.
3842 * The alignment requirements depend on the CPU: on some CPUs it isn't
3843 * necessary at all, on others it won't work at all if not aligned and on others
3844 * it will work but it will have an impact on performance.
3846 * In practice, avpkt->data should have 4 byte alignment at minimum.
3848 * @note Some codecs have a delay between input and output, these need to be
3849 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3851 * @param avctx the codec context
3852 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3853 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3854 * allocate memory for the actual bitmap.
3855 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3856 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3857 * decodes and the decoder tells the user once it does not need the data anymore,
3858 * the user app can at this point free/reuse/keep the memory as it sees fit.
3860 * @param[in] avpkt The input AVpacket containing the input buffer.
3861 * You can create such packet with av_init_packet() and by then setting
3862 * data and size, some decoders might in addition need other fields like
3863 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3865 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3866 * @return On error a negative value is returned, otherwise the number of bytes
3867 * used or zero if no frame could be decompressed.
3869 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3870 int *got_picture_ptr,
3873 #if FF_API_SUBTITLE_OLD
3874 /* Decode a subtitle message. Return -1 if error, otherwise return the
3875 * number of bytes used. If no subtitle could be decompressed,
3876 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3877 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3879 const uint8_t *buf, int buf_size);
3883 * Decode a subtitle message.
3884 * Return a negative value on error, otherwise return the number of bytes used.
3885 * If no subtitle could be decompressed, got_sub_ptr is zero.
3886 * Otherwise, the subtitle is stored in *sub.
3887 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3888 * simplicity, because the performance difference is expect to be negligible
3889 * and reusing a get_buffer written for video codecs would probably perform badly
3890 * due to a potentially very different allocation pattern.
3892 * @param avctx the codec context
3893 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3894 freed with avsubtitle_free if *got_sub_ptr is set.
3895 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3896 * @param[in] avpkt The input AVPacket containing the input buffer.
3898 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3903 * Frees all allocated data in the given subtitle struct.
3905 * @param sub AVSubtitle to free.
3907 void avsubtitle_free(AVSubtitle *sub);
3909 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3911 uint8_t *buf, int buf_size);
3914 * Encode an audio frame from samples into buf.
3916 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3917 * However, for PCM audio the user will know how much space is needed
3918 * because it depends on the value passed in buf_size as described
3919 * below. In that case a lower value can be used.
3921 * @param avctx the codec context
3922 * @param[out] buf the output buffer
3923 * @param[in] buf_size the output buffer size
3924 * @param[in] samples the input buffer containing the samples
3925 * The number of samples read from this buffer is frame_size*channels,
3926 * both of which are defined in avctx.
3927 * For PCM audio the number of samples read from samples is equal to
3928 * buf_size * input_sample_size / output_sample_size.
3929 * @return On error a negative value is returned, on success zero or the number
3930 * of bytes used to encode the data read from the input buffer.
3932 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3933 const short *samples);
3936 * Encode a video frame from pict into buf.
3937 * The input picture should be
3938 * stored using a specific format, namely avctx.pix_fmt.
3940 * @param avctx the codec context
3941 * @param[out] buf the output buffer for the bitstream of encoded frame
3942 * @param[in] buf_size the size of the output buffer in bytes
3943 * @param[in] pict the input picture to encode
3944 * @return On error a negative value is returned, on success zero or the number
3945 * of bytes used from the output buffer.
3947 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3948 const AVFrame *pict);
3949 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3950 const AVSubtitle *sub);
3952 int avcodec_close(AVCodecContext *avctx);
3955 * Register all the codecs, parsers and bitstream filters which were enabled at
3956 * configuration time. If you do not call this function you can select exactly
3957 * which formats you want to support, by using the individual registration
3960 * @see avcodec_register
3961 * @see av_register_codec_parser
3962 * @see av_register_bitstream_filter
3964 void avcodec_register_all(void);
3967 * Flush buffers, should be called when seeking or when switching to a different stream.
3969 void avcodec_flush_buffers(AVCodecContext *avctx);
3971 void avcodec_default_free_buffers(AVCodecContext *s);
3973 /* misc useful functions */
3976 * Return a single letter to describe the given picture type pict_type.
3978 * @param[in] pict_type the picture type
3979 * @return A single character representing the picture type.
3981 char av_get_pict_type_char(int pict_type);
3984 * Return codec bits per sample.
3986 * @param[in] codec_id the codec
3987 * @return Number of bits per sample or zero if unknown for the given codec.
3989 int av_get_bits_per_sample(enum CodecID codec_id);
3991 #if FF_API_OLD_SAMPLE_FMT
3993 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3995 attribute_deprecated
3996 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4000 typedef struct AVCodecParserContext {
4002 struct AVCodecParser *parser;
4003 int64_t frame_offset; /* offset of the current frame */
4004 int64_t cur_offset; /* current offset
4005 (incremented by each av_parser_parse()) */
4006 int64_t next_frame_offset; /* offset of the next frame */
4008 int pict_type; /* XXX: Put it back in AVCodecContext. */
4010 * This field is used for proper frame duration computation in lavf.
4011 * It signals, how much longer the frame duration of the current frame
4012 * is compared to normal frame duration.
4014 * frame_duration = (1 + repeat_pict) * time_base
4016 * It is used by codecs like H.264 to display telecined material.
4018 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4019 int64_t pts; /* pts of the current frame */
4020 int64_t dts; /* dts of the current frame */
4025 int fetch_timestamp;
4027 #define AV_PARSER_PTS_NB 4
4028 int cur_frame_start_index;
4029 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4030 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4031 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4034 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4035 #define PARSER_FLAG_ONCE 0x0002
4036 /// Set if the parser has a valid file offset
4037 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4039 int64_t offset; ///< byte offset from starting packet start
4040 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4043 * Set by parser to 1 for key frames and 0 for non-key frames.
4044 * It is initialized to -1, so if the parser doesn't set this flag,
4045 * old-style fallback using FF_I_TYPE picture type as key frames
4051 * Time difference in stream time base units from the pts of this
4052 * packet to the point at which the output from the decoder has converged
4053 * independent from the availability of previous frames. That is, the
4054 * frames are virtually identical no matter if decoding started from
4055 * the very first frame or from this keyframe.
4056 * Is AV_NOPTS_VALUE if unknown.
4057 * This field is not the display duration of the current frame.
4058 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4061 * The purpose of this field is to allow seeking in streams that have no
4062 * keyframes in the conventional sense. It corresponds to the
4063 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4064 * essential for some types of subtitle streams to ensure that all
4065 * subtitles are correctly displayed after seeking.
4067 int64_t convergence_duration;
4069 // Timestamp generation support:
4071 * Synchronization point for start of timestamp generation.
4073 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4076 * For example, this corresponds to presence of H.264 buffering period
4082 * Offset of the current timestamp against last timestamp sync point in
4083 * units of AVCodecContext.time_base.
4085 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4086 * contain a valid timestamp offset.
4088 * Note that the timestamp of sync point has usually a nonzero
4089 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4090 * the next frame after timestamp sync point will be usually 1.
4092 * For example, this corresponds to H.264 cpb_removal_delay.
4094 int dts_ref_dts_delta;
4097 * Presentation delay of current frame in units of AVCodecContext.time_base.
4099 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4100 * contain valid non-negative timestamp delta (presentation time of a frame
4101 * must not lie in the past).
4103 * This delay represents the difference between decoding and presentation
4104 * time of the frame.
4106 * For example, this corresponds to H.264 dpb_output_delay.
4111 * Position of the packet in file.
4113 * Analogous to cur_frame_pts/dts
4115 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4118 * Byte position of currently parsed frame in stream.
4123 * Previous frame byte position.
4126 } AVCodecParserContext;
4128 typedef struct AVCodecParser {
4129 int codec_ids[5]; /* several codec IDs are permitted */
4131 int (*parser_init)(AVCodecParserContext *s);
4132 int (*parser_parse)(AVCodecParserContext *s,
4133 AVCodecContext *avctx,
4134 const uint8_t **poutbuf, int *poutbuf_size,
4135 const uint8_t *buf, int buf_size);
4136 void (*parser_close)(AVCodecParserContext *s);
4137 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4138 struct AVCodecParser *next;
4141 AVCodecParser *av_parser_next(AVCodecParser *c);
4143 void av_register_codec_parser(AVCodecParser *parser);
4144 AVCodecParserContext *av_parser_init(int codec_id);
4146 #if LIBAVCODEC_VERSION_MAJOR < 53
4147 attribute_deprecated
4148 int av_parser_parse(AVCodecParserContext *s,
4149 AVCodecContext *avctx,
4150 uint8_t **poutbuf, int *poutbuf_size,
4151 const uint8_t *buf, int buf_size,
4152 int64_t pts, int64_t dts);
4158 * @param s parser context.
4159 * @param avctx codec context.
4160 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4161 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4162 * @param buf input buffer.
4163 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4164 * @param pts input presentation timestamp.
4165 * @param dts input decoding timestamp.
4166 * @param pos input byte position in stream.
4167 * @return the number of bytes of the input bitstream used.
4172 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4179 * decode_frame(data, size);
4183 int av_parser_parse2(AVCodecParserContext *s,
4184 AVCodecContext *avctx,
4185 uint8_t **poutbuf, int *poutbuf_size,
4186 const uint8_t *buf, int buf_size,
4187 int64_t pts, int64_t dts,
4190 int av_parser_change(AVCodecParserContext *s,
4191 AVCodecContext *avctx,
4192 uint8_t **poutbuf, int *poutbuf_size,
4193 const uint8_t *buf, int buf_size, int keyframe);
4194 void av_parser_close(AVCodecParserContext *s);
4197 typedef struct AVBitStreamFilterContext {
4199 struct AVBitStreamFilter *filter;
4200 AVCodecParserContext *parser;
4201 struct AVBitStreamFilterContext *next;
4202 } AVBitStreamFilterContext;
4205 typedef struct AVBitStreamFilter {
4208 int (*filter)(AVBitStreamFilterContext *bsfc,
4209 AVCodecContext *avctx, const char *args,
4210 uint8_t **poutbuf, int *poutbuf_size,
4211 const uint8_t *buf, int buf_size, int keyframe);
4212 void (*close)(AVBitStreamFilterContext *bsfc);
4213 struct AVBitStreamFilter *next;
4214 } AVBitStreamFilter;
4216 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4217 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4218 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4219 AVCodecContext *avctx, const char *args,
4220 uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size, int keyframe);
4222 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4224 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4229 * Reallocate the given block if it is not large enough, otherwise do nothing.
4233 void *av_fast_realloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4236 * Allocate a buffer, reusing the given one if large enough.
4238 * Contrary to av_fast_realloc the current buffer contents might not be
4239 * preserved and on error the old buffer is freed, thus no special
4240 * handling to avoid memleaks is necessary.
4242 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4243 * @param size size of the buffer *ptr points to
4244 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4245 * *size 0 if an error occurred.
4247 void av_fast_malloc(void *ptr, unsigned int *size, FF_INTERNALC_MEM_TYPE min_size);
4249 #if LIBAVCODEC_VERSION_MAJOR < 53
4251 * @deprecated Deprecated in favor of av_image_copy().
4253 attribute_deprecated
4254 void av_picture_data_copy(uint8_t *dst_data[4], int dst_linesize[4],
4255 uint8_t *src_data[4], int src_linesize[4],
4256 enum PixelFormat pix_fmt, int width, int height);
4260 * Copy image src to dst. Wraps av_picture_data_copy() above.
4262 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4263 enum PixelFormat pix_fmt, int width, int height);
4266 * Crop image top and left side.
4268 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4269 enum PixelFormat pix_fmt, int top_band, int left_band);
4274 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4275 int padtop, int padbottom, int padleft, int padright, int *color);
4278 * Encode extradata length to a buffer. Used by xiph codecs.
4280 * @param s buffer to write to; must be at least (v/255+1) bytes long
4281 * @param v size of extradata in bytes
4282 * @return number of bytes written to the buffer.
4284 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4286 #if LIBAVCODEC_VERSION_MAJOR < 53
4288 * Parse str and put in width_ptr and height_ptr the detected values.
4290 * @deprecated Deprecated in favor of av_parse_video_size().
4292 attribute_deprecated int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
4295 * Parse str and store the detected values in *frame_rate.
4297 * @deprecated Deprecated in favor of av_parse_video_rate().
4299 attribute_deprecated int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
4303 * Logs a generic warning message about a missing feature. This function is
4304 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4305 * only, and would normally not be used by applications.
4306 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4307 * a pointer to an AVClass struct
4308 * @param[in] feature string containing the name of the missing feature
4309 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4310 * If want_sample is non-zero, additional verbage will be added to the log
4311 * message which tells the user how to report samples to the development
4314 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4317 * Log a generic warning message asking for a sample. This function is
4318 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4319 * only, and would normally not be used by applications.
4320 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4321 * a pointer to an AVClass struct
4322 * @param[in] msg string containing an optional message, or NULL if no message
4324 void av_log_ask_for_sample(void *avc, const char *msg);
4327 * Register the hardware accelerator hwaccel.
4329 void av_register_hwaccel(AVHWAccel *hwaccel);
4332 * If hwaccel is NULL, returns the first registered hardware accelerator,
4333 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4334 * after hwaccel, or NULL if hwaccel is the last one.
4336 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4340 * Lock operation used by lockmgr
4343 AV_LOCK_CREATE, ///< Create a mutex
4344 AV_LOCK_OBTAIN, ///< Lock the mutex
4345 AV_LOCK_RELEASE, ///< Unlock the mutex
4346 AV_LOCK_DESTROY, ///< Free mutex resources
4350 * Register a user provided lock manager supporting the operations
4351 * specified by AVLockOp. mutex points to a (void *) where the
4352 * lockmgr should store/get a pointer to a user allocated mutex. It's
4353 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4355 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4356 * callback during the call to av_lockmgr_register().
4357 * Thus, the application must be prepared to handle that.
4358 * If cb is set to NULL the lockmgr will be unregistered.
4359 * Also note that during unregistration the previously registered
4360 * lockmgr callback may also be invoked.
4362 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4364 #endif /* AVCODEC_AVCODEC_H */