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
25 * @file libavcodec/avcodec.h
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 59
34 #define LIBAVCODEC_VERSION_MICRO 0
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 * Identifies 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,
145 CODEC_ID_TRUEMOTION2,
162 CODEC_ID_DSICINVIDEO,
163 CODEC_ID_TIERTEXSEQVIDEO,
172 CODEC_ID_BETHSOFTVID,
190 CODEC_ID_MOTIONPIXELS,
208 CODEC_ID_IFF_BYTERUN1,
211 /* various PCM "codecs" */
212 CODEC_ID_PCM_S16LE= 0x10000,
228 CODEC_ID_PCM_S24DAUD,
230 CODEC_ID_PCM_S16LE_PLANAR,
238 /* various ADPCM codecs */
239 CODEC_ID_ADPCM_IMA_QT= 0x11000,
240 CODEC_ID_ADPCM_IMA_WAV,
241 CODEC_ID_ADPCM_IMA_DK3,
242 CODEC_ID_ADPCM_IMA_DK4,
243 CODEC_ID_ADPCM_IMA_WS,
244 CODEC_ID_ADPCM_IMA_SMJPEG,
253 CODEC_ID_ADPCM_YAMAHA,
254 CODEC_ID_ADPCM_SBPRO_4,
255 CODEC_ID_ADPCM_SBPRO_3,
256 CODEC_ID_ADPCM_SBPRO_2,
258 CODEC_ID_ADPCM_IMA_AMV,
259 CODEC_ID_ADPCM_EA_R1,
260 CODEC_ID_ADPCM_EA_R3,
261 CODEC_ID_ADPCM_EA_R2,
262 CODEC_ID_ADPCM_IMA_EA_SEAD,
263 CODEC_ID_ADPCM_IMA_EA_EACS,
264 CODEC_ID_ADPCM_EA_XAS,
265 CODEC_ID_ADPCM_EA_MAXIS_XA,
266 CODEC_ID_ADPCM_IMA_ISS,
269 CODEC_ID_AMR_NB= 0x12000,
272 /* RealAudio codecs*/
273 CODEC_ID_RA_144= 0x13000,
276 /* various DPCM codecs */
277 CODEC_ID_ROQ_DPCM= 0x14000,
278 CODEC_ID_INTERPLAY_DPCM,
283 CODEC_ID_MP2= 0x15000,
284 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
302 CODEC_ID_WESTWOOD_SND1,
303 CODEC_ID_GSM, ///< as in Berlin toast format
311 CODEC_ID_DSICINAUDIO,
315 CODEC_ID_GSM_MS, /* as found in WAV */
324 CODEC_ID_WMALOSSLESS,
333 CODEC_ID_BINKAUDIO_RDFT,
334 CODEC_ID_BINKAUDIO_DCT,
336 /* subtitle codecs */
337 CODEC_ID_DVD_SUBTITLE= 0x17000,
338 CODEC_ID_DVB_SUBTITLE,
339 CODEC_ID_TEXT, ///< raw UTF-8 text
343 CODEC_ID_HDMV_PGS_SUBTITLE,
344 CODEC_ID_DVB_TELETEXT,
346 /* other specific kind of codecs (generally used for attachments) */
347 CODEC_ID_TTF= 0x18000,
349 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
351 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
352 * stream (only used by libavformat) */
356 CODEC_TYPE_UNKNOWN = -1,
361 CODEC_TYPE_ATTACHMENT,
366 * all in native-endian format
369 SAMPLE_FMT_NONE = -1,
370 SAMPLE_FMT_U8, ///< unsigned 8 bits
371 SAMPLE_FMT_S16, ///< signed 16 bits
372 SAMPLE_FMT_S32, ///< signed 32 bits
373 SAMPLE_FMT_FLT, ///< float
374 SAMPLE_FMT_DBL, ///< double
375 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
378 /* Audio channel masks */
379 #define CH_FRONT_LEFT 0x00000001
380 #define CH_FRONT_RIGHT 0x00000002
381 #define CH_FRONT_CENTER 0x00000004
382 #define CH_LOW_FREQUENCY 0x00000008
383 #define CH_BACK_LEFT 0x00000010
384 #define CH_BACK_RIGHT 0x00000020
385 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
386 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
387 #define CH_BACK_CENTER 0x00000100
388 #define CH_SIDE_LEFT 0x00000200
389 #define CH_SIDE_RIGHT 0x00000400
390 #define CH_TOP_CENTER 0x00000800
391 #define CH_TOP_FRONT_LEFT 0x00001000
392 #define CH_TOP_FRONT_CENTER 0x00002000
393 #define CH_TOP_FRONT_RIGHT 0x00004000
394 #define CH_TOP_BACK_LEFT 0x00008000
395 #define CH_TOP_BACK_CENTER 0x00010000
396 #define CH_TOP_BACK_RIGHT 0x00020000
397 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
398 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
400 /** Channel mask value used for AVCodecContext.request_channel_layout
401 to indicate that the user requests the channel order of the decoder output
402 to be the native codec channel order. */
403 #define CH_LAYOUT_NATIVE 0x8000000000000000LL
405 /* Audio channel convenience macros */
406 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
407 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
408 #define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
409 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
410 #define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
411 #define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
412 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
413 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
414 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
415 #define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
416 #define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
417 #define CH_LAYOUT_7POINT0 (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
418 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
419 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
420 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
421 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
424 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
427 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
428 * This is mainly needed because some optimized bitstream readers read
429 * 32 or 64 bit at once and could read over the end.<br>
430 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
431 * MPEG bitstreams could cause overread and segfault.
433 #define FF_INPUT_BUFFER_PADDING_SIZE 8
436 * minimum encoding buffer size
437 * Used to avoid some checks during header writing.
439 #define FF_MIN_BUFFER_SIZE 16384
443 * motion estimation type.
446 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
450 ME_EPZS, ///< enhanced predictive zonal search
451 ME_X1, ///< reserved for experiments
452 ME_HEX, ///< hexagon based search
453 ME_UMH, ///< uneven multi-hexagon search
454 ME_ITER, ///< iterative search
455 ME_TESA, ///< transformed exhaustive search algorithm
459 /* We leave some space between them for extensions (drop some
460 * keyframes for intra-only or drop just some bidir frames). */
461 AVDISCARD_NONE =-16, ///< discard nothing
462 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
463 AVDISCARD_NONREF = 8, ///< discard all non reference
464 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
465 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
466 AVDISCARD_ALL = 48, ///< discard all
469 enum AVColorPrimaries{
470 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
471 AVCOL_PRI_UNSPECIFIED=2,
473 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
474 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
475 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
477 AVCOL_PRI_NB , ///< Not part of ABI
480 enum AVColorTransferCharacteristic{
481 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
482 AVCOL_TRC_UNSPECIFIED=2,
483 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
484 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
485 AVCOL_TRC_NB , ///< Not part of ABI
490 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
491 AVCOL_SPC_UNSPECIFIED=2,
493 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
494 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
495 AVCOL_SPC_SMPTE240M =7,
496 AVCOL_SPC_NB , ///< Not part of ABI
500 AVCOL_RANGE_UNSPECIFIED=0,
501 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
502 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
503 AVCOL_RANGE_NB , ///< Not part of ABI
507 * X X 3 4 X X are luma samples,
508 * 1 2 1-6 are possible chroma positions
509 * X X 5 6 X 0 is undefined/unknown position
511 enum AVChromaLocation{
512 AVCHROMA_LOC_UNSPECIFIED=0,
513 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
514 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
515 AVCHROMA_LOC_TOPLEFT =3, ///< DV
517 AVCHROMA_LOC_BOTTOMLEFT =5,
518 AVCHROMA_LOC_BOTTOM =6,
519 AVCHROMA_LOC_NB , ///< Not part of ABI
522 typedef struct RcOverride{
525 int qscale; // If this is 0 then quality_factor will be used instead.
526 float quality_factor;
529 #define FF_MAX_B_FRAMES 16
532 These flags can be passed in AVCodecContext.flags before initialization.
533 Note: Not everything is supported yet.
536 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
537 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
538 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
539 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
540 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
541 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
543 * The parent program guarantees that the input for B-frames containing
544 * streams is not written to for at least s->max_b_frames+1 frames, if
545 * this is not set the input will be copied.
547 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
548 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
549 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
550 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
551 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
552 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
553 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
554 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
555 location instead of only at frame boundaries. */
556 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
557 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
558 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
559 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
560 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
561 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
562 /* Fx : Flag for h263+ extra options */
563 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
564 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
565 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
566 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
567 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
568 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
569 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
570 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
571 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
572 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
573 #define CODEC_FLAG_CLOSED_GOP 0x80000000
574 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
575 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
576 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
577 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
578 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
579 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
580 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
581 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
582 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
583 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
584 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
585 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
586 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
587 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
588 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
589 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
590 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
591 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
592 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
594 /* Unsupported options :
595 * Syntax Arithmetic coding (SAC)
596 * Reference Picture Selection
597 * Independent Segment Decoding */
599 /* codec capabilities */
601 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
603 * Codec uses get_buffer() for allocating buffers.
604 * direct rendering method 1
606 #define CODEC_CAP_DR1 0x0002
607 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
608 #define CODEC_CAP_PARSE_ONLY 0x0004
609 #define CODEC_CAP_TRUNCATED 0x0008
610 /* Codec can export data for HW decoding (XvMC). */
611 #define CODEC_CAP_HWACCEL 0x0010
613 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
614 * If this is not set, the codec is guaranteed to never be fed with NULL data.
616 #define CODEC_CAP_DELAY 0x0020
618 * Codec can be fed a final frame with a smaller size.
619 * This can be used to prevent truncation of the last audio samples.
621 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
623 * Codec can export data for HW decoding (VDPAU).
625 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
627 * Codec can output multiple frames per AVPacket
628 * Normally demuxers return one frame at a time, demuxers which do not do
629 * are connected to a parser to split what they return into proper frames.
630 * This flag is reserved to the very rare category of codecs which have a
631 * bitstream that cannot be split into frames without timeconsuming
632 * operations like full decoding. Demuxers carring such bitstreams thus
633 * may return multiple frames in a packet. This has many disadvantages like
634 * prohibiting stream copy in many cases thus it should only be considered
637 #define CODEC_CAP_SUBFRAMES 0x0100
639 //The following defines may change, don't expect compatibility if you use them.
640 #define MB_TYPE_INTRA4x4 0x0001
641 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
642 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
643 #define MB_TYPE_16x16 0x0008
644 #define MB_TYPE_16x8 0x0010
645 #define MB_TYPE_8x16 0x0020
646 #define MB_TYPE_8x8 0x0040
647 #define MB_TYPE_INTERLACED 0x0080
648 #define MB_TYPE_DIRECT2 0x0100 //FIXME
649 #define MB_TYPE_ACPRED 0x0200
650 #define MB_TYPE_GMC 0x0400
651 #define MB_TYPE_SKIP 0x0800
652 #define MB_TYPE_P0L0 0x1000
653 #define MB_TYPE_P1L0 0x2000
654 #define MB_TYPE_P0L1 0x4000
655 #define MB_TYPE_P1L1 0x8000
656 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
657 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
658 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
659 #define MB_TYPE_QUANT 0x00010000
660 #define MB_TYPE_CBP 0x00020000
661 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
665 * This specifies the area which should be displayed.
666 * Note there may be multiple such areas for one frame.
668 typedef struct AVPanScan{
671 * - encoding: Set by user.
672 * - decoding: Set by libavcodec.
677 * width and height in 1/16 pel
678 * - encoding: Set by user.
679 * - decoding: Set by libavcodec.
685 * position of the top left corner in 1/16 pel for up to 3 fields/frames
686 * - encoding: Set by user.
687 * - decoding: Set by libavcodec.
689 int16_t position[3][2];
692 #define FF_COMMON_FRAME \
694 * pointer to the picture planes.\
695 * This might be different from the first allocated byte\
702 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
703 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
709 * 1 -> keyframe, 0-> not\
710 * - encoding: Set by libavcodec.\
711 * - decoding: Set by libavcodec.\
716 * Picture type of the frame, see ?_TYPE below.\
717 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
718 * - decoding: Set by libavcodec.\
723 * presentation timestamp in time_base units (time when frame should be shown to user)\
724 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
725 * - encoding: MUST be set by user.\
726 * - decoding: Set by libavcodec.\
731 * picture number in bitstream order\
732 * - encoding: set by\
733 * - decoding: Set by libavcodec.\
735 int coded_picture_number;\
737 * picture number in display order\
738 * - encoding: set by\
739 * - decoding: Set by libavcodec.\
741 int display_picture_number;\
744 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
745 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
746 * - decoding: Set by libavcodec.\
751 * buffer age (1->was last buffer and dint change, 2->..., ...).\
752 * Set to INT_MAX if the buffer has not been used yet.\
753 * - encoding: unused\
754 * - decoding: MUST be set by get_buffer().\
759 * is this picture used as reference\
760 * The values for this are the same as the MpegEncContext.picture_structure\
761 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
762 * Set to 4 for delayed, non-reference frames.\
763 * - encoding: unused\
764 * - decoding: Set by libavcodec. (before get_buffer() call)).\
770 * - encoding: unused\
771 * - decoding: Set by libavcodec.\
773 int8_t *qscale_table;\
776 * - encoding: unused\
777 * - decoding: Set by libavcodec.\
782 * mbskip_table[mb]>=1 if MB didn't change\
783 * stride= mb_width = (width+15)>>4\
784 * - encoding: unused\
785 * - decoding: Set by libavcodec.\
787 uint8_t *mbskip_table;\
790 * motion vector table\
793 * int mv_sample_log2= 4 - motion_subsample_log2;\
794 * int mb_width= (width+15)>>4;\
795 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
796 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
798 * - encoding: Set by user.\
799 * - decoding: Set by libavcodec.\
801 int16_t (*motion_val[2])[2];\
804 * macroblock type table\
805 * mb_type_base + mb_width + 2\
806 * - encoding: Set by user.\
807 * - decoding: Set by libavcodec.\
812 * log2 of the size of the block which a single vector in motion_val represents: \
813 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
814 * - encoding: unused\
815 * - decoding: Set by libavcodec.\
817 uint8_t motion_subsample_log2;\
820 * for some private data of the user\
821 * - encoding: unused\
822 * - decoding: Set by user.\
828 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
829 * - decoding: unused\
834 * type of the buffer (to keep track of who has to deallocate data[*])\
835 * - encoding: Set by the one who allocates it.\
836 * - decoding: Set by the one who allocates it.\
837 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
842 * When decoding, this signals how much the picture must be delayed.\
843 * extra_delay = repeat_pict / (2*fps)\
844 * - encoding: unused\
845 * - decoding: Set by libavcodec.\
855 * The content of the picture is interlaced.\
856 * - encoding: Set by user.\
857 * - decoding: Set by libavcodec. (default 0)\
859 int interlaced_frame;\
862 * If the content is interlaced, is top field displayed first.\
863 * - encoding: Set by user.\
864 * - decoding: Set by libavcodec.\
866 int top_field_first;\
870 * - encoding: Set by user.\
871 * - decoding: Set by libavcodec.\
873 AVPanScan *pan_scan;\
876 * Tell user application that palette has changed from previous frame.\
877 * - encoding: ??? (no palette-enabled encoder yet)\
878 * - decoding: Set by libavcodec. (default 0).\
880 int palette_has_changed;\
883 * codec suggestion on buffer type if != 0\
884 * - encoding: unused\
885 * - decoding: Set by libavcodec. (before get_buffer() call)).\
891 * - encoding: unused\
892 * - decoding: Set by libavcodec.\
897 * motion reference frame index\
898 * the order in which these are stored can depend on the codec.\
899 * - encoding: Set by user.\
900 * - decoding: Set by libavcodec.\
902 int8_t *ref_index[2];\
905 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
906 * output in AVFrame.reordered_opaque\
907 * - encoding: unused\
908 * - decoding: Read by user.\
910 int64_t reordered_opaque;\
913 * hardware accelerator private data (FFmpeg allocated)\
914 * - encoding: unused\
915 * - decoding: Set by libavcodec\
917 void *hwaccel_picture_private;\
920 #define FF_QSCALE_TYPE_MPEG1 0
921 #define FF_QSCALE_TYPE_MPEG2 1
922 #define FF_QSCALE_TYPE_H264 2
923 #define FF_QSCALE_TYPE_VP56 3
925 #define FF_BUFFER_TYPE_INTERNAL 1
926 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
927 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
928 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
931 #define FF_I_TYPE 1 ///< Intra
932 #define FF_P_TYPE 2 ///< Predicted
933 #define FF_B_TYPE 3 ///< Bi-dir predicted
934 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
935 #define FF_SI_TYPE 5 ///< Switching Intra
936 #define FF_SP_TYPE 6 ///< Switching Predicted
939 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
940 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
941 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
942 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
944 typedef struct AVPacket {
946 * Presentation timestamp in AVStream->time_base units; the time at which
947 * the decompressed packet will be presented to the user.
948 * Can be AV_NOPTS_VALUE if it is not stored in the file.
949 * pts MUST be larger or equal to dts as presentation cannot happen before
950 * decompression, unless one wants to view hex dumps. Some formats misuse
951 * the terms dts and pts/cts to mean something different. Such timestamps
952 * must be converted to true pts/dts before they are stored in AVPacket.
956 * Decompression timestamp in AVStream->time_base units; the time at which
957 * the packet is decompressed.
958 * Can be AV_NOPTS_VALUE if it is not stored in the file.
966 * Duration of this packet in AVStream->time_base units, 0 if unknown.
967 * Equals next_pts - this_pts in presentation order.
970 void (*destruct)(struct AVPacket *);
972 int64_t pos; ///< byte position in stream, -1 if unknown
975 * Time difference in AVStream->time_base units from the pts of this
976 * packet to the point at which the output from the decoder has converged
977 * independent from the availability of previous frames. That is, the
978 * frames are virtually identical no matter if decoding started from
979 * the very first frame or from this keyframe.
980 * Is AV_NOPTS_VALUE if unknown.
981 * This field is not the display duration of the current packet.
983 * The purpose of this field is to allow seeking in streams that have no
984 * keyframes in the conventional sense. It corresponds to the
985 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
986 * essential for some types of subtitle streams to ensure that all
987 * subtitles are correctly displayed after seeking.
989 int64_t convergence_duration;
991 #define AV_PKT_FLAG_KEY 0x0001
992 #if LIBAVCODEC_VERSION_MAJOR < 53
993 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
998 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1000 * Removal, reordering and changes to existing fields require a major
1001 * version bump. No fields should be added into AVFrame before or after
1003 * sizeof(AVFrame) must not be used outside libav*.
1005 typedef struct AVFrame {
1010 * main external API structure.
1011 * New fields can be added to the end with minor version bumps.
1012 * Removal, reordering and changes to existing fields require a major
1014 * sizeof(AVCodecContext) must not be used outside libav*.
1016 typedef struct AVCodecContext {
1018 * information on struct for av_log
1019 * - set by avcodec_alloc_context
1021 const AVClass *av_class;
1023 * the average bitrate
1024 * - encoding: Set by user; unused for constant quantizer encoding.
1025 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1030 * number of bits the bitstream is allowed to diverge from the reference.
1031 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1032 * - encoding: Set by user; unused for constant quantizer encoding.
1033 * - decoding: unused
1035 int bit_rate_tolerance;
1039 * - encoding: Set by user.
1040 * - decoding: Set by user.
1045 * Some codecs need additional format info. It is stored here.
1046 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1047 * specific codec MUST set it correctly otherwise stream copy breaks.
1048 * In general use of this field by muxers is not recommanded.
1049 * - encoding: Set by libavcodec.
1050 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1055 * Motion estimation algorithm used for video coding.
1056 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1057 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1058 * - encoding: MUST be set by user.
1059 * - decoding: unused
1064 * some codecs need / can use extradata like Huffman tables.
1065 * mjpeg: Huffman tables
1066 * rv10: additional flags
1067 * mpeg4: global headers (they can be in the bitstream or here)
1068 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1069 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1070 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1071 * - encoding: Set/allocated/freed by libavcodec.
1072 * - decoding: Set/allocated/freed by user.
1078 * This is the fundamental unit of time (in seconds) in terms
1079 * of which frame timestamps are represented. For fixed-fps content,
1080 * timebase should be 1/framerate and timestamp increments should be
1082 * - encoding: MUST be set by user.
1083 * - decoding: Set by libavcodec.
1085 AVRational time_base;
1089 * picture width / height.
1090 * - encoding: MUST be set by user.
1091 * - decoding: Set by libavcodec.
1092 * Note: For compatibility it is possible to set this instead of
1093 * coded_width/height before decoding.
1097 #define FF_ASPECT_EXTENDED 15
1100 * the number of pictures in a group of pictures, or 0 for intra_only
1101 * - encoding: Set by user.
1102 * - decoding: unused
1107 * Pixel format, see PIX_FMT_xxx.
1108 * - encoding: Set by user.
1109 * - decoding: Set by libavcodec.
1111 enum PixelFormat pix_fmt;
1114 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1115 * has to read frames at native frame rate.
1116 * - encoding: Set by user.
1117 * - decoding: unused
1122 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1123 * decoder to draw a horizontal band. It improves cache usage. Not
1124 * all codecs can do that. You must check the codec capabilities
1126 * The function is also used by hardware acceleration APIs.
1127 * It is called at least once during frame decoding to pass
1128 * the data needed for hardware render.
1129 * In that mode instead of pixel data, AVFrame points to
1130 * a structure specific to the acceleration API. The application
1131 * reads the structure and can change some fields to indicate progress
1133 * - encoding: unused
1134 * - decoding: Set by user.
1135 * @param height the height of the slice
1136 * @param y the y position of the slice
1137 * @param type 1->top field, 2->bottom field, 3->frame
1138 * @param offset offset into the AVFrame.data from which the slice should be read
1140 void (*draw_horiz_band)(struct AVCodecContext *s,
1141 const AVFrame *src, int offset[4],
1142 int y, int type, int height);
1145 int sample_rate; ///< samples per second
1146 int channels; ///< number of audio channels
1149 * audio sample format
1150 * - encoding: Set by user.
1151 * - decoding: Set by libavcodec.
1153 enum SampleFormat sample_fmt; ///< sample format
1155 /* The following data should not be initialized. */
1157 * Samples per packet, initialized when calling 'init'.
1160 int frame_number; ///< audio or video frame number
1161 #if LIBAVCODEC_VERSION_MAJOR < 53
1162 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1166 * Number of frames the decoded output will be delayed relative to
1167 * the encoded input.
1168 * - encoding: Set by libavcodec.
1169 * - decoding: unused
1173 /* - encoding parameters */
1174 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1175 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1179 * - encoding: Set by user.
1180 * - decoding: unused
1186 * - encoding: Set by user.
1187 * - decoding: unused
1192 * maximum quantizer difference between frames
1193 * - encoding: Set by user.
1194 * - decoding: unused
1199 * maximum number of B-frames between non-B-frames
1200 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1201 * - encoding: Set by user.
1202 * - decoding: unused
1207 * qscale factor between IP and B-frames
1208 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1209 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1210 * - encoding: Set by user.
1211 * - decoding: unused
1213 float b_quant_factor;
1215 /** obsolete FIXME remove */
1217 #define FF_RC_STRATEGY_XVID 1
1219 int b_frame_strategy;
1223 * - encoding: unused
1224 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1225 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1229 struct AVCodec *codec;
1233 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1234 /* do its best to deliver a chunk with size */
1235 /* below rtp_payload_size, the chunk will start */
1236 /* with a start code on some codecs like H.263. */
1237 /* This doesn't take account of any particular */
1238 /* headers inside the transmitted RTP payload. */
1241 /* The RTP callback: This function is called */
1242 /* every time the encoder has a packet to send. */
1243 /* It depends on the encoder if the data starts */
1244 /* with a Start Code (it should). H.263 does. */
1245 /* mb_nb contains the number of macroblocks */
1246 /* encoded in the RTP payload. */
1247 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1249 /* statistics, used for 2-pass encoding */
1260 * number of bits used for the previously encoded frame
1261 * - encoding: Set by libavcodec.
1262 * - decoding: unused
1267 * Private data of the user, can be used to carry app specific stuff.
1268 * - encoding: Set by user.
1269 * - decoding: Set by user.
1273 char codec_name[32];
1274 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1275 enum CodecID codec_id; /* see CODEC_ID_xxx */
1278 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1279 * This is used to work around some encoder bugs.
1280 * A demuxer should set this to what is stored in the field used to identify the codec.
1281 * If there are multiple such fields in a container then the demuxer should choose the one
1282 * which maximizes the information about the used codec.
1283 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1284 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1285 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1287 * - encoding: Set by user, if not then the default based on codec_id will be used.
1288 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1290 unsigned int codec_tag;
1293 * Work around bugs in encoders which sometimes cannot be detected automatically.
1294 * - encoding: Set by user
1295 * - decoding: Set by user
1297 int workaround_bugs;
1298 #define FF_BUG_AUTODETECT 1 ///< autodetection
1299 #define FF_BUG_OLD_MSMPEG4 2
1300 #define FF_BUG_XVID_ILACE 4
1301 #define FF_BUG_UMP4 8
1302 #define FF_BUG_NO_PADDING 16
1303 #define FF_BUG_AMV 32
1304 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1305 #define FF_BUG_QPEL_CHROMA 64
1306 #define FF_BUG_STD_QPEL 128
1307 #define FF_BUG_QPEL_CHROMA2 256
1308 #define FF_BUG_DIRECT_BLOCKSIZE 512
1309 #define FF_BUG_EDGE 1024
1310 #define FF_BUG_HPEL_CHROMA 2048
1311 #define FF_BUG_DC_CLIP 4096
1312 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1313 #define FF_BUG_TRUNCATED 16384
1314 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1317 * luma single coefficient elimination threshold
1318 * - encoding: Set by user.
1319 * - decoding: unused
1321 int luma_elim_threshold;
1324 * chroma single coeff elimination threshold
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 int chroma_elim_threshold;
1331 * strictly follow the standard (MPEG4, ...).
1332 * - encoding: Set by user.
1333 * - decoding: Set by user.
1334 * Setting this to STRICT or higher means the encoder and decoder will
1335 * generally do stupid things. While setting it to inofficial or lower
1336 * will mean the encoder might use things that are not supported by all
1337 * spec compliant decoders. Decoders make no difference between normal,
1338 * inofficial and experimental, that is they always try to decode things
1339 * when they can unless they are explicitly asked to behave stupid
1340 * (=strictly conform to the specs)
1342 int strict_std_compliance;
1343 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1344 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1345 #define FF_COMPLIANCE_NORMAL 0
1346 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1347 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1350 * qscale offset between IP and B-frames
1351 * - encoding: Set by user.
1352 * - decoding: unused
1354 float b_quant_offset;
1357 * Error recognization; higher values will detect more errors but may
1358 * misdetect some more or less valid parts as errors.
1359 * - encoding: unused
1360 * - decoding: Set by user.
1362 int error_recognition;
1363 #define FF_ER_CAREFUL 1
1364 #define FF_ER_COMPLIANT 2
1365 #define FF_ER_AGGRESSIVE 3
1366 #define FF_ER_VERY_AGGRESSIVE 4
1369 * Called at the beginning of each frame to get a buffer for it.
1370 * If pic.reference is set then the frame will be read later by libavcodec.
1371 * avcodec_align_dimensions2() should be used to find the required width and
1372 * height, as they normally need to be rounded up to the next multiple of 16.
1373 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1374 * avcodec_default_get_buffer() instead of providing buffers allocated by
1376 * - encoding: unused
1377 * - decoding: Set by libavcodec., user can override.
1379 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1382 * Called to release buffers which were allocated with get_buffer.
1383 * A released buffer can be reused in get_buffer().
1384 * pic.data[*] must be set to NULL.
1385 * - encoding: unused
1386 * - decoding: Set by libavcodec., user can override.
1388 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1391 * Size of the frame reordering buffer in the decoder.
1392 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1393 * - encoding: Set by libavcodec.
1394 * - decoding: Set by libavcodec.
1399 * number of bytes per packet if constant and known or 0
1400 * Used by some WAV based audio codecs.
1404 int parse_only; /* - decoding only: If true, only parsing is done
1405 (function avcodec_parse_frame()). The frame
1406 data is returned. Only MPEG codecs support this now. */
1409 * 0-> h263 quant 1-> mpeg quant
1410 * - encoding: Set by user.
1411 * - decoding: unused
1416 * pass1 encoding statistics output buffer
1417 * - encoding: Set by libavcodec.
1418 * - decoding: unused
1423 * pass2 encoding statistics input buffer
1424 * Concatenated stuff from stats_out of pass1 should be placed here.
1425 * - encoding: Allocated/set/freed by user.
1426 * - decoding: unused
1431 * ratecontrol qmin qmax limiting method
1432 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1433 * - encoding: Set by user.
1434 * - decoding: unused
1442 * ratecontrol override, see RcOverride
1443 * - encoding: Allocated/set/freed by user.
1444 * - decoding: unused
1446 RcOverride *rc_override;
1447 int rc_override_count;
1450 * rate control equation
1451 * - encoding: Set by user
1452 * - decoding: unused
1458 * - encoding: Set by user.
1459 * - decoding: unused
1465 * - encoding: Set by user.
1466 * - decoding: unused
1471 * decoder bitstream buffer size
1472 * - encoding: Set by user.
1473 * - decoding: unused
1476 float rc_buffer_aggressivity;
1479 * qscale factor between P and I-frames
1480 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1481 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1482 * - encoding: Set by user.
1483 * - decoding: unused
1485 float i_quant_factor;
1488 * qscale offset between P and I-frames
1489 * - encoding: Set by user.
1490 * - decoding: unused
1492 float i_quant_offset;
1495 * initial complexity for pass1 ratecontrol
1496 * - encoding: Set by user.
1497 * - decoding: unused
1499 float rc_initial_cplx;
1502 * DCT algorithm, see FF_DCT_* below
1503 * - encoding: Set by user.
1504 * - decoding: unused
1507 #define FF_DCT_AUTO 0
1508 #define FF_DCT_FASTINT 1
1509 #define FF_DCT_INT 2
1510 #define FF_DCT_MMX 3
1511 #define FF_DCT_MLIB 4
1512 #define FF_DCT_ALTIVEC 5
1513 #define FF_DCT_FAAN 6
1516 * luminance masking (0-> disabled)
1517 * - encoding: Set by user.
1518 * - decoding: unused
1523 * temporary complexity masking (0-> disabled)
1524 * - encoding: Set by user.
1525 * - decoding: unused
1527 float temporal_cplx_masking;
1530 * spatial complexity masking (0-> disabled)
1531 * - encoding: Set by user.
1532 * - decoding: unused
1534 float spatial_cplx_masking;
1537 * p block masking (0-> disabled)
1538 * - encoding: Set by user.
1539 * - decoding: unused
1544 * darkness masking (0-> disabled)
1545 * - encoding: Set by user.
1546 * - decoding: unused
1551 * IDCT algorithm, see FF_IDCT_* below.
1552 * - encoding: Set by user.
1553 * - decoding: Set by user.
1556 #define FF_IDCT_AUTO 0
1557 #define FF_IDCT_INT 1
1558 #define FF_IDCT_SIMPLE 2
1559 #define FF_IDCT_SIMPLEMMX 3
1560 #define FF_IDCT_LIBMPEG2MMX 4
1561 #define FF_IDCT_PS2 5
1562 #define FF_IDCT_MLIB 6
1563 #define FF_IDCT_ARM 7
1564 #define FF_IDCT_ALTIVEC 8
1565 #define FF_IDCT_SH4 9
1566 #define FF_IDCT_SIMPLEARM 10
1567 #define FF_IDCT_H264 11
1568 #define FF_IDCT_VP3 12
1569 #define FF_IDCT_IPP 13
1570 #define FF_IDCT_XVIDMMX 14
1571 #define FF_IDCT_CAVS 15
1572 #define FF_IDCT_SIMPLEARMV5TE 16
1573 #define FF_IDCT_SIMPLEARMV6 17
1574 #define FF_IDCT_SIMPLEVIS 18
1575 #define FF_IDCT_WMV2 19
1576 #define FF_IDCT_FAAN 20
1577 #define FF_IDCT_EA 21
1578 #define FF_IDCT_SIMPLENEON 22
1579 #define FF_IDCT_SIMPLEALPHA 23
1580 #define FF_IDCT_BINK 24
1584 * - encoding: Set by libavcodec.
1585 * - decoding: Set by user (or 0).
1589 * slice offsets in the frame in bytes
1590 * - encoding: Set/allocated by libavcodec.
1591 * - decoding: Set/allocated by user (or NULL).
1596 * error concealment flags
1597 * - encoding: unused
1598 * - decoding: Set by user.
1600 int error_concealment;
1601 #define FF_EC_GUESS_MVS 1
1602 #define FF_EC_DEBLOCK 2
1605 * dsp_mask could be add used to disable unwanted CPU features
1606 * CPU features (i.e. MMX, SSE. ...)
1608 * With the FORCE flag you may instead enable given CPU features.
1609 * (Dangerous: Usable in case of misdetection, improper usage however will
1610 * result into program crash.)
1613 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1614 /* lower 16 bits - CPU features */
1615 #define FF_MM_MMX 0x0001 ///< standard MMX
1616 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1617 #if LIBAVCODEC_VERSION_MAJOR < 53
1618 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1620 #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
1621 #define FF_MM_SSE 0x0008 ///< SSE functions
1622 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1623 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1624 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1625 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1626 #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1627 #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
1628 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1629 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1632 * bits per sample/pixel from the demuxer (needed for huffyuv).
1633 * - encoding: Set by libavcodec.
1634 * - decoding: Set by user.
1636 int bits_per_coded_sample;
1639 * prediction method (needed for huffyuv)
1640 * - encoding: Set by user.
1641 * - decoding: unused
1643 int prediction_method;
1644 #define FF_PRED_LEFT 0
1645 #define FF_PRED_PLANE 1
1646 #define FF_PRED_MEDIAN 2
1649 * sample aspect ratio (0 if unknown)
1650 * That is the width of a pixel divided by the height of the pixel.
1651 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1652 * - encoding: Set by user.
1653 * - decoding: Set by libavcodec.
1655 AVRational sample_aspect_ratio;
1658 * the picture in the bitstream
1659 * - encoding: Set by libavcodec.
1660 * - decoding: Set by libavcodec.
1662 AVFrame *coded_frame;
1666 * - encoding: Set by user.
1667 * - decoding: Set by user.
1670 #define FF_DEBUG_PICT_INFO 1
1671 #define FF_DEBUG_RC 2
1672 #define FF_DEBUG_BITSTREAM 4
1673 #define FF_DEBUG_MB_TYPE 8
1674 #define FF_DEBUG_QP 16
1675 #define FF_DEBUG_MV 32
1676 #define FF_DEBUG_DCT_COEFF 0x00000040
1677 #define FF_DEBUG_SKIP 0x00000080
1678 #define FF_DEBUG_STARTCODE 0x00000100
1679 #define FF_DEBUG_PTS 0x00000200
1680 #define FF_DEBUG_ER 0x00000400
1681 #define FF_DEBUG_MMCO 0x00000800
1682 #define FF_DEBUG_BUGS 0x00001000
1683 #define FF_DEBUG_VIS_QP 0x00002000
1684 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1685 #define FF_DEBUG_BUFFERS 0x00008000
1689 * - encoding: Set by user.
1690 * - decoding: Set by user.
1693 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1694 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1695 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1699 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1700 * - decoding: unused
1705 * minimum MB quantizer
1706 * - encoding: unused
1707 * - decoding: unused
1712 * maximum MB quantizer
1713 * - encoding: unused
1714 * - decoding: unused
1719 * motion estimation comparison function
1720 * - encoding: Set by user.
1721 * - decoding: unused
1725 * subpixel motion estimation comparison function
1726 * - encoding: Set by user.
1727 * - decoding: unused
1731 * macroblock comparison function (not supported yet)
1732 * - encoding: Set by user.
1733 * - decoding: unused
1737 * interlaced DCT comparison function
1738 * - encoding: Set by user.
1739 * - decoding: unused
1742 #define FF_CMP_SAD 0
1743 #define FF_CMP_SSE 1
1744 #define FF_CMP_SATD 2
1745 #define FF_CMP_DCT 3
1746 #define FF_CMP_PSNR 4
1747 #define FF_CMP_BIT 5
1749 #define FF_CMP_ZERO 7
1750 #define FF_CMP_VSAD 8
1751 #define FF_CMP_VSSE 9
1752 #define FF_CMP_NSSE 10
1753 #define FF_CMP_W53 11
1754 #define FF_CMP_W97 12
1755 #define FF_CMP_DCTMAX 13
1756 #define FF_CMP_DCT264 14
1757 #define FF_CMP_CHROMA 256
1760 * ME diamond size & shape
1761 * - encoding: Set by user.
1762 * - decoding: unused
1767 * amount of previous MV predictors (2a+1 x 2a+1 square)
1768 * - encoding: Set by user.
1769 * - decoding: unused
1771 int last_predictor_count;
1774 * prepass for motion estimation
1775 * - encoding: Set by user.
1776 * - decoding: unused
1781 * motion estimation prepass comparison function
1782 * - encoding: Set by user.
1783 * - decoding: unused
1788 * ME prepass diamond size & shape
1789 * - encoding: Set by user.
1790 * - decoding: unused
1796 * - encoding: Set by user.
1797 * - decoding: unused
1799 int me_subpel_quality;
1802 * callback to negotiate the pixelFormat
1803 * @param fmt is the list of formats which are supported by the codec,
1804 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1805 * The first is always the native one.
1806 * @return the chosen format
1807 * - encoding: unused
1808 * - decoding: Set by user, if not set the native format will be chosen.
1810 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1813 * DTG active format information (additional aspect ratio
1814 * information only used in DVB MPEG-2 transport streams)
1817 * - encoding: unused
1818 * - decoding: Set by decoder.
1820 int dtg_active_format;
1821 #define FF_DTG_AFD_SAME 8
1822 #define FF_DTG_AFD_4_3 9
1823 #define FF_DTG_AFD_16_9 10
1824 #define FF_DTG_AFD_14_9 11
1825 #define FF_DTG_AFD_4_3_SP_14_9 13
1826 #define FF_DTG_AFD_16_9_SP_14_9 14
1827 #define FF_DTG_AFD_SP_4_3 15
1830 * maximum motion estimation search range in subpel units
1831 * If 0 then no limit.
1833 * - encoding: Set by user.
1834 * - decoding: unused
1839 * intra quantizer bias
1840 * - encoding: Set by user.
1841 * - decoding: unused
1843 int intra_quant_bias;
1844 #define FF_DEFAULT_QUANT_BIAS 999999
1847 * inter quantizer bias
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 int inter_quant_bias;
1855 * - encoding: unused
1856 * - decoding: Which clrtable should be used for 8bit RGB images.
1857 * Tables have to be stored somewhere. FIXME
1862 * internal_buffer count
1863 * Don't touch, used by libavcodec default_get_buffer().
1865 int internal_buffer_count;
1869 * Don't touch, used by libavcodec default_get_buffer().
1871 void *internal_buffer;
1873 #define FF_LAMBDA_SHIFT 7
1874 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1875 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1876 #define FF_LAMBDA_MAX (256*128-1)
1878 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1880 * Global quality for codecs which cannot change it per frame.
1881 * This should be proportional to MPEG-1/2/4 qscale.
1882 * - encoding: Set by user.
1883 * - decoding: unused
1887 #define FF_CODER_TYPE_VLC 0
1888 #define FF_CODER_TYPE_AC 1
1889 #define FF_CODER_TYPE_RAW 2
1890 #define FF_CODER_TYPE_RLE 3
1891 #define FF_CODER_TYPE_DEFLATE 4
1894 * - encoding: Set by user.
1895 * - decoding: unused
1901 * - encoding: Set by user.
1902 * - decoding: unused
1908 * - encoding: unused
1909 * - decoding: Set by user.
1911 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1916 * - encoding: unused
1917 * - decoding: Set by user.
1920 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1921 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1922 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1925 * XVideo Motion Acceleration
1926 * - encoding: forbidden
1927 * - decoding: set by decoder
1929 int xvmc_acceleration;
1932 * macroblock decision mode
1933 * - encoding: Set by user.
1934 * - decoding: unused
1937 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1938 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1939 #define FF_MB_DECISION_RD 2 ///< rate distortion
1942 * custom intra quantization matrix
1943 * - encoding: Set by user, can be NULL.
1944 * - decoding: Set by libavcodec.
1946 uint16_t *intra_matrix;
1949 * custom inter quantization matrix
1950 * - encoding: Set by user, can be NULL.
1951 * - decoding: Set by libavcodec.
1953 uint16_t *inter_matrix;
1956 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1957 * This is used to work around some encoder bugs.
1958 * - encoding: unused
1959 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1961 unsigned int stream_codec_tag;
1964 * scene change detection threshold
1965 * 0 is default, larger means fewer detected scene changes.
1966 * - encoding: Set by user.
1967 * - decoding: unused
1969 int scenechange_threshold;
1972 * minimum Lagrange multipler
1973 * - encoding: Set by user.
1974 * - decoding: unused
1979 * maximum Lagrange multipler
1980 * - encoding: Set by user.
1981 * - decoding: unused
1986 * palette control structure
1987 * - encoding: ??? (no palette-enabled encoder yet)
1988 * - decoding: Set by user.
1990 struct AVPaletteControl *palctrl;
1993 * noise reduction strength
1994 * - encoding: Set by user.
1995 * - decoding: unused
1997 int noise_reduction;
2000 * Called at the beginning of a frame to get cr buffer for it.
2001 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2002 * libavcodec will pass previous buffer in pic, function should return
2003 * same buffer or new buffer with old frame "painted" into it.
2004 * If pic.data[0] == NULL must behave like get_buffer().
2005 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2006 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2008 * - encoding: unused
2009 * - decoding: Set by libavcodec., user can override
2011 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2014 * Number of bits which should be loaded into the rc buffer before decoding starts.
2015 * - encoding: Set by user.
2016 * - decoding: unused
2018 int rc_initial_buffer_occupancy;
2022 * - encoding: Set by user.
2023 * - decoding: unused
2025 int inter_threshold;
2029 * - encoding: Set by user.
2030 * - decoding: Set by user.
2035 * Simulates errors in the bitstream to test error concealment.
2036 * - encoding: Set by user.
2037 * - decoding: unused
2042 * MP3 antialias algorithm, see FF_AA_* below.
2043 * - encoding: unused
2044 * - decoding: Set by user.
2047 #define FF_AA_AUTO 0
2048 #define FF_AA_FASTINT 1 //not implemented yet
2050 #define FF_AA_FLOAT 3
2052 * quantizer noise shaping
2053 * - encoding: Set by user.
2054 * - decoding: unused
2056 int quantizer_noise_shaping;
2060 * is used to decide how many independent tasks should be passed to execute()
2061 * - encoding: Set by user.
2062 * - decoding: Set by user.
2067 * The codec may call this to execute several independent things.
2068 * It will return only after finishing all tasks.
2069 * The user may replace this with some multithreaded implementation,
2070 * the default implementation will execute the parts serially.
2071 * @param count the number of things to execute
2072 * - encoding: Set by libavcodec, user can override.
2073 * - decoding: Set by libavcodec, user can override.
2075 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2079 * Can be used by execute() to store some per AVCodecContext stuff.
2080 * - encoding: set by execute()
2081 * - decoding: set by execute()
2083 void *thread_opaque;
2086 * Motion estimation threshold below which no motion estimation is
2087 * performed, but instead the user specified motion vectors are used.
2089 * - encoding: Set by user.
2090 * - decoding: unused
2095 * Macroblock threshold below which the user specified macroblock types will be used.
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * precision of the intra DC coefficient - 8
2103 * - encoding: Set by user.
2104 * - decoding: unused
2106 int intra_dc_precision;
2109 * noise vs. sse weight for the nsse comparsion function
2110 * - encoding: Set by user.
2111 * - decoding: unused
2116 * Number of macroblock rows at the top which are skipped.
2117 * - encoding: unused
2118 * - decoding: Set by user.
2123 * Number of macroblock rows at the bottom which are skipped.
2124 * - encoding: unused
2125 * - decoding: Set by user.
2131 * - encoding: Set by user.
2132 * - decoding: Set by libavcodec.
2135 #define FF_PROFILE_UNKNOWN -99
2137 #define FF_PROFILE_AAC_MAIN 0
2138 #define FF_PROFILE_AAC_LOW 1
2139 #define FF_PROFILE_AAC_SSR 2
2140 #define FF_PROFILE_AAC_LTP 3
2142 #define FF_PROFILE_H264_BASELINE 66
2143 #define FF_PROFILE_H264_MAIN 77
2144 #define FF_PROFILE_H264_EXTENDED 88
2145 #define FF_PROFILE_H264_HIGH 100
2146 #define FF_PROFILE_H264_HIGH_10 110
2147 #define FF_PROFILE_H264_HIGH_422 122
2148 #define FF_PROFILE_H264_HIGH_444 244
2149 #define FF_PROFILE_H264_CAVLC_444 44
2153 * - encoding: Set by user.
2154 * - decoding: Set by libavcodec.
2157 #define FF_LEVEL_UNKNOWN -99
2160 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2161 * - encoding: unused
2162 * - decoding: Set by user.
2167 * Bitstream width / height, may be different from width/height if lowres
2168 * or other things are used.
2169 * - encoding: unused
2170 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2172 int coded_width, coded_height;
2175 * frame skip threshold
2176 * - encoding: Set by user.
2177 * - decoding: unused
2179 int frame_skip_threshold;
2183 * - encoding: Set by user.
2184 * - decoding: unused
2186 int frame_skip_factor;
2189 * frame skip exponent
2190 * - encoding: Set by user.
2191 * - decoding: unused
2196 * frame skip comparison function
2197 * - encoding: Set by user.
2198 * - decoding: unused
2203 * Border processing masking, raises the quantizer for mbs on the borders
2205 * - encoding: Set by user.
2206 * - decoding: unused
2208 float border_masking;
2211 * minimum MB lagrange multipler
2212 * - encoding: Set by user.
2213 * - decoding: unused
2218 * maximum MB lagrange multipler
2219 * - encoding: Set by user.
2220 * - decoding: unused
2226 * - encoding: Set by user.
2227 * - decoding: unused
2229 int me_penalty_compensation;
2233 * - encoding: unused
2234 * - decoding: Set by user.
2236 enum AVDiscard skip_loop_filter;
2240 * - encoding: unused
2241 * - decoding: Set by user.
2243 enum AVDiscard skip_idct;
2247 * - encoding: unused
2248 * - decoding: Set by user.
2250 enum AVDiscard skip_frame;
2254 * - encoding: Set by user.
2255 * - decoding: unused
2261 * - encoding: Set by user.
2262 * - decoding: unused
2267 * constant rate factor - quality-based VBR - values ~correspond to qps
2268 * - encoding: Set by user.
2269 * - decoding: unused
2274 * constant quantization parameter rate control method
2275 * - encoding: Set by user.
2276 * - decoding: unused
2282 * - encoding: Set by user.
2283 * - decoding: unused
2288 * number of reference frames
2289 * - encoding: Set by user.
2290 * - decoding: Set by lavc.
2295 * chroma qp offset from luma
2296 * - encoding: Set by user.
2297 * - decoding: unused
2302 * Influences how often B-frames are used.
2303 * - encoding: Set by user.
2304 * - decoding: unused
2309 * trellis RD quantization
2310 * - encoding: Set by user.
2311 * - decoding: unused
2316 * Reduce fluctuations in qp (before curve compression).
2317 * - encoding: Set by user.
2318 * - decoding: unused
2320 float complexityblur;
2323 * in-loop deblocking filter alphac0 parameter
2324 * alpha is in the range -6...6
2325 * - encoding: Set by user.
2326 * - decoding: unused
2331 * in-loop deblocking filter beta parameter
2332 * beta is in the range -6...6
2333 * - encoding: Set by user.
2334 * - decoding: unused
2339 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2340 * - encoding: Set by user.
2341 * - decoding: unused
2344 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2345 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2346 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2347 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2348 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2351 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2352 * - encoding: Set by user.
2353 * - decoding: unused
2358 * Audio cutoff bandwidth (0 means "automatic")
2359 * - encoding: Set by user.
2360 * - decoding: unused
2365 * Multiplied by qscale for each frame and added to scene_change_score.
2366 * - encoding: Set by user.
2367 * - decoding: unused
2369 int scenechange_factor;
2373 * Note: Value depends upon the compare function used for fullpel ME.
2374 * - encoding: Set by user.
2375 * - decoding: unused
2380 * Adjusts sensitivity of b_frame_strategy 1.
2381 * - encoding: Set by user.
2382 * - decoding: unused
2387 * - encoding: Set by user.
2388 * - decoding: unused
2390 int compression_level;
2391 #define FF_COMPRESSION_DEFAULT -1
2394 * Sets whether to use LPC mode - used by FLAC encoder.
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * LPC coefficient precision - used by FLAC encoder
2402 * - encoding: Set by user.
2403 * - decoding: unused
2405 int lpc_coeff_precision;
2408 * - encoding: Set by user.
2409 * - decoding: unused
2411 int min_prediction_order;
2414 * - encoding: Set by user.
2415 * - decoding: unused
2417 int max_prediction_order;
2420 * search method for selecting prediction order
2421 * - encoding: Set by user.
2422 * - decoding: unused
2424 int prediction_order_method;
2427 * - encoding: Set by user.
2428 * - decoding: unused
2430 int min_partition_order;
2433 * - encoding: Set by user.
2434 * - decoding: unused
2436 int max_partition_order;
2439 * GOP timecode frame start number, in non drop frame format
2440 * - encoding: Set by user.
2441 * - decoding: unused
2443 int64_t timecode_frame_start;
2445 #if LIBAVCODEC_VERSION_MAJOR < 53
2447 * Decoder should decode to this many channels if it can (0 for default)
2448 * - encoding: unused
2449 * - decoding: Set by user.
2450 * @deprecated Deprecated in favor of request_channel_layout.
2452 int request_channels;
2456 * Percentage of dynamic range compression to be applied by the decoder.
2457 * The default value is 1.0, corresponding to full compression.
2458 * - encoding: unused
2459 * - decoding: Set by user.
2464 * opaque 64bit number (generally a PTS) that will be reordered and
2465 * output in AVFrame.reordered_opaque
2466 * - encoding: unused
2467 * - decoding: Set by user.
2469 int64_t reordered_opaque;
2472 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2473 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2474 * - encoding: set by user.
2475 * - decoding: set by libavcodec.
2477 int bits_per_raw_sample;
2480 * Audio channel layout.
2481 * - encoding: set by user.
2482 * - decoding: set by libavcodec.
2484 int64_t channel_layout;
2487 * Request decoder to use this channel layout if it can (0 for default)
2488 * - encoding: unused
2489 * - decoding: Set by user.
2491 int64_t request_channel_layout;
2494 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2495 * - encoding: Set by user.
2496 * - decoding: unused.
2498 float rc_max_available_vbv_use;
2501 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2502 * - encoding: Set by user.
2503 * - decoding: unused.
2505 float rc_min_vbv_overflow_use;
2508 * Hardware accelerator in use
2509 * - encoding: unused.
2510 * - decoding: Set by libavcodec
2512 struct AVHWAccel *hwaccel;
2515 * For some codecs, the time base is closer to the field rate than the frame rate.
2516 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2517 * if no telecine is used ...
2519 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2521 int ticks_per_frame;
2524 * Hardware accelerator context.
2525 * For some hardware accelerators, a global context needs to be
2526 * provided by the user. In that case, this holds display-dependent
2527 * data FFmpeg cannot instantiate itself. Please refer to the
2528 * FFmpeg HW accelerator documentation to know how to fill this
2529 * is. e.g. for VA API, this is a struct vaapi_context.
2530 * - encoding: unused
2531 * - decoding: Set by user
2533 void *hwaccel_context;
2536 * Chromaticity coordinates of the source primaries.
2537 * - encoding: Set by user
2538 * - decoding: Set by libavcodec
2540 enum AVColorPrimaries color_primaries;
2543 * Color Transfer Characteristic.
2544 * - encoding: Set by user
2545 * - decoding: Set by libavcodec
2547 enum AVColorTransferCharacteristic color_trc;
2550 * YUV colorspace type.
2551 * - encoding: Set by user
2552 * - decoding: Set by libavcodec
2554 enum AVColorSpace colorspace;
2557 * MPEG vs JPEG YUV range.
2558 * - encoding: Set by user
2559 * - decoding: Set by libavcodec
2561 enum AVColorRange color_range;
2564 * This defines the location of chroma samples.
2565 * - encoding: Set by user
2566 * - decoding: Set by libavcodec
2568 enum AVChromaLocation chroma_sample_location;
2571 * The codec may call this to execute several independent things.
2572 * It will return only after finishing all tasks.
2573 * The user may replace this with some multithreaded implementation,
2574 * the default implementation will execute the parts serially.
2575 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2576 * @param c context passed also to func
2577 * @param count the number of things to execute
2578 * @param arg2 argument passed unchanged to func
2579 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2580 * @param func function that will be called count times, with jobnr from 0 to count-1.
2581 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2582 * two instances of func executing at the same time will have the same threadnr.
2583 * @return always 0 currently, but code should handle a future improvement where when any call to func
2584 * returns < 0 no further calls to func may be done and < 0 is returned.
2585 * - encoding: Set by libavcodec, user can override.
2586 * - decoding: Set by libavcodec, user can override.
2588 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2591 * explicit P-frame weighted prediction analysis method
2593 * 1: fast blind weighting (one reference duplicate with -1 offset)
2594 * 2: smart weighting (full fade detection analysis)
2595 * - encoding: Set by user.
2596 * - decoding: unused
2598 int weighted_p_pred;
2604 typedef struct AVCodec {
2606 * Name of the codec implementation.
2607 * The name is globally unique among encoders and among decoders (but an
2608 * encoder and a decoder can share the same name).
2609 * This is the primary way to find a codec from the user perspective.
2612 enum CodecType type;
2615 int (*init)(AVCodecContext *);
2616 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2617 int (*close)(AVCodecContext *);
2618 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2620 * Codec capabilities.
2624 struct AVCodec *next;
2627 * Will be called when seeking
2629 void (*flush)(AVCodecContext *);
2630 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2631 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2633 * Descriptive name for the codec, meant to be more human readable than name.
2634 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2636 const char *long_name;
2637 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2638 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2639 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2645 typedef struct AVHWAccel {
2647 * Name of the hardware accelerated codec.
2648 * The name is globally unique among encoders and among decoders (but an
2649 * encoder and a decoder can share the same name).
2654 * Type of codec implemented by the hardware accelerator.
2656 * See CODEC_TYPE_xxx
2658 enum CodecType type;
2661 * Codec implemented by the hardware accelerator.
2668 * Supported pixel format.
2670 * Only hardware accelerated formats are supported here.
2672 enum PixelFormat pix_fmt;
2675 * Hardware accelerated codec capabilities.
2676 * see FF_HWACCEL_CODEC_CAP_*
2680 struct AVHWAccel *next;
2683 * Called at the beginning of each frame or field picture.
2685 * Meaningful frame information (codec specific) is guaranteed to
2686 * be parsed at this point. This function is mandatory.
2688 * Note that buf can be NULL along with buf_size set to 0.
2689 * Otherwise, this means the whole frame is available at this point.
2691 * @param avctx the codec context
2692 * @param buf the frame data buffer base
2693 * @param buf_size the size of the frame in bytes
2694 * @return zero if successful, a negative value otherwise
2696 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2699 * Callback for each slice.
2701 * Meaningful slice information (codec specific) is guaranteed to
2702 * be parsed at this point. This function is mandatory.
2704 * @param avctx the codec context
2705 * @param buf the slice data buffer base
2706 * @param buf_size the size of the slice in bytes
2707 * @return zero if successful, a negative value otherwise
2709 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2712 * Called at the end of each frame or field picture.
2714 * The whole picture is parsed at this point and can now be sent
2715 * to the hardware accelerator. This function is mandatory.
2717 * @param avctx the codec context
2718 * @return zero if successful, a negative value otherwise
2720 int (*end_frame)(AVCodecContext *avctx);
2723 * Size of HW accelerator private data.
2725 * Private data is allocated with av_mallocz() before
2726 * AVCodecContext.get_buffer() and deallocated after
2727 * AVCodecContext.release_buffer().
2733 * four components are given, that's all.
2734 * the last component is alpha
2736 typedef struct AVPicture {
2738 int linesize[4]; ///< number of bytes per line
2741 #if LIBAVCODEC_VERSION_MAJOR < 53
2744 * This structure defines a method for communicating palette changes
2745 * between and demuxer and a decoder.
2747 * @deprecated Use AVPacket to send palette changes instead.
2748 * This is totally broken.
2750 #define AVPALETTE_SIZE 1024
2751 #define AVPALETTE_COUNT 256
2752 typedef struct AVPaletteControl {
2754 /* Demuxer sets this to 1 to indicate the palette has changed;
2755 * decoder resets to 0. */
2756 int palette_changed;
2758 /* 4-byte ARGB palette entries, stored in native byte order; note that
2759 * the individual palette components should be on a 8-bit scale; if
2760 * the palette data comes from an IBM VGA native format, the component
2761 * data is probably 6 bits in size and needs to be scaled. */
2762 unsigned int palette[AVPALETTE_COUNT];
2764 } AVPaletteControl attribute_deprecated;
2767 enum AVSubtitleType {
2770 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2773 * Plain text, the text field must be set by the decoder and is
2774 * authoritative. ass and pict fields may contain approximations.
2779 * Formatted text, the ass field must be set by the decoder and is
2780 * authoritative. pict and text fields may contain approximations.
2785 typedef struct AVSubtitleRect {
2786 int x; ///< top left corner of pict, undefined when pict is not set
2787 int y; ///< top left corner of pict, undefined when pict is not set
2788 int w; ///< width of pict, undefined when pict is not set
2789 int h; ///< height of pict, undefined when pict is not set
2790 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2793 * data+linesize for the bitmap of this subtitle.
2794 * can be set for text/ass as well once they where rendered
2797 enum AVSubtitleType type;
2799 char *text; ///< 0 terminated plain UTF-8 text
2802 * 0 terminated ASS/SSA compatible event line.
2803 * The pressentation of this is unaffected by the other values in this
2809 typedef struct AVSubtitle {
2810 uint16_t format; /* 0 = graphics */
2811 uint32_t start_display_time; /* relative to packet pts, in ms */
2812 uint32_t end_display_time; /* relative to packet pts, in ms */
2814 AVSubtitleRect **rects;
2815 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
2818 /* packet functions */
2821 * @deprecated use NULL instead
2823 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2826 * Default packet destructor.
2828 void av_destruct_packet(AVPacket *pkt);
2831 * Initialize optional fields of a packet with default values.
2835 void av_init_packet(AVPacket *pkt);
2838 * Allocate the payload of a packet and initialize its fields with
2842 * @param size wanted payload size
2843 * @return 0 if OK, AVERROR_xxx otherwise
2845 int av_new_packet(AVPacket *pkt, int size);
2848 * Reduce packet size, correctly zeroing padding
2851 * @param size new size
2853 void av_shrink_packet(AVPacket *pkt, int size);
2856 * @warning This is a hack - the packet memory allocation stuff is broken. The
2857 * packet is allocated if it was not really allocated.
2859 int av_dup_packet(AVPacket *pkt);
2864 * @param pkt packet to free
2866 void av_free_packet(AVPacket *pkt);
2870 struct ReSampleContext;
2871 struct AVResampleContext;
2873 typedef struct ReSampleContext ReSampleContext;
2875 #if LIBAVCODEC_VERSION_MAJOR < 53
2877 * @deprecated Use av_audio_resample_init() instead.
2879 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2880 int output_rate, int input_rate);
2883 * Initializes audio resampling context
2885 * @param output_channels number of output channels
2886 * @param input_channels number of input channels
2887 * @param output_rate output sample rate
2888 * @param input_rate input sample rate
2889 * @param sample_fmt_out requested output sample format
2890 * @param sample_fmt_in input sample format
2891 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2892 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2893 * @param linear If 1 then the used FIR filter will be linearly interpolated
2894 between the 2 closest, if 0 the closest will be used
2895 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2896 * @return allocated ReSampleContext, NULL if error occured
2898 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2899 int output_rate, int input_rate,
2900 enum SampleFormat sample_fmt_out,
2901 enum SampleFormat sample_fmt_in,
2902 int filter_length, int log2_phase_count,
2903 int linear, double cutoff);
2905 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2906 void audio_resample_close(ReSampleContext *s);
2910 * Initializes an audio resampler.
2911 * Note, if either rate is not an integer then simply scale both rates up so they are.
2912 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2913 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2914 * @param linear If 1 then the used FIR filter will be linearly interpolated
2915 between the 2 closest, if 0 the closest will be used
2916 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2918 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2922 * @param src an array of unconsumed samples
2923 * @param consumed the number of samples of src which have been consumed are returned here
2924 * @param src_size the number of unconsumed samples available
2925 * @param dst_size the amount of space in samples available in dst
2926 * @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.
2927 * @return the number of samples written in dst or -1 if an error occurred
2929 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2933 * Compensates samplerate/timestamp drift. The compensation is done by changing
2934 * the resampler parameters, so no audible clicks or similar distortions occur
2935 * @param compensation_distance distance in output samples over which the compensation should be performed
2936 * @param sample_delta number of output samples which should be output less
2938 * example: av_resample_compensate(c, 10, 500)
2939 * here instead of 510 samples only 500 samples would be output
2941 * note, due to rounding the actual compensation might be slightly different,
2942 * especially if the compensation_distance is large and the in_rate used during init is small
2944 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2945 void av_resample_close(struct AVResampleContext *c);
2948 * Allocate memory for a picture. Call avpicture_free to free it.
2950 * @param picture the picture to be filled in
2951 * @param pix_fmt the format of the picture
2952 * @param width the width of the picture
2953 * @param height the height of the picture
2954 * @return zero if successful, a negative value if not
2956 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2959 * Free a picture previously allocated by avpicture_alloc().
2961 * @param picture the AVPicture to be freed
2963 void avpicture_free(AVPicture *picture);
2966 * Fill in the AVPicture fields.
2967 * The fields of the given AVPicture are filled in by using the 'ptr' address
2968 * which points to the image data buffer. Depending on the specified picture
2969 * format, one or multiple image data pointers and line sizes will be set.
2970 * If a planar format is specified, several pointers will be set pointing to
2971 * the different picture planes and the line sizes of the different planes
2972 * will be stored in the lines_sizes array.
2973 * Call with ptr == NULL to get the required size for the ptr buffer.
2975 * @param picture AVPicture whose fields are to be filled in
2976 * @param ptr Buffer which will contain or contains the actual image data
2977 * @param pix_fmt The format in which the picture data is stored.
2978 * @param width the width of the image in pixels
2979 * @param height the height of the image in pixels
2980 * @return size of the image data in bytes
2982 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2983 enum PixelFormat pix_fmt, int width, int height);
2984 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2985 unsigned char *dest, int dest_size);
2988 * Calculate the size in bytes that a picture of the given width and height
2989 * would occupy if stored in the given picture format.
2990 * Note that this returns the size of a compact representation as generated
2991 * by avpicture_layout, which can be smaller than the size required for e.g.
2994 * @param pix_fmt the given picture format
2995 * @param width the width of the image
2996 * @param height the height of the image
2997 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2999 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3000 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3001 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3002 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3004 #if LIBAVCODEC_VERSION_MAJOR < 53
3006 * Returns the pixel format corresponding to the name name.
3008 * If there is no pixel format with name name, then looks for a
3009 * pixel format with the name corresponding to the native endian
3011 * For example in a little-endian system, first looks for "gray16",
3012 * then for "gray16le".
3014 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
3016 * @deprecated Deprecated in favor of av_get_pix_fmt().
3018 attribute_deprecated enum PixelFormat avcodec_get_pix_fmt(const char* name);
3022 * Returns a value representing the fourCC code associated to the
3023 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3026 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3028 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3029 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3030 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3031 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3032 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3033 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3036 * Computes what kind of losses will occur when converting from one specific
3037 * pixel format to another.
3038 * When converting from one pixel format to another, information loss may occur.
3039 * For example, when converting from RGB24 to GRAY, the color information will
3040 * be lost. Similarly, other losses occur when converting from some formats to
3041 * other formats. These losses can involve loss of chroma, but also loss of
3042 * resolution, loss of color depth, loss due to the color space conversion, loss
3043 * of the alpha bits or loss due to color quantization.
3044 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3045 * which will occur when converting from one pixel format to another.
3047 * @param[in] dst_pix_fmt destination pixel format
3048 * @param[in] src_pix_fmt source pixel format
3049 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3050 * @return Combination of flags informing you what kind of losses will occur.
3052 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3056 * Finds the best pixel format to convert to given a certain source pixel
3057 * format. When converting from one pixel format to another, information loss
3058 * may occur. For example, when converting from RGB24 to GRAY, the color
3059 * information will be lost. Similarly, other losses occur when converting from
3060 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3061 * the given pixel formats should be used to suffer the least amount of loss.
3062 * The pixel formats from which it chooses one, are determined by the
3063 * pix_fmt_mask parameter.
3066 * src_pix_fmt = PIX_FMT_YUV420P;
3067 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3068 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3071 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3072 * @param[in] src_pix_fmt source pixel format
3073 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3074 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3075 * @return The best pixel format to convert to or -1 if none was found.
3077 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3078 int has_alpha, int *loss_ptr);
3082 * Print in buf the string corresponding to the pixel format with
3083 * number pix_fmt, or an header if pix_fmt is negative.
3085 * @param[in] buf the buffer where to write the string
3086 * @param[in] buf_size the size of buf
3087 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3088 * a negative value to print the corresponding header.
3089 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3091 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
3093 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3094 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3097 * Tell if an image really has transparent alpha values.
3098 * @return ored mask of FF_ALPHA_xxx constants
3100 int img_get_alpha_info(const AVPicture *src,
3101 enum PixelFormat pix_fmt, int width, int height);
3103 /* deinterlace a picture */
3104 /* deinterlace - if not supported return -1 */
3105 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3106 enum PixelFormat pix_fmt, int width, int height);
3108 /* external high level API */
3111 * If c is NULL, returns the first registered codec,
3112 * if c is non-NULL, returns the next registered codec after c,
3113 * or NULL if c is the last one.
3115 AVCodec *av_codec_next(AVCodec *c);
3118 * Returns the LIBAVCODEC_VERSION_INT constant.
3120 unsigned avcodec_version(void);
3123 * Returns the libavcodec build-time configuration.
3125 const char *avcodec_configuration(void);
3128 * Returns the libavcodec license.
3130 const char *avcodec_license(void);
3133 * Initializes libavcodec.
3135 * @warning This function must be called before any other libavcodec
3138 void avcodec_init(void);
3140 #if LIBAVCODEC_VERSION_MAJOR < 53
3142 * @deprecated Deprecated in favor of avcodec_register().
3144 attribute_deprecated void register_avcodec(AVCodec *codec);
3148 * Register the codec codec and initialize libavcodec.
3150 * @see avcodec_init()
3152 void avcodec_register(AVCodec *codec);
3155 * Finds a registered encoder with a matching codec ID.
3157 * @param id CodecID of the requested encoder
3158 * @return An encoder if one was found, NULL otherwise.
3160 AVCodec *avcodec_find_encoder(enum CodecID id);
3163 * Finds a registered encoder with the specified name.
3165 * @param name name of the requested encoder
3166 * @return An encoder if one was found, NULL otherwise.
3168 AVCodec *avcodec_find_encoder_by_name(const char *name);
3171 * Finds a registered decoder with a matching codec ID.
3173 * @param id CodecID of the requested decoder
3174 * @return A decoder if one was found, NULL otherwise.
3176 AVCodec *avcodec_find_decoder(enum CodecID id);
3179 * Finds a registered decoder with the specified name.
3181 * @param name name of the requested decoder
3182 * @return A decoder if one was found, NULL otherwise.
3184 AVCodec *avcodec_find_decoder_by_name(const char *name);
3185 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3188 * Sets the fields of the given AVCodecContext to default values.
3190 * @param s The AVCodecContext of which the fields should be set to default values.
3192 void avcodec_get_context_defaults(AVCodecContext *s);
3194 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3195 * we WILL change its arguments and name a few times! */
3196 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
3199 * Allocates an AVCodecContext and sets its fields to default values. The
3200 * resulting struct can be deallocated by simply calling av_free().
3202 * @return An AVCodecContext filled with default values or NULL on failure.
3203 * @see avcodec_get_context_defaults
3205 AVCodecContext *avcodec_alloc_context(void);
3207 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3208 * we WILL change its arguments and name a few times! */
3209 AVCodecContext *avcodec_alloc_context2(enum CodecType);
3212 * Sets the fields of the given AVFrame to default values.
3214 * @param pic The AVFrame of which the fields should be set to default values.
3216 void avcodec_get_frame_defaults(AVFrame *pic);
3219 * Allocates an AVFrame and sets its fields to default values. The resulting
3220 * struct can be deallocated by simply calling av_free().
3222 * @return An AVFrame filled with default values or NULL on failure.
3223 * @see avcodec_get_frame_defaults
3225 AVFrame *avcodec_alloc_frame(void);
3227 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3228 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3229 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3231 * Modifies width and height values so that they will result in a memory
3232 * buffer that is acceptable for the codec if you do not use any horizontal
3235 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3237 * Modifies width and height values so that they will result in a memory
3238 * buffer that is acceptable for the codec if you also ensure that all
3239 * line sizes are a multiple of the respective linesize_align[i].
3241 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3242 int linesize_align[4]);
3245 * Checks if the given dimension of a picture is valid, meaning that all
3246 * bytes of the picture can be addressed with a signed int.
3248 * @param[in] w Width of the picture.
3249 * @param[in] h Height of the picture.
3250 * @return Zero if valid, a negative value if invalid.
3252 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3253 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3255 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3256 void avcodec_thread_free(AVCodecContext *s);
3257 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3258 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3259 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3260 //FIXME func typedef
3263 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3264 * function the context has to be allocated.
3266 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3267 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3268 * retrieving a codec.
3270 * @warning This function is not thread safe!
3273 * avcodec_register_all();
3274 * codec = avcodec_find_decoder(CODEC_ID_H264);
3278 * context = avcodec_alloc_context();
3280 * if (avcodec_open(context, codec) < 0)
3284 * @param avctx The context which will be set up to use the given codec.
3285 * @param codec The codec to use within the context.
3286 * @return zero on success, a negative value on error
3287 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3289 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3291 #if LIBAVCODEC_VERSION_MAJOR < 53
3293 * Decodes an audio frame from buf into samples.
3294 * Wrapper function which calls avcodec_decode_audio3.
3296 * @deprecated Use avcodec_decode_audio3 instead.
3297 * @param avctx the codec context
3298 * @param[out] samples the output buffer
3299 * @param[in,out] frame_size_ptr the output buffer size in bytes
3300 * @param[in] buf the input buffer
3301 * @param[in] buf_size the input buffer size in bytes
3302 * @return On error a negative value is returned, otherwise the number of bytes
3303 * used or zero if no frame could be decompressed.
3305 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3306 int *frame_size_ptr,
3307 const uint8_t *buf, int buf_size);
3311 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3312 * Some decoders may support multiple frames in a single AVPacket, such
3313 * decoders would then just decode the first frame. In this case,
3314 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3315 * the remaining data in order to decode the second frame etc.
3317 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3318 * decompressed frame size in bytes.
3320 * @warning You must set frame_size_ptr to the allocated size of the
3321 * output buffer before calling avcodec_decode_audio3().
3323 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3324 * the actual read bytes because some optimized bitstream readers read 32 or 64
3325 * bits at once and could read over the end.
3327 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3328 * no overreading happens for damaged MPEG streams.
3330 * @note You might have to align the input buffer avpkt->data and output buffer
3331 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3332 * necessary at all, on others it won't work at all if not aligned and on others
3333 * it will work but it will have an impact on performance.
3335 * In practice, avpkt->data should have 4 byte alignment at minimum and
3336 * samples should be 16 byte aligned unless the CPU doesn't need it
3337 * (AltiVec and SSE do).
3339 * @param avctx the codec context
3340 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3341 * @param[in,out] frame_size_ptr the output buffer size in bytes
3342 * @param[in] avpkt The input AVPacket containing the input buffer.
3343 * You can create such packet with av_init_packet() and by then setting
3344 * data and size, some decoders might in addition need other fields.
3345 * All decoders are designed to use the least fields possible though.
3346 * @return On error a negative value is returned, otherwise the number of bytes
3347 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3349 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3350 int *frame_size_ptr,
3353 #if LIBAVCODEC_VERSION_MAJOR < 53
3355 * Decodes a video frame from buf into picture.
3356 * Wrapper function which calls avcodec_decode_video2.
3358 * @deprecated Use avcodec_decode_video2 instead.
3359 * @param avctx the codec context
3360 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3361 * @param[in] buf the input buffer
3362 * @param[in] buf_size the size of the input buffer in bytes
3363 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3364 * @return On error a negative value is returned, otherwise the number of bytes
3365 * used or zero if no frame could be decompressed.
3367 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3368 int *got_picture_ptr,
3369 const uint8_t *buf, int buf_size);
3373 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3374 * Some decoders may support multiple frames in a single AVPacket, such
3375 * decoders would then just decode the first frame.
3377 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3378 * the actual read bytes because some optimized bitstream readers read 32 or 64
3379 * bits at once and could read over the end.
3381 * @warning The end of the input buffer buf should be set to 0 to ensure that
3382 * no overreading happens for damaged MPEG streams.
3384 * @note You might have to align the input buffer avpkt->data.
3385 * The alignment requirements depend on the CPU: on some CPUs it isn't
3386 * necessary at all, on others it won't work at all if not aligned and on others
3387 * it will work but it will have an impact on performance.
3389 * In practice, avpkt->data should have 4 byte alignment at minimum.
3391 * @note Some codecs have a delay between input and output, these need to be
3392 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3394 * @param avctx the codec context
3395 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3396 * @param[in] avpkt The input AVpacket containing the input buffer.
3397 * You can create such packet with av_init_packet() and by then setting
3398 * data and size, some decoders might in addition need other fields like
3399 * flags&PKT_FLAG_KEY. All decoders are designed to use the least
3401 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3402 * @return On error a negative value is returned, otherwise the number of bytes
3403 * used or zero if no frame could be decompressed.
3405 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3406 int *got_picture_ptr,
3409 #if LIBAVCODEC_VERSION_MAJOR < 53
3410 /* Decode a subtitle message. Return -1 if error, otherwise return the
3411 * number of bytes used. If no subtitle could be decompressed,
3412 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3413 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3415 const uint8_t *buf, int buf_size);
3419 * Decodes a subtitle message.
3420 * Returns a negative value on error, otherwise returns the number of bytes used.
3421 * If no subtitle could be decompressed, got_sub_ptr is zero.
3422 * Otherwise, the subtitle is stored in *sub.
3424 * @param avctx the codec context
3425 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3426 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3427 * @param[in] avpkt The input AVPacket containing the input buffer.
3429 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3432 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3434 uint8_t *buf, int buf_size);
3437 * Encodes an audio frame from samples into buf.
3439 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3440 * However, for PCM audio the user will know how much space is needed
3441 * because it depends on the value passed in buf_size as described
3442 * below. In that case a lower value can be used.
3444 * @param avctx the codec context
3445 * @param[out] buf the output buffer
3446 * @param[in] buf_size the output buffer size
3447 * @param[in] samples the input buffer containing the samples
3448 * The number of samples read from this buffer is frame_size*channels,
3449 * both of which are defined in avctx.
3450 * For PCM audio the number of samples read from samples is equal to
3451 * buf_size * input_sample_size / output_sample_size.
3452 * @return On error a negative value is returned, on success zero or the number
3453 * of bytes used to encode the data read from the input buffer.
3455 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3456 const short *samples);
3459 * Encodes a video frame from pict into buf.
3460 * The input picture should be
3461 * stored using a specific format, namely avctx.pix_fmt.
3463 * @param avctx the codec context
3464 * @param[out] buf the output buffer for the bitstream of encoded frame
3465 * @param[in] buf_size the size of the output buffer in bytes
3466 * @param[in] pict the input picture to encode
3467 * @return On error a negative value is returned, on success zero or the number
3468 * of bytes used from the output buffer.
3470 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3471 const AVFrame *pict);
3472 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3473 const AVSubtitle *sub);
3475 int avcodec_close(AVCodecContext *avctx);
3478 * Register all the codecs, parsers and bitstream filters which were enabled at
3479 * configuration time. If you do not call this function you can select exactly
3480 * which formats you want to support, by using the individual registration
3483 * @see avcodec_register
3484 * @see av_register_codec_parser
3485 * @see av_register_bitstream_filter
3487 void avcodec_register_all(void);
3490 * Flush buffers, should be called when seeking or when switching to a different stream.
3492 void avcodec_flush_buffers(AVCodecContext *avctx);
3494 void avcodec_default_free_buffers(AVCodecContext *s);
3496 /* misc useful functions */
3499 * Returns a single letter to describe the given picture type pict_type.
3501 * @param[in] pict_type the picture type
3502 * @return A single character representing the picture type.
3504 char av_get_pict_type_char(int pict_type);
3507 * Returns codec bits per sample.
3509 * @param[in] codec_id the codec
3510 * @return Number of bits per sample or zero if unknown for the given codec.
3512 int av_get_bits_per_sample(enum CodecID codec_id);
3515 * Returns sample format bits per sample.
3517 * @param[in] sample_fmt the sample format
3518 * @return Number of bits per sample or zero if unknown for the given sample format.
3520 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3523 typedef struct AVCodecParserContext {
3525 struct AVCodecParser *parser;
3526 int64_t frame_offset; /* offset of the current frame */
3527 int64_t cur_offset; /* current offset
3528 (incremented by each av_parser_parse()) */
3529 int64_t next_frame_offset; /* offset of the next frame */
3531 int pict_type; /* XXX: Put it back in AVCodecContext. */
3533 * This field is used for proper frame duration computation in lavf.
3534 * It signals, how much longer the frame duration of the current frame
3535 * is compared to normal frame duration.
3537 * frame_duration = (1 + repeat_pict) * time_base
3539 * It is used by codecs like H.264 to display telecined material.
3541 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3542 int64_t pts; /* pts of the current frame */
3543 int64_t dts; /* dts of the current frame */
3548 int fetch_timestamp;
3550 #define AV_PARSER_PTS_NB 4
3551 int cur_frame_start_index;
3552 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3553 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3554 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3557 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3559 int64_t offset; ///< byte offset from starting packet start
3560 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3563 * Set by parser to 1 for key frames and 0 for non-key frames.
3564 * It is initialized to -1, so if the parser doesn't set this flag,
3565 * old-style fallback using FF_I_TYPE picture type as key frames
3571 * Time difference in stream time base units from the pts of this
3572 * packet to the point at which the output from the decoder has converged
3573 * independent from the availability of previous frames. That is, the
3574 * frames are virtually identical no matter if decoding started from
3575 * the very first frame or from this keyframe.
3576 * Is AV_NOPTS_VALUE if unknown.
3577 * This field is not the display duration of the current frame.
3579 * The purpose of this field is to allow seeking in streams that have no
3580 * keyframes in the conventional sense. It corresponds to the
3581 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3582 * essential for some types of subtitle streams to ensure that all
3583 * subtitles are correctly displayed after seeking.
3585 int64_t convergence_duration;
3587 // Timestamp generation support:
3589 * Synchronization point for start of timestamp generation.
3591 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3594 * For example, this corresponds to presence of H.264 buffering period
3600 * Offset of the current timestamp against last timestamp sync point in
3601 * units of AVCodecContext.time_base.
3603 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3604 * contain a valid timestamp offset.
3606 * Note that the timestamp of sync point has usually a nonzero
3607 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3608 * the next frame after timestamp sync point will be usually 1.
3610 * For example, this corresponds to H.264 cpb_removal_delay.
3612 int dts_ref_dts_delta;
3615 * Presentation delay of current frame in units of AVCodecContext.time_base.
3617 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3618 * contain valid non-negative timestamp delta (presentation time of a frame
3619 * must not lie in the past).
3621 * This delay represents the difference between decoding and presentation
3622 * time of the frame.
3624 * For example, this corresponds to H.264 dpb_output_delay.
3629 * Position of the packet in file.
3631 * Analogous to cur_frame_pts/dts
3633 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3636 * Byte position of currently parsed frame in stream.
3641 * Previous frame byte position.
3644 } AVCodecParserContext;
3646 typedef struct AVCodecParser {
3647 int codec_ids[5]; /* several codec IDs are permitted */
3649 int (*parser_init)(AVCodecParserContext *s);
3650 int (*parser_parse)(AVCodecParserContext *s,
3651 AVCodecContext *avctx,
3652 const uint8_t **poutbuf, int *poutbuf_size,
3653 const uint8_t *buf, int buf_size);
3654 void (*parser_close)(AVCodecParserContext *s);
3655 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3656 struct AVCodecParser *next;
3659 AVCodecParser *av_parser_next(AVCodecParser *c);
3661 void av_register_codec_parser(AVCodecParser *parser);
3662 AVCodecParserContext *av_parser_init(int codec_id);
3664 #if LIBAVCODEC_VERSION_MAJOR < 53
3665 attribute_deprecated
3666 int av_parser_parse(AVCodecParserContext *s,
3667 AVCodecContext *avctx,
3668 uint8_t **poutbuf, int *poutbuf_size,
3669 const uint8_t *buf, int buf_size,
3670 int64_t pts, int64_t dts);
3676 * @param s parser context.
3677 * @param avctx codec context.
3678 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3679 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3680 * @param buf input buffer.
3681 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3682 * @param pts input presentation timestamp.
3683 * @param dts input decoding timestamp.
3684 * @param pos input byte position in stream.
3685 * @return the number of bytes of the input bitstream used.
3690 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3697 * decode_frame(data, size);
3701 int av_parser_parse2(AVCodecParserContext *s,
3702 AVCodecContext *avctx,
3703 uint8_t **poutbuf, int *poutbuf_size,
3704 const uint8_t *buf, int buf_size,
3705 int64_t pts, int64_t dts,
3708 int av_parser_change(AVCodecParserContext *s,
3709 AVCodecContext *avctx,
3710 uint8_t **poutbuf, int *poutbuf_size,
3711 const uint8_t *buf, int buf_size, int keyframe);
3712 void av_parser_close(AVCodecParserContext *s);
3715 typedef struct AVBitStreamFilterContext {
3717 struct AVBitStreamFilter *filter;
3718 AVCodecParserContext *parser;
3719 struct AVBitStreamFilterContext *next;
3720 } AVBitStreamFilterContext;
3723 typedef struct AVBitStreamFilter {
3726 int (*filter)(AVBitStreamFilterContext *bsfc,
3727 AVCodecContext *avctx, const char *args,
3728 uint8_t **poutbuf, int *poutbuf_size,
3729 const uint8_t *buf, int buf_size, int keyframe);
3730 void (*close)(AVBitStreamFilterContext *bsfc);
3731 struct AVBitStreamFilter *next;
3732 } AVBitStreamFilter;
3734 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3735 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3736 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3737 AVCodecContext *avctx, const char *args,
3738 uint8_t **poutbuf, int *poutbuf_size,
3739 const uint8_t *buf, int buf_size, int keyframe);
3740 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3742 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3747 * Reallocates the given block if it is not large enough, otherwise it
3752 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3755 * Allocates a buffer, reusing the given one if large enough.
3757 * Contrary to av_fast_realloc the current buffer contents might not be
3758 * preserved and on error the old buffer is freed, thus no special
3759 * handling to avoid memleaks is necessary.
3761 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3762 * @param size size of the buffer *ptr points to
3763 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3764 * *size 0 if an error occurred.
3766 void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3769 * Copy image 'src' to 'dst'.
3771 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3772 enum PixelFormat pix_fmt, int width, int height);
3775 * Crop image top and left side.
3777 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3778 enum PixelFormat pix_fmt, int top_band, int left_band);
3783 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3784 int padtop, int padbottom, int padleft, int padright, int *color);
3786 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3789 * Parses str and put in width_ptr and height_ptr the detected values.
3791 * @return 0 in case of a successful parsing, a negative value otherwise
3792 * @param[in] str the string to parse: it has to be a string in the format
3793 * <width>x<height> or a valid video frame size abbreviation.
3794 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3796 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3797 * frame height value
3799 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3802 * Parses str and put in frame_rate the detected values.
3804 * @return 0 in case of a successful parsing, a negative value otherwise
3805 * @param[in] str the string to parse: it has to be a string in the format
3806 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3807 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3810 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3813 * Logs a generic warning message about a missing feature. This function is
3814 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3815 * only, and would normally not be used by applications.
3816 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3817 * a pointer to an AVClass struct
3818 * @param[in] feature string containing the name of the missing feature
3819 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3820 * If want_sample is non-zero, additional verbage will be added to the log
3821 * message which tells the user how to report samples to the development
3824 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3827 * Logs a generic warning message asking for a sample. This function is
3828 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3829 * only, and would normally not be used by applications.
3830 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3831 * a pointer to an AVClass struct
3832 * @param[in] msg string containing an optional message, or NULL if no message
3834 void av_log_ask_for_sample(void *avc, const char *msg);
3837 * Registers the hardware accelerator hwaccel.
3839 void av_register_hwaccel(AVHWAccel *hwaccel);
3842 * If hwaccel is NULL, returns the first registered hardware accelerator,
3843 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3844 * after hwaccel, or NULL if hwaccel is the last one.
3846 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3850 * Lock operation used by lockmgr
3853 AV_LOCK_CREATE, ///< Create a mutex
3854 AV_LOCK_OBTAIN, ///< Lock the mutex
3855 AV_LOCK_RELEASE, ///< Unlock the mutex
3856 AV_LOCK_DESTROY, ///< Free mutex resources
3860 * Register a user provided lock manager supporting the operations
3861 * specified by AVLockOp. mutex points to a (void *) where the
3862 * lockmgr should store/get a pointer to a user allocated mutex. It's
3863 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3865 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3866 * callback during the call to av_lockmgr_register().
3867 * Thus, the application must be prepared to handle that.
3868 * If cb is set to NULL the lockmgr will be unregistered.
3869 * Also note that during unregistration the previously registered
3870 * lockmgr callback may also be invoked.
3872 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
3874 #endif /* AVCODEC_AVCODEC_H */