2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
51 * This ensures that 2 forks can independantly add CodecIDs without producing conflicts.
58 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
59 CODEC_ID_MPEG2VIDEO_XVMC,
96 CODEC_ID_INTERPLAY_VIDEO,
108 CODEC_ID_TRUEMOTION1,
135 CODEC_ID_TRUEMOTION2,
152 CODEC_ID_DSICINVIDEO,
153 CODEC_ID_TIERTEXSEQVIDEO,
156 #if LIBAVCODEC_VERSION_MAJOR == 53
164 CODEC_ID_BETHSOFTVID,
176 #if LIBAVCODEC_VERSION_MAJOR == 53
184 CODEC_ID_MOTIONPIXELS,
202 CODEC_ID_IFF_BYTERUN1,
218 #if LIBAVCODEC_VERSION_MAJOR == 53
219 CODEC_ID_G723_1_DEPRECATED,
220 CODEC_ID_G729_DEPRECATED,
222 CODEC_ID_UTVIDEO_DEPRECATED,
225 CODEC_ID_UTVIDEO = 0x800,
227 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
229 /* various PCM "codecs" */
230 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
231 CODEC_ID_PCM_S16LE = 0x10000,
247 CODEC_ID_PCM_S24DAUD,
249 CODEC_ID_PCM_S16LE_PLANAR,
258 CODEC_ID_PCM_S8_PLANAR,
260 /* various ADPCM codecs */
261 CODEC_ID_ADPCM_IMA_QT = 0x11000,
262 CODEC_ID_ADPCM_IMA_WAV,
263 CODEC_ID_ADPCM_IMA_DK3,
264 CODEC_ID_ADPCM_IMA_DK4,
265 CODEC_ID_ADPCM_IMA_WS,
266 CODEC_ID_ADPCM_IMA_SMJPEG,
275 CODEC_ID_ADPCM_YAMAHA,
276 CODEC_ID_ADPCM_SBPRO_4,
277 CODEC_ID_ADPCM_SBPRO_3,
278 CODEC_ID_ADPCM_SBPRO_2,
280 CODEC_ID_ADPCM_IMA_AMV,
281 CODEC_ID_ADPCM_EA_R1,
282 CODEC_ID_ADPCM_EA_R3,
283 CODEC_ID_ADPCM_EA_R2,
284 CODEC_ID_ADPCM_IMA_EA_SEAD,
285 CODEC_ID_ADPCM_IMA_EA_EACS,
286 CODEC_ID_ADPCM_EA_XAS,
287 CODEC_ID_ADPCM_EA_MAXIS_XA,
288 CODEC_ID_ADPCM_IMA_ISS,
292 CODEC_ID_AMR_NB = 0x12000,
295 /* RealAudio codecs*/
296 CODEC_ID_RA_144 = 0x13000,
299 /* various DPCM codecs */
300 CODEC_ID_ROQ_DPCM = 0x14000,
301 CODEC_ID_INTERPLAY_DPCM,
306 CODEC_ID_MP2 = 0x15000,
307 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
318 #if LIBAVCODEC_VERSION_MAJOR == 53
327 CODEC_ID_WESTWOOD_SND1,
328 CODEC_ID_GSM, ///< as in Berlin toast format
336 CODEC_ID_DSICINAUDIO,
340 CODEC_ID_GSM_MS, /* as found in WAV */
349 CODEC_ID_WMALOSSLESS,
358 CODEC_ID_BINKAUDIO_RDFT,
359 CODEC_ID_BINKAUDIO_DCT,
363 #if LIBAVCODEC_VERSION_MAJOR > 53
364 CODEC_ID_G723_1_DEPRECATED,
365 CODEC_ID_G729_DEPRECATED,
370 CODEC_ID_G729 = 0x15800,
371 CODEC_ID_G723_1= 0x15801,
372 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
374 /* subtitle codecs */
375 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
376 CODEC_ID_DVD_SUBTITLE = 0x17000,
377 CODEC_ID_DVB_SUBTITLE,
378 CODEC_ID_TEXT, ///< raw UTF-8 text
382 CODEC_ID_HDMV_PGS_SUBTITLE,
383 CODEC_ID_DVB_TELETEXT,
385 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
387 /* other specific kind of codecs (generally used for attachments) */
388 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
389 CODEC_ID_TTF = 0x18000,
390 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
391 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
392 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
394 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
396 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
397 * stream (only used by libavformat) */
398 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
399 * stream (only used by libavformat) */
400 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
403 #if FF_API_OLD_SAMPLE_FMT
404 #define SampleFormat AVSampleFormat
406 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
407 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
408 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
409 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
410 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
411 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
412 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
415 #if FF_API_OLD_AUDIOCONVERT
416 #include "libavutil/audioconvert.h"
418 /* Audio channel masks */
419 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
420 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
421 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
422 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
423 #define CH_BACK_LEFT AV_CH_BACK_LEFT
424 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
425 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
426 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
427 #define CH_BACK_CENTER AV_CH_BACK_CENTER
428 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
429 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
430 #define CH_TOP_CENTER AV_CH_TOP_CENTER
431 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
432 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
433 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
434 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
435 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
436 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
437 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
438 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
440 /** Channel mask value used for AVCodecContext.request_channel_layout
441 to indicate that the user requests the channel order of the decoder output
442 to be the native codec channel order. */
443 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
445 /* Audio channel convenience macros */
446 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
447 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
448 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
449 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
450 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
451 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
452 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
453 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
454 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
455 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
456 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
457 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
458 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
459 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
460 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
464 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
467 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
468 * This is mainly needed because some optimized bitstream readers read
469 * 32 or 64 bit at once and could read over the end.<br>
470 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
471 * MPEG bitstreams could cause overread and segfault.
473 #define FF_INPUT_BUFFER_PADDING_SIZE 16
476 * minimum encoding buffer size
477 * Used to avoid some checks during header writing.
479 #define FF_MIN_BUFFER_SIZE 16384
483 * motion estimation type.
486 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
490 ME_EPZS, ///< enhanced predictive zonal search
491 ME_X1, ///< reserved for experiments
492 ME_HEX, ///< hexagon based search
493 ME_UMH, ///< uneven multi-hexagon search
494 ME_ITER, ///< iterative search
495 ME_TESA, ///< transformed exhaustive search algorithm
499 /* We leave some space between them for extensions (drop some
500 * keyframes for intra-only or drop just some bidir frames). */
501 AVDISCARD_NONE =-16, ///< discard nothing
502 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
503 AVDISCARD_NONREF = 8, ///< discard all non reference
504 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
505 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
506 AVDISCARD_ALL = 48, ///< discard all
509 enum AVColorPrimaries{
510 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
511 AVCOL_PRI_UNSPECIFIED=2,
513 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
514 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
515 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
517 AVCOL_PRI_NB , ///< Not part of ABI
520 enum AVColorTransferCharacteristic{
521 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
522 AVCOL_TRC_UNSPECIFIED=2,
523 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
524 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
525 AVCOL_TRC_SMPTE240M =7,
526 AVCOL_TRC_NB , ///< Not part of ABI
531 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
532 AVCOL_SPC_UNSPECIFIED=2,
534 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
535 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
536 AVCOL_SPC_SMPTE240M =7,
538 AVCOL_SPC_NB , ///< Not part of ABI
542 AVCOL_RANGE_UNSPECIFIED=0,
543 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
544 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
545 AVCOL_RANGE_NB , ///< Not part of ABI
549 * X X 3 4 X X are luma samples,
550 * 1 2 1-6 are possible chroma positions
551 * X X 5 6 X 0 is undefined/unknown position
553 enum AVChromaLocation{
554 AVCHROMA_LOC_UNSPECIFIED=0,
555 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
556 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
557 AVCHROMA_LOC_TOPLEFT =3, ///< DV
559 AVCHROMA_LOC_BOTTOMLEFT =5,
560 AVCHROMA_LOC_BOTTOM =6,
561 AVCHROMA_LOC_NB , ///< Not part of ABI
564 #if FF_API_FLAC_GLOBAL_OPTS
569 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
570 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
571 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
572 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
573 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
574 AV_LPC_TYPE_NB , ///< Not part of ABI
578 enum AVAudioServiceType {
579 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
580 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
581 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
582 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
583 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
584 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
585 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
586 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
587 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
588 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
591 typedef struct RcOverride{
594 int qscale; // If this is 0 then quality_factor will be used instead.
595 float quality_factor;
598 #define FF_MAX_B_FRAMES 16
601 These flags can be passed in AVCodecContext.flags before initialization.
602 Note: Not everything is supported yet.
605 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
606 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
607 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
608 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
609 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
611 * The parent program guarantees that the input for B-frames containing
612 * streams is not written to for at least s->max_b_frames+1 frames, if
613 * this is not set the input will be copied.
615 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
616 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
617 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
618 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
619 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
620 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
621 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
622 location instead of only at frame boundaries. */
623 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
624 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
625 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
626 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
627 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
628 /* Fx : Flag for h263+ extra options */
629 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
630 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
631 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
632 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
633 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
634 #define CODEC_FLAG_CLOSED_GOP 0x80000000
635 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
636 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
637 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
638 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
639 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
640 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
641 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
643 * @defgroup deprecated_flags Deprecated codec flags
644 * Use corresponding private codec options instead.
647 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
648 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
649 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
650 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
651 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
652 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
653 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
654 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
655 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
656 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
657 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
659 #if FF_API_MJPEG_GLOBAL_OPTS
660 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
662 #if FF_API_X264_GLOBAL_OPTS
663 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
664 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
665 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
666 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
667 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
668 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
669 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
670 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
671 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
672 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
673 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
675 #if FF_API_SNOW_GLOBAL_OPTS
676 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
678 #if FF_API_LAME_GLOBAL_OPTS
679 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
685 /* Unsupported options :
686 * Syntax Arithmetic coding (SAC)
687 * Reference Picture Selection
688 * Independent Segment Decoding */
690 /* codec capabilities */
692 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
694 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
695 * If not set, it might not use get_buffer() at all or use operations that
696 * assume the buffer was allocated by avcodec_default_get_buffer.
698 #define CODEC_CAP_DR1 0x0002
699 #if FF_API_PARSE_FRAME
700 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
701 #define CODEC_CAP_PARSE_ONLY 0x0004
703 #define CODEC_CAP_TRUNCATED 0x0008
704 /* Codec can export data for HW decoding (XvMC). */
705 #define CODEC_CAP_HWACCEL 0x0010
707 * Codec has a nonzero delay and needs to be fed with avpkt->data=NULL,
708 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
709 * returns frames. If this is not set, the codec is guaranteed to never be fed
712 #define CODEC_CAP_DELAY 0x0020
714 * Codec can be fed a final frame with a smaller size.
715 * This can be used to prevent truncation of the last audio samples.
717 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
719 * Codec can export data for HW decoding (VDPAU).
721 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
723 * Codec can output multiple frames per AVPacket
724 * Normally demuxers return one frame at a time, demuxers which do not do
725 * are connected to a parser to split what they return into proper frames.
726 * This flag is reserved to the very rare category of codecs which have a
727 * bitstream that cannot be split into frames without timeconsuming
728 * operations like full decoding. Demuxers carring such bitstreams thus
729 * may return multiple frames in a packet. This has many disadvantages like
730 * prohibiting stream copy in many cases thus it should only be considered
733 #define CODEC_CAP_SUBFRAMES 0x0100
735 * Codec is experimental and is thus avoided in favor of non experimental
738 #define CODEC_CAP_EXPERIMENTAL 0x0200
740 * Codec should fill in channel configuration and samplerate instead of container
742 #define CODEC_CAP_CHANNEL_CONF 0x0400
745 * Codec is able to deal with negative linesizes
747 #define CODEC_CAP_NEG_LINESIZES 0x0800
750 * Codec supports frame-level multithreading.
752 #define CODEC_CAP_FRAME_THREADS 0x1000
754 * Codec supports slice-based (or partition-based) multithreading.
756 #define CODEC_CAP_SLICE_THREADS 0x2000
760 #define CODEC_CAP_LOSSLESS 0x80000000
762 //The following defines may change, don't expect compatibility if you use them.
763 #define MB_TYPE_INTRA4x4 0x0001
764 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
765 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
766 #define MB_TYPE_16x16 0x0008
767 #define MB_TYPE_16x8 0x0010
768 #define MB_TYPE_8x16 0x0020
769 #define MB_TYPE_8x8 0x0040
770 #define MB_TYPE_INTERLACED 0x0080
771 #define MB_TYPE_DIRECT2 0x0100 //FIXME
772 #define MB_TYPE_ACPRED 0x0200
773 #define MB_TYPE_GMC 0x0400
774 #define MB_TYPE_SKIP 0x0800
775 #define MB_TYPE_P0L0 0x1000
776 #define MB_TYPE_P1L0 0x2000
777 #define MB_TYPE_P0L1 0x4000
778 #define MB_TYPE_P1L1 0x8000
779 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
780 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
781 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
782 #define MB_TYPE_QUANT 0x00010000
783 #define MB_TYPE_CBP 0x00020000
784 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
788 * This specifies the area which should be displayed.
789 * Note there may be multiple such areas for one frame.
791 typedef struct AVPanScan{
794 * - encoding: Set by user.
795 * - decoding: Set by libavcodec.
800 * width and height in 1/16 pel
801 * - encoding: Set by user.
802 * - decoding: Set by libavcodec.
808 * position of the top left corner in 1/16 pel for up to 3 fields/frames
809 * - encoding: Set by user.
810 * - decoding: Set by libavcodec.
812 int16_t position[3][2];
815 #define FF_QSCALE_TYPE_MPEG1 0
816 #define FF_QSCALE_TYPE_MPEG2 1
817 #define FF_QSCALE_TYPE_H264 2
818 #define FF_QSCALE_TYPE_VP56 3
820 #define FF_BUFFER_TYPE_INTERNAL 1
821 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
822 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
823 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
825 #if FF_API_OLD_FF_PICT_TYPES
826 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
827 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
828 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
829 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
830 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
831 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
832 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
833 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
836 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
837 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
838 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
839 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
841 enum AVPacketSideDataType {
845 typedef struct AVPacket {
847 * Presentation timestamp in AVStream->time_base units; the time at which
848 * the decompressed packet will be presented to the user.
849 * Can be AV_NOPTS_VALUE if it is not stored in the file.
850 * pts MUST be larger or equal to dts as presentation cannot happen before
851 * decompression, unless one wants to view hex dumps. Some formats misuse
852 * the terms dts and pts/cts to mean something different. Such timestamps
853 * must be converted to true pts/dts before they are stored in AVPacket.
857 * Decompression timestamp in AVStream->time_base units; the time at which
858 * the packet is decompressed.
859 * Can be AV_NOPTS_VALUE if it is not stored in the file.
866 * A combination of AV_PKT_FLAG values
870 * Additional packet data that can be provided by the container.
871 * Packet can contain several types of side information.
876 enum AVPacketSideDataType type;
881 * Duration of this packet in AVStream->time_base units, 0 if unknown.
882 * Equals next_pts - this_pts in presentation order.
885 void (*destruct)(struct AVPacket *);
887 int64_t pos; ///< byte position in stream, -1 if unknown
890 * Time difference in AVStream->time_base units from the pts of this
891 * packet to the point at which the output from the decoder has converged
892 * independent from the availability of previous frames. That is, the
893 * frames are virtually identical no matter if decoding started from
894 * the very first frame or from this keyframe.
895 * Is AV_NOPTS_VALUE if unknown.
896 * This field is not the display duration of the current packet.
897 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
900 * The purpose of this field is to allow seeking in streams that have no
901 * keyframes in the conventional sense. It corresponds to the
902 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
903 * essential for some types of subtitle streams to ensure that all
904 * subtitles are correctly displayed after seeking.
906 int64_t convergence_duration;
908 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
909 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
913 * New fields can be added to the end of AVFRAME with minor version
914 * bumps. Removal, reordering and changes to existing fields require
915 * a major version bump.
916 * sizeof(AVFrame) must not be used outside libav*.
918 typedef struct AVFrame {
920 * pointer to the picture planes.
921 * This might be different from the first allocated byte
928 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
929 * This isn't used by libavcodec unless the default get/release_buffer() is used.
935 * 1 -> keyframe, 0-> not
936 * - encoding: Set by libavcodec.
937 * - decoding: Set by libavcodec.
942 * Picture type of the frame, see ?_TYPE below.
943 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
944 * - decoding: Set by libavcodec.
946 enum AVPictureType pict_type;
949 * presentation timestamp in time_base units (time when frame should be shown to user)
950 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
951 * - encoding: MUST be set by user.
952 * - decoding: Set by libavcodec.
957 * picture number in bitstream order
959 * - decoding: Set by libavcodec.
961 int coded_picture_number;
963 * picture number in display order
965 * - decoding: Set by libavcodec.
967 int display_picture_number;
970 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
971 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
972 * - decoding: Set by libavcodec.
977 * buffer age (1->was last buffer and dint change, 2->..., ...).
978 * Set to INT_MAX if the buffer has not been used yet.
980 * - decoding: MUST be set by get_buffer().
985 * is this picture used as reference
986 * The values for this are the same as the MpegEncContext.picture_structure
987 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
988 * Set to 4 for delayed, non-reference frames.
990 * - decoding: Set by libavcodec. (before get_buffer() call)).
997 * - decoding: Set by libavcodec.
999 int8_t *qscale_table;
1002 * - encoding: unused
1003 * - decoding: Set by libavcodec.
1008 * mbskip_table[mb]>=1 if MB didn't change
1009 * stride= mb_width = (width+15)>>4
1010 * - encoding: unused
1011 * - decoding: Set by libavcodec.
1013 uint8_t *mbskip_table;
1016 * motion vector table
1019 * int mv_sample_log2= 4 - motion_subsample_log2;
1020 * int mb_width= (width+15)>>4;
1021 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1022 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1024 * - encoding: Set by user.
1025 * - decoding: Set by libavcodec.
1027 int16_t (*motion_val[2])[2];
1030 * macroblock type table
1031 * mb_type_base + mb_width + 2
1032 * - encoding: Set by user.
1033 * - decoding: Set by libavcodec.
1038 * log2 of the size of the block which a single vector in motion_val represents:
1039 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1040 * - encoding: unused
1041 * - decoding: Set by libavcodec.
1043 uint8_t motion_subsample_log2;
1046 * for some private data of the user
1047 * - encoding: unused
1048 * - decoding: Set by user.
1054 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1055 * - decoding: unused
1060 * type of the buffer (to keep track of who has to deallocate data[*])
1061 * - encoding: Set by the one who allocates it.
1062 * - decoding: Set by the one who allocates it.
1063 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1068 * When decoding, this signals how much the picture must be delayed.
1069 * extra_delay = repeat_pict / (2*fps)
1070 * - encoding: unused
1071 * - decoding: Set by libavcodec.
1081 * The content of the picture is interlaced.
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec. (default 0)
1085 int interlaced_frame;
1088 * If the content is interlaced, is top field displayed first.
1089 * - encoding: Set by user.
1090 * - decoding: Set by libavcodec.
1092 int top_field_first;
1096 * - encoding: Set by user.
1097 * - decoding: Set by libavcodec.
1099 AVPanScan *pan_scan;
1102 * Tell user application that palette has changed from previous frame.
1103 * - encoding: ??? (no palette-enabled encoder yet)
1104 * - decoding: Set by libavcodec. (default 0).
1106 int palette_has_changed;
1109 * codec suggestion on buffer type if != 0
1110 * - encoding: unused
1111 * - decoding: Set by libavcodec. (before get_buffer() call)).
1117 * - encoding: unused
1118 * - decoding: Set by libavcodec.
1123 * motion reference frame index
1124 * the order in which these are stored can depend on the codec.
1125 * - encoding: Set by user.
1126 * - decoding: Set by libavcodec.
1128 int8_t *ref_index[2];
1131 * reordered opaque 64bit (generally an integer or a double precision float
1132 * PTS but can be anything).
1133 * The user sets AVCodecContext.reordered_opaque to represent the input at
1135 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1136 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1137 * @deprecated in favor of pkt_pts
1138 * - encoding: unused
1139 * - decoding: Read by user.
1141 int64_t reordered_opaque;
1144 * hardware accelerator private data (FFmpeg-allocated)
1145 * - encoding: unused
1146 * - decoding: Set by libavcodec
1148 void *hwaccel_picture_private;
1151 * reordered pts from the last AVPacket that has been input into the decoder
1152 * - encoding: unused
1153 * - decoding: Read by user.
1158 * dts from the last AVPacket that has been input into the decoder
1159 * - encoding: unused
1160 * - decoding: Read by user.
1165 * the AVCodecContext which ff_thread_get_buffer() was last called on
1166 * - encoding: Set by libavcodec.
1167 * - decoding: Set by libavcodec.
1169 struct AVCodecContext *owner;
1172 * used by multithreading to store frame-specific info
1173 * - encoding: Set by libavcodec.
1174 * - decoding: Set by libavcodec.
1176 void *thread_opaque;
1179 * frame timestamp estimated using various heuristics, in stream time base
1180 * - encoding: unused
1181 * - decoding: set by libavcodec, read by user.
1183 int64_t best_effort_timestamp;
1186 * reordered pos from the last AVPacket that has been input into the decoder
1187 * - encoding: unused
1188 * - decoding: Read by user.
1193 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1194 * - encoding: unused
1195 * - decoding: Read by user.
1197 AVRational sample_aspect_ratio;
1200 * width and height of the video frame
1201 * - encoding: unused
1202 * - decoding: Read by user.
1207 * format of the frame, -1 if unknown or unset
1208 * It should be cast to the corresponding enum (enum PixelFormat
1209 * for video, enum AVSampleFormat for audio)
1210 * - encoding: unused
1211 * - decoding: Read by user.
1217 struct AVCodecInternal;
1220 * main external API structure.
1221 * New fields can be added to the end with minor version bumps.
1222 * Removal, reordering and changes to existing fields require a major
1224 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1226 * sizeof(AVCodecContext) must not be used outside libav*.
1228 typedef struct AVCodecContext {
1230 * information on struct for av_log
1231 * - set by avcodec_alloc_context
1233 const AVClass *av_class;
1235 * the average bitrate
1236 * - encoding: Set by user; unused for constant quantizer encoding.
1237 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1242 * number of bits the bitstream is allowed to diverge from the reference.
1243 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1244 * - encoding: Set by user; unused for constant quantizer encoding.
1245 * - decoding: unused
1247 int bit_rate_tolerance;
1251 * - encoding: Set by user.
1252 * - decoding: Set by user.
1257 * Some codecs need additional format info. It is stored here.
1258 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1259 * specific codec MUST set it correctly otherwise stream copy breaks.
1260 * In general use of this field by muxers is not recommanded.
1261 * - encoding: Set by libavcodec.
1262 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1267 * Motion estimation algorithm used for video coding.
1268 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1269 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1270 * - encoding: MUST be set by user.
1271 * - decoding: unused
1276 * some codecs need / can use extradata like Huffman tables.
1277 * mjpeg: Huffman tables
1278 * rv10: additional flags
1279 * mpeg4: global headers (they can be in the bitstream or here)
1280 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1281 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1282 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1283 * - encoding: Set/allocated/freed by libavcodec.
1284 * - decoding: Set/allocated/freed by user.
1290 * This is the fundamental unit of time (in seconds) in terms
1291 * of which frame timestamps are represented. For fixed-fps content,
1292 * timebase should be 1/framerate and timestamp increments should be
1294 * - encoding: MUST be set by user.
1295 * - decoding: Set by libavcodec.
1297 AVRational time_base;
1301 * picture width / height.
1302 * - encoding: MUST be set by user.
1303 * - decoding: Set by libavcodec.
1304 * Note: For compatibility it is possible to set this instead of
1305 * coded_width/height before decoding.
1309 #define FF_ASPECT_EXTENDED 15
1312 * the number of pictures in a group of pictures, or 0 for intra_only
1313 * - encoding: Set by user.
1314 * - decoding: unused
1319 * Pixel format, see PIX_FMT_xxx.
1320 * May be set by the demuxer if known from headers.
1321 * May be overriden by the decoder if it knows better.
1322 * - encoding: Set by user.
1323 * - decoding: Set by user if known, overridden by libavcodec if known
1325 enum PixelFormat pix_fmt;
1328 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1329 * decoder to draw a horizontal band. It improves cache usage. Not
1330 * all codecs can do that. You must check the codec capabilities
1332 * When multithreading is used, it may be called from multiple threads
1333 * at the same time; threads might draw different parts of the same AVFrame,
1334 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1336 * The function is also used by hardware acceleration APIs.
1337 * It is called at least once during frame decoding to pass
1338 * the data needed for hardware render.
1339 * In that mode instead of pixel data, AVFrame points to
1340 * a structure specific to the acceleration API. The application
1341 * reads the structure and can change some fields to indicate progress
1343 * - encoding: unused
1344 * - decoding: Set by user.
1345 * @param height the height of the slice
1346 * @param y the y position of the slice
1347 * @param type 1->top field, 2->bottom field, 3->frame
1348 * @param offset offset into the AVFrame.data from which the slice should be read
1350 void (*draw_horiz_band)(struct AVCodecContext *s,
1351 const AVFrame *src, int offset[4],
1352 int y, int type, int height);
1355 int sample_rate; ///< samples per second
1356 int channels; ///< number of audio channels
1359 * audio sample format
1360 * - encoding: Set by user.
1361 * - decoding: Set by libavcodec.
1363 enum AVSampleFormat sample_fmt; ///< sample format
1365 /* The following data should not be initialized. */
1367 * Samples per packet, initialized when calling 'init'.
1370 int frame_number; ///< audio or video frame number
1373 * Encoding: Number of frames delay there will be from the encoder input to
1374 * the decoder output. (we assume the decoder matches the spec)
1375 * Decoding: Number of frames delay in addition to what a standard decoder
1376 * as specified in the spec would produce.
1377 * - encoding: Set by libavcodec.
1378 * - decoding: Set by libavcodec.
1382 /* - encoding parameters */
1383 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1384 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1388 * - encoding: Set by user.
1389 * - decoding: unused
1395 * - encoding: Set by user.
1396 * - decoding: unused
1401 * maximum quantizer difference between frames
1402 * - encoding: Set by user.
1403 * - decoding: unused
1408 * maximum number of B-frames between non-B-frames
1409 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1410 * - encoding: Set by user.
1411 * - decoding: unused
1416 * qscale factor between IP and B-frames
1417 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1418 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1419 * - encoding: Set by user.
1420 * - decoding: unused
1422 float b_quant_factor;
1424 /** obsolete FIXME remove */
1426 #define FF_RC_STRATEGY_XVID 1
1428 int b_frame_strategy;
1430 struct AVCodec *codec;
1434 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1435 /* do its best to deliver a chunk with size */
1436 /* below rtp_payload_size, the chunk will start */
1437 /* with a start code on some codecs like H.263. */
1438 /* This doesn't take account of any particular */
1439 /* headers inside the transmitted RTP payload. */
1442 /* The RTP callback: This function is called */
1443 /* every time the encoder has a packet to send. */
1444 /* It depends on the encoder if the data starts */
1445 /* with a Start Code (it should). H.263 does. */
1446 /* mb_nb contains the number of macroblocks */
1447 /* encoded in the RTP payload. */
1448 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1450 /* statistics, used for 2-pass encoding */
1461 * number of bits used for the previously encoded frame
1462 * - encoding: Set by libavcodec.
1463 * - decoding: unused
1468 * Private data of the user, can be used to carry app specific stuff.
1469 * - encoding: Set by user.
1470 * - decoding: Set by user.
1474 char codec_name[32];
1475 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1476 enum CodecID codec_id; /* see CODEC_ID_xxx */
1479 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1480 * This is used to work around some encoder bugs.
1481 * A demuxer should set this to what is stored in the field used to identify the codec.
1482 * If there are multiple such fields in a container then the demuxer should choose the one
1483 * which maximizes the information about the used codec.
1484 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1485 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1486 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1488 * - encoding: Set by user, if not then the default based on codec_id will be used.
1489 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1491 unsigned int codec_tag;
1494 * Work around bugs in encoders which sometimes cannot be detected automatically.
1495 * - encoding: Set by user
1496 * - decoding: Set by user
1498 int workaround_bugs;
1499 #define FF_BUG_AUTODETECT 1 ///< autodetection
1500 #define FF_BUG_OLD_MSMPEG4 2
1501 #define FF_BUG_XVID_ILACE 4
1502 #define FF_BUG_UMP4 8
1503 #define FF_BUG_NO_PADDING 16
1504 #define FF_BUG_AMV 32
1505 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1506 #define FF_BUG_QPEL_CHROMA 64
1507 #define FF_BUG_STD_QPEL 128
1508 #define FF_BUG_QPEL_CHROMA2 256
1509 #define FF_BUG_DIRECT_BLOCKSIZE 512
1510 #define FF_BUG_EDGE 1024
1511 #define FF_BUG_HPEL_CHROMA 2048
1512 #define FF_BUG_DC_CLIP 4096
1513 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1514 #define FF_BUG_TRUNCATED 16384
1515 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1518 * luma single coefficient elimination threshold
1519 * - encoding: Set by user.
1520 * - decoding: unused
1522 int luma_elim_threshold;
1525 * chroma single coeff elimination threshold
1526 * - encoding: Set by user.
1527 * - decoding: unused
1529 int chroma_elim_threshold;
1532 * strictly follow the standard (MPEG4, ...).
1533 * - encoding: Set by user.
1534 * - decoding: Set by user.
1535 * Setting this to STRICT or higher means the encoder and decoder will
1536 * generally do stupid things, whereas setting it to unofficial or lower
1537 * will mean the encoder might produce output that is not supported by all
1538 * spec-compliant decoders. Decoders don't differentiate between normal,
1539 * unofficial and experimental (that is, they always try to decode things
1540 * when they can) unless they are explicitly asked to behave stupidly
1541 * (=strictly conform to the specs)
1543 int strict_std_compliance;
1544 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1545 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1546 #define FF_COMPLIANCE_NORMAL 0
1547 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1548 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1551 * qscale offset between IP and B-frames
1552 * - encoding: Set by user.
1553 * - decoding: unused
1555 float b_quant_offset;
1559 * Error recognition; higher values will detect more errors but may
1560 * misdetect some more or less valid parts as errors.
1561 * - encoding: unused
1562 * - decoding: Set by user.
1564 attribute_deprecated int error_recognition;
1565 #define FF_ER_CAREFUL 1
1566 #define FF_ER_COMPLIANT 2
1567 #define FF_ER_AGGRESSIVE 3
1568 #define FF_ER_VERY_AGGRESSIVE 4
1569 #define FF_ER_EXPLODE 5
1570 #endif /* FF_API_ER */
1573 * Called at the beginning of each frame to get a buffer for it.
1574 * If pic.reference is set then the frame will be read later by libavcodec.
1575 * avcodec_align_dimensions2() should be used to find the required width and
1576 * height, as they normally need to be rounded up to the next multiple of 16.
1577 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1578 * avcodec_default_get_buffer() instead of providing buffers allocated by
1580 * If frame multithreading is used and thread_safe_callbacks is set,
1581 * it may be called from a different thread, but not from more than one at once.
1582 * Does not need to be reentrant.
1583 * - encoding: unused
1584 * - decoding: Set by libavcodec, user can override.
1586 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1589 * Called to release buffers which were allocated with get_buffer.
1590 * A released buffer can be reused in get_buffer().
1591 * pic.data[*] must be set to NULL.
1592 * May be called from a different thread if frame multithreading is used,
1593 * but not by more than one thread at once, so does not need to be reentrant.
1594 * - encoding: unused
1595 * - decoding: Set by libavcodec, user can override.
1597 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1600 * Size of the frame reordering buffer in the decoder.
1601 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1602 * - encoding: Set by libavcodec.
1603 * - decoding: Set by libavcodec.
1608 * number of bytes per packet if constant and known or 0
1609 * Used by some WAV based audio codecs.
1613 #if FF_API_PARSE_FRAME
1615 * If true, only parsing is done. The frame data is returned.
1616 * Only MPEG audio decoders support this now.
1617 * - encoding: unused
1618 * - decoding: Set by user
1620 attribute_deprecated int parse_only;
1624 * 0-> h263 quant 1-> mpeg quant
1625 * - encoding: Set by user.
1626 * - decoding: unused
1631 * pass1 encoding statistics output buffer
1632 * - encoding: Set by libavcodec.
1633 * - decoding: unused
1638 * pass2 encoding statistics input buffer
1639 * Concatenated stuff from stats_out of pass1 should be placed here.
1640 * - encoding: Allocated/set/freed by user.
1641 * - decoding: unused
1646 * ratecontrol qmin qmax limiting method
1647 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1648 * - encoding: Set by user.
1649 * - decoding: unused
1657 * ratecontrol override, see RcOverride
1658 * - encoding: Allocated/set/freed by user.
1659 * - decoding: unused
1661 RcOverride *rc_override;
1662 int rc_override_count;
1665 * rate control equation
1666 * - encoding: Set by user
1667 * - decoding: unused
1673 * - encoding: Set by user.
1674 * - decoding: unused
1680 * - encoding: Set by user.
1681 * - decoding: unused
1686 * decoder bitstream buffer size
1687 * - encoding: Set by user.
1688 * - decoding: unused
1691 float rc_buffer_aggressivity;
1694 * qscale factor between P and I-frames
1695 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1696 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1697 * - encoding: Set by user.
1698 * - decoding: unused
1700 float i_quant_factor;
1703 * qscale offset between P and I-frames
1704 * - encoding: Set by user.
1705 * - decoding: unused
1707 float i_quant_offset;
1710 * initial complexity for pass1 ratecontrol
1711 * - encoding: Set by user.
1712 * - decoding: unused
1714 float rc_initial_cplx;
1717 * DCT algorithm, see FF_DCT_* below
1718 * - encoding: Set by user.
1719 * - decoding: unused
1722 #define FF_DCT_AUTO 0
1723 #define FF_DCT_FASTINT 1
1724 #define FF_DCT_INT 2
1725 #define FF_DCT_MMX 3
1726 #define FF_DCT_MLIB 4
1727 #define FF_DCT_ALTIVEC 5
1728 #define FF_DCT_FAAN 6
1731 * luminance masking (0-> disabled)
1732 * - encoding: Set by user.
1733 * - decoding: unused
1738 * temporary complexity masking (0-> disabled)
1739 * - encoding: Set by user.
1740 * - decoding: unused
1742 float temporal_cplx_masking;
1745 * spatial complexity masking (0-> disabled)
1746 * - encoding: Set by user.
1747 * - decoding: unused
1749 float spatial_cplx_masking;
1752 * p block masking (0-> disabled)
1753 * - encoding: Set by user.
1754 * - decoding: unused
1759 * darkness masking (0-> disabled)
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * IDCT algorithm, see FF_IDCT_* below.
1767 * - encoding: Set by user.
1768 * - decoding: Set by user.
1771 #define FF_IDCT_AUTO 0
1772 #define FF_IDCT_INT 1
1773 #define FF_IDCT_SIMPLE 2
1774 #define FF_IDCT_SIMPLEMMX 3
1775 #define FF_IDCT_LIBMPEG2MMX 4
1776 #define FF_IDCT_PS2 5
1777 #define FF_IDCT_MLIB 6
1778 #define FF_IDCT_ARM 7
1779 #define FF_IDCT_ALTIVEC 8
1780 #define FF_IDCT_SH4 9
1781 #define FF_IDCT_SIMPLEARM 10
1782 #define FF_IDCT_H264 11
1783 #define FF_IDCT_VP3 12
1784 #define FF_IDCT_IPP 13
1785 #define FF_IDCT_XVIDMMX 14
1786 #define FF_IDCT_CAVS 15
1787 #define FF_IDCT_SIMPLEARMV5TE 16
1788 #define FF_IDCT_SIMPLEARMV6 17
1789 #define FF_IDCT_SIMPLEVIS 18
1790 #define FF_IDCT_WMV2 19
1791 #define FF_IDCT_FAAN 20
1792 #define FF_IDCT_EA 21
1793 #define FF_IDCT_SIMPLENEON 22
1794 #define FF_IDCT_SIMPLEALPHA 23
1795 #define FF_IDCT_BINK 24
1799 * - encoding: Set by libavcodec.
1800 * - decoding: Set by user (or 0).
1804 * slice offsets in the frame in bytes
1805 * - encoding: Set/allocated by libavcodec.
1806 * - decoding: Set/allocated by user (or NULL).
1811 * error concealment flags
1812 * - encoding: unused
1813 * - decoding: Set by user.
1815 int error_concealment;
1816 #define FF_EC_GUESS_MVS 1
1817 #define FF_EC_DEBLOCK 2
1820 * dsp_mask could be add used to disable unwanted CPU features
1821 * CPU features (i.e. MMX, SSE. ...)
1823 * With the FORCE flag you may instead enable given CPU features.
1824 * (Dangerous: Usable in case of misdetection, improper usage however will
1825 * result into program crash.)
1830 * bits per sample/pixel from the demuxer (needed for huffyuv).
1831 * - encoding: Set by libavcodec.
1832 * - decoding: Set by user.
1834 int bits_per_coded_sample;
1837 * prediction method (needed for huffyuv)
1838 * - encoding: Set by user.
1839 * - decoding: unused
1841 int prediction_method;
1842 #define FF_PRED_LEFT 0
1843 #define FF_PRED_PLANE 1
1844 #define FF_PRED_MEDIAN 2
1847 * sample aspect ratio (0 if unknown)
1848 * That is the width of a pixel divided by the height of the pixel.
1849 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1850 * - encoding: Set by user.
1851 * - decoding: Set by libavcodec.
1853 AVRational sample_aspect_ratio;
1856 * the picture in the bitstream
1857 * - encoding: Set by libavcodec.
1858 * - decoding: Set by libavcodec.
1860 AVFrame *coded_frame;
1864 * - encoding: Set by user.
1865 * - decoding: Set by user.
1868 #define FF_DEBUG_PICT_INFO 1
1869 #define FF_DEBUG_RC 2
1870 #define FF_DEBUG_BITSTREAM 4
1871 #define FF_DEBUG_MB_TYPE 8
1872 #define FF_DEBUG_QP 16
1873 #define FF_DEBUG_MV 32
1874 #define FF_DEBUG_DCT_COEFF 0x00000040
1875 #define FF_DEBUG_SKIP 0x00000080
1876 #define FF_DEBUG_STARTCODE 0x00000100
1877 #define FF_DEBUG_PTS 0x00000200
1878 #define FF_DEBUG_ER 0x00000400
1879 #define FF_DEBUG_MMCO 0x00000800
1880 #define FF_DEBUG_BUGS 0x00001000
1881 #define FF_DEBUG_VIS_QP 0x00002000
1882 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1883 #define FF_DEBUG_BUFFERS 0x00008000
1884 #define FF_DEBUG_THREADS 0x00010000
1888 * - encoding: Set by user.
1889 * - decoding: Set by user.
1892 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1893 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1894 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1898 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1899 * - decoding: unused
1904 * motion estimation comparison function
1905 * - encoding: Set by user.
1906 * - decoding: unused
1910 * subpixel motion estimation comparison function
1911 * - encoding: Set by user.
1912 * - decoding: unused
1916 * macroblock comparison function (not supported yet)
1917 * - encoding: Set by user.
1918 * - decoding: unused
1922 * interlaced DCT comparison function
1923 * - encoding: Set by user.
1924 * - decoding: unused
1927 #define FF_CMP_SAD 0
1928 #define FF_CMP_SSE 1
1929 #define FF_CMP_SATD 2
1930 #define FF_CMP_DCT 3
1931 #define FF_CMP_PSNR 4
1932 #define FF_CMP_BIT 5
1934 #define FF_CMP_ZERO 7
1935 #define FF_CMP_VSAD 8
1936 #define FF_CMP_VSSE 9
1937 #define FF_CMP_NSSE 10
1938 #define FF_CMP_W53 11
1939 #define FF_CMP_W97 12
1940 #define FF_CMP_DCTMAX 13
1941 #define FF_CMP_DCT264 14
1942 #define FF_CMP_CHROMA 256
1945 * ME diamond size & shape
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * amount of previous MV predictors (2a+1 x 2a+1 square)
1953 * - encoding: Set by user.
1954 * - decoding: unused
1956 int last_predictor_count;
1959 * prepass for motion estimation
1960 * - encoding: Set by user.
1961 * - decoding: unused
1966 * motion estimation prepass comparison function
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * ME prepass diamond size & shape
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int me_subpel_quality;
1987 * callback to negotiate the pixelFormat
1988 * @param fmt is the list of formats which are supported by the codec,
1989 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1990 * The first is always the native one.
1991 * @return the chosen format
1992 * - encoding: unused
1993 * - decoding: Set by user, if not set the native format will be chosen.
1995 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1998 * DTG active format information (additional aspect ratio
1999 * information only used in DVB MPEG-2 transport streams)
2002 * - encoding: unused
2003 * - decoding: Set by decoder.
2005 int dtg_active_format;
2006 #define FF_DTG_AFD_SAME 8
2007 #define FF_DTG_AFD_4_3 9
2008 #define FF_DTG_AFD_16_9 10
2009 #define FF_DTG_AFD_14_9 11
2010 #define FF_DTG_AFD_4_3_SP_14_9 13
2011 #define FF_DTG_AFD_16_9_SP_14_9 14
2012 #define FF_DTG_AFD_SP_4_3 15
2015 * maximum motion estimation search range in subpel units
2016 * If 0 then no limit.
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * intra quantizer bias
2025 * - encoding: Set by user.
2026 * - decoding: unused
2028 int intra_quant_bias;
2029 #define FF_DEFAULT_QUANT_BIAS 999999
2032 * inter quantizer bias
2033 * - encoding: Set by user.
2034 * - decoding: unused
2036 int inter_quant_bias;
2040 * - encoding: unused
2041 * - decoding: Which clrtable should be used for 8bit RGB images.
2042 * Tables have to be stored somewhere. FIXME
2046 #if FF_API_INTERNAL_CONTEXT
2048 * internal_buffer count
2049 * Don't touch, used by libavcodec default_get_buffer().
2050 * @deprecated this field was moved to an internal context
2052 attribute_deprecated int internal_buffer_count;
2056 * Don't touch, used by libavcodec default_get_buffer().
2057 * @deprecated this field was moved to an internal context
2059 attribute_deprecated void *internal_buffer;
2063 * Global quality for codecs which cannot change it per frame.
2064 * This should be proportional to MPEG-1/2/4 qscale.
2065 * - encoding: Set by user.
2066 * - decoding: unused
2070 #define FF_CODER_TYPE_VLC 0
2071 #define FF_CODER_TYPE_AC 1
2072 #define FF_CODER_TYPE_RAW 2
2073 #define FF_CODER_TYPE_RLE 3
2074 #define FF_CODER_TYPE_DEFLATE 4
2077 * - encoding: Set by user.
2078 * - decoding: unused
2084 * - encoding: Set by user.
2085 * - decoding: unused
2091 * - encoding: unused
2092 * - decoding: Set by user.
2094 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2099 * - encoding: unused
2100 * - decoding: Set by user.
2103 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2104 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2105 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2108 * XVideo Motion Acceleration
2109 * - encoding: forbidden
2110 * - decoding: set by decoder
2112 int xvmc_acceleration;
2115 * macroblock decision mode
2116 * - encoding: Set by user.
2117 * - decoding: unused
2120 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2121 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2122 #define FF_MB_DECISION_RD 2 ///< rate distortion
2125 * custom intra quantization matrix
2126 * - encoding: Set by user, can be NULL.
2127 * - decoding: Set by libavcodec.
2129 uint16_t *intra_matrix;
2132 * custom inter quantization matrix
2133 * - encoding: Set by user, can be NULL.
2134 * - decoding: Set by libavcodec.
2136 uint16_t *inter_matrix;
2139 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2140 * This is used to work around some encoder bugs.
2141 * - encoding: unused
2142 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2144 unsigned int stream_codec_tag;
2147 * scene change detection threshold
2148 * 0 is default, larger means fewer detected scene changes.
2149 * - encoding: Set by user.
2150 * - decoding: unused
2152 int scenechange_threshold;
2155 * minimum Lagrange multipler
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * maximum Lagrange multipler
2163 * - encoding: Set by user.
2164 * - decoding: unused
2168 #if FF_API_PALETTE_CONTROL
2170 * palette control structure
2171 * - encoding: ??? (no palette-enabled encoder yet)
2172 * - decoding: Set by user.
2174 struct AVPaletteControl *palctrl;
2178 * noise reduction strength
2179 * - encoding: Set by user.
2180 * - decoding: unused
2182 int noise_reduction;
2185 * Called at the beginning of a frame to get cr buffer for it.
2186 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2187 * libavcodec will pass previous buffer in pic, function should return
2188 * same buffer or new buffer with old frame "painted" into it.
2189 * If pic.data[0] == NULL must behave like get_buffer().
2190 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2191 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2193 * - encoding: unused
2194 * - decoding: Set by libavcodec, user can override.
2196 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2199 * Number of bits which should be loaded into the rc buffer before decoding starts.
2200 * - encoding: Set by user.
2201 * - decoding: unused
2203 int rc_initial_buffer_occupancy;
2207 * - encoding: Set by user.
2208 * - decoding: unused
2210 int inter_threshold;
2214 * - encoding: Set by user.
2215 * - decoding: Set by user.
2220 * Simulates errors in the bitstream to test error concealment.
2221 * - encoding: Set by user.
2222 * - decoding: unused
2226 #if FF_API_ANTIALIAS_ALGO
2228 * MP3 antialias algorithm, see FF_AA_* below.
2229 * - encoding: unused
2230 * - decoding: Set by user.
2232 attribute_deprecated int antialias_algo;
2233 #define FF_AA_AUTO 0
2234 #define FF_AA_FASTINT 1 //not implemented yet
2236 #define FF_AA_FLOAT 3
2240 * quantizer noise shaping
2241 * - encoding: Set by user.
2242 * - decoding: unused
2244 int quantizer_noise_shaping;
2248 * is used to decide how many independent tasks should be passed to execute()
2249 * - encoding: Set by user.
2250 * - decoding: Set by user.
2255 * The codec may call this to execute several independent things.
2256 * It will return only after finishing all tasks.
2257 * The user may replace this with some multithreaded implementation,
2258 * the default implementation will execute the parts serially.
2259 * @param count the number of things to execute
2260 * - encoding: Set by libavcodec, user can override.
2261 * - decoding: Set by libavcodec, user can override.
2263 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2267 * Can be used by execute() to store some per AVCodecContext stuff.
2268 * - encoding: set by execute()
2269 * - decoding: set by execute()
2271 void *thread_opaque;
2274 * Motion estimation threshold below which no motion estimation is
2275 * performed, but instead the user specified motion vectors are used.
2277 * - encoding: Set by user.
2278 * - decoding: unused
2283 * Macroblock threshold below which the user specified macroblock types will be used.
2284 * - encoding: Set by user.
2285 * - decoding: unused
2290 * precision of the intra DC coefficient - 8
2291 * - encoding: Set by user.
2292 * - decoding: unused
2294 int intra_dc_precision;
2297 * noise vs. sse weight for the nsse comparsion function
2298 * - encoding: Set by user.
2299 * - decoding: unused
2304 * Number of macroblock rows at the top which are skipped.
2305 * - encoding: unused
2306 * - decoding: Set by user.
2311 * Number of macroblock rows at the bottom which are skipped.
2312 * - encoding: unused
2313 * - decoding: Set by user.
2319 * - encoding: Set by user.
2320 * - decoding: Set by libavcodec.
2323 #define FF_PROFILE_UNKNOWN -99
2324 #define FF_PROFILE_RESERVED -100
2326 #define FF_PROFILE_AAC_MAIN 0
2327 #define FF_PROFILE_AAC_LOW 1
2328 #define FF_PROFILE_AAC_SSR 2
2329 #define FF_PROFILE_AAC_LTP 3
2331 #define FF_PROFILE_DTS 20
2332 #define FF_PROFILE_DTS_ES 30
2333 #define FF_PROFILE_DTS_96_24 40
2334 #define FF_PROFILE_DTS_HD_HRA 50
2335 #define FF_PROFILE_DTS_HD_MA 60
2337 #define FF_PROFILE_MPEG2_422 0
2338 #define FF_PROFILE_MPEG2_HIGH 1
2339 #define FF_PROFILE_MPEG2_SS 2
2340 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2341 #define FF_PROFILE_MPEG2_MAIN 4
2342 #define FF_PROFILE_MPEG2_SIMPLE 5
2344 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2345 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2347 #define FF_PROFILE_H264_BASELINE 66
2348 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2349 #define FF_PROFILE_H264_MAIN 77
2350 #define FF_PROFILE_H264_EXTENDED 88
2351 #define FF_PROFILE_H264_HIGH 100
2352 #define FF_PROFILE_H264_HIGH_10 110
2353 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2354 #define FF_PROFILE_H264_HIGH_422 122
2355 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2356 #define FF_PROFILE_H264_HIGH_444 144
2357 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2358 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2359 #define FF_PROFILE_H264_CAVLC_444 44
2361 #define FF_PROFILE_VC1_SIMPLE 0
2362 #define FF_PROFILE_VC1_MAIN 1
2363 #define FF_PROFILE_VC1_COMPLEX 2
2364 #define FF_PROFILE_VC1_ADVANCED 3
2366 #define FF_PROFILE_MPEG4_SIMPLE 0
2367 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2368 #define FF_PROFILE_MPEG4_CORE 2
2369 #define FF_PROFILE_MPEG4_MAIN 3
2370 #define FF_PROFILE_MPEG4_N_BIT 4
2371 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2372 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2373 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2374 #define FF_PROFILE_MPEG4_HYBRID 8
2375 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2376 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2377 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2378 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2379 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2380 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2381 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2385 * - encoding: Set by user.
2386 * - decoding: Set by libavcodec.
2389 #define FF_LEVEL_UNKNOWN -99
2392 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2393 * - encoding: unused
2394 * - decoding: Set by user.
2399 * Bitstream width / height, may be different from width/height if lowres enabled.
2400 * - encoding: unused
2401 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2403 int coded_width, coded_height;
2406 * frame skip threshold
2407 * - encoding: Set by user.
2408 * - decoding: unused
2410 int frame_skip_threshold;
2414 * - encoding: Set by user.
2415 * - decoding: unused
2417 int frame_skip_factor;
2420 * frame skip exponent
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * frame skip comparison function
2428 * - encoding: Set by user.
2429 * - decoding: unused
2434 * Border processing masking, raises the quantizer for mbs on the borders
2436 * - encoding: Set by user.
2437 * - decoding: unused
2439 float border_masking;
2442 * minimum MB lagrange multipler
2443 * - encoding: Set by user.
2444 * - decoding: unused
2449 * maximum MB lagrange multipler
2450 * - encoding: Set by user.
2451 * - decoding: unused
2457 * - encoding: Set by user.
2458 * - decoding: unused
2460 int me_penalty_compensation;
2464 * - encoding: unused
2465 * - decoding: Set by user.
2467 enum AVDiscard skip_loop_filter;
2471 * - encoding: unused
2472 * - decoding: Set by user.
2474 enum AVDiscard skip_idct;
2478 * - encoding: unused
2479 * - decoding: Set by user.
2481 enum AVDiscard skip_frame;
2485 * - encoding: Set by user.
2486 * - decoding: unused
2492 * - encoding: Set by user.
2493 * - decoding: unused
2497 #if FF_API_X264_GLOBAL_OPTS
2499 * constant rate factor - quality-based VBR - values ~correspond to qps
2500 * - encoding: Set by user.
2501 * - decoding: unused
2502 * @deprecated use 'crf' libx264 private option
2504 attribute_deprecated float crf;
2507 * constant quantization parameter rate control method
2508 * - encoding: Set by user.
2509 * - decoding: unused
2510 * @deprecated use 'cqp' libx264 private option
2512 attribute_deprecated int cqp;
2517 * - encoding: Set by user.
2518 * - decoding: unused
2523 * number of reference frames
2524 * - encoding: Set by user.
2525 * - decoding: Set by lavc.
2530 * chroma qp offset from luma
2531 * - encoding: Set by user.
2532 * - decoding: unused
2536 #if FF_API_X264_GLOBAL_OPTS
2538 * Influences how often B-frames are used.
2539 * - encoding: Set by user.
2540 * - decoding: unused
2542 attribute_deprecated int bframebias;
2546 * trellis RD quantization
2547 * - encoding: Set by user.
2548 * - decoding: unused
2552 #if FF_API_X264_GLOBAL_OPTS
2554 * Reduce fluctuations in qp (before curve compression).
2555 * - encoding: Set by user.
2556 * - decoding: unused
2558 attribute_deprecated float complexityblur;
2561 * in-loop deblocking filter alphac0 parameter
2562 * alpha is in the range -6...6
2563 * - encoding: Set by user.
2564 * - decoding: unused
2566 attribute_deprecated int deblockalpha;
2569 * in-loop deblocking filter beta parameter
2570 * beta is in the range -6...6
2571 * - encoding: Set by user.
2572 * - decoding: unused
2574 attribute_deprecated int deblockbeta;
2577 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2578 * - encoding: Set by user.
2579 * - decoding: unused
2581 attribute_deprecated int partitions;
2582 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2583 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2584 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2585 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2586 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2589 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2590 * - encoding: Set by user.
2591 * - decoding: unused
2593 attribute_deprecated int directpred;
2597 * Audio cutoff bandwidth (0 means "automatic")
2598 * - encoding: Set by user.
2599 * - decoding: unused
2604 * Multiplied by qscale for each frame and added to scene_change_score.
2605 * - encoding: Set by user.
2606 * - decoding: unused
2608 int scenechange_factor;
2612 * Note: Value depends upon the compare function used for fullpel ME.
2613 * - encoding: Set by user.
2614 * - decoding: unused
2619 * Adjusts sensitivity of b_frame_strategy 1.
2620 * - encoding: Set by user.
2621 * - decoding: unused
2626 * - encoding: Set by user.
2627 * - decoding: unused
2629 int compression_level;
2630 #define FF_COMPRESSION_DEFAULT -1
2633 * - encoding: Set by user.
2634 * - decoding: unused
2636 int min_prediction_order;
2639 * - encoding: Set by user.
2640 * - decoding: unused
2642 int max_prediction_order;
2644 #if FF_API_FLAC_GLOBAL_OPTS
2646 * @name FLAC options
2647 * @deprecated Use FLAC encoder private options instead.
2652 * LPC coefficient precision - used by FLAC encoder
2653 * - encoding: Set by user.
2654 * - decoding: unused
2656 attribute_deprecated int lpc_coeff_precision;
2659 * search method for selecting prediction order
2660 * - encoding: Set by user.
2661 * - decoding: unused
2663 attribute_deprecated int prediction_order_method;
2666 * - encoding: Set by user.
2667 * - decoding: unused
2669 attribute_deprecated int min_partition_order;
2672 * - encoding: Set by user.
2673 * - decoding: unused
2675 attribute_deprecated int max_partition_order;
2682 * GOP timecode frame start number, in non drop frame format
2683 * - encoding: Set by user.
2684 * - decoding: unused
2686 int64_t timecode_frame_start;
2688 #if FF_API_REQUEST_CHANNELS
2690 * Decoder should decode to this many channels if it can (0 for default)
2691 * - encoding: unused
2692 * - decoding: Set by user.
2693 * @deprecated Deprecated in favor of request_channel_layout.
2695 int request_channels;
2698 #if FF_API_DRC_SCALE
2700 * Percentage of dynamic range compression to be applied by the decoder.
2701 * The default value is 1.0, corresponding to full compression.
2702 * - encoding: unused
2703 * - decoding: Set by user.
2704 * @deprecated use AC3 decoder private option instead.
2706 attribute_deprecated float drc_scale;
2710 * opaque 64bit number (generally a PTS) that will be reordered and
2711 * output in AVFrame.reordered_opaque
2712 * @deprecated in favor of pkt_pts
2713 * - encoding: unused
2714 * - decoding: Set by user.
2716 int64_t reordered_opaque;
2719 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2720 * - encoding: set by user.
2721 * - decoding: set by libavcodec.
2723 int bits_per_raw_sample;
2726 * Audio channel layout.
2727 * - encoding: set by user.
2728 * - decoding: set by user, may be overwritten by libavcodec.
2730 int64_t channel_layout;
2733 * Request decoder to use this channel layout if it can (0 for default)
2734 * - encoding: unused
2735 * - decoding: Set by user.
2737 int64_t request_channel_layout;
2740 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2741 * - encoding: Set by user.
2742 * - decoding: unused.
2744 float rc_max_available_vbv_use;
2747 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2748 * - encoding: Set by user.
2749 * - decoding: unused.
2751 float rc_min_vbv_overflow_use;
2754 * Hardware accelerator in use
2755 * - encoding: unused.
2756 * - decoding: Set by libavcodec
2758 struct AVHWAccel *hwaccel;
2761 * For some codecs, the time base is closer to the field rate than the frame rate.
2762 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2763 * if no telecine is used ...
2765 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2767 int ticks_per_frame;
2770 * Hardware accelerator context.
2771 * For some hardware accelerators, a global context needs to be
2772 * provided by the user. In that case, this holds display-dependent
2773 * data FFmpeg cannot instantiate itself. Please refer to the
2774 * FFmpeg HW accelerator documentation to know how to fill this
2775 * is. e.g. for VA API, this is a struct vaapi_context.
2776 * - encoding: unused
2777 * - decoding: Set by user
2779 void *hwaccel_context;
2782 * Chromaticity coordinates of the source primaries.
2783 * - encoding: Set by user
2784 * - decoding: Set by libavcodec
2786 enum AVColorPrimaries color_primaries;
2789 * Color Transfer Characteristic.
2790 * - encoding: Set by user
2791 * - decoding: Set by libavcodec
2793 enum AVColorTransferCharacteristic color_trc;
2796 * YUV colorspace type.
2797 * - encoding: Set by user
2798 * - decoding: Set by libavcodec
2800 enum AVColorSpace colorspace;
2803 * MPEG vs JPEG YUV range.
2804 * - encoding: Set by user
2805 * - decoding: Set by libavcodec
2807 enum AVColorRange color_range;
2810 * This defines the location of chroma samples.
2811 * - encoding: Set by user
2812 * - decoding: Set by libavcodec
2814 enum AVChromaLocation chroma_sample_location;
2817 * The codec may call this to execute several independent things.
2818 * It will return only after finishing all tasks.
2819 * The user may replace this with some multithreaded implementation,
2820 * the default implementation will execute the parts serially.
2821 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2822 * @param c context passed also to func
2823 * @param count the number of things to execute
2824 * @param arg2 argument passed unchanged to func
2825 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2826 * @param func function that will be called count times, with jobnr from 0 to count-1.
2827 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2828 * two instances of func executing at the same time will have the same threadnr.
2829 * @return always 0 currently, but code should handle a future improvement where when any call to func
2830 * returns < 0 no further calls to func may be done and < 0 is returned.
2831 * - encoding: Set by libavcodec, user can override.
2832 * - decoding: Set by libavcodec, user can override.
2834 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2836 #if FF_API_X264_GLOBAL_OPTS
2838 * explicit P-frame weighted prediction analysis method
2840 * 1: fast blind weighting (one reference duplicate with -1 offset)
2841 * 2: smart weighting (full fade detection analysis)
2842 * - encoding: Set by user.
2843 * - decoding: unused
2845 attribute_deprecated int weighted_p_pred;
2850 * 1: Variance AQ (complexity mask)
2851 * 2: Auto-variance AQ (experimental)
2852 * - encoding: Set by user
2853 * - decoding: unused
2855 attribute_deprecated int aq_mode;
2859 * Reduces blocking and blurring in flat and textured areas.
2860 * - encoding: Set by user
2861 * - decoding: unused
2863 attribute_deprecated float aq_strength;
2867 * Strength of psychovisual optimization
2868 * - encoding: Set by user
2869 * - decoding: unused
2871 attribute_deprecated float psy_rd;
2875 * Strength of psychovisual optimization
2876 * - encoding: Set by user
2877 * - decoding: unused
2879 attribute_deprecated float psy_trellis;
2883 * Number of frames for frametype and ratecontrol lookahead
2884 * - encoding: Set by user
2885 * - decoding: unused
2887 attribute_deprecated int rc_lookahead;
2890 * Constant rate factor maximum
2891 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2892 * than crf_max, even if doing so would violate VBV restrictions.
2893 * - encoding: Set by user.
2894 * - decoding: unused
2896 attribute_deprecated float crf_max;
2899 int log_level_offset;
2901 #if FF_API_FLAC_GLOBAL_OPTS
2903 * Determines which LPC analysis algorithm to use.
2904 * - encoding: Set by user
2905 * - decoding: unused
2907 attribute_deprecated enum AVLPCType lpc_type;
2910 * Number of passes to use for Cholesky factorization during LPC analysis
2911 * - encoding: Set by user
2912 * - decoding: unused
2914 attribute_deprecated int lpc_passes;
2919 * Indicates number of picture subdivisions. Used for parallelized
2921 * - encoding: Set by user
2922 * - decoding: unused
2927 * Header containing style information for text subtitles.
2928 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2929 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2930 * the Format line following. It shouldn't include any Dialogue line.
2931 * - encoding: Set/allocated/freed by user (before avcodec_open())
2932 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2934 uint8_t *subtitle_header;
2935 int subtitle_header_size;
2938 * Current packet as passed into the decoder, to avoid having
2939 * to pass the packet into every function. Currently only valid
2940 * inside lavc and get/release_buffer callbacks.
2941 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2942 * - encoding: unused
2946 #if FF_API_INTERNAL_CONTEXT
2948 * Whether this is a copy of the context which had init() called on it.
2949 * This is used by multithreading - shared tables and picture pointers
2950 * should be freed from the original context only.
2951 * - encoding: Set by libavcodec.
2952 * - decoding: Set by libavcodec.
2954 * @deprecated this field has been moved to an internal context
2956 attribute_deprecated int is_copy;
2960 * Which multithreading methods to use.
2961 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2962 * so clients which cannot provide future frames should not use it.
2964 * - encoding: Set by user, otherwise the default is used.
2965 * - decoding: Set by user, otherwise the default is used.
2968 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2969 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2972 * Which multithreading methods are in use by the codec.
2973 * - encoding: Set by libavcodec.
2974 * - decoding: Set by libavcodec.
2976 int active_thread_type;
2979 * Set by the client if its custom get_buffer() callback can be called
2980 * from another thread, which allows faster multithreaded decoding.
2981 * draw_horiz_band() will be called from other threads regardless of this setting.
2982 * Ignored if the default get_buffer() is used.
2983 * - encoding: Set by user.
2984 * - decoding: Set by user.
2986 int thread_safe_callbacks;
2989 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2990 * Used for compliant TS muxing.
2991 * - encoding: Set by libavcodec.
2992 * - decoding: unused.
2997 * Type of service that the audio stream conveys.
2998 * - encoding: Set by user.
2999 * - decoding: Set by libavcodec.
3001 enum AVAudioServiceType audio_service_type;
3004 * desired sample format
3005 * - encoding: Not used.
3006 * - decoding: Set by user.
3007 * Decoder will decode to this format if it can.
3009 enum AVSampleFormat request_sample_fmt;
3012 * Error recognition; may misdetect some more or less valid parts as errors.
3013 * - encoding: unused
3014 * - decoding: Set by user.
3016 int err_recognition;
3017 #define AV_EF_CRCCHECK (1<<0)
3018 #define AV_EF_BITSTREAM (1<<1)
3019 #define AV_EF_BUFFER (1<<2)
3020 #define AV_EF_EXPLODE (1<<3)
3022 #define AV_EF_CAREFUL (1<<16)
3023 #define AV_EF_COMPLIANT (1<<17)
3024 #define AV_EF_AGGRESSIVE (1<<18)
3027 * Private context used for internal data.
3029 * Unlike priv_data, this is not codec-specific. It is used in general
3030 * libavcodec functions.
3032 struct AVCodecInternal *internal;
3035 * Current statistics for PTS correction.
3036 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3037 * - encoding: unused
3039 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3040 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3041 int64_t pts_correction_last_pts; /// PTS of the last frame
3042 int64_t pts_correction_last_dts; /// DTS of the last frame
3049 typedef struct AVProfile {
3051 const char *name; ///< short name for the profile
3054 typedef struct AVCodecDefault AVCodecDefault;
3059 typedef struct AVCodec {
3061 * Name of the codec implementation.
3062 * The name is globally unique among encoders and among decoders (but an
3063 * encoder and a decoder can share the same name).
3064 * This is the primary way to find a codec from the user perspective.
3067 enum AVMediaType type;
3070 int (*init)(AVCodecContext *);
3071 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3072 int (*close)(AVCodecContext *);
3073 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3075 * Codec capabilities.
3079 struct AVCodec *next;
3082 * Will be called when seeking
3084 void (*flush)(AVCodecContext *);
3085 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3086 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3088 * Descriptive name for the codec, meant to be more human readable than name.
3089 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3091 const char *long_name;
3092 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3093 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3094 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3095 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3096 const AVClass *priv_class; ///< AVClass for the private context
3097 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3100 * @name Frame-level threading support functions
3104 * If defined, called on thread contexts when they are created.
3105 * If the codec allocates writable tables in init(), re-allocate them here.
3106 * priv_data will be set to a copy of the original.
3108 int (*init_thread_copy)(AVCodecContext *);
3110 * Copy necessary context variables from a previous thread context to the current one.
3111 * If not defined, the next thread will start automatically; otherwise, the codec
3112 * must call ff_thread_finish_setup().
3114 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3116 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3120 * Private codec-specific defaults.
3122 const AVCodecDefault *defaults;
3125 * Initialize codec static data, called from avcodec_register().
3127 void (*init_static_data)(struct AVCodec *codec);
3133 typedef struct AVHWAccel {
3135 * Name of the hardware accelerated codec.
3136 * The name is globally unique among encoders and among decoders (but an
3137 * encoder and a decoder can share the same name).
3142 * Type of codec implemented by the hardware accelerator.
3144 * See AVMEDIA_TYPE_xxx
3146 enum AVMediaType type;
3149 * Codec implemented by the hardware accelerator.
3156 * Supported pixel format.
3158 * Only hardware accelerated formats are supported here.
3160 enum PixelFormat pix_fmt;
3163 * Hardware accelerated codec capabilities.
3164 * see FF_HWACCEL_CODEC_CAP_*
3168 struct AVHWAccel *next;
3171 * Called at the beginning of each frame or field picture.
3173 * Meaningful frame information (codec specific) is guaranteed to
3174 * be parsed at this point. This function is mandatory.
3176 * Note that buf can be NULL along with buf_size set to 0.
3177 * Otherwise, this means the whole frame is available at this point.
3179 * @param avctx the codec context
3180 * @param buf the frame data buffer base
3181 * @param buf_size the size of the frame in bytes
3182 * @return zero if successful, a negative value otherwise
3184 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3187 * Callback for each slice.
3189 * Meaningful slice information (codec specific) is guaranteed to
3190 * be parsed at this point. This function is mandatory.
3192 * @param avctx the codec context
3193 * @param buf the slice data buffer base
3194 * @param buf_size the size of the slice in bytes
3195 * @return zero if successful, a negative value otherwise
3197 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3200 * Called at the end of each frame or field picture.
3202 * The whole picture is parsed at this point and can now be sent
3203 * to the hardware accelerator. This function is mandatory.
3205 * @param avctx the codec context
3206 * @return zero if successful, a negative value otherwise
3208 int (*end_frame)(AVCodecContext *avctx);
3211 * Size of HW accelerator private data.
3213 * Private data is allocated with av_mallocz() before
3214 * AVCodecContext.get_buffer() and deallocated after
3215 * AVCodecContext.release_buffer().
3221 * four components are given, that's all.
3222 * the last component is alpha
3224 typedef struct AVPicture {
3226 int linesize[4]; ///< number of bytes per line
3229 #define AVPALETTE_SIZE 1024
3230 #define AVPALETTE_COUNT 256
3231 #if FF_API_PALETTE_CONTROL
3234 * This structure defines a method for communicating palette changes
3235 * between and demuxer and a decoder.
3237 * @deprecated Use AVPacket to send palette changes instead.
3238 * This is totally broken.
3240 typedef struct AVPaletteControl {
3242 /* Demuxer sets this to 1 to indicate the palette has changed;
3243 * decoder resets to 0. */
3244 int palette_changed;
3246 /* 4-byte ARGB palette entries, stored in native byte order; note that
3247 * the individual palette components should be on a 8-bit scale; if
3248 * the palette data comes from an IBM VGA native format, the component
3249 * data is probably 6 bits in size and needs to be scaled. */
3250 unsigned int palette[AVPALETTE_COUNT];
3252 } AVPaletteControl attribute_deprecated;
3255 enum AVSubtitleType {
3258 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3261 * Plain text, the text field must be set by the decoder and is
3262 * authoritative. ass and pict fields may contain approximations.
3267 * Formatted text, the ass field must be set by the decoder and is
3268 * authoritative. pict and text fields may contain approximations.
3273 typedef struct AVSubtitleRect {
3274 int x; ///< top left corner of pict, undefined when pict is not set
3275 int y; ///< top left corner of pict, undefined when pict is not set
3276 int w; ///< width of pict, undefined when pict is not set
3277 int h; ///< height of pict, undefined when pict is not set
3278 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3281 * data+linesize for the bitmap of this subtitle.
3282 * can be set for text/ass as well once they where rendered
3285 enum AVSubtitleType type;
3287 char *text; ///< 0 terminated plain UTF-8 text
3290 * 0 terminated ASS/SSA compatible event line.
3291 * The pressentation of this is unaffected by the other values in this
3297 typedef struct AVSubtitle {
3298 uint16_t format; /* 0 = graphics */
3299 uint32_t start_display_time; /* relative to packet pts, in ms */
3300 uint32_t end_display_time; /* relative to packet pts, in ms */
3302 AVSubtitleRect **rects;
3303 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3306 /* packet functions */
3309 * @deprecated use NULL instead
3311 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3314 * Default packet destructor.
3316 void av_destruct_packet(AVPacket *pkt);
3319 * Initialize optional fields of a packet with default values.
3323 void av_init_packet(AVPacket *pkt);
3326 * Allocate the payload of a packet and initialize its fields with
3330 * @param size wanted payload size
3331 * @return 0 if OK, AVERROR_xxx otherwise
3333 int av_new_packet(AVPacket *pkt, int size);
3336 * Reduce packet size, correctly zeroing padding
3339 * @param size new size
3341 void av_shrink_packet(AVPacket *pkt, int size);
3344 * Increase packet size, correctly zeroing padding
3347 * @param grow_by number of bytes by which to increase the size of the packet
3349 int av_grow_packet(AVPacket *pkt, int grow_by);
3352 * @warning This is a hack - the packet memory allocation stuff is broken. The
3353 * packet is allocated if it was not really allocated.
3355 int av_dup_packet(AVPacket *pkt);
3360 * @param pkt packet to free
3362 void av_free_packet(AVPacket *pkt);
3365 * Allocate new information of a packet.
3368 * @param type side information type
3369 * @param size side information size
3370 * @return pointer to fresh allocated data or NULL otherwise
3372 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3376 * Get side information from packet.
3379 * @param type desired side information type
3380 * @param size pointer for side information size to store (optional)
3381 * @return pointer to data if present or NULL otherwise
3383 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3386 int av_packet_merge_side_data(AVPacket *pkt);
3388 int av_packet_split_side_data(AVPacket *pkt);
3393 struct ReSampleContext;
3394 struct AVResampleContext;
3396 typedef struct ReSampleContext ReSampleContext;
3399 * Initialize audio resampling context.
3401 * @param output_channels number of output channels
3402 * @param input_channels number of input channels
3403 * @param output_rate output sample rate
3404 * @param input_rate input sample rate
3405 * @param sample_fmt_out requested output sample format
3406 * @param sample_fmt_in input sample format
3407 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3408 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3409 * @param linear if 1 then the used FIR filter will be linearly interpolated
3410 between the 2 closest, if 0 the closest will be used
3411 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3412 * @return allocated ReSampleContext, NULL if error occured
3414 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3415 int output_rate, int input_rate,
3416 enum AVSampleFormat sample_fmt_out,
3417 enum AVSampleFormat sample_fmt_in,
3418 int filter_length, int log2_phase_count,
3419 int linear, double cutoff);
3421 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3424 * Free resample context.
3426 * @param s a non-NULL pointer to a resample context previously
3427 * created with av_audio_resample_init()
3429 void audio_resample_close(ReSampleContext *s);
3433 * Initialize an audio resampler.
3434 * Note, if either rate is not an integer then simply scale both rates up so they are.
3435 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3436 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3437 * @param linear If 1 then the used FIR filter will be linearly interpolated
3438 between the 2 closest, if 0 the closest will be used
3439 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3441 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3444 * Resample an array of samples using a previously configured context.
3445 * @param src an array of unconsumed samples
3446 * @param consumed the number of samples of src which have been consumed are returned here
3447 * @param src_size the number of unconsumed samples available
3448 * @param dst_size the amount of space in samples available in dst
3449 * @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.
3450 * @return the number of samples written in dst or -1 if an error occurred
3452 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3456 * Compensate samplerate/timestamp drift. The compensation is done by changing
3457 * the resampler parameters, so no audible clicks or similar distortions occur
3458 * @param compensation_distance distance in output samples over which the compensation should be performed
3459 * @param sample_delta number of output samples which should be output less
3461 * example: av_resample_compensate(c, 10, 500)
3462 * here instead of 510 samples only 500 samples would be output
3464 * note, due to rounding the actual compensation might be slightly different,
3465 * especially if the compensation_distance is large and the in_rate used during init is small
3467 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3468 void av_resample_close(struct AVResampleContext *c);
3471 * Allocate memory for a picture. Call avpicture_free() to free it.
3473 * @see avpicture_fill()
3475 * @param picture the picture to be filled in
3476 * @param pix_fmt the format of the picture
3477 * @param width the width of the picture
3478 * @param height the height of the picture
3479 * @return zero if successful, a negative value if not
3481 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3484 * Free a picture previously allocated by avpicture_alloc().
3485 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3488 * @param picture the AVPicture to be freed
3490 void avpicture_free(AVPicture *picture);
3493 * Fill in the AVPicture fields.
3494 * The fields of the given AVPicture are filled in by using the 'ptr' address
3495 * which points to the image data buffer. Depending on the specified picture
3496 * format, one or multiple image data pointers and line sizes will be set.
3497 * If a planar format is specified, several pointers will be set pointing to
3498 * the different picture planes and the line sizes of the different planes
3499 * will be stored in the lines_sizes array.
3500 * Call with ptr == NULL to get the required size for the ptr buffer.
3502 * To allocate the buffer and fill in the AVPicture fields in one call,
3503 * use avpicture_alloc().
3505 * @param picture AVPicture whose fields are to be filled in
3506 * @param ptr Buffer which will contain or contains the actual image data
3507 * @param pix_fmt The format in which the picture data is stored.
3508 * @param width the width of the image in pixels
3509 * @param height the height of the image in pixels
3510 * @return size of the image data in bytes
3512 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3513 enum PixelFormat pix_fmt, int width, int height);
3516 * Copy pixel data from an AVPicture into a buffer.
3517 * The data is stored compactly, without any gaps for alignment or padding
3518 * which may be applied by avpicture_fill().
3520 * @see avpicture_get_size()
3522 * @param[in] src AVPicture containing image data
3523 * @param[in] pix_fmt The format in which the picture data is stored.
3524 * @param[in] width the width of the image in pixels.
3525 * @param[in] height the height of the image in pixels.
3526 * @param[out] dest A buffer into which picture data will be copied.
3527 * @param[in] dest_size The size of 'dest'.
3528 * @return The number of bytes written to dest, or a negative value (error code) on error.
3530 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3531 unsigned char *dest, int dest_size);
3534 * Calculate the size in bytes that a picture of the given width and height
3535 * would occupy if stored in the given picture format.
3536 * Note that this returns the size of a compact representation as generated
3537 * by avpicture_layout(), which can be smaller than the size required for e.g.
3540 * @param pix_fmt the given picture format
3541 * @param width the width of the image
3542 * @param height the height of the image
3543 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3545 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3546 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3549 * Get the name of a codec.
3550 * @return a static string identifying the codec; never NULL
3552 const char *avcodec_get_name(enum CodecID id);
3554 #if FF_API_GET_PIX_FMT_NAME
3556 * Return the short name for a pixel format.
3558 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3559 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3561 attribute_deprecated
3562 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3565 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3568 * Return a value representing the fourCC code associated to the
3569 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3572 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3575 * Put a string representing the codec tag codec_tag in buf.
3577 * @param buf_size size in bytes of buf
3578 * @return the length of the string that would have been generated if
3579 * enough space had been available, excluding the trailing null
3581 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3583 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3584 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3585 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3586 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3587 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3588 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3591 * Compute what kind of losses will occur when converting from one specific
3592 * pixel format to another.
3593 * When converting from one pixel format to another, information loss may occur.
3594 * For example, when converting from RGB24 to GRAY, the color information will
3595 * be lost. Similarly, other losses occur when converting from some formats to
3596 * other formats. These losses can involve loss of chroma, but also loss of
3597 * resolution, loss of color depth, loss due to the color space conversion, loss
3598 * of the alpha bits or loss due to color quantization.
3599 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3600 * which will occur when converting from one pixel format to another.
3602 * @param[in] dst_pix_fmt destination pixel format
3603 * @param[in] src_pix_fmt source pixel format
3604 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3605 * @return Combination of flags informing you what kind of losses will occur
3606 * (maximum loss for an invalid dst_pix_fmt).
3608 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3612 * Find the best pixel format to convert to given a certain source pixel
3613 * format. When converting from one pixel format to another, information loss
3614 * may occur. For example, when converting from RGB24 to GRAY, the color
3615 * information will be lost. Similarly, other losses occur when converting from
3616 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3617 * the given pixel formats should be used to suffer the least amount of loss.
3618 * The pixel formats from which it chooses one, are determined by the
3619 * pix_fmt_mask parameter.
3621 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3624 * src_pix_fmt = PIX_FMT_YUV420P;
3625 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3626 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3629 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3630 * @param[in] src_pix_fmt source pixel format
3631 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3632 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3633 * @return The best pixel format to convert to or -1 if none was found.
3635 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3636 int has_alpha, int *loss_ptr);
3639 * Find the best pixel format to convert to given a certain source pixel
3640 * format and a selection of two destination pixel formats. When converting from
3641 * one pixel format to another, information loss may occur. For example, when converting
3642 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3643 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3644 * the given pixel formats should be used to suffer the least amount of loss.
3646 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3650 * src_pix_fmt = PIX_FMT_YUV420P;
3651 * dst_pix_fmt1= PIX_FMT_RGB24;
3652 * dst_pix_fmt2= PIX_FMT_GRAY8;
3653 * dst_pix_fmt3= PIX_FMT_RGB8;
3654 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3655 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3656 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3659 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3660 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3661 * @param[in] src_pix_fmt Source pixel format
3662 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3663 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3664 * NULL or value of zero means we care about all losses. Out: the loss
3665 * that occurs when converting from src to selected dst pixel format.
3666 * @return The best pixel format to convert to or -1 if none was found.
3668 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3669 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3671 #if FF_API_GET_ALPHA_INFO
3672 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3673 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3676 * Tell if an image really has transparent alpha values.
3677 * @return ored mask of FF_ALPHA_xxx constants
3679 attribute_deprecated
3680 int img_get_alpha_info(const AVPicture *src,
3681 enum PixelFormat pix_fmt, int width, int height);
3684 /* deinterlace a picture */
3685 /* deinterlace - if not supported return -1 */
3686 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3687 enum PixelFormat pix_fmt, int width, int height);
3689 /* external high level API */
3692 * If c is NULL, returns the first registered codec,
3693 * if c is non-NULL, returns the next registered codec after c,
3694 * or NULL if c is the last one.
3696 AVCodec *av_codec_next(AVCodec *c);
3699 * Return the LIBAVCODEC_VERSION_INT constant.
3701 unsigned avcodec_version(void);
3704 * Return the libavcodec build-time configuration.
3706 const char *avcodec_configuration(void);
3709 * Return the libavcodec license.
3711 const char *avcodec_license(void);
3713 #if FF_API_AVCODEC_INIT
3715 * @deprecated this function is called automatically from avcodec_register()
3716 * and avcodec_register_all(), there is no need to call it manually
3718 attribute_deprecated
3719 void avcodec_init(void);
3723 * Register the codec codec and initialize libavcodec.
3725 * @warning either this function or avcodec_register_all() must be called
3726 * before any other libavcodec functions.
3728 * @see avcodec_register_all()
3730 void avcodec_register(AVCodec *codec);
3733 * Find a registered encoder with a matching codec ID.
3735 * @param id CodecID of the requested encoder
3736 * @return An encoder if one was found, NULL otherwise.
3738 AVCodec *avcodec_find_encoder(enum CodecID id);
3741 * Find a registered encoder with the specified name.
3743 * @param name name of the requested encoder
3744 * @return An encoder if one was found, NULL otherwise.
3746 AVCodec *avcodec_find_encoder_by_name(const char *name);
3749 * Find a registered decoder with a matching codec ID.
3751 * @param id CodecID of the requested decoder
3752 * @return A decoder if one was found, NULL otherwise.
3754 AVCodec *avcodec_find_decoder(enum CodecID id);
3757 * Find a registered decoder with the specified name.
3759 * @param name name of the requested decoder
3760 * @return A decoder if one was found, NULL otherwise.
3762 AVCodec *avcodec_find_decoder_by_name(const char *name);
3763 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3766 * Return a name for the specified profile, if available.
3768 * @param codec the codec that is searched for the given profile
3769 * @param profile the profile value for which a name is requested
3770 * @return A name for the profile if found, NULL otherwise.
3772 const char *av_get_profile_name(const AVCodec *codec, int profile);
3774 #if FF_API_ALLOC_CONTEXT
3776 * Set the fields of the given AVCodecContext to default values.
3778 * @param s The AVCodecContext of which the fields should be set to default values.
3779 * @deprecated use avcodec_get_context_defaults3
3781 attribute_deprecated
3782 void avcodec_get_context_defaults(AVCodecContext *s);
3784 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3785 * we WILL change its arguments and name a few times! */
3786 attribute_deprecated
3787 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3791 * Set the fields of the given AVCodecContext to default values corresponding
3792 * to the given codec (defaults may be codec-dependent).
3794 * Do not call this function if a non-NULL codec has been passed
3795 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3796 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3797 * different codec on this AVCodecContext.
3799 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3801 #if FF_API_ALLOC_CONTEXT
3803 * Allocate an AVCodecContext and set its fields to default values. The
3804 * resulting struct can be deallocated by simply calling av_free().
3806 * @return An AVCodecContext filled with default values or NULL on failure.
3807 * @see avcodec_get_context_defaults
3809 * @deprecated use avcodec_alloc_context3()
3811 attribute_deprecated
3812 AVCodecContext *avcodec_alloc_context(void);
3814 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3815 * we WILL change its arguments and name a few times! */
3816 attribute_deprecated
3817 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3821 * Allocate an AVCodecContext and set its fields to default values. The
3822 * resulting struct can be deallocated by simply calling av_free().
3824 * @param codec if non-NULL, allocate private data and initialize defaults
3825 * for the given codec. It is illegal to then call avcodec_open()
3826 * with a different codec.
3828 * @return An AVCodecContext filled with default values or NULL on failure.
3829 * @see avcodec_get_context_defaults
3831 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3834 * Copy the settings of the source AVCodecContext into the destination
3835 * AVCodecContext. The resulting destination codec context will be
3836 * unopened, i.e. you are required to call avcodec_open() before you
3837 * can use this AVCodecContext to decode/encode video/audio data.
3839 * @param dest target codec context, should be initialized with
3840 * avcodec_alloc_context3(), but otherwise uninitialized
3841 * @param src source codec context
3842 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3844 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3847 * Set the fields of the given AVFrame to default values.
3849 * @param pic The AVFrame of which the fields should be set to default values.
3851 void avcodec_get_frame_defaults(AVFrame *pic);
3854 * Allocate an AVFrame and set its fields to default values. The resulting
3855 * struct can be deallocated by simply calling av_free().
3857 * @return An AVFrame filled with default values or NULL on failure.
3858 * @see avcodec_get_frame_defaults
3860 AVFrame *avcodec_alloc_frame(void);
3862 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3863 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3864 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3867 * Return the amount of padding in pixels which the get_buffer callback must
3868 * provide around the edge of the image for codecs which do not have the
3869 * CODEC_FLAG_EMU_EDGE flag.
3871 * @return Required padding in pixels.
3873 unsigned avcodec_get_edge_width(void);
3875 * Modify width and height values so that they will result in a memory
3876 * buffer that is acceptable for the codec if you do not use any horizontal
3879 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3880 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3881 * according to avcodec_get_edge_width() before.
3883 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3885 * Modify width and height values so that they will result in a memory
3886 * buffer that is acceptable for the codec if you also ensure that all
3887 * line sizes are a multiple of the respective linesize_align[i].
3889 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3890 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3891 * according to avcodec_get_edge_width() before.
3893 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3894 int linesize_align[4]);
3896 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3898 #if FF_API_THREAD_INIT
3900 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3902 attribute_deprecated
3903 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3906 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3907 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3908 //FIXME func typedef
3910 #if FF_API_AVCODEC_OPEN
3912 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3913 * function the context has to be allocated.
3915 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3916 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3917 * retrieving a codec.
3919 * @warning This function is not thread safe!
3922 * avcodec_register_all();
3923 * codec = avcodec_find_decoder(CODEC_ID_H264);
3927 * context = avcodec_alloc_context3(codec);
3929 * if (avcodec_open(context, codec) < 0)
3933 * @param avctx The context which will be set up to use the given codec.
3934 * @param codec The codec to use within the context.
3935 * @return zero on success, a negative value on error
3936 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3938 * @deprecated use avcodec_open2
3940 attribute_deprecated
3941 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3945 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3946 * function the context has to be allocated with avcodec_alloc_context().
3948 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3949 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3950 * retrieving a codec.
3952 * @warning This function is not thread safe!
3955 * avcodec_register_all();
3956 * av_dict_set(&opts, "b", "2.5M", 0);
3957 * codec = avcodec_find_decoder(CODEC_ID_H264);
3961 * context = avcodec_alloc_context();
3963 * if (avcodec_open(context, codec, opts) < 0)
3967 * @param avctx The context to initialize.
3968 * @param options A dictionary filled with AVCodecContext and codec-private options.
3969 * On return this object will be filled with options that were not found.
3971 * @return zero on success, a negative value on error
3972 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3973 * av_dict_set(), av_opt_find().
3975 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3978 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3979 * Some decoders may support multiple frames in a single AVPacket, such
3980 * decoders would then just decode the first frame. In this case,
3981 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3982 * the remaining data in order to decode the second frame etc.
3984 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3985 * decompressed frame size in bytes.
3987 * @warning You must set frame_size_ptr to the allocated size of the
3988 * output buffer before calling avcodec_decode_audio3().
3990 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3991 * the actual read bytes because some optimized bitstream readers read 32 or 64
3992 * bits at once and could read over the end.
3994 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3995 * no overreading happens for damaged MPEG streams.
3997 * @note You might have to align the input buffer avpkt->data and output buffer
3998 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3999 * necessary at all, on others it won't work at all if not aligned and on others
4000 * it will work but it will have an impact on performance.
4002 * In practice, avpkt->data should have 4 byte alignment at minimum and
4003 * samples should be 16 byte aligned unless the CPU doesn't need it
4004 * (AltiVec and SSE do).
4006 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4007 * between input and output, these need to be fed with avpkt->data=NULL,
4008 * avpkt->size=0 at the end to return the remaining frames.
4010 * @param avctx the codec context
4011 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
4012 * @param[in,out] frame_size_ptr the output buffer size in bytes
4013 * @param[in] avpkt The input AVPacket containing the input buffer.
4014 * You can create such packet with av_init_packet() and by then setting
4015 * data and size, some decoders might in addition need other fields.
4016 * All decoders are designed to use the least fields possible though.
4017 * @return On error a negative value is returned, otherwise the number of bytes
4018 * used or zero if no frame data was decompressed (used) from the input AVPacket.
4020 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
4021 int *frame_size_ptr,
4025 * Decode the video frame of size avpkt->size from avpkt->data into picture.
4026 * Some decoders may support multiple frames in a single AVPacket, such
4027 * decoders would then just decode the first frame.
4029 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
4030 * the actual read bytes because some optimized bitstream readers read 32 or 64
4031 * bits at once and could read over the end.
4033 * @warning The end of the input buffer buf should be set to 0 to ensure that
4034 * no overreading happens for damaged MPEG streams.
4036 * @note You might have to align the input buffer avpkt->data.
4037 * The alignment requirements depend on the CPU: on some CPUs it isn't
4038 * necessary at all, on others it won't work at all if not aligned and on others
4039 * it will work but it will have an impact on performance.
4041 * In practice, avpkt->data should have 4 byte alignment at minimum.
4043 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
4044 * between input and output, these need to be fed with avpkt->data=NULL,
4045 * avpkt->size=0 at the end to return the remaining frames.
4047 * @param avctx the codec context
4048 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4049 * Use avcodec_alloc_frame to get an AVFrame, the codec will
4050 * allocate memory for the actual bitmap.
4051 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
4052 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
4053 * decodes and the decoder tells the user once it does not need the data anymore,
4054 * the user app can at this point free/reuse/keep the memory as it sees fit.
4056 * @param[in] avpkt The input AVpacket containing the input buffer.
4057 * You can create such packet with av_init_packet() and by then setting
4058 * data and size, some decoders might in addition need other fields like
4059 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4061 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4062 * @return On error a negative value is returned, otherwise the number of bytes
4063 * used or zero if no frame could be decompressed.
4065 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4066 int *got_picture_ptr,
4070 * Decode a subtitle message.
4071 * Return a negative value on error, otherwise return the number of bytes used.
4072 * If no subtitle could be decompressed, got_sub_ptr is zero.
4073 * Otherwise, the subtitle is stored in *sub.
4074 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4075 * simplicity, because the performance difference is expect to be negligible
4076 * and reusing a get_buffer written for video codecs would probably perform badly
4077 * due to a potentially very different allocation pattern.
4079 * @param avctx the codec context
4080 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4081 freed with avsubtitle_free if *got_sub_ptr is set.
4082 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4083 * @param[in] avpkt The input AVPacket containing the input buffer.
4085 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4090 * Frees all allocated data in the given subtitle struct.
4092 * @param sub AVSubtitle to free.
4094 void avsubtitle_free(AVSubtitle *sub);
4097 * Encode an audio frame from samples into buf.
4099 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4100 * However, for PCM audio the user will know how much space is needed
4101 * because it depends on the value passed in buf_size as described
4102 * below. In that case a lower value can be used.
4104 * @param avctx the codec context
4105 * @param[out] buf the output buffer
4106 * @param[in] buf_size the output buffer size
4107 * @param[in] samples the input buffer containing the samples
4108 * The number of samples read from this buffer is frame_size*channels,
4109 * both of which are defined in avctx.
4110 * For PCM audio the number of samples read from samples is equal to
4111 * buf_size * input_sample_size / output_sample_size.
4112 * @return On error a negative value is returned, on success zero or the number
4113 * of bytes used to encode the data read from the input buffer.
4115 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4116 const short *samples);
4119 * Encode a video frame from pict into buf.
4120 * The input picture should be
4121 * stored using a specific format, namely avctx.pix_fmt.
4123 * @param avctx the codec context
4124 * @param[out] buf the output buffer for the bitstream of encoded frame
4125 * @param[in] buf_size the size of the output buffer in bytes
4126 * @param[in] pict the input picture to encode
4127 * @return On error a negative value is returned, on success zero or the number
4128 * of bytes used from the output buffer.
4130 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4131 const AVFrame *pict);
4132 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4133 const AVSubtitle *sub);
4135 int avcodec_close(AVCodecContext *avctx);
4138 * Register all the codecs, parsers and bitstream filters which were enabled at
4139 * configuration time. If you do not call this function you can select exactly
4140 * which formats you want to support, by using the individual registration
4143 * @see avcodec_register
4144 * @see av_register_codec_parser
4145 * @see av_register_bitstream_filter
4147 void avcodec_register_all(void);
4150 * Flush buffers, should be called when seeking or when switching to a different stream.
4152 void avcodec_flush_buffers(AVCodecContext *avctx);
4154 void avcodec_default_free_buffers(AVCodecContext *s);
4156 /* misc useful functions */
4158 #if FF_API_OLD_FF_PICT_TYPES
4160 * Return a single letter to describe the given picture type pict_type.
4162 * @param[in] pict_type the picture type
4163 * @return A single character representing the picture type.
4164 * @deprecated Use av_get_picture_type_char() instead.
4166 attribute_deprecated
4167 char av_get_pict_type_char(int pict_type);
4171 * Return codec bits per sample.
4173 * @param[in] codec_id the codec
4174 * @return Number of bits per sample or zero if unknown for the given codec.
4176 int av_get_bits_per_sample(enum CodecID codec_id);
4178 #if FF_API_OLD_SAMPLE_FMT
4180 * @deprecated Use av_get_bytes_per_sample() instead.
4182 attribute_deprecated
4183 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4187 typedef struct AVCodecParserContext {
4189 struct AVCodecParser *parser;
4190 int64_t frame_offset; /* offset of the current frame */
4191 int64_t cur_offset; /* current offset
4192 (incremented by each av_parser_parse()) */
4193 int64_t next_frame_offset; /* offset of the next frame */
4195 int pict_type; /* XXX: Put it back in AVCodecContext. */
4197 * This field is used for proper frame duration computation in lavf.
4198 * It signals, how much longer the frame duration of the current frame
4199 * is compared to normal frame duration.
4201 * frame_duration = (1 + repeat_pict) * time_base
4203 * It is used by codecs like H.264 to display telecined material.
4205 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4206 int64_t pts; /* pts of the current frame */
4207 int64_t dts; /* dts of the current frame */
4212 int fetch_timestamp;
4214 #define AV_PARSER_PTS_NB 4
4215 int cur_frame_start_index;
4216 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4217 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4218 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4221 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4222 #define PARSER_FLAG_ONCE 0x0002
4223 /// Set if the parser has a valid file offset
4224 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4226 int64_t offset; ///< byte offset from starting packet start
4227 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4230 * Set by parser to 1 for key frames and 0 for non-key frames.
4231 * It is initialized to -1, so if the parser doesn't set this flag,
4232 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4238 * Time difference in stream time base units from the pts of this
4239 * packet to the point at which the output from the decoder has converged
4240 * independent from the availability of previous frames. That is, the
4241 * frames are virtually identical no matter if decoding started from
4242 * the very first frame or from this keyframe.
4243 * Is AV_NOPTS_VALUE if unknown.
4244 * This field is not the display duration of the current frame.
4245 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4248 * The purpose of this field is to allow seeking in streams that have no
4249 * keyframes in the conventional sense. It corresponds to the
4250 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4251 * essential for some types of subtitle streams to ensure that all
4252 * subtitles are correctly displayed after seeking.
4254 int64_t convergence_duration;
4256 // Timestamp generation support:
4258 * Synchronization point for start of timestamp generation.
4260 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4263 * For example, this corresponds to presence of H.264 buffering period
4269 * Offset of the current timestamp against last timestamp sync point in
4270 * units of AVCodecContext.time_base.
4272 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4273 * contain a valid timestamp offset.
4275 * Note that the timestamp of sync point has usually a nonzero
4276 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4277 * the next frame after timestamp sync point will be usually 1.
4279 * For example, this corresponds to H.264 cpb_removal_delay.
4281 int dts_ref_dts_delta;
4284 * Presentation delay of current frame in units of AVCodecContext.time_base.
4286 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4287 * contain valid non-negative timestamp delta (presentation time of a frame
4288 * must not lie in the past).
4290 * This delay represents the difference between decoding and presentation
4291 * time of the frame.
4293 * For example, this corresponds to H.264 dpb_output_delay.
4298 * Position of the packet in file.
4300 * Analogous to cur_frame_pts/dts
4302 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4305 * Byte position of currently parsed frame in stream.
4310 * Previous frame byte position.
4313 } AVCodecParserContext;
4315 typedef struct AVCodecParser {
4316 int codec_ids[5]; /* several codec IDs are permitted */
4318 int (*parser_init)(AVCodecParserContext *s);
4319 int (*parser_parse)(AVCodecParserContext *s,
4320 AVCodecContext *avctx,
4321 const uint8_t **poutbuf, int *poutbuf_size,
4322 const uint8_t *buf, int buf_size);
4323 void (*parser_close)(AVCodecParserContext *s);
4324 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4325 struct AVCodecParser *next;
4328 AVCodecParser *av_parser_next(AVCodecParser *c);
4330 void av_register_codec_parser(AVCodecParser *parser);
4331 AVCodecParserContext *av_parser_init(int codec_id);
4336 * @param s parser context.
4337 * @param avctx codec context.
4338 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4339 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4340 * @param buf input buffer.
4341 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4342 * @param pts input presentation timestamp.
4343 * @param dts input decoding timestamp.
4344 * @param pos input byte position in stream.
4345 * @return the number of bytes of the input bitstream used.
4350 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4357 * decode_frame(data, size);
4361 int av_parser_parse2(AVCodecParserContext *s,
4362 AVCodecContext *avctx,
4363 uint8_t **poutbuf, int *poutbuf_size,
4364 const uint8_t *buf, int buf_size,
4365 int64_t pts, int64_t dts,
4368 int av_parser_change(AVCodecParserContext *s,
4369 AVCodecContext *avctx,
4370 uint8_t **poutbuf, int *poutbuf_size,
4371 const uint8_t *buf, int buf_size, int keyframe);
4372 void av_parser_close(AVCodecParserContext *s);
4375 typedef struct AVBitStreamFilterContext {
4377 struct AVBitStreamFilter *filter;
4378 AVCodecParserContext *parser;
4379 struct AVBitStreamFilterContext *next;
4380 } AVBitStreamFilterContext;
4383 typedef struct AVBitStreamFilter {
4386 int (*filter)(AVBitStreamFilterContext *bsfc,
4387 AVCodecContext *avctx, const char *args,
4388 uint8_t **poutbuf, int *poutbuf_size,
4389 const uint8_t *buf, int buf_size, int keyframe);
4390 void (*close)(AVBitStreamFilterContext *bsfc);
4391 struct AVBitStreamFilter *next;
4392 } AVBitStreamFilter;
4394 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4395 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4396 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4397 AVCodecContext *avctx, const char *args,
4398 uint8_t **poutbuf, int *poutbuf_size,
4399 const uint8_t *buf, int buf_size, int keyframe);
4400 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4402 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4407 * Reallocate the given block if it is not large enough, otherwise do nothing.
4411 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4414 * Allocate a buffer, reusing the given one if large enough.
4416 * Contrary to av_fast_realloc the current buffer contents might not be
4417 * preserved and on error the old buffer is freed, thus no special
4418 * handling to avoid memleaks is necessary.
4420 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4421 * @param size size of the buffer *ptr points to
4422 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4423 * *size 0 if an error occurred.
4425 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4428 * Copy image src to dst. Wraps av_picture_data_copy() above.
4430 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4431 enum PixelFormat pix_fmt, int width, int height);
4434 * Crop image top and left side.
4436 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4437 enum PixelFormat pix_fmt, int top_band, int left_band);
4442 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4443 int padtop, int padbottom, int padleft, int padright, int *color);
4446 * Encode extradata length to a buffer. Used by xiph codecs.
4448 * @param s buffer to write to; must be at least (v/255+1) bytes long
4449 * @param v size of extradata in bytes
4450 * @return number of bytes written to the buffer.
4452 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4455 * Logs a generic warning message about a missing feature. This function is
4456 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4457 * only, and would normally not be used by applications.
4458 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4459 * a pointer to an AVClass struct
4460 * @param[in] feature string containing the name of the missing feature
4461 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4462 * If want_sample is non-zero, additional verbage will be added to the log
4463 * message which tells the user how to report samples to the development
4466 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4469 * Log a generic warning message asking for a sample. This function is
4470 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4471 * only, and would normally not be used by applications.
4472 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4473 * a pointer to an AVClass struct
4474 * @param[in] msg string containing an optional message, or NULL if no message
4476 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4479 * Register the hardware accelerator hwaccel.
4481 void av_register_hwaccel(AVHWAccel *hwaccel);
4484 * If hwaccel is NULL, returns the first registered hardware accelerator,
4485 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4486 * after hwaccel, or NULL if hwaccel is the last one.
4488 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4492 * Lock operation used by lockmgr
4495 AV_LOCK_CREATE, ///< Create a mutex
4496 AV_LOCK_OBTAIN, ///< Lock the mutex
4497 AV_LOCK_RELEASE, ///< Unlock the mutex
4498 AV_LOCK_DESTROY, ///< Free mutex resources
4502 * Register a user provided lock manager supporting the operations
4503 * specified by AVLockOp. mutex points to a (void *) where the
4504 * lockmgr should store/get a pointer to a user allocated mutex. It's
4505 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4507 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4508 * callback during the call to av_lockmgr_register().
4509 * Thus, the application must be prepared to handle that.
4510 * If cb is set to NULL the lockmgr will be unregistered.
4511 * Also note that during unregistration the previously registered
4512 * lockmgr callback may also be invoked.
4514 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4517 * Get the type of the given codec.
4519 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4522 * Get the AVClass for AVCodecContext. It can be used in combination with
4523 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4525 * @see av_opt_find().
4527 const AVClass *avcodec_get_class(void);
4529 #endif /* AVCODEC_AVCODEC_H */