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,
214 /* various PCM "codecs" */
215 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
216 CODEC_ID_PCM_S16LE= 0x10000,
232 CODEC_ID_PCM_S24DAUD,
234 CODEC_ID_PCM_S16LE_PLANAR,
244 /* various ADPCM codecs */
245 CODEC_ID_ADPCM_IMA_QT= 0x11000,
246 CODEC_ID_ADPCM_IMA_WAV,
247 CODEC_ID_ADPCM_IMA_DK3,
248 CODEC_ID_ADPCM_IMA_DK4,
249 CODEC_ID_ADPCM_IMA_WS,
250 CODEC_ID_ADPCM_IMA_SMJPEG,
259 CODEC_ID_ADPCM_YAMAHA,
260 CODEC_ID_ADPCM_SBPRO_4,
261 CODEC_ID_ADPCM_SBPRO_3,
262 CODEC_ID_ADPCM_SBPRO_2,
264 CODEC_ID_ADPCM_IMA_AMV,
265 CODEC_ID_ADPCM_EA_R1,
266 CODEC_ID_ADPCM_EA_R3,
267 CODEC_ID_ADPCM_EA_R2,
268 CODEC_ID_ADPCM_IMA_EA_SEAD,
269 CODEC_ID_ADPCM_IMA_EA_EACS,
270 CODEC_ID_ADPCM_EA_XAS,
271 CODEC_ID_ADPCM_EA_MAXIS_XA,
272 CODEC_ID_ADPCM_IMA_ISS,
276 CODEC_ID_AMR_NB= 0x12000,
279 /* RealAudio codecs*/
280 CODEC_ID_RA_144= 0x13000,
283 /* various DPCM codecs */
284 CODEC_ID_ROQ_DPCM= 0x14000,
285 CODEC_ID_INTERPLAY_DPCM,
290 CODEC_ID_MP2= 0x15000,
291 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
309 CODEC_ID_WESTWOOD_SND1,
310 CODEC_ID_GSM, ///< as in Berlin toast format
318 CODEC_ID_DSICINAUDIO,
322 CODEC_ID_GSM_MS, /* as found in WAV */
331 CODEC_ID_WMALOSSLESS,
340 CODEC_ID_BINKAUDIO_RDFT,
341 CODEC_ID_BINKAUDIO_DCT,
346 /* subtitle codecs */
347 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
348 CODEC_ID_DVD_SUBTITLE= 0x17000,
349 CODEC_ID_DVB_SUBTITLE,
350 CODEC_ID_TEXT, ///< raw UTF-8 text
354 CODEC_ID_HDMV_PGS_SUBTITLE,
355 CODEC_ID_DVB_TELETEXT,
359 /* other specific kind of codecs (generally used for attachments) */
360 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
361 CODEC_ID_TTF= 0x18000,
363 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
365 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
366 * stream (only used by libavformat) */
367 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
370 #if FF_API_OLD_SAMPLE_FMT
371 #define SampleFormat AVSampleFormat
373 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
374 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
375 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
376 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
377 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
378 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
379 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
382 #if FF_API_OLD_AUDIOCONVERT
383 #include "libavutil/audioconvert.h"
385 /* Audio channel masks */
386 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
387 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
388 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
389 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
390 #define CH_BACK_LEFT AV_CH_BACK_LEFT
391 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
392 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
393 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
394 #define CH_BACK_CENTER AV_CH_BACK_CENTER
395 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
396 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
397 #define CH_TOP_CENTER AV_CH_TOP_CENTER
398 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
399 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
400 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
401 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
402 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
403 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
404 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
405 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
407 /** Channel mask value used for AVCodecContext.request_channel_layout
408 to indicate that the user requests the channel order of the decoder output
409 to be the native codec channel order. */
410 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
412 /* Audio channel convenience macros */
413 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
414 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
415 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
416 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
417 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
418 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
419 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
420 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
421 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
422 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
423 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
424 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
425 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
426 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
427 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
431 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
434 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
435 * This is mainly needed because some optimized bitstream readers read
436 * 32 or 64 bit at once and could read over the end.<br>
437 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
438 * MPEG bitstreams could cause overread and segfault.
440 #define FF_INPUT_BUFFER_PADDING_SIZE 16
443 * minimum encoding buffer size
444 * Used to avoid some checks during header writing.
446 #define FF_MIN_BUFFER_SIZE 16384
450 * motion estimation type.
453 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
457 ME_EPZS, ///< enhanced predictive zonal search
458 ME_X1, ///< reserved for experiments
459 ME_HEX, ///< hexagon based search
460 ME_UMH, ///< uneven multi-hexagon search
461 ME_ITER, ///< iterative search
462 ME_TESA, ///< transformed exhaustive search algorithm
466 /* We leave some space between them for extensions (drop some
467 * keyframes for intra-only or drop just some bidir frames). */
468 AVDISCARD_NONE =-16, ///< discard nothing
469 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
470 AVDISCARD_NONREF = 8, ///< discard all non reference
471 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
472 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
473 AVDISCARD_ALL = 48, ///< discard all
476 enum AVColorPrimaries{
477 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
478 AVCOL_PRI_UNSPECIFIED=2,
480 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
481 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
482 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
484 AVCOL_PRI_NB , ///< Not part of ABI
487 enum AVColorTransferCharacteristic{
488 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
489 AVCOL_TRC_UNSPECIFIED=2,
490 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
491 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
492 AVCOL_TRC_NB , ///< Not part of ABI
497 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
498 AVCOL_SPC_UNSPECIFIED=2,
500 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
501 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
502 AVCOL_SPC_SMPTE240M =7,
503 AVCOL_SPC_NB , ///< Not part of ABI
507 AVCOL_RANGE_UNSPECIFIED=0,
508 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
509 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
510 AVCOL_RANGE_NB , ///< Not part of ABI
514 * X X 3 4 X X are luma samples,
515 * 1 2 1-6 are possible chroma positions
516 * X X 5 6 X 0 is undefined/unknown position
518 enum AVChromaLocation{
519 AVCHROMA_LOC_UNSPECIFIED=0,
520 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
521 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
522 AVCHROMA_LOC_TOPLEFT =3, ///< DV
524 AVCHROMA_LOC_BOTTOMLEFT =5,
525 AVCHROMA_LOC_BOTTOM =6,
526 AVCHROMA_LOC_NB , ///< Not part of ABI
529 #if FF_API_FLAC_GLOBAL_OPTS
533 attribute_deprecated enum AVLPCType {
534 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
535 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
536 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
537 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
538 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
539 AV_LPC_TYPE_NB , ///< Not part of ABI
543 enum AVAudioServiceType {
544 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
545 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
546 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
547 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
548 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
549 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
550 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
551 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
552 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
553 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
556 typedef struct RcOverride{
559 int qscale; // If this is 0 then quality_factor will be used instead.
560 float quality_factor;
563 #define FF_MAX_B_FRAMES 16
566 These flags can be passed in AVCodecContext.flags before initialization.
567 Note: Not everything is supported yet.
570 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
571 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
572 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
573 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
574 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
575 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
577 * The parent program guarantees that the input for B-frames containing
578 * streams is not written to for at least s->max_b_frames+1 frames, if
579 * this is not set the input will be copied.
581 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
582 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
583 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
584 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
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_ALT_SCAN 0x00100000 ///< Use alternate scan.
594 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
595 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
596 /* Fx : Flag for h263+ extra options */
597 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
598 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
599 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
600 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
601 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
602 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
603 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
604 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
605 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
606 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
607 #define CODEC_FLAG_CLOSED_GOP 0x80000000
608 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
609 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
610 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
611 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
612 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
613 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
614 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
615 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
616 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
617 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
618 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
619 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
620 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
621 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
622 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
623 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
624 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
625 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
626 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
627 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
628 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
629 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
631 /* Unsupported options :
632 * Syntax Arithmetic coding (SAC)
633 * Reference Picture Selection
634 * Independent Segment Decoding */
636 /* codec capabilities */
638 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
640 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
641 * If not set, it might not use get_buffer() at all or use operations that
642 * assume the buffer was allocated by avcodec_default_get_buffer.
644 #define CODEC_CAP_DR1 0x0002
645 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
646 #define CODEC_CAP_PARSE_ONLY 0x0004
647 #define CODEC_CAP_TRUNCATED 0x0008
648 /* Codec can export data for HW decoding (XvMC). */
649 #define CODEC_CAP_HWACCEL 0x0010
651 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
652 * If this is not set, the codec is guaranteed to never be fed with NULL data.
654 #define CODEC_CAP_DELAY 0x0020
656 * Codec can be fed a final frame with a smaller size.
657 * This can be used to prevent truncation of the last audio samples.
659 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
661 * Codec can export data for HW decoding (VDPAU).
663 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
665 * Codec can output multiple frames per AVPacket
666 * Normally demuxers return one frame at a time, demuxers which do not do
667 * are connected to a parser to split what they return into proper frames.
668 * This flag is reserved to the very rare category of codecs which have a
669 * bitstream that cannot be split into frames without timeconsuming
670 * operations like full decoding. Demuxers carring such bitstreams thus
671 * may return multiple frames in a packet. This has many disadvantages like
672 * prohibiting stream copy in many cases thus it should only be considered
675 #define CODEC_CAP_SUBFRAMES 0x0100
677 * Codec is experimental and is thus avoided in favor of non experimental
680 #define CODEC_CAP_EXPERIMENTAL 0x0200
682 * Codec should fill in channel configuration and samplerate instead of container
684 #define CODEC_CAP_CHANNEL_CONF 0x0400
687 * Codec is able to deal with negative linesizes
689 #define CODEC_CAP_NEG_LINESIZES 0x0800
692 * Codec supports frame-level multithreading.
694 #define CODEC_CAP_FRAME_THREADS 0x1000
696 * Codec supports slice-based (or partition-based) multithreading.
698 #define CODEC_CAP_SLICE_THREADS 0x2000
702 #define CODEC_CAP_LOSSLESS 0x80000000
704 //The following defines may change, don't expect compatibility if you use them.
705 #define MB_TYPE_INTRA4x4 0x0001
706 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
707 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
708 #define MB_TYPE_16x16 0x0008
709 #define MB_TYPE_16x8 0x0010
710 #define MB_TYPE_8x16 0x0020
711 #define MB_TYPE_8x8 0x0040
712 #define MB_TYPE_INTERLACED 0x0080
713 #define MB_TYPE_DIRECT2 0x0100 //FIXME
714 #define MB_TYPE_ACPRED 0x0200
715 #define MB_TYPE_GMC 0x0400
716 #define MB_TYPE_SKIP 0x0800
717 #define MB_TYPE_P0L0 0x1000
718 #define MB_TYPE_P1L0 0x2000
719 #define MB_TYPE_P0L1 0x4000
720 #define MB_TYPE_P1L1 0x8000
721 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
722 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
723 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
724 #define MB_TYPE_QUANT 0x00010000
725 #define MB_TYPE_CBP 0x00020000
726 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
730 * This specifies the area which should be displayed.
731 * Note there may be multiple such areas for one frame.
733 typedef struct AVPanScan{
736 * - encoding: Set by user.
737 * - decoding: Set by libavcodec.
742 * width and height in 1/16 pel
743 * - encoding: Set by user.
744 * - decoding: Set by libavcodec.
750 * position of the top left corner in 1/16 pel for up to 3 fields/frames
751 * - encoding: Set by user.
752 * - decoding: Set by libavcodec.
754 int16_t position[3][2];
757 #define FF_QSCALE_TYPE_MPEG1 0
758 #define FF_QSCALE_TYPE_MPEG2 1
759 #define FF_QSCALE_TYPE_H264 2
760 #define FF_QSCALE_TYPE_VP56 3
762 #define FF_BUFFER_TYPE_INTERNAL 1
763 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
764 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
765 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
767 #if FF_API_OLD_FF_PICT_TYPES
768 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
769 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
770 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
771 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
772 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
773 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
774 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
775 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
778 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
779 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
780 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
781 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
783 enum AVPacketSideDataType {
787 typedef struct AVPacket {
789 * Presentation timestamp in AVStream->time_base units; the time at which
790 * the decompressed packet will be presented to the user.
791 * Can be AV_NOPTS_VALUE if it is not stored in the file.
792 * pts MUST be larger or equal to dts as presentation cannot happen before
793 * decompression, unless one wants to view hex dumps. Some formats misuse
794 * the terms dts and pts/cts to mean something different. Such timestamps
795 * must be converted to true pts/dts before they are stored in AVPacket.
799 * Decompression timestamp in AVStream->time_base units; the time at which
800 * the packet is decompressed.
801 * Can be AV_NOPTS_VALUE if it is not stored in the file.
808 * A combination of AV_PKT_FLAG values
812 * Additional packet data that can be provided by the container.
813 * Packet can contain several types of side information.
818 enum AVPacketSideDataType type;
823 * Duration of this packet in AVStream->time_base units, 0 if unknown.
824 * Equals next_pts - this_pts in presentation order.
827 void (*destruct)(struct AVPacket *);
829 int64_t pos; ///< byte position in stream, -1 if unknown
832 * Time difference in AVStream->time_base units from the pts of this
833 * packet to the point at which the output from the decoder has converged
834 * independent from the availability of previous frames. That is, the
835 * frames are virtually identical no matter if decoding started from
836 * the very first frame or from this keyframe.
837 * Is AV_NOPTS_VALUE if unknown.
838 * This field is not the display duration of the current packet.
839 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
842 * The purpose of this field is to allow seeking in streams that have no
843 * keyframes in the conventional sense. It corresponds to the
844 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
845 * essential for some types of subtitle streams to ensure that all
846 * subtitles are correctly displayed after seeking.
848 int64_t convergence_duration;
850 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
851 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
855 * New fields can be added to the end of AVFRAME with minor version
856 * bumps. Removal, reordering and changes to existing fields require
857 * a major version bump.
858 * sizeof(AVFrame) must not be used outside libav*.
860 typedef struct AVFrame {
862 * pointer to the picture planes.
863 * This might be different from the first allocated byte
870 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
871 * This isn't used by libavcodec unless the default get/release_buffer() is used.
877 * 1 -> keyframe, 0-> not
878 * - encoding: Set by libavcodec.
879 * - decoding: Set by libavcodec.
884 * Picture type of the frame, see ?_TYPE below.
885 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
886 * - decoding: Set by libavcodec.
888 enum AVPictureType pict_type;
891 * presentation timestamp in time_base units (time when frame should be shown to user)
892 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
893 * - encoding: MUST be set by user.
894 * - decoding: Set by libavcodec.
899 * picture number in bitstream order
901 * - decoding: Set by libavcodec.
903 int coded_picture_number;
905 * picture number in display order
907 * - decoding: Set by libavcodec.
909 int display_picture_number;
912 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
913 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
914 * - decoding: Set by libavcodec.
919 * buffer age (1->was last buffer and dint change, 2->..., ...).
920 * Set to INT_MAX if the buffer has not been used yet.
922 * - decoding: MUST be set by get_buffer().
927 * is this picture used as reference
928 * The values for this are the same as the MpegEncContext.picture_structure
929 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
930 * Set to 4 for delayed, non-reference frames.
932 * - decoding: Set by libavcodec. (before get_buffer() call)).
939 * - decoding: Set by libavcodec.
941 int8_t *qscale_table;
945 * - decoding: Set by libavcodec.
950 * mbskip_table[mb]>=1 if MB didn't change
951 * stride= mb_width = (width+15)>>4
953 * - decoding: Set by libavcodec.
955 uint8_t *mbskip_table;
958 * motion vector table
961 * int mv_sample_log2= 4 - motion_subsample_log2;
962 * int mb_width= (width+15)>>4;
963 * int mv_stride= (mb_width << mv_sample_log2) + 1;
964 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
966 * - encoding: Set by user.
967 * - decoding: Set by libavcodec.
969 int16_t (*motion_val[2])[2];
972 * macroblock type table
973 * mb_type_base + mb_width + 2
974 * - encoding: Set by user.
975 * - decoding: Set by libavcodec.
980 * log2 of the size of the block which a single vector in motion_val represents:
981 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
983 * - decoding: Set by libavcodec.
985 uint8_t motion_subsample_log2;
988 * for some private data of the user
990 * - decoding: Set by user.
996 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1002 * type of the buffer (to keep track of who has to deallocate data[*])
1003 * - encoding: Set by the one who allocates it.
1004 * - decoding: Set by the one who allocates it.
1005 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1010 * When decoding, this signals how much the picture must be delayed.
1011 * extra_delay = repeat_pict / (2*fps)
1012 * - encoding: unused
1013 * - decoding: Set by libavcodec.
1023 * The content of the picture is interlaced.
1024 * - encoding: Set by user.
1025 * - decoding: Set by libavcodec. (default 0)
1027 int interlaced_frame;
1030 * If the content is interlaced, is top field displayed first.
1031 * - encoding: Set by user.
1032 * - decoding: Set by libavcodec.
1034 int top_field_first;
1038 * - encoding: Set by user.
1039 * - decoding: Set by libavcodec.
1041 AVPanScan *pan_scan;
1044 * Tell user application that palette has changed from previous frame.
1045 * - encoding: ??? (no palette-enabled encoder yet)
1046 * - decoding: Set by libavcodec. (default 0).
1048 int palette_has_changed;
1051 * codec suggestion on buffer type if != 0
1052 * - encoding: unused
1053 * - decoding: Set by libavcodec. (before get_buffer() call)).
1059 * - encoding: unused
1060 * - decoding: Set by libavcodec.
1065 * motion reference frame index
1066 * the order in which these are stored can depend on the codec.
1067 * - encoding: Set by user.
1068 * - decoding: Set by libavcodec.
1070 int8_t *ref_index[2];
1073 * reordered opaque 64bit (generally an integer or a double precision float
1074 * PTS but can be anything).
1075 * The user sets AVCodecContext.reordered_opaque to represent the input at
1077 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1078 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1079 * @deprecated in favor of pkt_pts
1080 * - encoding: unused
1081 * - decoding: Read by user.
1083 int64_t reordered_opaque;
1086 * hardware accelerator private data (FFmpeg-allocated)
1087 * - encoding: unused
1088 * - decoding: Set by libavcodec
1090 void *hwaccel_picture_private;
1093 * reordered pts from the last AVPacket that has been input into the decoder
1094 * - encoding: unused
1095 * - decoding: Read by user.
1100 * dts from the last AVPacket that has been input into the decoder
1101 * - encoding: unused
1102 * - decoding: Read by user.
1107 * the AVCodecContext which ff_thread_get_buffer() was last called on
1108 * - encoding: Set by libavcodec.
1109 * - decoding: Set by libavcodec.
1111 struct AVCodecContext *owner;
1114 * used by multithreading to store frame-specific info
1115 * - encoding: Set by libavcodec.
1116 * - decoding: Set by libavcodec.
1118 void *thread_opaque;
1121 * frame timestamp estimated using various heuristics, in stream time base
1122 * - encoding: unused
1123 * - decoding: set by libavcodec, read by user.
1125 int64_t best_effort_timestamp;
1128 * reordered pos from the last AVPacket that has been input into the decoder
1129 * - encoding: unused
1130 * - decoding: Read by user.
1135 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1136 * - encoding: unused
1137 * - decoding: Read by user.
1139 AVRational sample_aspect_ratio;
1142 * width and height of the video frame
1143 * - encoding: unused
1144 * - decoding: Read by user.
1149 * format of the frame, -1 if unknown or unset
1150 * It should be cast to the corresponding enum (enum PixelFormat
1151 * for video, enum AVSampleFormat for audio)
1152 * - encoding: unused
1153 * - decoding: Read by user.
1160 * main external API structure.
1161 * New fields can be added to the end with minor version bumps.
1162 * Removal, reordering and changes to existing fields require a major
1164 * sizeof(AVCodecContext) must not be used outside libav*.
1166 typedef struct AVCodecContext {
1168 * information on struct for av_log
1169 * - set by avcodec_alloc_context
1171 const AVClass *av_class;
1173 * the average bitrate
1174 * - encoding: Set by user; unused for constant quantizer encoding.
1175 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1180 * number of bits the bitstream is allowed to diverge from the reference.
1181 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1182 * - encoding: Set by user; unused for constant quantizer encoding.
1183 * - decoding: unused
1185 int bit_rate_tolerance;
1189 * - encoding: Set by user.
1190 * - decoding: Set by user.
1195 * Some codecs need additional format info. It is stored here.
1196 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1197 * specific codec MUST set it correctly otherwise stream copy breaks.
1198 * In general use of this field by muxers is not recommanded.
1199 * - encoding: Set by libavcodec.
1200 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1205 * Motion estimation algorithm used for video coding.
1206 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1207 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1208 * - encoding: MUST be set by user.
1209 * - decoding: unused
1214 * some codecs need / can use extradata like Huffman tables.
1215 * mjpeg: Huffman tables
1216 * rv10: additional flags
1217 * mpeg4: global headers (they can be in the bitstream or here)
1218 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1219 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1220 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1221 * - encoding: Set/allocated/freed by libavcodec.
1222 * - decoding: Set/allocated/freed by user.
1228 * This is the fundamental unit of time (in seconds) in terms
1229 * of which frame timestamps are represented. For fixed-fps content,
1230 * timebase should be 1/framerate and timestamp increments should be
1232 * - encoding: MUST be set by user.
1233 * - decoding: Set by libavcodec.
1235 AVRational time_base;
1239 * picture width / height.
1240 * - encoding: MUST be set by user.
1241 * - decoding: Set by libavcodec.
1242 * Note: For compatibility it is possible to set this instead of
1243 * coded_width/height before decoding.
1247 #define FF_ASPECT_EXTENDED 15
1250 * the number of pictures in a group of pictures, or 0 for intra_only
1251 * - encoding: Set by user.
1252 * - decoding: unused
1257 * Pixel format, see PIX_FMT_xxx.
1258 * May be set by the demuxer if known from headers.
1259 * May be overriden by the decoder if it knows better.
1260 * - encoding: Set by user.
1261 * - decoding: Set by user if known, overridden by libavcodec if known
1263 enum PixelFormat pix_fmt;
1266 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1267 * decoder to draw a horizontal band. It improves cache usage. Not
1268 * all codecs can do that. You must check the codec capabilities
1270 * When multithreading is used, it may be called from multiple threads
1271 * at the same time; threads might draw different parts of the same AVFrame,
1272 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1274 * The function is also used by hardware acceleration APIs.
1275 * It is called at least once during frame decoding to pass
1276 * the data needed for hardware render.
1277 * In that mode instead of pixel data, AVFrame points to
1278 * a structure specific to the acceleration API. The application
1279 * reads the structure and can change some fields to indicate progress
1281 * - encoding: unused
1282 * - decoding: Set by user.
1283 * @param height the height of the slice
1284 * @param y the y position of the slice
1285 * @param type 1->top field, 2->bottom field, 3->frame
1286 * @param offset offset into the AVFrame.data from which the slice should be read
1288 void (*draw_horiz_band)(struct AVCodecContext *s,
1289 const AVFrame *src, int offset[4],
1290 int y, int type, int height);
1293 int sample_rate; ///< samples per second
1294 int channels; ///< number of audio channels
1297 * audio sample format
1298 * - encoding: Set by user.
1299 * - decoding: Set by libavcodec.
1301 enum AVSampleFormat sample_fmt; ///< sample format
1303 /* The following data should not be initialized. */
1305 * Samples per packet, initialized when calling 'init'.
1308 int frame_number; ///< audio or video frame number
1311 * Number of frames the decoded output will be delayed relative to
1312 * the encoded input.
1313 * - encoding: Set by libavcodec.
1314 * - decoding: unused
1318 /* - encoding parameters */
1319 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1320 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1324 * - encoding: Set by user.
1325 * - decoding: unused
1331 * - encoding: Set by user.
1332 * - decoding: unused
1337 * maximum quantizer difference between frames
1338 * - encoding: Set by user.
1339 * - decoding: unused
1344 * maximum number of B-frames between non-B-frames
1345 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1346 * - encoding: Set by user.
1347 * - decoding: unused
1352 * qscale factor between IP and B-frames
1353 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1354 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1355 * - encoding: Set by user.
1356 * - decoding: unused
1358 float b_quant_factor;
1360 /** obsolete FIXME remove */
1362 #define FF_RC_STRATEGY_XVID 1
1364 int b_frame_strategy;
1366 struct AVCodec *codec;
1370 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1371 /* do its best to deliver a chunk with size */
1372 /* below rtp_payload_size, the chunk will start */
1373 /* with a start code on some codecs like H.263. */
1374 /* This doesn't take account of any particular */
1375 /* headers inside the transmitted RTP payload. */
1378 /* The RTP callback: This function is called */
1379 /* every time the encoder has a packet to send. */
1380 /* It depends on the encoder if the data starts */
1381 /* with a Start Code (it should). H.263 does. */
1382 /* mb_nb contains the number of macroblocks */
1383 /* encoded in the RTP payload. */
1384 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1386 /* statistics, used for 2-pass encoding */
1397 * number of bits used for the previously encoded frame
1398 * - encoding: Set by libavcodec.
1399 * - decoding: unused
1404 * Private data of the user, can be used to carry app specific stuff.
1405 * - encoding: Set by user.
1406 * - decoding: Set by user.
1410 char codec_name[32];
1411 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1412 enum CodecID codec_id; /* see CODEC_ID_xxx */
1415 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1416 * This is used to work around some encoder bugs.
1417 * A demuxer should set this to what is stored in the field used to identify the codec.
1418 * If there are multiple such fields in a container then the demuxer should choose the one
1419 * which maximizes the information about the used codec.
1420 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1421 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1422 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1424 * - encoding: Set by user, if not then the default based on codec_id will be used.
1425 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1427 unsigned int codec_tag;
1430 * Work around bugs in encoders which sometimes cannot be detected automatically.
1431 * - encoding: Set by user
1432 * - decoding: Set by user
1434 int workaround_bugs;
1435 #define FF_BUG_AUTODETECT 1 ///< autodetection
1436 #define FF_BUG_OLD_MSMPEG4 2
1437 #define FF_BUG_XVID_ILACE 4
1438 #define FF_BUG_UMP4 8
1439 #define FF_BUG_NO_PADDING 16
1440 #define FF_BUG_AMV 32
1441 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1442 #define FF_BUG_QPEL_CHROMA 64
1443 #define FF_BUG_STD_QPEL 128
1444 #define FF_BUG_QPEL_CHROMA2 256
1445 #define FF_BUG_DIRECT_BLOCKSIZE 512
1446 #define FF_BUG_EDGE 1024
1447 #define FF_BUG_HPEL_CHROMA 2048
1448 #define FF_BUG_DC_CLIP 4096
1449 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1450 #define FF_BUG_TRUNCATED 16384
1451 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1454 * luma single coefficient elimination threshold
1455 * - encoding: Set by user.
1456 * - decoding: unused
1458 int luma_elim_threshold;
1461 * chroma single coeff elimination threshold
1462 * - encoding: Set by user.
1463 * - decoding: unused
1465 int chroma_elim_threshold;
1468 * strictly follow the standard (MPEG4, ...).
1469 * - encoding: Set by user.
1470 * - decoding: Set by user.
1471 * Setting this to STRICT or higher means the encoder and decoder will
1472 * generally do stupid things, whereas setting it to unofficial or lower
1473 * will mean the encoder might produce output that is not supported by all
1474 * spec-compliant decoders. Decoders don't differentiate between normal,
1475 * unofficial and experimental (that is, they always try to decode things
1476 * when they can) unless they are explicitly asked to behave stupidly
1477 * (=strictly conform to the specs)
1479 int strict_std_compliance;
1480 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1481 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1482 #define FF_COMPLIANCE_NORMAL 0
1483 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1484 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1487 * qscale offset between IP and B-frames
1488 * - encoding: Set by user.
1489 * - decoding: unused
1491 float b_quant_offset;
1494 * Error recognition; higher values will detect more errors but may
1495 * misdetect some more or less valid parts as errors.
1496 * - encoding: unused
1497 * - decoding: Set by user.
1499 int error_recognition;
1500 #define FF_ER_CAREFUL 1
1501 #define FF_ER_COMPLIANT 2
1502 #define FF_ER_AGGRESSIVE 3
1503 #if FF_API_VERY_AGGRESSIVE
1504 #define FF_ER_VERY_AGGRESSIVE 4
1505 #define FF_ER_EXPLODE 5
1507 #define FF_ER_EXPLODE 4
1508 #endif /* FF_API_VERY_AGGRESSIVE */
1511 * Called at the beginning of each frame to get a buffer for it.
1512 * If pic.reference is set then the frame will be read later by libavcodec.
1513 * avcodec_align_dimensions2() should be used to find the required width and
1514 * height, as they normally need to be rounded up to the next multiple of 16.
1515 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1516 * avcodec_default_get_buffer() instead of providing buffers allocated by
1518 * If frame multithreading is used and thread_safe_callbacks is set,
1519 * it may be called from a different thread, but not from more than one at once.
1520 * Does not need to be reentrant.
1521 * - encoding: unused
1522 * - decoding: Set by libavcodec, user can override.
1524 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1527 * Called to release buffers which were allocated with get_buffer.
1528 * A released buffer can be reused in get_buffer().
1529 * pic.data[*] must be set to NULL.
1530 * May be called from a different thread if frame multithreading is used,
1531 * but not by more than one thread at once, so does not need to be reentrant.
1532 * - encoding: unused
1533 * - decoding: Set by libavcodec, user can override.
1535 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1538 * Size of the frame reordering buffer in the decoder.
1539 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1540 * - encoding: Set by libavcodec.
1541 * - decoding: Set by libavcodec.
1546 * number of bytes per packet if constant and known or 0
1547 * Used by some WAV based audio codecs.
1551 int parse_only; /* - decoding only: If true, only parsing is done
1552 (function avcodec_parse_frame()). The frame
1553 data is returned. Only MPEG codecs support this now. */
1556 * 0-> h263 quant 1-> mpeg quant
1557 * - encoding: Set by user.
1558 * - decoding: unused
1563 * pass1 encoding statistics output buffer
1564 * - encoding: Set by libavcodec.
1565 * - decoding: unused
1570 * pass2 encoding statistics input buffer
1571 * Concatenated stuff from stats_out of pass1 should be placed here.
1572 * - encoding: Allocated/set/freed by user.
1573 * - decoding: unused
1578 * ratecontrol qmin qmax limiting method
1579 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1580 * - encoding: Set by user.
1581 * - decoding: unused
1589 * ratecontrol override, see RcOverride
1590 * - encoding: Allocated/set/freed by user.
1591 * - decoding: unused
1593 RcOverride *rc_override;
1594 int rc_override_count;
1597 * rate control equation
1598 * - encoding: Set by user
1599 * - decoding: unused
1605 * - encoding: Set by user.
1606 * - decoding: unused
1612 * - encoding: Set by user.
1613 * - decoding: unused
1618 * decoder bitstream buffer size
1619 * - encoding: Set by user.
1620 * - decoding: unused
1623 float rc_buffer_aggressivity;
1626 * qscale factor between P and I-frames
1627 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1628 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1629 * - encoding: Set by user.
1630 * - decoding: unused
1632 float i_quant_factor;
1635 * qscale offset between P and I-frames
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 float i_quant_offset;
1642 * initial complexity for pass1 ratecontrol
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 float rc_initial_cplx;
1649 * DCT algorithm, see FF_DCT_* below
1650 * - encoding: Set by user.
1651 * - decoding: unused
1654 #define FF_DCT_AUTO 0
1655 #define FF_DCT_FASTINT 1
1656 #define FF_DCT_INT 2
1657 #define FF_DCT_MMX 3
1658 #define FF_DCT_MLIB 4
1659 #define FF_DCT_ALTIVEC 5
1660 #define FF_DCT_FAAN 6
1663 * luminance masking (0-> disabled)
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * temporary complexity masking (0-> disabled)
1671 * - encoding: Set by user.
1672 * - decoding: unused
1674 float temporal_cplx_masking;
1677 * spatial complexity masking (0-> disabled)
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 float spatial_cplx_masking;
1684 * p block masking (0-> disabled)
1685 * - encoding: Set by user.
1686 * - decoding: unused
1691 * darkness masking (0-> disabled)
1692 * - encoding: Set by user.
1693 * - decoding: unused
1698 * IDCT algorithm, see FF_IDCT_* below.
1699 * - encoding: Set by user.
1700 * - decoding: Set by user.
1703 #define FF_IDCT_AUTO 0
1704 #define FF_IDCT_INT 1
1705 #define FF_IDCT_SIMPLE 2
1706 #define FF_IDCT_SIMPLEMMX 3
1707 #define FF_IDCT_LIBMPEG2MMX 4
1708 #define FF_IDCT_PS2 5
1709 #define FF_IDCT_MLIB 6
1710 #define FF_IDCT_ARM 7
1711 #define FF_IDCT_ALTIVEC 8
1712 #define FF_IDCT_SH4 9
1713 #define FF_IDCT_SIMPLEARM 10
1714 #define FF_IDCT_H264 11
1715 #define FF_IDCT_VP3 12
1716 #define FF_IDCT_IPP 13
1717 #define FF_IDCT_XVIDMMX 14
1718 #define FF_IDCT_CAVS 15
1719 #define FF_IDCT_SIMPLEARMV5TE 16
1720 #define FF_IDCT_SIMPLEARMV6 17
1721 #define FF_IDCT_SIMPLEVIS 18
1722 #define FF_IDCT_WMV2 19
1723 #define FF_IDCT_FAAN 20
1724 #define FF_IDCT_EA 21
1725 #define FF_IDCT_SIMPLENEON 22
1726 #define FF_IDCT_SIMPLEALPHA 23
1727 #define FF_IDCT_BINK 24
1731 * - encoding: Set by libavcodec.
1732 * - decoding: Set by user (or 0).
1736 * slice offsets in the frame in bytes
1737 * - encoding: Set/allocated by libavcodec.
1738 * - decoding: Set/allocated by user (or NULL).
1743 * error concealment flags
1744 * - encoding: unused
1745 * - decoding: Set by user.
1747 int error_concealment;
1748 #define FF_EC_GUESS_MVS 1
1749 #define FF_EC_DEBLOCK 2
1752 * dsp_mask could be add used to disable unwanted CPU features
1753 * CPU features (i.e. MMX, SSE. ...)
1755 * With the FORCE flag you may instead enable given CPU features.
1756 * (Dangerous: Usable in case of misdetection, improper usage however will
1757 * result into program crash.)
1762 * bits per sample/pixel from the demuxer (needed for huffyuv).
1763 * - encoding: Set by libavcodec.
1764 * - decoding: Set by user.
1766 int bits_per_coded_sample;
1769 * prediction method (needed for huffyuv)
1770 * - encoding: Set by user.
1771 * - decoding: unused
1773 int prediction_method;
1774 #define FF_PRED_LEFT 0
1775 #define FF_PRED_PLANE 1
1776 #define FF_PRED_MEDIAN 2
1779 * sample aspect ratio (0 if unknown)
1780 * That is the width of a pixel divided by the height of the pixel.
1781 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1782 * - encoding: Set by user.
1783 * - decoding: Set by libavcodec.
1785 AVRational sample_aspect_ratio;
1788 * the picture in the bitstream
1789 * - encoding: Set by libavcodec.
1790 * - decoding: Set by libavcodec.
1792 AVFrame *coded_frame;
1796 * - encoding: Set by user.
1797 * - decoding: Set by user.
1800 #define FF_DEBUG_PICT_INFO 1
1801 #define FF_DEBUG_RC 2
1802 #define FF_DEBUG_BITSTREAM 4
1803 #define FF_DEBUG_MB_TYPE 8
1804 #define FF_DEBUG_QP 16
1805 #define FF_DEBUG_MV 32
1806 #define FF_DEBUG_DCT_COEFF 0x00000040
1807 #define FF_DEBUG_SKIP 0x00000080
1808 #define FF_DEBUG_STARTCODE 0x00000100
1809 #define FF_DEBUG_PTS 0x00000200
1810 #define FF_DEBUG_ER 0x00000400
1811 #define FF_DEBUG_MMCO 0x00000800
1812 #define FF_DEBUG_BUGS 0x00001000
1813 #define FF_DEBUG_VIS_QP 0x00002000
1814 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1815 #define FF_DEBUG_BUFFERS 0x00008000
1816 #define FF_DEBUG_THREADS 0x00010000
1820 * - encoding: Set by user.
1821 * - decoding: Set by user.
1824 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1825 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1826 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1830 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1831 * - decoding: unused
1836 * motion estimation comparison function
1837 * - encoding: Set by user.
1838 * - decoding: unused
1842 * subpixel motion estimation comparison function
1843 * - encoding: Set by user.
1844 * - decoding: unused
1848 * macroblock comparison function (not supported yet)
1849 * - encoding: Set by user.
1850 * - decoding: unused
1854 * interlaced DCT comparison function
1855 * - encoding: Set by user.
1856 * - decoding: unused
1859 #define FF_CMP_SAD 0
1860 #define FF_CMP_SSE 1
1861 #define FF_CMP_SATD 2
1862 #define FF_CMP_DCT 3
1863 #define FF_CMP_PSNR 4
1864 #define FF_CMP_BIT 5
1866 #define FF_CMP_ZERO 7
1867 #define FF_CMP_VSAD 8
1868 #define FF_CMP_VSSE 9
1869 #define FF_CMP_NSSE 10
1870 #define FF_CMP_W53 11
1871 #define FF_CMP_W97 12
1872 #define FF_CMP_DCTMAX 13
1873 #define FF_CMP_DCT264 14
1874 #define FF_CMP_CHROMA 256
1877 * ME diamond size & shape
1878 * - encoding: Set by user.
1879 * - decoding: unused
1884 * amount of previous MV predictors (2a+1 x 2a+1 square)
1885 * - encoding: Set by user.
1886 * - decoding: unused
1888 int last_predictor_count;
1891 * prepass for motion estimation
1892 * - encoding: Set by user.
1893 * - decoding: unused
1898 * motion estimation prepass comparison function
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * ME prepass diamond size & shape
1906 * - encoding: Set by user.
1907 * - decoding: unused
1913 * - encoding: Set by user.
1914 * - decoding: unused
1916 int me_subpel_quality;
1919 * callback to negotiate the pixelFormat
1920 * @param fmt is the list of formats which are supported by the codec,
1921 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1922 * The first is always the native one.
1923 * @return the chosen format
1924 * - encoding: unused
1925 * - decoding: Set by user, if not set the native format will be chosen.
1927 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1930 * DTG active format information (additional aspect ratio
1931 * information only used in DVB MPEG-2 transport streams)
1934 * - encoding: unused
1935 * - decoding: Set by decoder.
1937 int dtg_active_format;
1938 #define FF_DTG_AFD_SAME 8
1939 #define FF_DTG_AFD_4_3 9
1940 #define FF_DTG_AFD_16_9 10
1941 #define FF_DTG_AFD_14_9 11
1942 #define FF_DTG_AFD_4_3_SP_14_9 13
1943 #define FF_DTG_AFD_16_9_SP_14_9 14
1944 #define FF_DTG_AFD_SP_4_3 15
1947 * maximum motion estimation search range in subpel units
1948 * If 0 then no limit.
1950 * - encoding: Set by user.
1951 * - decoding: unused
1956 * intra quantizer bias
1957 * - encoding: Set by user.
1958 * - decoding: unused
1960 int intra_quant_bias;
1961 #define FF_DEFAULT_QUANT_BIAS 999999
1964 * inter quantizer bias
1965 * - encoding: Set by user.
1966 * - decoding: unused
1968 int inter_quant_bias;
1972 * - encoding: unused
1973 * - decoding: Which clrtable should be used for 8bit RGB images.
1974 * Tables have to be stored somewhere. FIXME
1979 * internal_buffer count
1980 * Don't touch, used by libavcodec default_get_buffer().
1982 int internal_buffer_count;
1986 * Don't touch, used by libavcodec default_get_buffer().
1988 void *internal_buffer;
1991 * Global quality for codecs which cannot change it per frame.
1992 * This should be proportional to MPEG-1/2/4 qscale.
1993 * - encoding: Set by user.
1994 * - decoding: unused
1998 #define FF_CODER_TYPE_VLC 0
1999 #define FF_CODER_TYPE_AC 1
2000 #define FF_CODER_TYPE_RAW 2
2001 #define FF_CODER_TYPE_RLE 3
2002 #define FF_CODER_TYPE_DEFLATE 4
2005 * - encoding: Set by user.
2006 * - decoding: unused
2012 * - encoding: Set by user.
2013 * - decoding: unused
2019 * - encoding: unused
2020 * - decoding: Set by user.
2022 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2027 * - encoding: unused
2028 * - decoding: Set by user.
2031 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2032 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2033 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2036 * XVideo Motion Acceleration
2037 * - encoding: forbidden
2038 * - decoding: set by decoder
2040 int xvmc_acceleration;
2043 * macroblock decision mode
2044 * - encoding: Set by user.
2045 * - decoding: unused
2048 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2049 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2050 #define FF_MB_DECISION_RD 2 ///< rate distortion
2053 * custom intra quantization matrix
2054 * - encoding: Set by user, can be NULL.
2055 * - decoding: Set by libavcodec.
2057 uint16_t *intra_matrix;
2060 * custom inter quantization matrix
2061 * - encoding: Set by user, can be NULL.
2062 * - decoding: Set by libavcodec.
2064 uint16_t *inter_matrix;
2067 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2068 * This is used to work around some encoder bugs.
2069 * - encoding: unused
2070 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2072 unsigned int stream_codec_tag;
2075 * scene change detection threshold
2076 * 0 is default, larger means fewer detected scene changes.
2077 * - encoding: Set by user.
2078 * - decoding: unused
2080 int scenechange_threshold;
2083 * minimum Lagrange multipler
2084 * - encoding: Set by user.
2085 * - decoding: unused
2090 * maximum Lagrange multipler
2091 * - encoding: Set by user.
2092 * - decoding: unused
2096 #if FF_API_PALETTE_CONTROL
2098 * palette control structure
2099 * - encoding: ??? (no palette-enabled encoder yet)
2100 * - decoding: Set by user.
2102 struct AVPaletteControl *palctrl;
2106 * noise reduction strength
2107 * - encoding: Set by user.
2108 * - decoding: unused
2110 int noise_reduction;
2113 * Called at the beginning of a frame to get cr buffer for it.
2114 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2115 * libavcodec will pass previous buffer in pic, function should return
2116 * same buffer or new buffer with old frame "painted" into it.
2117 * If pic.data[0] == NULL must behave like get_buffer().
2118 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2119 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2121 * - encoding: unused
2122 * - decoding: Set by libavcodec, user can override.
2124 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2127 * Number of bits which should be loaded into the rc buffer before decoding starts.
2128 * - encoding: Set by user.
2129 * - decoding: unused
2131 int rc_initial_buffer_occupancy;
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int inter_threshold;
2142 * - encoding: Set by user.
2143 * - decoding: Set by user.
2148 * Simulates errors in the bitstream to test error concealment.
2149 * - encoding: Set by user.
2150 * - decoding: unused
2154 #if FF_API_ANTIALIAS_ALGO
2156 * MP3 antialias algorithm, see FF_AA_* below.
2157 * - encoding: unused
2158 * - decoding: Set by user.
2160 attribute_deprecated int antialias_algo;
2161 #define FF_AA_AUTO 0
2162 #define FF_AA_FASTINT 1 //not implemented yet
2164 #define FF_AA_FLOAT 3
2168 * quantizer noise shaping
2169 * - encoding: Set by user.
2170 * - decoding: unused
2172 int quantizer_noise_shaping;
2176 * is used to decide how many independent tasks should be passed to execute()
2177 * - encoding: Set by user.
2178 * - decoding: Set by user.
2183 * The codec may call this to execute several independent things.
2184 * It will return only after finishing all tasks.
2185 * The user may replace this with some multithreaded implementation,
2186 * the default implementation will execute the parts serially.
2187 * @param count the number of things to execute
2188 * - encoding: Set by libavcodec, user can override.
2189 * - decoding: Set by libavcodec, user can override.
2191 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2195 * Can be used by execute() to store some per AVCodecContext stuff.
2196 * - encoding: set by execute()
2197 * - decoding: set by execute()
2199 void *thread_opaque;
2202 * Motion estimation threshold below which no motion estimation is
2203 * performed, but instead the user specified motion vectors are used.
2205 * - encoding: Set by user.
2206 * - decoding: unused
2211 * Macroblock threshold below which the user specified macroblock types will be used.
2212 * - encoding: Set by user.
2213 * - decoding: unused
2218 * precision of the intra DC coefficient - 8
2219 * - encoding: Set by user.
2220 * - decoding: unused
2222 int intra_dc_precision;
2225 * noise vs. sse weight for the nsse comparsion function
2226 * - encoding: Set by user.
2227 * - decoding: unused
2232 * Number of macroblock rows at the top which are skipped.
2233 * - encoding: unused
2234 * - decoding: Set by user.
2239 * Number of macroblock rows at the bottom which are skipped.
2240 * - encoding: unused
2241 * - decoding: Set by user.
2247 * - encoding: Set by user.
2248 * - decoding: Set by libavcodec.
2251 #define FF_PROFILE_UNKNOWN -99
2252 #define FF_PROFILE_RESERVED -100
2254 #define FF_PROFILE_AAC_MAIN 0
2255 #define FF_PROFILE_AAC_LOW 1
2256 #define FF_PROFILE_AAC_SSR 2
2257 #define FF_PROFILE_AAC_LTP 3
2259 #define FF_PROFILE_DTS 20
2260 #define FF_PROFILE_DTS_ES 30
2261 #define FF_PROFILE_DTS_96_24 40
2262 #define FF_PROFILE_DTS_HD_HRA 50
2263 #define FF_PROFILE_DTS_HD_MA 60
2265 #define FF_PROFILE_MPEG2_422 0
2266 #define FF_PROFILE_MPEG2_HIGH 1
2267 #define FF_PROFILE_MPEG2_SS 2
2268 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2269 #define FF_PROFILE_MPEG2_MAIN 4
2270 #define FF_PROFILE_MPEG2_SIMPLE 5
2272 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2273 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2275 #define FF_PROFILE_H264_BASELINE 66
2276 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2277 #define FF_PROFILE_H264_MAIN 77
2278 #define FF_PROFILE_H264_EXTENDED 88
2279 #define FF_PROFILE_H264_HIGH 100
2280 #define FF_PROFILE_H264_HIGH_10 110
2281 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2282 #define FF_PROFILE_H264_HIGH_422 122
2283 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2284 #define FF_PROFILE_H264_HIGH_444 144
2285 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2286 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2287 #define FF_PROFILE_H264_CAVLC_444 44
2289 #define FF_PROFILE_VC1_SIMPLE 0
2290 #define FF_PROFILE_VC1_MAIN 1
2291 #define FF_PROFILE_VC1_COMPLEX 2
2292 #define FF_PROFILE_VC1_ADVANCED 3
2294 #define FF_PROFILE_MPEG4_SIMPLE 0
2295 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2296 #define FF_PROFILE_MPEG4_CORE 2
2297 #define FF_PROFILE_MPEG4_MAIN 3
2298 #define FF_PROFILE_MPEG4_N_BIT 4
2299 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2300 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2301 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2302 #define FF_PROFILE_MPEG4_HYBRID 8
2303 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2304 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2305 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2306 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2307 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2308 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2309 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2313 * - encoding: Set by user.
2314 * - decoding: Set by libavcodec.
2317 #define FF_LEVEL_UNKNOWN -99
2320 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2321 * - encoding: unused
2322 * - decoding: Set by user.
2327 * Bitstream width / height, may be different from width/height if lowres
2328 * or other things are used.
2329 * - encoding: unused
2330 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2332 int coded_width, coded_height;
2335 * frame skip threshold
2336 * - encoding: Set by user.
2337 * - decoding: unused
2339 int frame_skip_threshold;
2343 * - encoding: Set by user.
2344 * - decoding: unused
2346 int frame_skip_factor;
2349 * frame skip exponent
2350 * - encoding: Set by user.
2351 * - decoding: unused
2356 * frame skip comparison function
2357 * - encoding: Set by user.
2358 * - decoding: unused
2363 * Border processing masking, raises the quantizer for mbs on the borders
2365 * - encoding: Set by user.
2366 * - decoding: unused
2368 float border_masking;
2371 * minimum MB lagrange multipler
2372 * - encoding: Set by user.
2373 * - decoding: unused
2378 * maximum MB lagrange multipler
2379 * - encoding: Set by user.
2380 * - decoding: unused
2386 * - encoding: Set by user.
2387 * - decoding: unused
2389 int me_penalty_compensation;
2393 * - encoding: unused
2394 * - decoding: Set by user.
2396 enum AVDiscard skip_loop_filter;
2400 * - encoding: unused
2401 * - decoding: Set by user.
2403 enum AVDiscard skip_idct;
2407 * - encoding: unused
2408 * - decoding: Set by user.
2410 enum AVDiscard skip_frame;
2414 * - encoding: Set by user.
2415 * - decoding: unused
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * constant rate factor - quality-based VBR - values ~correspond to qps
2428 * - encoding: Set by user.
2429 * - decoding: unused
2434 * constant quantization parameter rate control method
2435 * - encoding: Set by user.
2436 * - decoding: unused
2442 * - encoding: Set by user.
2443 * - decoding: unused
2448 * number of reference frames
2449 * - encoding: Set by user.
2450 * - decoding: Set by lavc.
2455 * chroma qp offset from luma
2456 * - encoding: Set by user.
2457 * - decoding: unused
2462 * Influences how often B-frames are used.
2463 * - encoding: Set by user.
2464 * - decoding: unused
2469 * trellis RD quantization
2470 * - encoding: Set by user.
2471 * - decoding: unused
2476 * Reduce fluctuations in qp (before curve compression).
2477 * - encoding: Set by user.
2478 * - decoding: unused
2480 float complexityblur;
2483 * in-loop deblocking filter alphac0 parameter
2484 * alpha is in the range -6...6
2485 * - encoding: Set by user.
2486 * - decoding: unused
2491 * in-loop deblocking filter beta parameter
2492 * beta is in the range -6...6
2493 * - encoding: Set by user.
2494 * - decoding: unused
2499 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2500 * - encoding: Set by user.
2501 * - decoding: unused
2504 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2505 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2506 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2507 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2508 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2511 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2512 * - encoding: Set by user.
2513 * - decoding: unused
2518 * Audio cutoff bandwidth (0 means "automatic")
2519 * - encoding: Set by user.
2520 * - decoding: unused
2525 * Multiplied by qscale for each frame and added to scene_change_score.
2526 * - encoding: Set by user.
2527 * - decoding: unused
2529 int scenechange_factor;
2533 * Note: Value depends upon the compare function used for fullpel ME.
2534 * - encoding: Set by user.
2535 * - decoding: unused
2540 * Adjusts sensitivity of b_frame_strategy 1.
2541 * - encoding: Set by user.
2542 * - decoding: unused
2547 * - encoding: Set by user.
2548 * - decoding: unused
2550 int compression_level;
2551 #define FF_COMPRESSION_DEFAULT -1
2554 * - encoding: Set by user.
2555 * - decoding: unused
2557 int min_prediction_order;
2560 * - encoding: Set by user.
2561 * - decoding: unused
2563 int max_prediction_order;
2565 #if FF_API_FLAC_GLOBAL_OPTS
2567 * @name FLAC options
2568 * @deprecated Use FLAC encoder private options instead.
2573 * LPC coefficient precision - used by FLAC encoder
2574 * - encoding: Set by user.
2575 * - decoding: unused
2577 attribute_deprecated int lpc_coeff_precision;
2580 * search method for selecting prediction order
2581 * - encoding: Set by user.
2582 * - decoding: unused
2584 attribute_deprecated int prediction_order_method;
2587 * - encoding: Set by user.
2588 * - decoding: unused
2590 attribute_deprecated int min_partition_order;
2593 * - encoding: Set by user.
2594 * - decoding: unused
2596 attribute_deprecated int max_partition_order;
2603 * GOP timecode frame start number, in non drop frame format
2604 * - encoding: Set by user.
2605 * - decoding: unused
2607 int64_t timecode_frame_start;
2609 #if FF_API_REQUEST_CHANNELS
2611 * Decoder should decode to this many channels if it can (0 for default)
2612 * - encoding: unused
2613 * - decoding: Set by user.
2614 * @deprecated Deprecated in favor of request_channel_layout.
2616 int request_channels;
2619 #if FF_API_DRC_SCALE
2621 * Percentage of dynamic range compression to be applied by the decoder.
2622 * The default value is 1.0, corresponding to full compression.
2623 * - encoding: unused
2624 * - decoding: Set by user.
2625 * @deprecated use AC3 decoder private option instead.
2627 attribute_deprecated float drc_scale;
2631 * opaque 64bit number (generally a PTS) that will be reordered and
2632 * output in AVFrame.reordered_opaque
2633 * @deprecated in favor of pkt_pts
2634 * - encoding: unused
2635 * - decoding: Set by user.
2637 int64_t reordered_opaque;
2640 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2641 * - encoding: set by user.
2642 * - decoding: set by libavcodec.
2644 int bits_per_raw_sample;
2647 * Audio channel layout.
2648 * - encoding: set by user.
2649 * - decoding: set by user, may be overwritten by libavcodec.
2651 int64_t channel_layout;
2654 * Request decoder to use this channel layout if it can (0 for default)
2655 * - encoding: unused
2656 * - decoding: Set by user.
2658 int64_t request_channel_layout;
2661 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2662 * - encoding: Set by user.
2663 * - decoding: unused.
2665 float rc_max_available_vbv_use;
2668 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2669 * - encoding: Set by user.
2670 * - decoding: unused.
2672 float rc_min_vbv_overflow_use;
2675 * Hardware accelerator in use
2676 * - encoding: unused.
2677 * - decoding: Set by libavcodec
2679 struct AVHWAccel *hwaccel;
2682 * For some codecs, the time base is closer to the field rate than the frame rate.
2683 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2684 * if no telecine is used ...
2686 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2688 int ticks_per_frame;
2691 * Hardware accelerator context.
2692 * For some hardware accelerators, a global context needs to be
2693 * provided by the user. In that case, this holds display-dependent
2694 * data FFmpeg cannot instantiate itself. Please refer to the
2695 * FFmpeg HW accelerator documentation to know how to fill this
2696 * is. e.g. for VA API, this is a struct vaapi_context.
2697 * - encoding: unused
2698 * - decoding: Set by user
2700 void *hwaccel_context;
2703 * Chromaticity coordinates of the source primaries.
2704 * - encoding: Set by user
2705 * - decoding: Set by libavcodec
2707 enum AVColorPrimaries color_primaries;
2710 * Color Transfer Characteristic.
2711 * - encoding: Set by user
2712 * - decoding: Set by libavcodec
2714 enum AVColorTransferCharacteristic color_trc;
2717 * YUV colorspace type.
2718 * - encoding: Set by user
2719 * - decoding: Set by libavcodec
2721 enum AVColorSpace colorspace;
2724 * MPEG vs JPEG YUV range.
2725 * - encoding: Set by user
2726 * - decoding: Set by libavcodec
2728 enum AVColorRange color_range;
2731 * This defines the location of chroma samples.
2732 * - encoding: Set by user
2733 * - decoding: Set by libavcodec
2735 enum AVChromaLocation chroma_sample_location;
2738 * The codec may call this to execute several independent things.
2739 * It will return only after finishing all tasks.
2740 * The user may replace this with some multithreaded implementation,
2741 * the default implementation will execute the parts serially.
2742 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2743 * @param c context passed also to func
2744 * @param count the number of things to execute
2745 * @param arg2 argument passed unchanged to func
2746 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2747 * @param func function that will be called count times, with jobnr from 0 to count-1.
2748 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2749 * two instances of func executing at the same time will have the same threadnr.
2750 * @return always 0 currently, but code should handle a future improvement where when any call to func
2751 * returns < 0 no further calls to func may be done and < 0 is returned.
2752 * - encoding: Set by libavcodec, user can override.
2753 * - decoding: Set by libavcodec, user can override.
2755 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2758 * explicit P-frame weighted prediction analysis method
2760 * 1: fast blind weighting (one reference duplicate with -1 offset)
2761 * 2: smart weighting (full fade detection analysis)
2762 * - encoding: Set by user.
2763 * - decoding: unused
2765 int weighted_p_pred;
2770 * 1: Variance AQ (complexity mask)
2771 * 2: Auto-variance AQ (experimental)
2772 * - encoding: Set by user
2773 * - decoding: unused
2779 * Reduces blocking and blurring in flat and textured areas.
2780 * - encoding: Set by user
2781 * - decoding: unused
2787 * Strength of psychovisual optimization
2788 * - encoding: Set by user
2789 * - decoding: unused
2795 * Strength of psychovisual optimization
2796 * - encoding: Set by user
2797 * - decoding: unused
2803 * Number of frames for frametype and ratecontrol lookahead
2804 * - encoding: Set by user
2805 * - decoding: unused
2810 * Constant rate factor maximum
2811 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2812 * than crf_max, even if doing so would violate VBV restrictions.
2813 * - encoding: Set by user.
2814 * - decoding: unused
2818 int log_level_offset;
2820 #if FF_API_FLAC_GLOBAL_OPTS
2822 * Determines which LPC analysis algorithm to use.
2823 * - encoding: Set by user
2824 * - decoding: unused
2826 attribute_deprecated enum AVLPCType lpc_type;
2829 * Number of passes to use for Cholesky factorization during LPC analysis
2830 * - encoding: Set by user
2831 * - decoding: unused
2833 attribute_deprecated int lpc_passes;
2838 * Indicates number of picture subdivisions. Used for parallelized
2840 * - encoding: Set by user
2841 * - decoding: unused
2846 * Header containing style information for text subtitles.
2847 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2848 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2849 * the Format line following. It shouldn't include any Dialogue line.
2850 * - encoding: Set/allocated/freed by user (before avcodec_open())
2851 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2853 uint8_t *subtitle_header;
2854 int subtitle_header_size;
2857 * Current packet as passed into the decoder, to avoid having
2858 * to pass the packet into every function. Currently only valid
2859 * inside lavc and get/release_buffer callbacks.
2860 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2861 * - encoding: unused
2866 * Whether this is a copy of the context which had init() called on it.
2867 * This is used by multithreading - shared tables and picture pointers
2868 * should be freed from the original context only.
2869 * - encoding: Set by libavcodec.
2870 * - decoding: Set by libavcodec.
2875 * Which multithreading methods to use.
2876 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2877 * so clients which cannot provide future frames should not use it.
2879 * - encoding: Set by user, otherwise the default is used.
2880 * - decoding: Set by user, otherwise the default is used.
2883 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2884 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2887 * Which multithreading methods are in use by the codec.
2888 * - encoding: Set by libavcodec.
2889 * - decoding: Set by libavcodec.
2891 int active_thread_type;
2894 * Set by the client if its custom get_buffer() callback can be called
2895 * from another thread, which allows faster multithreaded decoding.
2896 * draw_horiz_band() will be called from other threads regardless of this setting.
2897 * Ignored if the default get_buffer() is used.
2898 * - encoding: Set by user.
2899 * - decoding: Set by user.
2901 int thread_safe_callbacks;
2904 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2905 * Used for compliant TS muxing.
2906 * - encoding: Set by libavcodec.
2907 * - decoding: unused.
2912 * Type of service that the audio stream conveys.
2913 * - encoding: Set by user.
2914 * - decoding: Set by libavcodec.
2916 enum AVAudioServiceType audio_service_type;
2919 * desired sample format
2920 * - encoding: Not used.
2921 * - decoding: Set by user.
2922 * Decoder will decode to this format if it can.
2924 enum AVSampleFormat request_sample_fmt;
2927 * Current statistics for PTS correction.
2928 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2929 * - encoding: unused
2931 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2932 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2933 int64_t pts_correction_last_pts; /// PTS of the last frame
2934 int64_t pts_correction_last_dts; /// DTS of the last frame
2942 typedef struct AVProfile {
2944 const char *name; ///< short name for the profile
2947 typedef struct AVCodecDefault AVCodecDefault;
2952 typedef struct AVCodec {
2954 * Name of the codec implementation.
2955 * The name is globally unique among encoders and among decoders (but an
2956 * encoder and a decoder can share the same name).
2957 * This is the primary way to find a codec from the user perspective.
2960 enum AVMediaType type;
2963 int (*init)(AVCodecContext *);
2964 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2965 int (*close)(AVCodecContext *);
2966 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2968 * Codec capabilities.
2972 struct AVCodec *next;
2975 * Will be called when seeking
2977 void (*flush)(AVCodecContext *);
2978 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2979 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2981 * Descriptive name for the codec, meant to be more human readable than name.
2982 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2984 const char *long_name;
2985 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2986 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2987 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2988 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2989 const AVClass *priv_class; ///< AVClass for the private context
2990 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2993 * @name Frame-level threading support functions
2997 * If defined, called on thread contexts when they are created.
2998 * If the codec allocates writable tables in init(), re-allocate them here.
2999 * priv_data will be set to a copy of the original.
3001 int (*init_thread_copy)(AVCodecContext *);
3003 * Copy necessary context variables from a previous thread context to the current one.
3004 * If not defined, the next thread will start automatically; otherwise, the codec
3005 * must call ff_thread_finish_setup().
3007 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3009 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3013 * Private codec-specific defaults.
3015 const AVCodecDefault *defaults;
3021 typedef struct AVHWAccel {
3023 * Name of the hardware accelerated codec.
3024 * The name is globally unique among encoders and among decoders (but an
3025 * encoder and a decoder can share the same name).
3030 * Type of codec implemented by the hardware accelerator.
3032 * See AVMEDIA_TYPE_xxx
3034 enum AVMediaType type;
3037 * Codec implemented by the hardware accelerator.
3044 * Supported pixel format.
3046 * Only hardware accelerated formats are supported here.
3048 enum PixelFormat pix_fmt;
3051 * Hardware accelerated codec capabilities.
3052 * see FF_HWACCEL_CODEC_CAP_*
3056 struct AVHWAccel *next;
3059 * Called at the beginning of each frame or field picture.
3061 * Meaningful frame information (codec specific) is guaranteed to
3062 * be parsed at this point. This function is mandatory.
3064 * Note that buf can be NULL along with buf_size set to 0.
3065 * Otherwise, this means the whole frame is available at this point.
3067 * @param avctx the codec context
3068 * @param buf the frame data buffer base
3069 * @param buf_size the size of the frame in bytes
3070 * @return zero if successful, a negative value otherwise
3072 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3075 * Callback for each slice.
3077 * Meaningful slice information (codec specific) is guaranteed to
3078 * be parsed at this point. This function is mandatory.
3080 * @param avctx the codec context
3081 * @param buf the slice data buffer base
3082 * @param buf_size the size of the slice in bytes
3083 * @return zero if successful, a negative value otherwise
3085 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3088 * Called at the end of each frame or field picture.
3090 * The whole picture is parsed at this point and can now be sent
3091 * to the hardware accelerator. This function is mandatory.
3093 * @param avctx the codec context
3094 * @return zero if successful, a negative value otherwise
3096 int (*end_frame)(AVCodecContext *avctx);
3099 * Size of HW accelerator private data.
3101 * Private data is allocated with av_mallocz() before
3102 * AVCodecContext.get_buffer() and deallocated after
3103 * AVCodecContext.release_buffer().
3109 * four components are given, that's all.
3110 * the last component is alpha
3112 typedef struct AVPicture {
3114 int linesize[4]; ///< number of bytes per line
3117 #if FF_API_PALETTE_CONTROL
3120 * This structure defines a method for communicating palette changes
3121 * between and demuxer and a decoder.
3123 * @deprecated Use AVPacket to send palette changes instead.
3124 * This is totally broken.
3126 #define AVPALETTE_SIZE 1024
3127 #define AVPALETTE_COUNT 256
3128 typedef struct AVPaletteControl {
3130 /* Demuxer sets this to 1 to indicate the palette has changed;
3131 * decoder resets to 0. */
3132 int palette_changed;
3134 /* 4-byte ARGB palette entries, stored in native byte order; note that
3135 * the individual palette components should be on a 8-bit scale; if
3136 * the palette data comes from an IBM VGA native format, the component
3137 * data is probably 6 bits in size and needs to be scaled. */
3138 unsigned int palette[AVPALETTE_COUNT];
3140 } AVPaletteControl attribute_deprecated;
3143 enum AVSubtitleType {
3146 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3149 * Plain text, the text field must be set by the decoder and is
3150 * authoritative. ass and pict fields may contain approximations.
3155 * Formatted text, the ass field must be set by the decoder and is
3156 * authoritative. pict and text fields may contain approximations.
3161 typedef struct AVSubtitleRect {
3162 int x; ///< top left corner of pict, undefined when pict is not set
3163 int y; ///< top left corner of pict, undefined when pict is not set
3164 int w; ///< width of pict, undefined when pict is not set
3165 int h; ///< height of pict, undefined when pict is not set
3166 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3169 * data+linesize for the bitmap of this subtitle.
3170 * can be set for text/ass as well once they where rendered
3173 enum AVSubtitleType type;
3175 char *text; ///< 0 terminated plain UTF-8 text
3178 * 0 terminated ASS/SSA compatible event line.
3179 * The pressentation of this is unaffected by the other values in this
3185 typedef struct AVSubtitle {
3186 uint16_t format; /* 0 = graphics */
3187 uint32_t start_display_time; /* relative to packet pts, in ms */
3188 uint32_t end_display_time; /* relative to packet pts, in ms */
3190 AVSubtitleRect **rects;
3191 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3194 /* packet functions */
3197 * @deprecated use NULL instead
3199 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3202 * Default packet destructor.
3204 void av_destruct_packet(AVPacket *pkt);
3207 * Initialize optional fields of a packet with default values.
3211 void av_init_packet(AVPacket *pkt);
3214 * Allocate the payload of a packet and initialize its fields with
3218 * @param size wanted payload size
3219 * @return 0 if OK, AVERROR_xxx otherwise
3221 int av_new_packet(AVPacket *pkt, int size);
3224 * Reduce packet size, correctly zeroing padding
3227 * @param size new size
3229 void av_shrink_packet(AVPacket *pkt, int size);
3232 * Increase packet size, correctly zeroing padding
3235 * @param grow_by number of bytes by which to increase the size of the packet
3237 int av_grow_packet(AVPacket *pkt, int grow_by);
3240 * @warning This is a hack - the packet memory allocation stuff is broken. The
3241 * packet is allocated if it was not really allocated.
3243 int av_dup_packet(AVPacket *pkt);
3248 * @param pkt packet to free
3250 void av_free_packet(AVPacket *pkt);
3253 * Allocate new information of a packet.
3256 * @param type side information type
3257 * @param size side information size
3258 * @return pointer to fresh allocated data or NULL otherwise
3260 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3264 * Get side information from packet.
3267 * @param type desired side information type
3268 * @param size pointer for side information size to store (optional)
3269 * @return pointer to data if present or NULL otherwise
3271 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3274 int av_packet_merge_side_data(AVPacket *pkt);
3276 int av_packet_split_side_data(AVPacket *pkt);
3281 struct ReSampleContext;
3282 struct AVResampleContext;
3284 typedef struct ReSampleContext ReSampleContext;
3287 * Initialize audio resampling context.
3289 * @param output_channels number of output channels
3290 * @param input_channels number of input channels
3291 * @param output_rate output sample rate
3292 * @param input_rate input sample rate
3293 * @param sample_fmt_out requested output sample format
3294 * @param sample_fmt_in input sample format
3295 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3296 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3297 * @param linear if 1 then the used FIR filter will be linearly interpolated
3298 between the 2 closest, if 0 the closest will be used
3299 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3300 * @return allocated ReSampleContext, NULL if error occured
3302 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3303 int output_rate, int input_rate,
3304 enum AVSampleFormat sample_fmt_out,
3305 enum AVSampleFormat sample_fmt_in,
3306 int filter_length, int log2_phase_count,
3307 int linear, double cutoff);
3309 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3312 * Free resample context.
3314 * @param s a non-NULL pointer to a resample context previously
3315 * created with av_audio_resample_init()
3317 void audio_resample_close(ReSampleContext *s);
3321 * Initialize an audio resampler.
3322 * Note, if either rate is not an integer then simply scale both rates up so they are.
3323 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3324 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3325 * @param linear If 1 then the used FIR filter will be linearly interpolated
3326 between the 2 closest, if 0 the closest will be used
3327 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3329 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3332 * Resample an array of samples using a previously configured context.
3333 * @param src an array of unconsumed samples
3334 * @param consumed the number of samples of src which have been consumed are returned here
3335 * @param src_size the number of unconsumed samples available
3336 * @param dst_size the amount of space in samples available in dst
3337 * @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.
3338 * @return the number of samples written in dst or -1 if an error occurred
3340 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3344 * Compensate samplerate/timestamp drift. The compensation is done by changing
3345 * the resampler parameters, so no audible clicks or similar distortions occur
3346 * @param compensation_distance distance in output samples over which the compensation should be performed
3347 * @param sample_delta number of output samples which should be output less
3349 * example: av_resample_compensate(c, 10, 500)
3350 * here instead of 510 samples only 500 samples would be output
3352 * note, due to rounding the actual compensation might be slightly different,
3353 * especially if the compensation_distance is large and the in_rate used during init is small
3355 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3356 void av_resample_close(struct AVResampleContext *c);
3359 * Allocate memory for a picture. Call avpicture_free() to free it.
3361 * @see avpicture_fill()
3363 * @param picture the picture to be filled in
3364 * @param pix_fmt the format of the picture
3365 * @param width the width of the picture
3366 * @param height the height of the picture
3367 * @return zero if successful, a negative value if not
3369 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3372 * Free a picture previously allocated by avpicture_alloc().
3373 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3376 * @param picture the AVPicture to be freed
3378 void avpicture_free(AVPicture *picture);
3381 * Fill in the AVPicture fields.
3382 * The fields of the given AVPicture are filled in by using the 'ptr' address
3383 * which points to the image data buffer. Depending on the specified picture
3384 * format, one or multiple image data pointers and line sizes will be set.
3385 * If a planar format is specified, several pointers will be set pointing to
3386 * the different picture planes and the line sizes of the different planes
3387 * will be stored in the lines_sizes array.
3388 * Call with ptr == NULL to get the required size for the ptr buffer.
3390 * To allocate the buffer and fill in the AVPicture fields in one call,
3391 * use avpicture_alloc().
3393 * @param picture AVPicture whose fields are to be filled in
3394 * @param ptr Buffer which will contain or contains the actual image data
3395 * @param pix_fmt The format in which the picture data is stored.
3396 * @param width the width of the image in pixels
3397 * @param height the height of the image in pixels
3398 * @return size of the image data in bytes
3400 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3401 enum PixelFormat pix_fmt, int width, int height);
3404 * Copy pixel data from an AVPicture into a buffer.
3405 * The data is stored compactly, without any gaps for alignment or padding
3406 * which may be applied by avpicture_fill().
3408 * @see avpicture_get_size()
3410 * @param[in] src AVPicture containing image data
3411 * @param[in] pix_fmt The format in which the picture data is stored.
3412 * @param[in] width the width of the image in pixels.
3413 * @param[in] height the height of the image in pixels.
3414 * @param[out] dest A buffer into which picture data will be copied.
3415 * @param[in] dest_size The size of 'dest'.
3416 * @return The number of bytes written to dest, or a negative value (error code) on error.
3418 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3419 unsigned char *dest, int dest_size);
3422 * Calculate the size in bytes that a picture of the given width and height
3423 * would occupy if stored in the given picture format.
3424 * Note that this returns the size of a compact representation as generated
3425 * by avpicture_layout(), which can be smaller than the size required for e.g.
3428 * @param pix_fmt the given picture format
3429 * @param width the width of the image
3430 * @param height the height of the image
3431 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3433 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3434 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3436 #if FF_API_GET_PIX_FMT_NAME
3438 * Return the short name for a pixel format.
3440 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3441 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3443 attribute_deprecated
3444 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3447 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3450 * Return a value representing the fourCC code associated to the
3451 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3454 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3457 * Put a string representing the codec tag codec_tag in buf.
3459 * @param buf_size size in bytes of buf
3460 * @return the length of the string that would have been generated if
3461 * enough space had been available, excluding the trailing null
3463 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3465 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3466 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3467 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3468 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3469 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3470 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3473 * Compute what kind of losses will occur when converting from one specific
3474 * pixel format to another.
3475 * When converting from one pixel format to another, information loss may occur.
3476 * For example, when converting from RGB24 to GRAY, the color information will
3477 * be lost. Similarly, other losses occur when converting from some formats to
3478 * other formats. These losses can involve loss of chroma, but also loss of
3479 * resolution, loss of color depth, loss due to the color space conversion, loss
3480 * of the alpha bits or loss due to color quantization.
3481 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3482 * which will occur when converting from one pixel format to another.
3484 * @param[in] dst_pix_fmt destination pixel format
3485 * @param[in] src_pix_fmt source pixel format
3486 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3487 * @return Combination of flags informing you what kind of losses will occur.
3489 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3493 * Find the best pixel format to convert to given a certain source pixel
3494 * format. When converting from one pixel format to another, information loss
3495 * may occur. For example, when converting from RGB24 to GRAY, the color
3496 * information will be lost. Similarly, other losses occur when converting from
3497 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3498 * the given pixel formats should be used to suffer the least amount of loss.
3499 * The pixel formats from which it chooses one, are determined by the
3500 * pix_fmt_mask parameter.
3503 * src_pix_fmt = PIX_FMT_YUV420P;
3504 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3505 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3508 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3509 * @param[in] src_pix_fmt source pixel format
3510 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3511 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3512 * @return The best pixel format to convert to or -1 if none was found.
3514 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3515 int has_alpha, int *loss_ptr);
3517 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3518 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3521 * Tell if an image really has transparent alpha values.
3522 * @return ored mask of FF_ALPHA_xxx constants
3524 int img_get_alpha_info(const AVPicture *src,
3525 enum PixelFormat pix_fmt, int width, int height);
3527 /* deinterlace a picture */
3528 /* deinterlace - if not supported return -1 */
3529 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3530 enum PixelFormat pix_fmt, int width, int height);
3532 /* external high level API */
3535 * If c is NULL, returns the first registered codec,
3536 * if c is non-NULL, returns the next registered codec after c,
3537 * or NULL if c is the last one.
3539 AVCodec *av_codec_next(AVCodec *c);
3542 * Return the LIBAVCODEC_VERSION_INT constant.
3544 unsigned avcodec_version(void);
3547 * Return the libavcodec build-time configuration.
3549 const char *avcodec_configuration(void);
3552 * Return the libavcodec license.
3554 const char *avcodec_license(void);
3556 #if FF_API_AVCODEC_INIT
3558 * @deprecated this function is called automatically from avcodec_register()
3559 * and avcodec_register_all(), there is no need to call it manually
3561 attribute_deprecated
3562 void avcodec_init(void);
3566 * Register the codec codec and initialize libavcodec.
3568 * @warning either this function or avcodec_register_all() must be called
3569 * before any other libavcodec functions.
3571 * @see avcodec_register_all()
3573 void avcodec_register(AVCodec *codec);
3576 * Find a registered encoder with a matching codec ID.
3578 * @param id CodecID of the requested encoder
3579 * @return An encoder if one was found, NULL otherwise.
3581 AVCodec *avcodec_find_encoder(enum CodecID id);
3584 * Find a registered encoder with the specified name.
3586 * @param name name of the requested encoder
3587 * @return An encoder if one was found, NULL otherwise.
3589 AVCodec *avcodec_find_encoder_by_name(const char *name);
3592 * Find a registered decoder with a matching codec ID.
3594 * @param id CodecID of the requested decoder
3595 * @return A decoder if one was found, NULL otherwise.
3597 AVCodec *avcodec_find_decoder(enum CodecID id);
3600 * Find a registered decoder with the specified name.
3602 * @param name name of the requested decoder
3603 * @return A decoder if one was found, NULL otherwise.
3605 AVCodec *avcodec_find_decoder_by_name(const char *name);
3606 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3609 * Return a name for the specified profile, if available.
3611 * @param codec the codec that is searched for the given profile
3612 * @param profile the profile value for which a name is requested
3613 * @return A name for the profile if found, NULL otherwise.
3615 const char *av_get_profile_name(const AVCodec *codec, int profile);
3618 * Set the fields of the given AVCodecContext to default values.
3620 * @param s The AVCodecContext of which the fields should be set to default values.
3622 void avcodec_get_context_defaults(AVCodecContext *s);
3624 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3625 * we WILL change its arguments and name a few times! */
3626 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3628 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3629 * we WILL change its arguments and name a few times! */
3630 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3632 #if FF_API_ALLOC_CONTEXT
3634 * Allocate an AVCodecContext and set its fields to default values. The
3635 * resulting struct can be deallocated by simply calling av_free().
3637 * @return An AVCodecContext filled with default values or NULL on failure.
3638 * @see avcodec_get_context_defaults
3640 * @deprecated use avcodec_alloc_context3()
3642 attribute_deprecated
3643 AVCodecContext *avcodec_alloc_context(void);
3645 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3646 * we WILL change its arguments and name a few times! */
3647 attribute_deprecated
3648 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3652 * Allocate an AVCodecContext and set its fields to default values. The
3653 * resulting struct can be deallocated by simply calling av_free().
3655 * @param codec if non-NULL, allocate private data and initialize defaults
3656 * for the given codec. It is illegal to then call avcodec_open()
3657 * with a different codec.
3659 * @return An AVCodecContext filled with default values or NULL on failure.
3660 * @see avcodec_get_context_defaults
3662 * @deprecated use avcodec_alloc_context3()
3664 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3667 * Copy the settings of the source AVCodecContext into the destination
3668 * AVCodecContext. The resulting destination codec context will be
3669 * unopened, i.e. you are required to call avcodec_open() before you
3670 * can use this AVCodecContext to decode/encode video/audio data.
3672 * @param dest target codec context, should be initialized with
3673 * avcodec_alloc_context3(), but otherwise uninitialized
3674 * @param src source codec context
3675 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3677 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3680 * Set the fields of the given AVFrame to default values.
3682 * @param pic The AVFrame of which the fields should be set to default values.
3684 void avcodec_get_frame_defaults(AVFrame *pic);
3687 * Allocate an AVFrame and set its fields to default values. The resulting
3688 * struct can be deallocated by simply calling av_free().
3690 * @return An AVFrame filled with default values or NULL on failure.
3691 * @see avcodec_get_frame_defaults
3693 AVFrame *avcodec_alloc_frame(void);
3695 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3696 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3697 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3700 * Return the amount of padding in pixels which the get_buffer callback must
3701 * provide around the edge of the image for codecs which do not have the
3702 * CODEC_FLAG_EMU_EDGE flag.
3704 * @return Required padding in pixels.
3706 unsigned avcodec_get_edge_width(void);
3708 * Modify width and height values so that they will result in a memory
3709 * buffer that is acceptable for the codec if you do not use any horizontal
3712 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3713 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3714 * according to avcodec_get_edge_width() before.
3716 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3718 * Modify width and height values so that they will result in a memory
3719 * buffer that is acceptable for the codec if you also ensure that all
3720 * line sizes are a multiple of the respective linesize_align[i].
3722 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3723 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3724 * according to avcodec_get_edge_width() before.
3726 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3727 int linesize_align[4]);
3729 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3731 #if FF_API_THREAD_INIT
3733 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3735 attribute_deprecated
3736 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3739 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3740 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3741 //FIXME func typedef
3743 #if FF_API_AVCODEC_OPEN
3745 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3746 * function the context has to be allocated.
3748 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3749 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3750 * retrieving a codec.
3752 * @warning This function is not thread safe!
3755 * avcodec_register_all();
3756 * codec = avcodec_find_decoder(CODEC_ID_H264);
3760 * context = avcodec_alloc_context3(codec);
3762 * if (avcodec_open(context, codec) < 0)
3766 * @param avctx The context which will be set up to use the given codec.
3767 * @param codec The codec to use within the context.
3768 * @return zero on success, a negative value on error
3769 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3771 * @deprecated use avcodec_open2
3773 attribute_deprecated
3774 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3778 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3779 * function the context has to be allocated with avcodec_alloc_context().
3781 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3782 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3783 * retrieving a codec.
3785 * @warning This function is not thread safe!
3788 * avcodec_register_all();
3789 * av_dict_set(&opts, "b", "2.5M", 0);
3790 * codec = avcodec_find_decoder(CODEC_ID_H264);
3794 * context = avcodec_alloc_context();
3796 * if (avcodec_open(context, codec, opts) < 0)
3800 * @param avctx The context to initialize.
3801 * @param options A dictionary filled with AVCodecContext and codec-private options.
3802 * On return this object will be filled with options that were not found.
3804 * @return zero on success, a negative value on error
3805 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3806 * av_dict_set(), av_opt_find().
3808 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3811 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3812 * Some decoders may support multiple frames in a single AVPacket, such
3813 * decoders would then just decode the first frame. In this case,
3814 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3815 * the remaining data in order to decode the second frame etc.
3817 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3818 * decompressed frame size in bytes.
3820 * @warning You must set frame_size_ptr to the allocated size of the
3821 * output buffer before calling avcodec_decode_audio3().
3823 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3824 * the actual read bytes because some optimized bitstream readers read 32 or 64
3825 * bits at once and could read over the end.
3827 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that