2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs.
57 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58 CODEC_ID_MPEG2VIDEO_XVMC,
95 CODEC_ID_INTERPLAY_VIDEO,
107 CODEC_ID_TRUEMOTION1,
134 CODEC_ID_TRUEMOTION2,
151 CODEC_ID_DSICINVIDEO,
152 CODEC_ID_TIERTEXSEQVIDEO,
155 #if LIBAVCODEC_VERSION_MAJOR == 53
163 CODEC_ID_BETHSOFTVID,
175 #if LIBAVCODEC_VERSION_MAJOR == 53
183 CODEC_ID_MOTIONPIXELS,
201 CODEC_ID_IFF_BYTERUN1,
217 #if LIBAVCODEC_VERSION_MAJOR == 53
223 /* various PCM "codecs" */
224 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
225 CODEC_ID_PCM_S16LE = 0x10000,
241 CODEC_ID_PCM_S24DAUD,
243 CODEC_ID_PCM_S16LE_PLANAR,
253 /* various ADPCM codecs */
254 CODEC_ID_ADPCM_IMA_QT = 0x11000,
255 CODEC_ID_ADPCM_IMA_WAV,
256 CODEC_ID_ADPCM_IMA_DK3,
257 CODEC_ID_ADPCM_IMA_DK4,
258 CODEC_ID_ADPCM_IMA_WS,
259 CODEC_ID_ADPCM_IMA_SMJPEG,
268 CODEC_ID_ADPCM_YAMAHA,
269 CODEC_ID_ADPCM_SBPRO_4,
270 CODEC_ID_ADPCM_SBPRO_3,
271 CODEC_ID_ADPCM_SBPRO_2,
273 CODEC_ID_ADPCM_IMA_AMV,
274 CODEC_ID_ADPCM_EA_R1,
275 CODEC_ID_ADPCM_EA_R3,
276 CODEC_ID_ADPCM_EA_R2,
277 CODEC_ID_ADPCM_IMA_EA_SEAD,
278 CODEC_ID_ADPCM_IMA_EA_EACS,
279 CODEC_ID_ADPCM_EA_XAS,
280 CODEC_ID_ADPCM_EA_MAXIS_XA,
281 CODEC_ID_ADPCM_IMA_ISS,
285 CODEC_ID_AMR_NB = 0x12000,
288 /* RealAudio codecs*/
289 CODEC_ID_RA_144 = 0x13000,
292 /* various DPCM codecs */
293 CODEC_ID_ROQ_DPCM = 0x14000,
294 CODEC_ID_INTERPLAY_DPCM,
299 CODEC_ID_MP2 = 0x15000,
300 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
311 #if LIBAVCODEC_VERSION_MAJOR == 53
320 CODEC_ID_WESTWOOD_SND1,
321 CODEC_ID_GSM, ///< as in Berlin toast format
329 CODEC_ID_DSICINAUDIO,
333 CODEC_ID_GSM_MS, /* as found in WAV */
342 CODEC_ID_WMALOSSLESS,
351 CODEC_ID_BINKAUDIO_RDFT,
352 CODEC_ID_BINKAUDIO_DCT,
356 #if LIBAVCODEC_VERSION_MAJOR > 53
363 /* subtitle codecs */
364 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
365 CODEC_ID_DVD_SUBTITLE = 0x17000,
366 CODEC_ID_DVB_SUBTITLE,
367 CODEC_ID_TEXT, ///< raw UTF-8 text
371 CODEC_ID_HDMV_PGS_SUBTITLE,
372 CODEC_ID_DVB_TELETEXT,
375 /* other specific kind of codecs (generally used for attachments) */
376 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
377 CODEC_ID_TTF = 0x18000,
379 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
381 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
382 * stream (only used by libavformat) */
383 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
384 * stream (only used by libavformat) */
385 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
388 #if FF_API_OLD_SAMPLE_FMT
389 #define SampleFormat AVSampleFormat
391 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
392 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
393 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
394 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
395 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
396 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
397 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
400 #if FF_API_OLD_AUDIOCONVERT
401 #include "libavutil/audioconvert.h"
403 /* Audio channel masks */
404 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
405 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
406 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
407 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
408 #define CH_BACK_LEFT AV_CH_BACK_LEFT
409 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
410 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
411 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
412 #define CH_BACK_CENTER AV_CH_BACK_CENTER
413 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
414 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
415 #define CH_TOP_CENTER AV_CH_TOP_CENTER
416 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
417 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
418 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
419 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
420 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
421 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
422 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
423 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
425 /** Channel mask value used for AVCodecContext.request_channel_layout
426 to indicate that the user requests the channel order of the decoder output
427 to be the native codec channel order. */
428 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
430 /* Audio channel convenience macros */
431 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
432 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
433 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
434 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
435 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
436 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
437 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
438 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
439 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
440 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
441 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
442 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
443 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
444 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
445 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
449 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
452 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
453 * This is mainly needed because some optimized bitstream readers read
454 * 32 or 64 bit at once and could read over the end.<br>
455 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
456 * MPEG bitstreams could cause overread and segfault.
458 #define FF_INPUT_BUFFER_PADDING_SIZE 8
461 * minimum encoding buffer size
462 * Used to avoid some checks during header writing.
464 #define FF_MIN_BUFFER_SIZE 16384
468 * motion estimation type.
471 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
475 ME_EPZS, ///< enhanced predictive zonal search
476 ME_X1, ///< reserved for experiments
477 ME_HEX, ///< hexagon based search
478 ME_UMH, ///< uneven multi-hexagon search
479 ME_ITER, ///< iterative search
480 ME_TESA, ///< transformed exhaustive search algorithm
484 /* We leave some space between them for extensions (drop some
485 * keyframes for intra-only or drop just some bidir frames). */
486 AVDISCARD_NONE =-16, ///< discard nothing
487 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
488 AVDISCARD_NONREF = 8, ///< discard all non reference
489 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
490 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
491 AVDISCARD_ALL = 48, ///< discard all
494 enum AVColorPrimaries{
495 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
496 AVCOL_PRI_UNSPECIFIED=2,
498 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
499 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
500 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
502 AVCOL_PRI_NB , ///< Not part of ABI
505 enum AVColorTransferCharacteristic{
506 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
507 AVCOL_TRC_UNSPECIFIED=2,
508 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
509 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
510 AVCOL_TRC_NB , ///< Not part of ABI
515 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
516 AVCOL_SPC_UNSPECIFIED=2,
518 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
519 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
520 AVCOL_SPC_SMPTE240M =7,
521 AVCOL_SPC_NB , ///< Not part of ABI
525 AVCOL_RANGE_UNSPECIFIED=0,
526 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
527 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
528 AVCOL_RANGE_NB , ///< Not part of ABI
532 * X X 3 4 X X are luma samples,
533 * 1 2 1-6 are possible chroma positions
534 * X X 5 6 X 0 is undefined/unknown position
536 enum AVChromaLocation{
537 AVCHROMA_LOC_UNSPECIFIED=0,
538 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
539 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
540 AVCHROMA_LOC_TOPLEFT =3, ///< DV
542 AVCHROMA_LOC_BOTTOMLEFT =5,
543 AVCHROMA_LOC_BOTTOM =6,
544 AVCHROMA_LOC_NB , ///< Not part of ABI
547 #if FF_API_FLAC_GLOBAL_OPTS
552 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
553 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
554 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
555 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
556 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
557 AV_LPC_TYPE_NB , ///< Not part of ABI
561 enum AVAudioServiceType {
562 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
563 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
564 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
565 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
566 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
567 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
568 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
569 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
570 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
571 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
574 typedef struct RcOverride{
577 int qscale; // If this is 0 then quality_factor will be used instead.
578 float quality_factor;
581 #define FF_MAX_B_FRAMES 16
584 These flags can be passed in AVCodecContext.flags before initialization.
585 Note: Not everything is supported yet.
588 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
589 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
590 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
591 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
592 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
594 * The parent program guarantees that the input for B-frames containing
595 * streams is not written to for at least s->max_b_frames+1 frames, if
596 * this is not set the input will be copied.
598 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
599 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
600 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
601 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
602 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
603 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
604 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
605 location instead of only at frame boundaries. */
606 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
607 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
608 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
609 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
610 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
611 /* Fx : Flag for h263+ extra options */
612 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
613 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
614 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
615 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
616 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
617 #define CODEC_FLAG_CLOSED_GOP 0x80000000
618 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
619 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
620 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
621 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
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.
625 * @defgroup deprecated_flags Deprecated codec flags
626 * Use corresponding private codec options instead.
629 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
630 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
631 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
632 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
633 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
634 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
635 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
636 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
637 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
638 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
639 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
641 #if FF_API_MJPEG_GLOBAL_OPTS
642 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
644 #if FF_API_X264_GLOBAL_OPTS
645 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
646 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
647 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
648 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
649 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
650 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
651 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
652 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
653 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
654 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
655 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
657 #if FF_API_SNOW_GLOBAL_OPTS
658 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
660 #if FF_API_LAME_GLOBAL_OPTS
661 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
667 /* Unsupported options :
668 * Syntax Arithmetic coding (SAC)
669 * Reference Picture Selection
670 * Independent Segment Decoding */
672 /* codec capabilities */
674 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
676 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
677 * If not set, it might not use get_buffer() at all or use operations that
678 * assume the buffer was allocated by avcodec_default_get_buffer.
680 #define CODEC_CAP_DR1 0x0002
681 #if FF_API_PARSE_FRAME
682 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
683 #define CODEC_CAP_PARSE_ONLY 0x0004
685 #define CODEC_CAP_TRUNCATED 0x0008
686 /* Codec can export data for HW decoding (XvMC). */
687 #define CODEC_CAP_HWACCEL 0x0010
689 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
690 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
691 * returns frames. If this is not set, the codec is guaranteed to never be fed
694 #define CODEC_CAP_DELAY 0x0020
696 * Codec can be fed a final frame with a smaller size.
697 * This can be used to prevent truncation of the last audio samples.
699 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
701 * Codec can export data for HW decoding (VDPAU).
703 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
705 * Codec can output multiple frames per AVPacket
706 * Normally demuxers return one frame at a time, demuxers which do not do
707 * are connected to a parser to split what they return into proper frames.
708 * This flag is reserved to the very rare category of codecs which have a
709 * bitstream that cannot be split into frames without timeconsuming
710 * operations like full decoding. Demuxers carring such bitstreams thus
711 * may return multiple frames in a packet. This has many disadvantages like
712 * prohibiting stream copy in many cases thus it should only be considered
715 #define CODEC_CAP_SUBFRAMES 0x0100
717 * Codec is experimental and is thus avoided in favor of non experimental
720 #define CODEC_CAP_EXPERIMENTAL 0x0200
722 * Codec should fill in channel configuration and samplerate instead of container
724 #define CODEC_CAP_CHANNEL_CONF 0x0400
726 * Codec is able to deal with negative linesizes
728 #define CODEC_CAP_NEG_LINESIZES 0x0800
730 * Codec supports frame-level multithreading.
732 #define CODEC_CAP_FRAME_THREADS 0x1000
734 * Codec supports slice-based (or partition-based) multithreading.
736 #define CODEC_CAP_SLICE_THREADS 0x2000
738 //The following defines may change, don't expect compatibility if you use them.
739 #define MB_TYPE_INTRA4x4 0x0001
740 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
741 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
742 #define MB_TYPE_16x16 0x0008
743 #define MB_TYPE_16x8 0x0010
744 #define MB_TYPE_8x16 0x0020
745 #define MB_TYPE_8x8 0x0040
746 #define MB_TYPE_INTERLACED 0x0080
747 #define MB_TYPE_DIRECT2 0x0100 //FIXME
748 #define MB_TYPE_ACPRED 0x0200
749 #define MB_TYPE_GMC 0x0400
750 #define MB_TYPE_SKIP 0x0800
751 #define MB_TYPE_P0L0 0x1000
752 #define MB_TYPE_P1L0 0x2000
753 #define MB_TYPE_P0L1 0x4000
754 #define MB_TYPE_P1L1 0x8000
755 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
756 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
757 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
758 #define MB_TYPE_QUANT 0x00010000
759 #define MB_TYPE_CBP 0x00020000
760 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
764 * This specifies the area which should be displayed.
765 * Note there may be multiple such areas for one frame.
767 typedef struct AVPanScan{
770 * - encoding: Set by user.
771 * - decoding: Set by libavcodec.
776 * width and height in 1/16 pel
777 * - encoding: Set by user.
778 * - decoding: Set by libavcodec.
784 * position of the top left corner in 1/16 pel for up to 3 fields/frames
785 * - encoding: Set by user.
786 * - decoding: Set by libavcodec.
788 int16_t position[3][2];
791 #define FF_QSCALE_TYPE_MPEG1 0
792 #define FF_QSCALE_TYPE_MPEG2 1
793 #define FF_QSCALE_TYPE_H264 2
794 #define FF_QSCALE_TYPE_VP56 3
796 #define FF_BUFFER_TYPE_INTERNAL 1
797 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
798 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
799 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
801 #if FF_API_OLD_FF_PICT_TYPES
802 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
803 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
804 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
805 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
806 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
807 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
808 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
809 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
812 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
813 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
814 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
815 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
817 enum AVPacketSideDataType {
821 typedef struct AVPacket {
823 * Presentation timestamp in AVStream->time_base units; the time at which
824 * the decompressed packet will be presented to the user.
825 * Can be AV_NOPTS_VALUE if it is not stored in the file.
826 * pts MUST be larger or equal to dts as presentation cannot happen before
827 * decompression, unless one wants to view hex dumps. Some formats misuse
828 * the terms dts and pts/cts to mean something different. Such timestamps
829 * must be converted to true pts/dts before they are stored in AVPacket.
833 * Decompression timestamp in AVStream->time_base units; the time at which
834 * the packet is decompressed.
835 * Can be AV_NOPTS_VALUE if it is not stored in the file.
842 * A combination of AV_PKT_FLAG values
846 * Additional packet data that can be provided by the container.
847 * Packet can contain several types of side information.
852 enum AVPacketSideDataType type;
857 * Duration of this packet in AVStream->time_base units, 0 if unknown.
858 * Equals next_pts - this_pts in presentation order.
861 void (*destruct)(struct AVPacket *);
863 int64_t pos; ///< byte position in stream, -1 if unknown
866 * Time difference in AVStream->time_base units from the pts of this
867 * packet to the point at which the output from the decoder has converged
868 * independent from the availability of previous frames. That is, the
869 * frames are virtually identical no matter if decoding started from
870 * the very first frame or from this keyframe.
871 * Is AV_NOPTS_VALUE if unknown.
872 * This field is not the display duration of the current packet.
873 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
876 * The purpose of this field is to allow seeking in streams that have no
877 * keyframes in the conventional sense. It corresponds to the
878 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
879 * essential for some types of subtitle streams to ensure that all
880 * subtitles are correctly displayed after seeking.
882 int64_t convergence_duration;
884 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
885 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
889 * New fields can be added to the end of AVFRAME with minor version
890 * bumps. Removal, reordering and changes to existing fields require
891 * a major version bump.
892 * sizeof(AVFrame) must not be used outside libav*.
894 typedef struct AVFrame {
896 * pointer to the picture planes.
897 * This might be different from the first allocated byte
904 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
905 * This isn't used by libavcodec unless the default get/release_buffer() is used.
911 * 1 -> keyframe, 0-> not
912 * - encoding: Set by libavcodec.
913 * - decoding: Set by libavcodec.
918 * Picture type of the frame, see ?_TYPE below.
919 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
920 * - decoding: Set by libavcodec.
922 enum AVPictureType pict_type;
925 * presentation timestamp in time_base units (time when frame should be shown to user)
926 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
927 * - encoding: MUST be set by user.
928 * - decoding: Set by libavcodec.
933 * picture number in bitstream order
935 * - decoding: Set by libavcodec.
937 int coded_picture_number;
939 * picture number in display order
941 * - decoding: Set by libavcodec.
943 int display_picture_number;
946 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
947 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
948 * - decoding: Set by libavcodec.
953 * buffer age (1->was last buffer and dint change, 2->..., ...).
954 * Set to INT_MAX if the buffer has not been used yet.
956 * - decoding: MUST be set by get_buffer().
961 * is this picture used as reference
962 * The values for this are the same as the MpegEncContext.picture_structure
963 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
964 * Set to 4 for delayed, non-reference frames.
966 * - decoding: Set by libavcodec. (before get_buffer() call)).
973 * - decoding: Set by libavcodec.
975 int8_t *qscale_table;
979 * - decoding: Set by libavcodec.
984 * mbskip_table[mb]>=1 if MB didn't change
985 * stride= mb_width = (width+15)>>4
987 * - decoding: Set by libavcodec.
989 uint8_t *mbskip_table;
992 * motion vector table
995 * int mv_sample_log2= 4 - motion_subsample_log2;
996 * int mb_width= (width+15)>>4;
997 * int mv_stride= (mb_width << mv_sample_log2) + 1;
998 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1000 * - encoding: Set by user.
1001 * - decoding: Set by libavcodec.
1003 int16_t (*motion_val[2])[2];
1006 * macroblock type table
1007 * mb_type_base + mb_width + 2
1008 * - encoding: Set by user.
1009 * - decoding: Set by libavcodec.
1014 * log2 of the size of the block which a single vector in motion_val represents:
1015 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1016 * - encoding: unused
1017 * - decoding: Set by libavcodec.
1019 uint8_t motion_subsample_log2;
1022 * for some private data of the user
1023 * - encoding: unused
1024 * - decoding: Set by user.
1030 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1031 * - decoding: unused
1036 * type of the buffer (to keep track of who has to deallocate data[*])
1037 * - encoding: Set by the one who allocates it.
1038 * - decoding: Set by the one who allocates it.
1039 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1044 * When decoding, this signals how much the picture must be delayed.
1045 * extra_delay = repeat_pict / (2*fps)
1046 * - encoding: unused
1047 * - decoding: Set by libavcodec.
1057 * The content of the picture is interlaced.
1058 * - encoding: Set by user.
1059 * - decoding: Set by libavcodec. (default 0)
1061 int interlaced_frame;
1064 * If the content is interlaced, is top field displayed first.
1065 * - encoding: Set by user.
1066 * - decoding: Set by libavcodec.
1068 int top_field_first;
1072 * - encoding: Set by user.
1073 * - decoding: Set by libavcodec.
1075 AVPanScan *pan_scan;
1078 * Tell user application that palette has changed from previous frame.
1079 * - encoding: ??? (no palette-enabled encoder yet)
1080 * - decoding: Set by libavcodec. (default 0).
1082 int palette_has_changed;
1085 * codec suggestion on buffer type if != 0
1086 * - encoding: unused
1087 * - decoding: Set by libavcodec. (before get_buffer() call)).
1093 * - encoding: unused
1094 * - decoding: Set by libavcodec.
1099 * motion reference frame index
1100 * the order in which these are stored can depend on the codec.
1101 * - encoding: Set by user.
1102 * - decoding: Set by libavcodec.
1104 int8_t *ref_index[2];
1107 * reordered opaque 64bit (generally an integer or a double precision float
1108 * PTS but can be anything).
1109 * The user sets AVCodecContext.reordered_opaque to represent the input at
1111 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1112 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1113 * @deprecated in favor of pkt_pts
1114 * - encoding: unused
1115 * - decoding: Read by user.
1117 int64_t reordered_opaque;
1120 * hardware accelerator private data (Libav-allocated)
1121 * - encoding: unused
1122 * - decoding: Set by libavcodec
1124 void *hwaccel_picture_private;
1127 * reordered pts from the last AVPacket that has been input into the decoder
1128 * - encoding: unused
1129 * - decoding: Read by user.
1134 * dts from the last AVPacket that has been input into the decoder
1135 * - encoding: unused
1136 * - decoding: Read by user.
1141 * the AVCodecContext which ff_thread_get_buffer() was last called on
1142 * - encoding: Set by libavcodec.
1143 * - decoding: Set by libavcodec.
1145 struct AVCodecContext *owner;
1148 * used by multithreading to store frame-specific info
1149 * - encoding: Set by libavcodec.
1150 * - decoding: Set by libavcodec.
1152 void *thread_opaque;
1156 * main external API structure.
1157 * New fields can be added to the end with minor version bumps.
1158 * Removal, reordering and changes to existing fields require a major
1160 * sizeof(AVCodecContext) must not be used outside libav*.
1162 typedef struct AVCodecContext {
1164 * information on struct for av_log
1165 * - set by avcodec_alloc_context
1167 const AVClass *av_class;
1169 * the average bitrate
1170 * - encoding: Set by user; unused for constant quantizer encoding.
1171 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1176 * number of bits the bitstream is allowed to diverge from the reference.
1177 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1178 * - encoding: Set by user; unused for constant quantizer encoding.
1179 * - decoding: unused
1181 int bit_rate_tolerance;
1185 * - encoding: Set by user.
1186 * - decoding: Set by user.
1191 * Some codecs need additional format info. It is stored here.
1192 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1193 * specific codec MUST set it correctly otherwise stream copy breaks.
1194 * In general use of this field by muxers is not recommanded.
1195 * - encoding: Set by libavcodec.
1196 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1201 * Motion estimation algorithm used for video coding.
1202 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1203 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1204 * - encoding: MUST be set by user.
1205 * - decoding: unused
1210 * some codecs need / can use extradata like Huffman tables.
1211 * mjpeg: Huffman tables
1212 * rv10: additional flags
1213 * mpeg4: global headers (they can be in the bitstream or here)
1214 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1215 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1216 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1217 * - encoding: Set/allocated/freed by libavcodec.
1218 * - decoding: Set/allocated/freed by user.
1224 * This is the fundamental unit of time (in seconds) in terms
1225 * of which frame timestamps are represented. For fixed-fps content,
1226 * timebase should be 1/framerate and timestamp increments should be
1228 * - encoding: MUST be set by user.
1229 * - decoding: Set by libavcodec.
1231 AVRational time_base;
1235 * picture width / height.
1236 * - encoding: MUST be set by user.
1237 * - decoding: Set by libavcodec.
1238 * Note: For compatibility it is possible to set this instead of
1239 * coded_width/height before decoding.
1243 #define FF_ASPECT_EXTENDED 15
1246 * the number of pictures in a group of pictures, or 0 for intra_only
1247 * - encoding: Set by user.
1248 * - decoding: unused
1253 * Pixel format, see PIX_FMT_xxx.
1254 * May be set by the demuxer if known from headers.
1255 * May be overriden by the decoder if it knows better.
1256 * - encoding: Set by user.
1257 * - decoding: Set by user if known, overridden by libavcodec if known
1259 enum PixelFormat pix_fmt;
1262 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1263 * decoder to draw a horizontal band. It improves cache usage. Not
1264 * all codecs can do that. You must check the codec capabilities
1266 * When multithreading is used, it may be called from multiple threads
1267 * at the same time; threads might draw different parts of the same AVFrame,
1268 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1270 * The function is also used by hardware acceleration APIs.
1271 * It is called at least once during frame decoding to pass
1272 * the data needed for hardware render.
1273 * In that mode instead of pixel data, AVFrame points to
1274 * a structure specific to the acceleration API. The application
1275 * reads the structure and can change some fields to indicate progress
1277 * - encoding: unused
1278 * - decoding: Set by user.
1279 * @param height the height of the slice
1280 * @param y the y position of the slice
1281 * @param type 1->top field, 2->bottom field, 3->frame
1282 * @param offset offset into the AVFrame.data from which the slice should be read
1284 void (*draw_horiz_band)(struct AVCodecContext *s,
1285 const AVFrame *src, int offset[4],
1286 int y, int type, int height);
1289 int sample_rate; ///< samples per second
1290 int channels; ///< number of audio channels
1293 * audio sample format
1294 * - encoding: Set by user.
1295 * - decoding: Set by libavcodec.
1297 enum AVSampleFormat sample_fmt; ///< sample format
1299 /* The following data should not be initialized. */
1301 * Samples per packet, initialized when calling 'init'.
1304 int frame_number; ///< audio or video frame number
1307 * Number of frames the decoded output will be delayed relative to
1308 * the encoded input.
1309 * - encoding: Set by libavcodec.
1310 * - decoding: unused
1314 /* - encoding parameters */
1315 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1316 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1320 * - encoding: Set by user.
1321 * - decoding: unused
1327 * - encoding: Set by user.
1328 * - decoding: unused
1333 * maximum quantizer difference between frames
1334 * - encoding: Set by user.
1335 * - decoding: unused
1340 * maximum number of B-frames between non-B-frames
1341 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1342 * - encoding: Set by user.
1343 * - decoding: unused
1348 * qscale factor between IP and B-frames
1349 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1350 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1351 * - encoding: Set by user.
1352 * - decoding: unused
1354 float b_quant_factor;
1356 /** obsolete FIXME remove */
1358 #define FF_RC_STRATEGY_XVID 1
1360 int b_frame_strategy;
1362 struct AVCodec *codec;
1366 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1367 /* do its best to deliver a chunk with size */
1368 /* below rtp_payload_size, the chunk will start */
1369 /* with a start code on some codecs like H.263. */
1370 /* This doesn't take account of any particular */
1371 /* headers inside the transmitted RTP payload. */
1374 /* The RTP callback: This function is called */
1375 /* every time the encoder has a packet to send. */
1376 /* It depends on the encoder if the data starts */
1377 /* with a Start Code (it should). H.263 does. */
1378 /* mb_nb contains the number of macroblocks */
1379 /* encoded in the RTP payload. */
1380 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1382 /* statistics, used for 2-pass encoding */
1393 * number of bits used for the previously encoded frame
1394 * - encoding: Set by libavcodec.
1395 * - decoding: unused
1400 * Private data of the user, can be used to carry app specific stuff.
1401 * - encoding: Set by user.
1402 * - decoding: Set by user.
1406 char codec_name[32];
1407 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1408 enum CodecID codec_id; /* see CODEC_ID_xxx */
1411 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1412 * This is used to work around some encoder bugs.
1413 * A demuxer should set this to what is stored in the field used to identify the codec.
1414 * If there are multiple such fields in a container then the demuxer should choose the one
1415 * which maximizes the information about the used codec.
1416 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1417 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1418 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1420 * - encoding: Set by user, if not then the default based on codec_id will be used.
1421 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1423 unsigned int codec_tag;
1426 * Work around bugs in encoders which sometimes cannot be detected automatically.
1427 * - encoding: Set by user
1428 * - decoding: Set by user
1430 int workaround_bugs;
1431 #define FF_BUG_AUTODETECT 1 ///< autodetection
1432 #define FF_BUG_OLD_MSMPEG4 2
1433 #define FF_BUG_XVID_ILACE 4
1434 #define FF_BUG_UMP4 8
1435 #define FF_BUG_NO_PADDING 16
1436 #define FF_BUG_AMV 32
1437 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1438 #define FF_BUG_QPEL_CHROMA 64
1439 #define FF_BUG_STD_QPEL 128
1440 #define FF_BUG_QPEL_CHROMA2 256
1441 #define FF_BUG_DIRECT_BLOCKSIZE 512
1442 #define FF_BUG_EDGE 1024
1443 #define FF_BUG_HPEL_CHROMA 2048
1444 #define FF_BUG_DC_CLIP 4096
1445 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1446 #define FF_BUG_TRUNCATED 16384
1447 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1450 * luma single coefficient elimination threshold
1451 * - encoding: Set by user.
1452 * - decoding: unused
1454 int luma_elim_threshold;
1457 * chroma single coeff elimination threshold
1458 * - encoding: Set by user.
1459 * - decoding: unused
1461 int chroma_elim_threshold;
1464 * strictly follow the standard (MPEG4, ...).
1465 * - encoding: Set by user.
1466 * - decoding: Set by user.
1467 * Setting this to STRICT or higher means the encoder and decoder will
1468 * generally do stupid things, whereas setting it to unofficial or lower
1469 * will mean the encoder might produce output that is not supported by all
1470 * spec-compliant decoders. Decoders don't differentiate between normal,
1471 * unofficial and experimental (that is, they always try to decode things
1472 * when they can) unless they are explicitly asked to behave stupidly
1473 * (=strictly conform to the specs)
1475 int strict_std_compliance;
1476 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1477 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1478 #define FF_COMPLIANCE_NORMAL 0
1479 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1480 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1483 * qscale offset between IP and B-frames
1484 * - encoding: Set by user.
1485 * - decoding: unused
1487 float b_quant_offset;
1491 * Error recognition; higher values will detect more errors but may
1492 * misdetect some more or less valid parts as errors.
1493 * - encoding: unused
1494 * - decoding: Set by user.
1496 attribute_deprecated int error_recognition;
1497 #define FF_ER_CAREFUL 1
1498 #define FF_ER_COMPLIANT 2
1499 #define FF_ER_AGGRESSIVE 3
1500 #define FF_ER_VERY_AGGRESSIVE 4
1501 #define FF_ER_EXPLODE 5
1502 #endif /* FF_API_ER */
1505 * Called at the beginning of each frame to get a buffer for it.
1506 * If pic.reference is set then the frame will be read later by libavcodec.
1507 * avcodec_align_dimensions2() should be used to find the required width and
1508 * height, as they normally need to be rounded up to the next multiple of 16.
1509 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1510 * avcodec_default_get_buffer() instead of providing buffers allocated by
1512 * If frame multithreading is used and thread_safe_callbacks is set,
1513 * it may be called from a different thread, but not from more than one at once.
1514 * Does not need to be reentrant.
1515 * - encoding: unused
1516 * - decoding: Set by libavcodec, user can override.
1518 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1521 * Called to release buffers which were allocated with get_buffer.
1522 * A released buffer can be reused in get_buffer().
1523 * pic.data[*] must be set to NULL.
1524 * May be called from a different thread if frame multithreading is used,
1525 * but not by more than one thread at once, so does not need to be reentrant.
1526 * - encoding: unused
1527 * - decoding: Set by libavcodec, user can override.
1529 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1532 * Size of the frame reordering buffer in the decoder.
1533 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1534 * - encoding: Set by libavcodec.
1535 * - decoding: Set by libavcodec.
1540 * number of bytes per packet if constant and known or 0
1541 * Used by some WAV based audio codecs.
1545 #if FF_API_PARSE_FRAME
1547 * If true, only parsing is done. The frame data is returned.
1548 * Only MPEG audio decoders support this now.
1549 * - encoding: unused
1550 * - decoding: Set by user
1552 attribute_deprecated int parse_only;
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 enabled.
2328 * - encoding: unused
2329 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2331 int coded_width, coded_height;
2334 * frame skip threshold
2335 * - encoding: Set by user.
2336 * - decoding: unused
2338 int frame_skip_threshold;
2342 * - encoding: Set by user.
2343 * - decoding: unused
2345 int frame_skip_factor;
2348 * frame skip exponent
2349 * - encoding: Set by user.
2350 * - decoding: unused
2355 * frame skip comparison function
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * Border processing masking, raises the quantizer for mbs on the borders
2364 * - encoding: Set by user.
2365 * - decoding: unused
2367 float border_masking;
2370 * minimum MB lagrange multipler
2371 * - encoding: Set by user.
2372 * - decoding: unused
2377 * maximum MB lagrange multipler
2378 * - encoding: Set by user.
2379 * - decoding: unused
2385 * - encoding: Set by user.
2386 * - decoding: unused
2388 int me_penalty_compensation;
2392 * - encoding: unused
2393 * - decoding: Set by user.
2395 enum AVDiscard skip_loop_filter;
2399 * - encoding: unused
2400 * - decoding: Set by user.
2402 enum AVDiscard skip_idct;
2406 * - encoding: unused
2407 * - decoding: Set by user.
2409 enum AVDiscard skip_frame;
2413 * - encoding: Set by user.
2414 * - decoding: unused
2420 * - encoding: Set by user.
2421 * - decoding: unused
2425 #if FF_API_X264_GLOBAL_OPTS
2427 * constant rate factor - quality-based VBR - values ~correspond to qps
2428 * - encoding: Set by user.
2429 * - decoding: unused
2430 * @deprecated use 'crf' libx264 private option
2432 attribute_deprecated float crf;
2435 * constant quantization parameter rate control method
2436 * - encoding: Set by user.
2437 * - decoding: unused
2438 * @deprecated use 'cqp' libx264 private option
2440 attribute_deprecated int cqp;
2445 * - encoding: Set by user.
2446 * - decoding: unused
2451 * number of reference frames
2452 * - encoding: Set by user.
2453 * - decoding: Set by lavc.
2458 * chroma qp offset from luma
2459 * - encoding: Set by user.
2460 * - decoding: unused
2464 #if FF_API_X264_GLOBAL_OPTS
2466 * Influences how often B-frames are used.
2467 * - encoding: Set by user.
2468 * - decoding: unused
2470 attribute_deprecated int bframebias;
2474 * trellis RD quantization
2475 * - encoding: Set by user.
2476 * - decoding: unused
2480 #if FF_API_X264_GLOBAL_OPTS
2482 * Reduce fluctuations in qp (before curve compression).
2483 * - encoding: Set by user.
2484 * - decoding: unused
2486 attribute_deprecated float complexityblur;
2489 * in-loop deblocking filter alphac0 parameter
2490 * alpha is in the range -6...6
2491 * - encoding: Set by user.
2492 * - decoding: unused
2494 attribute_deprecated int deblockalpha;
2497 * in-loop deblocking filter beta parameter
2498 * beta is in the range -6...6
2499 * - encoding: Set by user.
2500 * - decoding: unused
2502 attribute_deprecated int deblockbeta;
2505 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2506 * - encoding: Set by user.
2507 * - decoding: unused
2509 attribute_deprecated int partitions;
2510 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2511 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2512 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2513 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2514 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2517 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2518 * - encoding: Set by user.
2519 * - decoding: unused
2521 attribute_deprecated int directpred;
2525 * Audio cutoff bandwidth (0 means "automatic")
2526 * - encoding: Set by user.
2527 * - decoding: unused
2532 * Multiplied by qscale for each frame and added to scene_change_score.
2533 * - encoding: Set by user.
2534 * - decoding: unused
2536 int scenechange_factor;
2540 * Note: Value depends upon the compare function used for fullpel ME.
2541 * - encoding: Set by user.
2542 * - decoding: unused
2547 * Adjusts sensitivity of b_frame_strategy 1.
2548 * - encoding: Set by user.
2549 * - decoding: unused
2554 * - encoding: Set by user.
2555 * - decoding: unused
2557 int compression_level;
2558 #define FF_COMPRESSION_DEFAULT -1
2561 * - encoding: Set by user.
2562 * - decoding: unused
2564 int min_prediction_order;
2567 * - encoding: Set by user.
2568 * - decoding: unused
2570 int max_prediction_order;
2572 #if FF_API_FLAC_GLOBAL_OPTS
2574 * @name FLAC options
2575 * @deprecated Use FLAC encoder private options instead.
2580 * LPC coefficient precision - used by FLAC encoder
2581 * - encoding: Set by user.
2582 * - decoding: unused
2584 attribute_deprecated int lpc_coeff_precision;
2587 * search method for selecting prediction order
2588 * - encoding: Set by user.
2589 * - decoding: unused
2591 attribute_deprecated int prediction_order_method;
2594 * - encoding: Set by user.
2595 * - decoding: unused
2597 attribute_deprecated int min_partition_order;
2600 * - encoding: Set by user.
2601 * - decoding: unused
2603 attribute_deprecated int max_partition_order;
2610 * GOP timecode frame start number, in non drop frame format
2611 * - encoding: Set by user.
2612 * - decoding: unused
2614 int64_t timecode_frame_start;
2616 #if FF_API_REQUEST_CHANNELS
2618 * Decoder should decode to this many channels if it can (0 for default)
2619 * - encoding: unused
2620 * - decoding: Set by user.
2621 * @deprecated Deprecated in favor of request_channel_layout.
2623 int request_channels;
2626 #if FF_API_DRC_SCALE
2628 * Percentage of dynamic range compression to be applied by the decoder.
2629 * The default value is 1.0, corresponding to full compression.
2630 * - encoding: unused
2631 * - decoding: Set by user.
2632 * @deprecated use AC3 decoder private option instead.
2634 attribute_deprecated float drc_scale;
2638 * opaque 64bit number (generally a PTS) that will be reordered and
2639 * output in AVFrame.reordered_opaque
2640 * @deprecated in favor of pkt_pts
2641 * - encoding: unused
2642 * - decoding: Set by user.
2644 int64_t reordered_opaque;
2647 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2648 * - encoding: set by user.
2649 * - decoding: set by libavcodec.
2651 int bits_per_raw_sample;
2654 * Audio channel layout.
2655 * - encoding: set by user.
2656 * - decoding: set by libavcodec.
2658 int64_t channel_layout;
2661 * Request decoder to use this channel layout if it can (0 for default)
2662 * - encoding: unused
2663 * - decoding: Set by user.
2665 int64_t request_channel_layout;
2668 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2669 * - encoding: Set by user.
2670 * - decoding: unused.
2672 float rc_max_available_vbv_use;
2675 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2676 * - encoding: Set by user.
2677 * - decoding: unused.
2679 float rc_min_vbv_overflow_use;
2682 * Hardware accelerator in use
2683 * - encoding: unused.
2684 * - decoding: Set by libavcodec
2686 struct AVHWAccel *hwaccel;
2689 * For some codecs, the time base is closer to the field rate than the frame rate.
2690 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2691 * if no telecine is used ...
2693 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2695 int ticks_per_frame;
2698 * Hardware accelerator context.
2699 * For some hardware accelerators, a global context needs to be
2700 * provided by the user. In that case, this holds display-dependent
2701 * data Libav cannot instantiate itself. Please refer to the
2702 * Libav HW accelerator documentation to know how to fill this
2703 * is. e.g. for VA API, this is a struct vaapi_context.
2704 * - encoding: unused
2705 * - decoding: Set by user
2707 void *hwaccel_context;
2710 * Chromaticity coordinates of the source primaries.
2711 * - encoding: Set by user
2712 * - decoding: Set by libavcodec
2714 enum AVColorPrimaries color_primaries;
2717 * Color Transfer Characteristic.
2718 * - encoding: Set by user
2719 * - decoding: Set by libavcodec
2721 enum AVColorTransferCharacteristic color_trc;
2724 * YUV colorspace type.
2725 * - encoding: Set by user
2726 * - decoding: Set by libavcodec
2728 enum AVColorSpace colorspace;
2731 * MPEG vs JPEG YUV range.
2732 * - encoding: Set by user
2733 * - decoding: Set by libavcodec
2735 enum AVColorRange color_range;
2738 * This defines the location of chroma samples.
2739 * - encoding: Set by user
2740 * - decoding: Set by libavcodec
2742 enum AVChromaLocation chroma_sample_location;
2745 * The codec may call this to execute several independent things.
2746 * It will return only after finishing all tasks.
2747 * The user may replace this with some multithreaded implementation,
2748 * the default implementation will execute the parts serially.
2749 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2750 * @param c context passed also to func
2751 * @param count the number of things to execute
2752 * @param arg2 argument passed unchanged to func
2753 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2754 * @param func function that will be called count times, with jobnr from 0 to count-1.
2755 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2756 * two instances of func executing at the same time will have the same threadnr.
2757 * @return always 0 currently, but code should handle a future improvement where when any call to func
2758 * returns < 0 no further calls to func may be done and < 0 is returned.
2759 * - encoding: Set by libavcodec, user can override.
2760 * - decoding: Set by libavcodec, user can override.
2762 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2764 #if FF_API_X264_GLOBAL_OPTS
2766 * explicit P-frame weighted prediction analysis method
2768 * 1: fast blind weighting (one reference duplicate with -1 offset)
2769 * 2: smart weighting (full fade detection analysis)
2770 * - encoding: Set by user.
2771 * - decoding: unused
2773 attribute_deprecated int weighted_p_pred;
2778 * 1: Variance AQ (complexity mask)
2779 * 2: Auto-variance AQ (experimental)
2780 * - encoding: Set by user
2781 * - decoding: unused
2783 attribute_deprecated int aq_mode;
2787 * Reduces blocking and blurring in flat and textured areas.
2788 * - encoding: Set by user
2789 * - decoding: unused
2791 attribute_deprecated float aq_strength;
2795 * Strength of psychovisual optimization
2796 * - encoding: Set by user
2797 * - decoding: unused
2799 attribute_deprecated float psy_rd;
2803 * Strength of psychovisual optimization
2804 * - encoding: Set by user
2805 * - decoding: unused
2807 attribute_deprecated float psy_trellis;
2811 * Number of frames for frametype and ratecontrol lookahead
2812 * - encoding: Set by user
2813 * - decoding: unused
2815 attribute_deprecated int rc_lookahead;
2818 * Constant rate factor maximum
2819 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2820 * than crf_max, even if doing so would violate VBV restrictions.
2821 * - encoding: Set by user.
2822 * - decoding: unused
2824 attribute_deprecated float crf_max;
2827 int log_level_offset;
2829 #if FF_API_FLAC_GLOBAL_OPTS
2831 * Determines which LPC analysis algorithm to use.
2832 * - encoding: Set by user
2833 * - decoding: unused
2835 attribute_deprecated enum AVLPCType lpc_type;
2838 * Number of passes to use for Cholesky factorization during LPC analysis
2839 * - encoding: Set by user
2840 * - decoding: unused
2842 attribute_deprecated int lpc_passes;
2847 * Indicates number of picture subdivisions. Used for parallelized
2849 * - encoding: Set by user
2850 * - decoding: unused
2855 * Header containing style information for text subtitles.
2856 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2857 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2858 * the Format line following. It shouldn't include any Dialogue line.
2859 * - encoding: Set/allocated/freed by user (before avcodec_open())
2860 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2862 uint8_t *subtitle_header;
2863 int subtitle_header_size;
2866 * Current packet as passed into the decoder, to avoid having
2867 * to pass the packet into every function. Currently only valid
2868 * inside lavc and get/release_buffer callbacks.
2869 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2870 * - encoding: unused
2875 * Whether this is a copy of the context which had init() called on it.
2876 * This is used by multithreading - shared tables and picture pointers
2877 * should be freed from the original context only.
2878 * - encoding: Set by libavcodec.
2879 * - decoding: Set by libavcodec.
2884 * Which multithreading methods to use.
2885 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2886 * so clients which cannot provide future frames should not use it.
2888 * - encoding: Set by user, otherwise the default is used.
2889 * - decoding: Set by user, otherwise the default is used.
2892 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2893 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2896 * Which multithreading methods are in use by the codec.
2897 * - encoding: Set by libavcodec.
2898 * - decoding: Set by libavcodec.
2900 int active_thread_type;
2903 * Set by the client if its custom get_buffer() callback can be called
2904 * from another thread, which allows faster multithreaded decoding.
2905 * draw_horiz_band() will be called from other threads regardless of this setting.
2906 * Ignored if the default get_buffer() is used.
2907 * - encoding: Set by user.
2908 * - decoding: Set by user.
2910 int thread_safe_callbacks;
2913 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2914 * Used for compliant TS muxing.
2915 * - encoding: Set by libavcodec.
2916 * - decoding: unused.
2921 * Type of service that the audio stream conveys.
2922 * - encoding: Set by user.
2923 * - decoding: Set by libavcodec.
2925 enum AVAudioServiceType audio_service_type;
2928 * Used to request a sample format from the decoder.
2929 * - encoding: unused.
2930 * - decoding: Set by user.
2932 enum AVSampleFormat request_sample_fmt;
2935 * Error recognition; may misdetect some more or less valid parts as errors.
2936 * - encoding: unused
2937 * - decoding: Set by user.
2939 int err_recognition;
2940 #define AV_EF_CRCCHECK (1<<0)
2941 #define AV_EF_BITSTREAM (1<<1)
2942 #define AV_EF_BUFFER (1<<2)
2943 #define AV_EF_EXPLODE (1<<3)
2949 typedef struct AVProfile {
2951 const char *name; ///< short name for the profile
2954 typedef struct AVCodecDefault AVCodecDefault;
2959 typedef struct AVCodec {
2961 * Name of the codec implementation.
2962 * The name is globally unique among encoders and among decoders (but an
2963 * encoder and a decoder can share the same name).
2964 * This is the primary way to find a codec from the user perspective.
2967 enum AVMediaType type;
2970 int (*init)(AVCodecContext *);
2971 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2972 int (*close)(AVCodecContext *);
2973 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2975 * Codec capabilities.
2979 struct AVCodec *next;
2982 * Will be called when seeking
2984 void (*flush)(AVCodecContext *);
2985 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2986 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2988 * Descriptive name for the codec, meant to be more human readable than name.
2989 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2991 const char *long_name;
2992 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2993 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2994 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2995 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2996 const AVClass *priv_class; ///< AVClass for the private context
2997 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3000 * @name Frame-level threading support functions
3004 * If defined, called on thread contexts when they are created.
3005 * If the codec allocates writable tables in init(), re-allocate them here.
3006 * priv_data will be set to a copy of the original.
3008 int (*init_thread_copy)(AVCodecContext *);
3010 * Copy necessary context variables from a previous thread context to the current one.
3011 * If not defined, the next thread will start automatically; otherwise, the codec
3012 * must call ff_thread_finish_setup().
3014 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3016 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3020 * Private codec-specific defaults.
3022 const AVCodecDefault *defaults;
3025 * Initialize codec static data, called from avcodec_register().
3027 void (*init_static_data)(struct AVCodec *codec);
3033 typedef struct AVHWAccel {
3035 * Name of the hardware accelerated codec.
3036 * The name is globally unique among encoders and among decoders (but an
3037 * encoder and a decoder can share the same name).
3042 * Type of codec implemented by the hardware accelerator.
3044 * See AVMEDIA_TYPE_xxx
3046 enum AVMediaType type;
3049 * Codec implemented by the hardware accelerator.
3056 * Supported pixel format.
3058 * Only hardware accelerated formats are supported here.
3060 enum PixelFormat pix_fmt;
3063 * Hardware accelerated codec capabilities.
3064 * see FF_HWACCEL_CODEC_CAP_*
3068 struct AVHWAccel *next;
3071 * Called at the beginning of each frame or field picture.
3073 * Meaningful frame information (codec specific) is guaranteed to
3074 * be parsed at this point. This function is mandatory.
3076 * Note that buf can be NULL along with buf_size set to 0.
3077 * Otherwise, this means the whole frame is available at this point.
3079 * @param avctx the codec context
3080 * @param buf the frame data buffer base
3081 * @param buf_size the size of the frame in bytes
3082 * @return zero if successful, a negative value otherwise
3084 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3087 * Callback for each slice.
3089 * Meaningful slice information (codec specific) is guaranteed to
3090 * be parsed at this point. This function is mandatory.
3092 * @param avctx the codec context
3093 * @param buf the slice data buffer base
3094 * @param buf_size the size of the slice in bytes
3095 * @return zero if successful, a negative value otherwise
3097 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3100 * Called at the end of each frame or field picture.
3102 * The whole picture is parsed at this point and can now be sent
3103 * to the hardware accelerator. This function is mandatory.
3105 * @param avctx the codec context
3106 * @return zero if successful, a negative value otherwise
3108 int (*end_frame)(AVCodecContext *avctx);
3111 * Size of HW accelerator private data.
3113 * Private data is allocated with av_mallocz() before
3114 * AVCodecContext.get_buffer() and deallocated after
3115 * AVCodecContext.release_buffer().
3121 * four components are given, that's all.
3122 * the last component is alpha
3124 typedef struct AVPicture {
3126 int linesize[4]; ///< number of bytes per line
3129 #define AVPALETTE_SIZE 1024
3130 #define AVPALETTE_COUNT 256
3131 #if FF_API_PALETTE_CONTROL
3134 * This structure defines a method for communicating palette changes
3135 * between and demuxer and a decoder.
3137 * @deprecated Use AVPacket to send palette changes instead.
3138 * This is totally broken.
3140 typedef struct AVPaletteControl {
3142 /* Demuxer sets this to 1 to indicate the palette has changed;
3143 * decoder resets to 0. */
3144 int palette_changed;
3146 /* 4-byte ARGB palette entries, stored in native byte order; note that
3147 * the individual palette components should be on a 8-bit scale; if
3148 * the palette data comes from an IBM VGA native format, the component
3149 * data is probably 6 bits in size and needs to be scaled. */
3150 unsigned int palette[AVPALETTE_COUNT];
3152 } AVPaletteControl attribute_deprecated;
3155 enum AVSubtitleType {
3158 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3161 * Plain text, the text field must be set by the decoder and is
3162 * authoritative. ass and pict fields may contain approximations.
3167 * Formatted text, the ass field must be set by the decoder and is
3168 * authoritative. pict and text fields may contain approximations.
3173 typedef struct AVSubtitleRect {
3174 int x; ///< top left corner of pict, undefined when pict is not set
3175 int y; ///< top left corner of pict, undefined when pict is not set
3176 int w; ///< width of pict, undefined when pict is not set
3177 int h; ///< height of pict, undefined when pict is not set
3178 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3181 * data+linesize for the bitmap of this subtitle.
3182 * can be set for text/ass as well once they where rendered
3185 enum AVSubtitleType type;
3187 char *text; ///< 0 terminated plain UTF-8 text
3190 * 0 terminated ASS/SSA compatible event line.
3191 * The pressentation of this is unaffected by the other values in this
3197 typedef struct AVSubtitle {
3198 uint16_t format; /* 0 = graphics */
3199 uint32_t start_display_time; /* relative to packet pts, in ms */
3200 uint32_t end_display_time; /* relative to packet pts, in ms */
3202 AVSubtitleRect **rects;
3203 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3206 /* packet functions */
3209 * @deprecated use NULL instead
3211 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3214 * Default packet destructor.
3216 void av_destruct_packet(AVPacket *pkt);
3219 * Initialize optional fields of a packet with default values.
3223 void av_init_packet(AVPacket *pkt);
3226 * Allocate the payload of a packet and initialize its fields with
3230 * @param size wanted payload size
3231 * @return 0 if OK, AVERROR_xxx otherwise
3233 int av_new_packet(AVPacket *pkt, int size);
3236 * Reduce packet size, correctly zeroing padding
3239 * @param size new size
3241 void av_shrink_packet(AVPacket *pkt, int size);
3244 * Increase packet size, correctly zeroing padding
3247 * @param grow_by number of bytes by which to increase the size of the packet
3249 int av_grow_packet(AVPacket *pkt, int grow_by);
3252 * @warning This is a hack - the packet memory allocation stuff is broken. The
3253 * packet is allocated if it was not really allocated.
3255 int av_dup_packet(AVPacket *pkt);
3260 * @param pkt packet to free
3262 void av_free_packet(AVPacket *pkt);
3265 * Allocate new information of a packet.
3268 * @param type side information type
3269 * @param size side information size
3270 * @return pointer to fresh allocated data or NULL otherwise
3272 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3276 * Get side information from packet.
3279 * @param type desired side information type
3280 * @param size pointer for side information size to store (optional)
3281 * @return pointer to data if present or NULL otherwise
3283 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3288 struct ReSampleContext;
3289 struct AVResampleContext;
3291 typedef struct ReSampleContext ReSampleContext;
3294 * Initialize audio resampling context.
3296 * @param output_channels number of output channels
3297 * @param input_channels number of input channels
3298 * @param output_rate output sample rate
3299 * @param input_rate input sample rate
3300 * @param sample_fmt_out requested output sample format
3301 * @param sample_fmt_in input sample format
3302 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3303 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3304 * @param linear if 1 then the used FIR filter will be linearly interpolated
3305 between the 2 closest, if 0 the closest will be used
3306 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3307 * @return allocated ReSampleContext, NULL if error occured
3309 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3310 int output_rate, int input_rate,
3311 enum AVSampleFormat sample_fmt_out,
3312 enum AVSampleFormat sample_fmt_in,
3313 int filter_length, int log2_phase_count,
3314 int linear, double cutoff);
3316 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3319 * Free resample context.
3321 * @param s a non-NULL pointer to a resample context previously
3322 * created with av_audio_resample_init()
3324 void audio_resample_close(ReSampleContext *s);
3328 * Initialize an audio resampler.
3329 * Note, if either rate is not an integer then simply scale both rates up so they are.
3330 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3331 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3332 * @param linear If 1 then the used FIR filter will be linearly interpolated
3333 between the 2 closest, if 0 the closest will be used
3334 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3336 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3339 * Resample an array of samples using a previously configured context.
3340 * @param src an array of unconsumed samples
3341 * @param consumed the number of samples of src which have been consumed are returned here
3342 * @param src_size the number of unconsumed samples available
3343 * @param dst_size the amount of space in samples available in dst
3344 * @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.
3345 * @return the number of samples written in dst or -1 if an error occurred
3347 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3351 * Compensate samplerate/timestamp drift. The compensation is done by changing
3352 * the resampler parameters, so no audible clicks or similar distortions occur
3353 * @param compensation_distance distance in output samples over which the compensation should be performed
3354 * @param sample_delta number of output samples which should be output less
3356 * example: av_resample_compensate(c, 10, 500)
3357 * here instead of 510 samples only 500 samples would be output
3359 * note, due to rounding the actual compensation might be slightly different,
3360 * especially if the compensation_distance is large and the in_rate used during init is small
3362 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3363 void av_resample_close(struct AVResampleContext *c);
3366 * Allocate memory for a picture. Call avpicture_free() to free it.
3368 * @see avpicture_fill()
3370 * @param picture the picture to be filled in
3371 * @param pix_fmt the format of the picture
3372 * @param width the width of the picture
3373 * @param height the height of the picture
3374 * @return zero if successful, a negative value if not
3376 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3379 * Free a picture previously allocated by avpicture_alloc().
3380 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3383 * @param picture the AVPicture to be freed
3385 void avpicture_free(AVPicture *picture);
3388 * Fill in the AVPicture fields.
3389 * The fields of the given AVPicture are filled in by using the 'ptr' address
3390 * which points to the image data buffer. Depending on the specified picture
3391 * format, one or multiple image data pointers and line sizes will be set.
3392 * If a planar format is specified, several pointers will be set pointing to
3393 * the different picture planes and the line sizes of the different planes
3394 * will be stored in the lines_sizes array.
3395 * Call with ptr == NULL to get the required size for the ptr buffer.
3397 * To allocate the buffer and fill in the AVPicture fields in one call,
3398 * use avpicture_alloc().
3400 * @param picture AVPicture whose fields are to be filled in
3401 * @param ptr Buffer which will contain or contains the actual image data
3402 * @param pix_fmt The format in which the picture data is stored.
3403 * @param width the width of the image in pixels
3404 * @param height the height of the image in pixels
3405 * @return size of the image data in bytes
3407 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3408 enum PixelFormat pix_fmt, int width, int height);
3411 * Copy pixel data from an AVPicture into a buffer.
3412 * The data is stored compactly, without any gaps for alignment or padding
3413 * which may be applied by avpicture_fill().
3415 * @see avpicture_get_size()
3417 * @param[in] src AVPicture containing image data
3418 * @param[in] pix_fmt The format in which the picture data is stored.
3419 * @param[in] width the width of the image in pixels.
3420 * @param[in] height the height of the image in pixels.
3421 * @param[out] dest A buffer into which picture data will be copied.
3422 * @param[in] dest_size The size of 'dest'.
3423 * @return The number of bytes written to dest, or a negative value (error code) on error.
3425 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3426 unsigned char *dest, int dest_size);
3429 * Calculate the size in bytes that a picture of the given width and height
3430 * would occupy if stored in the given picture format.
3431 * Note that this returns the size of a compact representation as generated
3432 * by avpicture_layout(), which can be smaller than the size required for e.g.
3435 * @param pix_fmt the given picture format
3436 * @param width the width of the image
3437 * @param height the height of the image
3438 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3440 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3441 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3443 #if FF_API_GET_PIX_FMT_NAME
3445 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3447 attribute_deprecated
3448 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3451 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3454 * Return a value representing the fourCC code associated to the
3455 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3458 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3461 * Put a string representing the codec tag codec_tag in buf.
3463 * @param buf_size size in bytes of buf
3464 * @return the length of the string that would have been generated if
3465 * enough space had been available, excluding the trailing null
3467 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3469 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3470 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3471 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3472 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3473 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3474 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3477 * Compute what kind of losses will occur when converting from one specific
3478 * pixel format to another.
3479 * When converting from one pixel format to another, information loss may occur.
3480 * For example, when converting from RGB24 to GRAY, the color information will
3481 * be lost. Similarly, other losses occur when converting from some formats to
3482 * other formats. These losses can involve loss of chroma, but also loss of
3483 * resolution, loss of color depth, loss due to the color space conversion, loss
3484 * of the alpha bits or loss due to color quantization.
3485 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3486 * which will occur when converting from one pixel format to another.
3488 * @param[in] dst_pix_fmt destination pixel format
3489 * @param[in] src_pix_fmt source pixel format
3490 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3491 * @return Combination of flags informing you what kind of losses will occur.
3493 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3497 * Find the best pixel format to convert to given a certain source pixel
3498 * format. When converting from one pixel format to another, information loss
3499 * may occur. For example, when converting from RGB24 to GRAY, the color
3500 * information will be lost. Similarly, other losses occur when converting from
3501 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3502 * the given pixel formats should be used to suffer the least amount of loss.
3503 * The pixel formats from which it chooses one, are determined by the
3504 * pix_fmt_mask parameter.
3507 * src_pix_fmt = PIX_FMT_YUV420P;
3508 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3509 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3512 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3513 * @param[in] src_pix_fmt source pixel format
3514 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3515 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3516 * @return The best pixel format to convert to or -1 if none was found.
3518 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3519 int has_alpha, int *loss_ptr);
3521 #if FF_API_GET_ALPHA_INFO
3522 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3523 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3526 * Tell if an image really has transparent alpha values.
3527 * @return ored mask of FF_ALPHA_xxx constants
3529 attribute_deprecated
3530 int img_get_alpha_info(const AVPicture *src,
3531 enum PixelFormat pix_fmt, int width, int height);
3534 /* deinterlace a picture */
3535 /* deinterlace - if not supported return -1 */
3536 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3537 enum PixelFormat pix_fmt, int width, int height);
3539 /* external high level API */
3542 * If c is NULL, returns the first registered codec,
3543 * if c is non-NULL, returns the next registered codec after c,
3544 * or NULL if c is the last one.
3546 AVCodec *av_codec_next(AVCodec *c);
3549 * Return the LIBAVCODEC_VERSION_INT constant.
3551 unsigned avcodec_version(void);
3554 * Return the libavcodec build-time configuration.
3556 const char *avcodec_configuration(void);
3559 * Return the libavcodec license.
3561 const char *avcodec_license(void);
3563 #if FF_API_AVCODEC_INIT
3565 * @deprecated this function is called automatically from avcodec_register()
3566 * and avcodec_register_all(), there is no need to call it manually
3568 attribute_deprecated
3569 void avcodec_init(void);
3573 * Register the codec codec and initialize libavcodec.
3575 * @warning either this function or avcodec_register_all() must be called
3576 * before any other libavcodec functions.
3578 * @see avcodec_register_all()
3580 void avcodec_register(AVCodec *codec);
3583 * Find a registered encoder with a matching codec ID.
3585 * @param id CodecID of the requested encoder
3586 * @return An encoder if one was found, NULL otherwise.
3588 AVCodec *avcodec_find_encoder(enum CodecID id);
3591 * Find a registered encoder with the specified name.
3593 * @param name name of the requested encoder
3594 * @return An encoder if one was found, NULL otherwise.
3596 AVCodec *avcodec_find_encoder_by_name(const char *name);
3599 * Find a registered decoder with a matching codec ID.
3601 * @param id CodecID of the requested decoder
3602 * @return A decoder if one was found, NULL otherwise.
3604 AVCodec *avcodec_find_decoder(enum CodecID id);
3607 * Find a registered decoder with the specified name.
3609 * @param name name of the requested decoder
3610 * @return A decoder if one was found, NULL otherwise.
3612 AVCodec *avcodec_find_decoder_by_name(const char *name);
3613 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3616 * Return a name for the specified profile, if available.
3618 * @param codec the codec that is searched for the given profile
3619 * @param profile the profile value for which a name is requested
3620 * @return A name for the profile if found, NULL otherwise.
3622 const char *av_get_profile_name(const AVCodec *codec, int profile);
3624 #if FF_API_ALLOC_CONTEXT
3626 * Set the fields of the given AVCodecContext to default values.
3628 * @param s The AVCodecContext of which the fields should be set to default values.
3629 * @deprecated use avcodec_get_context_defaults3
3631 attribute_deprecated
3632 void avcodec_get_context_defaults(AVCodecContext *s);
3634 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3635 * we WILL change its arguments and name a few times! */
3636 attribute_deprecated
3637 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3641 * Set the fields of the given AVCodecContext to default values corresponding
3642 * to the given codec (defaults may be codec-dependent).
3644 * Do not call this function if a non-NULL codec has been passed
3645 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3646 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3647 * different codec on this AVCodecContext.
3649 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3651 #if FF_API_ALLOC_CONTEXT
3653 * Allocate an AVCodecContext and set its fields to default values. The
3654 * resulting struct can be deallocated by simply calling av_free().
3656 * @return An AVCodecContext filled with default values or NULL on failure.
3657 * @see avcodec_get_context_defaults
3659 * @deprecated use avcodec_alloc_context3()
3661 attribute_deprecated
3662 AVCodecContext *avcodec_alloc_context(void);
3664 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3665 * we WILL change its arguments and name a few times! */
3666 attribute_deprecated
3667 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3671 * Allocate an AVCodecContext and set its fields to default values. The
3672 * resulting struct can be deallocated by simply calling av_free().
3674 * @param codec if non-NULL, allocate private data and initialize defaults
3675 * for the given codec. It is illegal to then call avcodec_open()
3676 * with a different codec.
3678 * @return An AVCodecContext filled with default values or NULL on failure.
3679 * @see avcodec_get_context_defaults
3681 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3684 * Copy the settings of the source AVCodecContext into the destination
3685 * AVCodecContext. The resulting destination codec context will be
3686 * unopened, i.e. you are required to call avcodec_open() before you
3687 * can use this AVCodecContext to decode/encode video/audio data.
3689 * @param dest target codec context, should be initialized with
3690 * avcodec_alloc_context3(), but otherwise uninitialized
3691 * @param src source codec context
3692 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3694 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3697 * Set the fields of the given AVFrame to default values.
3699 * @param pic The AVFrame of which the fields should be set to default values.
3701 void avcodec_get_frame_defaults(AVFrame *pic);
3704 * Allocate an AVFrame and set its fields to default values. The resulting
3705 * struct can be deallocated by simply calling av_free().
3707 * @return An AVFrame filled with default values or NULL on failure.
3708 * @see avcodec_get_frame_defaults
3710 AVFrame *avcodec_alloc_frame(void);
3712 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3713 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3714 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3717 * Return the amount of padding in pixels which the get_buffer callback must
3718 * provide around the edge of the image for codecs which do not have the
3719 * CODEC_FLAG_EMU_EDGE flag.
3721 * @return Required padding in pixels.
3723 unsigned avcodec_get_edge_width(void);
3725 * Modify width and height values so that they will result in a memory
3726 * buffer that is acceptable for the codec if you do not use any horizontal
3729 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3730 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3731 * according to avcodec_get_edge_width() before.
3733 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3735 * Modify width and height values so that they will result in a memory
3736 * buffer that is acceptable for the codec if you also ensure that all
3737 * line sizes are a multiple of the respective linesize_align[i].
3739 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3740 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3741 * according to avcodec_get_edge_width() before.
3743 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3744 int linesize_align[4]);
3746 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3748 #if FF_API_THREAD_INIT
3750 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3752 attribute_deprecated
3753 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3756 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3757 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3758 //FIXME func typedef
3760 #if FF_API_AVCODEC_OPEN
3762 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3763 * function the context has to be allocated.
3765 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3766 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3767 * retrieving a codec.
3769 * @warning This function is not thread safe!
3772 * avcodec_register_all();
3773 * codec = avcodec_find_decoder(CODEC_ID_H264);
3777 * context = avcodec_alloc_context3(codec);
3779 * if (avcodec_open(context, codec) < 0)
3783 * @param avctx The context which will be set up to use the given codec.
3784 * @param codec The codec to use within the context.
3785 * @return zero on success, a negative value on error
3786 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3788 * @deprecated use avcodec_open2
3790 attribute_deprecated
3791 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3795 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3796 * function the context has to be allocated with avcodec_alloc_context().
3798 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3799 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3800 * retrieving a codec.
3802 * @warning This function is not thread safe!
3805 * avcodec_register_all();
3806 * av_dict_set(&opts, "b", "2.5M", 0);
3807 * codec = avcodec_find_decoder(CODEC_ID_H264);
3811 * context = avcodec_alloc_context();
3813 * if (avcodec_open(context, codec, opts) < 0)
3817 * @param avctx The context to initialize.
3818 * @param options A dictionary filled with AVCodecContext and codec-private options.
3819 * On return this object will be filled with options that were not found.
3821 * @return zero on success, a negative value on error
3822 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3823 * av_dict_set(), av_opt_find().
3825 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3828 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3829 * Some decoders may support multiple frames in a single AVPacket, such
3830 * decoders would then just decode the first frame. In this case,
3831 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3832 * the remaining data in order to decode the second frame etc.
3834 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3835 * decompressed frame size in bytes.
3837 * @warning You must set frame_size_ptr to the allocated size of the
3838 * output buffer before calling avcodec_decode_audio3().
3840 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3841 * the actual read bytes because some optimized bitstream readers read 32 or 64
3842 * bits at once and could read over the end.
3844 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3845 * no overreading happens for damaged MPEG streams.
3847 * @note You might have to align the input buffer avpkt->data and output buffer
3848 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3849 * necessary at all, on others it won't work at all if not aligned and on others
3850 * it will work but it will have an impact on performance.
3852 * In practice, avpkt->data should have 4 byte alignment at minimum and
3853 * samples should be 16 byte aligned unless the CPU doesn't need it
3854 * (AltiVec and SSE do).
3856 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3857 * between input and output, these need to be fed with avpkt->data=NULL,
3858 * avpkt->size=0 at the end to return the remaining frames.
3860 * @param avctx the codec context
3861 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3862 * @param[in,out] frame_size_ptr the output buffer size in bytes
3863 * @param[in] avpkt The input AVPacket containing the input buffer.
3864 * You can create such packet with av_init_packet() and by then setting
3865 * data and size, some decoders might in addition need other fields.
3866 * All decoders are designed to use the least fields possible though.
3867 * @return On error a negative value is returned, otherwise the number of bytes
3868 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3870 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3871 int *frame_size_ptr,
3875 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3876 * Some decoders may support multiple frames in a single AVPacket, such
3877 * decoders would then just decode the first frame.
3879 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3880 * the actual read bytes because some optimized bitstream readers read 32 or 64
3881 * bits at once and could read over the end.
3883 * @warning The end of the input buffer buf should be set to 0 to ensure that
3884 * no overreading happens for damaged MPEG streams.
3886 * @note You might have to align the input buffer avpkt->data.
3887 * The alignment requirements depend on the CPU: on some CPUs it isn't
3888 * necessary at all, on others it won't work at all if not aligned and on others
3889 * it will work but it will have an impact on performance.
3891 * In practice, avpkt->data should have 4 byte alignment at minimum.
3893 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3894 * between input and output, these need to be fed with avpkt->data=NULL,
3895 * avpkt->size=0 at the end to return the remaining frames.
3897 * @param avctx the codec context
3898 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3899 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3900 * allocate memory for the actual bitmap.
3901 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3902 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3903 * decodes and the decoder tells the user once it does not need the data anymore,
3904 * the user app can at this point free/reuse/keep the memory as it sees fit.
3906 * @param[in] avpkt The input AVpacket containing the input buffer.
3907 * You can create such packet with av_init_packet() and by then setting
3908 * data and size, some decoders might in addition need other fields like
3909 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3911 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3912 * @return On error a negative value is returned, otherwise the number of bytes
3913 * used or zero if no frame could be decompressed.
3915 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3916 int *got_picture_ptr,
3920 * Decode a subtitle message.
3921 * Return a negative value on error, otherwise return the number of bytes used.
3922 * If no subtitle could be decompressed, got_sub_ptr is zero.
3923 * Otherwise, the subtitle is stored in *sub.
3924 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3925 * simplicity, because the performance difference is expect to be negligible
3926 * and reusing a get_buffer written for video codecs would probably perform badly
3927 * due to a potentially very different allocation pattern.
3929 * @param avctx the codec context
3930 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3931 freed with avsubtitle_free if *got_sub_ptr is set.
3932 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3933 * @param[in] avpkt The input AVPacket containing the input buffer.
3935 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3940 * Frees all allocated data in the given subtitle struct.
3942 * @param sub AVSubtitle to free.
3944 void avsubtitle_free(AVSubtitle *sub);
3947 * Encode an audio frame from samples into buf.
3949 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3950 * However, for PCM audio the user will know how much space is needed
3951 * because it depends on the value passed in buf_size as described
3952 * below. In that case a lower value can be used.
3954 * @param avctx the codec context
3955 * @param[out] buf the output buffer
3956 * @param[in] buf_size the output buffer size
3957 * @param[in] samples the input buffer containing the samples
3958 * The number of samples read from this buffer is frame_size*channels,
3959 * both of which are defined in avctx.
3960 * For PCM audio the number of samples read from samples is equal to
3961 * buf_size * input_sample_size / output_sample_size.
3962 * @return On error a negative value is returned, on success zero or the number
3963 * of bytes used to encode the data read from the input buffer.
3965 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3966 const short *samples);
3969 * Encode a video frame from pict into buf.
3970 * The input picture should be
3971 * stored using a specific format, namely avctx.pix_fmt.
3973 * @param avctx the codec context
3974 * @param[out] buf the output buffer for the bitstream of encoded frame
3975 * @param[in] buf_size the size of the output buffer in bytes
3976 * @param[in] pict the input picture to encode
3977 * @return On error a negative value is returned, on success zero or the number
3978 * of bytes used from the output buffer.
3980 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3981 const AVFrame *pict);
3982 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3983 const AVSubtitle *sub);
3985 int avcodec_close(AVCodecContext *avctx);
3988 * Register all the codecs, parsers and bitstream filters which were enabled at
3989 * configuration time. If you do not call this function you can select exactly
3990 * which formats you want to support, by using the individual registration
3993 * @see avcodec_register
3994 * @see av_register_codec_parser
3995 * @see av_register_bitstream_filter
3997 void avcodec_register_all(void);
4000 * Flush buffers, should be called when seeking or when switching to a different stream.
4002 void avcodec_flush_buffers(AVCodecContext *avctx);
4004 void avcodec_default_free_buffers(AVCodecContext *s);
4006 /* misc useful functions */
4008 #if FF_API_OLD_FF_PICT_TYPES
4010 * Return a single letter to describe the given picture type pict_type.
4012 * @param[in] pict_type the picture type
4013 * @return A single character representing the picture type.
4014 * @deprecated Use av_get_picture_type_char() instead.
4016 attribute_deprecated
4017 char av_get_pict_type_char(int pict_type);
4021 * Return codec bits per sample.
4023 * @param[in] codec_id the codec
4024 * @return Number of bits per sample or zero if unknown for the given codec.
4026 int av_get_bits_per_sample(enum CodecID codec_id);
4028 #if FF_API_OLD_SAMPLE_FMT
4030 * @deprecated Use av_get_bytes_per_sample() instead.
4032 attribute_deprecated
4033 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4037 typedef struct AVCodecParserContext {
4039 struct AVCodecParser *parser;
4040 int64_t frame_offset; /* offset of the current frame */
4041 int64_t cur_offset; /* current offset
4042 (incremented by each av_parser_parse()) */
4043 int64_t next_frame_offset; /* offset of the next frame */
4045 int pict_type; /* XXX: Put it back in AVCodecContext. */
4047 * This field is used for proper frame duration computation in lavf.
4048 * It signals, how much longer the frame duration of the current frame
4049 * is compared to normal frame duration.
4051 * frame_duration = (1 + repeat_pict) * time_base
4053 * It is used by codecs like H.264 to display telecined material.
4055 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4056 int64_t pts; /* pts of the current frame */
4057 int64_t dts; /* dts of the current frame */
4062 int fetch_timestamp;
4064 #define AV_PARSER_PTS_NB 4
4065 int cur_frame_start_index;
4066 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4067 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4068 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4071 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4072 #define PARSER_FLAG_ONCE 0x0002
4073 /// Set if the parser has a valid file offset
4074 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4076 int64_t offset; ///< byte offset from starting packet start
4077 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4080 * Set by parser to 1 for key frames and 0 for non-key frames.
4081 * It is initialized to -1, so if the parser doesn't set this flag,
4082 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4088 * Time difference in stream time base units from the pts of this
4089 * packet to the point at which the output from the decoder has converged
4090 * independent from the availability of previous frames. That is, the
4091 * frames are virtually identical no matter if decoding started from
4092 * the very first frame or from this keyframe.
4093 * Is AV_NOPTS_VALUE if unknown.
4094 * This field is not the display duration of the current frame.
4095 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4098 * The purpose of this field is to allow seeking in streams that have no
4099 * keyframes in the conventional sense. It corresponds to the
4100 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4101 * essential for some types of subtitle streams to ensure that all
4102 * subtitles are correctly displayed after seeking.
4104 int64_t convergence_duration;
4106 // Timestamp generation support:
4108 * Synchronization point for start of timestamp generation.
4110 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4113 * For example, this corresponds to presence of H.264 buffering period
4119 * Offset of the current timestamp against last timestamp sync point in
4120 * units of AVCodecContext.time_base.
4122 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4123 * contain a valid timestamp offset.
4125 * Note that the timestamp of sync point has usually a nonzero
4126 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4127 * the next frame after timestamp sync point will be usually 1.
4129 * For example, this corresponds to H.264 cpb_removal_delay.
4131 int dts_ref_dts_delta;
4134 * Presentation delay of current frame in units of AVCodecContext.time_base.
4136 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4137 * contain valid non-negative timestamp delta (presentation time of a frame
4138 * must not lie in the past).
4140 * This delay represents the difference between decoding and presentation
4141 * time of the frame.
4143 * For example, this corresponds to H.264 dpb_output_delay.
4148 * Position of the packet in file.
4150 * Analogous to cur_frame_pts/dts
4152 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4155 * Byte position of currently parsed frame in stream.
4160 * Previous frame byte position.
4163 } AVCodecParserContext;
4165 typedef struct AVCodecParser {
4166 int codec_ids[5]; /* several codec IDs are permitted */
4168 int (*parser_init)(AVCodecParserContext *s);
4169 int (*parser_parse)(AVCodecParserContext *s,
4170 AVCodecContext *avctx,
4171 const uint8_t **poutbuf, int *poutbuf_size,
4172 const uint8_t *buf, int buf_size);
4173 void (*parser_close)(AVCodecParserContext *s);
4174 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4175 struct AVCodecParser *next;
4178 AVCodecParser *av_parser_next(AVCodecParser *c);
4180 void av_register_codec_parser(AVCodecParser *parser);
4181 AVCodecParserContext *av_parser_init(int codec_id);
4186 * @param s parser context.
4187 * @param avctx codec context.
4188 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4189 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4190 * @param buf input buffer.
4191 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4192 * @param pts input presentation timestamp.
4193 * @param dts input decoding timestamp.
4194 * @param pos input byte position in stream.
4195 * @return the number of bytes of the input bitstream used.
4200 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4207 * decode_frame(data, size);
4211 int av_parser_parse2(AVCodecParserContext *s,
4212 AVCodecContext *avctx,
4213 uint8_t **poutbuf, int *poutbuf_size,
4214 const uint8_t *buf, int buf_size,
4215 int64_t pts, int64_t dts,
4218 int av_parser_change(AVCodecParserContext *s,
4219 AVCodecContext *avctx,
4220 uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size, int keyframe);
4222 void av_parser_close(AVCodecParserContext *s);
4225 typedef struct AVBitStreamFilterContext {
4227 struct AVBitStreamFilter *filter;
4228 AVCodecParserContext *parser;
4229 struct AVBitStreamFilterContext *next;
4230 } AVBitStreamFilterContext;
4233 typedef struct AVBitStreamFilter {
4236 int (*filter)(AVBitStreamFilterContext *bsfc,
4237 AVCodecContext *avctx, const char *args,
4238 uint8_t **poutbuf, int *poutbuf_size,
4239 const uint8_t *buf, int buf_size, int keyframe);
4240 void (*close)(AVBitStreamFilterContext *bsfc);
4241 struct AVBitStreamFilter *next;
4242 } AVBitStreamFilter;
4244 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4245 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4246 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4247 AVCodecContext *avctx, const char *args,
4248 uint8_t **poutbuf, int *poutbuf_size,
4249 const uint8_t *buf, int buf_size, int keyframe);
4250 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4252 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4257 * Reallocate the given block if it is not large enough, otherwise do nothing.
4261 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4264 * Allocate a buffer, reusing the given one if large enough.
4266 * Contrary to av_fast_realloc the current buffer contents might not be
4267 * preserved and on error the old buffer is freed, thus no special
4268 * handling to avoid memleaks is necessary.
4270 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4271 * @param size size of the buffer *ptr points to
4272 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4273 * *size 0 if an error occurred.
4275 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4278 * Copy image src to dst. Wraps av_picture_data_copy() above.
4280 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4281 enum PixelFormat pix_fmt, int width, int height);
4284 * Crop image top and left side.
4286 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4287 enum PixelFormat pix_fmt, int top_band, int left_band);
4292 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4293 int padtop, int padbottom, int padleft, int padright, int *color);
4296 * Encode extradata length to a buffer. Used by xiph codecs.
4298 * @param s buffer to write to; must be at least (v/255+1) bytes long
4299 * @param v size of extradata in bytes
4300 * @return number of bytes written to the buffer.
4302 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4305 * Logs a generic warning message about a missing feature. This function is
4306 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4307 * only, and would normally not be used by applications.
4308 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4309 * a pointer to an AVClass struct
4310 * @param[in] feature string containing the name of the missing feature
4311 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4312 * If want_sample is non-zero, additional verbage will be added to the log
4313 * message which tells the user how to report samples to the development
4316 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4319 * Log a generic warning message asking for a sample. This function is
4320 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4321 * only, and would normally not be used by applications.
4322 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4323 * a pointer to an AVClass struct
4324 * @param[in] msg string containing an optional message, or NULL if no message
4326 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4329 * Register the hardware accelerator hwaccel.
4331 void av_register_hwaccel(AVHWAccel *hwaccel);
4334 * If hwaccel is NULL, returns the first registered hardware accelerator,
4335 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4336 * after hwaccel, or NULL if hwaccel is the last one.
4338 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4342 * Lock operation used by lockmgr
4345 AV_LOCK_CREATE, ///< Create a mutex
4346 AV_LOCK_OBTAIN, ///< Lock the mutex
4347 AV_LOCK_RELEASE, ///< Unlock the mutex
4348 AV_LOCK_DESTROY, ///< Free mutex resources
4352 * Register a user provided lock manager supporting the operations
4353 * specified by AVLockOp. mutex points to a (void *) where the
4354 * lockmgr should store/get a pointer to a user allocated mutex. It's
4355 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4357 * @param cb User defined callback. Note: Libav may invoke calls to this
4358 * callback during the call to av_lockmgr_register().
4359 * Thus, the application must be prepared to handle that.
4360 * If cb is set to NULL the lockmgr will be unregistered.
4361 * Also note that during unregistration the previously registered
4362 * lockmgr callback may also be invoked.
4364 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4367 * Get the type of the given codec.
4369 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4372 * Get the AVClass for AVCodecContext. It can be used in combination with
4373 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4375 * @see av_opt_find().
4377 const AVClass *avcodec_get_class(void);
4379 #endif /* AVCODEC_AVCODEC_H */