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/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 79
34 #define LIBAVCODEC_VERSION_MICRO 1
36 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
42 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
44 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
46 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
47 #define AV_TIME_BASE 1000000
48 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
51 * Identify the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
68 CODEC_ID_MPEG2VIDEO_XVMC,
105 CODEC_ID_INTERPLAY_VIDEO,
117 CODEC_ID_TRUEMOTION1,
128 #if LIBAVCODEC_VERSION_MAJOR < 53
147 CODEC_ID_TRUEMOTION2,
164 CODEC_ID_DSICINVIDEO,
165 CODEC_ID_TIERTEXSEQVIDEO,
174 CODEC_ID_BETHSOFTVID,
192 CODEC_ID_MOTIONPIXELS,
210 CODEC_ID_IFF_BYTERUN1,
216 /* various PCM "codecs" */
217 CODEC_ID_PCM_S16LE= 0x10000,
233 CODEC_ID_PCM_S24DAUD,
235 CODEC_ID_PCM_S16LE_PLANAR,
243 /* various ADPCM codecs */
244 CODEC_ID_ADPCM_IMA_QT= 0x11000,
245 CODEC_ID_ADPCM_IMA_WAV,
246 CODEC_ID_ADPCM_IMA_DK3,
247 CODEC_ID_ADPCM_IMA_DK4,
248 CODEC_ID_ADPCM_IMA_WS,
249 CODEC_ID_ADPCM_IMA_SMJPEG,
258 CODEC_ID_ADPCM_YAMAHA,
259 CODEC_ID_ADPCM_SBPRO_4,
260 CODEC_ID_ADPCM_SBPRO_3,
261 CODEC_ID_ADPCM_SBPRO_2,
263 CODEC_ID_ADPCM_IMA_AMV,
264 CODEC_ID_ADPCM_EA_R1,
265 CODEC_ID_ADPCM_EA_R3,
266 CODEC_ID_ADPCM_EA_R2,
267 CODEC_ID_ADPCM_IMA_EA_SEAD,
268 CODEC_ID_ADPCM_IMA_EA_EACS,
269 CODEC_ID_ADPCM_EA_XAS,
270 CODEC_ID_ADPCM_EA_MAXIS_XA,
271 CODEC_ID_ADPCM_IMA_ISS,
274 CODEC_ID_AMR_NB= 0x12000,
277 /* RealAudio codecs*/
278 CODEC_ID_RA_144= 0x13000,
281 /* various DPCM codecs */
282 CODEC_ID_ROQ_DPCM= 0x14000,
283 CODEC_ID_INTERPLAY_DPCM,
288 CODEC_ID_MP2= 0x15000,
289 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
307 CODEC_ID_WESTWOOD_SND1,
308 CODEC_ID_GSM, ///< as in Berlin toast format
316 CODEC_ID_DSICINAUDIO,
320 CODEC_ID_GSM_MS, /* as found in WAV */
329 CODEC_ID_WMALOSSLESS,
338 CODEC_ID_BINKAUDIO_RDFT,
339 CODEC_ID_BINKAUDIO_DCT,
341 /* subtitle codecs */
342 CODEC_ID_DVD_SUBTITLE= 0x17000,
343 CODEC_ID_DVB_SUBTITLE,
344 CODEC_ID_TEXT, ///< raw UTF-8 text
348 CODEC_ID_HDMV_PGS_SUBTITLE,
349 CODEC_ID_DVB_TELETEXT,
351 /* other specific kind of codecs (generally used for attachments) */
352 CODEC_ID_TTF= 0x18000,
354 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
356 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
357 * stream (only used by libavformat) */
360 #if LIBAVCODEC_VERSION_MAJOR < 53
361 #define CodecType AVMediaType
363 #define CODEC_TYPE_UNKNOWN AVMEDIA_TYPE_UNKNOWN
364 #define CODEC_TYPE_VIDEO AVMEDIA_TYPE_VIDEO
365 #define CODEC_TYPE_AUDIO AVMEDIA_TYPE_AUDIO
366 #define CODEC_TYPE_DATA AVMEDIA_TYPE_DATA
367 #define CODEC_TYPE_SUBTITLE AVMEDIA_TYPE_SUBTITLE
368 #define CODEC_TYPE_ATTACHMENT AVMEDIA_TYPE_ATTACHMENT
369 #define CODEC_TYPE_NB AVMEDIA_TYPE_NB
373 * all in native-endian format
376 SAMPLE_FMT_NONE = -1,
377 SAMPLE_FMT_U8, ///< unsigned 8 bits
378 SAMPLE_FMT_S16, ///< signed 16 bits
379 SAMPLE_FMT_S32, ///< signed 32 bits
380 SAMPLE_FMT_FLT, ///< float
381 SAMPLE_FMT_DBL, ///< double
382 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
385 /* Audio channel masks */
386 #define CH_FRONT_LEFT 0x00000001
387 #define CH_FRONT_RIGHT 0x00000002
388 #define CH_FRONT_CENTER 0x00000004
389 #define CH_LOW_FREQUENCY 0x00000008
390 #define CH_BACK_LEFT 0x00000010
391 #define CH_BACK_RIGHT 0x00000020
392 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
393 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
394 #define CH_BACK_CENTER 0x00000100
395 #define CH_SIDE_LEFT 0x00000200
396 #define CH_SIDE_RIGHT 0x00000400
397 #define CH_TOP_CENTER 0x00000800
398 #define CH_TOP_FRONT_LEFT 0x00001000
399 #define CH_TOP_FRONT_CENTER 0x00002000
400 #define CH_TOP_FRONT_RIGHT 0x00004000
401 #define CH_TOP_BACK_LEFT 0x00008000
402 #define CH_TOP_BACK_CENTER 0x00010000
403 #define CH_TOP_BACK_RIGHT 0x00020000
404 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
405 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
407 /** Channel mask value used for AVCodecContext.request_channel_layout
408 to indicate that the user requests the channel order of the decoder output
409 to be the native codec channel order. */
410 #define CH_LAYOUT_NATIVE 0x8000000000000000LL
412 /* Audio channel convenience macros */
413 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
414 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
415 #define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
416 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
417 #define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
418 #define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
419 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
420 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
421 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
422 #define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
423 #define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
424 #define CH_LAYOUT_7POINT0 (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
425 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
426 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
427 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
428 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
431 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
434 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
435 * This is mainly needed because some optimized bitstream readers read
436 * 32 or 64 bit at once and could read over the end.<br>
437 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
438 * MPEG bitstreams could cause overread and segfault.
440 #define FF_INPUT_BUFFER_PADDING_SIZE 8
443 * minimum encoding buffer size
444 * Used to avoid some checks during header writing.
446 #define FF_MIN_BUFFER_SIZE 16384
450 * motion estimation type.
453 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
457 ME_EPZS, ///< enhanced predictive zonal search
458 ME_X1, ///< reserved for experiments
459 ME_HEX, ///< hexagon based search
460 ME_UMH, ///< uneven multi-hexagon search
461 ME_ITER, ///< iterative search
462 ME_TESA, ///< transformed exhaustive search algorithm
466 /* We leave some space between them for extensions (drop some
467 * keyframes for intra-only or drop just some bidir frames). */
468 AVDISCARD_NONE =-16, ///< discard nothing
469 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
470 AVDISCARD_NONREF = 8, ///< discard all non reference
471 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
472 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
473 AVDISCARD_ALL = 48, ///< discard all
476 enum AVColorPrimaries{
477 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
478 AVCOL_PRI_UNSPECIFIED=2,
480 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
481 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
482 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
484 AVCOL_PRI_NB , ///< Not part of ABI
487 enum AVColorTransferCharacteristic{
488 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
489 AVCOL_TRC_UNSPECIFIED=2,
490 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
491 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
492 AVCOL_TRC_NB , ///< Not part of ABI
497 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
498 AVCOL_SPC_UNSPECIFIED=2,
500 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
501 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
502 AVCOL_SPC_SMPTE240M =7,
503 AVCOL_SPC_NB , ///< Not part of ABI
507 AVCOL_RANGE_UNSPECIFIED=0,
508 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
509 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
510 AVCOL_RANGE_NB , ///< Not part of ABI
514 * X X 3 4 X X are luma samples,
515 * 1 2 1-6 are possible chroma positions
516 * X X 5 6 X 0 is undefined/unknown position
518 enum AVChromaLocation{
519 AVCHROMA_LOC_UNSPECIFIED=0,
520 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
521 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
522 AVCHROMA_LOC_TOPLEFT =3, ///< DV
524 AVCHROMA_LOC_BOTTOMLEFT =5,
525 AVCHROMA_LOC_BOTTOM =6,
526 AVCHROMA_LOC_NB , ///< Not part of ABI
529 typedef struct RcOverride{
532 int qscale; // If this is 0 then quality_factor will be used instead.
533 float quality_factor;
536 #define FF_MAX_B_FRAMES 16
539 These flags can be passed in AVCodecContext.flags before initialization.
540 Note: Not everything is supported yet.
543 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
544 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
545 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
546 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
547 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
548 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
550 * The parent program guarantees that the input for B-frames containing
551 * streams is not written to for at least s->max_b_frames+1 frames, if
552 * this is not set the input will be copied.
554 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
555 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
556 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
557 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
558 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
559 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
560 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
561 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
562 location instead of only at frame boundaries. */
563 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
564 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
565 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
566 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
567 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
568 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
569 /* Fx : Flag for h263+ extra options */
570 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
571 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
572 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
573 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
574 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
575 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
576 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
577 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
578 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
579 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
580 #define CODEC_FLAG_CLOSED_GOP 0x80000000
581 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
582 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
583 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
584 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
585 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
586 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
587 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
588 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
589 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
590 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
591 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
592 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
593 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
594 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
595 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
596 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
597 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
598 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
599 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
600 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
601 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
602 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
604 /* Unsupported options :
605 * Syntax Arithmetic coding (SAC)
606 * Reference Picture Selection
607 * Independent Segment Decoding */
609 /* codec capabilities */
611 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
613 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
614 * If not set, it might not use get_buffer() at all or use operations that
615 * assume the buffer was allocated by avcodec_default_get_buffer.
617 #define CODEC_CAP_DR1 0x0002
618 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
619 #define CODEC_CAP_PARSE_ONLY 0x0004
620 #define CODEC_CAP_TRUNCATED 0x0008
621 /* Codec can export data for HW decoding (XvMC). */
622 #define CODEC_CAP_HWACCEL 0x0010
624 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
625 * If this is not set, the codec is guaranteed to never be fed with NULL data.
627 #define CODEC_CAP_DELAY 0x0020
629 * Codec can be fed a final frame with a smaller size.
630 * This can be used to prevent truncation of the last audio samples.
632 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
634 * Codec can export data for HW decoding (VDPAU).
636 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
638 * Codec can output multiple frames per AVPacket
639 * Normally demuxers return one frame at a time, demuxers which do not do
640 * are connected to a parser to split what they return into proper frames.
641 * This flag is reserved to the very rare category of codecs which have a
642 * bitstream that cannot be split into frames without timeconsuming
643 * operations like full decoding. Demuxers carring such bitstreams thus
644 * may return multiple frames in a packet. This has many disadvantages like
645 * prohibiting stream copy in many cases thus it should only be considered
648 #define CODEC_CAP_SUBFRAMES 0x0100
650 * Codec is experimental and is thus avoided in favor of non experimental
653 #define CODEC_CAP_EXPERIMENTAL 0x0200
655 //The following defines may change, don't expect compatibility if you use them.
656 #define MB_TYPE_INTRA4x4 0x0001
657 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
658 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
659 #define MB_TYPE_16x16 0x0008
660 #define MB_TYPE_16x8 0x0010
661 #define MB_TYPE_8x16 0x0020
662 #define MB_TYPE_8x8 0x0040
663 #define MB_TYPE_INTERLACED 0x0080
664 #define MB_TYPE_DIRECT2 0x0100 //FIXME
665 #define MB_TYPE_ACPRED 0x0200
666 #define MB_TYPE_GMC 0x0400
667 #define MB_TYPE_SKIP 0x0800
668 #define MB_TYPE_P0L0 0x1000
669 #define MB_TYPE_P1L0 0x2000
670 #define MB_TYPE_P0L1 0x4000
671 #define MB_TYPE_P1L1 0x8000
672 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
673 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
674 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
675 #define MB_TYPE_QUANT 0x00010000
676 #define MB_TYPE_CBP 0x00020000
677 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
681 * This specifies the area which should be displayed.
682 * Note there may be multiple such areas for one frame.
684 typedef struct AVPanScan{
687 * - encoding: Set by user.
688 * - decoding: Set by libavcodec.
693 * width and height in 1/16 pel
694 * - encoding: Set by user.
695 * - decoding: Set by libavcodec.
701 * position of the top left corner in 1/16 pel for up to 3 fields/frames
702 * - encoding: Set by user.
703 * - decoding: Set by libavcodec.
705 int16_t position[3][2];
708 #define FF_COMMON_FRAME \
710 * pointer to the picture planes.\
711 * This might be different from the first allocated byte\
718 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
719 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
725 * 1 -> keyframe, 0-> not\
726 * - encoding: Set by libavcodec.\
727 * - decoding: Set by libavcodec.\
732 * Picture type of the frame, see ?_TYPE below.\
733 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
734 * - decoding: Set by libavcodec.\
739 * presentation timestamp in time_base units (time when frame should be shown to user)\
740 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
741 * - encoding: MUST be set by user.\
742 * - decoding: Set by libavcodec.\
747 * picture number in bitstream order\
748 * - encoding: set by\
749 * - decoding: Set by libavcodec.\
751 int coded_picture_number;\
753 * picture number in display order\
754 * - encoding: set by\
755 * - decoding: Set by libavcodec.\
757 int display_picture_number;\
760 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
761 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
762 * - decoding: Set by libavcodec.\
767 * buffer age (1->was last buffer and dint change, 2->..., ...).\
768 * Set to INT_MAX if the buffer has not been used yet.\
769 * - encoding: unused\
770 * - decoding: MUST be set by get_buffer().\
775 * is this picture used as reference\
776 * The values for this are the same as the MpegEncContext.picture_structure\
777 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
778 * Set to 4 for delayed, non-reference frames.\
779 * - encoding: unused\
780 * - decoding: Set by libavcodec. (before get_buffer() call)).\
786 * - encoding: unused\
787 * - decoding: Set by libavcodec.\
789 int8_t *qscale_table;\
792 * - encoding: unused\
793 * - decoding: Set by libavcodec.\
798 * mbskip_table[mb]>=1 if MB didn't change\
799 * stride= mb_width = (width+15)>>4\
800 * - encoding: unused\
801 * - decoding: Set by libavcodec.\
803 uint8_t *mbskip_table;\
806 * motion vector table\
809 * int mv_sample_log2= 4 - motion_subsample_log2;\
810 * int mb_width= (width+15)>>4;\
811 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
812 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
814 * - encoding: Set by user.\
815 * - decoding: Set by libavcodec.\
817 int16_t (*motion_val[2])[2];\
820 * macroblock type table\
821 * mb_type_base + mb_width + 2\
822 * - encoding: Set by user.\
823 * - decoding: Set by libavcodec.\
828 * log2 of the size of the block which a single vector in motion_val represents: \
829 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
830 * - encoding: unused\
831 * - decoding: Set by libavcodec.\
833 uint8_t motion_subsample_log2;\
836 * for some private data of the user\
837 * - encoding: unused\
838 * - decoding: Set by user.\
844 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
845 * - decoding: unused\
850 * type of the buffer (to keep track of who has to deallocate data[*])\
851 * - encoding: Set by the one who allocates it.\
852 * - decoding: Set by the one who allocates it.\
853 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
858 * When decoding, this signals how much the picture must be delayed.\
859 * extra_delay = repeat_pict / (2*fps)\
860 * - encoding: unused\
861 * - decoding: Set by libavcodec.\
871 * The content of the picture is interlaced.\
872 * - encoding: Set by user.\
873 * - decoding: Set by libavcodec. (default 0)\
875 int interlaced_frame;\
878 * If the content is interlaced, is top field displayed first.\
879 * - encoding: Set by user.\
880 * - decoding: Set by libavcodec.\
882 int top_field_first;\
886 * - encoding: Set by user.\
887 * - decoding: Set by libavcodec.\
889 AVPanScan *pan_scan;\
892 * Tell user application that palette has changed from previous frame.\
893 * - encoding: ??? (no palette-enabled encoder yet)\
894 * - decoding: Set by libavcodec. (default 0).\
896 int palette_has_changed;\
899 * codec suggestion on buffer type if != 0\
900 * - encoding: unused\
901 * - decoding: Set by libavcodec. (before get_buffer() call)).\
907 * - encoding: unused\
908 * - decoding: Set by libavcodec.\
913 * motion reference frame index\
914 * the order in which these are stored can depend on the codec.\
915 * - encoding: Set by user.\
916 * - decoding: Set by libavcodec.\
918 int8_t *ref_index[2];\
921 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
922 * output in AVFrame.reordered_opaque\
923 * - encoding: unused\
924 * - decoding: Read by user.\
926 int64_t reordered_opaque;\
929 * hardware accelerator private data (FFmpeg allocated)\
930 * - encoding: unused\
931 * - decoding: Set by libavcodec\
933 void *hwaccel_picture_private;\
936 #define FF_QSCALE_TYPE_MPEG1 0
937 #define FF_QSCALE_TYPE_MPEG2 1
938 #define FF_QSCALE_TYPE_H264 2
939 #define FF_QSCALE_TYPE_VP56 3
941 #define FF_BUFFER_TYPE_INTERNAL 1
942 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
943 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
944 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
947 #define FF_I_TYPE 1 ///< Intra
948 #define FF_P_TYPE 2 ///< Predicted
949 #define FF_B_TYPE 3 ///< Bi-dir predicted
950 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
951 #define FF_SI_TYPE 5 ///< Switching Intra
952 #define FF_SP_TYPE 6 ///< Switching Predicted
955 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
956 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
957 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
958 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
960 typedef struct AVPacket {
962 * Presentation timestamp in AVStream->time_base units; the time at which
963 * the decompressed packet will be presented to the user.
964 * Can be AV_NOPTS_VALUE if it is not stored in the file.
965 * pts MUST be larger or equal to dts as presentation cannot happen before
966 * decompression, unless one wants to view hex dumps. Some formats misuse
967 * the terms dts and pts/cts to mean something different. Such timestamps
968 * must be converted to true pts/dts before they are stored in AVPacket.
972 * Decompression timestamp in AVStream->time_base units; the time at which
973 * the packet is decompressed.
974 * Can be AV_NOPTS_VALUE if it is not stored in the file.
982 * Duration of this packet in AVStream->time_base units, 0 if unknown.
983 * Equals next_pts - this_pts in presentation order.
986 void (*destruct)(struct AVPacket *);
988 int64_t pos; ///< byte position in stream, -1 if unknown
991 * Time difference in AVStream->time_base units from the pts of this
992 * packet to the point at which the output from the decoder has converged
993 * independent from the availability of previous frames. That is, the
994 * frames are virtually identical no matter if decoding started from
995 * the very first frame or from this keyframe.
996 * Is AV_NOPTS_VALUE if unknown.
997 * This field is not the display duration of the current packet.
998 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1001 * The purpose of this field is to allow seeking in streams that have no
1002 * keyframes in the conventional sense. It corresponds to the
1003 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1004 * essential for some types of subtitle streams to ensure that all
1005 * subtitles are correctly displayed after seeking.
1007 int64_t convergence_duration;
1009 #define AV_PKT_FLAG_KEY 0x0001
1010 #if LIBAVCODEC_VERSION_MAJOR < 53
1011 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
1015 * Audio Video Frame.
1016 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1018 * Removal, reordering and changes to existing fields require a major
1019 * version bump. No fields should be added into AVFrame before or after
1021 * sizeof(AVFrame) must not be used outside libav*.
1023 typedef struct AVFrame {
1028 * main external API structure.
1029 * New fields can be added to the end with minor version bumps.
1030 * Removal, reordering and changes to existing fields require a major
1032 * sizeof(AVCodecContext) must not be used outside libav*.
1034 typedef struct AVCodecContext {
1036 * information on struct for av_log
1037 * - set by avcodec_alloc_context
1039 const AVClass *av_class;
1041 * the average bitrate
1042 * - encoding: Set by user; unused for constant quantizer encoding.
1043 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1048 * number of bits the bitstream is allowed to diverge from the reference.
1049 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1050 * - encoding: Set by user; unused for constant quantizer encoding.
1051 * - decoding: unused
1053 int bit_rate_tolerance;
1057 * - encoding: Set by user.
1058 * - decoding: Set by user.
1063 * Some codecs need additional format info. It is stored here.
1064 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1065 * specific codec MUST set it correctly otherwise stream copy breaks.
1066 * In general use of this field by muxers is not recommanded.
1067 * - encoding: Set by libavcodec.
1068 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1073 * Motion estimation algorithm used for video coding.
1074 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1075 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1076 * - encoding: MUST be set by user.
1077 * - decoding: unused
1082 * some codecs need / can use extradata like Huffman tables.
1083 * mjpeg: Huffman tables
1084 * rv10: additional flags
1085 * mpeg4: global headers (they can be in the bitstream or here)
1086 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1087 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1088 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1089 * - encoding: Set/allocated/freed by libavcodec.
1090 * - decoding: Set/allocated/freed by user.
1096 * This is the fundamental unit of time (in seconds) in terms
1097 * of which frame timestamps are represented. For fixed-fps content,
1098 * timebase should be 1/framerate and timestamp increments should be
1100 * - encoding: MUST be set by user.
1101 * - decoding: Set by libavcodec.
1103 AVRational time_base;
1107 * picture width / height.
1108 * - encoding: MUST be set by user.
1109 * - decoding: Set by libavcodec.
1110 * Note: For compatibility it is possible to set this instead of
1111 * coded_width/height before decoding.
1115 #define FF_ASPECT_EXTENDED 15
1118 * the number of pictures in a group of pictures, or 0 for intra_only
1119 * - encoding: Set by user.
1120 * - decoding: unused
1125 * Pixel format, see PIX_FMT_xxx.
1126 * May be set by the demuxer if known from headers.
1127 * May be overriden by the decoder if it knows better.
1128 * - encoding: Set by user.
1129 * - decoding: Set by user if known, overridden by libavcodec if known
1131 enum PixelFormat pix_fmt;
1134 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1135 * has to read frames at native frame rate.
1136 * - encoding: Set by user.
1137 * - decoding: unused
1142 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1143 * decoder to draw a horizontal band. It improves cache usage. Not
1144 * all codecs can do that. You must check the codec capabilities
1146 * The function is also used by hardware acceleration APIs.
1147 * It is called at least once during frame decoding to pass
1148 * the data needed for hardware render.
1149 * In that mode instead of pixel data, AVFrame points to
1150 * a structure specific to the acceleration API. The application
1151 * reads the structure and can change some fields to indicate progress
1153 * - encoding: unused
1154 * - decoding: Set by user.
1155 * @param height the height of the slice
1156 * @param y the y position of the slice
1157 * @param type 1->top field, 2->bottom field, 3->frame
1158 * @param offset offset into the AVFrame.data from which the slice should be read
1160 void (*draw_horiz_band)(struct AVCodecContext *s,
1161 const AVFrame *src, int offset[4],
1162 int y, int type, int height);
1165 int sample_rate; ///< samples per second
1166 int channels; ///< number of audio channels
1169 * audio sample format
1170 * - encoding: Set by user.
1171 * - decoding: Set by libavcodec.
1173 enum SampleFormat sample_fmt; ///< sample format
1175 /* The following data should not be initialized. */
1177 * Samples per packet, initialized when calling 'init'.
1180 int frame_number; ///< audio or video frame number
1181 #if LIBAVCODEC_VERSION_MAJOR < 53
1182 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1186 * Number of frames the decoded output will be delayed relative to
1187 * the encoded input.
1188 * - encoding: Set by libavcodec.
1189 * - decoding: unused
1193 /* - encoding parameters */
1194 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1195 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1199 * - encoding: Set by user.
1200 * - decoding: unused
1206 * - encoding: Set by user.
1207 * - decoding: unused
1212 * maximum quantizer difference between frames
1213 * - encoding: Set by user.
1214 * - decoding: unused
1219 * maximum number of B-frames between non-B-frames
1220 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1221 * - encoding: Set by user.
1222 * - decoding: unused
1227 * qscale factor between IP and B-frames
1228 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1229 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1230 * - encoding: Set by user.
1231 * - decoding: unused
1233 float b_quant_factor;
1235 /** obsolete FIXME remove */
1237 #define FF_RC_STRATEGY_XVID 1
1239 int b_frame_strategy;
1243 * - encoding: unused
1244 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1245 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1249 struct AVCodec *codec;
1253 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1254 /* do its best to deliver a chunk with size */
1255 /* below rtp_payload_size, the chunk will start */
1256 /* with a start code on some codecs like H.263. */
1257 /* This doesn't take account of any particular */
1258 /* headers inside the transmitted RTP payload. */
1261 /* The RTP callback: This function is called */
1262 /* every time the encoder has a packet to send. */
1263 /* It depends on the encoder if the data starts */
1264 /* with a Start Code (it should). H.263 does. */
1265 /* mb_nb contains the number of macroblocks */
1266 /* encoded in the RTP payload. */
1267 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1269 /* statistics, used for 2-pass encoding */
1280 * number of bits used for the previously encoded frame
1281 * - encoding: Set by libavcodec.
1282 * - decoding: unused
1287 * Private data of the user, can be used to carry app specific stuff.
1288 * - encoding: Set by user.
1289 * - decoding: Set by user.
1293 char codec_name[32];
1294 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1295 enum CodecID codec_id; /* see CODEC_ID_xxx */
1298 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1299 * This is used to work around some encoder bugs.
1300 * A demuxer should set this to what is stored in the field used to identify the codec.
1301 * If there are multiple such fields in a container then the demuxer should choose the one
1302 * which maximizes the information about the used codec.
1303 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1304 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1305 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1307 * - encoding: Set by user, if not then the default based on codec_id will be used.
1308 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1310 unsigned int codec_tag;
1313 * Work around bugs in encoders which sometimes cannot be detected automatically.
1314 * - encoding: Set by user
1315 * - decoding: Set by user
1317 int workaround_bugs;
1318 #define FF_BUG_AUTODETECT 1 ///< autodetection
1319 #define FF_BUG_OLD_MSMPEG4 2
1320 #define FF_BUG_XVID_ILACE 4
1321 #define FF_BUG_UMP4 8
1322 #define FF_BUG_NO_PADDING 16
1323 #define FF_BUG_AMV 32
1324 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1325 #define FF_BUG_QPEL_CHROMA 64
1326 #define FF_BUG_STD_QPEL 128
1327 #define FF_BUG_QPEL_CHROMA2 256
1328 #define FF_BUG_DIRECT_BLOCKSIZE 512
1329 #define FF_BUG_EDGE 1024
1330 #define FF_BUG_HPEL_CHROMA 2048
1331 #define FF_BUG_DC_CLIP 4096
1332 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1333 #define FF_BUG_TRUNCATED 16384
1334 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1337 * luma single coefficient elimination threshold
1338 * - encoding: Set by user.
1339 * - decoding: unused
1341 int luma_elim_threshold;
1344 * chroma single coeff elimination threshold
1345 * - encoding: Set by user.
1346 * - decoding: unused
1348 int chroma_elim_threshold;
1351 * strictly follow the standard (MPEG4, ...).
1352 * - encoding: Set by user.
1353 * - decoding: Set by user.
1354 * Setting this to STRICT or higher means the encoder and decoder will
1355 * generally do stupid things, whereas setting it to unofficial or lower
1356 * will mean the encoder might produce output that is not supported by all
1357 * spec-compliant decoders. Decoders don't differentiate between normal,
1358 * unofficial and experimental (that is, they always try to decode things
1359 * when they can) unless they are explicitly asked to behave stupidly
1360 * (=strictly conform to the specs)
1362 int strict_std_compliance;
1363 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1364 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1365 #define FF_COMPLIANCE_NORMAL 0
1366 #if LIBAVCODEC_VERSION_MAJOR < 53
1367 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions (deprecated - use FF_COMPLIANCE_UNOFFICIAL instead).
1369 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1370 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1373 * qscale offset between IP and B-frames
1374 * - encoding: Set by user.
1375 * - decoding: unused
1377 float b_quant_offset;
1380 * Error recognization; higher values will detect more errors but may
1381 * misdetect some more or less valid parts as errors.
1382 * - encoding: unused
1383 * - decoding: Set by user.
1385 int error_recognition;
1386 #define FF_ER_CAREFUL 1
1387 #define FF_ER_COMPLIANT 2
1388 #define FF_ER_AGGRESSIVE 3
1389 #define FF_ER_VERY_AGGRESSIVE 4
1392 * Called at the beginning of each frame to get a buffer for it.
1393 * If pic.reference is set then the frame will be read later by libavcodec.
1394 * avcodec_align_dimensions2() should be used to find the required width and
1395 * height, as they normally need to be rounded up to the next multiple of 16.
1396 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1397 * avcodec_default_get_buffer() instead of providing buffers allocated by
1399 * - encoding: unused
1400 * - decoding: Set by libavcodec., user can override.
1402 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1405 * Called to release buffers which were allocated with get_buffer.
1406 * A released buffer can be reused in get_buffer().
1407 * pic.data[*] must be set to NULL.
1408 * - encoding: unused
1409 * - decoding: Set by libavcodec., user can override.
1411 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1414 * Size of the frame reordering buffer in the decoder.
1415 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1416 * - encoding: Set by libavcodec.
1417 * - decoding: Set by libavcodec.
1422 * number of bytes per packet if constant and known or 0
1423 * Used by some WAV based audio codecs.
1427 int parse_only; /* - decoding only: If true, only parsing is done
1428 (function avcodec_parse_frame()). The frame
1429 data is returned. Only MPEG codecs support this now. */
1432 * 0-> h263 quant 1-> mpeg quant
1433 * - encoding: Set by user.
1434 * - decoding: unused
1439 * pass1 encoding statistics output buffer
1440 * - encoding: Set by libavcodec.
1441 * - decoding: unused
1446 * pass2 encoding statistics input buffer
1447 * Concatenated stuff from stats_out of pass1 should be placed here.
1448 * - encoding: Allocated/set/freed by user.
1449 * - decoding: unused
1454 * ratecontrol qmin qmax limiting method
1455 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1456 * - encoding: Set by user.
1457 * - decoding: unused
1465 * ratecontrol override, see RcOverride
1466 * - encoding: Allocated/set/freed by user.
1467 * - decoding: unused
1469 RcOverride *rc_override;
1470 int rc_override_count;
1473 * rate control equation
1474 * - encoding: Set by user
1475 * - decoding: unused
1481 * - encoding: Set by user.
1482 * - decoding: unused
1488 * - encoding: Set by user.
1489 * - decoding: unused
1494 * decoder bitstream buffer size
1495 * - encoding: Set by user.
1496 * - decoding: unused
1499 float rc_buffer_aggressivity;
1502 * qscale factor between P and I-frames
1503 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1504 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1505 * - encoding: Set by user.
1506 * - decoding: unused
1508 float i_quant_factor;
1511 * qscale offset between P and I-frames
1512 * - encoding: Set by user.
1513 * - decoding: unused
1515 float i_quant_offset;
1518 * initial complexity for pass1 ratecontrol
1519 * - encoding: Set by user.
1520 * - decoding: unused
1522 float rc_initial_cplx;
1525 * DCT algorithm, see FF_DCT_* below
1526 * - encoding: Set by user.
1527 * - decoding: unused
1530 #define FF_DCT_AUTO 0
1531 #define FF_DCT_FASTINT 1
1532 #define FF_DCT_INT 2
1533 #define FF_DCT_MMX 3
1534 #define FF_DCT_MLIB 4
1535 #define FF_DCT_ALTIVEC 5
1536 #define FF_DCT_FAAN 6
1539 * luminance masking (0-> disabled)
1540 * - encoding: Set by user.
1541 * - decoding: unused
1546 * temporary complexity masking (0-> disabled)
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 float temporal_cplx_masking;
1553 * spatial complexity masking (0-> disabled)
1554 * - encoding: Set by user.
1555 * - decoding: unused
1557 float spatial_cplx_masking;
1560 * p block masking (0-> disabled)
1561 * - encoding: Set by user.
1562 * - decoding: unused
1567 * darkness masking (0-> disabled)
1568 * - encoding: Set by user.
1569 * - decoding: unused
1574 * IDCT algorithm, see FF_IDCT_* below.
1575 * - encoding: Set by user.
1576 * - decoding: Set by user.
1579 #define FF_IDCT_AUTO 0
1580 #define FF_IDCT_INT 1
1581 #define FF_IDCT_SIMPLE 2
1582 #define FF_IDCT_SIMPLEMMX 3
1583 #define FF_IDCT_LIBMPEG2MMX 4
1584 #define FF_IDCT_PS2 5
1585 #define FF_IDCT_MLIB 6
1586 #define FF_IDCT_ARM 7
1587 #define FF_IDCT_ALTIVEC 8
1588 #define FF_IDCT_SH4 9
1589 #define FF_IDCT_SIMPLEARM 10
1590 #define FF_IDCT_H264 11
1591 #define FF_IDCT_VP3 12
1592 #define FF_IDCT_IPP 13
1593 #define FF_IDCT_XVIDMMX 14
1594 #define FF_IDCT_CAVS 15
1595 #define FF_IDCT_SIMPLEARMV5TE 16
1596 #define FF_IDCT_SIMPLEARMV6 17
1597 #define FF_IDCT_SIMPLEVIS 18
1598 #define FF_IDCT_WMV2 19
1599 #define FF_IDCT_FAAN 20
1600 #define FF_IDCT_EA 21
1601 #define FF_IDCT_SIMPLENEON 22
1602 #define FF_IDCT_SIMPLEALPHA 23
1603 #define FF_IDCT_BINK 24
1607 * - encoding: Set by libavcodec.
1608 * - decoding: Set by user (or 0).
1612 * slice offsets in the frame in bytes
1613 * - encoding: Set/allocated by libavcodec.
1614 * - decoding: Set/allocated by user (or NULL).
1619 * error concealment flags
1620 * - encoding: unused
1621 * - decoding: Set by user.
1623 int error_concealment;
1624 #define FF_EC_GUESS_MVS 1
1625 #define FF_EC_DEBLOCK 2
1628 * dsp_mask could be add used to disable unwanted CPU features
1629 * CPU features (i.e. MMX, SSE. ...)
1631 * With the FORCE flag you may instead enable given CPU features.
1632 * (Dangerous: Usable in case of misdetection, improper usage however will
1633 * result into program crash.)
1636 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1637 /* lower 16 bits - CPU features */
1638 #define FF_MM_MMX 0x0001 ///< standard MMX
1639 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1640 #if LIBAVCODEC_VERSION_MAJOR < 53
1641 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1643 #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
1644 #define FF_MM_SSE 0x0008 ///< SSE functions
1645 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1646 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1647 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1648 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1649 #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1650 #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
1651 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1652 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1655 * bits per sample/pixel from the demuxer (needed for huffyuv).
1656 * - encoding: Set by libavcodec.
1657 * - decoding: Set by user.
1659 int bits_per_coded_sample;
1662 * prediction method (needed for huffyuv)
1663 * - encoding: Set by user.
1664 * - decoding: unused
1666 int prediction_method;
1667 #define FF_PRED_LEFT 0
1668 #define FF_PRED_PLANE 1
1669 #define FF_PRED_MEDIAN 2
1672 * sample aspect ratio (0 if unknown)
1673 * That is the width of a pixel divided by the height of the pixel.
1674 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1675 * - encoding: Set by user.
1676 * - decoding: Set by libavcodec.
1678 AVRational sample_aspect_ratio;
1681 * the picture in the bitstream
1682 * - encoding: Set by libavcodec.
1683 * - decoding: Set by libavcodec.
1685 AVFrame *coded_frame;
1689 * - encoding: Set by user.
1690 * - decoding: Set by user.
1693 #define FF_DEBUG_PICT_INFO 1
1694 #define FF_DEBUG_RC 2
1695 #define FF_DEBUG_BITSTREAM 4
1696 #define FF_DEBUG_MB_TYPE 8
1697 #define FF_DEBUG_QP 16
1698 #define FF_DEBUG_MV 32
1699 #define FF_DEBUG_DCT_COEFF 0x00000040
1700 #define FF_DEBUG_SKIP 0x00000080
1701 #define FF_DEBUG_STARTCODE 0x00000100
1702 #define FF_DEBUG_PTS 0x00000200
1703 #define FF_DEBUG_ER 0x00000400
1704 #define FF_DEBUG_MMCO 0x00000800
1705 #define FF_DEBUG_BUGS 0x00001000
1706 #define FF_DEBUG_VIS_QP 0x00002000
1707 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1708 #define FF_DEBUG_BUFFERS 0x00008000
1712 * - encoding: Set by user.
1713 * - decoding: Set by user.
1716 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1717 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1718 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1722 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1723 * - decoding: unused
1728 * minimum MB quantizer
1729 * - encoding: unused
1730 * - decoding: unused
1735 * maximum MB quantizer
1736 * - encoding: unused
1737 * - decoding: unused
1742 * motion estimation comparison function
1743 * - encoding: Set by user.
1744 * - decoding: unused
1748 * subpixel motion estimation comparison function
1749 * - encoding: Set by user.
1750 * - decoding: unused
1754 * macroblock comparison function (not supported yet)
1755 * - encoding: Set by user.
1756 * - decoding: unused
1760 * interlaced DCT comparison function
1761 * - encoding: Set by user.
1762 * - decoding: unused
1765 #define FF_CMP_SAD 0
1766 #define FF_CMP_SSE 1
1767 #define FF_CMP_SATD 2
1768 #define FF_CMP_DCT 3
1769 #define FF_CMP_PSNR 4
1770 #define FF_CMP_BIT 5
1772 #define FF_CMP_ZERO 7
1773 #define FF_CMP_VSAD 8
1774 #define FF_CMP_VSSE 9
1775 #define FF_CMP_NSSE 10
1776 #define FF_CMP_W53 11
1777 #define FF_CMP_W97 12
1778 #define FF_CMP_DCTMAX 13
1779 #define FF_CMP_DCT264 14
1780 #define FF_CMP_CHROMA 256
1783 * ME diamond size & shape
1784 * - encoding: Set by user.
1785 * - decoding: unused
1790 * amount of previous MV predictors (2a+1 x 2a+1 square)
1791 * - encoding: Set by user.
1792 * - decoding: unused
1794 int last_predictor_count;
1797 * prepass for motion estimation
1798 * - encoding: Set by user.
1799 * - decoding: unused
1804 * motion estimation prepass comparison function
1805 * - encoding: Set by user.
1806 * - decoding: unused
1811 * ME prepass diamond size & shape
1812 * - encoding: Set by user.
1813 * - decoding: unused
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 int me_subpel_quality;
1825 * callback to negotiate the pixelFormat
1826 * @param fmt is the list of formats which are supported by the codec,
1827 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1828 * The first is always the native one.
1829 * @return the chosen format
1830 * - encoding: unused
1831 * - decoding: Set by user, if not set the native format will be chosen.
1833 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1836 * DTG active format information (additional aspect ratio
1837 * information only used in DVB MPEG-2 transport streams)
1840 * - encoding: unused
1841 * - decoding: Set by decoder.
1843 int dtg_active_format;
1844 #define FF_DTG_AFD_SAME 8
1845 #define FF_DTG_AFD_4_3 9
1846 #define FF_DTG_AFD_16_9 10
1847 #define FF_DTG_AFD_14_9 11
1848 #define FF_DTG_AFD_4_3_SP_14_9 13
1849 #define FF_DTG_AFD_16_9_SP_14_9 14
1850 #define FF_DTG_AFD_SP_4_3 15
1853 * maximum motion estimation search range in subpel units
1854 * If 0 then no limit.
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * intra quantizer bias
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int intra_quant_bias;
1867 #define FF_DEFAULT_QUANT_BIAS 999999
1870 * inter quantizer bias
1871 * - encoding: Set by user.
1872 * - decoding: unused
1874 int inter_quant_bias;
1878 * - encoding: unused
1879 * - decoding: Which clrtable should be used for 8bit RGB images.
1880 * Tables have to be stored somewhere. FIXME
1885 * internal_buffer count
1886 * Don't touch, used by libavcodec default_get_buffer().
1888 int internal_buffer_count;
1892 * Don't touch, used by libavcodec default_get_buffer().
1894 void *internal_buffer;
1896 #define FF_LAMBDA_SHIFT 7
1897 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1898 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1899 #define FF_LAMBDA_MAX (256*128-1)
1901 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1903 * Global quality for codecs which cannot change it per frame.
1904 * This should be proportional to MPEG-1/2/4 qscale.
1905 * - encoding: Set by user.
1906 * - decoding: unused
1910 #define FF_CODER_TYPE_VLC 0
1911 #define FF_CODER_TYPE_AC 1
1912 #define FF_CODER_TYPE_RAW 2
1913 #define FF_CODER_TYPE_RLE 3
1914 #define FF_CODER_TYPE_DEFLATE 4
1917 * - encoding: Set by user.
1918 * - decoding: unused
1924 * - encoding: Set by user.
1925 * - decoding: unused
1931 * - encoding: unused
1932 * - decoding: Set by user.
1934 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1939 * - encoding: unused
1940 * - decoding: Set by user.
1943 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1944 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1945 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1948 * XVideo Motion Acceleration
1949 * - encoding: forbidden
1950 * - decoding: set by decoder
1952 int xvmc_acceleration;
1955 * macroblock decision mode
1956 * - encoding: Set by user.
1957 * - decoding: unused
1960 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1961 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1962 #define FF_MB_DECISION_RD 2 ///< rate distortion
1965 * custom intra quantization matrix
1966 * - encoding: Set by user, can be NULL.
1967 * - decoding: Set by libavcodec.
1969 uint16_t *intra_matrix;
1972 * custom inter quantization matrix
1973 * - encoding: Set by user, can be NULL.
1974 * - decoding: Set by libavcodec.
1976 uint16_t *inter_matrix;
1979 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1980 * This is used to work around some encoder bugs.
1981 * - encoding: unused
1982 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1984 unsigned int stream_codec_tag;
1987 * scene change detection threshold
1988 * 0 is default, larger means fewer detected scene changes.
1989 * - encoding: Set by user.
1990 * - decoding: unused
1992 int scenechange_threshold;
1995 * minimum Lagrange multipler
1996 * - encoding: Set by user.
1997 * - decoding: unused
2002 * maximum Lagrange multipler
2003 * - encoding: Set by user.
2004 * - decoding: unused
2009 * palette control structure
2010 * - encoding: ??? (no palette-enabled encoder yet)
2011 * - decoding: Set by user.
2013 struct AVPaletteControl *palctrl;
2016 * noise reduction strength
2017 * - encoding: Set by user.
2018 * - decoding: unused
2020 int noise_reduction;
2023 * Called at the beginning of a frame to get cr buffer for it.
2024 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2025 * libavcodec will pass previous buffer in pic, function should return
2026 * same buffer or new buffer with old frame "painted" into it.
2027 * If pic.data[0] == NULL must behave like get_buffer().
2028 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2029 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2031 * - encoding: unused
2032 * - decoding: Set by libavcodec., user can override
2034 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2037 * Number of bits which should be loaded into the rc buffer before decoding starts.
2038 * - encoding: Set by user.
2039 * - decoding: unused
2041 int rc_initial_buffer_occupancy;
2045 * - encoding: Set by user.
2046 * - decoding: unused
2048 int inter_threshold;
2052 * - encoding: Set by user.
2053 * - decoding: Set by user.
2058 * Simulates errors in the bitstream to test error concealment.
2059 * - encoding: Set by user.
2060 * - decoding: unused
2065 * MP3 antialias algorithm, see FF_AA_* below.
2066 * - encoding: unused
2067 * - decoding: Set by user.
2070 #define FF_AA_AUTO 0
2071 #define FF_AA_FASTINT 1 //not implemented yet
2073 #define FF_AA_FLOAT 3
2075 * quantizer noise shaping
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 int quantizer_noise_shaping;
2083 * is used to decide how many independent tasks should be passed to execute()
2084 * - encoding: Set by user.
2085 * - decoding: Set by user.
2090 * The codec may call this to execute several independent things.
2091 * It will return only after finishing all tasks.
2092 * The user may replace this with some multithreaded implementation,
2093 * the default implementation will execute the parts serially.
2094 * @param count the number of things to execute
2095 * - encoding: Set by libavcodec, user can override.
2096 * - decoding: Set by libavcodec, user can override.
2098 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2102 * Can be used by execute() to store some per AVCodecContext stuff.
2103 * - encoding: set by execute()
2104 * - decoding: set by execute()
2106 void *thread_opaque;
2109 * Motion estimation threshold below which no motion estimation is
2110 * performed, but instead the user specified motion vectors are used.
2112 * - encoding: Set by user.
2113 * - decoding: unused
2118 * Macroblock threshold below which the user specified macroblock types will be used.
2119 * - encoding: Set by user.
2120 * - decoding: unused
2125 * precision of the intra DC coefficient - 8
2126 * - encoding: Set by user.
2127 * - decoding: unused
2129 int intra_dc_precision;
2132 * noise vs. sse weight for the nsse comparsion function
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * Number of macroblock rows at the top which are skipped.
2140 * - encoding: unused
2141 * - decoding: Set by user.
2146 * Number of macroblock rows at the bottom which are skipped.
2147 * - encoding: unused
2148 * - decoding: Set by user.
2154 * - encoding: Set by user.
2155 * - decoding: Set by libavcodec.
2158 #define FF_PROFILE_UNKNOWN -99
2160 #define FF_PROFILE_AAC_MAIN 0
2161 #define FF_PROFILE_AAC_LOW 1
2162 #define FF_PROFILE_AAC_SSR 2
2163 #define FF_PROFILE_AAC_LTP 3
2165 #define FF_PROFILE_H264_BASELINE 66
2166 #define FF_PROFILE_H264_MAIN 77
2167 #define FF_PROFILE_H264_EXTENDED 88
2168 #define FF_PROFILE_H264_HIGH 100
2169 #define FF_PROFILE_H264_HIGH_10 110
2170 #define FF_PROFILE_H264_HIGH_422 122
2171 #define FF_PROFILE_H264_HIGH_444 244
2172 #define FF_PROFILE_H264_CAVLC_444 44
2176 * - encoding: Set by user.
2177 * - decoding: Set by libavcodec.
2180 #define FF_LEVEL_UNKNOWN -99
2183 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2184 * - encoding: unused
2185 * - decoding: Set by user.
2190 * Bitstream width / height, may be different from width/height if lowres
2191 * or other things are used.
2192 * - encoding: unused
2193 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2195 int coded_width, coded_height;
2198 * frame skip threshold
2199 * - encoding: Set by user.
2200 * - decoding: unused
2202 int frame_skip_threshold;
2206 * - encoding: Set by user.
2207 * - decoding: unused
2209 int frame_skip_factor;
2212 * frame skip exponent
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * frame skip comparison function
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * Border processing masking, raises the quantizer for mbs on the borders
2228 * - encoding: Set by user.
2229 * - decoding: unused
2231 float border_masking;
2234 * minimum MB lagrange multipler
2235 * - encoding: Set by user.
2236 * - decoding: unused
2241 * maximum MB lagrange multipler
2242 * - encoding: Set by user.
2243 * - decoding: unused
2249 * - encoding: Set by user.
2250 * - decoding: unused
2252 int me_penalty_compensation;
2256 * - encoding: unused
2257 * - decoding: Set by user.
2259 enum AVDiscard skip_loop_filter;
2263 * - encoding: unused
2264 * - decoding: Set by user.
2266 enum AVDiscard skip_idct;
2270 * - encoding: unused
2271 * - decoding: Set by user.
2273 enum AVDiscard skip_frame;
2277 * - encoding: Set by user.
2278 * - decoding: unused
2284 * - encoding: Set by user.
2285 * - decoding: unused
2290 * constant rate factor - quality-based VBR - values ~correspond to qps
2291 * - encoding: Set by user.
2292 * - decoding: unused
2297 * constant quantization parameter rate control method
2298 * - encoding: Set by user.
2299 * - decoding: unused
2305 * - encoding: Set by user.
2306 * - decoding: unused
2311 * number of reference frames
2312 * - encoding: Set by user.
2313 * - decoding: Set by lavc.
2318 * chroma qp offset from luma
2319 * - encoding: Set by user.
2320 * - decoding: unused
2325 * Influences how often B-frames are used.
2326 * - encoding: Set by user.
2327 * - decoding: unused
2332 * trellis RD quantization
2333 * - encoding: Set by user.
2334 * - decoding: unused
2339 * Reduce fluctuations in qp (before curve compression).
2340 * - encoding: Set by user.
2341 * - decoding: unused
2343 float complexityblur;
2346 * in-loop deblocking filter alphac0 parameter
2347 * alpha is in the range -6...6
2348 * - encoding: Set by user.
2349 * - decoding: unused
2354 * in-loop deblocking filter beta parameter
2355 * beta is in the range -6...6
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2363 * - encoding: Set by user.
2364 * - decoding: unused
2367 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2368 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2369 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2370 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2371 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2374 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2375 * - encoding: Set by user.
2376 * - decoding: unused
2381 * Audio cutoff bandwidth (0 means "automatic")
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * Multiplied by qscale for each frame and added to scene_change_score.
2389 * - encoding: Set by user.
2390 * - decoding: unused
2392 int scenechange_factor;
2396 * Note: Value depends upon the compare function used for fullpel ME.
2397 * - encoding: Set by user.
2398 * - decoding: unused
2403 * Adjusts sensitivity of b_frame_strategy 1.
2404 * - encoding: Set by user.
2405 * - decoding: unused
2410 * - encoding: Set by user.
2411 * - decoding: unused
2413 int compression_level;
2414 #define FF_COMPRESSION_DEFAULT -1
2417 * Sets whether to use LPC mode - used by FLAC encoder.
2418 * - encoding: Set by user.
2419 * - decoding: unused
2424 * LPC coefficient precision - used by FLAC encoder
2425 * - encoding: Set by user.
2426 * - decoding: unused
2428 int lpc_coeff_precision;
2431 * - encoding: Set by user.
2432 * - decoding: unused
2434 int min_prediction_order;
2437 * - encoding: Set by user.
2438 * - decoding: unused
2440 int max_prediction_order;
2443 * search method for selecting prediction order
2444 * - encoding: Set by user.
2445 * - decoding: unused
2447 int prediction_order_method;
2450 * - encoding: Set by user.
2451 * - decoding: unused
2453 int min_partition_order;
2456 * - encoding: Set by user.
2457 * - decoding: unused
2459 int max_partition_order;
2462 * GOP timecode frame start number, in non drop frame format
2463 * - encoding: Set by user.
2464 * - decoding: unused
2466 int64_t timecode_frame_start;
2468 #if LIBAVCODEC_VERSION_MAJOR < 53
2470 * Decoder should decode to this many channels if it can (0 for default)
2471 * - encoding: unused
2472 * - decoding: Set by user.
2473 * @deprecated Deprecated in favor of request_channel_layout.
2475 int request_channels;
2479 * Percentage of dynamic range compression to be applied by the decoder.
2480 * The default value is 1.0, corresponding to full compression.
2481 * - encoding: unused
2482 * - decoding: Set by user.
2487 * opaque 64bit number (generally a PTS) that will be reordered and
2488 * output in AVFrame.reordered_opaque
2489 * - encoding: unused
2490 * - decoding: Set by user.
2492 int64_t reordered_opaque;
2495 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2496 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2497 * - encoding: set by user.
2498 * - decoding: set by libavcodec.
2500 int bits_per_raw_sample;
2503 * Audio channel layout.
2504 * - encoding: set by user.
2505 * - decoding: set by libavcodec.
2507 int64_t channel_layout;
2510 * Request decoder to use this channel layout if it can (0 for default)
2511 * - encoding: unused
2512 * - decoding: Set by user.
2514 int64_t request_channel_layout;
2517 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2518 * - encoding: Set by user.
2519 * - decoding: unused.
2521 float rc_max_available_vbv_use;
2524 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2525 * - encoding: Set by user.
2526 * - decoding: unused.
2528 float rc_min_vbv_overflow_use;
2531 * Hardware accelerator in use
2532 * - encoding: unused.
2533 * - decoding: Set by libavcodec
2535 struct AVHWAccel *hwaccel;
2538 * For some codecs, the time base is closer to the field rate than the frame rate.
2539 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2540 * if no telecine is used ...
2542 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2544 int ticks_per_frame;
2547 * Hardware accelerator context.
2548 * For some hardware accelerators, a global context needs to be
2549 * provided by the user. In that case, this holds display-dependent
2550 * data FFmpeg cannot instantiate itself. Please refer to the
2551 * FFmpeg HW accelerator documentation to know how to fill this
2552 * is. e.g. for VA API, this is a struct vaapi_context.
2553 * - encoding: unused
2554 * - decoding: Set by user
2556 void *hwaccel_context;
2559 * Chromaticity coordinates of the source primaries.
2560 * - encoding: Set by user
2561 * - decoding: Set by libavcodec
2563 enum AVColorPrimaries color_primaries;
2566 * Color Transfer Characteristic.
2567 * - encoding: Set by user
2568 * - decoding: Set by libavcodec
2570 enum AVColorTransferCharacteristic color_trc;
2573 * YUV colorspace type.
2574 * - encoding: Set by user
2575 * - decoding: Set by libavcodec
2577 enum AVColorSpace colorspace;
2580 * MPEG vs JPEG YUV range.
2581 * - encoding: Set by user
2582 * - decoding: Set by libavcodec
2584 enum AVColorRange color_range;
2587 * This defines the location of chroma samples.
2588 * - encoding: Set by user
2589 * - decoding: Set by libavcodec
2591 enum AVChromaLocation chroma_sample_location;
2594 * The codec may call this to execute several independent things.
2595 * It will return only after finishing all tasks.
2596 * The user may replace this with some multithreaded implementation,
2597 * the default implementation will execute the parts serially.
2598 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2599 * @param c context passed also to func
2600 * @param count the number of things to execute
2601 * @param arg2 argument passed unchanged to func
2602 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2603 * @param func function that will be called count times, with jobnr from 0 to count-1.
2604 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2605 * two instances of func executing at the same time will have the same threadnr.
2606 * @return always 0 currently, but code should handle a future improvement where when any call to func
2607 * returns < 0 no further calls to func may be done and < 0 is returned.
2608 * - encoding: Set by libavcodec, user can override.
2609 * - decoding: Set by libavcodec, user can override.
2611 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2614 * explicit P-frame weighted prediction analysis method
2616 * 1: fast blind weighting (one reference duplicate with -1 offset)
2617 * 2: smart weighting (full fade detection analysis)
2618 * - encoding: Set by user.
2619 * - decoding: unused
2621 int weighted_p_pred;
2626 * 1: Variance AQ (complexity mask)
2627 * 2: Auto-variance AQ (experimental)
2628 * - encoding: Set by user
2629 * - decoding: unused
2635 * Reduces blocking and blurring in flat and textured areas.
2636 * - encoding: Set by user
2637 * - decoding: unused
2643 * Strength of psychovisual optimization
2644 * - encoding: Set by user
2645 * - decoding: unused
2651 * Strength of psychovisual optimization
2652 * - encoding: Set by user
2653 * - decoding: unused
2659 * Number of frames for frametype and ratecontrol lookahead
2660 * - encoding: Set by user
2661 * - decoding: unused
2666 * Constant rate factor maximum
2667 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2668 * than crf_max, even if doing so would violate VBV restrictions.
2669 * - encoding: Set by user.
2670 * - decoding: unused
2674 int log_level_offset;
2680 typedef struct AVCodec {
2682 * Name of the codec implementation.
2683 * The name is globally unique among encoders and among decoders (but an
2684 * encoder and a decoder can share the same name).
2685 * This is the primary way to find a codec from the user perspective.
2688 enum AVMediaType type;
2691 int (*init)(AVCodecContext *);
2692 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2693 int (*close)(AVCodecContext *);
2694 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2696 * Codec capabilities.
2700 struct AVCodec *next;
2703 * Will be called when seeking
2705 void (*flush)(AVCodecContext *);
2706 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2707 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2709 * Descriptive name for the codec, meant to be more human readable than name.
2710 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2712 const char *long_name;
2713 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2714 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2715 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2721 typedef struct AVHWAccel {
2723 * Name of the hardware accelerated codec.
2724 * The name is globally unique among encoders and among decoders (but an
2725 * encoder and a decoder can share the same name).
2730 * Type of codec implemented by the hardware accelerator.
2732 * See AVMEDIA_TYPE_xxx
2734 enum AVMediaType type;
2737 * Codec implemented by the hardware accelerator.
2744 * Supported pixel format.
2746 * Only hardware accelerated formats are supported here.
2748 enum PixelFormat pix_fmt;
2751 * Hardware accelerated codec capabilities.
2752 * see FF_HWACCEL_CODEC_CAP_*
2756 struct AVHWAccel *next;
2759 * Called at the beginning of each frame or field picture.
2761 * Meaningful frame information (codec specific) is guaranteed to
2762 * be parsed at this point. This function is mandatory.
2764 * Note that buf can be NULL along with buf_size set to 0.
2765 * Otherwise, this means the whole frame is available at this point.
2767 * @param avctx the codec context
2768 * @param buf the frame data buffer base
2769 * @param buf_size the size of the frame in bytes
2770 * @return zero if successful, a negative value otherwise
2772 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2775 * Callback for each slice.
2777 * Meaningful slice information (codec specific) is guaranteed to
2778 * be parsed at this point. This function is mandatory.
2780 * @param avctx the codec context
2781 * @param buf the slice data buffer base
2782 * @param buf_size the size of the slice in bytes
2783 * @return zero if successful, a negative value otherwise
2785 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2788 * Called at the end of each frame or field picture.
2790 * The whole picture is parsed at this point and can now be sent
2791 * to the hardware accelerator. This function is mandatory.
2793 * @param avctx the codec context
2794 * @return zero if successful, a negative value otherwise
2796 int (*end_frame)(AVCodecContext *avctx);
2799 * Size of HW accelerator private data.
2801 * Private data is allocated with av_mallocz() before
2802 * AVCodecContext.get_buffer() and deallocated after
2803 * AVCodecContext.release_buffer().
2809 * four components are given, that's all.
2810 * the last component is alpha
2812 typedef struct AVPicture {
2814 int linesize[4]; ///< number of bytes per line
2817 #if LIBAVCODEC_VERSION_MAJOR < 53
2820 * This structure defines a method for communicating palette changes
2821 * between and demuxer and a decoder.
2823 * @deprecated Use AVPacket to send palette changes instead.
2824 * This is totally broken.
2826 #define AVPALETTE_SIZE 1024
2827 #define AVPALETTE_COUNT 256
2828 typedef struct AVPaletteControl {
2830 /* Demuxer sets this to 1 to indicate the palette has changed;
2831 * decoder resets to 0. */
2832 int palette_changed;
2834 /* 4-byte ARGB palette entries, stored in native byte order; note that
2835 * the individual palette components should be on a 8-bit scale; if
2836 * the palette data comes from an IBM VGA native format, the component
2837 * data is probably 6 bits in size and needs to be scaled. */
2838 unsigned int palette[AVPALETTE_COUNT];
2840 } AVPaletteControl attribute_deprecated;
2843 enum AVSubtitleType {
2846 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2849 * Plain text, the text field must be set by the decoder and is
2850 * authoritative. ass and pict fields may contain approximations.
2855 * Formatted text, the ass field must be set by the decoder and is
2856 * authoritative. pict and text fields may contain approximations.
2861 typedef struct AVSubtitleRect {
2862 int x; ///< top left corner of pict, undefined when pict is not set
2863 int y; ///< top left corner of pict, undefined when pict is not set
2864 int w; ///< width of pict, undefined when pict is not set
2865 int h; ///< height of pict, undefined when pict is not set
2866 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2869 * data+linesize for the bitmap of this subtitle.
2870 * can be set for text/ass as well once they where rendered
2873 enum AVSubtitleType type;
2875 char *text; ///< 0 terminated plain UTF-8 text
2878 * 0 terminated ASS/SSA compatible event line.
2879 * The pressentation of this is unaffected by the other values in this
2885 typedef struct AVSubtitle {
2886 uint16_t format; /* 0 = graphics */
2887 uint32_t start_display_time; /* relative to packet pts, in ms */
2888 uint32_t end_display_time; /* relative to packet pts, in ms */
2890 AVSubtitleRect **rects;
2891 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2894 /* packet functions */
2897 * @deprecated use NULL instead
2899 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2902 * Default packet destructor.
2904 void av_destruct_packet(AVPacket *pkt);
2907 * Initialize optional fields of a packet with default values.
2911 void av_init_packet(AVPacket *pkt);
2914 * Allocate the payload of a packet and initialize its fields with
2918 * @param size wanted payload size
2919 * @return 0 if OK, AVERROR_xxx otherwise
2921 int av_new_packet(AVPacket *pkt, int size);
2924 * Reduce packet size, correctly zeroing padding
2927 * @param size new size
2929 void av_shrink_packet(AVPacket *pkt, int size);
2932 * @warning This is a hack - the packet memory allocation stuff is broken. The
2933 * packet is allocated if it was not really allocated.
2935 int av_dup_packet(AVPacket *pkt);
2940 * @param pkt packet to free
2942 void av_free_packet(AVPacket *pkt);
2946 struct ReSampleContext;
2947 struct AVResampleContext;
2949 typedef struct ReSampleContext ReSampleContext;
2951 #if LIBAVCODEC_VERSION_MAJOR < 53
2953 * @deprecated Use av_audio_resample_init() instead.
2955 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2956 int output_rate, int input_rate);
2959 * Initialize audio resampling context
2961 * @param output_channels number of output channels
2962 * @param input_channels number of input channels
2963 * @param output_rate output sample rate
2964 * @param input_rate input sample rate
2965 * @param sample_fmt_out requested output sample format
2966 * @param sample_fmt_in input sample format
2967 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2968 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2969 * @param linear If 1 then the used FIR filter will be linearly interpolated
2970 between the 2 closest, if 0 the closest will be used
2971 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2972 * @return allocated ReSampleContext, NULL if error occured
2974 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2975 int output_rate, int input_rate,
2976 enum SampleFormat sample_fmt_out,
2977 enum SampleFormat sample_fmt_in,
2978 int filter_length, int log2_phase_count,
2979 int linear, double cutoff);
2981 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2982 void audio_resample_close(ReSampleContext *s);
2986 * Initialize an audio resampler.
2987 * Note, if either rate is not an integer then simply scale both rates up so they are.
2988 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2989 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2990 * @param linear If 1 then the used FIR filter will be linearly interpolated
2991 between the 2 closest, if 0 the closest will be used
2992 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2994 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2997 * Resample an array of samples using a previously configured context.
2998 * @param src an array of unconsumed samples
2999 * @param consumed the number of samples of src which have been consumed are returned here
3000 * @param src_size the number of unconsumed samples available
3001 * @param dst_size the amount of space in samples available in dst
3002 * @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.
3003 * @return the number of samples written in dst or -1 if an error occurred
3005 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3009 * Compensate samplerate/timestamp drift. The compensation is done by changing
3010 * the resampler parameters, so no audible clicks or similar distortions occur
3011 * @param compensation_distance distance in output samples over which the compensation should be performed
3012 * @param sample_delta number of output samples which should be output less
3014 * example: av_resample_compensate(c, 10, 500)
3015 * here instead of 510 samples only 500 samples would be output
3017 * note, due to rounding the actual compensation might be slightly different,
3018 * especially if the compensation_distance is large and the in_rate used during init is small
3020 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3021 void av_resample_close(struct AVResampleContext *c);
3024 * Allocate memory for a picture. Call avpicture_free to free it.
3026 * @param picture the picture to be filled in
3027 * @param pix_fmt the format of the picture
3028 * @param width the width of the picture
3029 * @param height the height of the picture
3030 * @return zero if successful, a negative value if not
3032 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3035 * Free a picture previously allocated by avpicture_alloc().
3037 * @param picture the AVPicture to be freed
3039 void avpicture_free(AVPicture *picture);
3042 * Fill in the AVPicture fields.
3043 * The fields of the given AVPicture are filled in by using the 'ptr' address
3044 * which points to the image data buffer. Depending on the specified picture
3045 * format, one or multiple image data pointers and line sizes will be set.
3046 * If a planar format is specified, several pointers will be set pointing to
3047 * the different picture planes and the line sizes of the different planes
3048 * will be stored in the lines_sizes array.
3049 * Call with ptr == NULL to get the required size for the ptr buffer.
3051 * @param picture AVPicture whose fields are to be filled in
3052 * @param ptr Buffer which will contain or contains the actual image data
3053 * @param pix_fmt The format in which the picture data is stored.
3054 * @param width the width of the image in pixels
3055 * @param height the height of the image in pixels
3056 * @return size of the image data in bytes
3058 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3059 enum PixelFormat pix_fmt, int width, int height);
3060 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3061 unsigned char *dest, int dest_size);
3064 * Calculate the size in bytes that a picture of the given width and height
3065 * would occupy if stored in the given picture format.
3066 * Note that this returns the size of a compact representation as generated
3067 * by avpicture_layout, which can be smaller than the size required for e.g.
3070 * @param pix_fmt the given picture format
3071 * @param width the width of the image
3072 * @param height the height of the image
3073 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3075 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3076 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3077 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3078 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3080 #if LIBAVCODEC_VERSION_MAJOR < 53
3082 * Return the pixel format corresponding to the name name.
3084 * If there is no pixel format with name name, then look for a
3085 * pixel format with the name corresponding to the native endian
3087 * For example in a little-endian system, first look for "gray16",
3088 * then for "gray16le".
3090 * Finally if no pixel format has been found, return PIX_FMT_NONE.
3092 * @deprecated Deprecated in favor of av_get_pix_fmt().
3094 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3098 * Return a value representing the fourCC code associated to the
3099 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3102 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3105 * Put a string representing the codec tag codec_tag in buf.
3107 * @param buf_size size in bytes of buf
3108 * @return the length of the string that would have been generated if
3109 * enough space had been available, excluding the trailing null
3111 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3113 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3114 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3115 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3116 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3117 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3118 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3121 * Compute what kind of losses will occur when converting from one specific
3122 * pixel format to another.
3123 * When converting from one pixel format to another, information loss may occur.
3124 * For example, when converting from RGB24 to GRAY, the color information will
3125 * be lost. Similarly, other losses occur when converting from some formats to
3126 * other formats. These losses can involve loss of chroma, but also loss of
3127 * resolution, loss of color depth, loss due to the color space conversion, loss
3128 * of the alpha bits or loss due to color quantization.
3129 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3130 * which will occur when converting from one pixel format to another.
3132 * @param[in] dst_pix_fmt destination pixel format
3133 * @param[in] src_pix_fmt source pixel format
3134 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3135 * @return Combination of flags informing you what kind of losses will occur.
3137 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3141 * Find the best pixel format to convert to given a certain source pixel
3142 * format. When converting from one pixel format to another, information loss
3143 * may occur. For example, when converting from RGB24 to GRAY, the color
3144 * information will be lost. Similarly, other losses occur when converting from
3145 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3146 * the given pixel formats should be used to suffer the least amount of loss.
3147 * The pixel formats from which it chooses one, are determined by the
3148 * pix_fmt_mask parameter.
3151 * src_pix_fmt = PIX_FMT_YUV420P;
3152 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3153 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3156 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3157 * @param[in] src_pix_fmt source pixel format
3158 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3159 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3160 * @return The best pixel format to convert to or -1 if none was found.
3162 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3163 int has_alpha, int *loss_ptr);
3167 * Print in buf the string corresponding to the pixel format with
3168 * number pix_fmt, or an header if pix_fmt is negative.
3170 * @param[in] buf the buffer where to write the string
3171 * @param[in] buf_size the size of buf
3172 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3173 * a negative value to print the corresponding header.
3174 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3176 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3178 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3179 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3182 * Tell if an image really has transparent alpha values.
3183 * @return ored mask of FF_ALPHA_xxx constants
3185 int img_get_alpha_info(const AVPicture *src,
3186 enum PixelFormat pix_fmt, int width, int height);
3188 /* deinterlace a picture */
3189 /* deinterlace - if not supported return -1 */
3190 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3191 enum PixelFormat pix_fmt, int width, int height);
3193 /* external high level API */
3196 * If c is NULL, returns the first registered codec,
3197 * if c is non-NULL, returns the next registered codec after c,
3198 * or NULL if c is the last one.
3200 AVCodec *av_codec_next(AVCodec *c);
3203 * Return the LIBAVCODEC_VERSION_INT constant.
3205 unsigned avcodec_version(void);
3208 * Return the libavcodec build-time configuration.
3210 const char *avcodec_configuration(void);
3213 * Return the libavcodec license.
3215 const char *avcodec_license(void);
3218 * Initialize libavcodec.
3220 * @warning This function must be called before any other libavcodec
3223 void avcodec_init(void);
3225 #if LIBAVCODEC_VERSION_MAJOR < 53
3227 * @deprecated Deprecated in favor of avcodec_register().
3229 attribute_deprecated void register_avcodec(AVCodec *codec);
3233 * Register the codec codec and initialize libavcodec.
3235 * @see avcodec_init()
3237 void avcodec_register(AVCodec *codec);
3240 * Find a registered encoder with a matching codec ID.
3242 * @param id CodecID of the requested encoder
3243 * @return An encoder if one was found, NULL otherwise.
3245 AVCodec *avcodec_find_encoder(enum CodecID id);
3248 * Find a registered encoder with the specified name.
3250 * @param name name of the requested encoder
3251 * @return An encoder if one was found, NULL otherwise.
3253 AVCodec *avcodec_find_encoder_by_name(const char *name);
3256 * Find a registered decoder with a matching codec ID.
3258 * @param id CodecID of the requested decoder
3259 * @return A decoder if one was found, NULL otherwise.
3261 AVCodec *avcodec_find_decoder(enum CodecID id);
3264 * Find a registered decoder with the specified name.
3266 * @param name name of the requested decoder
3267 * @return A decoder if one was found, NULL otherwise.
3269 AVCodec *avcodec_find_decoder_by_name(const char *name);
3270 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3273 * Set the fields of the given AVCodecContext to default values.
3275 * @param s The AVCodecContext of which the fields should be set to default values.
3277 void avcodec_get_context_defaults(AVCodecContext *s);
3279 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3280 * we WILL change its arguments and name a few times! */
3281 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3284 * Allocate an AVCodecContext and set its fields to default values. The
3285 * resulting struct can be deallocated by simply calling av_free().
3287 * @return An AVCodecContext filled with default values or NULL on failure.
3288 * @see avcodec_get_context_defaults
3290 AVCodecContext *avcodec_alloc_context(void);
3292 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3293 * we WILL change its arguments and name a few times! */
3294 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3297 * Copy the settings of the source AVCodecContext into the destination
3298 * AVCodecContext. The resulting destination codec context will be
3299 * unopened, i.e. you are required to call avcodec_open() before you
3300 * can use this AVCodecContext to decode/encode video/audio data.
3302 * @param dest target codec context, should be initialized with
3303 * avcodec_alloc_context(), but otherwise uninitialized
3304 * @param src source codec context
3305 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3307 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3310 * Set the fields of the given AVFrame to default values.
3312 * @param pic The AVFrame of which the fields should be set to default values.
3314 void avcodec_get_frame_defaults(AVFrame *pic);
3317 * Allocate an AVFrame and set its fields to default values. The resulting
3318 * struct can be deallocated by simply calling av_free().
3320 * @return An AVFrame filled with default values or NULL on failure.
3321 * @see avcodec_get_frame_defaults
3323 AVFrame *avcodec_alloc_frame(void);
3325 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3326 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3327 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3330 * Return the amount of padding in pixels which the get_buffer callback must
3331 * provide around the edge of the image for codecs which do not have the
3332 * CODEC_FLAG_EMU_EDGE flag.
3334 * @return Required padding in pixels.
3336 unsigned avcodec_get_edge_width(void);
3338 * Modify width and height values so that they will result in a memory
3339 * buffer that is acceptable for the codec if you do not use any horizontal
3342 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3343 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3344 * according to avcodec_get_edge_width() before.
3346 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3348 * Modify width and height values so that they will result in a memory
3349 * buffer that is acceptable for the codec if you also ensure that all
3350 * line sizes are a multiple of the respective linesize_align[i].
3352 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3353 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3354 * according to avcodec_get_edge_width() before.
3356 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3357 int linesize_align[4]);
3360 * Check if the given dimension of a picture is valid, meaning that all
3361 * bytes of the picture can be addressed with a signed int.
3363 * @param[in] w Width of the picture.
3364 * @param[in] h Height of the picture.
3365 * @return Zero if valid, a negative value if invalid.
3367 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3368 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3370 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3371 void avcodec_thread_free(AVCodecContext *s);
3372 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3373 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3374 //FIXME func typedef
3377 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3378 * function the context has to be allocated.
3380 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3381 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3382 * retrieving a codec.
3384 * @warning This function is not thread safe!
3387 * avcodec_register_all();
3388 * codec = avcodec_find_decoder(CODEC_ID_H264);
3392 * context = avcodec_alloc_context();
3394 * if (avcodec_open(context, codec) < 0)
3398 * @param avctx The context which will be set up to use the given codec.
3399 * @param codec The codec to use within the context.
3400 * @return zero on success, a negative value on error
3401 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3403 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3405 #if LIBAVCODEC_VERSION_MAJOR < 53
3407 * Decode an audio frame from buf into samples.
3408 * Wrapper function which calls avcodec_decode_audio3.
3410 * @deprecated Use avcodec_decode_audio3 instead.
3411 * @param avctx the codec context
3412 * @param[out] samples the output buffer
3413 * @param[in,out] frame_size_ptr the output buffer size in bytes
3414 * @param[in] buf the input buffer
3415 * @param[in] buf_size the input buffer size in bytes
3416 * @return On error a negative value is returned, otherwise the number of bytes
3417 * used or zero if no frame could be decompressed.
3419 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3420 int *frame_size_ptr,
3421 const uint8_t *buf, int buf_size);
3425 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3426 * Some decoders may support multiple frames in a single AVPacket, such
3427 * decoders would then just decode the first frame. In this case,
3428 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3429 * the remaining data in order to decode the second frame etc.
3431 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3432 * decompressed frame size in bytes.
3434 * @warning You must set frame_size_ptr to the allocated size of the
3435 * output buffer before calling avcodec_decode_audio3().
3437 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3438 * the actual read bytes because some optimized bitstream readers read 32 or 64
3439 * bits at once and could read over the end.
3441 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3442 * no overreading happens for damaged MPEG streams.
3444 * @note You might have to align the input buffer avpkt->data and output buffer
3445 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3446 * necessary at all, on others it won't work at all if not aligned and on others
3447 * it will work but it will have an impact on performance.
3449 * In practice, avpkt->data should have 4 byte alignment at minimum and
3450 * samples should be 16 byte aligned unless the CPU doesn't need it
3451 * (AltiVec and SSE do).
3453 * @param avctx the codec context
3454 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3455 * @param[in,out] frame_size_ptr the output buffer size in bytes
3456 * @param[in] avpkt The input AVPacket containing the input buffer.
3457 * You can create such packet with av_init_packet() and by then setting
3458 * data and size, some decoders might in addition need other fields.
3459 * All decoders are designed to use the least fields possible though.
3460 * @return On error a negative value is returned, otherwise the number of bytes
3461 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3463 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3464 int *frame_size_ptr,
3467 #if LIBAVCODEC_VERSION_MAJOR < 53
3469 * Decode a video frame from buf into picture.
3470 * Wrapper function which calls avcodec_decode_video2.
3472 * @deprecated Use avcodec_decode_video2 instead.
3473 * @param avctx the codec context
3474 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3475 * @param[in] buf the input buffer
3476 * @param[in] buf_size the size of the input buffer in bytes
3477 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3478 * @return On error a negative value is returned, otherwise the number of bytes
3479 * used or zero if no frame could be decompressed.
3481 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3482 int *got_picture_ptr,
3483 const uint8_t *buf, int buf_size);
3487 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3488 * Some decoders may support multiple frames in a single AVPacket, such
3489 * decoders would then just decode the first frame.
3491 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3492 * the actual read bytes because some optimized bitstream readers read 32 or 64
3493 * bits at once and could read over the end.
3495 * @warning The end of the input buffer buf should be set to 0 to ensure that
3496 * no overreading happens for damaged MPEG streams.
3498 * @note You might have to align the input buffer avpkt->data.
3499 * The alignment requirements depend on the CPU: on some CPUs it isn't
3500 * necessary at all, on others it won't work at all if not aligned and on others
3501 * it will work but it will have an impact on performance.
3503 * In practice, avpkt->data should have 4 byte alignment at minimum.
3505 * @note Some codecs have a delay between input and output, these need to be
3506 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3508 * @param avctx the codec context
3509 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3510 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3511 * allocate memory for the actual bitmap.
3512 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3513 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3514 * decodes and the decoder tells the user once it does not need the data anymore,
3515 * the user app can at this point free/reuse/keep the memory as it sees fit.
3517 * @param[in] avpkt The input AVpacket containing the input buffer.
3518 * You can create such packet with av_init_packet() and by then setting
3519 * data and size, some decoders might in addition need other fields like
3520 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3522 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3523 * @return On error a negative value is returned, otherwise the number of bytes
3524 * used or zero if no frame could be decompressed.
3526 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3527 int *got_picture_ptr,
3530 #if LIBAVCODEC_VERSION_MAJOR < 53
3531 /* Decode a subtitle message. Return -1 if error, otherwise return the
3532 * number of bytes used. If no subtitle could be decompressed,
3533 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3534 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3536 const uint8_t *buf, int buf_size);
3540 * Decode a subtitle message.
3541 * Return a negative value on error, otherwise return the number of bytes used.
3542 * If no subtitle could be decompressed, got_sub_ptr is zero.
3543 * Otherwise, the subtitle is stored in *sub.
3545 * @param avctx the codec context
3546 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3547 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3548 * @param[in] avpkt The input AVPacket containing the input buffer.
3550 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3553 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3555 uint8_t *buf, int buf_size);
3558 * Encode an audio frame from samples into buf.
3560 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3561 * However, for PCM audio the user will know how much space is needed
3562 * because it depends on the value passed in buf_size as described
3563 * below. In that case a lower value can be used.
3565 * @param avctx the codec context
3566 * @param[out] buf the output buffer
3567 * @param[in] buf_size the output buffer size
3568 * @param[in] samples the input buffer containing the samples
3569 * The number of samples read from this buffer is frame_size*channels,
3570 * both of which are defined in avctx.
3571 * For PCM audio the number of samples read from samples is equal to
3572 * buf_size * input_sample_size / output_sample_size.
3573 * @return On error a negative value is returned, on success zero or the number
3574 * of bytes used to encode the data read from the input buffer.
3576 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3577 const short *samples);
3580 * Encode a video frame from pict into buf.
3581 * The input picture should be
3582 * stored using a specific format, namely avctx.pix_fmt.
3584 * @param avctx the codec context
3585 * @param[out] buf the output buffer for the bitstream of encoded frame
3586 * @param[in] buf_size the size of the output buffer in bytes
3587 * @param[in] pict the input picture to encode
3588 * @return On error a negative value is returned, on success zero or the number
3589 * of bytes used from the output buffer.
3591 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3592 const AVFrame *pict);
3593 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3594 const AVSubtitle *sub);
3596 int avcodec_close(AVCodecContext *avctx);
3599 * Register all the codecs, parsers and bitstream filters which were enabled at
3600 * configuration time. If you do not call this function you can select exactly
3601 * which formats you want to support, by using the individual registration
3604 * @see avcodec_register
3605 * @see av_register_codec_parser
3606 * @see av_register_bitstream_filter
3608 void avcodec_register_all(void);
3611 * Flush buffers, should be called when seeking or when switching to a different stream.
3613 void avcodec_flush_buffers(AVCodecContext *avctx);
3615 void avcodec_default_free_buffers(AVCodecContext *s);
3617 /* misc useful functions */
3620 * Return a single letter to describe the given picture type pict_type.
3622 * @param[in] pict_type the picture type
3623 * @return A single character representing the picture type.
3625 char av_get_pict_type_char(int pict_type);
3628 * Return codec bits per sample.
3630 * @param[in] codec_id the codec
3631 * @return Number of bits per sample or zero if unknown for the given codec.
3633 int av_get_bits_per_sample(enum CodecID codec_id);
3636 * Return sample format bits per sample.
3638 * @param[in] sample_fmt the sample format
3639 * @return Number of bits per sample or zero if unknown for the given sample format.
3641 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3644 typedef struct AVCodecParserContext {
3646 struct AVCodecParser *parser;
3647 int64_t frame_offset; /* offset of the current frame */
3648 int64_t cur_offset; /* current offset
3649 (incremented by each av_parser_parse()) */
3650 int64_t next_frame_offset; /* offset of the next frame */
3652 int pict_type; /* XXX: Put it back in AVCodecContext. */
3654 * This field is used for proper frame duration computation in lavf.
3655 * It signals, how much longer the frame duration of the current frame
3656 * is compared to normal frame duration.
3658 * frame_duration = (1 + repeat_pict) * time_base
3660 * It is used by codecs like H.264 to display telecined material.
3662 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3663 int64_t pts; /* pts of the current frame */
3664 int64_t dts; /* dts of the current frame */
3669 int fetch_timestamp;
3671 #define AV_PARSER_PTS_NB 4
3672 int cur_frame_start_index;
3673 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3674 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3675 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3678 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3679 #define PARSER_FLAG_ONCE 0x0002
3681 int64_t offset; ///< byte offset from starting packet start
3682 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3685 * Set by parser to 1 for key frames and 0 for non-key frames.
3686 * It is initialized to -1, so if the parser doesn't set this flag,
3687 * old-style fallback using FF_I_TYPE picture type as key frames
3693 * Time difference in stream time base units from the pts of this
3694 * packet to the point at which the output from the decoder has converged
3695 * independent from the availability of previous frames. That is, the
3696 * frames are virtually identical no matter if decoding started from
3697 * the very first frame or from this keyframe.
3698 * Is AV_NOPTS_VALUE if unknown.
3699 * This field is not the display duration of the current frame.
3700 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3703 * The purpose of this field is to allow seeking in streams that have no
3704 * keyframes in the conventional sense. It corresponds to the
3705 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3706 * essential for some types of subtitle streams to ensure that all
3707 * subtitles are correctly displayed after seeking.
3709 int64_t convergence_duration;
3711 // Timestamp generation support:
3713 * Synchronization point for start of timestamp generation.
3715 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3718 * For example, this corresponds to presence of H.264 buffering period
3724 * Offset of the current timestamp against last timestamp sync point in
3725 * units of AVCodecContext.time_base.
3727 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3728 * contain a valid timestamp offset.
3730 * Note that the timestamp of sync point has usually a nonzero
3731 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3732 * the next frame after timestamp sync point will be usually 1.
3734 * For example, this corresponds to H.264 cpb_removal_delay.
3736 int dts_ref_dts_delta;
3739 * Presentation delay of current frame in units of AVCodecContext.time_base.
3741 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3742 * contain valid non-negative timestamp delta (presentation time of a frame
3743 * must not lie in the past).
3745 * This delay represents the difference between decoding and presentation
3746 * time of the frame.
3748 * For example, this corresponds to H.264 dpb_output_delay.
3753 * Position of the packet in file.
3755 * Analogous to cur_frame_pts/dts
3757 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3760 * Byte position of currently parsed frame in stream.
3765 * Previous frame byte position.
3768 } AVCodecParserContext;
3770 typedef struct AVCodecParser {
3771 int codec_ids[5]; /* several codec IDs are permitted */
3773 int (*parser_init)(AVCodecParserContext *s);
3774 int (*parser_parse)(AVCodecParserContext *s,
3775 AVCodecContext *avctx,
3776 const uint8_t **poutbuf, int *poutbuf_size,
3777 const uint8_t *buf, int buf_size);
3778 void (*parser_close)(AVCodecParserContext *s);
3779 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3780 struct AVCodecParser *next;
3783 AVCodecParser *av_parser_next(AVCodecParser *c);
3785 void av_register_codec_parser(AVCodecParser *parser);
3786 AVCodecParserContext *av_parser_init(int codec_id);
3788 #if LIBAVCODEC_VERSION_MAJOR < 53
3789 attribute_deprecated
3790 int av_parser_parse(AVCodecParserContext *s,
3791 AVCodecContext *avctx,
3792 uint8_t **poutbuf, int *poutbuf_size,
3793 const uint8_t *buf, int buf_size,
3794 int64_t pts, int64_t dts);
3800 * @param s parser context.
3801 * @param avctx codec context.
3802 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3803 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3804 * @param buf input buffer.
3805 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3806 * @param pts input presentation timestamp.
3807 * @param dts input decoding timestamp.
3808 * @param pos input byte position in stream.
3809 * @return the number of bytes of the input bitstream used.
3814 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3821 * decode_frame(data, size);
3825 int av_parser_parse2(AVCodecParserContext *s,
3826 AVCodecContext *avctx,
3827 uint8_t **poutbuf, int *poutbuf_size,
3828 const uint8_t *buf, int buf_size,
3829 int64_t pts, int64_t dts,
3832 int av_parser_change(AVCodecParserContext *s,
3833 AVCodecContext *avctx,
3834 uint8_t **poutbuf, int *poutbuf_size,
3835 const uint8_t *buf, int buf_size, int keyframe);
3836 void av_parser_close(AVCodecParserContext *s);
3839 typedef struct AVBitStreamFilterContext {
3841 struct AVBitStreamFilter *filter;
3842 AVCodecParserContext *parser;
3843 struct AVBitStreamFilterContext *next;
3844 } AVBitStreamFilterContext;
3847 typedef struct AVBitStreamFilter {
3850 int (*filter)(AVBitStreamFilterContext *bsfc,
3851 AVCodecContext *avctx, const char *args,
3852 uint8_t **poutbuf, int *poutbuf_size,
3853 const uint8_t *buf, int buf_size, int keyframe);
3854 void (*close)(AVBitStreamFilterContext *bsfc);
3855 struct AVBitStreamFilter *next;
3856 } AVBitStreamFilter;
3858 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3859 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3860 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3861 AVCodecContext *avctx, const char *args,
3862 uint8_t **poutbuf, int *poutbuf_size,
3863 const uint8_t *buf, int buf_size, int keyframe);
3864 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3866 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3871 * Reallocate the given block if it is not large enough, otherwise do nothing.
3875 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3878 * Allocate a buffer, reusing the given one if large enough.
3880 * Contrary to av_fast_realloc the current buffer contents might not be
3881 * preserved and on error the old buffer is freed, thus no special
3882 * handling to avoid memleaks is necessary.
3884 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3885 * @param size size of the buffer *ptr points to
3886 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3887 * *size 0 if an error occurred.
3889 void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3892 * Copy image 'src' to 'dst'.
3894 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3895 enum PixelFormat pix_fmt, int width, int height);
3898 * Crop image top and left side.
3900 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3901 enum PixelFormat pix_fmt, int top_band, int left_band);
3906 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3907 int padtop, int padbottom, int padleft, int padright, int *color);
3910 * Encode extradata length to a buffer. Used by xiph codecs.
3912 * @param s buffer to write to; must be at least (v/255+1) bytes long
3913 * @param v size of extradata in bytes
3914 * @return number of bytes written to the buffer.
3916 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3919 * Parse str and put in width_ptr and height_ptr the detected values.
3921 * @return 0 in case of a successful parsing, a negative value otherwise
3922 * @param[in] str the string to parse: it has to be a string in the format
3923 * width x height or a valid video frame size abbreviation.
3924 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3926 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3927 * frame height value
3929 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3932 * Parse str and store the detected values in *frame_rate.
3934 * @return 0 in case of a successful parsing, a negative value otherwise
3935 * @param[in] str the string to parse: it has to be a string in the format
3936 * frame_rate_num / frame_rate_den, a float number or a valid video rate abbreviation
3937 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3940 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3943 * Logs a generic warning message about a missing feature. This function is
3944 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3945 * only, and would normally not be used by applications.
3946 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3947 * a pointer to an AVClass struct
3948 * @param[in] feature string containing the name of the missing feature
3949 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3950 * If want_sample is non-zero, additional verbage will be added to the log
3951 * message which tells the user how to report samples to the development
3954 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3957 * Log a generic warning message asking for a sample. This function is
3958 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3959 * only, and would normally not be used by applications.
3960 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3961 * a pointer to an AVClass struct
3962 * @param[in] msg string containing an optional message, or NULL if no message
3964 void av_log_ask_for_sample(void *avc, const char *msg);
3967 * Register the hardware accelerator hwaccel.
3969 void av_register_hwaccel(AVHWAccel *hwaccel);
3972 * If hwaccel is NULL, returns the first registered hardware accelerator,
3973 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3974 * after hwaccel, or NULL if hwaccel is the last one.
3976 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3980 * Lock operation used by lockmgr
3983 AV_LOCK_CREATE, ///< Create a mutex
3984 AV_LOCK_OBTAIN, ///< Lock the mutex
3985 AV_LOCK_RELEASE, ///< Unlock the mutex
3986 AV_LOCK_DESTROY, ///< Free mutex resources
3990 * Register a user provided lock manager supporting the operations
3991 * specified by AVLockOp. mutex points to a (void *) where the
3992 * lockmgr should store/get a pointer to a user allocated mutex. It's
3993 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3995 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3996 * callback during the call to av_lockmgr_register().
3997 * Thus, the application must be prepared to handle that.
3998 * If cb is set to NULL the lockmgr will be unregistered.
3999 * Also note that during unregistration the previously registered
4000 * lockmgr callback may also be invoked.
4002 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4004 #endif /* AVCODEC_AVCODEC_H */