2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs.
57 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58 CODEC_ID_MPEG2VIDEO_XVMC,
95 CODEC_ID_INTERPLAY_VIDEO,
107 CODEC_ID_TRUEMOTION1,
134 CODEC_ID_TRUEMOTION2,
151 CODEC_ID_DSICINVIDEO,
152 CODEC_ID_TIERTEXSEQVIDEO,
161 CODEC_ID_BETHSOFTVID,
179 CODEC_ID_MOTIONPIXELS,
197 CODEC_ID_IFF_BYTERUN1,
216 /* various PCM "codecs" */
217 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
218 CODEC_ID_PCM_S16LE= 0x10000,
234 CODEC_ID_PCM_S24DAUD,
236 CODEC_ID_PCM_S16LE_PLANAR,
246 /* various ADPCM codecs */
247 CODEC_ID_ADPCM_IMA_QT= 0x11000,
248 CODEC_ID_ADPCM_IMA_WAV,
249 CODEC_ID_ADPCM_IMA_DK3,
250 CODEC_ID_ADPCM_IMA_DK4,
251 CODEC_ID_ADPCM_IMA_WS,
252 CODEC_ID_ADPCM_IMA_SMJPEG,
261 CODEC_ID_ADPCM_YAMAHA,
262 CODEC_ID_ADPCM_SBPRO_4,
263 CODEC_ID_ADPCM_SBPRO_3,
264 CODEC_ID_ADPCM_SBPRO_2,
266 CODEC_ID_ADPCM_IMA_AMV,
267 CODEC_ID_ADPCM_EA_R1,
268 CODEC_ID_ADPCM_EA_R3,
269 CODEC_ID_ADPCM_EA_R2,
270 CODEC_ID_ADPCM_IMA_EA_SEAD,
271 CODEC_ID_ADPCM_IMA_EA_EACS,
272 CODEC_ID_ADPCM_EA_XAS,
273 CODEC_ID_ADPCM_EA_MAXIS_XA,
274 CODEC_ID_ADPCM_IMA_ISS,
278 CODEC_ID_AMR_NB= 0x12000,
281 /* RealAudio codecs*/
282 CODEC_ID_RA_144= 0x13000,
285 /* various DPCM codecs */
286 CODEC_ID_ROQ_DPCM= 0x14000,
287 CODEC_ID_INTERPLAY_DPCM,
292 CODEC_ID_MP2= 0x15000,
293 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
311 CODEC_ID_WESTWOOD_SND1,
312 CODEC_ID_GSM, ///< as in Berlin toast format
320 CODEC_ID_DSICINAUDIO,
324 CODEC_ID_GSM_MS, /* as found in WAV */
333 CODEC_ID_WMALOSSLESS,
342 CODEC_ID_BINKAUDIO_RDFT,
343 CODEC_ID_BINKAUDIO_DCT,
348 /* subtitle codecs */
349 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
350 CODEC_ID_DVD_SUBTITLE= 0x17000,
351 CODEC_ID_DVB_SUBTITLE,
352 CODEC_ID_TEXT, ///< raw UTF-8 text
356 CODEC_ID_HDMV_PGS_SUBTITLE,
357 CODEC_ID_DVB_TELETEXT,
361 /* other specific kind of codecs (generally used for attachments) */
362 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
363 CODEC_ID_TTF= 0x18000,
365 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
367 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
368 * stream (only used by libavformat) */
369 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
372 #if FF_API_OLD_SAMPLE_FMT
373 #define SampleFormat AVSampleFormat
375 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
376 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
377 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
378 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
379 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
380 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
381 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
384 #if FF_API_OLD_AUDIOCONVERT
385 #include "libavutil/audioconvert.h"
387 /* Audio channel masks */
388 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
389 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
390 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
391 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
392 #define CH_BACK_LEFT AV_CH_BACK_LEFT
393 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
394 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
395 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
396 #define CH_BACK_CENTER AV_CH_BACK_CENTER
397 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
398 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
399 #define CH_TOP_CENTER AV_CH_TOP_CENTER
400 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
401 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
402 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
403 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
404 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
405 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
406 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
407 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
409 /** Channel mask value used for AVCodecContext.request_channel_layout
410 to indicate that the user requests the channel order of the decoder output
411 to be the native codec channel order. */
412 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
414 /* Audio channel convenience macros */
415 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
416 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
417 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
418 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
419 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
420 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
421 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
422 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
423 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
424 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
425 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
426 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
427 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
428 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
429 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
433 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
436 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
437 * This is mainly needed because some optimized bitstream readers read
438 * 32 or 64 bit at once and could read over the end.<br>
439 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
440 * MPEG bitstreams could cause overread and segfault.
442 #define FF_INPUT_BUFFER_PADDING_SIZE 16
445 * minimum encoding buffer size
446 * Used to avoid some checks during header writing.
448 #define FF_MIN_BUFFER_SIZE 16384
452 * motion estimation type.
455 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
459 ME_EPZS, ///< enhanced predictive zonal search
460 ME_X1, ///< reserved for experiments
461 ME_HEX, ///< hexagon based search
462 ME_UMH, ///< uneven multi-hexagon search
463 ME_ITER, ///< iterative search
464 ME_TESA, ///< transformed exhaustive search algorithm
468 /* We leave some space between them for extensions (drop some
469 * keyframes for intra-only or drop just some bidir frames). */
470 AVDISCARD_NONE =-16, ///< discard nothing
471 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
472 AVDISCARD_NONREF = 8, ///< discard all non reference
473 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
474 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
475 AVDISCARD_ALL = 48, ///< discard all
478 enum AVColorPrimaries{
479 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
480 AVCOL_PRI_UNSPECIFIED=2,
482 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
483 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
484 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
486 AVCOL_PRI_NB , ///< Not part of ABI
489 enum AVColorTransferCharacteristic{
490 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
491 AVCOL_TRC_UNSPECIFIED=2,
492 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
493 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
494 AVCOL_TRC_NB , ///< Not part of ABI
499 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
500 AVCOL_SPC_UNSPECIFIED=2,
502 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
503 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
504 AVCOL_SPC_SMPTE240M =7,
505 AVCOL_SPC_NB , ///< Not part of ABI
509 AVCOL_RANGE_UNSPECIFIED=0,
510 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
511 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
512 AVCOL_RANGE_NB , ///< Not part of ABI
516 * X X 3 4 X X are luma samples,
517 * 1 2 1-6 are possible chroma positions
518 * X X 5 6 X 0 is undefined/unknown position
520 enum AVChromaLocation{
521 AVCHROMA_LOC_UNSPECIFIED=0,
522 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
523 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
524 AVCHROMA_LOC_TOPLEFT =3, ///< DV
526 AVCHROMA_LOC_BOTTOMLEFT =5,
527 AVCHROMA_LOC_BOTTOM =6,
528 AVCHROMA_LOC_NB , ///< Not part of ABI
531 #if FF_API_FLAC_GLOBAL_OPTS
535 attribute_deprecated enum AVLPCType {
536 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
537 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
538 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
539 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
540 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
541 AV_LPC_TYPE_NB , ///< Not part of ABI
545 enum AVAudioServiceType {
546 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
547 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
548 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
549 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
550 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
551 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
552 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
553 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
554 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
555 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
558 typedef struct RcOverride{
561 int qscale; // If this is 0 then quality_factor will be used instead.
562 float quality_factor;
565 #define FF_MAX_B_FRAMES 16
568 These flags can be passed in AVCodecContext.flags before initialization.
569 Note: Not everything is supported yet.
572 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
573 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
574 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
575 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
576 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
578 * The parent program guarantees that the input for B-frames containing
579 * streams is not written to for at least s->max_b_frames+1 frames, if
580 * this is not set the input will be copied.
582 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
583 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
584 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
585 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
586 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
587 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
588 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
589 location instead of only at frame boundaries. */
590 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
591 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
592 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
593 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
594 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
595 /* Fx : Flag for h263+ extra options */
596 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
597 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
598 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
599 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
600 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
601 #define CODEC_FLAG_CLOSED_GOP 0x80000000
602 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
603 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
604 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
605 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
606 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
607 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
609 * @defgroup deprecated_flags Deprecated codec flags
610 * Use corresponding private codec options instead.
613 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
614 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
615 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
616 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
617 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
618 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
619 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
620 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
621 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
622 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
623 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
625 #if FF_API_MJPEG_GLOBAL_OPTS
626 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
628 #if FF_API_X264_GLOBAL_OPTS
629 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
630 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
631 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
632 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
633 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
634 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
635 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
636 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
637 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
638 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
639 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
641 #if FF_API_SNOW_GLOBAL_OPTS
642 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
644 #if FF_API_LAME_GLOBAL_OPTS
645 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
651 /* Unsupported options :
652 * Syntax Arithmetic coding (SAC)
653 * Reference Picture Selection
654 * Independent Segment Decoding */
656 /* codec capabilities */
658 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
660 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
661 * If not set, it might not use get_buffer() at all or use operations that
662 * assume the buffer was allocated by avcodec_default_get_buffer.
664 #define CODEC_CAP_DR1 0x0002
665 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
666 #define CODEC_CAP_PARSE_ONLY 0x0004
667 #define CODEC_CAP_TRUNCATED 0x0008
668 /* Codec can export data for HW decoding (XvMC). */
669 #define CODEC_CAP_HWACCEL 0x0010
671 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
672 * If this is not set, the codec is guaranteed to never be fed with NULL data.
674 #define CODEC_CAP_DELAY 0x0020
676 * Codec can be fed a final frame with a smaller size.
677 * This can be used to prevent truncation of the last audio samples.
679 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
681 * Codec can export data for HW decoding (VDPAU).
683 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
685 * Codec can output multiple frames per AVPacket
686 * Normally demuxers return one frame at a time, demuxers which do not do
687 * are connected to a parser to split what they return into proper frames.
688 * This flag is reserved to the very rare category of codecs which have a
689 * bitstream that cannot be split into frames without timeconsuming
690 * operations like full decoding. Demuxers carring such bitstreams thus
691 * may return multiple frames in a packet. This has many disadvantages like
692 * prohibiting stream copy in many cases thus it should only be considered
695 #define CODEC_CAP_SUBFRAMES 0x0100
697 * Codec is experimental and is thus avoided in favor of non experimental
700 #define CODEC_CAP_EXPERIMENTAL 0x0200
702 * Codec should fill in channel configuration and samplerate instead of container
704 #define CODEC_CAP_CHANNEL_CONF 0x0400
707 * Codec is able to deal with negative linesizes
709 #define CODEC_CAP_NEG_LINESIZES 0x0800
712 * Codec supports frame-level multithreading.
714 #define CODEC_CAP_FRAME_THREADS 0x1000
716 * Codec supports slice-based (or partition-based) multithreading.
718 #define CODEC_CAP_SLICE_THREADS 0x2000
722 #define CODEC_CAP_LOSSLESS 0x80000000
724 //The following defines may change, don't expect compatibility if you use them.
725 #define MB_TYPE_INTRA4x4 0x0001
726 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
727 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
728 #define MB_TYPE_16x16 0x0008
729 #define MB_TYPE_16x8 0x0010
730 #define MB_TYPE_8x16 0x0020
731 #define MB_TYPE_8x8 0x0040
732 #define MB_TYPE_INTERLACED 0x0080
733 #define MB_TYPE_DIRECT2 0x0100 //FIXME
734 #define MB_TYPE_ACPRED 0x0200
735 #define MB_TYPE_GMC 0x0400
736 #define MB_TYPE_SKIP 0x0800
737 #define MB_TYPE_P0L0 0x1000
738 #define MB_TYPE_P1L0 0x2000
739 #define MB_TYPE_P0L1 0x4000
740 #define MB_TYPE_P1L1 0x8000
741 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
742 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
743 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
744 #define MB_TYPE_QUANT 0x00010000
745 #define MB_TYPE_CBP 0x00020000
746 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
750 * This specifies the area which should be displayed.
751 * Note there may be multiple such areas for one frame.
753 typedef struct AVPanScan{
756 * - encoding: Set by user.
757 * - decoding: Set by libavcodec.
762 * width and height in 1/16 pel
763 * - encoding: Set by user.
764 * - decoding: Set by libavcodec.
770 * position of the top left corner in 1/16 pel for up to 3 fields/frames
771 * - encoding: Set by user.
772 * - decoding: Set by libavcodec.
774 int16_t position[3][2];
777 #define FF_QSCALE_TYPE_MPEG1 0
778 #define FF_QSCALE_TYPE_MPEG2 1
779 #define FF_QSCALE_TYPE_H264 2
780 #define FF_QSCALE_TYPE_VP56 3
782 #define FF_BUFFER_TYPE_INTERNAL 1
783 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
784 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
785 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
787 #if FF_API_OLD_FF_PICT_TYPES
788 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
789 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
790 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
791 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
792 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
793 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
794 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
795 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
798 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
799 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
800 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
801 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
803 enum AVPacketSideDataType {
807 typedef struct AVPacket {
809 * Presentation timestamp in AVStream->time_base units; the time at which
810 * the decompressed packet will be presented to the user.
811 * Can be AV_NOPTS_VALUE if it is not stored in the file.
812 * pts MUST be larger or equal to dts as presentation cannot happen before
813 * decompression, unless one wants to view hex dumps. Some formats misuse
814 * the terms dts and pts/cts to mean something different. Such timestamps
815 * must be converted to true pts/dts before they are stored in AVPacket.
819 * Decompression timestamp in AVStream->time_base units; the time at which
820 * the packet is decompressed.
821 * Can be AV_NOPTS_VALUE if it is not stored in the file.
828 * A combination of AV_PKT_FLAG values
832 * Additional packet data that can be provided by the container.
833 * Packet can contain several types of side information.
838 enum AVPacketSideDataType type;
843 * Duration of this packet in AVStream->time_base units, 0 if unknown.
844 * Equals next_pts - this_pts in presentation order.
847 void (*destruct)(struct AVPacket *);
849 int64_t pos; ///< byte position in stream, -1 if unknown
852 * Time difference in AVStream->time_base units from the pts of this
853 * packet to the point at which the output from the decoder has converged
854 * independent from the availability of previous frames. That is, the
855 * frames are virtually identical no matter if decoding started from
856 * the very first frame or from this keyframe.
857 * Is AV_NOPTS_VALUE if unknown.
858 * This field is not the display duration of the current packet.
859 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
862 * The purpose of this field is to allow seeking in streams that have no
863 * keyframes in the conventional sense. It corresponds to the
864 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
865 * essential for some types of subtitle streams to ensure that all
866 * subtitles are correctly displayed after seeking.
868 int64_t convergence_duration;
870 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
871 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
875 * New fields can be added to the end of AVFRAME with minor version
876 * bumps. Removal, reordering and changes to existing fields require
877 * a major version bump.
878 * sizeof(AVFrame) must not be used outside libav*.
880 typedef struct AVFrame {
882 * pointer to the picture planes.
883 * This might be different from the first allocated byte
890 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
891 * This isn't used by libavcodec unless the default get/release_buffer() is used.
897 * 1 -> keyframe, 0-> not
898 * - encoding: Set by libavcodec.
899 * - decoding: Set by libavcodec.
904 * Picture type of the frame, see ?_TYPE below.
905 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
906 * - decoding: Set by libavcodec.
908 enum AVPictureType pict_type;
911 * presentation timestamp in time_base units (time when frame should be shown to user)
912 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
913 * - encoding: MUST be set by user.
914 * - decoding: Set by libavcodec.
919 * picture number in bitstream order
921 * - decoding: Set by libavcodec.
923 int coded_picture_number;
925 * picture number in display order
927 * - decoding: Set by libavcodec.
929 int display_picture_number;
932 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
933 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
934 * - decoding: Set by libavcodec.
939 * buffer age (1->was last buffer and dint change, 2->..., ...).
940 * Set to INT_MAX if the buffer has not been used yet.
942 * - decoding: MUST be set by get_buffer().
947 * is this picture used as reference
948 * The values for this are the same as the MpegEncContext.picture_structure
949 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
950 * Set to 4 for delayed, non-reference frames.
952 * - decoding: Set by libavcodec. (before get_buffer() call)).
959 * - decoding: Set by libavcodec.
961 int8_t *qscale_table;
965 * - decoding: Set by libavcodec.
970 * mbskip_table[mb]>=1 if MB didn't change
971 * stride= mb_width = (width+15)>>4
973 * - decoding: Set by libavcodec.
975 uint8_t *mbskip_table;
978 * motion vector table
981 * int mv_sample_log2= 4 - motion_subsample_log2;
982 * int mb_width= (width+15)>>4;
983 * int mv_stride= (mb_width << mv_sample_log2) + 1;
984 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
986 * - encoding: Set by user.
987 * - decoding: Set by libavcodec.
989 int16_t (*motion_val[2])[2];
992 * macroblock type table
993 * mb_type_base + mb_width + 2
994 * - encoding: Set by user.
995 * - decoding: Set by libavcodec.
1000 * log2 of the size of the block which a single vector in motion_val represents:
1001 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1002 * - encoding: unused
1003 * - decoding: Set by libavcodec.
1005 uint8_t motion_subsample_log2;
1008 * for some private data of the user
1009 * - encoding: unused
1010 * - decoding: Set by user.
1016 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1017 * - decoding: unused
1022 * type of the buffer (to keep track of who has to deallocate data[*])
1023 * - encoding: Set by the one who allocates it.
1024 * - decoding: Set by the one who allocates it.
1025 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1030 * When decoding, this signals how much the picture must be delayed.
1031 * extra_delay = repeat_pict / (2*fps)
1032 * - encoding: unused
1033 * - decoding: Set by libavcodec.
1043 * The content of the picture is interlaced.
1044 * - encoding: Set by user.
1045 * - decoding: Set by libavcodec. (default 0)
1047 int interlaced_frame;
1050 * If the content is interlaced, is top field displayed first.
1051 * - encoding: Set by user.
1052 * - decoding: Set by libavcodec.
1054 int top_field_first;
1058 * - encoding: Set by user.
1059 * - decoding: Set by libavcodec.
1061 AVPanScan *pan_scan;
1064 * Tell user application that palette has changed from previous frame.
1065 * - encoding: ??? (no palette-enabled encoder yet)
1066 * - decoding: Set by libavcodec. (default 0).
1068 int palette_has_changed;
1071 * codec suggestion on buffer type if != 0
1072 * - encoding: unused
1073 * - decoding: Set by libavcodec. (before get_buffer() call)).
1079 * - encoding: unused
1080 * - decoding: Set by libavcodec.
1085 * motion reference frame index
1086 * the order in which these are stored can depend on the codec.
1087 * - encoding: Set by user.
1088 * - decoding: Set by libavcodec.
1090 int8_t *ref_index[2];
1093 * reordered opaque 64bit (generally an integer or a double precision float
1094 * PTS but can be anything).
1095 * The user sets AVCodecContext.reordered_opaque to represent the input at
1097 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1098 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1099 * @deprecated in favor of pkt_pts
1100 * - encoding: unused
1101 * - decoding: Read by user.
1103 int64_t reordered_opaque;
1106 * hardware accelerator private data (FFmpeg-allocated)
1107 * - encoding: unused
1108 * - decoding: Set by libavcodec
1110 void *hwaccel_picture_private;
1113 * reordered pts from the last AVPacket that has been input into the decoder
1114 * - encoding: unused
1115 * - decoding: Read by user.
1120 * dts from the last AVPacket that has been input into the decoder
1121 * - encoding: unused
1122 * - decoding: Read by user.
1127 * the AVCodecContext which ff_thread_get_buffer() was last called on
1128 * - encoding: Set by libavcodec.
1129 * - decoding: Set by libavcodec.
1131 struct AVCodecContext *owner;
1134 * used by multithreading to store frame-specific info
1135 * - encoding: Set by libavcodec.
1136 * - decoding: Set by libavcodec.
1138 void *thread_opaque;
1141 * frame timestamp estimated using various heuristics, in stream time base
1142 * - encoding: unused
1143 * - decoding: set by libavcodec, read by user.
1145 int64_t best_effort_timestamp;
1148 * reordered pos from the last AVPacket that has been input into the decoder
1149 * - encoding: unused
1150 * - decoding: Read by user.
1155 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1156 * - encoding: unused
1157 * - decoding: Read by user.
1159 AVRational sample_aspect_ratio;
1162 * width and height of the video frame
1163 * - encoding: unused
1164 * - decoding: Read by user.
1169 * format of the frame, -1 if unknown or unset
1170 * It should be cast to the corresponding enum (enum PixelFormat
1171 * for video, enum AVSampleFormat for audio)
1172 * - encoding: unused
1173 * - decoding: Read by user.
1180 * main external API structure.
1181 * New fields can be added to the end with minor version bumps.
1182 * Removal, reordering and changes to existing fields require a major
1184 * sizeof(AVCodecContext) must not be used outside libav*.
1186 typedef struct AVCodecContext {
1188 * information on struct for av_log
1189 * - set by avcodec_alloc_context
1191 const AVClass *av_class;
1193 * the average bitrate
1194 * - encoding: Set by user; unused for constant quantizer encoding.
1195 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1200 * number of bits the bitstream is allowed to diverge from the reference.
1201 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1202 * - encoding: Set by user; unused for constant quantizer encoding.
1203 * - decoding: unused
1205 int bit_rate_tolerance;
1209 * - encoding: Set by user.
1210 * - decoding: Set by user.
1215 * Some codecs need additional format info. It is stored here.
1216 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1217 * specific codec MUST set it correctly otherwise stream copy breaks.
1218 * In general use of this field by muxers is not recommanded.
1219 * - encoding: Set by libavcodec.
1220 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1225 * Motion estimation algorithm used for video coding.
1226 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1227 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1228 * - encoding: MUST be set by user.
1229 * - decoding: unused
1234 * some codecs need / can use extradata like Huffman tables.
1235 * mjpeg: Huffman tables
1236 * rv10: additional flags
1237 * mpeg4: global headers (they can be in the bitstream or here)
1238 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1239 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1240 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1241 * - encoding: Set/allocated/freed by libavcodec.
1242 * - decoding: Set/allocated/freed by user.
1248 * This is the fundamental unit of time (in seconds) in terms
1249 * of which frame timestamps are represented. For fixed-fps content,
1250 * timebase should be 1/framerate and timestamp increments should be
1252 * - encoding: MUST be set by user.
1253 * - decoding: Set by libavcodec.
1255 AVRational time_base;
1259 * picture width / height.
1260 * - encoding: MUST be set by user.
1261 * - decoding: Set by libavcodec.
1262 * Note: For compatibility it is possible to set this instead of
1263 * coded_width/height before decoding.
1267 #define FF_ASPECT_EXTENDED 15
1270 * the number of pictures in a group of pictures, or 0 for intra_only
1271 * - encoding: Set by user.
1272 * - decoding: unused
1277 * Pixel format, see PIX_FMT_xxx.
1278 * May be set by the demuxer if known from headers.
1279 * May be overriden by the decoder if it knows better.
1280 * - encoding: Set by user.
1281 * - decoding: Set by user if known, overridden by libavcodec if known
1283 enum PixelFormat pix_fmt;
1286 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1287 * decoder to draw a horizontal band. It improves cache usage. Not
1288 * all codecs can do that. You must check the codec capabilities
1290 * When multithreading is used, it may be called from multiple threads
1291 * at the same time; threads might draw different parts of the same AVFrame,
1292 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1294 * The function is also used by hardware acceleration APIs.
1295 * It is called at least once during frame decoding to pass
1296 * the data needed for hardware render.
1297 * In that mode instead of pixel data, AVFrame points to
1298 * a structure specific to the acceleration API. The application
1299 * reads the structure and can change some fields to indicate progress
1301 * - encoding: unused
1302 * - decoding: Set by user.
1303 * @param height the height of the slice
1304 * @param y the y position of the slice
1305 * @param type 1->top field, 2->bottom field, 3->frame
1306 * @param offset offset into the AVFrame.data from which the slice should be read
1308 void (*draw_horiz_band)(struct AVCodecContext *s,
1309 const AVFrame *src, int offset[4],
1310 int y, int type, int height);
1313 int sample_rate; ///< samples per second
1314 int channels; ///< number of audio channels
1317 * audio sample format
1318 * - encoding: Set by user.
1319 * - decoding: Set by libavcodec.
1321 enum AVSampleFormat sample_fmt; ///< sample format
1323 /* The following data should not be initialized. */
1325 * Samples per packet, initialized when calling 'init'.
1328 int frame_number; ///< audio or video frame number
1331 * Number of frames the decoded output will be delayed relative to
1332 * the encoded input.
1333 * - encoding: Set by libavcodec.
1334 * - decoding: unused
1338 /* - encoding parameters */
1339 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1340 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1344 * - encoding: Set by user.
1345 * - decoding: unused
1351 * - encoding: Set by user.
1352 * - decoding: unused
1357 * maximum quantizer difference between frames
1358 * - encoding: Set by user.
1359 * - decoding: unused
1364 * maximum number of B-frames between non-B-frames
1365 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1366 * - encoding: Set by user.
1367 * - decoding: unused
1372 * qscale factor between IP and B-frames
1373 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1374 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1375 * - encoding: Set by user.
1376 * - decoding: unused
1378 float b_quant_factor;
1380 /** obsolete FIXME remove */
1382 #define FF_RC_STRATEGY_XVID 1
1384 int b_frame_strategy;
1386 struct AVCodec *codec;
1390 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1391 /* do its best to deliver a chunk with size */
1392 /* below rtp_payload_size, the chunk will start */
1393 /* with a start code on some codecs like H.263. */
1394 /* This doesn't take account of any particular */
1395 /* headers inside the transmitted RTP payload. */
1398 /* The RTP callback: This function is called */
1399 /* every time the encoder has a packet to send. */
1400 /* It depends on the encoder if the data starts */
1401 /* with a Start Code (it should). H.263 does. */
1402 /* mb_nb contains the number of macroblocks */
1403 /* encoded in the RTP payload. */
1404 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1406 /* statistics, used for 2-pass encoding */
1417 * number of bits used for the previously encoded frame
1418 * - encoding: Set by libavcodec.
1419 * - decoding: unused
1424 * Private data of the user, can be used to carry app specific stuff.
1425 * - encoding: Set by user.
1426 * - decoding: Set by user.
1430 char codec_name[32];
1431 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1432 enum CodecID codec_id; /* see CODEC_ID_xxx */
1435 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1436 * This is used to work around some encoder bugs.
1437 * A demuxer should set this to what is stored in the field used to identify the codec.
1438 * If there are multiple such fields in a container then the demuxer should choose the one
1439 * which maximizes the information about the used codec.
1440 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1441 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1442 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1444 * - encoding: Set by user, if not then the default based on codec_id will be used.
1445 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1447 unsigned int codec_tag;
1450 * Work around bugs in encoders which sometimes cannot be detected automatically.
1451 * - encoding: Set by user
1452 * - decoding: Set by user
1454 int workaround_bugs;
1455 #define FF_BUG_AUTODETECT 1 ///< autodetection
1456 #define FF_BUG_OLD_MSMPEG4 2
1457 #define FF_BUG_XVID_ILACE 4
1458 #define FF_BUG_UMP4 8
1459 #define FF_BUG_NO_PADDING 16
1460 #define FF_BUG_AMV 32
1461 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1462 #define FF_BUG_QPEL_CHROMA 64
1463 #define FF_BUG_STD_QPEL 128
1464 #define FF_BUG_QPEL_CHROMA2 256
1465 #define FF_BUG_DIRECT_BLOCKSIZE 512
1466 #define FF_BUG_EDGE 1024
1467 #define FF_BUG_HPEL_CHROMA 2048
1468 #define FF_BUG_DC_CLIP 4096
1469 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1470 #define FF_BUG_TRUNCATED 16384
1471 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1474 * luma single coefficient elimination threshold
1475 * - encoding: Set by user.
1476 * - decoding: unused
1478 int luma_elim_threshold;
1481 * chroma single coeff elimination threshold
1482 * - encoding: Set by user.
1483 * - decoding: unused
1485 int chroma_elim_threshold;
1488 * strictly follow the standard (MPEG4, ...).
1489 * - encoding: Set by user.
1490 * - decoding: Set by user.
1491 * Setting this to STRICT or higher means the encoder and decoder will
1492 * generally do stupid things, whereas setting it to unofficial or lower
1493 * will mean the encoder might produce output that is not supported by all
1494 * spec-compliant decoders. Decoders don't differentiate between normal,
1495 * unofficial and experimental (that is, they always try to decode things
1496 * when they can) unless they are explicitly asked to behave stupidly
1497 * (=strictly conform to the specs)
1499 int strict_std_compliance;
1500 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1501 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1502 #define FF_COMPLIANCE_NORMAL 0
1503 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1504 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1507 * qscale offset between IP and B-frames
1508 * - encoding: Set by user.
1509 * - decoding: unused
1511 float b_quant_offset;
1514 * Error recognition; higher values will detect more errors but may
1515 * misdetect some more or less valid parts as errors.
1516 * - encoding: unused
1517 * - decoding: Set by user.
1519 int error_recognition;
1520 #define FF_ER_CAREFUL 1
1521 #define FF_ER_COMPLIANT 2
1522 #define FF_ER_AGGRESSIVE 3
1523 #if FF_API_VERY_AGGRESSIVE
1524 #define FF_ER_VERY_AGGRESSIVE 4
1525 #define FF_ER_EXPLODE 5
1527 #define FF_ER_EXPLODE 4
1528 #endif /* FF_API_VERY_AGGRESSIVE */
1531 * Called at the beginning of each frame to get a buffer for it.
1532 * If pic.reference is set then the frame will be read later by libavcodec.
1533 * avcodec_align_dimensions2() should be used to find the required width and
1534 * height, as they normally need to be rounded up to the next multiple of 16.
1535 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1536 * avcodec_default_get_buffer() instead of providing buffers allocated by
1538 * If frame multithreading is used and thread_safe_callbacks is set,
1539 * it may be called from a different thread, but not from more than one at once.
1540 * Does not need to be reentrant.
1541 * - encoding: unused
1542 * - decoding: Set by libavcodec, user can override.
1544 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1547 * Called to release buffers which were allocated with get_buffer.
1548 * A released buffer can be reused in get_buffer().
1549 * pic.data[*] must be set to NULL.
1550 * May be called from a different thread if frame multithreading is used,
1551 * but not by more than one thread at once, so does not need to be reentrant.
1552 * - encoding: unused
1553 * - decoding: Set by libavcodec, user can override.
1555 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1558 * Size of the frame reordering buffer in the decoder.
1559 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1560 * - encoding: Set by libavcodec.
1561 * - decoding: Set by libavcodec.
1566 * number of bytes per packet if constant and known or 0
1567 * Used by some WAV based audio codecs.
1571 int parse_only; /* - decoding only: If true, only parsing is done
1572 (function avcodec_parse_frame()). The frame
1573 data is returned. Only MPEG codecs support this now. */
1576 * 0-> h263 quant 1-> mpeg quant
1577 * - encoding: Set by user.
1578 * - decoding: unused
1583 * pass1 encoding statistics output buffer
1584 * - encoding: Set by libavcodec.
1585 * - decoding: unused
1590 * pass2 encoding statistics input buffer
1591 * Concatenated stuff from stats_out of pass1 should be placed here.
1592 * - encoding: Allocated/set/freed by user.
1593 * - decoding: unused
1598 * ratecontrol qmin qmax limiting method
1599 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1600 * - encoding: Set by user.
1601 * - decoding: unused
1609 * ratecontrol override, see RcOverride
1610 * - encoding: Allocated/set/freed by user.
1611 * - decoding: unused
1613 RcOverride *rc_override;
1614 int rc_override_count;
1617 * rate control equation
1618 * - encoding: Set by user
1619 * - decoding: unused
1625 * - encoding: Set by user.
1626 * - decoding: unused
1632 * - encoding: Set by user.
1633 * - decoding: unused
1638 * decoder bitstream buffer size
1639 * - encoding: Set by user.
1640 * - decoding: unused
1643 float rc_buffer_aggressivity;
1646 * qscale factor between P and I-frames
1647 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1648 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1649 * - encoding: Set by user.
1650 * - decoding: unused
1652 float i_quant_factor;
1655 * qscale offset between P and I-frames
1656 * - encoding: Set by user.
1657 * - decoding: unused
1659 float i_quant_offset;
1662 * initial complexity for pass1 ratecontrol
1663 * - encoding: Set by user.
1664 * - decoding: unused
1666 float rc_initial_cplx;
1669 * DCT algorithm, see FF_DCT_* below
1670 * - encoding: Set by user.
1671 * - decoding: unused
1674 #define FF_DCT_AUTO 0
1675 #define FF_DCT_FASTINT 1
1676 #define FF_DCT_INT 2
1677 #define FF_DCT_MMX 3
1678 #define FF_DCT_MLIB 4
1679 #define FF_DCT_ALTIVEC 5
1680 #define FF_DCT_FAAN 6
1683 * luminance masking (0-> disabled)
1684 * - encoding: Set by user.
1685 * - decoding: unused
1690 * temporary complexity masking (0-> disabled)
1691 * - encoding: Set by user.
1692 * - decoding: unused
1694 float temporal_cplx_masking;
1697 * spatial complexity masking (0-> disabled)
1698 * - encoding: Set by user.
1699 * - decoding: unused
1701 float spatial_cplx_masking;
1704 * p block masking (0-> disabled)
1705 * - encoding: Set by user.
1706 * - decoding: unused
1711 * darkness masking (0-> disabled)
1712 * - encoding: Set by user.
1713 * - decoding: unused
1718 * IDCT algorithm, see FF_IDCT_* below.
1719 * - encoding: Set by user.
1720 * - decoding: Set by user.
1723 #define FF_IDCT_AUTO 0
1724 #define FF_IDCT_INT 1
1725 #define FF_IDCT_SIMPLE 2
1726 #define FF_IDCT_SIMPLEMMX 3
1727 #define FF_IDCT_LIBMPEG2MMX 4
1728 #define FF_IDCT_PS2 5
1729 #define FF_IDCT_MLIB 6
1730 #define FF_IDCT_ARM 7
1731 #define FF_IDCT_ALTIVEC 8
1732 #define FF_IDCT_SH4 9
1733 #define FF_IDCT_SIMPLEARM 10
1734 #define FF_IDCT_H264 11
1735 #define FF_IDCT_VP3 12
1736 #define FF_IDCT_IPP 13
1737 #define FF_IDCT_XVIDMMX 14
1738 #define FF_IDCT_CAVS 15
1739 #define FF_IDCT_SIMPLEARMV5TE 16
1740 #define FF_IDCT_SIMPLEARMV6 17
1741 #define FF_IDCT_SIMPLEVIS 18
1742 #define FF_IDCT_WMV2 19
1743 #define FF_IDCT_FAAN 20
1744 #define FF_IDCT_EA 21
1745 #define FF_IDCT_SIMPLENEON 22
1746 #define FF_IDCT_SIMPLEALPHA 23
1747 #define FF_IDCT_BINK 24
1751 * - encoding: Set by libavcodec.
1752 * - decoding: Set by user (or 0).
1756 * slice offsets in the frame in bytes
1757 * - encoding: Set/allocated by libavcodec.
1758 * - decoding: Set/allocated by user (or NULL).
1763 * error concealment flags
1764 * - encoding: unused
1765 * - decoding: Set by user.
1767 int error_concealment;
1768 #define FF_EC_GUESS_MVS 1
1769 #define FF_EC_DEBLOCK 2
1772 * dsp_mask could be add used to disable unwanted CPU features
1773 * CPU features (i.e. MMX, SSE. ...)
1775 * With the FORCE flag you may instead enable given CPU features.
1776 * (Dangerous: Usable in case of misdetection, improper usage however will
1777 * result into program crash.)
1782 * bits per sample/pixel from the demuxer (needed for huffyuv).
1783 * - encoding: Set by libavcodec.
1784 * - decoding: Set by user.
1786 int bits_per_coded_sample;
1789 * prediction method (needed for huffyuv)
1790 * - encoding: Set by user.
1791 * - decoding: unused
1793 int prediction_method;
1794 #define FF_PRED_LEFT 0
1795 #define FF_PRED_PLANE 1
1796 #define FF_PRED_MEDIAN 2
1799 * sample aspect ratio (0 if unknown)
1800 * That is the width of a pixel divided by the height of the pixel.
1801 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1802 * - encoding: Set by user.
1803 * - decoding: Set by libavcodec.
1805 AVRational sample_aspect_ratio;
1808 * the picture in the bitstream
1809 * - encoding: Set by libavcodec.
1810 * - decoding: Set by libavcodec.
1812 AVFrame *coded_frame;
1816 * - encoding: Set by user.
1817 * - decoding: Set by user.
1820 #define FF_DEBUG_PICT_INFO 1
1821 #define FF_DEBUG_RC 2
1822 #define FF_DEBUG_BITSTREAM 4
1823 #define FF_DEBUG_MB_TYPE 8
1824 #define FF_DEBUG_QP 16
1825 #define FF_DEBUG_MV 32
1826 #define FF_DEBUG_DCT_COEFF 0x00000040
1827 #define FF_DEBUG_SKIP 0x00000080
1828 #define FF_DEBUG_STARTCODE 0x00000100
1829 #define FF_DEBUG_PTS 0x00000200
1830 #define FF_DEBUG_ER 0x00000400
1831 #define FF_DEBUG_MMCO 0x00000800
1832 #define FF_DEBUG_BUGS 0x00001000
1833 #define FF_DEBUG_VIS_QP 0x00002000
1834 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1835 #define FF_DEBUG_BUFFERS 0x00008000
1836 #define FF_DEBUG_THREADS 0x00010000
1840 * - encoding: Set by user.
1841 * - decoding: Set by user.
1844 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1845 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1846 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1850 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1851 * - decoding: unused
1856 * motion estimation comparison function
1857 * - encoding: Set by user.
1858 * - decoding: unused
1862 * subpixel motion estimation comparison function
1863 * - encoding: Set by user.
1864 * - decoding: unused
1868 * macroblock comparison function (not supported yet)
1869 * - encoding: Set by user.
1870 * - decoding: unused
1874 * interlaced DCT comparison function
1875 * - encoding: Set by user.
1876 * - decoding: unused
1879 #define FF_CMP_SAD 0
1880 #define FF_CMP_SSE 1
1881 #define FF_CMP_SATD 2
1882 #define FF_CMP_DCT 3
1883 #define FF_CMP_PSNR 4
1884 #define FF_CMP_BIT 5
1886 #define FF_CMP_ZERO 7
1887 #define FF_CMP_VSAD 8
1888 #define FF_CMP_VSSE 9
1889 #define FF_CMP_NSSE 10
1890 #define FF_CMP_W53 11
1891 #define FF_CMP_W97 12
1892 #define FF_CMP_DCTMAX 13
1893 #define FF_CMP_DCT264 14
1894 #define FF_CMP_CHROMA 256
1897 * ME diamond size & shape
1898 * - encoding: Set by user.
1899 * - decoding: unused
1904 * amount of previous MV predictors (2a+1 x 2a+1 square)
1905 * - encoding: Set by user.
1906 * - decoding: unused
1908 int last_predictor_count;
1911 * prepass for motion estimation
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * motion estimation prepass comparison function
1919 * - encoding: Set by user.
1920 * - decoding: unused
1925 * ME prepass diamond size & shape
1926 * - encoding: Set by user.
1927 * - decoding: unused
1933 * - encoding: Set by user.
1934 * - decoding: unused
1936 int me_subpel_quality;
1939 * callback to negotiate the pixelFormat
1940 * @param fmt is the list of formats which are supported by the codec,
1941 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1942 * The first is always the native one.
1943 * @return the chosen format
1944 * - encoding: unused
1945 * - decoding: Set by user, if not set the native format will be chosen.
1947 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1950 * DTG active format information (additional aspect ratio
1951 * information only used in DVB MPEG-2 transport streams)
1954 * - encoding: unused
1955 * - decoding: Set by decoder.
1957 int dtg_active_format;
1958 #define FF_DTG_AFD_SAME 8
1959 #define FF_DTG_AFD_4_3 9
1960 #define FF_DTG_AFD_16_9 10
1961 #define FF_DTG_AFD_14_9 11
1962 #define FF_DTG_AFD_4_3_SP_14_9 13
1963 #define FF_DTG_AFD_16_9_SP_14_9 14
1964 #define FF_DTG_AFD_SP_4_3 15
1967 * maximum motion estimation search range in subpel units
1968 * If 0 then no limit.
1970 * - encoding: Set by user.
1971 * - decoding: unused
1976 * intra quantizer bias
1977 * - encoding: Set by user.
1978 * - decoding: unused
1980 int intra_quant_bias;
1981 #define FF_DEFAULT_QUANT_BIAS 999999
1984 * inter quantizer bias
1985 * - encoding: Set by user.
1986 * - decoding: unused
1988 int inter_quant_bias;
1992 * - encoding: unused
1993 * - decoding: Which clrtable should be used for 8bit RGB images.
1994 * Tables have to be stored somewhere. FIXME
1999 * internal_buffer count
2000 * Don't touch, used by libavcodec default_get_buffer().
2002 int internal_buffer_count;
2006 * Don't touch, used by libavcodec default_get_buffer().
2008 void *internal_buffer;
2011 * Global quality for codecs which cannot change it per frame.
2012 * This should be proportional to MPEG-1/2/4 qscale.
2013 * - encoding: Set by user.
2014 * - decoding: unused
2018 #define FF_CODER_TYPE_VLC 0
2019 #define FF_CODER_TYPE_AC 1
2020 #define FF_CODER_TYPE_RAW 2
2021 #define FF_CODER_TYPE_RLE 3
2022 #define FF_CODER_TYPE_DEFLATE 4
2025 * - encoding: Set by user.
2026 * - decoding: unused
2032 * - encoding: Set by user.
2033 * - decoding: unused
2039 * - encoding: unused
2040 * - decoding: Set by user.
2042 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2047 * - encoding: unused
2048 * - decoding: Set by user.
2051 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2052 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2053 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2056 * XVideo Motion Acceleration
2057 * - encoding: forbidden
2058 * - decoding: set by decoder
2060 int xvmc_acceleration;
2063 * macroblock decision mode
2064 * - encoding: Set by user.
2065 * - decoding: unused
2068 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2069 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2070 #define FF_MB_DECISION_RD 2 ///< rate distortion
2073 * custom intra quantization matrix
2074 * - encoding: Set by user, can be NULL.
2075 * - decoding: Set by libavcodec.
2077 uint16_t *intra_matrix;
2080 * custom inter quantization matrix
2081 * - encoding: Set by user, can be NULL.
2082 * - decoding: Set by libavcodec.
2084 uint16_t *inter_matrix;
2087 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2088 * This is used to work around some encoder bugs.
2089 * - encoding: unused
2090 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2092 unsigned int stream_codec_tag;
2095 * scene change detection threshold
2096 * 0 is default, larger means fewer detected scene changes.
2097 * - encoding: Set by user.
2098 * - decoding: unused
2100 int scenechange_threshold;
2103 * minimum Lagrange multipler
2104 * - encoding: Set by user.
2105 * - decoding: unused
2110 * maximum Lagrange multipler
2111 * - encoding: Set by user.
2112 * - decoding: unused
2116 #if FF_API_PALETTE_CONTROL
2118 * palette control structure
2119 * - encoding: ??? (no palette-enabled encoder yet)
2120 * - decoding: Set by user.
2122 struct AVPaletteControl *palctrl;
2126 * noise reduction strength
2127 * - encoding: Set by user.
2128 * - decoding: unused
2130 int noise_reduction;
2133 * Called at the beginning of a frame to get cr buffer for it.
2134 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2135 * libavcodec will pass previous buffer in pic, function should return
2136 * same buffer or new buffer with old frame "painted" into it.
2137 * If pic.data[0] == NULL must behave like get_buffer().
2138 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2139 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2141 * - encoding: unused
2142 * - decoding: Set by libavcodec, user can override.
2144 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2147 * Number of bits which should be loaded into the rc buffer before decoding starts.
2148 * - encoding: Set by user.
2149 * - decoding: unused
2151 int rc_initial_buffer_occupancy;
2155 * - encoding: Set by user.
2156 * - decoding: unused
2158 int inter_threshold;
2162 * - encoding: Set by user.
2163 * - decoding: Set by user.
2168 * Simulates errors in the bitstream to test error concealment.
2169 * - encoding: Set by user.
2170 * - decoding: unused
2174 #if FF_API_ANTIALIAS_ALGO
2176 * MP3 antialias algorithm, see FF_AA_* below.
2177 * - encoding: unused
2178 * - decoding: Set by user.
2180 attribute_deprecated int antialias_algo;
2181 #define FF_AA_AUTO 0
2182 #define FF_AA_FASTINT 1 //not implemented yet
2184 #define FF_AA_FLOAT 3
2188 * quantizer noise shaping
2189 * - encoding: Set by user.
2190 * - decoding: unused
2192 int quantizer_noise_shaping;
2196 * is used to decide how many independent tasks should be passed to execute()
2197 * - encoding: Set by user.
2198 * - decoding: Set by user.
2203 * The codec may call this to execute several independent things.
2204 * It will return only after finishing all tasks.
2205 * The user may replace this with some multithreaded implementation,
2206 * the default implementation will execute the parts serially.
2207 * @param count the number of things to execute
2208 * - encoding: Set by libavcodec, user can override.
2209 * - decoding: Set by libavcodec, user can override.
2211 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2215 * Can be used by execute() to store some per AVCodecContext stuff.
2216 * - encoding: set by execute()
2217 * - decoding: set by execute()
2219 void *thread_opaque;
2222 * Motion estimation threshold below which no motion estimation is
2223 * performed, but instead the user specified motion vectors are used.
2225 * - encoding: Set by user.
2226 * - decoding: unused
2231 * Macroblock threshold below which the user specified macroblock types will be used.
2232 * - encoding: Set by user.
2233 * - decoding: unused
2238 * precision of the intra DC coefficient - 8
2239 * - encoding: Set by user.
2240 * - decoding: unused
2242 int intra_dc_precision;
2245 * noise vs. sse weight for the nsse comparsion function
2246 * - encoding: Set by user.
2247 * - decoding: unused
2252 * Number of macroblock rows at the top which are skipped.
2253 * - encoding: unused
2254 * - decoding: Set by user.
2259 * Number of macroblock rows at the bottom which are skipped.
2260 * - encoding: unused
2261 * - decoding: Set by user.
2267 * - encoding: Set by user.
2268 * - decoding: Set by libavcodec.
2271 #define FF_PROFILE_UNKNOWN -99
2272 #define FF_PROFILE_RESERVED -100
2274 #define FF_PROFILE_AAC_MAIN 0
2275 #define FF_PROFILE_AAC_LOW 1
2276 #define FF_PROFILE_AAC_SSR 2
2277 #define FF_PROFILE_AAC_LTP 3
2279 #define FF_PROFILE_DTS 20
2280 #define FF_PROFILE_DTS_ES 30
2281 #define FF_PROFILE_DTS_96_24 40
2282 #define FF_PROFILE_DTS_HD_HRA 50
2283 #define FF_PROFILE_DTS_HD_MA 60
2285 #define FF_PROFILE_MPEG2_422 0
2286 #define FF_PROFILE_MPEG2_HIGH 1
2287 #define FF_PROFILE_MPEG2_SS 2
2288 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2289 #define FF_PROFILE_MPEG2_MAIN 4
2290 #define FF_PROFILE_MPEG2_SIMPLE 5
2292 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2293 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2295 #define FF_PROFILE_H264_BASELINE 66
2296 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2297 #define FF_PROFILE_H264_MAIN 77
2298 #define FF_PROFILE_H264_EXTENDED 88
2299 #define FF_PROFILE_H264_HIGH 100
2300 #define FF_PROFILE_H264_HIGH_10 110
2301 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2302 #define FF_PROFILE_H264_HIGH_422 122
2303 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2304 #define FF_PROFILE_H264_HIGH_444 144
2305 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2306 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2307 #define FF_PROFILE_H264_CAVLC_444 44
2309 #define FF_PROFILE_VC1_SIMPLE 0
2310 #define FF_PROFILE_VC1_MAIN 1
2311 #define FF_PROFILE_VC1_COMPLEX 2
2312 #define FF_PROFILE_VC1_ADVANCED 3
2314 #define FF_PROFILE_MPEG4_SIMPLE 0
2315 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2316 #define FF_PROFILE_MPEG4_CORE 2
2317 #define FF_PROFILE_MPEG4_MAIN 3
2318 #define FF_PROFILE_MPEG4_N_BIT 4
2319 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2320 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2321 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2322 #define FF_PROFILE_MPEG4_HYBRID 8
2323 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2324 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2325 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2326 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2327 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2328 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2329 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2333 * - encoding: Set by user.
2334 * - decoding: Set by libavcodec.
2337 #define FF_LEVEL_UNKNOWN -99
2340 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2341 * - encoding: unused
2342 * - decoding: Set by user.
2347 * Bitstream width / height, may be different from width/height if lowres enabled.
2348 * - encoding: unused
2349 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2351 int coded_width, coded_height;
2354 * frame skip threshold
2355 * - encoding: Set by user.
2356 * - decoding: unused
2358 int frame_skip_threshold;
2362 * - encoding: Set by user.
2363 * - decoding: unused
2365 int frame_skip_factor;
2368 * frame skip exponent
2369 * - encoding: Set by user.
2370 * - decoding: unused
2375 * frame skip comparison function
2376 * - encoding: Set by user.
2377 * - decoding: unused
2382 * Border processing masking, raises the quantizer for mbs on the borders
2384 * - encoding: Set by user.
2385 * - decoding: unused
2387 float border_masking;
2390 * minimum MB lagrange multipler
2391 * - encoding: Set by user.
2392 * - decoding: unused
2397 * maximum MB lagrange multipler
2398 * - encoding: Set by user.
2399 * - decoding: unused
2405 * - encoding: Set by user.
2406 * - decoding: unused
2408 int me_penalty_compensation;
2412 * - encoding: unused
2413 * - decoding: Set by user.
2415 enum AVDiscard skip_loop_filter;
2419 * - encoding: unused
2420 * - decoding: Set by user.
2422 enum AVDiscard skip_idct;
2426 * - encoding: unused
2427 * - decoding: Set by user.
2429 enum AVDiscard skip_frame;
2433 * - encoding: Set by user.
2434 * - decoding: unused
2440 * - encoding: Set by user.
2441 * - decoding: unused
2445 #if FF_API_X264_GLOBAL_OPTS
2447 * constant rate factor - quality-based VBR - values ~correspond to qps
2448 * - encoding: Set by user.
2449 * - decoding: unused
2450 * @deprecated use 'crf' libx264 private option
2452 attribute_deprecated float crf;
2455 * constant quantization parameter rate control method
2456 * - encoding: Set by user.
2457 * - decoding: unused
2458 * @deprecated use 'cqp' libx264 private option
2460 attribute_deprecated int cqp;
2465 * - encoding: Set by user.
2466 * - decoding: unused
2471 * number of reference frames
2472 * - encoding: Set by user.
2473 * - decoding: Set by lavc.
2478 * chroma qp offset from luma
2479 * - encoding: Set by user.
2480 * - decoding: unused
2485 * Influences how often B-frames are used.
2486 * - encoding: Set by user.
2487 * - decoding: unused
2492 * trellis RD quantization
2493 * - encoding: Set by user.
2494 * - decoding: unused
2499 * Reduce fluctuations in qp (before curve compression).
2500 * - encoding: Set by user.
2501 * - decoding: unused
2503 float complexityblur;
2506 * in-loop deblocking filter alphac0 parameter
2507 * alpha is in the range -6...6
2508 * - encoding: Set by user.
2509 * - decoding: unused
2514 * in-loop deblocking filter beta parameter
2515 * beta is in the range -6...6
2516 * - encoding: Set by user.
2517 * - decoding: unused
2522 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2523 * - encoding: Set by user.
2524 * - decoding: unused
2527 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2528 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2529 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2530 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2531 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2534 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2535 * - encoding: Set by user.
2536 * - decoding: unused
2541 * Audio cutoff bandwidth (0 means "automatic")
2542 * - encoding: Set by user.
2543 * - decoding: unused
2548 * Multiplied by qscale for each frame and added to scene_change_score.
2549 * - encoding: Set by user.
2550 * - decoding: unused
2552 int scenechange_factor;
2556 * Note: Value depends upon the compare function used for fullpel ME.
2557 * - encoding: Set by user.
2558 * - decoding: unused
2563 * Adjusts sensitivity of b_frame_strategy 1.
2564 * - encoding: Set by user.
2565 * - decoding: unused
2570 * - encoding: Set by user.
2571 * - decoding: unused
2573 int compression_level;
2574 #define FF_COMPRESSION_DEFAULT -1
2577 * - encoding: Set by user.
2578 * - decoding: unused
2580 int min_prediction_order;
2583 * - encoding: Set by user.
2584 * - decoding: unused
2586 int max_prediction_order;
2588 #if FF_API_FLAC_GLOBAL_OPTS
2590 * @name FLAC options
2591 * @deprecated Use FLAC encoder private options instead.
2596 * LPC coefficient precision - used by FLAC encoder
2597 * - encoding: Set by user.
2598 * - decoding: unused
2600 attribute_deprecated int lpc_coeff_precision;
2603 * search method for selecting prediction order
2604 * - encoding: Set by user.
2605 * - decoding: unused
2607 attribute_deprecated int prediction_order_method;
2610 * - encoding: Set by user.
2611 * - decoding: unused
2613 attribute_deprecated int min_partition_order;
2616 * - encoding: Set by user.
2617 * - decoding: unused
2619 attribute_deprecated int max_partition_order;
2626 * GOP timecode frame start number, in non drop frame format
2627 * - encoding: Set by user.
2628 * - decoding: unused
2630 int64_t timecode_frame_start;
2632 #if FF_API_REQUEST_CHANNELS
2634 * Decoder should decode to this many channels if it can (0 for default)
2635 * - encoding: unused
2636 * - decoding: Set by user.
2637 * @deprecated Deprecated in favor of request_channel_layout.
2639 int request_channels;
2642 #if FF_API_DRC_SCALE
2644 * Percentage of dynamic range compression to be applied by the decoder.
2645 * The default value is 1.0, corresponding to full compression.
2646 * - encoding: unused
2647 * - decoding: Set by user.
2648 * @deprecated use AC3 decoder private option instead.
2650 attribute_deprecated float drc_scale;
2654 * opaque 64bit number (generally a PTS) that will be reordered and
2655 * output in AVFrame.reordered_opaque
2656 * @deprecated in favor of pkt_pts
2657 * - encoding: unused
2658 * - decoding: Set by user.
2660 int64_t reordered_opaque;
2663 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2664 * - encoding: set by user.
2665 * - decoding: set by libavcodec.
2667 int bits_per_raw_sample;
2670 * Audio channel layout.
2671 * - encoding: set by user.
2672 * - decoding: set by user, may be overwritten by libavcodec.
2674 int64_t channel_layout;
2677 * Request decoder to use this channel layout if it can (0 for default)
2678 * - encoding: unused
2679 * - decoding: Set by user.
2681 int64_t request_channel_layout;
2684 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2685 * - encoding: Set by user.
2686 * - decoding: unused.
2688 float rc_max_available_vbv_use;
2691 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2692 * - encoding: Set by user.
2693 * - decoding: unused.
2695 float rc_min_vbv_overflow_use;
2698 * Hardware accelerator in use
2699 * - encoding: unused.
2700 * - decoding: Set by libavcodec
2702 struct AVHWAccel *hwaccel;
2705 * For some codecs, the time base is closer to the field rate than the frame rate.
2706 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2707 * if no telecine is used ...
2709 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2711 int ticks_per_frame;
2714 * Hardware accelerator context.
2715 * For some hardware accelerators, a global context needs to be
2716 * provided by the user. In that case, this holds display-dependent
2717 * data FFmpeg cannot instantiate itself. Please refer to the
2718 * FFmpeg HW accelerator documentation to know how to fill this
2719 * is. e.g. for VA API, this is a struct vaapi_context.
2720 * - encoding: unused
2721 * - decoding: Set by user
2723 void *hwaccel_context;
2726 * Chromaticity coordinates of the source primaries.
2727 * - encoding: Set by user
2728 * - decoding: Set by libavcodec
2730 enum AVColorPrimaries color_primaries;
2733 * Color Transfer Characteristic.
2734 * - encoding: Set by user
2735 * - decoding: Set by libavcodec
2737 enum AVColorTransferCharacteristic color_trc;
2740 * YUV colorspace type.
2741 * - encoding: Set by user
2742 * - decoding: Set by libavcodec
2744 enum AVColorSpace colorspace;
2747 * MPEG vs JPEG YUV range.
2748 * - encoding: Set by user
2749 * - decoding: Set by libavcodec
2751 enum AVColorRange color_range;
2754 * This defines the location of chroma samples.
2755 * - encoding: Set by user
2756 * - decoding: Set by libavcodec
2758 enum AVChromaLocation chroma_sample_location;
2761 * The codec may call this to execute several independent things.
2762 * It will return only after finishing all tasks.
2763 * The user may replace this with some multithreaded implementation,
2764 * the default implementation will execute the parts serially.
2765 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2766 * @param c context passed also to func
2767 * @param count the number of things to execute
2768 * @param arg2 argument passed unchanged to func
2769 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2770 * @param func function that will be called count times, with jobnr from 0 to count-1.
2771 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2772 * two instances of func executing at the same time will have the same threadnr.
2773 * @return always 0 currently, but code should handle a future improvement where when any call to func
2774 * returns < 0 no further calls to func may be done and < 0 is returned.
2775 * - encoding: Set by libavcodec, user can override.
2776 * - decoding: Set by libavcodec, user can override.
2778 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2780 #if FF_API_X264_GLOBAL_OPTS
2782 * explicit P-frame weighted prediction analysis method
2784 * 1: fast blind weighting (one reference duplicate with -1 offset)
2785 * 2: smart weighting (full fade detection analysis)
2786 * - encoding: Set by user.
2787 * - decoding: unused
2789 attribute_deprecated int weighted_p_pred;
2794 * 1: Variance AQ (complexity mask)
2795 * 2: Auto-variance AQ (experimental)
2796 * - encoding: Set by user
2797 * - decoding: unused
2799 attribute_deprecated int aq_mode;
2803 * Reduces blocking and blurring in flat and textured areas.
2804 * - encoding: Set by user
2805 * - decoding: unused
2807 attribute_deprecated float aq_strength;
2811 * Strength of psychovisual optimization
2812 * - encoding: Set by user
2813 * - decoding: unused
2815 attribute_deprecated float psy_rd;
2819 * Strength of psychovisual optimization
2820 * - encoding: Set by user
2821 * - decoding: unused
2823 attribute_deprecated float psy_trellis;
2827 * Number of frames for frametype and ratecontrol lookahead
2828 * - encoding: Set by user
2829 * - decoding: unused
2831 attribute_deprecated int rc_lookahead;
2834 * Constant rate factor maximum
2835 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2836 * than crf_max, even if doing so would violate VBV restrictions.
2837 * - encoding: Set by user.
2838 * - decoding: unused
2840 attribute_deprecated float crf_max;
2843 int log_level_offset;
2845 #if FF_API_FLAC_GLOBAL_OPTS
2847 * Determines which LPC analysis algorithm to use.
2848 * - encoding: Set by user
2849 * - decoding: unused
2851 attribute_deprecated enum AVLPCType lpc_type;
2854 * Number of passes to use for Cholesky factorization during LPC analysis
2855 * - encoding: Set by user
2856 * - decoding: unused
2858 attribute_deprecated int lpc_passes;
2863 * Indicates number of picture subdivisions. Used for parallelized
2865 * - encoding: Set by user
2866 * - decoding: unused
2871 * Header containing style information for text subtitles.
2872 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2873 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2874 * the Format line following. It shouldn't include any Dialogue line.
2875 * - encoding: Set/allocated/freed by user (before avcodec_open())
2876 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2878 uint8_t *subtitle_header;
2879 int subtitle_header_size;
2882 * Current packet as passed into the decoder, to avoid having
2883 * to pass the packet into every function. Currently only valid
2884 * inside lavc and get/release_buffer callbacks.
2885 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2886 * - encoding: unused
2891 * Whether this is a copy of the context which had init() called on it.
2892 * This is used by multithreading - shared tables and picture pointers
2893 * should be freed from the original context only.
2894 * - encoding: Set by libavcodec.
2895 * - decoding: Set by libavcodec.
2900 * Which multithreading methods to use.
2901 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2902 * so clients which cannot provide future frames should not use it.
2904 * - encoding: Set by user, otherwise the default is used.
2905 * - decoding: Set by user, otherwise the default is used.
2908 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2909 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2912 * Which multithreading methods are in use by the codec.
2913 * - encoding: Set by libavcodec.
2914 * - decoding: Set by libavcodec.
2916 int active_thread_type;
2919 * Set by the client if its custom get_buffer() callback can be called
2920 * from another thread, which allows faster multithreaded decoding.
2921 * draw_horiz_band() will be called from other threads regardless of this setting.
2922 * Ignored if the default get_buffer() is used.
2923 * - encoding: Set by user.
2924 * - decoding: Set by user.
2926 int thread_safe_callbacks;
2929 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2930 * Used for compliant TS muxing.
2931 * - encoding: Set by libavcodec.
2932 * - decoding: unused.
2937 * Type of service that the audio stream conveys.
2938 * - encoding: Set by user.
2939 * - decoding: Set by libavcodec.
2941 enum AVAudioServiceType audio_service_type;
2944 * desired sample format
2945 * - encoding: Not used.
2946 * - decoding: Set by user.
2947 * Decoder will decode to this format if it can.
2949 enum AVSampleFormat request_sample_fmt;
2952 * Current statistics for PTS correction.
2953 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2954 * - encoding: unused
2956 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2957 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2958 int64_t pts_correction_last_pts; /// PTS of the last frame
2959 int64_t pts_correction_last_dts; /// DTS of the last frame
2967 typedef struct AVProfile {
2969 const char *name; ///< short name for the profile
2972 typedef struct AVCodecDefault AVCodecDefault;
2977 typedef struct AVCodec {
2979 * Name of the codec implementation.
2980 * The name is globally unique among encoders and among decoders (but an
2981 * encoder and a decoder can share the same name).
2982 * This is the primary way to find a codec from the user perspective.
2985 enum AVMediaType type;
2988 int (*init)(AVCodecContext *);
2989 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2990 int (*close)(AVCodecContext *);
2991 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2993 * Codec capabilities.
2997 struct AVCodec *next;
3000 * Will be called when seeking
3002 void (*flush)(AVCodecContext *);
3003 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3004 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3006 * Descriptive name for the codec, meant to be more human readable than name.
3007 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3009 const char *long_name;
3010 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3011 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3012 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3013 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3014 const AVClass *priv_class; ///< AVClass for the private context
3015 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3018 * @name Frame-level threading support functions
3022 * If defined, called on thread contexts when they are created.
3023 * If the codec allocates writable tables in init(), re-allocate them here.
3024 * priv_data will be set to a copy of the original.
3026 int (*init_thread_copy)(AVCodecContext *);
3028 * Copy necessary context variables from a previous thread context to the current one.
3029 * If not defined, the next thread will start automatically; otherwise, the codec
3030 * must call ff_thread_finish_setup().
3032 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3034 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3038 * Private codec-specific defaults.
3040 const AVCodecDefault *defaults;
3046 typedef struct AVHWAccel {
3048 * Name of the hardware accelerated codec.
3049 * The name is globally unique among encoders and among decoders (but an
3050 * encoder and a decoder can share the same name).
3055 * Type of codec implemented by the hardware accelerator.
3057 * See AVMEDIA_TYPE_xxx
3059 enum AVMediaType type;
3062 * Codec implemented by the hardware accelerator.
3069 * Supported pixel format.
3071 * Only hardware accelerated formats are supported here.
3073 enum PixelFormat pix_fmt;
3076 * Hardware accelerated codec capabilities.
3077 * see FF_HWACCEL_CODEC_CAP_*
3081 struct AVHWAccel *next;
3084 * Called at the beginning of each frame or field picture.
3086 * Meaningful frame information (codec specific) is guaranteed to
3087 * be parsed at this point. This function is mandatory.
3089 * Note that buf can be NULL along with buf_size set to 0.
3090 * Otherwise, this means the whole frame is available at this point.
3092 * @param avctx the codec context
3093 * @param buf the frame data buffer base
3094 * @param buf_size the size of the frame in bytes
3095 * @return zero if successful, a negative value otherwise
3097 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3100 * Callback for each slice.
3102 * Meaningful slice information (codec specific) is guaranteed to
3103 * be parsed at this point. This function is mandatory.
3105 * @param avctx the codec context
3106 * @param buf the slice data buffer base
3107 * @param buf_size the size of the slice in bytes
3108 * @return zero if successful, a negative value otherwise
3110 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3113 * Called at the end of each frame or field picture.
3115 * The whole picture is parsed at this point and can now be sent
3116 * to the hardware accelerator. This function is mandatory.
3118 * @param avctx the codec context
3119 * @return zero if successful, a negative value otherwise
3121 int (*end_frame)(AVCodecContext *avctx);
3124 * Size of HW accelerator private data.
3126 * Private data is allocated with av_mallocz() before
3127 * AVCodecContext.get_buffer() and deallocated after
3128 * AVCodecContext.release_buffer().
3134 * four components are given, that's all.
3135 * the last component is alpha
3137 typedef struct AVPicture {
3139 int linesize[4]; ///< number of bytes per line
3142 #if FF_API_PALETTE_CONTROL
3145 * This structure defines a method for communicating palette changes
3146 * between and demuxer and a decoder.
3148 * @deprecated Use AVPacket to send palette changes instead.
3149 * This is totally broken.
3151 #define AVPALETTE_SIZE 1024
3152 #define AVPALETTE_COUNT 256
3153 typedef struct AVPaletteControl {
3155 /* Demuxer sets this to 1 to indicate the palette has changed;
3156 * decoder resets to 0. */
3157 int palette_changed;
3159 /* 4-byte ARGB palette entries, stored in native byte order; note that
3160 * the individual palette components should be on a 8-bit scale; if
3161 * the palette data comes from an IBM VGA native format, the component
3162 * data is probably 6 bits in size and needs to be scaled. */
3163 unsigned int palette[AVPALETTE_COUNT];
3165 } AVPaletteControl attribute_deprecated;
3168 enum AVSubtitleType {
3171 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3174 * Plain text, the text field must be set by the decoder and is
3175 * authoritative. ass and pict fields may contain approximations.
3180 * Formatted text, the ass field must be set by the decoder and is
3181 * authoritative. pict and text fields may contain approximations.
3186 typedef struct AVSubtitleRect {
3187 int x; ///< top left corner of pict, undefined when pict is not set
3188 int y; ///< top left corner of pict, undefined when pict is not set
3189 int w; ///< width of pict, undefined when pict is not set
3190 int h; ///< height of pict, undefined when pict is not set
3191 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3194 * data+linesize for the bitmap of this subtitle.
3195 * can be set for text/ass as well once they where rendered
3198 enum AVSubtitleType type;
3200 char *text; ///< 0 terminated plain UTF-8 text
3203 * 0 terminated ASS/SSA compatible event line.
3204 * The pressentation of this is unaffected by the other values in this
3210 typedef struct AVSubtitle {
3211 uint16_t format; /* 0 = graphics */
3212 uint32_t start_display_time; /* relative to packet pts, in ms */
3213 uint32_t end_display_time; /* relative to packet pts, in ms */
3215 AVSubtitleRect **rects;
3216 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3219 /* packet functions */
3222 * @deprecated use NULL instead
3224 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3227 * Default packet destructor.
3229 void av_destruct_packet(AVPacket *pkt);
3232 * Initialize optional fields of a packet with default values.
3236 void av_init_packet(AVPacket *pkt);
3239 * Allocate the payload of a packet and initialize its fields with
3243 * @param size wanted payload size
3244 * @return 0 if OK, AVERROR_xxx otherwise
3246 int av_new_packet(AVPacket *pkt, int size);
3249 * Reduce packet size, correctly zeroing padding
3252 * @param size new size
3254 void av_shrink_packet(AVPacket *pkt, int size);
3257 * Increase packet size, correctly zeroing padding
3260 * @param grow_by number of bytes by which to increase the size of the packet
3262 int av_grow_packet(AVPacket *pkt, int grow_by);
3265 * @warning This is a hack - the packet memory allocation stuff is broken. The
3266 * packet is allocated if it was not really allocated.
3268 int av_dup_packet(AVPacket *pkt);
3273 * @param pkt packet to free
3275 void av_free_packet(AVPacket *pkt);
3278 * Allocate new information of a packet.
3281 * @param type side information type
3282 * @param size side information size
3283 * @return pointer to fresh allocated data or NULL otherwise
3285 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3289 * Get side information from packet.
3292 * @param type desired side information type
3293 * @param size pointer for side information size to store (optional)
3294 * @return pointer to data if present or NULL otherwise
3296 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3299 int av_packet_merge_side_data(AVPacket *pkt);
3301 int av_packet_split_side_data(AVPacket *pkt);
3306 struct ReSampleContext;
3307 struct AVResampleContext;
3309 typedef struct ReSampleContext ReSampleContext;
3312 * Initialize audio resampling context.
3314 * @param output_channels number of output channels
3315 * @param input_channels number of input channels
3316 * @param output_rate output sample rate
3317 * @param input_rate input sample rate
3318 * @param sample_fmt_out requested output sample format
3319 * @param sample_fmt_in input sample format
3320 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3321 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3322 * @param linear if 1 then the used FIR filter will be linearly interpolated
3323 between the 2 closest, if 0 the closest will be used
3324 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3325 * @return allocated ReSampleContext, NULL if error occured
3327 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3328 int output_rate, int input_rate,
3329 enum AVSampleFormat sample_fmt_out,
3330 enum AVSampleFormat sample_fmt_in,
3331 int filter_length, int log2_phase_count,
3332 int linear, double cutoff);
3334 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3337 * Free resample context.
3339 * @param s a non-NULL pointer to a resample context previously
3340 * created with av_audio_resample_init()
3342 void audio_resample_close(ReSampleContext *s);
3346 * Initialize an audio resampler.
3347 * Note, if either rate is not an integer then simply scale both rates up so they are.
3348 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3349 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3350 * @param linear If 1 then the used FIR filter will be linearly interpolated
3351 between the 2 closest, if 0 the closest will be used
3352 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3354 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3357 * Resample an array of samples using a previously configured context.
3358 * @param src an array of unconsumed samples
3359 * @param consumed the number of samples of src which have been consumed are returned here
3360 * @param src_size the number of unconsumed samples available
3361 * @param dst_size the amount of space in samples available in dst
3362 * @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.
3363 * @return the number of samples written in dst or -1 if an error occurred
3365 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3369 * Compensate samplerate/timestamp drift. The compensation is done by changing
3370 * the resampler parameters, so no audible clicks or similar distortions occur
3371 * @param compensation_distance distance in output samples over which the compensation should be performed
3372 * @param sample_delta number of output samples which should be output less
3374 * example: av_resample_compensate(c, 10, 500)
3375 * here instead of 510 samples only 500 samples would be output
3377 * note, due to rounding the actual compensation might be slightly different,
3378 * especially if the compensation_distance is large and the in_rate used during init is small
3380 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3381 void av_resample_close(struct AVResampleContext *c);
3384 * Allocate memory for a picture. Call avpicture_free() to free it.
3386 * @see avpicture_fill()
3388 * @param picture the picture to be filled in
3389 * @param pix_fmt the format of the picture
3390 * @param width the width of the picture
3391 * @param height the height of the picture
3392 * @return zero if successful, a negative value if not
3394 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3397 * Free a picture previously allocated by avpicture_alloc().
3398 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3401 * @param picture the AVPicture to be freed
3403 void avpicture_free(AVPicture *picture);
3406 * Fill in the AVPicture fields.
3407 * The fields of the given AVPicture are filled in by using the 'ptr' address
3408 * which points to the image data buffer. Depending on the specified picture
3409 * format, one or multiple image data pointers and line sizes will be set.
3410 * If a planar format is specified, several pointers will be set pointing to
3411 * the different picture planes and the line sizes of the different planes
3412 * will be stored in the lines_sizes array.
3413 * Call with ptr == NULL to get the required size for the ptr buffer.
3415 * To allocate the buffer and fill in the AVPicture fields in one call,
3416 * use avpicture_alloc().
3418 * @param picture AVPicture whose fields are to be filled in
3419 * @param ptr Buffer which will contain or contains the actual image data
3420 * @param pix_fmt The format in which the picture data is stored.
3421 * @param width the width of the image in pixels
3422 * @param height the height of the image in pixels
3423 * @return size of the image data in bytes
3425 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3426 enum PixelFormat pix_fmt, int width, int height);
3429 * Copy pixel data from an AVPicture into a buffer.
3430 * The data is stored compactly, without any gaps for alignment or padding
3431 * which may be applied by avpicture_fill().
3433 * @see avpicture_get_size()
3435 * @param[in] src AVPicture containing image data
3436 * @param[in] pix_fmt The format in which the picture data is stored.
3437 * @param[in] width the width of the image in pixels.
3438 * @param[in] height the height of the image in pixels.
3439 * @param[out] dest A buffer into which picture data will be copied.
3440 * @param[in] dest_size The size of 'dest'.
3441 * @return The number of bytes written to dest, or a negative value (error code) on error.
3443 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3444 unsigned char *dest, int dest_size);
3447 * Calculate the size in bytes that a picture of the given width and height
3448 * would occupy if stored in the given picture format.
3449 * Note that this returns the size of a compact representation as generated
3450 * by avpicture_layout(), which can be smaller than the size required for e.g.
3453 * @param pix_fmt the given picture format
3454 * @param width the width of the image
3455 * @param height the height of the image
3456 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3458 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3459 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3462 * Get the name of a codec.
3463 * @return a static string identifying the codec; never NULL
3465 const char *avcodec_get_name(enum CodecID id);
3467 #if FF_API_GET_PIX_FMT_NAME
3469 * Return the short name for a pixel format.
3471 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3472 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3474 attribute_deprecated
3475 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3478 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3481 * Return a value representing the fourCC code associated to the
3482 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3485 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3488 * Put a string representing the codec tag codec_tag in buf.
3490 * @param buf_size size in bytes of buf
3491 * @return the length of the string that would have been generated if
3492 * enough space had been available, excluding the trailing null
3494 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3496 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3497 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3498 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3499 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3500 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3501 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3504 * Compute what kind of losses will occur when converting from one specific
3505 * pixel format to another.
3506 * When converting from one pixel format to another, information loss may occur.
3507 * For example, when converting from RGB24 to GRAY, the color information will
3508 * be lost. Similarly, other losses occur when converting from some formats to
3509 * other formats. These losses can involve loss of chroma, but also loss of
3510 * resolution, loss of color depth, loss due to the color space conversion, loss
3511 * of the alpha bits or loss due to color quantization.
3512 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3513 * which will occur when converting from one pixel format to another.
3515 * @param[in] dst_pix_fmt destination pixel format
3516 * @param[in] src_pix_fmt source pixel format
3517 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3518 * @return Combination of flags informing you what kind of losses will occur
3519 * (maximum loss for an invalid dst_pix_fmt).
3521 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3525 * Find the best pixel format to convert to given a certain source pixel
3526 * format. When converting from one pixel format to another, information loss
3527 * may occur. For example, when converting from RGB24 to GRAY, the color
3528 * information will be lost. Similarly, other losses occur when converting from
3529 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3530 * the given pixel formats should be used to suffer the least amount of loss.
3531 * The pixel formats from which it chooses one, are determined by the
3532 * pix_fmt_mask parameter.
3534 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3537 * src_pix_fmt = PIX_FMT_YUV420P;
3538 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3539 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3542 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3543 * @param[in] src_pix_fmt source pixel format
3544 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3545 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3546 * @return The best pixel format to convert to or -1 if none was found.
3548 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3549 int has_alpha, int *loss_ptr);
3552 * Find the best pixel format to convert to given a certain source pixel
3553 * format and a selection of two destination pixel formats. When converting from
3554 * one pixel format to another, information loss may occur. For example, when converting
3555 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3556 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3557 * the given pixel formats should be used to suffer the least amount of loss.
3559 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3563 * src_pix_fmt = PIX_FMT_YUV420P;
3564 * dst_pix_fmt1= PIX_FMT_RGB24;
3565 * dst_pix_fmt2= PIX_FMT_GRAY8;
3566 * dst_pix_fmt3= PIX_FMT_RGB8;
3567 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3568 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3569 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3572 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3573 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3574 * @param[in] src_pix_fmt Source pixel format
3575 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3576 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3577 * NULL or value of zero means we care about all losses. Out: the loss
3578 * that occurs when converting from src to selected dst pixel format.
3579 * @return The best pixel format to convert to or -1 if none was found.
3581 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3582 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3584 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3585 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3588 * Tell if an image really has transparent alpha values.
3589 * @return ored mask of FF_ALPHA_xxx constants
3591 int img_get_alpha_info(const AVPicture *src,
3592 enum PixelFormat pix_fmt, int width, int height);
3594 /* deinterlace a picture */
3595 /* deinterlace - if not supported return -1 */
3596 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3597 enum PixelFormat pix_fmt, int width, int height);
3599 /* external high level API */
3602 * If c is NULL, returns the first registered codec,
3603 * if c is non-NULL, returns the next registered codec after c,
3604 * or NULL if c is the last one.
3606 AVCodec *av_codec_next(AVCodec *c);
3609 * Return the LIBAVCODEC_VERSION_INT constant.
3611 unsigned avcodec_version(void);
3614 * Return the libavcodec build-time configuration.
3616 const char *avcodec_configuration(void);
3619 * Return the libavcodec license.
3621 const char *avcodec_license(void);
3623 #if FF_API_AVCODEC_INIT
3625 * @deprecated this function is called automatically from avcodec_register()
3626 * and avcodec_register_all(), there is no need to call it manually
3628 attribute_deprecated
3629 void avcodec_init(void);
3633 * Register the codec codec and initialize libavcodec.
3635 * @warning either this function or avcodec_register_all() must be called
3636 * before any other libavcodec functions.
3638 * @see avcodec_register_all()
3640 void avcodec_register(AVCodec *codec);
3643 * Find a registered encoder with a matching codec ID.
3645 * @param id CodecID of the requested encoder
3646 * @return An encoder if one was found, NULL otherwise.
3648 AVCodec *avcodec_find_encoder(enum CodecID id);
3651 * Find a registered encoder with the specified name.
3653 * @param name name of the requested encoder
3654 * @return An encoder if one was found, NULL otherwise.
3656 AVCodec *avcodec_find_encoder_by_name(const char *name);
3659 * Find a registered decoder with a matching codec ID.
3661 * @param id CodecID of the requested decoder
3662 * @return A decoder if one was found, NULL otherwise.
3664 AVCodec *avcodec_find_decoder(enum CodecID id);
3667 * Find a registered decoder with the specified name.
3669 * @param name name of the requested decoder
3670 * @return A decoder if one was found, NULL otherwise.
3672 AVCodec *avcodec_find_decoder_by_name(const char *name);
3673 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3676 * Return a name for the specified profile, if available.
3678 * @param codec the codec that is searched for the given profile
3679 * @param profile the profile value for which a name is requested
3680 * @return A name for the profile if found, NULL otherwise.
3682 const char *av_get_profile_name(const AVCodec *codec, int profile);
3685 * Set the fields of the given AVCodecContext to default values.
3687 * @param s The AVCodecContext of which the fields should be set to default values.
3689 void avcodec_get_context_defaults(AVCodecContext *s);
3691 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3692 * we WILL change its arguments and name a few times! */
3693 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3695 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3696 * we WILL change its arguments and name a few times! */
3697 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3699 #if FF_API_ALLOC_CONTEXT
3701 * Allocate an AVCodecContext and set its fields to default values. The
3702 * resulting struct can be deallocated by simply calling av_free().
3704 * @return An AVCodecContext filled with default values or NULL on failure.
3705 * @see avcodec_get_context_defaults
3707 * @deprecated use avcodec_alloc_context3()
3709 attribute_deprecated
3710 AVCodecContext *avcodec_alloc_context(void);
3712 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3713 * we WILL change its arguments and name a few times! */
3714 attribute_deprecated
3715 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3719 * Allocate an AVCodecContext and set its fields to default values. The
3720 * resulting struct can be deallocated by simply calling av_free().
3722 * @param codec if non-NULL, allocate private data and initialize defaults
3723 * for the given codec. It is illegal to then call avcodec_open()
3724 * with a different codec.
3726 * @return An AVCodecContext filled with default values or NULL on failure.
3727 * @see avcodec_get_context_defaults
3729 * @deprecated use avcodec_alloc_context3()
3731 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3734 * Copy the settings of the source AVCodecContext into the destination
3735 * AVCodecContext. The resulting destination codec context will be
3736 * unopened, i.e. you are required to call avcodec_open() before you
3737 * can use this AVCodecContext to decode/encode video/audio data.
3739 * @param dest target codec context, should be initialized with
3740 * avcodec_alloc_context3(), but otherwise uninitialized
3741 * @param src source codec context
3742 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3744 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3747 * Set the fields of the given AVFrame to default values.
3749 * @param pic The AVFrame of which the fields should be set to default values.
3751 void avcodec_get_frame_defaults(AVFrame *pic);
3754 * Allocate an AVFrame and set its fields to default values. The resulting
3755 * struct can be deallocated by simply calling av_free().
3757 * @return An AVFrame filled with default values or NULL on failure.
3758 * @see avcodec_get_frame_defaults
3760 AVFrame *avcodec_alloc_frame(void);
3762 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3763 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3764 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3767 * Return the amount of padding in pixels which the get_buffer callback must
3768 * provide around the edge of the image for codecs which do not have the
3769 * CODEC_FLAG_EMU_EDGE flag.
3771 * @return Required padding in pixels.
3773 unsigned avcodec_get_edge_width(void);
3775 * Modify width and height values so that they will result in a memory
3776 * buffer that is acceptable for the codec if you do not use any horizontal
3779 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3780 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3781 * according to avcodec_get_edge_width() before.
3783 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3785 * Modify width and height values so that they will result in a memory
3786 * buffer that is acceptable for the codec if you also ensure that all
3787 * line sizes are a multiple of the respective linesize_align[i].
3789 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3790 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3791 * according to avcodec_get_edge_width() before.
3793 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3794 int linesize_align[4]);
3796 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3798 #if FF_API_THREAD_INIT
3800 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3802 attribute_deprecated
3803 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3806 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3807 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3808 //FIXME func typedef
3810 #if FF_API_AVCODEC_OPEN
3812 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3813 * function the context has to be allocated.
3815 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3816 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3817 * retrieving a codec.
3819 * @warning This function is not thread safe!
3822 * avcodec_register_all();
3823 * codec = avcodec_find_decoder(CODEC_ID_H264);
3827 * context = avcodec_alloc_context3(codec);
3829 * if (avcodec_open(context, codec) < 0)
3833 * @param avctx The context which will be set up to use the given codec.
3834 * @param codec The codec to use within the context.
3835 * @return zero on success, a negative value on error
3836 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3838 * @deprecated use avcodec_open2
3840 attribute_deprecated
3841 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3845 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3846 * function the context has to be allocated with avcodec_alloc_context().
3848 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3849 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3850 * retrieving a codec.
3852 * @warning This function is not thread safe!
3855 * avcodec_register_all();
3856 * av_dict_set(&opts, "b", "2.5M", 0);
3857 * codec = avcodec_find_decoder(CODEC_ID_H264);
3861 * context = avcodec_alloc_context();
3863 * if (avcodec_open(context, codec, opts) < 0)
3867 * @param avctx The context to initialize.
3868 * @param options A dictionary filled with AVCodecContext and codec-private options.
3869 * On return this object will be filled with options that were not found.
3871 * @return zero on success, a negative value on error
3872 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3873 * av_dict_set(), av_opt_find().
3875 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3878 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3879 * Some decoders may support multiple frames in a single AVPacket, such
3880 * decoders would then just decode the first frame. In this case,
3881 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3882 * the remaining data in order to decode the second frame etc.
3884 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3885 * decompressed frame size in bytes.
3887 * @warning You must set frame_size_ptr to the allocated size of the
3888 * output buffer before calling avcodec_decode_audio3().
3890 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3891 * the actual read bytes because some optimized bitstream readers read 32 or 64
3892 * bits at once and could read over the end.
3894 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3895 * no overreading happens for damaged MPEG streams.
3897 * @note You might have to align the input buffer avpkt->data and output buffer
3898 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3899 * necessary at all, on others it won't work at all if not aligned and on others
3900 * it will work but it will have an impact on performance.
3902 * In practice, avpkt->data should have 4 byte alignment at minimum and
3903 * samples should be 16 byte aligned unless the CPU doesn't need it
3904 * (AltiVec and SSE do).
3906 * @param avctx the codec context
3907 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3908 * @param[in,out] frame_size_ptr the output buffer size in bytes
3909 * @param[in] avpkt The input AVPacket containing the input buffer.
3910 * You can create such packet with av_init_packet() and by then setting
3911 * data and size, some decoders might in addition need other fields.
3912 * All decoders are designed to use the least fields possible though.
3913 * @return On error a negative value is returned, otherwise the number of bytes
3914 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3916 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3917 int *frame_size_ptr,
3921 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3922 * Some decoders may support multiple frames in a single AVPacket, such
3923 * decoders would then just decode the first frame.
3925 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3926 * the actual read bytes because some optimized bitstream readers read 32 or 64
3927 * bits at once and could read over the end.
3929 * @warning The end of the input buffer buf should be set to 0 to ensure that
3930 * no overreading happens for damaged MPEG streams.
3932 * @note You might have to align the input buffer avpkt->data.
3933 * The alignment requirements depend on the CPU: on some CPUs it isn't
3934 * necessary at all, on others it won't work at all if not aligned and on others
3935 * it will work but it will have an impact on performance.
3937 * In practice, avpkt->data should have 4 byte alignment at minimum.
3939 * @note Some codecs have a delay between input and output, these need to be
3940 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3942 * @param avctx the codec context
3943 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3944 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3945 * allocate memory for the actual bitmap.
3946 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3947 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3948 * decodes and the decoder tells the user once it does not need the data anymore,
3949 * the user app can at this point free/reuse/keep the memory as it sees fit.
3951 * @param[in] avpkt The input AVpacket containing the input buffer.
3952 * You can create such packet with av_init_packet() and by then setting
3953 * data and size, some decoders might in addition need other fields like
3954 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3956 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3957 * @return On error a negative value is returned, otherwise the number of bytes
3958 * used or zero if no frame could be decompressed.
3960 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3961 int *got_picture_ptr,
3965 * Decode a subtitle message.
3966 * Return a negative value on error, otherwise return the number of bytes used.
3967 * If no subtitle could be decompressed, got_sub_ptr is zero.
3968 * Otherwise, the subtitle is stored in *sub.
3969 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3970 * simplicity, because the performance difference is expect to be negligible
3971 * and reusing a get_buffer written for video codecs would probably perform badly
3972 * due to a potentially very different allocation pattern.
3974 * @param avctx the codec context
3975 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3976 freed with avsubtitle_free if *got_sub_ptr is set.
3977 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3978 * @param[in] avpkt The input AVPacket containing the input buffer.
3980 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3985 * Frees all allocated data in the given subtitle struct.
3987 * @param sub AVSubtitle to free.
3989 void avsubtitle_free(AVSubtitle *sub);
3991 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3993 uint8_t *buf, int buf_size);
3996 * Encode an audio frame from samples into buf.
3998 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3999 * However, for PCM audio the user will know how much space is needed
4000 * because it depends on the value passed in buf_size as described
4001 * below. In that case a lower value can be used.
4003 * @param avctx the codec context
4004 * @param[out] buf the output buffer
4005 * @param[in] buf_size the output buffer size
4006 * @param[in] samples the input buffer containing the samples
4007 * The number of samples read from this buffer is frame_size*channels,
4008 * both of which are defined in avctx.
4009 * For PCM audio the number of samples read from samples is equal to
4010 * buf_size * input_sample_size / output_sample_size.
4011 * @return On error a negative value is returned, on success zero or the number
4012 * of bytes used to encode the data read from the input buffer.
4014 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4015 const short *samples);
4018 * Encode a video frame from pict into buf.
4019 * The input picture should be
4020 * stored using a specific format, namely avctx.pix_fmt.
4022 * @param avctx the codec context
4023 * @param[out] buf the output buffer for the bitstream of encoded frame
4024 * @param[in] buf_size the size of the output buffer in bytes
4025 * @param[in] pict the input picture to encode
4026 * @return On error a negative value is returned, on success zero or the number
4027 * of bytes used from the output buffer.
4029 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4030 const AVFrame *pict);
4031 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4032 const AVSubtitle *sub);
4034 int avcodec_close(AVCodecContext *avctx);
4037 * Register all the codecs, parsers and bitstream filters which were enabled at
4038 * configuration time. If you do not call this function you can select exactly
4039 * which formats you want to support, by using the individual registration
4042 * @see avcodec_register
4043 * @see av_register_codec_parser
4044 * @see av_register_bitstream_filter
4046 void avcodec_register_all(void);
4049 * Flush buffers, should be called when seeking or when switching to a different stream.
4051 void avcodec_flush_buffers(AVCodecContext *avctx);
4053 void avcodec_default_free_buffers(AVCodecContext *s);
4055 /* misc useful functions */
4057 #if FF_API_OLD_FF_PICT_TYPES
4059 * Return a single letter to describe the given picture type pict_type.
4061 * @param[in] pict_type the picture type
4062 * @return A single character representing the picture type.
4063 * @deprecated Use av_get_picture_type_char() instead.
4065 attribute_deprecated
4066 char av_get_pict_type_char(int pict_type);
4070 * Return codec bits per sample.
4072 * @param[in] codec_id the codec
4073 * @return Number of bits per sample or zero if unknown for the given codec.
4075 int av_get_bits_per_sample(enum CodecID codec_id);
4077 #if FF_API_OLD_SAMPLE_FMT
4079 * @deprecated Use av_get_bytes_per_sample() instead.
4081 attribute_deprecated
4082 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4086 typedef struct AVCodecParserContext {
4088 struct AVCodecParser *parser;
4089 int64_t frame_offset; /* offset of the current frame */
4090 int64_t cur_offset; /* current offset
4091 (incremented by each av_parser_parse()) */
4092 int64_t next_frame_offset; /* offset of the next frame */
4094 int pict_type; /* XXX: Put it back in AVCodecContext. */
4096 * This field is used for proper frame duration computation in lavf.
4097 * It signals, how much longer the frame duration of the current frame
4098 * is compared to normal frame duration.
4100 * frame_duration = (1 + repeat_pict) * time_base
4102 * It is used by codecs like H.264 to display telecined material.
4104 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4105 int64_t pts; /* pts of the current frame */
4106 int64_t dts; /* dts of the current frame */
4111 int fetch_timestamp;
4113 #define AV_PARSER_PTS_NB 4
4114 int cur_frame_start_index;
4115 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4116 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4117 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4120 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4121 #define PARSER_FLAG_ONCE 0x0002
4122 /// Set if the parser has a valid file offset
4123 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4125 int64_t offset; ///< byte offset from starting packet start
4126 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4129 * Set by parser to 1 for key frames and 0 for non-key frames.
4130 * It is initialized to -1, so if the parser doesn't set this flag,
4131 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4137 * Time difference in stream time base units from the pts of this
4138 * packet to the point at which the output from the decoder has converged
4139 * independent from the availability of previous frames. That is, the
4140 * frames are virtually identical no matter if decoding started from
4141 * the very first frame or from this keyframe.
4142 * Is AV_NOPTS_VALUE if unknown.
4143 * This field is not the display duration of the current frame.
4144 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4147 * The purpose of this field is to allow seeking in streams that have no
4148 * keyframes in the conventional sense. It corresponds to the
4149 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4150 * essential for some types of subtitle streams to ensure that all
4151 * subtitles are correctly displayed after seeking.
4153 int64_t convergence_duration;
4155 // Timestamp generation support:
4157 * Synchronization point for start of timestamp generation.
4159 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4162 * For example, this corresponds to presence of H.264 buffering period
4168 * Offset of the current timestamp against last timestamp sync point in
4169 * units of AVCodecContext.time_base.
4171 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4172 * contain a valid timestamp offset.
4174 * Note that the timestamp of sync point has usually a nonzero
4175 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4176 * the next frame after timestamp sync point will be usually 1.
4178 * For example, this corresponds to H.264 cpb_removal_delay.
4180 int dts_ref_dts_delta;
4183 * Presentation delay of current frame in units of AVCodecContext.time_base.
4185 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4186 * contain valid non-negative timestamp delta (presentation time of a frame
4187 * must not lie in the past).
4189 * This delay represents the difference between decoding and presentation
4190 * time of the frame.
4192 * For example, this corresponds to H.264 dpb_output_delay.
4197 * Position of the packet in file.
4199 * Analogous to cur_frame_pts/dts
4201 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4204 * Byte position of currently parsed frame in stream.
4209 * Previous frame byte position.
4212 } AVCodecParserContext;
4214 typedef struct AVCodecParser {
4215 int codec_ids[5]; /* several codec IDs are permitted */
4217 int (*parser_init)(AVCodecParserContext *s);
4218 int (*parser_parse)(AVCodecParserContext *s,
4219 AVCodecContext *avctx,
4220 const uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size);
4222 void (*parser_close)(AVCodecParserContext *s);
4223 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4224 struct AVCodecParser *next;
4227 AVCodecParser *av_parser_next(AVCodecParser *c);
4229 void av_register_codec_parser(AVCodecParser *parser);
4230 AVCodecParserContext *av_parser_init(int codec_id);
4235 * @param s parser context.
4236 * @param avctx codec context.
4237 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4238 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4239 * @param buf input buffer.
4240 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4241 * @param pts input presentation timestamp.
4242 * @param dts input decoding timestamp.
4243 * @param pos input byte position in stream.
4244 * @return the number of bytes of the input bitstream used.
4249 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4256 * decode_frame(data, size);
4260 int av_parser_parse2(AVCodecParserContext *s,
4261 AVCodecContext *avctx,
4262 uint8_t **poutbuf, int *poutbuf_size,
4263 const uint8_t *buf, int buf_size,
4264 int64_t pts, int64_t dts,
4267 int av_parser_change(AVCodecParserContext *s,
4268 AVCodecContext *avctx,
4269 uint8_t **poutbuf, int *poutbuf_size,
4270 const uint8_t *buf, int buf_size, int keyframe);
4271 void av_parser_close(AVCodecParserContext *s);
4274 typedef struct AVBitStreamFilterContext {
4276 struct AVBitStreamFilter *filter;
4277 AVCodecParserContext *parser;
4278 struct AVBitStreamFilterContext *next;
4279 } AVBitStreamFilterContext;
4282 typedef struct AVBitStreamFilter {
4285 int (*filter)(AVBitStreamFilterContext *bsfc,
4286 AVCodecContext *avctx, const char *args,
4287 uint8_t **poutbuf, int *poutbuf_size,
4288 const uint8_t *buf, int buf_size, int keyframe);
4289 void (*close)(AVBitStreamFilterContext *bsfc);
4290 struct AVBitStreamFilter *next;
4291 } AVBitStreamFilter;
4293 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4294 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4295 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4296 AVCodecContext *avctx, const char *args,
4297 uint8_t **poutbuf, int *poutbuf_size,
4298 const uint8_t *buf, int buf_size, int keyframe);
4299 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4301 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4306 * Reallocate the given block if it is not large enough, otherwise do nothing.
4310 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4313 * Allocate a buffer, reusing the given one if large enough.
4315 * Contrary to av_fast_realloc the current buffer contents might not be
4316 * preserved and on error the old buffer is freed, thus no special
4317 * handling to avoid memleaks is necessary.
4319 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4320 * @param size size of the buffer *ptr points to
4321 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4322 * *size 0 if an error occurred.
4324 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4327 * Copy image src to dst. Wraps av_picture_data_copy() above.
4329 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4330 enum PixelFormat pix_fmt, int width, int height);
4333 * Crop image top and left side.
4335 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4336 enum PixelFormat pix_fmt, int top_band, int left_band);
4341 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4342 int padtop, int padbottom, int padleft, int padright, int *color);
4345 * Encode extradata length to a buffer. Used by xiph codecs.
4347 * @param s buffer to write to; must be at least (v/255+1) bytes long
4348 * @param v size of extradata in bytes
4349 * @return number of bytes written to the buffer.
4351 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4354 * Logs a generic warning message about a missing feature. This function is
4355 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4356 * only, and would normally not be used by applications.
4357 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4358 * a pointer to an AVClass struct
4359 * @param[in] feature string containing the name of the missing feature
4360 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4361 * If want_sample is non-zero, additional verbage will be added to the log
4362 * message which tells the user how to report samples to the development
4365 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4368 * Log a generic warning message asking for a sample. This function is
4369 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4370 * only, and would normally not be used by applications.
4371 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4372 * a pointer to an AVClass struct
4373 * @param[in] msg string containing an optional message, or NULL if no message
4375 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4378 * Register the hardware accelerator hwaccel.
4380 void av_register_hwaccel(AVHWAccel *hwaccel);
4383 * If hwaccel is NULL, returns the first registered hardware accelerator,
4384 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4385 * after hwaccel, or NULL if hwaccel is the last one.
4387 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4391 * Lock operation used by lockmgr
4394 AV_LOCK_CREATE, ///< Create a mutex
4395 AV_LOCK_OBTAIN, ///< Lock the mutex
4396 AV_LOCK_RELEASE, ///< Unlock the mutex
4397 AV_LOCK_DESTROY, ///< Free mutex resources
4401 * Register a user provided lock manager supporting the operations
4402 * specified by AVLockOp. mutex points to a (void *) where the
4403 * lockmgr should store/get a pointer to a user allocated mutex. It's
4404 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4406 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4407 * callback during the call to av_lockmgr_register().
4408 * Thus, the application must be prepared to handle that.
4409 * If cb is set to NULL the lockmgr will be unregistered.
4410 * Also note that during unregistration the previously registered
4411 * lockmgr callback may also be invoked.
4413 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4416 * Get the type of the given codec.
4418 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4420 #endif /* AVCODEC_AVCODEC_H */