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 35
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
,
202 /* various PCM "codecs" */
203 CODEC_ID_PCM_S16LE
= 0x10000,
219 CODEC_ID_PCM_S24DAUD
,
221 CODEC_ID_PCM_S16LE_PLANAR
,
229 /* various ADPCM codecs */
230 CODEC_ID_ADPCM_IMA_QT
= 0x11000,
231 CODEC_ID_ADPCM_IMA_WAV
,
232 CODEC_ID_ADPCM_IMA_DK3
,
233 CODEC_ID_ADPCM_IMA_DK4
,
234 CODEC_ID_ADPCM_IMA_WS
,
235 CODEC_ID_ADPCM_IMA_SMJPEG
,
244 CODEC_ID_ADPCM_YAMAHA
,
245 CODEC_ID_ADPCM_SBPRO_4
,
246 CODEC_ID_ADPCM_SBPRO_3
,
247 CODEC_ID_ADPCM_SBPRO_2
,
249 CODEC_ID_ADPCM_IMA_AMV
,
250 CODEC_ID_ADPCM_EA_R1
,
251 CODEC_ID_ADPCM_EA_R3
,
252 CODEC_ID_ADPCM_EA_R2
,
253 CODEC_ID_ADPCM_IMA_EA_SEAD
,
254 CODEC_ID_ADPCM_IMA_EA_EACS
,
255 CODEC_ID_ADPCM_EA_XAS
,
256 CODEC_ID_ADPCM_EA_MAXIS_XA
,
257 CODEC_ID_ADPCM_IMA_ISS
,
260 CODEC_ID_AMR_NB
= 0x12000,
263 /* RealAudio codecs*/
264 CODEC_ID_RA_144
= 0x13000,
267 /* various DPCM codecs */
268 CODEC_ID_ROQ_DPCM
= 0x14000,
269 CODEC_ID_INTERPLAY_DPCM
,
274 CODEC_ID_MP2
= 0x15000,
275 CODEC_ID_MP3
, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
293 CODEC_ID_WESTWOOD_SND1
,
294 CODEC_ID_GSM
, ///< as in Berlin toast format
302 CODEC_ID_DSICINAUDIO
,
306 CODEC_ID_GSM_MS
, /* as found in WAV */
315 CODEC_ID_WMALOSSLESS
,
325 /* subtitle codecs */
326 CODEC_ID_DVD_SUBTITLE
= 0x17000,
327 CODEC_ID_DVB_SUBTITLE
,
328 CODEC_ID_TEXT
, ///< raw UTF-8 text
332 CODEC_ID_HDMV_PGS_SUBTITLE
,
334 /* other specific kind of codecs (generally used for attachments) */
335 CODEC_ID_TTF
= 0x18000,
337 CODEC_ID_PROBE
= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
339 CODEC_ID_MPEG2TS
= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
340 * stream (only used by libavformat) */
344 CODEC_TYPE_UNKNOWN
= -1,
349 CODEC_TYPE_ATTACHMENT
,
354 * all in native-endian format
357 SAMPLE_FMT_NONE
= -1,
358 SAMPLE_FMT_U8
, ///< unsigned 8 bits
359 SAMPLE_FMT_S16
, ///< signed 16 bits
360 SAMPLE_FMT_S32
, ///< signed 32 bits
361 SAMPLE_FMT_FLT
, ///< float
362 SAMPLE_FMT_DBL
, ///< double
363 SAMPLE_FMT_NB
///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
366 /* Audio channel masks */
367 #define CH_FRONT_LEFT 0x00000001
368 #define CH_FRONT_RIGHT 0x00000002
369 #define CH_FRONT_CENTER 0x00000004
370 #define CH_LOW_FREQUENCY 0x00000008
371 #define CH_BACK_LEFT 0x00000010
372 #define CH_BACK_RIGHT 0x00000020
373 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
374 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
375 #define CH_BACK_CENTER 0x00000100
376 #define CH_SIDE_LEFT 0x00000200
377 #define CH_SIDE_RIGHT 0x00000400
378 #define CH_TOP_CENTER 0x00000800
379 #define CH_TOP_FRONT_LEFT 0x00001000
380 #define CH_TOP_FRONT_CENTER 0x00002000
381 #define CH_TOP_FRONT_RIGHT 0x00004000
382 #define CH_TOP_BACK_LEFT 0x00008000
383 #define CH_TOP_BACK_CENTER 0x00010000
384 #define CH_TOP_BACK_RIGHT 0x00020000
385 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
386 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
388 /* Audio channel convenience macros */
389 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
390 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
391 #define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
392 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
393 #define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
394 #define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
395 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
396 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
397 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
398 #define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
399 #define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
400 #define CH_LAYOUT_7POINT0 (CH_LAYOUT_5POINT0|CH_BACK_LEFT|CH_BACK_RIGHT)
401 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
402 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
403 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
404 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
407 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
410 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
411 * This is mainly needed because some optimized bitstream readers read
412 * 32 or 64 bit at once and could read over the end.<br>
413 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
414 * MPEG bitstreams could cause overread and segfault.
416 #define FF_INPUT_BUFFER_PADDING_SIZE 8
419 * minimum encoding buffer size
420 * Used to avoid some checks during header writing.
422 #define FF_MIN_BUFFER_SIZE 16384
426 * motion estimation type.
429 ME_ZERO
= 1, ///< no search, that is use 0,0 vector whenever one is needed
433 ME_EPZS
, ///< enhanced predictive zonal search
434 ME_X1
, ///< reserved for experiments
435 ME_HEX
, ///< hexagon based search
436 ME_UMH
, ///< uneven multi-hexagon search
437 ME_ITER
, ///< iterative search
438 ME_TESA
, ///< transformed exhaustive search algorithm
442 /* We leave some space between them for extensions (drop some
443 * keyframes for intra-only or drop just some bidir frames). */
444 AVDISCARD_NONE
=-16, ///< discard nothing
445 AVDISCARD_DEFAULT
= 0, ///< discard useless packets like 0 size packets in avi
446 AVDISCARD_NONREF
= 8, ///< discard all non reference
447 AVDISCARD_BIDIR
= 16, ///< discard all bidirectional frames
448 AVDISCARD_NONKEY
= 32, ///< discard all frames except keyframes
449 AVDISCARD_ALL
= 48, ///< discard all
452 enum AVColorPrimaries
{
453 AVCOL_PRI_BT709
=1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
454 AVCOL_PRI_UNSPECIFIED
=2,
456 AVCOL_PRI_BT470BG
=5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
457 AVCOL_PRI_SMPTE170M
=6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
458 AVCOL_PRI_SMPTE240M
=7, ///< functionally identical to above
460 AVCOL_PRI_NB
, ///< Not part of ABI
463 enum AVColorTransferCharacteristic
{
464 AVCOL_TRC_BT709
=1, ///< also ITU-R BT1361
465 AVCOL_TRC_UNSPECIFIED
=2,
466 AVCOL_TRC_GAMMA22
=4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
467 AVCOL_TRC_GAMMA28
=5, ///< also ITU-R BT470BG
468 AVCOL_TRC_NB
, ///< Not part of ABI
473 AVCOL_SPC_BT709
=1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
474 AVCOL_SPC_UNSPECIFIED
=2,
476 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
477 AVCOL_SPC_SMPTE170M
=6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
478 AVCOL_SPC_SMPTE240M
=7,
479 AVCOL_SPC_NB
, ///< Not part of ABI
483 AVCOL_RANGE_UNSPECIFIED
=0,
484 AVCOL_RANGE_MPEG
=1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
485 AVCOL_RANGE_JPEG
=2, ///< the normal 2^n-1 "JPEG" YUV ranges
486 AVCOL_RANGE_NB
, ///< Not part of ABI
490 * X X 3 4 X X are luma samples,
491 * 1 2 1-6 are possible chroma positions
492 * X X 5 6 X 0 is undefined/unknown position
494 enum AVChromaLocation
{
495 AVCHROMA_LOC_UNSPECIFIED
=0,
496 AVCHROMA_LOC_LEFT
=1, ///< mpeg2/4, h264 default
497 AVCHROMA_LOC_CENTER
=2, ///< mpeg1, jpeg, h263
498 AVCHROMA_LOC_TOPLEFT
=3, ///< DV
500 AVCHROMA_LOC_BOTTOMLEFT
=5,
501 AVCHROMA_LOC_BOTTOM
=6,
502 AVCHROMA_LOC_NB
, ///< Not part of ABI
505 typedef struct RcOverride
{
508 int qscale
; // If this is 0 then quality_factor will be used instead.
509 float quality_factor
;
512 #define FF_MAX_B_FRAMES 16
515 These flags can be passed in AVCodecContext.flags before initialization.
516 Note: Not everything is supported yet.
519 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
520 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
521 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
522 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
523 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
524 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
526 * The parent program guarantees that the input for B-frames containing
527 * streams is not written to for at least s->max_b_frames+1 frames, if
528 * this is not set the input will be copied.
530 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
531 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
532 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
533 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
534 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
535 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
536 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
537 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
538 location instead of only at frame boundaries. */
539 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
540 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
541 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
542 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
543 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
544 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
545 /* Fx : Flag for h263+ extra options */
546 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
547 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
548 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
549 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
550 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
551 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
552 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
553 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
554 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
555 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
556 #define CODEC_FLAG_CLOSED_GOP 0x80000000
557 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
558 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
559 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
560 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
561 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
562 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
563 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
564 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
565 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
566 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
567 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
568 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
569 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
570 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
571 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
572 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
573 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
574 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
576 /* Unsupported options :
577 * Syntax Arithmetic coding (SAC)
578 * Reference Picture Selection
579 * Independent Segment Decoding */
581 /* codec capabilities */
583 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
585 * Codec uses get_buffer() for allocating buffers.
586 * direct rendering method 1
588 #define CODEC_CAP_DR1 0x0002
589 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
590 #define CODEC_CAP_PARSE_ONLY 0x0004
591 #define CODEC_CAP_TRUNCATED 0x0008
592 /* Codec can export data for HW decoding (XvMC). */
593 #define CODEC_CAP_HWACCEL 0x0010
595 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
596 * If this is not set, the codec is guaranteed to never be fed with NULL data.
598 #define CODEC_CAP_DELAY 0x0020
600 * Codec can be fed a final frame with a smaller size.
601 * This can be used to prevent truncation of the last audio samples.
603 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
605 * Codec can export data for HW decoding (VDPAU).
607 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
609 //The following defines may change, don't expect compatibility if you use them.
610 #define MB_TYPE_INTRA4x4 0x0001
611 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
612 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
613 #define MB_TYPE_16x16 0x0008
614 #define MB_TYPE_16x8 0x0010
615 #define MB_TYPE_8x16 0x0020
616 #define MB_TYPE_8x8 0x0040
617 #define MB_TYPE_INTERLACED 0x0080
618 #define MB_TYPE_DIRECT2 0x0100 //FIXME
619 #define MB_TYPE_ACPRED 0x0200
620 #define MB_TYPE_GMC 0x0400
621 #define MB_TYPE_SKIP 0x0800
622 #define MB_TYPE_P0L0 0x1000
623 #define MB_TYPE_P1L0 0x2000
624 #define MB_TYPE_P0L1 0x4000
625 #define MB_TYPE_P1L1 0x8000
626 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
627 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
628 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
629 #define MB_TYPE_QUANT 0x00010000
630 #define MB_TYPE_CBP 0x00020000
631 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
635 * This specifies the area which should be displayed.
636 * Note there may be multiple such areas for one frame.
638 typedef struct AVPanScan
{
641 * - encoding: Set by user.
642 * - decoding: Set by libavcodec.
647 * width and height in 1/16 pel
648 * - encoding: Set by user.
649 * - decoding: Set by libavcodec.
655 * position of the top left corner in 1/16 pel for up to 3 fields/frames
656 * - encoding: Set by user.
657 * - decoding: Set by libavcodec.
659 int16_t position
[3][2];
662 #define FF_COMMON_FRAME \
664 * pointer to the picture planes.\
665 * This might be different from the first allocated byte\
672 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
673 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
679 * 1 -> keyframe, 0-> not\
680 * - encoding: Set by libavcodec.\
681 * - decoding: Set by libavcodec.\
686 * Picture type of the frame, see ?_TYPE below.\
687 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
688 * - decoding: Set by libavcodec.\
693 * presentation timestamp in time_base units (time when frame should be shown to user)\
694 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
695 * - encoding: MUST be set by user.\
696 * - decoding: Set by libavcodec.\
701 * picture number in bitstream order\
702 * - encoding: set by\
703 * - decoding: Set by libavcodec.\
705 int coded_picture_number;\
707 * picture number in display order\
708 * - encoding: set by\
709 * - decoding: Set by libavcodec.\
711 int display_picture_number;\
714 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
715 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
716 * - decoding: Set by libavcodec.\
721 * buffer age (1->was last buffer and dint change, 2->..., ...).\
722 * Set to INT_MAX if the buffer has not been used yet.\
723 * - encoding: unused\
724 * - decoding: MUST be set by get_buffer().\
729 * is this picture used as reference\
730 * The values for this are the same as the MpegEncContext.picture_structure\
731 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
732 * Set to 4 for delayed, non-reference frames.\
733 * - encoding: unused\
734 * - decoding: Set by libavcodec. (before get_buffer() call)).\
740 * - encoding: unused\
741 * - decoding: Set by libavcodec.\
743 int8_t *qscale_table;\
746 * - encoding: unused\
747 * - decoding: Set by libavcodec.\
752 * mbskip_table[mb]>=1 if MB didn't change\
753 * stride= mb_width = (width+15)>>4\
754 * - encoding: unused\
755 * - decoding: Set by libavcodec.\
757 uint8_t *mbskip_table;\
760 * motion vector table\
763 * int mv_sample_log2= 4 - motion_subsample_log2;\
764 * int mb_width= (width+15)>>4;\
765 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
766 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
768 * - encoding: Set by user.\
769 * - decoding: Set by libavcodec.\
771 int16_t (*motion_val[2])[2];\
774 * macroblock type table\
775 * mb_type_base + mb_width + 2\
776 * - encoding: Set by user.\
777 * - decoding: Set by libavcodec.\
782 * log2 of the size of the block which a single vector in motion_val represents: \
783 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
784 * - encoding: unused\
785 * - decoding: Set by libavcodec.\
787 uint8_t motion_subsample_log2;\
790 * for some private data of the user\
791 * - encoding: unused\
792 * - decoding: Set by user.\
798 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
799 * - decoding: unused\
804 * type of the buffer (to keep track of who has to deallocate data[*])\
805 * - encoding: Set by the one who allocates it.\
806 * - decoding: Set by the one who allocates it.\
807 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
812 * When decoding, this signals how much the picture must be delayed.\
813 * extra_delay = repeat_pict / (2*fps)\
814 * - encoding: unused\
815 * - decoding: Set by libavcodec.\
825 * The content of the picture is interlaced.\
826 * - encoding: Set by user.\
827 * - decoding: Set by libavcodec. (default 0)\
829 int interlaced_frame;\
832 * If the content is interlaced, is top field displayed first.\
833 * - encoding: Set by user.\
834 * - decoding: Set by libavcodec.\
836 int top_field_first;\
840 * - encoding: Set by user.\
841 * - decoding: Set by libavcodec.\
843 AVPanScan *pan_scan;\
846 * Tell user application that palette has changed from previous frame.\
847 * - encoding: ??? (no palette-enabled encoder yet)\
848 * - decoding: Set by libavcodec. (default 0).\
850 int palette_has_changed;\
853 * codec suggestion on buffer type if != 0\
854 * - encoding: unused\
855 * - decoding: Set by libavcodec. (before get_buffer() call)).\
861 * - encoding: unused\
862 * - decoding: Set by libavcodec.\
867 * motion referece frame index\
868 * - encoding: Set by user.\
869 * - decoding: Set by libavcodec.\
871 int8_t *ref_index[2];\
874 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
875 * output in AVFrame.reordered_opaque\
876 * - encoding: unused\
877 * - decoding: Read by user.\
879 int64_t reordered_opaque;\
882 * hardware accelerator private data (FFmpeg allocated)\
883 * - encoding: unused\
884 * - decoding: Set by libavcodec\
886 void *hwaccel_picture_private;\
889 #define FF_QSCALE_TYPE_MPEG1 0
890 #define FF_QSCALE_TYPE_MPEG2 1
891 #define FF_QSCALE_TYPE_H264 2
893 #define FF_BUFFER_TYPE_INTERNAL 1
894 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
895 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
896 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
899 #define FF_I_TYPE 1 ///< Intra
900 #define FF_P_TYPE 2 ///< Predicted
901 #define FF_B_TYPE 3 ///< Bi-dir predicted
902 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
903 #define FF_SI_TYPE 5 ///< Switching Intra
904 #define FF_SP_TYPE 6 ///< Switching Predicted
907 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
908 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
909 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
910 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
912 typedef struct AVPacket
{
914 * Presentation timestamp in AVStream->time_base units; the time at which
915 * the decompressed packet will be presented to the user.
916 * Can be AV_NOPTS_VALUE if it is not stored in the file.
917 * pts MUST be larger or equal to dts as presentation cannot happen before
918 * decompression, unless one wants to view hex dumps. Some formats misuse
919 * the terms dts and pts/cts to mean something different. Such timestamps
920 * must be converted to true pts/dts before they are stored in AVPacket.
924 * Decompression timestamp in AVStream->time_base units; the time at which
925 * the packet is decompressed.
926 * Can be AV_NOPTS_VALUE if it is not stored in the file.
934 * Duration of this packet in AVStream->time_base units, 0 if unknown.
935 * Equals next_pts - this_pts in presentation order.
938 void (*destruct
)(struct AVPacket
*);
940 int64_t pos
; ///< byte position in stream, -1 if unknown
943 * Time difference in AVStream->time_base units from the pts of this
944 * packet to the point at which the output from the decoder has converged
945 * independent from the availability of previous frames. That is, the
946 * frames are virtually identical no matter if decoding started from
947 * the very first frame or from this keyframe.
948 * Is AV_NOPTS_VALUE if unknown.
949 * This field is not the display duration of the current packet.
951 * The purpose of this field is to allow seeking in streams that have no
952 * keyframes in the conventional sense. It corresponds to the
953 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
954 * essential for some types of subtitle streams to ensure that all
955 * subtitles are correctly displayed after seeking.
957 int64_t convergence_duration
;
959 #define AV_PKT_FLAG_KEY 0x0001
960 #if LIBAVCODEC_VERSION_MAJOR < 53
961 #define PKT_FLAG_KEY AV_PKT_FLAG_KEY
966 * New fields can be added to the end of FF_COMMON_FRAME with minor version
968 * Removal, reordering and changes to existing fields require a major
969 * version bump. No fields should be added into AVFrame before or after
971 * sizeof(AVFrame) must not be used outside libav*.
973 typedef struct AVFrame
{
978 * main external API structure.
979 * New fields can be added to the end with minor version bumps.
980 * Removal, reordering and changes to existing fields require a major
982 * sizeof(AVCodecContext) must not be used outside libav*.
984 typedef struct AVCodecContext
{
986 * information on struct for av_log
987 * - set by avcodec_alloc_context
989 const AVClass
*av_class
;
991 * the average bitrate
992 * - encoding: Set by user; unused for constant quantizer encoding.
993 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
998 * number of bits the bitstream is allowed to diverge from the reference.
999 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1000 * - encoding: Set by user; unused for constant quantizer encoding.
1001 * - decoding: unused
1003 int bit_rate_tolerance
;
1007 * - encoding: Set by user.
1008 * - decoding: Set by user.
1013 * Some codecs need additional format info. It is stored here.
1014 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1015 * specific codec MUST set it correctly otherwise stream copy breaks.
1016 * In general use of this field by muxers is not recommanded.
1017 * - encoding: Set by libavcodec.
1018 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1023 * Motion estimation algorithm used for video coding.
1024 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1025 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1026 * - encoding: MUST be set by user.
1027 * - decoding: unused
1032 * some codecs need / can use extradata like Huffman tables.
1033 * mjpeg: Huffman tables
1034 * rv10: additional flags
1035 * mpeg4: global headers (they can be in the bitstream or here)
1036 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1037 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1038 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1039 * - encoding: Set/allocated/freed by libavcodec.
1040 * - decoding: Set/allocated/freed by user.
1046 * This is the fundamental unit of time (in seconds) in terms
1047 * of which frame timestamps are represented. For fixed-fps content,
1048 * timebase should be 1/framerate and timestamp increments should be
1050 * - encoding: MUST be set by user.
1051 * - decoding: Set by libavcodec.
1053 AVRational time_base
;
1057 * picture width / height.
1058 * - encoding: MUST be set by user.
1059 * - decoding: Set by libavcodec.
1060 * Note: For compatibility it is possible to set this instead of
1061 * coded_width/height before decoding.
1065 #define FF_ASPECT_EXTENDED 15
1068 * the number of pictures in a group of pictures, or 0 for intra_only
1069 * - encoding: Set by user.
1070 * - decoding: unused
1075 * Pixel format, see PIX_FMT_xxx.
1076 * - encoding: Set by user.
1077 * - decoding: Set by libavcodec.
1079 enum PixelFormat pix_fmt
;
1082 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1083 * has to read frames at native frame rate.
1084 * - encoding: Set by user.
1085 * - decoding: unused
1090 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1091 * decoder to draw a horizontal band. It improves cache usage. Not
1092 * all codecs can do that. You must check the codec capabilities
1094 * The function is also used by hardware acceleration APIs.
1095 * It is called at least once during frame decoding to pass
1096 * the data needed for hardware render.
1097 * In that mode instead of pixel data, AVFrame points to
1098 * a structure specific to the acceleration API. The application
1099 * reads the structure and can change some fields to indicate progress
1101 * - encoding: unused
1102 * - decoding: Set by user.
1103 * @param height the height of the slice
1104 * @param y the y position of the slice
1105 * @param type 1->top field, 2->bottom field, 3->frame
1106 * @param offset offset into the AVFrame.data from which the slice should be read
1108 void (*draw_horiz_band
)(struct AVCodecContext
*s
,
1109 const AVFrame
*src
, int offset
[4],
1110 int y
, int type
, int height
);
1113 int sample_rate
; ///< samples per second
1114 int channels
; ///< number of audio channels
1117 * audio sample format
1118 * - encoding: Set by user.
1119 * - decoding: Set by libavcodec.
1121 enum SampleFormat sample_fmt
; ///< sample format
1123 /* The following data should not be initialized. */
1125 * Samples per packet, initialized when calling 'init'.
1128 int frame_number
; ///< audio or video frame number
1129 #if LIBAVCODEC_VERSION_MAJOR < 53
1130 int real_pict_num
; ///< Returns the real picture number of previous encoded frame.
1134 * Number of frames the decoded output will be delayed relative to
1135 * the encoded input.
1136 * - encoding: Set by libavcodec.
1137 * - decoding: unused
1141 /* - encoding parameters */
1142 float qcompress
; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1143 float qblur
; ///< amount of qscale smoothing over time (0.0-1.0)
1147 * - encoding: Set by user.
1148 * - decoding: unused
1154 * - encoding: Set by user.
1155 * - decoding: unused
1160 * maximum quantizer difference between frames
1161 * - encoding: Set by user.
1162 * - decoding: unused
1167 * maximum number of B-frames between non-B-frames
1168 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1169 * - encoding: Set by user.
1170 * - decoding: unused
1175 * qscale factor between IP and B-frames
1176 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1177 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1178 * - encoding: Set by user.
1179 * - decoding: unused
1181 float b_quant_factor
;
1183 /** obsolete FIXME remove */
1185 #define FF_RC_STRATEGY_XVID 1
1187 int b_frame_strategy
;
1191 * - encoding: unused
1192 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1193 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1197 struct AVCodec
*codec
;
1201 int rtp_payload_size
; /* The size of the RTP payload: the coder will */
1202 /* do its best to deliver a chunk with size */
1203 /* below rtp_payload_size, the chunk will start */
1204 /* with a start code on some codecs like H.263. */
1205 /* This doesn't take account of any particular */
1206 /* headers inside the transmitted RTP payload. */
1209 /* The RTP callback: This function is called */
1210 /* every time the encoder has a packet to send. */
1211 /* It depends on the encoder if the data starts */
1212 /* with a Start Code (it should). H.263 does. */
1213 /* mb_nb contains the number of macroblocks */
1214 /* encoded in the RTP payload. */
1215 void (*rtp_callback
)(struct AVCodecContext
*avctx
, void *data
, int size
, int mb_nb
);
1217 /* statistics, used for 2-pass encoding */
1228 * number of bits used for the previously encoded frame
1229 * - encoding: Set by libavcodec.
1230 * - decoding: unused
1235 * Private data of the user, can be used to carry app specific stuff.
1236 * - encoding: Set by user.
1237 * - decoding: Set by user.
1241 char codec_name
[32];
1242 enum CodecType codec_type
; /* see CODEC_TYPE_xxx */
1243 enum CodecID codec_id
; /* see CODEC_ID_xxx */
1246 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1247 * This is used to work around some encoder bugs.
1248 * A demuxer should set this to what is stored in the field used to identify the codec.
1249 * If there are multiple such fields in a container then the demuxer should choose the one
1250 * which maximizes the information about the used codec.
1251 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1252 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1253 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1255 * - encoding: Set by user, if not then the default based on codec_id will be used.
1256 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1258 unsigned int codec_tag
;
1261 * Work around bugs in encoders which sometimes cannot be detected automatically.
1262 * - encoding: Set by user
1263 * - decoding: Set by user
1265 int workaround_bugs
;
1266 #define FF_BUG_AUTODETECT 1 ///< autodetection
1267 #define FF_BUG_OLD_MSMPEG4 2
1268 #define FF_BUG_XVID_ILACE 4
1269 #define FF_BUG_UMP4 8
1270 #define FF_BUG_NO_PADDING 16
1271 #define FF_BUG_AMV 32
1272 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1273 #define FF_BUG_QPEL_CHROMA 64
1274 #define FF_BUG_STD_QPEL 128
1275 #define FF_BUG_QPEL_CHROMA2 256
1276 #define FF_BUG_DIRECT_BLOCKSIZE 512
1277 #define FF_BUG_EDGE 1024
1278 #define FF_BUG_HPEL_CHROMA 2048
1279 #define FF_BUG_DC_CLIP 4096
1280 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1281 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1284 * luma single coefficient elimination threshold
1285 * - encoding: Set by user.
1286 * - decoding: unused
1288 int luma_elim_threshold
;
1291 * chroma single coeff elimination threshold
1292 * - encoding: Set by user.
1293 * - decoding: unused
1295 int chroma_elim_threshold
;
1298 * strictly follow the standard (MPEG4, ...).
1299 * - encoding: Set by user.
1300 * - decoding: Set by user.
1301 * Setting this to STRICT or higher means the encoder and decoder will
1302 * generally do stupid things. While setting it to inofficial or lower
1303 * will mean the encoder might use things that are not supported by all
1304 * spec compliant decoders. Decoders make no difference between normal,
1305 * inofficial and experimental, that is they always try to decode things
1306 * when they can unless they are explicitly asked to behave stupid
1307 * (=strictly conform to the specs)
1309 int strict_std_compliance
;
1310 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1311 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1312 #define FF_COMPLIANCE_NORMAL 0
1313 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1314 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1317 * qscale offset between IP and B-frames
1318 * - encoding: Set by user.
1319 * - decoding: unused
1321 float b_quant_offset
;
1324 * Error recognization; higher values will detect more errors but may
1325 * misdetect some more or less valid parts as errors.
1326 * - encoding: unused
1327 * - decoding: Set by user.
1329 int error_recognition
;
1330 #define FF_ER_CAREFUL 1
1331 #define FF_ER_COMPLIANT 2
1332 #define FF_ER_AGGRESSIVE 3
1333 #define FF_ER_VERY_AGGRESSIVE 4
1336 * Called at the beginning of each frame to get a buffer for it.
1337 * If pic.reference is set then the frame will be read later by libavcodec.
1338 * avcodec_align_dimensions() should be used to find the required width and
1339 * height, as they normally need to be rounded up to the next multiple of 16.
1340 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1341 * avcodec_default_get_buffer() instead of providing buffers allocated by
1343 * - encoding: unused
1344 * - decoding: Set by libavcodec., user can override.
1346 int (*get_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1349 * Called to release buffers which were allocated with get_buffer.
1350 * A released buffer can be reused in get_buffer().
1351 * pic.data[*] must be set to NULL.
1352 * - encoding: unused
1353 * - decoding: Set by libavcodec., user can override.
1355 void (*release_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1358 * Size of the frame reordering buffer in the decoder.
1359 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1360 * - encoding: Set by libavcodec.
1361 * - decoding: Set by libavcodec.
1366 * number of bytes per packet if constant and known or 0
1367 * Used by some WAV based audio codecs.
1371 int parse_only
; /* - decoding only: If true, only parsing is done
1372 (function avcodec_parse_frame()). The frame
1373 data is returned. Only MPEG codecs support this now. */
1376 * 0-> h263 quant 1-> mpeg quant
1377 * - encoding: Set by user.
1378 * - decoding: unused
1383 * pass1 encoding statistics output buffer
1384 * - encoding: Set by libavcodec.
1385 * - decoding: unused
1390 * pass2 encoding statistics input buffer
1391 * Concatenated stuff from stats_out of pass1 should be placed here.
1392 * - encoding: Allocated/set/freed by user.
1393 * - decoding: unused
1398 * ratecontrol qmin qmax limiting method
1399 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1400 * - encoding: Set by user.
1401 * - decoding: unused
1409 * ratecontrol override, see RcOverride
1410 * - encoding: Allocated/set/freed by user.
1411 * - decoding: unused
1413 RcOverride
*rc_override
;
1414 int rc_override_count
;
1417 * rate control equation
1418 * - encoding: Set by user
1419 * - decoding: unused
1425 * - encoding: Set by user.
1426 * - decoding: unused
1432 * - encoding: Set by user.
1433 * - decoding: unused
1438 * decoder bitstream buffer size
1439 * - encoding: Set by user.
1440 * - decoding: unused
1443 float rc_buffer_aggressivity
;
1446 * qscale factor between P and I-frames
1447 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1448 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1449 * - encoding: Set by user.
1450 * - decoding: unused
1452 float i_quant_factor
;
1455 * qscale offset between P and I-frames
1456 * - encoding: Set by user.
1457 * - decoding: unused
1459 float i_quant_offset
;
1462 * initial complexity for pass1 ratecontrol
1463 * - encoding: Set by user.
1464 * - decoding: unused
1466 float rc_initial_cplx
;
1469 * DCT algorithm, see FF_DCT_* below
1470 * - encoding: Set by user.
1471 * - decoding: unused
1474 #define FF_DCT_AUTO 0
1475 #define FF_DCT_FASTINT 1
1476 #define FF_DCT_INT 2
1477 #define FF_DCT_MMX 3
1478 #define FF_DCT_MLIB 4
1479 #define FF_DCT_ALTIVEC 5
1480 #define FF_DCT_FAAN 6
1483 * luminance masking (0-> disabled)
1484 * - encoding: Set by user.
1485 * - decoding: unused
1490 * temporary complexity masking (0-> disabled)
1491 * - encoding: Set by user.
1492 * - decoding: unused
1494 float temporal_cplx_masking
;
1497 * spatial complexity masking (0-> disabled)
1498 * - encoding: Set by user.
1499 * - decoding: unused
1501 float spatial_cplx_masking
;
1504 * p block masking (0-> disabled)
1505 * - encoding: Set by user.
1506 * - decoding: unused
1511 * darkness masking (0-> disabled)
1512 * - encoding: Set by user.
1513 * - decoding: unused
1518 * IDCT algorithm, see FF_IDCT_* below.
1519 * - encoding: Set by user.
1520 * - decoding: Set by user.
1523 #define FF_IDCT_AUTO 0
1524 #define FF_IDCT_INT 1
1525 #define FF_IDCT_SIMPLE 2
1526 #define FF_IDCT_SIMPLEMMX 3
1527 #define FF_IDCT_LIBMPEG2MMX 4
1528 #define FF_IDCT_PS2 5
1529 #define FF_IDCT_MLIB 6
1530 #define FF_IDCT_ARM 7
1531 #define FF_IDCT_ALTIVEC 8
1532 #define FF_IDCT_SH4 9
1533 #define FF_IDCT_SIMPLEARM 10
1534 #define FF_IDCT_H264 11
1535 #define FF_IDCT_VP3 12
1536 #define FF_IDCT_IPP 13
1537 #define FF_IDCT_XVIDMMX 14
1538 #define FF_IDCT_CAVS 15
1539 #define FF_IDCT_SIMPLEARMV5TE 16
1540 #define FF_IDCT_SIMPLEARMV6 17
1541 #define FF_IDCT_SIMPLEVIS 18
1542 #define FF_IDCT_WMV2 19
1543 #define FF_IDCT_FAAN 20
1544 #define FF_IDCT_EA 21
1545 #define FF_IDCT_SIMPLENEON 22
1546 #define FF_IDCT_SIMPLEALPHA 23
1550 * - encoding: Set by libavcodec.
1551 * - decoding: Set by user (or 0).
1555 * slice offsets in the frame in bytes
1556 * - encoding: Set/allocated by libavcodec.
1557 * - decoding: Set/allocated by user (or NULL).
1562 * error concealment flags
1563 * - encoding: unused
1564 * - decoding: Set by user.
1566 int error_concealment
;
1567 #define FF_EC_GUESS_MVS 1
1568 #define FF_EC_DEBLOCK 2
1571 * dsp_mask could be add used to disable unwanted CPU features
1572 * CPU features (i.e. MMX, SSE. ...)
1574 * With the FORCE flag you may instead enable given CPU features.
1575 * (Dangerous: Usable in case of misdetection, improper usage however will
1576 * result into program crash.)
1579 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1580 /* lower 16 bits - CPU features */
1581 #define FF_MM_MMX 0x0001 ///< standard MMX
1582 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1583 #if LIBAVCODEC_VERSION_MAJOR < 53
1584 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1586 #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
1587 #define FF_MM_SSE 0x0008 ///< SSE functions
1588 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1589 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1590 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1591 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1592 #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1593 #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
1594 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1595 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1598 * bits per sample/pixel from the demuxer (needed for huffyuv).
1599 * - encoding: Set by libavcodec.
1600 * - decoding: Set by user.
1602 int bits_per_coded_sample
;
1605 * prediction method (needed for huffyuv)
1606 * - encoding: Set by user.
1607 * - decoding: unused
1609 int prediction_method
;
1610 #define FF_PRED_LEFT 0
1611 #define FF_PRED_PLANE 1
1612 #define FF_PRED_MEDIAN 2
1615 * sample aspect ratio (0 if unknown)
1616 * That is the width of a pixel divided by the height of the pixel.
1617 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1618 * - encoding: Set by user.
1619 * - decoding: Set by libavcodec.
1621 AVRational sample_aspect_ratio
;
1624 * the picture in the bitstream
1625 * - encoding: Set by libavcodec.
1626 * - decoding: Set by libavcodec.
1628 AVFrame
*coded_frame
;
1632 * - encoding: Set by user.
1633 * - decoding: Set by user.
1636 #define FF_DEBUG_PICT_INFO 1
1637 #define FF_DEBUG_RC 2
1638 #define FF_DEBUG_BITSTREAM 4
1639 #define FF_DEBUG_MB_TYPE 8
1640 #define FF_DEBUG_QP 16
1641 #define FF_DEBUG_MV 32
1642 #define FF_DEBUG_DCT_COEFF 0x00000040
1643 #define FF_DEBUG_SKIP 0x00000080
1644 #define FF_DEBUG_STARTCODE 0x00000100
1645 #define FF_DEBUG_PTS 0x00000200
1646 #define FF_DEBUG_ER 0x00000400
1647 #define FF_DEBUG_MMCO 0x00000800
1648 #define FF_DEBUG_BUGS 0x00001000
1649 #define FF_DEBUG_VIS_QP 0x00002000
1650 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1651 #define FF_DEBUG_BUFFERS 0x00008000
1655 * - encoding: Set by user.
1656 * - decoding: Set by user.
1659 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1660 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1661 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1665 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1666 * - decoding: unused
1671 * minimum MB quantizer
1672 * - encoding: unused
1673 * - decoding: unused
1678 * maximum MB quantizer
1679 * - encoding: unused
1680 * - decoding: unused
1685 * motion estimation comparison function
1686 * - encoding: Set by user.
1687 * - decoding: unused
1691 * subpixel motion estimation comparison function
1692 * - encoding: Set by user.
1693 * - decoding: unused
1697 * macroblock comparison function (not supported yet)
1698 * - encoding: Set by user.
1699 * - decoding: unused
1703 * interlaced DCT comparison function
1704 * - encoding: Set by user.
1705 * - decoding: unused
1708 #define FF_CMP_SAD 0
1709 #define FF_CMP_SSE 1
1710 #define FF_CMP_SATD 2
1711 #define FF_CMP_DCT 3
1712 #define FF_CMP_PSNR 4
1713 #define FF_CMP_BIT 5
1715 #define FF_CMP_ZERO 7
1716 #define FF_CMP_VSAD 8
1717 #define FF_CMP_VSSE 9
1718 #define FF_CMP_NSSE 10
1719 #define FF_CMP_W53 11
1720 #define FF_CMP_W97 12
1721 #define FF_CMP_DCTMAX 13
1722 #define FF_CMP_DCT264 14
1723 #define FF_CMP_CHROMA 256
1726 * ME diamond size & shape
1727 * - encoding: Set by user.
1728 * - decoding: unused
1733 * amount of previous MV predictors (2a+1 x 2a+1 square)
1734 * - encoding: Set by user.
1735 * - decoding: unused
1737 int last_predictor_count
;
1740 * prepass for motion estimation
1741 * - encoding: Set by user.
1742 * - decoding: unused
1747 * motion estimation prepass comparison function
1748 * - encoding: Set by user.
1749 * - decoding: unused
1754 * ME prepass diamond size & shape
1755 * - encoding: Set by user.
1756 * - decoding: unused
1762 * - encoding: Set by user.
1763 * - decoding: unused
1765 int me_subpel_quality
;
1768 * callback to negotiate the pixelFormat
1769 * @param fmt is the list of formats which are supported by the codec,
1770 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1771 * The first is always the native one.
1772 * @return the chosen format
1773 * - encoding: unused
1774 * - decoding: Set by user, if not set the native format will be chosen.
1776 enum PixelFormat (*get_format
)(struct AVCodecContext
*s
, const enum PixelFormat
* fmt
);
1779 * DTG active format information (additional aspect ratio
1780 * information only used in DVB MPEG-2 transport streams)
1783 * - encoding: unused
1784 * - decoding: Set by decoder.
1786 int dtg_active_format
;
1787 #define FF_DTG_AFD_SAME 8
1788 #define FF_DTG_AFD_4_3 9
1789 #define FF_DTG_AFD_16_9 10
1790 #define FF_DTG_AFD_14_9 11
1791 #define FF_DTG_AFD_4_3_SP_14_9 13
1792 #define FF_DTG_AFD_16_9_SP_14_9 14
1793 #define FF_DTG_AFD_SP_4_3 15
1796 * maximum motion estimation search range in subpel units
1797 * If 0 then no limit.
1799 * - encoding: Set by user.
1800 * - decoding: unused
1805 * intra quantizer bias
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 int intra_quant_bias
;
1810 #define FF_DEFAULT_QUANT_BIAS 999999
1813 * inter quantizer bias
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 int inter_quant_bias
;
1821 * - encoding: unused
1822 * - decoding: Which clrtable should be used for 8bit RGB images.
1823 * Tables have to be stored somewhere. FIXME
1828 * internal_buffer count
1829 * Don't touch, used by libavcodec default_get_buffer().
1831 int internal_buffer_count
;
1835 * Don't touch, used by libavcodec default_get_buffer().
1837 void *internal_buffer
;
1839 #define FF_LAMBDA_SHIFT 7
1840 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1841 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1842 #define FF_LAMBDA_MAX (256*128-1)
1844 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1846 * Global quality for codecs which cannot change it per frame.
1847 * This should be proportional to MPEG-1/2/4 qscale.
1848 * - encoding: Set by user.
1849 * - decoding: unused
1853 #define FF_CODER_TYPE_VLC 0
1854 #define FF_CODER_TYPE_AC 1
1855 #define FF_CODER_TYPE_RAW 2
1856 #define FF_CODER_TYPE_RLE 3
1857 #define FF_CODER_TYPE_DEFLATE 4
1860 * - encoding: Set by user.
1861 * - decoding: unused
1867 * - encoding: Set by user.
1868 * - decoding: unused
1874 * - encoding: unused
1875 * - decoding: Set by user.
1877 uint8_t * (*realloc
)(struct AVCodecContext
*s
, uint8_t *buf
, int buf_size
);
1882 * - encoding: unused
1883 * - decoding: Set by user.
1886 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1887 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1888 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1891 * XVideo Motion Acceleration
1892 * - encoding: forbidden
1893 * - decoding: set by decoder
1895 int xvmc_acceleration
;
1898 * macroblock decision mode
1899 * - encoding: Set by user.
1900 * - decoding: unused
1903 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1904 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1905 #define FF_MB_DECISION_RD 2 ///< rate distortion
1908 * custom intra quantization matrix
1909 * - encoding: Set by user, can be NULL.
1910 * - decoding: Set by libavcodec.
1912 uint16_t *intra_matrix
;
1915 * custom inter quantization matrix
1916 * - encoding: Set by user, can be NULL.
1917 * - decoding: Set by libavcodec.
1919 uint16_t *inter_matrix
;
1922 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1923 * This is used to work around some encoder bugs.
1924 * - encoding: unused
1925 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1927 unsigned int stream_codec_tag
;
1930 * scene change detection threshold
1931 * 0 is default, larger means fewer detected scene changes.
1932 * - encoding: Set by user.
1933 * - decoding: unused
1935 int scenechange_threshold
;
1938 * minimum Lagrange multipler
1939 * - encoding: Set by user.
1940 * - decoding: unused
1945 * maximum Lagrange multipler
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * palette control structure
1953 * - encoding: ??? (no palette-enabled encoder yet)
1954 * - decoding: Set by user.
1956 struct AVPaletteControl
*palctrl
;
1959 * noise reduction strength
1960 * - encoding: Set by user.
1961 * - decoding: unused
1963 int noise_reduction
;
1966 * Called at the beginning of a frame to get cr buffer for it.
1967 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1968 * libavcodec will pass previous buffer in pic, function should return
1969 * same buffer or new buffer with old frame "painted" into it.
1970 * If pic.data[0] == NULL must behave like get_buffer().
1971 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1972 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1974 * - encoding: unused
1975 * - decoding: Set by libavcodec., user can override
1977 int (*reget_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1980 * Number of bits which should be loaded into the rc buffer before decoding starts.
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int rc_initial_buffer_occupancy
;
1988 * - encoding: Set by user.
1989 * - decoding: unused
1991 int inter_threshold
;
1995 * - encoding: Set by user.
1996 * - decoding: Set by user.
2001 * Simulates errors in the bitstream to test error concealment.
2002 * - encoding: Set by user.
2003 * - decoding: unused
2008 * MP3 antialias algorithm, see FF_AA_* below.
2009 * - encoding: unused
2010 * - decoding: Set by user.
2013 #define FF_AA_AUTO 0
2014 #define FF_AA_FASTINT 1 //not implemented yet
2016 #define FF_AA_FLOAT 3
2018 * quantizer noise shaping
2019 * - encoding: Set by user.
2020 * - decoding: unused
2022 int quantizer_noise_shaping
;
2026 * is used to decide how many independent tasks should be passed to execute()
2027 * - encoding: Set by user.
2028 * - decoding: Set by user.
2033 * The codec may call this to execute several independent things.
2034 * It will return only after finishing all tasks.
2035 * The user may replace this with some multithreaded implementation,
2036 * the default implementation will execute the parts serially.
2037 * @param count the number of things to execute
2038 * - encoding: Set by libavcodec, user can override.
2039 * - decoding: Set by libavcodec, user can override.
2041 int (*execute
)(struct AVCodecContext
*c
, int (*func
)(struct AVCodecContext
*c2
, void *arg
), void *arg2
, int *ret
, int count
, int size
);
2045 * Can be used by execute() to store some per AVCodecContext stuff.
2046 * - encoding: set by execute()
2047 * - decoding: set by execute()
2049 void *thread_opaque
;
2052 * Motion estimation threshold below which no motion estimation is
2053 * performed, but instead the user specified motion vectors are used.
2055 * - encoding: Set by user.
2056 * - decoding: unused
2061 * Macroblock threshold below which the user specified macroblock types will be used.
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * precision of the intra DC coefficient - 8
2069 * - encoding: Set by user.
2070 * - decoding: unused
2072 int intra_dc_precision
;
2075 * noise vs. sse weight for the nsse comparsion function
2076 * - encoding: Set by user.
2077 * - decoding: unused
2082 * Number of macroblock rows at the top which are skipped.
2083 * - encoding: unused
2084 * - decoding: Set by user.
2089 * Number of macroblock rows at the bottom which are skipped.
2090 * - encoding: unused
2091 * - decoding: Set by user.
2097 * - encoding: Set by user.
2098 * - decoding: Set by libavcodec.
2101 #define FF_PROFILE_UNKNOWN -99
2102 #define FF_PROFILE_AAC_MAIN 0
2103 #define FF_PROFILE_AAC_LOW 1
2104 #define FF_PROFILE_AAC_SSR 2
2105 #define FF_PROFILE_AAC_LTP 3
2109 * - encoding: Set by user.
2110 * - decoding: Set by libavcodec.
2113 #define FF_LEVEL_UNKNOWN -99
2116 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2117 * - encoding: unused
2118 * - decoding: Set by user.
2123 * Bitstream width / height, may be different from width/height if lowres
2124 * or other things are used.
2125 * - encoding: unused
2126 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2128 int coded_width
, coded_height
;
2131 * frame skip threshold
2132 * - encoding: Set by user.
2133 * - decoding: unused
2135 int frame_skip_threshold
;
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int frame_skip_factor
;
2145 * frame skip exponent
2146 * - encoding: Set by user.
2147 * - decoding: unused
2152 * frame skip comparison function
2153 * - encoding: Set by user.
2154 * - decoding: unused
2159 * Border processing masking, raises the quantizer for mbs on the borders
2161 * - encoding: Set by user.
2162 * - decoding: unused
2164 float border_masking
;
2167 * minimum MB lagrange multipler
2168 * - encoding: Set by user.
2169 * - decoding: unused
2174 * maximum MB lagrange multipler
2175 * - encoding: Set by user.
2176 * - decoding: unused
2182 * - encoding: Set by user.
2183 * - decoding: unused
2185 int me_penalty_compensation
;
2189 * - encoding: unused
2190 * - decoding: Set by user.
2192 enum AVDiscard skip_loop_filter
;
2196 * - encoding: unused
2197 * - decoding: Set by user.
2199 enum AVDiscard skip_idct
;
2203 * - encoding: unused
2204 * - decoding: Set by user.
2206 enum AVDiscard skip_frame
;
2210 * - encoding: Set by user.
2211 * - decoding: unused
2217 * - encoding: Set by user.
2218 * - decoding: unused
2223 * constant rate factor - quality-based VBR - values ~correspond to qps
2224 * - encoding: Set by user.
2225 * - decoding: unused
2230 * constant quantization parameter rate control method
2231 * - encoding: Set by user.
2232 * - decoding: unused
2238 * - encoding: Set by user.
2239 * - decoding: unused
2244 * number of reference frames
2245 * - encoding: Set by user.
2246 * - decoding: Set by lavc.
2251 * chroma qp offset from luma
2252 * - encoding: Set by user.
2253 * - decoding: unused
2258 * Influences how often B-frames are used.
2259 * - encoding: Set by user.
2260 * - decoding: unused
2265 * trellis RD quantization
2266 * - encoding: Set by user.
2267 * - decoding: unused
2272 * Reduce fluctuations in qp (before curve compression).
2273 * - encoding: Set by user.
2274 * - decoding: unused
2276 float complexityblur
;
2279 * in-loop deblocking filter alphac0 parameter
2280 * alpha is in the range -6...6
2281 * - encoding: Set by user.
2282 * - decoding: unused
2287 * in-loop deblocking filter beta parameter
2288 * beta is in the range -6...6
2289 * - encoding: Set by user.
2290 * - decoding: unused
2295 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2296 * - encoding: Set by user.
2297 * - decoding: unused
2300 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2301 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2302 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2303 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2304 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2307 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2308 * - encoding: Set by user.
2309 * - decoding: unused
2314 * Audio cutoff bandwidth (0 means "automatic")
2315 * - encoding: Set by user.
2316 * - decoding: unused
2321 * Multiplied by qscale for each frame and added to scene_change_score.
2322 * - encoding: Set by user.
2323 * - decoding: unused
2325 int scenechange_factor
;
2329 * Note: Value depends upon the compare function used for fullpel ME.
2330 * - encoding: Set by user.
2331 * - decoding: unused
2336 * Adjusts sensitivity of b_frame_strategy 1.
2337 * - encoding: Set by user.
2338 * - decoding: unused
2343 * - encoding: Set by user.
2344 * - decoding: unused
2346 int compression_level
;
2347 #define FF_COMPRESSION_DEFAULT -1
2350 * Sets whether to use LPC mode - used by FLAC encoder.
2351 * - encoding: Set by user.
2352 * - decoding: unused
2357 * LPC coefficient precision - used by FLAC encoder
2358 * - encoding: Set by user.
2359 * - decoding: unused
2361 int lpc_coeff_precision
;
2364 * - encoding: Set by user.
2365 * - decoding: unused
2367 int min_prediction_order
;
2370 * - encoding: Set by user.
2371 * - decoding: unused
2373 int max_prediction_order
;
2376 * search method for selecting prediction order
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 int prediction_order_method
;
2383 * - encoding: Set by user.
2384 * - decoding: unused
2386 int min_partition_order
;
2389 * - encoding: Set by user.
2390 * - decoding: unused
2392 int max_partition_order
;
2395 * GOP timecode frame start number, in non drop frame format
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 int64_t timecode_frame_start
;
2401 #if LIBAVCODEC_VERSION_MAJOR < 53
2403 * Decoder should decode to this many channels if it can (0 for default)
2404 * - encoding: unused
2405 * - decoding: Set by user.
2406 * @deprecated Deprecated in favor of request_channel_layout.
2408 int request_channels
;
2412 * Percentage of dynamic range compression to be applied by the decoder.
2413 * The default value is 1.0, corresponding to full compression.
2414 * - encoding: unused
2415 * - decoding: Set by user.
2420 * opaque 64bit number (generally a PTS) that will be reordered and
2421 * output in AVFrame.reordered_opaque
2422 * - encoding: unused
2423 * - decoding: Set by user.
2425 int64_t reordered_opaque
;
2428 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2429 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2430 * - encoding: set by user.
2431 * - decoding: set by libavcodec.
2433 int bits_per_raw_sample
;
2436 * Audio channel layout.
2437 * - encoding: set by user.
2438 * - decoding: set by libavcodec.
2440 int64_t channel_layout
;
2443 * Request decoder to use this channel layout if it can (0 for default)
2444 * - encoding: unused
2445 * - decoding: Set by user.
2447 int64_t request_channel_layout
;
2450 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2451 * - encoding: Set by user.
2452 * - decoding: unused.
2454 float rc_max_available_vbv_use
;
2457 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2458 * - encoding: Set by user.
2459 * - decoding: unused.
2461 float rc_min_vbv_overflow_use
;
2464 * Hardware accelerator in use
2465 * - encoding: unused.
2466 * - decoding: Set by libavcodec
2468 struct AVHWAccel
*hwaccel
;
2471 * For some codecs, the time base is closer to the field rate than the frame rate.
2472 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2473 * if no telecine is used ...
2475 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2477 int ticks_per_frame
;
2480 * Hardware accelerator context.
2481 * For some hardware accelerators, a global context needs to be
2482 * provided by the user. In that case, this holds display-dependent
2483 * data FFmpeg cannot instantiate itself. Please refer to the
2484 * FFmpeg HW accelerator documentation to know how to fill this
2485 * is. e.g. for VA API, this is a struct vaapi_context.
2486 * - encoding: unused
2487 * - decoding: Set by user
2489 void *hwaccel_context
;
2492 * Chromaticity coordinates of the source primaries.
2493 * - encoding: Set by user
2494 * - decoding: Set by libavcodec
2496 enum AVColorPrimaries color_primaries
;
2499 * Color Transfer Characteristic.
2500 * - encoding: Set by user
2501 * - decoding: Set by libavcodec
2503 enum AVColorTransferCharacteristic color_trc
;
2506 * YUV colorspace type.
2507 * - encoding: Set by user
2508 * - decoding: Set by libavcodec
2510 enum AVColorSpace colorspace
;
2513 * MPEG vs JPEG YUV range.
2514 * - encoding: Set by user
2515 * - decoding: Set by libavcodec
2517 enum AVColorRange color_range
;
2520 * This defines the location of chroma samples.
2521 * - encoding: Set by user
2522 * - decoding: Set by libavcodec
2524 enum AVChromaLocation chroma_sample_location
;
2530 typedef struct AVCodec
{
2532 * Name of the codec implementation.
2533 * The name is globally unique among encoders and among decoders (but an
2534 * encoder and a decoder can share the same name).
2535 * This is the primary way to find a codec from the user perspective.
2538 enum CodecType type
;
2541 int (*init
)(AVCodecContext
*);
2542 int (*encode
)(AVCodecContext
*, uint8_t *buf
, int buf_size
, void *data
);
2543 int (*close
)(AVCodecContext
*);
2544 int (*decode
)(AVCodecContext
*, void *outdata
, int *outdata_size
, AVPacket
*avpkt
);
2546 * Codec capabilities.
2550 struct AVCodec
*next
;
2553 * Will be called when seeking
2555 void (*flush
)(AVCodecContext
*);
2556 const AVRational
*supported_framerates
; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2557 const enum PixelFormat
*pix_fmts
; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2559 * Descriptive name for the codec, meant to be more human readable than name.
2560 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2562 const char *long_name
;
2563 const int *supported_samplerates
; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2564 const enum SampleFormat
*sample_fmts
; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2565 const int64_t *channel_layouts
; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2571 typedef struct AVHWAccel
{
2573 * Name of the hardware accelerated codec.
2574 * The name is globally unique among encoders and among decoders (but an
2575 * encoder and a decoder can share the same name).
2580 * Type of codec implemented by the hardware accelerator.
2582 * See CODEC_TYPE_xxx
2584 enum CodecType type
;
2587 * Codec implemented by the hardware accelerator.
2594 * Supported pixel format.
2596 * Only hardware accelerated formats are supported here.
2598 enum PixelFormat pix_fmt
;
2601 * Hardware accelerated codec capabilities.
2602 * see FF_HWACCEL_CODEC_CAP_*
2606 struct AVHWAccel
*next
;
2609 * Called at the beginning of each frame or field picture.
2611 * Meaningful frame information (codec specific) is guaranteed to
2612 * be parsed at this point. This function is mandatory.
2614 * Note that buf can be NULL along with buf_size set to 0.
2615 * Otherwise, this means the whole frame is available at this point.
2617 * @param avctx the codec context
2618 * @param buf the frame data buffer base
2619 * @param buf_size the size of the frame in bytes
2620 * @return zero if successful, a negative value otherwise
2622 int (*start_frame
)(AVCodecContext
*avctx
, const uint8_t *buf
, uint32_t buf_size
);
2625 * Callback for each slice.
2627 * Meaningful slice information (codec specific) is guaranteed to
2628 * be parsed at this point. This function is mandatory.
2630 * @param avctx the codec context
2631 * @param buf the slice data buffer base
2632 * @param buf_size the size of the slice in bytes
2633 * @return zero if successful, a negative value otherwise
2635 int (*decode_slice
)(AVCodecContext
*avctx
, const uint8_t *buf
, uint32_t buf_size
);
2638 * Called at the end of each frame or field picture.
2640 * The whole picture is parsed at this point and can now be sent
2641 * to the hardware accelerator. This function is mandatory.
2643 * @param avctx the codec context
2644 * @return zero if successful, a negative value otherwise
2646 int (*end_frame
)(AVCodecContext
*avctx
);
2649 * Size of HW accelerator private data.
2651 * Private data is allocated with av_mallocz() before
2652 * AVCodecContext.get_buffer() and deallocated after
2653 * AVCodecContext.release_buffer().
2659 * four components are given, that's all.
2660 * the last component is alpha
2662 typedef struct AVPicture
{
2664 int linesize
[4]; ///< number of bytes per line
2667 #if LIBAVCODEC_VERSION_MAJOR < 53
2670 * This structure defines a method for communicating palette changes
2671 * between and demuxer and a decoder.
2673 * @deprecated Use AVPacket to send palette changes instead.
2674 * This is totally broken.
2676 #define AVPALETTE_SIZE 1024
2677 #define AVPALETTE_COUNT 256
2678 typedef struct AVPaletteControl
{
2680 /* Demuxer sets this to 1 to indicate the palette has changed;
2681 * decoder resets to 0. */
2682 int palette_changed
;
2684 /* 4-byte ARGB palette entries, stored in native byte order; note that
2685 * the individual palette components should be on a 8-bit scale; if
2686 * the palette data comes from an IBM VGA native format, the component
2687 * data is probably 6 bits in size and needs to be scaled. */
2688 unsigned int palette
[AVPALETTE_COUNT
];
2690 } AVPaletteControl attribute_deprecated
;
2693 enum AVSubtitleType
{
2696 SUBTITLE_BITMAP
, ///< A bitmap, pict will be set
2699 * Plain text, the text field must be set by the decoder and is
2700 * authoritative. ass and pict fields may contain approximations.
2705 * Formatted text, the ass field must be set by the decoder and is
2706 * authoritative. pict and text fields may contain approximations.
2711 typedef struct AVSubtitleRect
{
2712 int x
; ///< top left corner of pict, undefined when pict is not set
2713 int y
; ///< top left corner of pict, undefined when pict is not set
2714 int w
; ///< width of pict, undefined when pict is not set
2715 int h
; ///< height of pict, undefined when pict is not set
2716 int nb_colors
; ///< number of colors in pict, undefined when pict is not set
2719 * data+linesize for the bitmap of this subtitle.
2720 * can be set for text/ass as well once they where rendered
2723 enum AVSubtitleType type
;
2725 char *text
; ///< 0 terminated plain UTF-8 text
2728 * 0 terminated ASS/SSA compatible event line.
2729 * The pressentation of this is unaffected by the other values in this
2735 typedef struct AVSubtitle
{
2736 uint16_t format
; /* 0 = graphics */
2737 uint32_t start_display_time
; /* relative to packet pts, in ms */
2738 uint32_t end_display_time
; /* relative to packet pts, in ms */
2740 AVSubtitleRect
**rects
;
2741 int64_t pts
; ///< Same as packet pts, in AV_TIME_BASE
2744 /* packet functions */
2747 * @deprecated use NULL instead
2749 attribute_deprecated
void av_destruct_packet_nofree(AVPacket
*pkt
);
2752 * Default packet destructor.
2754 void av_destruct_packet(AVPacket
*pkt
);
2757 * Initialize optional fields of a packet with default values.
2761 void av_init_packet(AVPacket
*pkt
);
2764 * Allocate the payload of a packet and initialize its fields with
2768 * @param size wanted payload size
2769 * @return 0 if OK, AVERROR_xxx otherwise
2771 int av_new_packet(AVPacket
*pkt
, int size
);
2774 * Reduce packet size, correctly zeroing padding
2777 * @param size new size
2779 void av_shrink_packet(AVPacket
*pkt
, int size
);
2782 * @warning This is a hack - the packet memory allocation stuff is broken. The
2783 * packet is allocated if it was not really allocated.
2785 int av_dup_packet(AVPacket
*pkt
);
2790 * @param pkt packet to free
2792 void av_free_packet(AVPacket
*pkt
);
2796 struct ReSampleContext
;
2797 struct AVResampleContext
;
2799 typedef struct ReSampleContext ReSampleContext
;
2801 #if LIBAVCODEC_VERSION_MAJOR < 53
2803 * @deprecated Use av_audio_resample_init() instead.
2805 attribute_deprecated ReSampleContext
*audio_resample_init(int output_channels
, int input_channels
,
2806 int output_rate
, int input_rate
);
2809 * Initializes audio resampling context
2811 * @param output_channels number of output channels
2812 * @param input_channels number of input channels
2813 * @param output_rate output sample rate
2814 * @param input_rate input sample rate
2815 * @param sample_fmt_out requested output sample format
2816 * @param sample_fmt_in input sample format
2817 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2818 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2819 * @param linear If 1 then the used FIR filter will be linearly interpolated
2820 between the 2 closest, if 0 the closest will be used
2821 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2822 * @return allocated ReSampleContext, NULL if error occured
2824 ReSampleContext
*av_audio_resample_init(int output_channels
, int input_channels
,
2825 int output_rate
, int input_rate
,
2826 enum SampleFormat sample_fmt_out
,
2827 enum SampleFormat sample_fmt_in
,
2828 int filter_length
, int log2_phase_count
,
2829 int linear
, double cutoff
);
2831 int audio_resample(ReSampleContext
*s
, short *output
, short *input
, int nb_samples
);
2832 void audio_resample_close(ReSampleContext
*s
);
2836 * Initializes an audio resampler.
2837 * Note, if either rate is not an integer then simply scale both rates up so they are.
2838 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2839 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2840 * @param linear If 1 then the used FIR filter will be linearly interpolated
2841 between the 2 closest, if 0 the closest will be used
2842 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2844 struct AVResampleContext
*av_resample_init(int out_rate
, int in_rate
, int filter_length
, int log2_phase_count
, int linear
, double cutoff
);
2848 * @param src an array of unconsumed samples
2849 * @param consumed the number of samples of src which have been consumed are returned here
2850 * @param src_size the number of unconsumed samples available
2851 * @param dst_size the amount of space in samples available in dst
2852 * @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.
2853 * @return the number of samples written in dst or -1 if an error occurred
2855 int av_resample(struct AVResampleContext
*c
, short *dst
, short *src
, int *consumed
, int src_size
, int dst_size
, int update_ctx
);
2859 * Compensates samplerate/timestamp drift. The compensation is done by changing
2860 * the resampler parameters, so no audible clicks or similar distortions occur
2861 * @param compensation_distance distance in output samples over which the compensation should be performed
2862 * @param sample_delta number of output samples which should be output less
2864 * example: av_resample_compensate(c, 10, 500)
2865 * here instead of 510 samples only 500 samples would be output
2867 * note, due to rounding the actual compensation might be slightly different,
2868 * especially if the compensation_distance is large and the in_rate used during init is small
2870 void av_resample_compensate(struct AVResampleContext
*c
, int sample_delta
, int compensation_distance
);
2871 void av_resample_close(struct AVResampleContext
*c
);
2874 * Allocate memory for a picture. Call avpicture_free to free it.
2876 * @param picture the picture to be filled in
2877 * @param pix_fmt the format of the picture
2878 * @param width the width of the picture
2879 * @param height the height of the picture
2880 * @return zero if successful, a negative value if not
2882 int avpicture_alloc(AVPicture
*picture
, enum PixelFormat pix_fmt
, int width
, int height
);
2885 * Free a picture previously allocated by avpicture_alloc().
2887 * @param picture the AVPicture to be freed
2889 void avpicture_free(AVPicture
*picture
);
2892 * Fill in the AVPicture fields.
2893 * The fields of the given AVPicture are filled in by using the 'ptr' address
2894 * which points to the image data buffer. Depending on the specified picture
2895 * format, one or multiple image data pointers and line sizes will be set.
2896 * If a planar format is specified, several pointers will be set pointing to
2897 * the different picture planes and the line sizes of the different planes
2898 * will be stored in the lines_sizes array.
2899 * Call with ptr == NULL to get the required size for the ptr buffer.
2901 * @param picture AVPicture whose fields are to be filled in
2902 * @param ptr Buffer which will contain or contains the actual image data
2903 * @param pix_fmt The format in which the picture data is stored.
2904 * @param width the width of the image in pixels
2905 * @param height the height of the image in pixels
2906 * @return size of the image data in bytes
2908 int avpicture_fill(AVPicture
*picture
, uint8_t *ptr
,
2909 enum PixelFormat pix_fmt
, int width
, int height
);
2910 int avpicture_layout(const AVPicture
* src
, enum PixelFormat pix_fmt
, int width
, int height
,
2911 unsigned char *dest
, int dest_size
);
2914 * Calculate the size in bytes that a picture of the given width and height
2915 * would occupy if stored in the given picture format.
2916 * Note that this returns the size of a compact representation as generated
2917 * by avpicture_layout, which can be smaller than the size required for e.g.
2920 * @param pix_fmt the given picture format
2921 * @param width the width of the image
2922 * @param height the height of the image
2923 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2925 int avpicture_get_size(enum PixelFormat pix_fmt
, int width
, int height
);
2926 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt
, int *h_shift
, int *v_shift
);
2927 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt
);
2928 void avcodec_set_dimensions(AVCodecContext
*s
, int width
, int height
);
2931 * Returns the pixel format corresponding to the name name.
2933 * If there is no pixel format with name name, then looks for a
2934 * pixel format with the name corresponding to the native endian
2936 * For example in a little-endian system, first looks for "gray16",
2937 * then for "gray16le".
2939 * Finally if no pixel format has been found, returns PIX_FMT_NONE.
2941 enum PixelFormat
avcodec_get_pix_fmt(const char* name
);
2942 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p
);
2944 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2945 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2946 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2947 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2948 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2949 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2952 * Computes what kind of losses will occur when converting from one specific
2953 * pixel format to another.
2954 * When converting from one pixel format to another, information loss may occur.
2955 * For example, when converting from RGB24 to GRAY, the color information will
2956 * be lost. Similarly, other losses occur when converting from some formats to
2957 * other formats. These losses can involve loss of chroma, but also loss of
2958 * resolution, loss of color depth, loss due to the color space conversion, loss
2959 * of the alpha bits or loss due to color quantization.
2960 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2961 * which will occur when converting from one pixel format to another.
2963 * @param[in] dst_pix_fmt destination pixel format
2964 * @param[in] src_pix_fmt source pixel format
2965 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2966 * @return Combination of flags informing you what kind of losses will occur.
2968 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt
, enum PixelFormat src_pix_fmt
,
2972 * Finds the best pixel format to convert to given a certain source pixel
2973 * format. When converting from one pixel format to another, information loss
2974 * may occur. For example, when converting from RGB24 to GRAY, the color
2975 * information will be lost. Similarly, other losses occur when converting from
2976 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2977 * the given pixel formats should be used to suffer the least amount of loss.
2978 * The pixel formats from which it chooses one, are determined by the
2979 * pix_fmt_mask parameter.
2982 * src_pix_fmt = PIX_FMT_YUV420P;
2983 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2984 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2987 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2988 * @param[in] src_pix_fmt source pixel format
2989 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2990 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2991 * @return The best pixel format to convert to or -1 if none was found.
2993 enum PixelFormat
avcodec_find_best_pix_fmt(int64_t pix_fmt_mask
, enum PixelFormat src_pix_fmt
,
2994 int has_alpha
, int *loss_ptr
);
2998 * Print in buf the string corresponding to the pixel format with
2999 * number pix_fmt, or an header if pix_fmt is negative.
3001 * @param[in] buf the buffer where to write the string
3002 * @param[in] buf_size the size of buf
3003 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
3004 * a negative value to print the corresponding header.
3005 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
3007 void avcodec_pix_fmt_string (char *buf
, int buf_size
, enum PixelFormat pix_fmt
);
3009 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3010 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3013 * Tell if an image really has transparent alpha values.
3014 * @return ored mask of FF_ALPHA_xxx constants
3016 int img_get_alpha_info(const AVPicture
*src
,
3017 enum PixelFormat pix_fmt
, int width
, int height
);
3019 /* deinterlace a picture */
3020 /* deinterlace - if not supported return -1 */
3021 int avpicture_deinterlace(AVPicture
*dst
, const AVPicture
*src
,
3022 enum PixelFormat pix_fmt
, int width
, int height
);
3024 /* external high level API */
3027 * If c is NULL, returns the first registered codec,
3028 * if c is non-NULL, returns the next registered codec after c,
3029 * or NULL if c is the last one.
3031 AVCodec
*av_codec_next(AVCodec
*c
);
3034 * Returns the LIBAVCODEC_VERSION_INT constant.
3036 unsigned avcodec_version(void);
3039 * Initializes libavcodec.
3041 * @warning This function must be called before any other libavcodec
3044 void avcodec_init(void);
3046 #if LIBAVCODEC_VERSION_MAJOR < 53
3048 * @deprecated Deprecated in favor of avcodec_register().
3050 attribute_deprecated
void register_avcodec(AVCodec
*codec
);
3054 * Register the codec codec and initialize libavcodec.
3056 * @see avcodec_init()
3058 void avcodec_register(AVCodec
*codec
);
3061 * Finds a registered encoder with a matching codec ID.
3063 * @param id CodecID of the requested encoder
3064 * @return An encoder if one was found, NULL otherwise.
3066 AVCodec
*avcodec_find_encoder(enum CodecID id
);
3069 * Finds a registered encoder with the specified name.
3071 * @param name name of the requested encoder
3072 * @return An encoder if one was found, NULL otherwise.
3074 AVCodec
*avcodec_find_encoder_by_name(const char *name
);
3077 * Finds a registered decoder with a matching codec ID.
3079 * @param id CodecID of the requested decoder
3080 * @return A decoder if one was found, NULL otherwise.
3082 AVCodec
*avcodec_find_decoder(enum CodecID id
);
3085 * Finds a registered decoder with the specified name.
3087 * @param name name of the requested decoder
3088 * @return A decoder if one was found, NULL otherwise.
3090 AVCodec
*avcodec_find_decoder_by_name(const char *name
);
3091 void avcodec_string(char *buf
, int buf_size
, AVCodecContext
*enc
, int encode
);
3094 * Sets the fields of the given AVCodecContext to default values.
3096 * @param s The AVCodecContext of which the fields should be set to default values.
3098 void avcodec_get_context_defaults(AVCodecContext
*s
);
3100 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3101 * we WILL change its arguments and name a few times! */
3102 void avcodec_get_context_defaults2(AVCodecContext
*s
, enum CodecType
);
3105 * Allocates an AVCodecContext and sets its fields to default values. The
3106 * resulting struct can be deallocated by simply calling av_free().
3108 * @return An AVCodecContext filled with default values or NULL on failure.
3109 * @see avcodec_get_context_defaults
3111 AVCodecContext
*avcodec_alloc_context(void);
3113 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3114 * we WILL change its arguments and name a few times! */
3115 AVCodecContext
*avcodec_alloc_context2(enum CodecType
);
3118 * Sets the fields of the given AVFrame to default values.
3120 * @param pic The AVFrame of which the fields should be set to default values.
3122 void avcodec_get_frame_defaults(AVFrame
*pic
);
3125 * Allocates an AVFrame and sets its fields to default values. The resulting
3126 * struct can be deallocated by simply calling av_free().
3128 * @return An AVFrame filled with default values or NULL on failure.
3129 * @see avcodec_get_frame_defaults
3131 AVFrame
*avcodec_alloc_frame(void);
3133 int avcodec_default_get_buffer(AVCodecContext
*s
, AVFrame
*pic
);
3134 void avcodec_default_release_buffer(AVCodecContext
*s
, AVFrame
*pic
);
3135 int avcodec_default_reget_buffer(AVCodecContext
*s
, AVFrame
*pic
);
3136 void avcodec_align_dimensions(AVCodecContext
*s
, int *width
, int *height
);
3139 * Checks if the given dimension of a picture is valid, meaning that all
3140 * bytes of the picture can be addressed with a signed int.
3142 * @param[in] w Width of the picture.
3143 * @param[in] h Height of the picture.
3144 * @return Zero if valid, a negative value if invalid.
3146 int avcodec_check_dimensions(void *av_log_ctx
, unsigned int w
, unsigned int h
);
3147 enum PixelFormat
avcodec_default_get_format(struct AVCodecContext
*s
, const enum PixelFormat
* fmt
);
3149 int avcodec_thread_init(AVCodecContext
*s
, int thread_count
);
3150 void avcodec_thread_free(AVCodecContext
*s
);
3151 int avcodec_thread_execute(AVCodecContext
*s
, int (*func
)(AVCodecContext
*c2
, void *arg2
),void *arg
, int *ret
, int count
, int size
);
3152 int avcodec_default_execute(AVCodecContext
*c
, int (*func
)(AVCodecContext
*c2
, void *arg2
),void *arg
, int *ret
, int count
, int size
);
3153 //FIXME func typedef
3156 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3157 * function the context has to be allocated.
3159 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3160 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3161 * retrieving a codec.
3163 * @warning This function is not thread safe!
3166 * avcodec_register_all();
3167 * codec = avcodec_find_decoder(CODEC_ID_H264);
3171 * context = avcodec_alloc_context();
3173 * if (avcodec_open(context, codec) < 0)
3177 * @param avctx The context which will be set up to use the given codec.
3178 * @param codec The codec to use within the context.
3179 * @return zero on success, a negative value on error
3180 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3182 int avcodec_open(AVCodecContext
*avctx
, AVCodec
*codec
);
3184 #if LIBAVCODEC_VERSION_MAJOR < 53
3186 * Decodes an audio frame from buf into samples.
3187 * Wrapper function which calls avcodec_decode_audio3.
3189 * @deprecated Use avcodec_decode_audio3 instead.
3190 * @param avctx the codec context
3191 * @param[out] samples the output buffer
3192 * @param[in,out] frame_size_ptr the output buffer size in bytes
3193 * @param[in] buf the input buffer
3194 * @param[in] buf_size the input buffer size in bytes
3195 * @return On error a negative value is returned, otherwise the number of bytes
3196 * used or zero if no frame could be decompressed.
3198 attribute_deprecated
int avcodec_decode_audio2(AVCodecContext
*avctx
, int16_t *samples
,
3199 int *frame_size_ptr
,
3200 const uint8_t *buf
, int buf_size
);
3204 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3205 * Some decoders may support multiple frames in a single AVPacket, such
3206 * decoders would then just decode the first frame.
3208 * could be decompressed, frame_size_ptr is zero. Otherwise, it is the
3209 * decompressed frame size in bytes.
3211 * @warning You must set frame_size_ptr to the allocated size of the
3212 * output buffer before calling avcodec_decode_audio3().
3214 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3215 * the actual read bytes because some optimized bitstream readers read 32 or 64
3216 * bits at once and could read over the end.
3218 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3219 * no overreading happens for damaged MPEG streams.
3221 * @note You might have to align the input buffer avpkt->data and output buffer
3222 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3223 * necessary at all, on others it won't work at all if not aligned and on others
3224 * it will work but it will have an impact on performance.
3226 * In practice, avpkt->data should have 4 byte alignment at minimum and
3227 * samples should be 16 byte aligned unless the CPU doesn't need it
3228 * (AltiVec and SSE do).
3230 * @param avctx the codec context
3231 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3232 * @param[in,out] frame_size_ptr the output buffer size in bytes
3233 * @param[in] avpkt The input AVPacket containing the input buffer.
3234 * You can create such packet with av_init_packet() and by then setting
3235 * data and size, some decoders might in addition need other fields.
3236 * All decoders are designed to use the least fields possible though.
3237 * @return On error a negative value is returned, otherwise the number of bytes
3238 * used or zero if no frame could be decompressed.
3240 int avcodec_decode_audio3(AVCodecContext
*avctx
, int16_t *samples
,
3241 int *frame_size_ptr
,
3244 #if LIBAVCODEC_VERSION_MAJOR < 53
3246 * Decodes a video frame from buf into picture.
3247 * Wrapper function which calls avcodec_decode_video2.
3249 * @deprecated Use avcodec_decode_video2 instead.
3250 * @param avctx the codec context
3251 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3252 * @param[in] buf the input buffer
3253 * @param[in] buf_size the size of the input buffer in bytes
3254 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3255 * @return On error a negative value is returned, otherwise the number of bytes
3256 * used or zero if no frame could be decompressed.
3258 attribute_deprecated
int avcodec_decode_video(AVCodecContext
*avctx
, AVFrame
*picture
,
3259 int *got_picture_ptr
,
3260 const uint8_t *buf
, int buf_size
);
3264 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3265 * Some decoders may support multiple frames in a single AVPacket, such
3266 * decoders would then just decode the first frame.
3268 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3269 * the actual read bytes because some optimized bitstream readers read 32 or 64
3270 * bits at once and could read over the end.
3272 * @warning The end of the input buffer buf should be set to 0 to ensure that
3273 * no overreading happens for damaged MPEG streams.
3275 * @note You might have to align the input buffer avpkt->data.
3276 * The alignment requirements depend on the CPU: on some CPUs it isn't
3277 * necessary at all, on others it won't work at all if not aligned and on others
3278 * it will work but it will have an impact on performance.
3280 * In practice, avpkt->data should have 4 byte alignment at minimum.
3282 * @note Some codecs have a delay between input and output, these need to be
3283 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3285 * @param avctx the codec context
3286 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3287 * @param[in] avpkt The input AVpacket containing the input buffer.
3288 * You can create such packet with av_init_packet() and by then setting
3289 * data and size, some decoders might in addition need other fields like
3290 * flags&PKT_FLAG_KEY. All decoders are designed to use the least
3292 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3293 * @return On error a negative value is returned, otherwise the number of bytes
3294 * used or zero if no frame could be decompressed.
3296 int avcodec_decode_video2(AVCodecContext
*avctx
, AVFrame
*picture
,
3297 int *got_picture_ptr
,
3300 #if LIBAVCODEC_VERSION_MAJOR < 53
3301 /* Decode a subtitle message. Return -1 if error, otherwise return the
3302 * number of bytes used. If no subtitle could be decompressed,
3303 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3304 attribute_deprecated
int avcodec_decode_subtitle(AVCodecContext
*avctx
, AVSubtitle
*sub
,
3306 const uint8_t *buf
, int buf_size
);
3310 * Decodes a subtitle message.
3311 * Returns a negative value on error, otherwise returns the number of bytes used.
3312 * If no subtitle could be decompressed, got_sub_ptr is zero.
3313 * Otherwise, the subtitle is stored in *sub.
3315 * @param avctx the codec context
3316 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3317 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3318 * @param[in] avpkt The input AVPacket containing the input buffer.
3320 int avcodec_decode_subtitle2(AVCodecContext
*avctx
, AVSubtitle
*sub
,
3323 int avcodec_parse_frame(AVCodecContext
*avctx
, uint8_t **pdata
,
3325 uint8_t *buf
, int buf_size
);
3328 * Encodes an audio frame from samples into buf.
3330 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3331 * However, for PCM audio the user will know how much space is needed
3332 * because it depends on the value passed in buf_size as described
3333 * below. In that case a lower value can be used.
3335 * @param avctx the codec context
3336 * @param[out] buf the output buffer
3337 * @param[in] buf_size the output buffer size
3338 * @param[in] samples the input buffer containing the samples
3339 * The number of samples read from this buffer is frame_size*channels,
3340 * both of which are defined in avctx.
3341 * For PCM audio the number of samples read from samples is equal to
3342 * buf_size * input_sample_size / output_sample_size.
3343 * @return On error a negative value is returned, on success zero or the number
3344 * of bytes used to encode the data read from the input buffer.
3346 int avcodec_encode_audio(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
3347 const short *samples
);
3350 * Encodes a video frame from pict into buf.
3351 * The input picture should be
3352 * stored using a specific format, namely avctx.pix_fmt.
3354 * @param avctx the codec context
3355 * @param[out] buf the output buffer for the bitstream of encoded frame
3356 * @param[in] buf_size the size of the output buffer in bytes
3357 * @param[in] pict the input picture to encode
3358 * @return On error a negative value is returned, on success zero or the number
3359 * of bytes used from the output buffer.
3361 int avcodec_encode_video(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
3362 const AVFrame
*pict
);
3363 int avcodec_encode_subtitle(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
3364 const AVSubtitle
*sub
);
3366 int avcodec_close(AVCodecContext
*avctx
);
3369 * Register all the codecs, parsers and bitstream filters which were enabled at
3370 * configuration time. If you do not call this function you can select exactly
3371 * which formats you want to support, by using the individual registration
3374 * @see avcodec_register
3375 * @see av_register_codec_parser
3376 * @see av_register_bitstream_filter
3378 void avcodec_register_all(void);
3381 * Flush buffers, should be called when seeking or when switching to a different stream.
3383 void avcodec_flush_buffers(AVCodecContext
*avctx
);
3385 void avcodec_default_free_buffers(AVCodecContext
*s
);
3387 /* misc useful functions */
3390 * Returns a single letter to describe the given picture type pict_type.
3392 * @param[in] pict_type the picture type
3393 * @return A single character representing the picture type.
3395 char av_get_pict_type_char(int pict_type
);
3398 * Returns codec bits per sample.
3400 * @param[in] codec_id the codec
3401 * @return Number of bits per sample or zero if unknown for the given codec.
3403 int av_get_bits_per_sample(enum CodecID codec_id
);
3406 * Returns sample format bits per sample.
3408 * @param[in] sample_fmt the sample format
3409 * @return Number of bits per sample or zero if unknown for the given sample format.
3411 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt
);
3414 typedef struct AVCodecParserContext
{
3416 struct AVCodecParser
*parser
;
3417 int64_t frame_offset
; /* offset of the current frame */
3418 int64_t cur_offset
; /* current offset
3419 (incremented by each av_parser_parse()) */
3420 int64_t next_frame_offset
; /* offset of the next frame */
3422 int pict_type
; /* XXX: Put it back in AVCodecContext. */
3424 * This field is used for proper frame duration computation in lavf.
3425 * It signals, how much longer the frame duration of the current frame
3426 * is compared to normal frame duration.
3428 * frame_duration = (1 + repeat_pict) * time_base
3430 * It is used by codecs like H.264 to display telecined material.
3432 int repeat_pict
; /* XXX: Put it back in AVCodecContext. */
3433 int64_t pts
; /* pts of the current frame */
3434 int64_t dts
; /* dts of the current frame */
3439 int fetch_timestamp
;
3441 #define AV_PARSER_PTS_NB 4
3442 int cur_frame_start_index
;
3443 int64_t cur_frame_offset
[AV_PARSER_PTS_NB
];
3444 int64_t cur_frame_pts
[AV_PARSER_PTS_NB
];
3445 int64_t cur_frame_dts
[AV_PARSER_PTS_NB
];
3448 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3450 int64_t offset
; ///< byte offset from starting packet start
3451 int64_t cur_frame_end
[AV_PARSER_PTS_NB
];
3454 * Set by parser to 1 for key frames and 0 for non-key frames.
3455 * It is initialized to -1, so if the parser doesn't set this flag,
3456 * old-style fallback using FF_I_TYPE picture type as key frames
3462 * Time difference in stream time base units from the pts of this
3463 * packet to the point at which the output from the decoder has converged
3464 * independent from the availability of previous frames. That is, the
3465 * frames are virtually identical no matter if decoding started from
3466 * the very first frame or from this keyframe.
3467 * Is AV_NOPTS_VALUE if unknown.
3468 * This field is not the display duration of the current frame.
3470 * The purpose of this field is to allow seeking in streams that have no
3471 * keyframes in the conventional sense. It corresponds to the
3472 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3473 * essential for some types of subtitle streams to ensure that all
3474 * subtitles are correctly displayed after seeking.
3476 int64_t convergence_duration
;
3478 // Timestamp generation support:
3480 * Synchronization point for start of timestamp generation.
3482 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3485 * For example, this corresponds to presence of H.264 buffering period
3491 * Offset of the current timestamp against last timestamp sync point in
3492 * units of AVCodecContext.time_base.
3494 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3495 * contain a valid timestamp offset.
3497 * Note that the timestamp of sync point has usually a nonzero
3498 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3499 * the next frame after timestamp sync point will be usually 1.
3501 * For example, this corresponds to H.264 cpb_removal_delay.
3503 int dts_ref_dts_delta
;
3506 * Presentation delay of current frame in units of AVCodecContext.time_base.
3508 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3509 * contain valid non-negative timestamp delta (presentation time of a frame
3510 * must not lie in the past).
3512 * This delay represents the difference between decoding and presentation
3513 * time of the frame.
3515 * For example, this corresponds to H.264 dpb_output_delay.
3520 * Position of the packet in file.
3522 * Analogous to cur_frame_pts/dts
3524 int64_t cur_frame_pos
[AV_PARSER_PTS_NB
];
3527 * Byte position of currently parsed frame in stream.
3532 * Previous frame byte position.
3535 } AVCodecParserContext
;
3537 typedef struct AVCodecParser
{
3538 int codec_ids
[5]; /* several codec IDs are permitted */
3540 int (*parser_init
)(AVCodecParserContext
*s
);
3541 int (*parser_parse
)(AVCodecParserContext
*s
,
3542 AVCodecContext
*avctx
,
3543 const uint8_t **poutbuf
, int *poutbuf_size
,
3544 const uint8_t *buf
, int buf_size
);
3545 void (*parser_close
)(AVCodecParserContext
*s
);
3546 int (*split
)(AVCodecContext
*avctx
, const uint8_t *buf
, int buf_size
);
3547 struct AVCodecParser
*next
;
3550 AVCodecParser
*av_parser_next(AVCodecParser
*c
);
3552 void av_register_codec_parser(AVCodecParser
*parser
);
3553 AVCodecParserContext
*av_parser_init(int codec_id
);
3555 #if LIBAVCODEC_VERSION_MAJOR < 53
3556 attribute_deprecated
3557 int av_parser_parse(AVCodecParserContext
*s
,
3558 AVCodecContext
*avctx
,
3559 uint8_t **poutbuf
, int *poutbuf_size
,
3560 const uint8_t *buf
, int buf_size
,
3561 int64_t pts
, int64_t dts
);
3567 * @param s parser context.
3568 * @param avctx codec context.
3569 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3570 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3571 * @param buf input buffer.
3572 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3573 * @param pts input presentation timestamp.
3574 * @param dts input decoding timestamp.
3575 * @param pos input byte position in stream.
3576 * @return the number of bytes of the input bitstream used.
3581 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3588 * decode_frame(data, size);
3592 int av_parser_parse2(AVCodecParserContext
*s
,
3593 AVCodecContext
*avctx
,
3594 uint8_t **poutbuf
, int *poutbuf_size
,
3595 const uint8_t *buf
, int buf_size
,
3596 int64_t pts
, int64_t dts
,
3599 int av_parser_change(AVCodecParserContext
*s
,
3600 AVCodecContext
*avctx
,
3601 uint8_t **poutbuf
, int *poutbuf_size
,
3602 const uint8_t *buf
, int buf_size
, int keyframe
);
3603 void av_parser_close(AVCodecParserContext
*s
);
3606 typedef struct AVBitStreamFilterContext
{
3608 struct AVBitStreamFilter
*filter
;
3609 AVCodecParserContext
*parser
;
3610 struct AVBitStreamFilterContext
*next
;
3611 } AVBitStreamFilterContext
;
3614 typedef struct AVBitStreamFilter
{
3617 int (*filter
)(AVBitStreamFilterContext
*bsfc
,
3618 AVCodecContext
*avctx
, const char *args
,
3619 uint8_t **poutbuf
, int *poutbuf_size
,
3620 const uint8_t *buf
, int buf_size
, int keyframe
);
3621 void (*close
)(AVBitStreamFilterContext
*bsfc
);
3622 struct AVBitStreamFilter
*next
;
3623 } AVBitStreamFilter
;
3625 void av_register_bitstream_filter(AVBitStreamFilter
*bsf
);
3626 AVBitStreamFilterContext
*av_bitstream_filter_init(const char *name
);
3627 int av_bitstream_filter_filter(AVBitStreamFilterContext
*bsfc
,
3628 AVCodecContext
*avctx
, const char *args
,
3629 uint8_t **poutbuf
, int *poutbuf_size
,
3630 const uint8_t *buf
, int buf_size
, int keyframe
);
3631 void av_bitstream_filter_close(AVBitStreamFilterContext
*bsf
);
3633 AVBitStreamFilter
*av_bitstream_filter_next(AVBitStreamFilter
*f
);
3638 * Reallocates the given block if it is not large enough, otherwise it
3643 void *av_fast_realloc(void *ptr
, unsigned int *size
, unsigned int min_size
);
3646 * Allocates a buffer, reusing the given one if large enough.
3648 * Contrary to av_fast_realloc the current buffer contents might not be
3649 * preserved and on error the old buffer is freed, thus no special
3650 * handling to avoid memleaks is necessary.
3652 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3653 * @param size size of the buffer *ptr points to
3654 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3655 * *size 0 if an error occurred.
3657 void av_fast_malloc(void *ptr
, unsigned int *size
, unsigned int min_size
);
3660 * Copy image 'src' to 'dst'.
3662 void av_picture_copy(AVPicture
*dst
, const AVPicture
*src
,
3663 enum PixelFormat pix_fmt
, int width
, int height
);
3666 * Crop image top and left side.
3668 int av_picture_crop(AVPicture
*dst
, const AVPicture
*src
,
3669 enum PixelFormat pix_fmt
, int top_band
, int left_band
);
3674 int av_picture_pad(AVPicture
*dst
, const AVPicture
*src
, int height
, int width
, enum PixelFormat pix_fmt
,
3675 int padtop
, int padbottom
, int padleft
, int padright
, int *color
);
3677 unsigned int av_xiphlacing(unsigned char *s
, unsigned int v
);
3680 * Parses str and put in width_ptr and height_ptr the detected values.
3682 * @return 0 in case of a successful parsing, a negative value otherwise
3683 * @param[in] str the string to parse: it has to be a string in the format
3684 * <width>x<height> or a valid video frame size abbreviation.
3685 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3687 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3688 * frame height value
3690 int av_parse_video_frame_size(int *width_ptr
, int *height_ptr
, const char *str
);
3693 * Parses str and put in frame_rate the detected values.
3695 * @return 0 in case of a successful parsing, a negative value otherwise
3696 * @param[in] str the string to parse: it has to be a string in the format
3697 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3698 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3701 int av_parse_video_frame_rate(AVRational
*frame_rate
, const char *str
);
3703 /* error handling */
3705 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3706 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3708 /* Some platforms have E* and errno already negated. */
3709 #define AVERROR(e) (e)
3710 #define AVUNERROR(e) (e)
3712 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3713 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3714 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3715 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3716 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3717 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3718 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3719 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3720 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3721 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3724 * Logs a generic warning message about a missing feature. This function is
3725 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3726 * only, and would normally not be used by applications.
3727 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3728 * a pointer to an AVClass struct
3729 * @param[in] feature string containing the name of the missing feature
3730 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3731 * If want_sample is non-zero, additional verbage will be added to the log
3732 * message which tells the user how to report samples to the development
3735 void av_log_missing_feature(void *avc
, const char *feature
, int want_sample
);
3738 * Logs a generic warning message asking for a sample. This function is
3739 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
3740 * only, and would normally not be used by applications.
3741 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3742 * a pointer to an AVClass struct
3743 * @param[in] msg string containing an optional message, or NULL if no message
3745 void av_log_ask_for_sample(void *avc
, const char *msg
);
3748 * Registers the hardware accelerator hwaccel.
3750 void av_register_hwaccel(AVHWAccel
*hwaccel
);
3753 * If hwaccel is NULL, returns the first registered hardware accelerator,
3754 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3755 * after hwaccel, or NULL if hwaccel is the last one.
3757 AVHWAccel
*av_hwaccel_next(AVHWAccel
*hwaccel
);
3761 * Lock operation used by lockmgr
3764 AV_LOCK_CREATE
, ///< Create a mutex
3765 AV_LOCK_OBTAIN
, ///< Lock the mutex
3766 AV_LOCK_RELEASE
, ///< Unlock the mutex
3767 AV_LOCK_DESTROY
, ///< Free mutex resources
3771 * Register a user provided lock manager supporting the operations
3772 * specified by AVLockOp. mutex points to a (void *) where the
3773 * lockmgr should store/get a pointer to a user allocated mutex. It's
3774 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
3776 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
3777 * callback during the call to av_lockmgr_register().
3778 * Thus, the application must be prepared to handle that.
3779 * If cb is set to NULL the lockmgr will be unregistered.
3780 * Also note that during unregistration the previously registered
3781 * lockmgr callback may also be invoked.
3783 int av_lockmgr_register(int (*cb
)(void **mutex
, enum AVLockOp op
));
3785 #endif /* AVCODEC_AVCODEC_H */