2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
37 #include "libavutil/audioconvert.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
91 * This ensures that 2 forks can independently add CodecIDs without producing conflicts.
98 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
99 CODEC_ID_MPEG2VIDEO_XVMC,
136 CODEC_ID_INTERPLAY_VIDEO,
148 CODEC_ID_TRUEMOTION1,
175 CODEC_ID_TRUEMOTION2,
192 CODEC_ID_DSICINVIDEO,
193 CODEC_ID_TIERTEXSEQVIDEO,
201 CODEC_ID_BETHSOFTVID,
217 CODEC_ID_MOTIONPIXELS,
235 CODEC_ID_IFF_BYTERUN1,
260 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
261 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
262 CODEC_ID_EXR = MKBETAG('0','E','X','R'),
263 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
265 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
266 CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
267 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
268 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
269 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
270 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
272 /* various PCM "codecs" */
273 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
274 CODEC_ID_PCM_S16LE = 0x10000,
290 CODEC_ID_PCM_S24DAUD,
292 CODEC_ID_PCM_S16LE_PLANAR,
301 CODEC_ID_PCM_S8_PLANAR,
303 /* various ADPCM codecs */
304 CODEC_ID_ADPCM_IMA_QT = 0x11000,
305 CODEC_ID_ADPCM_IMA_WAV,
306 CODEC_ID_ADPCM_IMA_DK3,
307 CODEC_ID_ADPCM_IMA_DK4,
308 CODEC_ID_ADPCM_IMA_WS,
309 CODEC_ID_ADPCM_IMA_SMJPEG,
318 CODEC_ID_ADPCM_YAMAHA,
319 CODEC_ID_ADPCM_SBPRO_4,
320 CODEC_ID_ADPCM_SBPRO_3,
321 CODEC_ID_ADPCM_SBPRO_2,
323 CODEC_ID_ADPCM_IMA_AMV,
324 CODEC_ID_ADPCM_EA_R1,
325 CODEC_ID_ADPCM_EA_R3,
326 CODEC_ID_ADPCM_EA_R2,
327 CODEC_ID_ADPCM_IMA_EA_SEAD,
328 CODEC_ID_ADPCM_IMA_EA_EACS,
329 CODEC_ID_ADPCM_EA_XAS,
330 CODEC_ID_ADPCM_EA_MAXIS_XA,
331 CODEC_ID_ADPCM_IMA_ISS,
333 CODEC_ID_ADPCM_IMA_APC,
336 CODEC_ID_AMR_NB = 0x12000,
339 /* RealAudio codecs*/
340 CODEC_ID_RA_144 = 0x13000,
343 /* various DPCM codecs */
344 CODEC_ID_ROQ_DPCM = 0x14000,
345 CODEC_ID_INTERPLAY_DPCM,
350 CODEC_ID_MP2 = 0x15000,
351 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
367 CODEC_ID_WESTWOOD_SND1,
368 CODEC_ID_GSM, ///< as in Berlin toast format
376 CODEC_ID_DSICINAUDIO,
380 CODEC_ID_GSM_MS, /* as found in WAV */
389 CODEC_ID_WMALOSSLESS,
398 CODEC_ID_BINKAUDIO_RDFT,
399 CODEC_ID_BINKAUDIO_DCT,
410 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
411 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
412 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
413 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
415 /* subtitle codecs */
416 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
417 CODEC_ID_DVD_SUBTITLE = 0x17000,
418 CODEC_ID_DVB_SUBTITLE,
419 CODEC_ID_TEXT, ///< raw UTF-8 text
423 CODEC_ID_HDMV_PGS_SUBTITLE,
424 CODEC_ID_DVB_TELETEXT,
426 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
427 CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
428 CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
430 /* other specific kind of codecs (generally used for attachments) */
431 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
432 CODEC_ID_TTF = 0x18000,
433 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
434 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
435 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
437 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
439 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
440 * stream (only used by libavformat) */
441 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
442 * stream (only used by libavformat) */
443 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
446 #if FF_API_OLD_DECODE_AUDIO
448 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
452 * @ingroup lavc_decoding
453 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
454 * This is mainly needed because some optimized bitstream readers read
455 * 32 or 64 bit at once and could read over the end.<br>
456 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
457 * MPEG bitstreams could cause overread and segfault.
459 #define FF_INPUT_BUFFER_PADDING_SIZE 16
462 * @ingroup lavc_encoding
463 * minimum encoding buffer size
464 * Used to avoid some checks during header writing.
466 #define FF_MIN_BUFFER_SIZE 16384
470 * @ingroup lavc_encoding
471 * motion estimation type.
474 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
478 ME_EPZS, ///< enhanced predictive zonal search
479 ME_X1, ///< reserved for experiments
480 ME_HEX, ///< hexagon based search
481 ME_UMH, ///< uneven multi-hexagon search
482 ME_ITER, ///< iterative search
483 ME_TESA, ///< transformed exhaustive search algorithm
487 * @ingroup lavc_decoding
490 /* We leave some space between them for extensions (drop some
491 * keyframes for intra-only or drop just some bidir frames). */
492 AVDISCARD_NONE =-16, ///< discard nothing
493 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
494 AVDISCARD_NONREF = 8, ///< discard all non reference
495 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
496 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
497 AVDISCARD_ALL = 48, ///< discard all
500 enum AVColorPrimaries{
501 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
502 AVCOL_PRI_UNSPECIFIED = 2,
503 AVCOL_PRI_BT470M = 4,
504 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
505 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
506 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
508 AVCOL_PRI_NB , ///< Not part of ABI
511 enum AVColorTransferCharacteristic{
512 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
513 AVCOL_TRC_UNSPECIFIED = 2,
514 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
515 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
516 AVCOL_TRC_SMPTE240M = 7,
517 AVCOL_TRC_NB , ///< Not part of ABI
522 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
523 AVCOL_SPC_UNSPECIFIED = 2,
525 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
526 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
527 AVCOL_SPC_SMPTE240M = 7,
528 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
529 AVCOL_SPC_NB , ///< Not part of ABI
531 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
534 AVCOL_RANGE_UNSPECIFIED = 0,
535 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
536 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
537 AVCOL_RANGE_NB , ///< Not part of ABI
541 * X X 3 4 X X are luma samples,
542 * 1 2 1-6 are possible chroma positions
543 * X X 5 6 X 0 is undefined/unknown position
545 enum AVChromaLocation{
546 AVCHROMA_LOC_UNSPECIFIED = 0,
547 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
548 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
549 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
550 AVCHROMA_LOC_TOP = 4,
551 AVCHROMA_LOC_BOTTOMLEFT = 5,
552 AVCHROMA_LOC_BOTTOM = 6,
553 AVCHROMA_LOC_NB , ///< Not part of ABI
556 enum AVAudioServiceType {
557 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
558 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
559 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
560 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
561 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
562 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
563 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
564 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
565 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
566 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
570 * @ingroup lavc_encoding
572 typedef struct RcOverride{
575 int qscale; // If this is 0 then quality_factor will be used instead.
576 float quality_factor;
579 #define FF_MAX_B_FRAMES 16
582 These flags can be passed in AVCodecContext.flags before initialization.
583 Note: Not everything is supported yet.
586 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
587 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
588 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
589 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
590 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
592 * The parent program guarantees that the input for B-frames containing
593 * streams is not written to for at least s->max_b_frames+1 frames, if
594 * this is not set the input will be copied.
596 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
597 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
598 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
599 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
600 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
601 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
602 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
603 location instead of only at frame boundaries. */
604 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
605 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
606 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
607 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
608 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
609 /* Fx : Flag for h263+ extra options */
610 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
611 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
612 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
613 #define CODEC_FLAG_CLOSED_GOP 0x80000000
614 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
615 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
616 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
617 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
618 #if FF_API_MPV_GLOBAL_OPTS
619 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
620 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
621 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
622 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
624 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
625 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
627 /* Unsupported options :
628 * Syntax Arithmetic coding (SAC)
629 * Reference Picture Selection
630 * Independent Segment Decoding */
632 /* codec capabilities */
634 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
636 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
637 * If not set, it might not use get_buffer() at all or use operations that
638 * assume the buffer was allocated by avcodec_default_get_buffer.
640 #define CODEC_CAP_DR1 0x0002
641 #define CODEC_CAP_TRUNCATED 0x0008
642 /* Codec can export data for HW decoding (XvMC). */
643 #define CODEC_CAP_HWACCEL 0x0010
645 * Encoder or decoder requires flushing with NULL input at the end in order to
646 * give the complete and correct output.
648 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
649 * with NULL data. The user can still send NULL data to the public encode
650 * or decode function, but libavcodec will not pass it along to the codec
651 * unless this flag is set.
654 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
655 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
659 * The encoder needs to be fed with NULL data at the end of encoding until the
660 * encoder no longer returns data.
662 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
663 * flag also means that the encoder must set the pts and duration for
664 * each output packet. If this flag is not set, the pts and duration will
665 * be determined by libavcodec from the input frame.
667 #define CODEC_CAP_DELAY 0x0020
669 * Codec can be fed a final frame with a smaller size.
670 * This can be used to prevent truncation of the last audio samples.
672 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
674 * Codec can export data for HW decoding (VDPAU).
676 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
678 * Codec can output multiple frames per AVPacket
679 * Normally demuxers return one frame at a time, demuxers which do not do
680 * are connected to a parser to split what they return into proper frames.
681 * This flag is reserved to the very rare category of codecs which have a
682 * bitstream that cannot be split into frames without timeconsuming
683 * operations like full decoding. Demuxers carring such bitstreams thus
684 * may return multiple frames in a packet. This has many disadvantages like
685 * prohibiting stream copy in many cases thus it should only be considered
688 #define CODEC_CAP_SUBFRAMES 0x0100
690 * Codec is experimental and is thus avoided in favor of non experimental
693 #define CODEC_CAP_EXPERIMENTAL 0x0200
695 * Codec should fill in channel configuration and samplerate instead of container
697 #define CODEC_CAP_CHANNEL_CONF 0x0400
700 * Codec is able to deal with negative linesizes
702 #define CODEC_CAP_NEG_LINESIZES 0x0800
705 * Codec supports frame-level multithreading.
707 #define CODEC_CAP_FRAME_THREADS 0x1000
709 * Codec supports slice-based (or partition-based) multithreading.
711 #define CODEC_CAP_SLICE_THREADS 0x2000
713 * Codec supports changed parameters at any point.
715 #define CODEC_CAP_PARAM_CHANGE 0x4000
717 * Codec supports avctx->thread_count == 0 (auto).
719 #define CODEC_CAP_AUTO_THREADS 0x8000
721 * Audio encoder supports receiving a different number of samples in each call.
723 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
727 #define CODEC_CAP_LOSSLESS 0x80000000
729 //The following defines may change, don't expect compatibility if you use them.
730 #define MB_TYPE_INTRA4x4 0x0001
731 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
732 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
733 #define MB_TYPE_16x16 0x0008
734 #define MB_TYPE_16x8 0x0010
735 #define MB_TYPE_8x16 0x0020
736 #define MB_TYPE_8x8 0x0040
737 #define MB_TYPE_INTERLACED 0x0080
738 #define MB_TYPE_DIRECT2 0x0100 //FIXME
739 #define MB_TYPE_ACPRED 0x0200
740 #define MB_TYPE_GMC 0x0400
741 #define MB_TYPE_SKIP 0x0800
742 #define MB_TYPE_P0L0 0x1000
743 #define MB_TYPE_P1L0 0x2000
744 #define MB_TYPE_P0L1 0x4000
745 #define MB_TYPE_P1L1 0x8000
746 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
747 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
748 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
749 #define MB_TYPE_QUANT 0x00010000
750 #define MB_TYPE_CBP 0x00020000
751 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
755 * This specifies the area which should be displayed.
756 * Note there may be multiple such areas for one frame.
758 typedef struct AVPanScan{
761 * - encoding: Set by user.
762 * - decoding: Set by libavcodec.
767 * width and height in 1/16 pel
768 * - encoding: Set by user.
769 * - decoding: Set by libavcodec.
775 * position of the top left corner in 1/16 pel for up to 3 fields/frames
776 * - encoding: Set by user.
777 * - decoding: Set by libavcodec.
779 int16_t position[3][2];
782 #define FF_QSCALE_TYPE_MPEG1 0
783 #define FF_QSCALE_TYPE_MPEG2 1
784 #define FF_QSCALE_TYPE_H264 2
785 #define FF_QSCALE_TYPE_VP56 3
787 #define FF_BUFFER_TYPE_INTERNAL 1
788 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
789 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
790 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
792 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
793 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
794 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
795 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
798 * @defgroup lavc_packet AVPacket
800 * Types and functions for working with AVPacket.
803 enum AVPacketSideDataType {
805 AV_PKT_DATA_NEW_EXTRADATA,
808 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
811 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
812 * s32le channel_count
813 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
814 * u64le channel_layout
815 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
817 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
822 AV_PKT_DATA_PARAM_CHANGE,
825 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
826 * structures with info about macroblocks relevant to splitting the
827 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
828 * That is, it does not necessarily contain info about all macroblocks,
829 * as long as the distance between macroblocks in the info is smaller
830 * than the target payload size.
831 * Each MB info structure is 12 bytes, and is laid out as follows:
833 * u32le bit offset from the start of the packet
834 * u8 current quantizer at the start of the macroblock
836 * u16le macroblock address within the GOB
837 * u8 horizontal MV predictor
838 * u8 vertical MV predictor
839 * u8 horizontal MV predictor for block number 3
840 * u8 vertical MV predictor for block number 3
843 AV_PKT_DATA_H263_MB_INFO,
846 typedef struct AVPacket {
848 * Presentation timestamp in AVStream->time_base units; the time at which
849 * the decompressed packet will be presented to the user.
850 * Can be AV_NOPTS_VALUE if it is not stored in the file.
851 * pts MUST be larger or equal to dts as presentation cannot happen before
852 * decompression, unless one wants to view hex dumps. Some formats misuse
853 * the terms dts and pts/cts to mean something different. Such timestamps
854 * must be converted to true pts/dts before they are stored in AVPacket.
858 * Decompression timestamp in AVStream->time_base units; the time at which
859 * the packet is decompressed.
860 * Can be AV_NOPTS_VALUE if it is not stored in the file.
867 * A combination of AV_PKT_FLAG values
871 * Additional packet data that can be provided by the container.
872 * Packet can contain several types of side information.
877 enum AVPacketSideDataType type;
882 * Duration of this packet in AVStream->time_base units, 0 if unknown.
883 * Equals next_pts - this_pts in presentation order.
886 void (*destruct)(struct AVPacket *);
888 int64_t pos; ///< byte position in stream, -1 if unknown
891 * Time difference in AVStream->time_base units from the pts of this
892 * packet to the point at which the output from the decoder has converged
893 * independent from the availability of previous frames. That is, the
894 * frames are virtually identical no matter if decoding started from
895 * the very first frame or from this keyframe.
896 * Is AV_NOPTS_VALUE if unknown.
897 * This field is not the display duration of the current packet.
898 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
901 * The purpose of this field is to allow seeking in streams that have no
902 * keyframes in the conventional sense. It corresponds to the
903 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
904 * essential for some types of subtitle streams to ensure that all
905 * subtitles are correctly displayed after seeking.
907 int64_t convergence_duration;
909 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
910 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
912 enum AVSideDataParamChangeFlags {
913 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
914 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
915 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
916 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
924 * New fields can be added to the end of AVFRAME with minor version
925 * bumps. Similarly fields that are marked as to be only accessed by
926 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
927 * without breaking compatibility with each other.
928 * Removal, reordering and changes in the remaining cases require
929 * a major version bump.
930 * sizeof(AVFrame) must not be used outside libavcodec.
932 typedef struct AVFrame {
933 #define AV_NUM_DATA_POINTERS 8
935 * pointer to the picture/channel planes.
936 * This might be different from the first allocated byte
937 * - encoding: Set by user
938 * - decoding: set by AVCodecContext.get_buffer()
940 uint8_t *data[AV_NUM_DATA_POINTERS];
943 * Size, in bytes, of the data for each picture/channel plane.
945 * For audio, only linesize[0] may be set. For planar audio, each channel
946 * plane must be the same size.
948 * - encoding: Set by user
949 * - decoding: set by AVCodecContext.get_buffer()
951 int linesize[AV_NUM_DATA_POINTERS];
954 * pointers to the data planes/channels.
956 * For video, this should simply point to data[].
958 * For planar audio, each channel has a separate data pointer, and
959 * linesize[0] contains the size of each channel buffer.
960 * For packed audio, there is just one data pointer, and linesize[0]
961 * contains the total size of the buffer for all channels.
963 * Note: Both data and extended_data will always be set by get_buffer(),
964 * but for planar audio with more channels that can fit in data,
965 * extended_data must be used by the decoder in order to access all
969 * decoding: set by AVCodecContext.get_buffer()
971 uint8_t **extended_data;
974 * width and height of the video frame
976 * - decoding: Read by user.
981 * number of audio samples (per channel) described by this frame
982 * - encoding: Set by user
983 * - decoding: Set by libavcodec
988 * format of the frame, -1 if unknown or unset
989 * Values correspond to enum PixelFormat for video frames,
990 * enum AVSampleFormat for audio)
992 * - decoding: Read by user.
997 * 1 -> keyframe, 0-> not
998 * - encoding: Set by libavcodec.
999 * - decoding: Set by libavcodec.
1004 * Picture type of the frame, see ?_TYPE below.
1005 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1006 * - decoding: Set by libavcodec.
1008 enum AVPictureType pict_type;
1011 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1012 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1016 uint8_t *base[AV_NUM_DATA_POINTERS];
1019 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1020 * - encoding: unused
1021 * - decoding: Read by user.
1023 AVRational sample_aspect_ratio;
1026 * presentation timestamp in time_base units (time when frame should be shown to user)
1027 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1028 * - encoding: MUST be set by user.
1029 * - decoding: Set by libavcodec.
1034 * reordered pts from the last AVPacket that has been input into the decoder
1035 * - encoding: unused
1036 * - decoding: Read by user.
1041 * dts from the last AVPacket that has been input into the decoder
1042 * - encoding: unused
1043 * - decoding: Read by user.
1048 * picture number in bitstream order
1049 * - encoding: set by
1050 * - decoding: Set by libavcodec.
1052 int coded_picture_number;
1054 * picture number in display order
1055 * - encoding: set by
1056 * - decoding: Set by libavcodec.
1058 int display_picture_number;
1061 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1062 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1063 * - decoding: Set by libavcodec.
1068 * is this picture used as reference
1069 * The values for this are the same as the MpegEncContext.picture_structure
1070 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1071 * Set to 4 for delayed, non-reference frames.
1072 * - encoding: unused
1073 * - decoding: Set by libavcodec. (before get_buffer() call)).
1079 * - encoding: unused
1080 * - decoding: Set by libavcodec.
1082 int8_t *qscale_table;
1085 * - encoding: unused
1086 * - decoding: Set by libavcodec.
1096 * mbskip_table[mb]>=1 if MB didn't change
1097 * stride= mb_width = (width+15)>>4
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec.
1101 uint8_t *mbskip_table;
1104 * motion vector table
1107 * int mv_sample_log2= 4 - motion_subsample_log2;
1108 * int mb_width= (width+15)>>4;
1109 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1110 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1112 * - encoding: Set by user.
1113 * - decoding: Set by libavcodec.
1115 int16_t (*motion_val[2])[2];
1118 * macroblock type table
1119 * mb_type_base + mb_width + 2
1120 * - encoding: Set by user.
1121 * - decoding: Set by libavcodec.
1127 * - encoding: unused
1128 * - decoding: Set by libavcodec.
1133 * motion reference frame index
1134 * the order in which these are stored can depend on the codec.
1135 * - encoding: Set by user.
1136 * - decoding: Set by libavcodec.
1138 int8_t *ref_index[2];
1141 * for some private data of the user
1142 * - encoding: unused
1143 * - decoding: Set by user.
1149 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1150 * - decoding: unused
1152 uint64_t error[AV_NUM_DATA_POINTERS];
1155 * type of the buffer (to keep track of who has to deallocate data[*])
1156 * - encoding: Set by the one who allocates it.
1157 * - decoding: Set by the one who allocates it.
1158 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1163 * When decoding, this signals how much the picture must be delayed.
1164 * extra_delay = repeat_pict / (2*fps)
1165 * - encoding: unused
1166 * - decoding: Set by libavcodec.
1171 * The content of the picture is interlaced.
1172 * - encoding: Set by user.
1173 * - decoding: Set by libavcodec. (default 0)
1175 int interlaced_frame;
1178 * If the content is interlaced, is top field displayed first.
1179 * - encoding: Set by user.
1180 * - decoding: Set by libavcodec.
1182 int top_field_first;
1185 * Tell user application that palette has changed from previous frame.
1186 * - encoding: ??? (no palette-enabled encoder yet)
1187 * - decoding: Set by libavcodec. (default 0).
1189 int palette_has_changed;
1192 * codec suggestion on buffer type if != 0
1193 * - encoding: unused
1194 * - decoding: Set by libavcodec. (before get_buffer() call)).
1200 * - encoding: Set by user.
1201 * - decoding: Set by libavcodec.
1203 AVPanScan *pan_scan;
1206 * reordered opaque 64bit (generally an integer or a double precision float
1207 * PTS but can be anything).
1208 * The user sets AVCodecContext.reordered_opaque to represent the input at
1210 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1211 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1212 * @deprecated in favor of pkt_pts
1213 * - encoding: unused
1214 * - decoding: Read by user.
1216 int64_t reordered_opaque;
1219 * hardware accelerator private data (FFmpeg-allocated)
1220 * - encoding: unused
1221 * - decoding: Set by libavcodec
1223 void *hwaccel_picture_private;
1226 * the AVCodecContext which ff_thread_get_buffer() was last called on
1227 * - encoding: Set by libavcodec.
1228 * - decoding: Set by libavcodec.
1230 struct AVCodecContext *owner;
1233 * used by multithreading to store frame-specific info
1234 * - encoding: Set by libavcodec.
1235 * - decoding: Set by libavcodec.
1237 void *thread_opaque;
1240 * log2 of the size of the block which a single vector in motion_val represents:
1241 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1242 * - encoding: unused
1243 * - decoding: Set by libavcodec.
1245 uint8_t motion_subsample_log2;
1248 * Sample rate of the audio data.
1250 * - encoding: unused
1251 * - decoding: read by user
1256 * Channel layout of the audio data.
1258 * - encoding: unused
1259 * - decoding: read by user.
1261 uint64_t channel_layout;
1264 * frame timestamp estimated using various heuristics, in stream time base
1265 * Code outside libavcodec should access this field using:
1266 * av_frame_get_best_effort_timestamp(frame)
1267 * - encoding: unused
1268 * - decoding: set by libavcodec, read by user.
1270 int64_t best_effort_timestamp;
1273 * reordered pos from the last AVPacket that has been input into the decoder
1274 * Code outside libavcodec should access this field using:
1275 * av_frame_get_pkt_pos(frame)
1276 * - encoding: unused
1277 * - decoding: Read by user.
1282 * duration of the corresponding packet, expressed in
1283 * AVStream->time_base units, 0 if unknown.
1284 * Code outside libavcodec should access this field using:
1285 * av_frame_get_pkt_duration(frame)
1286 * - encoding: unused
1287 * - decoding: Read by user.
1289 int64_t pkt_duration;
1293 * Accessors for some AVFrame fields.
1294 * The position of these field in the structure is not part of the ABI,
1295 * they should not be accessed directly outside libavcodec.
1297 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1298 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1299 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1300 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1301 int av_frame_get_sample_rate (const AVFrame *frame);
1302 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1303 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1304 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1305 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1306 void av_frame_set_sample_rate (AVFrame *frame, int val);
1308 struct AVCodecInternal;
1312 AV_FIELD_PROGRESSIVE,
1313 AV_FIELD_TT, //< Top coded_first, top displayed first
1314 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1315 AV_FIELD_TB, //< Top coded first, bottom displayed first
1316 AV_FIELD_BT, //< Bottom coded first, top displayed first
1320 * main external API structure.
1321 * New fields can be added to the end with minor version bumps.
1322 * Removal, reordering and changes to existing fields require a major
1324 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1326 * sizeof(AVCodecContext) must not be used outside libav*.
1328 typedef struct AVCodecContext {
1330 * information on struct for av_log
1331 * - set by avcodec_alloc_context3
1333 const AVClass *av_class;
1334 int log_level_offset;
1336 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1337 struct AVCodec *codec;
1338 char codec_name[32];
1339 enum CodecID codec_id; /* see CODEC_ID_xxx */
1342 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1343 * This is used to work around some encoder bugs.
1344 * A demuxer should set this to what is stored in the field used to identify the codec.
1345 * If there are multiple such fields in a container then the demuxer should choose the one
1346 * which maximizes the information about the used codec.
1347 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1348 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1349 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1351 * - encoding: Set by user, if not then the default based on codec_id will be used.
1352 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1354 unsigned int codec_tag;
1357 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1358 * This is used to work around some encoder bugs.
1359 * - encoding: unused
1360 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1362 unsigned int stream_codec_tag;
1366 * @deprecated this field is unused
1368 attribute_deprecated int sub_id;
1374 * Private context used for internal data.
1376 * Unlike priv_data, this is not codec-specific. It is used in general
1377 * libavcodec functions.
1379 struct AVCodecInternal *internal;
1382 * Private data of the user, can be used to carry app specific stuff.
1383 * - encoding: Set by user.
1384 * - decoding: Set by user.
1389 * the average bitrate
1390 * - encoding: Set by user; unused for constant quantizer encoding.
1391 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1396 * number of bits the bitstream is allowed to diverge from the reference.
1397 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1398 * - encoding: Set by user; unused for constant quantizer encoding.
1399 * - decoding: unused
1401 int bit_rate_tolerance;
1404 * Global quality for codecs which cannot change it per frame.
1405 * This should be proportional to MPEG-1/2/4 qscale.
1406 * - encoding: Set by user.
1407 * - decoding: unused
1412 * - encoding: Set by user.
1413 * - decoding: unused
1415 int compression_level;
1416 #define FF_COMPRESSION_DEFAULT -1
1420 * - encoding: Set by user.
1421 * - decoding: Set by user.
1427 * - encoding: Set by user.
1428 * - decoding: Set by user.
1433 * some codecs need / can use extradata like Huffman tables.
1434 * mjpeg: Huffman tables
1435 * rv10: additional flags
1436 * mpeg4: global headers (they can be in the bitstream or here)
1437 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1438 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1439 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1440 * - encoding: Set/allocated/freed by libavcodec.
1441 * - decoding: Set/allocated/freed by user.
1447 * This is the fundamental unit of time (in seconds) in terms
1448 * of which frame timestamps are represented. For fixed-fps content,
1449 * timebase should be 1/framerate and timestamp increments should be
1451 * - encoding: MUST be set by user.
1452 * - decoding: Set by libavcodec.
1454 AVRational time_base;
1457 * For some codecs, the time base is closer to the field rate than the frame rate.
1458 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1459 * if no telecine is used ...
1461 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1463 int ticks_per_frame;
1466 * Encoding: Number of frames delay there will be from the encoder input to
1467 * the decoder output. (we assume the decoder matches the spec)
1468 * Decoding: Number of frames delay in addition to what a standard decoder
1469 * as specified in the spec would produce.
1472 * Number of frames the decoded output will be delayed relative to the
1476 * Number of "priming" samples added to the beginning of the stream
1477 * during encoding. The decoded output will be delayed by this many
1478 * samples relative to the input to the encoder. Note that this field is
1479 * purely informational and does not directly affect the pts output by
1480 * the encoder, which should always be based on the actual presentation
1481 * time, including any delay.
1483 * - encoding: Set by libavcodec.
1484 * - decoding: Set by libavcodec.
1491 * picture width / height.
1492 * - encoding: MUST be set by user.
1493 * - decoding: Set by libavcodec.
1494 * Note: For compatibility it is possible to set this instead of
1495 * coded_width/height before decoding.
1500 * Bitstream width / height, may be different from width/height if lowres enabled.
1501 * - encoding: unused
1502 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1504 int coded_width, coded_height;
1506 #define FF_ASPECT_EXTENDED 15
1509 * the number of pictures in a group of pictures, or 0 for intra_only
1510 * - encoding: Set by user.
1511 * - decoding: unused
1516 * Pixel format, see PIX_FMT_xxx.
1517 * May be set by the demuxer if known from headers.
1518 * May be overriden by the decoder if it knows better.
1519 * - encoding: Set by user.
1520 * - decoding: Set by user if known, overridden by libavcodec if known
1522 enum PixelFormat pix_fmt;
1525 * Motion estimation algorithm used for video coding.
1526 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1527 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1528 * - encoding: MUST be set by user.
1529 * - decoding: unused
1534 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1535 * decoder to draw a horizontal band. It improves cache usage. Not
1536 * all codecs can do that. You must check the codec capabilities
1538 * When multithreading is used, it may be called from multiple threads
1539 * at the same time; threads might draw different parts of the same AVFrame,
1540 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1542 * The function is also used by hardware acceleration APIs.
1543 * It is called at least once during frame decoding to pass
1544 * the data needed for hardware render.
1545 * In that mode instead of pixel data, AVFrame points to
1546 * a structure specific to the acceleration API. The application
1547 * reads the structure and can change some fields to indicate progress
1549 * - encoding: unused
1550 * - decoding: Set by user.
1551 * @param height the height of the slice
1552 * @param y the y position of the slice
1553 * @param type 1->top field, 2->bottom field, 3->frame
1554 * @param offset offset into the AVFrame.data from which the slice should be read
1556 void (*draw_horiz_band)(struct AVCodecContext *s,
1557 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1558 int y, int type, int height);
1561 * callback to negotiate the pixelFormat
1562 * @param fmt is the list of formats which are supported by the codec,
1563 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1564 * The first is always the native one.
1565 * @return the chosen format
1566 * - encoding: unused
1567 * - decoding: Set by user, if not set the native format will be chosen.
1569 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1572 * maximum number of B-frames between non-B-frames
1573 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1574 * - encoding: Set by user.
1575 * - decoding: unused
1580 * qscale factor between IP and B-frames
1581 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1582 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1583 * - encoding: Set by user.
1584 * - decoding: unused
1586 float b_quant_factor;
1588 /** obsolete FIXME remove */
1590 #define FF_RC_STRATEGY_XVID 1
1592 int b_frame_strategy;
1594 #if FF_API_MPV_GLOBAL_OPTS
1596 * luma single coefficient elimination threshold
1597 * - encoding: Set by user.
1598 * - decoding: unused
1600 attribute_deprecated int luma_elim_threshold;
1603 * chroma single coeff elimination threshold
1604 * - encoding: Set by user.
1605 * - decoding: unused
1607 attribute_deprecated int chroma_elim_threshold;
1611 * qscale offset between IP and B-frames
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 float b_quant_offset;
1618 * Size of the frame reordering buffer in the decoder.
1619 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1620 * - encoding: Set by libavcodec.
1621 * - decoding: Set by libavcodec.
1626 * 0-> h263 quant 1-> mpeg quant
1627 * - encoding: Set by user.
1628 * - decoding: unused
1633 * qscale factor between P and I-frames
1634 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1635 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1636 * - encoding: Set by user.
1637 * - decoding: unused
1639 float i_quant_factor;
1642 * qscale offset between P and I-frames
1643 * - encoding: Set by user.
1644 * - decoding: unused
1646 float i_quant_offset;
1649 * luminance masking (0-> disabled)
1650 * - encoding: Set by user.
1651 * - decoding: unused
1656 * temporary complexity masking (0-> disabled)
1657 * - encoding: Set by user.
1658 * - decoding: unused
1660 float temporal_cplx_masking;
1663 * spatial complexity masking (0-> disabled)
1664 * - encoding: Set by user.
1665 * - decoding: unused
1667 float spatial_cplx_masking;
1670 * p block masking (0-> disabled)
1671 * - encoding: Set by user.
1672 * - decoding: unused
1677 * darkness masking (0-> disabled)
1678 * - encoding: Set by user.
1679 * - decoding: unused
1685 * - encoding: Set by libavcodec.
1686 * - decoding: Set by user (or 0).
1690 * prediction method (needed for huffyuv)
1691 * - encoding: Set by user.
1692 * - decoding: unused
1694 int prediction_method;
1695 #define FF_PRED_LEFT 0
1696 #define FF_PRED_PLANE 1
1697 #define FF_PRED_MEDIAN 2
1700 * slice offsets in the frame in bytes
1701 * - encoding: Set/allocated by libavcodec.
1702 * - decoding: Set/allocated by user (or NULL).
1707 * sample aspect ratio (0 if unknown)
1708 * That is the width of a pixel divided by the height of the pixel.
1709 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1710 * - encoding: Set by user.
1711 * - decoding: Set by libavcodec.
1713 AVRational sample_aspect_ratio;
1716 * motion estimation comparison function
1717 * - encoding: Set by user.
1718 * - decoding: unused
1722 * subpixel motion estimation comparison function
1723 * - encoding: Set by user.
1724 * - decoding: unused
1728 * macroblock comparison function (not supported yet)
1729 * - encoding: Set by user.
1730 * - decoding: unused
1734 * interlaced DCT comparison function
1735 * - encoding: Set by user.
1736 * - decoding: unused
1739 #define FF_CMP_SAD 0
1740 #define FF_CMP_SSE 1
1741 #define FF_CMP_SATD 2
1742 #define FF_CMP_DCT 3
1743 #define FF_CMP_PSNR 4
1744 #define FF_CMP_BIT 5
1746 #define FF_CMP_ZERO 7
1747 #define FF_CMP_VSAD 8
1748 #define FF_CMP_VSSE 9
1749 #define FF_CMP_NSSE 10
1750 #define FF_CMP_W53 11
1751 #define FF_CMP_W97 12
1752 #define FF_CMP_DCTMAX 13
1753 #define FF_CMP_DCT264 14
1754 #define FF_CMP_CHROMA 256
1757 * ME diamond size & shape
1758 * - encoding: Set by user.
1759 * - decoding: unused
1764 * amount of previous MV predictors (2a+1 x 2a+1 square)
1765 * - encoding: Set by user.
1766 * - decoding: unused
1768 int last_predictor_count;
1771 * prepass for motion estimation
1772 * - encoding: Set by user.
1773 * - decoding: unused
1778 * motion estimation prepass comparison function
1779 * - encoding: Set by user.
1780 * - decoding: unused
1785 * ME prepass diamond size & shape
1786 * - encoding: Set by user.
1787 * - decoding: unused
1793 * - encoding: Set by user.
1794 * - decoding: unused
1796 int me_subpel_quality;
1799 * DTG active format information (additional aspect ratio
1800 * information only used in DVB MPEG-2 transport streams)
1803 * - encoding: unused
1804 * - decoding: Set by decoder.
1806 int dtg_active_format;
1807 #define FF_DTG_AFD_SAME 8
1808 #define FF_DTG_AFD_4_3 9
1809 #define FF_DTG_AFD_16_9 10
1810 #define FF_DTG_AFD_14_9 11
1811 #define FF_DTG_AFD_4_3_SP_14_9 13
1812 #define FF_DTG_AFD_16_9_SP_14_9 14
1813 #define FF_DTG_AFD_SP_4_3 15
1816 * maximum motion estimation search range in subpel units
1817 * If 0 then no limit.
1819 * - encoding: Set by user.
1820 * - decoding: unused
1825 * intra quantizer bias
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 int intra_quant_bias;
1830 #define FF_DEFAULT_QUANT_BIAS 999999
1833 * inter quantizer bias
1834 * - encoding: Set by user.
1835 * - decoding: unused
1837 int inter_quant_bias;
1839 #if FF_API_COLOR_TABLE_ID
1842 * - encoding: unused
1843 * - decoding: Which clrtable should be used for 8bit RGB images.
1844 * Tables have to be stored somewhere. FIXME
1846 attribute_deprecated int color_table_id;
1851 * - encoding: unused
1852 * - decoding: Set by user.
1855 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1856 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1857 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1860 * XVideo Motion Acceleration
1861 * - encoding: forbidden
1862 * - decoding: set by decoder
1864 int xvmc_acceleration;
1867 * macroblock decision mode
1868 * - encoding: Set by user.
1869 * - decoding: unused
1872 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1873 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1874 #define FF_MB_DECISION_RD 2 ///< rate distortion
1877 * custom intra quantization matrix
1878 * - encoding: Set by user, can be NULL.
1879 * - decoding: Set by libavcodec.
1881 uint16_t *intra_matrix;
1884 * custom inter quantization matrix
1885 * - encoding: Set by user, can be NULL.
1886 * - decoding: Set by libavcodec.
1888 uint16_t *inter_matrix;
1891 * scene change detection threshold
1892 * 0 is default, larger means fewer detected scene changes.
1893 * - encoding: Set by user.
1894 * - decoding: unused
1896 int scenechange_threshold;
1899 * noise reduction strength
1900 * - encoding: Set by user.
1901 * - decoding: unused
1903 int noise_reduction;
1905 #if FF_API_INTER_THRESHOLD
1907 * @deprecated this field is unused
1909 attribute_deprecated int inter_threshold;
1912 #if FF_API_MPV_GLOBAL_OPTS
1914 * @deprecated use mpegvideo private options instead
1916 attribute_deprecated int quantizer_noise_shaping;
1920 * Motion estimation threshold below which no motion estimation is
1921 * performed, but instead the user specified motion vectors are used.
1923 * - encoding: Set by user.
1924 * - decoding: unused
1929 * Macroblock threshold below which the user specified macroblock types will be used.
1930 * - encoding: Set by user.
1931 * - decoding: unused
1936 * precision of the intra DC coefficient - 8
1937 * - encoding: Set by user.
1938 * - decoding: unused
1940 int intra_dc_precision;
1943 * Number of macroblock rows at the top which are skipped.
1944 * - encoding: unused
1945 * - decoding: Set by user.
1950 * Number of macroblock rows at the bottom which are skipped.
1951 * - encoding: unused
1952 * - decoding: Set by user.
1957 * Border processing masking, raises the quantizer for mbs on the borders
1959 * - encoding: Set by user.
1960 * - decoding: unused
1962 float border_masking;
1965 * minimum MB lagrange multipler
1966 * - encoding: Set by user.
1967 * - decoding: unused
1972 * maximum MB lagrange multipler
1973 * - encoding: Set by user.
1974 * - decoding: unused
1980 * - encoding: Set by user.
1981 * - decoding: unused
1983 int me_penalty_compensation;
1987 * - encoding: Set by user.
1988 * - decoding: unused
1994 * - encoding: Set by user.
1995 * - decoding: unused
2001 * - encoding: Set by user.
2002 * - decoding: unused
2007 * number of reference frames
2008 * - encoding: Set by user.
2009 * - decoding: Set by lavc.
2014 * chroma qp offset from luma
2015 * - encoding: Set by user.
2016 * - decoding: unused
2021 * Multiplied by qscale for each frame and added to scene_change_score.
2022 * - encoding: Set by user.
2023 * - decoding: unused
2025 int scenechange_factor;
2029 * Note: Value depends upon the compare function used for fullpel ME.
2030 * - encoding: Set by user.
2031 * - decoding: unused
2036 * Adjust sensitivity of b_frame_strategy 1.
2037 * - encoding: Set by user.
2038 * - decoding: unused
2043 * Chromaticity coordinates of the source primaries.
2044 * - encoding: Set by user
2045 * - decoding: Set by libavcodec
2047 enum AVColorPrimaries color_primaries;
2050 * Color Transfer Characteristic.
2051 * - encoding: Set by user
2052 * - decoding: Set by libavcodec
2054 enum AVColorTransferCharacteristic color_trc;
2057 * YUV colorspace type.
2058 * - encoding: Set by user
2059 * - decoding: Set by libavcodec
2061 enum AVColorSpace colorspace;
2064 * MPEG vs JPEG YUV range.
2065 * - encoding: Set by user
2066 * - decoding: Set by libavcodec
2068 enum AVColorRange color_range;
2071 * This defines the location of chroma samples.
2072 * - encoding: Set by user
2073 * - decoding: Set by libavcodec
2075 enum AVChromaLocation chroma_sample_location;
2079 * Indicates number of picture subdivisions. Used for parallelized
2081 * - encoding: Set by user
2082 * - decoding: unused
2087 * - encoding: set by libavcodec
2088 * - decoding: Set by libavcodec
2090 enum AVFieldOrder field_order;
2093 int sample_rate; ///< samples per second
2094 int channels; ///< number of audio channels
2097 * audio sample format
2098 * - encoding: Set by user.
2099 * - decoding: Set by libavcodec.
2101 enum AVSampleFormat sample_fmt; ///< sample format
2103 /* The following data should not be initialized. */
2105 * Samples per packet, initialized when calling 'init'.
2110 * Frame counter, set by libavcodec.
2112 * - decoding: total number of frames returned from the decoder so far.
2113 * - encoding: total number of frames passed to the encoder so far.
2115 * @note the counter is not incremented if encoding/decoding resulted in
2121 * number of bytes per packet if constant and known or 0
2122 * Used by some WAV based audio codecs.
2127 * Audio cutoff bandwidth (0 means "automatic")
2128 * - encoding: Set by user.
2129 * - decoding: unused
2133 #if FF_API_REQUEST_CHANNELS
2135 * Decoder should decode to this many channels if it can (0 for default)
2136 * - encoding: unused
2137 * - decoding: Set by user.
2138 * @deprecated Deprecated in favor of request_channel_layout.
2140 int request_channels;
2144 * Audio channel layout.
2145 * - encoding: set by user.
2146 * - decoding: set by user, may be overwritten by libavcodec.
2148 uint64_t channel_layout;
2151 * Request decoder to use this channel layout if it can (0 for default)
2152 * - encoding: unused
2153 * - decoding: Set by user.
2155 uint64_t request_channel_layout;
2158 * Type of service that the audio stream conveys.
2159 * - encoding: Set by user.
2160 * - decoding: Set by libavcodec.
2162 enum AVAudioServiceType audio_service_type;
2165 * desired sample format
2166 * - encoding: Not used.
2167 * - decoding: Set by user.
2168 * Decoder will decode to this format if it can.
2170 enum AVSampleFormat request_sample_fmt;
2173 * Called at the beginning of each frame to get a buffer for it.
2175 * The function will set AVFrame.data[], AVFrame.linesize[].
2176 * AVFrame.extended_data[] must also be set, but it should be the same as
2177 * AVFrame.data[] except for planar audio with more channels than can fit
2178 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2179 * many data pointers as it can hold.
2181 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2182 * avcodec_default_get_buffer() instead of providing buffers allocated by
2185 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2186 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2187 * but if get_buffer() is overridden then alignment considerations should
2188 * be taken into account.
2190 * @see avcodec_default_get_buffer()
2194 * If pic.reference is set then the frame will be read later by libavcodec.
2195 * avcodec_align_dimensions2() should be used to find the required width and
2196 * height, as they normally need to be rounded up to the next multiple of 16.
2198 * If frame multithreading is used and thread_safe_callbacks is set,
2199 * it may be called from a different thread, but not from more than one at
2200 * once. Does not need to be reentrant.
2202 * @see release_buffer(), reget_buffer()
2203 * @see avcodec_align_dimensions2()
2207 * Decoders request a buffer of a particular size by setting
2208 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2209 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2210 * to a smaller value in the output frame.
2212 * Decoders cannot use the buffer after returning from
2213 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2214 * is assumed to be released immediately upon return.
2216 * As a convenience, av_samples_get_buffer_size() and
2217 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2218 * functions to find the required data size and to fill data pointers and
2219 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2220 * since all planes must be the same size.
2222 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2224 * - encoding: unused
2225 * - decoding: Set by libavcodec, user can override.
2227 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2230 * Called to release buffers which were allocated with get_buffer.
2231 * A released buffer can be reused in get_buffer().
2232 * pic.data[*] must be set to NULL.
2233 * May be called from a different thread if frame multithreading is used,
2234 * but not by more than one thread at once, so does not need to be reentrant.
2235 * - encoding: unused
2236 * - decoding: Set by libavcodec, user can override.
2238 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2241 * Called at the beginning of a frame to get cr buffer for it.
2242 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2243 * libavcodec will pass previous buffer in pic, function should return
2244 * same buffer or new buffer with old frame "painted" into it.
2245 * If pic.data[0] == NULL must behave like get_buffer().
2246 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2247 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2249 * - encoding: unused
2250 * - decoding: Set by libavcodec, user can override.
2252 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2255 /* - encoding parameters */
2256 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2257 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2261 * - encoding: Set by user.
2262 * - decoding: unused
2268 * - encoding: Set by user.
2269 * - decoding: unused
2274 * maximum quantizer difference between frames
2275 * - encoding: Set by user.
2276 * - decoding: unused
2281 * ratecontrol qmin qmax limiting method
2282 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2283 * - encoding: Set by user.
2284 * - decoding: unused
2292 * decoder bitstream buffer size
2293 * - encoding: Set by user.
2294 * - decoding: unused
2299 * ratecontrol override, see RcOverride
2300 * - encoding: Allocated/set/freed by user.
2301 * - decoding: unused
2303 int rc_override_count;
2304 RcOverride *rc_override;
2307 * rate control equation
2308 * - encoding: Set by user
2309 * - decoding: unused
2315 * - encoding: Set by user.
2316 * - decoding: unused
2322 * - encoding: Set by user.
2323 * - decoding: unused
2327 float rc_buffer_aggressivity;
2330 * initial complexity for pass1 ratecontrol
2331 * - encoding: Set by user.
2332 * - decoding: unused
2334 float rc_initial_cplx;
2337 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2338 * - encoding: Set by user.
2339 * - decoding: unused.
2341 float rc_max_available_vbv_use;
2344 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2345 * - encoding: Set by user.
2346 * - decoding: unused.
2348 float rc_min_vbv_overflow_use;
2351 * Number of bits which should be loaded into the rc buffer before decoding starts.
2352 * - encoding: Set by user.
2353 * - decoding: unused
2355 int rc_initial_buffer_occupancy;
2357 #define FF_CODER_TYPE_VLC 0
2358 #define FF_CODER_TYPE_AC 1
2359 #define FF_CODER_TYPE_RAW 2
2360 #define FF_CODER_TYPE_RLE 3
2361 #define FF_CODER_TYPE_DEFLATE 4
2364 * - encoding: Set by user.
2365 * - decoding: unused
2371 * - encoding: Set by user.
2372 * - decoding: unused
2377 * minimum Lagrange multipler
2378 * - encoding: Set by user.
2379 * - decoding: unused
2384 * maximum Lagrange multipler
2385 * - encoding: Set by user.
2386 * - decoding: unused
2391 * frame skip threshold
2392 * - encoding: Set by user.
2393 * - decoding: unused
2395 int frame_skip_threshold;
2399 * - encoding: Set by user.
2400 * - decoding: unused
2402 int frame_skip_factor;
2405 * frame skip exponent
2406 * - encoding: Set by user.
2407 * - decoding: unused
2412 * frame skip comparison function
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * trellis RD quantization
2420 * - encoding: Set by user.
2421 * - decoding: unused
2426 * - encoding: Set by user.
2427 * - decoding: unused
2429 int min_prediction_order;
2432 * - encoding: Set by user.
2433 * - decoding: unused
2435 int max_prediction_order;
2438 * GOP timecode frame start number
2439 * - encoding: Set by user, in non drop frame format
2440 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2442 int64_t timecode_frame_start;
2444 /* The RTP callback: This function is called */
2445 /* every time the encoder has a packet to send. */
2446 /* It depends on the encoder if the data starts */
2447 /* with a Start Code (it should). H.263 does. */
2448 /* mb_nb contains the number of macroblocks */
2449 /* encoded in the RTP payload. */
2450 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2452 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2453 /* do its best to deliver a chunk with size */
2454 /* below rtp_payload_size, the chunk will start */
2455 /* with a start code on some codecs like H.263. */
2456 /* This doesn't take account of any particular */
2457 /* headers inside the transmitted RTP payload. */
2459 /* statistics, used for 2-pass encoding */
2470 * number of bits used for the previously encoded frame
2471 * - encoding: Set by libavcodec.
2472 * - decoding: unused
2477 * pass1 encoding statistics output buffer
2478 * - encoding: Set by libavcodec.
2479 * - decoding: unused
2484 * pass2 encoding statistics input buffer
2485 * Concatenated stuff from stats_out of pass1 should be placed here.
2486 * - encoding: Allocated/set/freed by user.
2487 * - decoding: unused
2492 * Work around bugs in encoders which sometimes cannot be detected automatically.
2493 * - encoding: Set by user
2494 * - decoding: Set by user
2496 int workaround_bugs;
2497 #define FF_BUG_AUTODETECT 1 ///< autodetection
2498 #define FF_BUG_OLD_MSMPEG4 2
2499 #define FF_BUG_XVID_ILACE 4
2500 #define FF_BUG_UMP4 8
2501 #define FF_BUG_NO_PADDING 16
2502 #define FF_BUG_AMV 32
2503 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2504 #define FF_BUG_QPEL_CHROMA 64
2505 #define FF_BUG_STD_QPEL 128
2506 #define FF_BUG_QPEL_CHROMA2 256
2507 #define FF_BUG_DIRECT_BLOCKSIZE 512
2508 #define FF_BUG_EDGE 1024
2509 #define FF_BUG_HPEL_CHROMA 2048
2510 #define FF_BUG_DC_CLIP 4096
2511 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2512 #define FF_BUG_TRUNCATED 16384
2515 * strictly follow the standard (MPEG4, ...).
2516 * - encoding: Set by user.
2517 * - decoding: Set by user.
2518 * Setting this to STRICT or higher means the encoder and decoder will
2519 * generally do stupid things, whereas setting it to unofficial or lower
2520 * will mean the encoder might produce output that is not supported by all
2521 * spec-compliant decoders. Decoders don't differentiate between normal,
2522 * unofficial and experimental (that is, they always try to decode things
2523 * when they can) unless they are explicitly asked to behave stupidly
2524 * (=strictly conform to the specs)
2526 int strict_std_compliance;
2527 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2528 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2529 #define FF_COMPLIANCE_NORMAL 0
2530 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2531 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2534 * error concealment flags
2535 * - encoding: unused
2536 * - decoding: Set by user.
2538 int error_concealment;
2539 #define FF_EC_GUESS_MVS 1
2540 #define FF_EC_DEBLOCK 2
2544 * - encoding: Set by user.
2545 * - decoding: Set by user.
2548 #define FF_DEBUG_PICT_INFO 1
2549 #define FF_DEBUG_RC 2
2550 #define FF_DEBUG_BITSTREAM 4
2551 #define FF_DEBUG_MB_TYPE 8
2552 #define FF_DEBUG_QP 16
2553 #define FF_DEBUG_MV 32
2554 #define FF_DEBUG_DCT_COEFF 0x00000040
2555 #define FF_DEBUG_SKIP 0x00000080
2556 #define FF_DEBUG_STARTCODE 0x00000100
2557 #define FF_DEBUG_PTS 0x00000200
2558 #define FF_DEBUG_ER 0x00000400
2559 #define FF_DEBUG_MMCO 0x00000800
2560 #define FF_DEBUG_BUGS 0x00001000
2561 #define FF_DEBUG_VIS_QP 0x00002000
2562 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2563 #define FF_DEBUG_BUFFERS 0x00008000
2564 #define FF_DEBUG_THREADS 0x00010000
2568 * - encoding: Set by user.
2569 * - decoding: Set by user.
2572 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2573 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2574 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2577 * Error recognition; may misdetect some more or less valid parts as errors.
2578 * - encoding: unused
2579 * - decoding: Set by user.
2581 int err_recognition;
2582 #define AV_EF_CRCCHECK (1<<0)
2583 #define AV_EF_BITSTREAM (1<<1)
2584 #define AV_EF_BUFFER (1<<2)
2585 #define AV_EF_EXPLODE (1<<3)
2587 #define AV_EF_CAREFUL (1<<16)
2588 #define AV_EF_COMPLIANT (1<<17)
2589 #define AV_EF_AGGRESSIVE (1<<18)
2593 * opaque 64bit number (generally a PTS) that will be reordered and
2594 * output in AVFrame.reordered_opaque
2595 * @deprecated in favor of pkt_pts
2596 * - encoding: unused
2597 * - decoding: Set by user.
2599 int64_t reordered_opaque;
2602 * Hardware accelerator in use
2603 * - encoding: unused.
2604 * - decoding: Set by libavcodec
2606 struct AVHWAccel *hwaccel;
2609 * Hardware accelerator context.
2610 * For some hardware accelerators, a global context needs to be
2611 * provided by the user. In that case, this holds display-dependent
2612 * data FFmpeg cannot instantiate itself. Please refer to the
2613 * FFmpeg HW accelerator documentation to know how to fill this
2614 * is. e.g. for VA API, this is a struct vaapi_context.
2615 * - encoding: unused
2616 * - decoding: Set by user
2618 void *hwaccel_context;
2622 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2623 * - decoding: unused
2625 uint64_t error[AV_NUM_DATA_POINTERS];
2628 * DCT algorithm, see FF_DCT_* below
2629 * - encoding: Set by user.
2630 * - decoding: unused
2633 #define FF_DCT_AUTO 0
2634 #define FF_DCT_FASTINT 1
2635 #define FF_DCT_INT 2
2636 #define FF_DCT_MMX 3
2637 #define FF_DCT_ALTIVEC 5
2638 #define FF_DCT_FAAN 6
2641 * IDCT algorithm, see FF_IDCT_* below.
2642 * - encoding: Set by user.
2643 * - decoding: Set by user.
2646 #define FF_IDCT_AUTO 0
2647 #define FF_IDCT_INT 1
2648 #define FF_IDCT_SIMPLE 2
2649 #define FF_IDCT_SIMPLEMMX 3
2650 #define FF_IDCT_LIBMPEG2MMX 4
2651 #define FF_IDCT_MMI 5
2652 #define FF_IDCT_ARM 7
2653 #define FF_IDCT_ALTIVEC 8
2654 #define FF_IDCT_SH4 9
2655 #define FF_IDCT_SIMPLEARM 10
2656 #define FF_IDCT_H264 11
2657 #define FF_IDCT_VP3 12
2658 #define FF_IDCT_IPP 13
2659 #define FF_IDCT_XVIDMMX 14
2660 #define FF_IDCT_CAVS 15
2661 #define FF_IDCT_SIMPLEARMV5TE 16
2662 #define FF_IDCT_SIMPLEARMV6 17
2663 #define FF_IDCT_SIMPLEVIS 18
2664 #define FF_IDCT_WMV2 19
2665 #define FF_IDCT_FAAN 20
2666 #define FF_IDCT_EA 21
2667 #define FF_IDCT_SIMPLENEON 22
2668 #define FF_IDCT_SIMPLEALPHA 23
2669 #define FF_IDCT_BINK 24
2674 * @deprecated use av_set_cpu_flags_mask() instead.
2676 attribute_deprecated unsigned dsp_mask;
2680 * bits per sample/pixel from the demuxer (needed for huffyuv).
2681 * - encoding: Set by libavcodec.
2682 * - decoding: Set by user.
2684 int bits_per_coded_sample;
2687 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2688 * - encoding: set by user.
2689 * - decoding: set by libavcodec.
2691 int bits_per_raw_sample;
2694 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2695 * - encoding: unused
2696 * - decoding: Set by user.
2701 * the picture in the bitstream
2702 * - encoding: Set by libavcodec.
2703 * - decoding: Set by libavcodec.
2705 AVFrame *coded_frame;
2709 * is used to decide how many independent tasks should be passed to execute()
2710 * - encoding: Set by user.
2711 * - decoding: Set by user.
2716 * Which multithreading methods to use.
2717 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2718 * so clients which cannot provide future frames should not use it.
2720 * - encoding: Set by user, otherwise the default is used.
2721 * - decoding: Set by user, otherwise the default is used.
2724 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2725 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2728 * Which multithreading methods are in use by the codec.
2729 * - encoding: Set by libavcodec.
2730 * - decoding: Set by libavcodec.
2732 int active_thread_type;
2735 * Set by the client if its custom get_buffer() callback can be called
2736 * synchronously from another thread, which allows faster multithreaded decoding.
2737 * draw_horiz_band() will be called from other threads regardless of this setting.
2738 * Ignored if the default get_buffer() is used.
2739 * - encoding: Set by user.
2740 * - decoding: Set by user.
2742 int thread_safe_callbacks;
2745 * The codec may call this to execute several independent things.
2746 * It will return only after finishing all tasks.
2747 * The user may replace this with some multithreaded implementation,
2748 * the default implementation will execute the parts serially.
2749 * @param count the number of things to execute
2750 * - encoding: Set by libavcodec, user can override.
2751 * - decoding: Set by libavcodec, user can override.
2753 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2756 * The codec may call this to execute several independent things.
2757 * It will return only after finishing all tasks.
2758 * The user may replace this with some multithreaded implementation,
2759 * the default implementation will execute the parts serially.
2760 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2761 * @param c context passed also to func
2762 * @param count the number of things to execute
2763 * @param arg2 argument passed unchanged to func
2764 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2765 * @param func function that will be called count times, with jobnr from 0 to count-1.
2766 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2767 * two instances of func executing at the same time will have the same threadnr.
2768 * @return always 0 currently, but code should handle a future improvement where when any call to func
2769 * returns < 0 no further calls to func may be done and < 0 is returned.
2770 * - encoding: Set by libavcodec, user can override.
2771 * - decoding: Set by libavcodec, user can override.
2773 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2777 * Can be used by execute() to store some per AVCodecContext stuff.
2778 * - encoding: set by execute()
2779 * - decoding: set by execute()
2781 void *thread_opaque;
2784 * noise vs. sse weight for the nsse comparsion function
2785 * - encoding: Set by user.
2786 * - decoding: unused
2792 * - encoding: Set by user.
2793 * - decoding: Set by libavcodec.
2796 #define FF_PROFILE_UNKNOWN -99
2797 #define FF_PROFILE_RESERVED -100
2799 #define FF_PROFILE_AAC_MAIN 0
2800 #define FF_PROFILE_AAC_LOW 1
2801 #define FF_PROFILE_AAC_SSR 2
2802 #define FF_PROFILE_AAC_LTP 3
2804 #define FF_PROFILE_DTS 20
2805 #define FF_PROFILE_DTS_ES 30
2806 #define FF_PROFILE_DTS_96_24 40
2807 #define FF_PROFILE_DTS_HD_HRA 50
2808 #define FF_PROFILE_DTS_HD_MA 60
2810 #define FF_PROFILE_MPEG2_422 0
2811 #define FF_PROFILE_MPEG2_HIGH 1
2812 #define FF_PROFILE_MPEG2_SS 2
2813 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2814 #define FF_PROFILE_MPEG2_MAIN 4
2815 #define FF_PROFILE_MPEG2_SIMPLE 5
2817 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2818 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2820 #define FF_PROFILE_H264_BASELINE 66
2821 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2822 #define FF_PROFILE_H264_MAIN 77
2823 #define FF_PROFILE_H264_EXTENDED 88
2824 #define FF_PROFILE_H264_HIGH 100
2825 #define FF_PROFILE_H264_HIGH_10 110
2826 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2827 #define FF_PROFILE_H264_HIGH_422 122
2828 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2829 #define FF_PROFILE_H264_HIGH_444 144
2830 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2831 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2832 #define FF_PROFILE_H264_CAVLC_444 44
2834 #define FF_PROFILE_VC1_SIMPLE 0
2835 #define FF_PROFILE_VC1_MAIN 1
2836 #define FF_PROFILE_VC1_COMPLEX 2
2837 #define FF_PROFILE_VC1_ADVANCED 3
2839 #define FF_PROFILE_MPEG4_SIMPLE 0
2840 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2841 #define FF_PROFILE_MPEG4_CORE 2
2842 #define FF_PROFILE_MPEG4_MAIN 3
2843 #define FF_PROFILE_MPEG4_N_BIT 4
2844 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2845 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2846 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2847 #define FF_PROFILE_MPEG4_HYBRID 8
2848 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2849 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2850 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2851 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2852 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2853 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2854 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2858 * - encoding: Set by user.
2859 * - decoding: Set by libavcodec.
2862 #define FF_LEVEL_UNKNOWN -99
2866 * - encoding: unused
2867 * - decoding: Set by user.
2869 enum AVDiscard skip_loop_filter;
2873 * - encoding: unused
2874 * - decoding: Set by user.
2876 enum AVDiscard skip_idct;
2880 * - encoding: unused
2881 * - decoding: Set by user.
2883 enum AVDiscard skip_frame;
2886 * Header containing style information for text subtitles.
2887 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2888 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2889 * the Format line following. It shouldn't include any Dialogue line.
2890 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2891 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2893 uint8_t *subtitle_header;
2894 int subtitle_header_size;
2897 * Simulates errors in the bitstream to test error concealment.
2898 * - encoding: Set by user.
2899 * - decoding: unused
2904 * Current packet as passed into the decoder, to avoid having
2905 * to pass the packet into every function. Currently only valid
2906 * inside lavc and get/release_buffer callbacks.
2907 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2908 * - encoding: unused
2913 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2914 * Used for compliant TS muxing.
2915 * - encoding: Set by libavcodec.
2916 * - decoding: unused.
2921 * Current statistics for PTS correction.
2922 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2923 * - encoding: unused
2925 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2926 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2927 int64_t pts_correction_last_pts; /// PTS of the last frame
2928 int64_t pts_correction_last_dts; /// DTS of the last frame
2934 typedef struct AVProfile {
2936 const char *name; ///< short name for the profile
2939 typedef struct AVCodecDefault AVCodecDefault;
2944 typedef struct AVCodec {
2946 * Name of the codec implementation.
2947 * The name is globally unique among encoders and among decoders (but an
2948 * encoder and a decoder can share the same name).
2949 * This is the primary way to find a codec from the user perspective.
2953 * Descriptive name for the codec, meant to be more human readable than name.
2954 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2956 const char *long_name;
2957 enum AVMediaType type;
2960 * Codec capabilities.
2964 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2965 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2966 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2967 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2968 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2969 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2970 const AVClass *priv_class; ///< AVClass for the private context
2971 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2973 /*****************************************************************
2974 * No fields below this line are part of the public API. They
2975 * may not be used outside of libavcodec and can be changed and
2977 * New public fields should be added right above.
2978 *****************************************************************
2981 struct AVCodec *next;
2983 * @name Frame-level threading support functions
2987 * If defined, called on thread contexts when they are created.
2988 * If the codec allocates writable tables in init(), re-allocate them here.
2989 * priv_data will be set to a copy of the original.
2991 int (*init_thread_copy)(AVCodecContext *);
2993 * Copy necessary context variables from a previous thread context to the current one.
2994 * If not defined, the next thread will start automatically; otherwise, the codec
2995 * must call ff_thread_finish_setup().
2997 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2999 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3003 * Private codec-specific defaults.
3005 const AVCodecDefault *defaults;
3008 * Initialize codec static data, called from avcodec_register().
3010 void (*init_static_data)(struct AVCodec *codec);
3012 int (*init)(AVCodecContext *);
3013 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3015 * Encode data to an AVPacket.
3017 * @param avctx codec context
3018 * @param avpkt output AVPacket (may contain a user-provided buffer)
3019 * @param[in] frame AVFrame containing the raw data to be encoded
3020 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3021 * non-empty packet was returned in avpkt.
3022 * @return 0 on success, negative error code on failure
3024 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3025 int *got_packet_ptr);
3026 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3027 int (*close)(AVCodecContext *);
3030 * Will be called when seeking
3032 void (*flush)(AVCodecContext *);
3038 typedef struct AVHWAccel {
3040 * Name of the hardware accelerated codec.
3041 * The name is globally unique among encoders and among decoders (but an
3042 * encoder and a decoder can share the same name).
3047 * Type of codec implemented by the hardware accelerator.
3049 * See AVMEDIA_TYPE_xxx
3051 enum AVMediaType type;
3054 * Codec implemented by the hardware accelerator.
3061 * Supported pixel format.
3063 * Only hardware accelerated formats are supported here.
3065 enum PixelFormat pix_fmt;
3068 * Hardware accelerated codec capabilities.
3069 * see FF_HWACCEL_CODEC_CAP_*
3073 struct AVHWAccel *next;
3076 * Called at the beginning of each frame or field picture.
3078 * Meaningful frame information (codec specific) is guaranteed to
3079 * be parsed at this point. This function is mandatory.
3081 * Note that buf can be NULL along with buf_size set to 0.
3082 * Otherwise, this means the whole frame is available at this point.
3084 * @param avctx the codec context
3085 * @param buf the frame data buffer base
3086 * @param buf_size the size of the frame in bytes
3087 * @return zero if successful, a negative value otherwise
3089 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3092 * Callback for each slice.
3094 * Meaningful slice information (codec specific) is guaranteed to
3095 * be parsed at this point. This function is mandatory.
3097 * @param avctx the codec context
3098 * @param buf the slice data buffer base
3099 * @param buf_size the size of the slice in bytes
3100 * @return zero if successful, a negative value otherwise
3102 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3105 * Called at the end of each frame or field picture.
3107 * The whole picture is parsed at this point and can now be sent
3108 * to the hardware accelerator. This function is mandatory.
3110 * @param avctx the codec context
3111 * @return zero if successful, a negative value otherwise
3113 int (*end_frame)(AVCodecContext *avctx);
3116 * Size of HW accelerator private data.
3118 * Private data is allocated with av_mallocz() before
3119 * AVCodecContext.get_buffer() and deallocated after
3120 * AVCodecContext.release_buffer().
3126 * @defgroup lavc_picture AVPicture
3128 * Functions for working with AVPicture
3133 * four components are given, that's all.
3134 * the last component is alpha
3136 typedef struct AVPicture {
3137 uint8_t *data[AV_NUM_DATA_POINTERS];
3138 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3145 enum AVSubtitleType {
3148 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3151 * Plain text, the text field must be set by the decoder and is
3152 * authoritative. ass and pict fields may contain approximations.
3157 * Formatted text, the ass field must be set by the decoder and is
3158 * authoritative. pict and text fields may contain approximations.
3163 typedef struct AVSubtitleRect {
3164 int x; ///< top left corner of pict, undefined when pict is not set
3165 int y; ///< top left corner of pict, undefined when pict is not set
3166 int w; ///< width of pict, undefined when pict is not set
3167 int h; ///< height of pict, undefined when pict is not set
3168 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3171 * data+linesize for the bitmap of this subtitle.
3172 * can be set for text/ass as well once they where rendered
3175 enum AVSubtitleType type;
3177 char *text; ///< 0 terminated plain UTF-8 text
3180 * 0 terminated ASS/SSA compatible event line.
3181 * The pressentation of this is unaffected by the other values in this
3187 * 1 indicates this subtitle is a forced subtitle.
3188 * A forced subtitle should be displayed even when subtitles are hidden.
3193 typedef struct AVSubtitle {
3194 uint16_t format; /* 0 = graphics */
3195 uint32_t start_display_time; /* relative to packet pts, in ms */
3196 uint32_t end_display_time; /* relative to packet pts, in ms */
3198 AVSubtitleRect **rects;
3199 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3203 * If c is NULL, returns the first registered codec,
3204 * if c is non-NULL, returns the next registered codec after c,
3205 * or NULL if c is the last one.
3207 AVCodec *av_codec_next(AVCodec *c);
3210 * Return the LIBAVCODEC_VERSION_INT constant.
3212 unsigned avcodec_version(void);
3215 * Return the libavcodec build-time configuration.
3217 const char *avcodec_configuration(void);
3220 * Return the libavcodec license.
3222 const char *avcodec_license(void);
3225 * Register the codec codec and initialize libavcodec.
3227 * @warning either this function or avcodec_register_all() must be called
3228 * before any other libavcodec functions.
3230 * @see avcodec_register_all()
3232 void avcodec_register(AVCodec *codec);
3235 * Register all the codecs, parsers and bitstream filters which were enabled at
3236 * configuration time. If you do not call this function you can select exactly
3237 * which formats you want to support, by using the individual registration
3240 * @see avcodec_register
3241 * @see av_register_codec_parser
3242 * @see av_register_bitstream_filter
3244 void avcodec_register_all(void);
3247 #if FF_API_ALLOC_CONTEXT
3249 * Allocate an AVCodecContext and set its fields to default values. The
3250 * resulting struct can be deallocated by simply calling av_free().
3252 * @return An AVCodecContext filled with default values or NULL on failure.
3253 * @see avcodec_get_context_defaults
3255 * @deprecated use avcodec_alloc_context3()
3257 attribute_deprecated
3258 AVCodecContext *avcodec_alloc_context(void);
3260 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3261 * we WILL change its arguments and name a few times! */
3262 attribute_deprecated
3263 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3266 * Set the fields of the given AVCodecContext to default values.
3268 * @param s The AVCodecContext of which the fields should be set to default values.
3269 * @deprecated use avcodec_get_context_defaults3
3271 attribute_deprecated
3272 void avcodec_get_context_defaults(AVCodecContext *s);
3274 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3275 * we WILL change its arguments and name a few times! */
3276 attribute_deprecated
3277 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3281 * Allocate an AVCodecContext and set its fields to default values. The
3282 * resulting struct can be deallocated by calling avcodec_close() on it followed
3285 * @param codec if non-NULL, allocate private data and initialize defaults
3286 * for the given codec. It is illegal to then call avcodec_open2()
3287 * with a different codec.
3288 * If NULL, then the codec-specific defaults won't be initialized,
3289 * which may result in suboptimal default settings (this is
3290 * important mainly for encoders, e.g. libx264).
3292 * @return An AVCodecContext filled with default values or NULL on failure.
3293 * @see avcodec_get_context_defaults
3295 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3298 * Set the fields of the given AVCodecContext to default values corresponding
3299 * to the given codec (defaults may be codec-dependent).
3301 * Do not call this function if a non-NULL codec has been passed
3302 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3303 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3304 * different codec on this AVCodecContext.
3306 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3309 * Get the AVClass for AVCodecContext. It can be used in combination with
3310 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3312 * @see av_opt_find().
3314 const AVClass *avcodec_get_class(void);
3317 * Get the AVClass for AVFrame. It can be used in combination with
3318 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3320 * @see av_opt_find().
3322 const AVClass *avcodec_get_frame_class(void);
3325 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3326 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3328 * @see av_opt_find().
3330 const AVClass *avcodec_get_subtitle_rect_class(void);
3333 * Copy the settings of the source AVCodecContext into the destination
3334 * AVCodecContext. The resulting destination codec context will be
3335 * unopened, i.e. you are required to call avcodec_open2() before you
3336 * can use this AVCodecContext to decode/encode video/audio data.
3338 * @param dest target codec context, should be initialized with
3339 * avcodec_alloc_context3(), but otherwise uninitialized
3340 * @param src source codec context
3341 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3343 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3346 * Allocate an AVFrame and set its fields to default values. The resulting
3347 * struct can be deallocated by simply calling av_free().
3349 * @return An AVFrame filled with default values or NULL on failure.
3350 * @see avcodec_get_frame_defaults
3352 AVFrame *avcodec_alloc_frame(void);
3355 * Set the fields of the given AVFrame to default values.
3357 * @param pic The AVFrame of which the fields should be set to default values.
3359 void avcodec_get_frame_defaults(AVFrame *pic);
3361 #if FF_API_AVCODEC_OPEN
3363 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3364 * function the context has to be allocated.
3366 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3367 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3368 * retrieving a codec.
3370 * @warning This function is not thread safe!
3373 * avcodec_register_all();
3374 * codec = avcodec_find_decoder(CODEC_ID_H264);
3378 * context = avcodec_alloc_context3(codec);
3380 * if (avcodec_open(context, codec) < 0)
3384 * @param avctx The context which will be set up to use the given codec.
3385 * @param codec The codec to use within the context.
3386 * @return zero on success, a negative value on error
3387 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3389 * @deprecated use avcodec_open2
3391 attribute_deprecated
3392 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3396 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3397 * function the context has to be allocated with avcodec_alloc_context3().
3399 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3400 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3401 * retrieving a codec.
3403 * @warning This function is not thread safe!
3406 * avcodec_register_all();
3407 * av_dict_set(&opts, "b", "2.5M", 0);
3408 * codec = avcodec_find_decoder(CODEC_ID_H264);
3412 * context = avcodec_alloc_context3(codec);
3414 * if (avcodec_open2(context, codec, opts) < 0)
3418 * @param avctx The context to initialize.
3419 * @param codec The codec to open this context for. If a non-NULL codec has been
3420 * previously passed to avcodec_alloc_context3() or
3421 * avcodec_get_context_defaults3() for this context, then this
3422 * parameter MUST be either NULL or equal to the previously passed
3424 * @param options A dictionary filled with AVCodecContext and codec-private options.
3425 * On return this object will be filled with options that were not found.
3427 * @return zero on success, a negative value on error
3428 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3429 * av_dict_set(), av_opt_find().
3431 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3434 * Close a given AVCodecContext and free all the data associated with it
3435 * (but not the AVCodecContext itself).
3437 * Calling this function on an AVCodecContext that hasn't been opened will free
3438 * the codec-specific data allocated in avcodec_alloc_context3() /
3439 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3442 int avcodec_close(AVCodecContext *avctx);
3445 * Free all allocated data in the given subtitle struct.
3447 * @param sub AVSubtitle to free.
3449 void avsubtitle_free(AVSubtitle *sub);
3456 * @addtogroup lavc_packet
3461 * @deprecated use NULL instead
3463 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3466 * Default packet destructor.
3468 void av_destruct_packet(AVPacket *pkt);
3471 * Initialize optional fields of a packet with default values.
3475 void av_init_packet(AVPacket *pkt);
3478 * Allocate the payload of a packet and initialize its fields with
3482 * @param size wanted payload size
3483 * @return 0 if OK, AVERROR_xxx otherwise
3485 int av_new_packet(AVPacket *pkt, int size);
3488 * Reduce packet size, correctly zeroing padding
3491 * @param size new size
3493 void av_shrink_packet(AVPacket *pkt, int size);
3496 * Increase packet size, correctly zeroing padding
3499 * @param grow_by number of bytes by which to increase the size of the packet
3501 int av_grow_packet(AVPacket *pkt, int grow_by);
3504 * @warning This is a hack - the packet memory allocation stuff is broken. The
3505 * packet is allocated if it was not really allocated.
3507 int av_dup_packet(AVPacket *pkt);
3512 * @param pkt packet to free
3514 void av_free_packet(AVPacket *pkt);
3517 * Allocate new information of a packet.
3520 * @param type side information type
3521 * @param size side information size
3522 * @return pointer to fresh allocated data or NULL otherwise
3524 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3528 * Shrink the already allocated side data buffer
3531 * @param type side information type
3532 * @param size new side information size
3533 * @return 0 on success, < 0 on failure
3535 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3539 * Get side information from packet.
3542 * @param type desired side information type
3543 * @param size pointer for side information size to store (optional)
3544 * @return pointer to data if present or NULL otherwise
3546 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3549 int av_packet_merge_side_data(AVPacket *pkt);
3551 int av_packet_split_side_data(AVPacket *pkt);
3559 * @addtogroup lavc_decoding
3564 * Find a registered decoder with a matching codec ID.
3566 * @param id CodecID of the requested decoder
3567 * @return A decoder if one was found, NULL otherwise.
3569 AVCodec *avcodec_find_decoder(enum CodecID id);
3572 * Find a registered decoder with the specified name.
3574 * @param name name of the requested decoder
3575 * @return A decoder if one was found, NULL otherwise.
3577 AVCodec *avcodec_find_decoder_by_name(const char *name);
3579 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3580 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3581 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3584 * Return the amount of padding in pixels which the get_buffer callback must
3585 * provide around the edge of the image for codecs which do not have the
3586 * CODEC_FLAG_EMU_EDGE flag.
3588 * @return Required padding in pixels.
3590 unsigned avcodec_get_edge_width(void);
3593 * Modify width and height values so that they will result in a memory
3594 * buffer that is acceptable for the codec if you do not use any horizontal
3597 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3598 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3599 * according to avcodec_get_edge_width() before.
3601 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3604 * Modify width and height values so that they will result in a memory
3605 * buffer that is acceptable for the codec if you also ensure that all
3606 * line sizes are a multiple of the respective linesize_align[i].
3608 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3609 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3610 * according to avcodec_get_edge_width() before.
3612 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3613 int linesize_align[AV_NUM_DATA_POINTERS]);
3615 #if FF_API_OLD_DECODE_AUDIO
3617 * Wrapper function which calls avcodec_decode_audio4.
3619 * @deprecated Use avcodec_decode_audio4 instead.
3621 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3622 * Some decoders may support multiple frames in a single AVPacket, such
3623 * decoders would then just decode the first frame. In this case,
3624 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3625 * the remaining data in order to decode the second frame etc.
3627 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3628 * decompressed frame size in bytes.
3630 * @warning You must set frame_size_ptr to the allocated size of the
3631 * output buffer before calling avcodec_decode_audio3().
3633 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3634 * the actual read bytes because some optimized bitstream readers read 32 or 64
3635 * bits at once and could read over the end.
3637 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3638 * no overreading happens for damaged MPEG streams.
3640 * @warning You must not provide a custom get_buffer() when using
3641 * avcodec_decode_audio3(). Doing so will override it with
3642 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3643 * which does allow the application to provide a custom get_buffer().
3645 * @note You might have to align the input buffer avpkt->data and output buffer
3646 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3647 * necessary at all, on others it won't work at all if not aligned and on others
3648 * it will work but it will have an impact on performance.
3650 * In practice, avpkt->data should have 4 byte alignment at minimum and
3651 * samples should be 16 byte aligned unless the CPU doesn't need it
3652 * (AltiVec and SSE do).
3654 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3655 * between input and output, these need to be fed with avpkt->data=NULL,
3656 * avpkt->size=0 at the end to return the remaining frames.
3658 * @param avctx the codec context
3659 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3660 * If the sample format is planar, each channel plane will
3661 * be the same size, with no padding between channels.
3662 * @param[in,out] frame_size_ptr the output buffer size in bytes
3663 * @param[in] avpkt The input AVPacket containing the input buffer.
3664 * You can create such packet with av_init_packet() and by then setting
3665 * data and size, some decoders might in addition need other fields.
3666 * All decoders are designed to use the least fields possible though.
3667 * @return On error a negative value is returned, otherwise the number of bytes
3668 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3670 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3671 int *frame_size_ptr,
3676 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3678 * Some decoders may support multiple frames in a single AVPacket. Such
3679 * decoders would then just decode the first frame. In this case,
3680 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3681 * the remaining data in order to decode the second frame, etc...
3682 * Even if no frames are returned, the packet needs to be fed to the decoder
3683 * with remaining data until it is completely consumed or an error occurs.
3685 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3686 * larger than the actual read bytes because some optimized bitstream
3687 * readers read 32 or 64 bits at once and could read over the end.
3689 * @note You might have to align the input buffer. The alignment requirements
3690 * depend on the CPU and the decoder.
3692 * @param avctx the codec context
3693 * @param[out] frame The AVFrame in which to store decoded audio samples.
3694 * Decoders request a buffer of a particular size by setting
3695 * AVFrame.nb_samples prior to calling get_buffer(). The
3696 * decoder may, however, only utilize part of the buffer by
3697 * setting AVFrame.nb_samples to a smaller value in the
3699 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3701 * @param[in] avpkt The input AVPacket containing the input buffer.
3702 * At least avpkt->data and avpkt->size should be set. Some
3703 * decoders might also require additional fields to be set.
3704 * @return A negative error code is returned if an error occurred during
3705 * decoding, otherwise the number of bytes consumed from the input
3706 * AVPacket is returned.
3708 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3709 int *got_frame_ptr, const AVPacket *avpkt);
3712 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3713 * Some decoders may support multiple frames in a single AVPacket, such
3714 * decoders would then just decode the first frame.
3716 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3717 * the actual read bytes because some optimized bitstream readers read 32 or 64
3718 * bits at once and could read over the end.
3720 * @warning The end of the input buffer buf should be set to 0 to ensure that
3721 * no overreading happens for damaged MPEG streams.
3723 * @note You might have to align the input buffer avpkt->data.
3724 * The alignment requirements depend on the CPU: on some CPUs it isn't
3725 * necessary at all, on others it won't work at all if not aligned and on others
3726 * it will work but it will have an impact on performance.
3728 * In practice, avpkt->data should have 4 byte alignment at minimum.
3730 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3731 * between input and output, these need to be fed with avpkt->data=NULL,
3732 * avpkt->size=0 at the end to return the remaining frames.
3734 * @param avctx the codec context
3735 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3736 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3737 * allocate memory for the actual bitmap.
3738 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3739 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3740 * decodes and the decoder tells the user once it does not need the data anymore,
3741 * the user app can at this point free/reuse/keep the memory as it sees fit.
3743 * @param[in] avpkt The input AVpacket containing the input buffer.
3744 * You can create such packet with av_init_packet() and by then setting
3745 * data and size, some decoders might in addition need other fields like
3746 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3748 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3749 * @return On error a negative value is returned, otherwise the number of bytes
3750 * used or zero if no frame could be decompressed.
3752 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3753 int *got_picture_ptr,
3754 const AVPacket *avpkt);
3757 * Decode a subtitle message.
3758 * Return a negative value on error, otherwise return the number of bytes used.
3759 * If no subtitle could be decompressed, got_sub_ptr is zero.
3760 * Otherwise, the subtitle is stored in *sub.
3761 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3762 * simplicity, because the performance difference is expect to be negligible
3763 * and reusing a get_buffer written for video codecs would probably perform badly
3764 * due to a potentially very different allocation pattern.
3766 * @param avctx the codec context
3767 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3768 freed with avsubtitle_free if *got_sub_ptr is set.
3769 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3770 * @param[in] avpkt The input AVPacket containing the input buffer.
3772 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3777 * @defgroup lavc_parsing Frame parsing
3781 typedef struct AVCodecParserContext {
3783 struct AVCodecParser *parser;
3784 int64_t frame_offset; /* offset of the current frame */
3785 int64_t cur_offset; /* current offset
3786 (incremented by each av_parser_parse()) */
3787 int64_t next_frame_offset; /* offset of the next frame */
3789 int pict_type; /* XXX: Put it back in AVCodecContext. */
3791 * This field is used for proper frame duration computation in lavf.
3792 * It signals, how much longer the frame duration of the current frame
3793 * is compared to normal frame duration.
3795 * frame_duration = (1 + repeat_pict) * time_base
3797 * It is used by codecs like H.264 to display telecined material.
3799 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3800 int64_t pts; /* pts of the current frame */
3801 int64_t dts; /* dts of the current frame */
3806 int fetch_timestamp;
3808 #define AV_PARSER_PTS_NB 4
3809 int cur_frame_start_index;
3810 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3811 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3812 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3815 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3816 #define PARSER_FLAG_ONCE 0x0002
3817 /// Set if the parser has a valid file offset
3818 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3819 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3821 int64_t offset; ///< byte offset from starting packet start
3822 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3825 * Set by parser to 1 for key frames and 0 for non-key frames.
3826 * It is initialized to -1, so if the parser doesn't set this flag,
3827 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3833 * Time difference in stream time base units from the pts of this
3834 * packet to the point at which the output from the decoder has converged
3835 * independent from the availability of previous frames. That is, the
3836 * frames are virtually identical no matter if decoding started from
3837 * the very first frame or from this keyframe.
3838 * Is AV_NOPTS_VALUE if unknown.
3839 * This field is not the display duration of the current frame.
3840 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3843 * The purpose of this field is to allow seeking in streams that have no
3844 * keyframes in the conventional sense. It corresponds to the
3845 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3846 * essential for some types of subtitle streams to ensure that all
3847 * subtitles are correctly displayed after seeking.
3849 int64_t convergence_duration;
3851 // Timestamp generation support:
3853 * Synchronization point for start of timestamp generation.
3855 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3858 * For example, this corresponds to presence of H.264 buffering period
3864 * Offset of the current timestamp against last timestamp sync point in
3865 * units of AVCodecContext.time_base.
3867 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3868 * contain a valid timestamp offset.
3870 * Note that the timestamp of sync point has usually a nonzero
3871 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3872 * the next frame after timestamp sync point will be usually 1.
3874 * For example, this corresponds to H.264 cpb_removal_delay.
3876 int dts_ref_dts_delta;
3879 * Presentation delay of current frame in units of AVCodecContext.time_base.
3881 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3882 * contain valid non-negative timestamp delta (presentation time of a frame
3883 * must not lie in the past).
3885 * This delay represents the difference between decoding and presentation
3886 * time of the frame.
3888 * For example, this corresponds to H.264 dpb_output_delay.
3893 * Position of the packet in file.
3895 * Analogous to cur_frame_pts/dts
3897 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3900 * Byte position of currently parsed frame in stream.
3905 * Previous frame byte position.
3910 * Duration of the current frame.
3911 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3912 * For all other types, this is in units of AVCodecContext.time_base.
3915 } AVCodecParserContext;
3917 typedef struct AVCodecParser {
3918 int codec_ids[5]; /* several codec IDs are permitted */
3920 int (*parser_init)(AVCodecParserContext *s);
3921 int (*parser_parse)(AVCodecParserContext *s,
3922 AVCodecContext *avctx,
3923 const uint8_t **poutbuf, int *poutbuf_size,
3924 const uint8_t *buf, int buf_size);
3925 void (*parser_close)(AVCodecParserContext *s);
3926 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3927 struct AVCodecParser *next;
3930 AVCodecParser *av_parser_next(AVCodecParser *c);
3932 void av_register_codec_parser(AVCodecParser *parser);
3933 AVCodecParserContext *av_parser_init(int codec_id);
3938 * @param s parser context.
3939 * @param avctx codec context.
3940 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3941 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3942 * @param buf input buffer.
3943 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3944 * @param pts input presentation timestamp.
3945 * @param dts input decoding timestamp.
3946 * @param pos input byte position in stream.
3947 * @return the number of bytes of the input bitstream used.
3952 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3959 * decode_frame(data, size);
3963 int av_parser_parse2(AVCodecParserContext *s,
3964 AVCodecContext *avctx,
3965 uint8_t **poutbuf, int *poutbuf_size,
3966 const uint8_t *buf, int buf_size,
3967 int64_t pts, int64_t dts,
3970 int av_parser_change(AVCodecParserContext *s,
3971 AVCodecContext *avctx,
3972 uint8_t **poutbuf, int *poutbuf_size,
3973 const uint8_t *buf, int buf_size, int keyframe);
3974 void av_parser_close(AVCodecParserContext *s);
3982 * @addtogroup lavc_encoding
3987 * Find a registered encoder with a matching codec ID.
3989 * @param id CodecID of the requested encoder
3990 * @return An encoder if one was found, NULL otherwise.
3992 AVCodec *avcodec_find_encoder(enum CodecID id);
3995 * Find a registered encoder with the specified name.
3997 * @param name name of the requested encoder
3998 * @return An encoder if one was found, NULL otherwise.
4000 AVCodec *avcodec_find_encoder_by_name(const char *name);
4002 #if FF_API_OLD_ENCODE_AUDIO
4004 * Encode an audio frame from samples into buf.
4006 * @deprecated Use avcodec_encode_audio2 instead.
4008 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4009 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4010 * will know how much space is needed because it depends on the value passed
4011 * in buf_size as described below. In that case a lower value can be used.
4013 * @param avctx the codec context
4014 * @param[out] buf the output buffer
4015 * @param[in] buf_size the output buffer size
4016 * @param[in] samples the input buffer containing the samples
4017 * The number of samples read from this buffer is frame_size*channels,
4018 * both of which are defined in avctx.
4019 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4020 * samples read from samples is equal to:
4021 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4022 * This also implies that av_get_bits_per_sample() must not return 0 for these
4024 * @return On error a negative value is returned, on success zero or the number
4025 * of bytes used to encode the data read from the input buffer.
4027 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4028 uint8_t *buf, int buf_size,
4029 const short *samples);
4033 * Encode a frame of audio.
4035 * Takes input samples from frame and writes the next output packet, if
4036 * available, to avpkt. The output packet does not necessarily contain data for
4037 * the most recent frame, as encoders can delay, split, and combine input frames
4038 * internally as needed.
4040 * @param avctx codec context
4041 * @param avpkt output AVPacket.
4042 * The user can supply an output buffer by setting
4043 * avpkt->data and avpkt->size prior to calling the
4044 * function, but if the size of the user-provided data is not
4045 * large enough, encoding will fail. All other AVPacket fields
4046 * will be reset by the encoder using av_init_packet(). If
4047 * avpkt->data is NULL, the encoder will allocate it.
4048 * The encoder will set avpkt->size to the size of the
4051 * If this function fails or produces no output, avpkt will be
4052 * freed using av_free_packet() (i.e. avpkt->destruct will be
4053 * called to free the user supplied buffer).
4054 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4055 * May be NULL when flushing an encoder that has the
4056 * CODEC_CAP_DELAY capability set.
4057 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4058 * can have any number of samples.
4059 * If it is not set, frame->nb_samples must be equal to
4060 * avctx->frame_size for all frames except the last.
4061 * The final frame may be smaller than avctx->frame_size.
4062 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4063 * output packet is non-empty, and to 0 if it is
4064 * empty. If the function returns an error, the
4065 * packet can be assumed to be invalid, and the
4066 * value of got_packet_ptr is undefined and should
4068 * @return 0 on success, negative error code on failure
4070 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4071 const AVFrame *frame, int *got_packet_ptr);
4073 #if FF_API_OLD_ENCODE_VIDEO
4075 * @deprecated use avcodec_encode_video2() instead.
4077 * Encode a video frame from pict into buf.
4078 * The input picture should be
4079 * stored using a specific format, namely avctx.pix_fmt.
4081 * @param avctx the codec context
4082 * @param[out] buf the output buffer for the bitstream of encoded frame
4083 * @param[in] buf_size the size of the output buffer in bytes
4084 * @param[in] pict the input picture to encode
4085 * @return On error a negative value is returned, on success zero or the number
4086 * of bytes used from the output buffer.
4088 attribute_deprecated
4089 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4090 const AVFrame *pict);
4094 * Encode a frame of video.
4096 * Takes input raw video data from frame and writes the next output packet, if
4097 * available, to avpkt. The output packet does not necessarily contain data for
4098 * the most recent frame, as encoders can delay and reorder input frames
4099 * internally as needed.
4101 * @param avctx codec context
4102 * @param avpkt output AVPacket.
4103 * The user can supply an output buffer by setting
4104 * avpkt->data and avpkt->size prior to calling the
4105 * function, but if the size of the user-provided data is not
4106 * large enough, encoding will fail. All other AVPacket fields
4107 * will be reset by the encoder using av_init_packet(). If
4108 * avpkt->data is NULL, the encoder will allocate it.
4109 * The encoder will set avpkt->size to the size of the
4110 * output packet. The returned data (if any) belongs to the
4111 * caller, he is responsible for freeing it.
4113 * If this function fails or produces no output, avpkt will be
4114 * freed using av_free_packet() (i.e. avpkt->destruct will be
4115 * called to free the user supplied buffer).
4116 * @param[in] frame AVFrame containing the raw video data to be encoded.
4117 * May be NULL when flushing an encoder that has the
4118 * CODEC_CAP_DELAY capability set.
4119 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4120 * output packet is non-empty, and to 0 if it is
4121 * empty. If the function returns an error, the
4122 * packet can be assumed to be invalid, and the
4123 * value of got_packet_ptr is undefined and should
4125 * @return 0 on success, negative error code on failure
4127 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4128 const AVFrame *frame, int *got_packet_ptr);
4130 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4131 const AVSubtitle *sub);
4139 * @defgroup lavc_resample Audio resampling
4144 struct ReSampleContext;
4145 struct AVResampleContext;
4147 typedef struct ReSampleContext ReSampleContext;
4150 * Initialize audio resampling context.
4152 * @param output_channels number of output channels
4153 * @param input_channels number of input channels
4154 * @param output_rate output sample rate
4155 * @param input_rate input sample rate
4156 * @param sample_fmt_out requested output sample format
4157 * @param sample_fmt_in input sample format
4158 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4159 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4160 * @param linear if 1 then the used FIR filter will be linearly interpolated
4161 between the 2 closest, if 0 the closest will be used
4162 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4163 * @return allocated ReSampleContext, NULL if error occurred
4165 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4166 int output_rate, int input_rate,
4167 enum AVSampleFormat sample_fmt_out,
4168 enum AVSampleFormat sample_fmt_in,
4169 int filter_length, int log2_phase_count,
4170 int linear, double cutoff);
4172 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4175 * Free resample context.
4177 * @param s a non-NULL pointer to a resample context previously
4178 * created with av_audio_resample_init()
4180 void audio_resample_close(ReSampleContext *s);
4184 * Initialize an audio resampler.
4185 * Note, if either rate is not an integer then simply scale both rates up so they are.
4186 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4187 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4188 * @param linear If 1 then the used FIR filter will be linearly interpolated
4189 between the 2 closest, if 0 the closest will be used
4190 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4192 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4195 * Resample an array of samples using a previously configured context.
4196 * @param src an array of unconsumed samples
4197 * @param consumed the number of samples of src which have been consumed are returned here
4198 * @param src_size the number of unconsumed samples available
4199 * @param dst_size the amount of space in samples available in dst
4200 * @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.
4201 * @return the number of samples written in dst or -1 if an error occurred
4203 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4207 * Compensate samplerate/timestamp drift. The compensation is done by changing
4208 * the resampler parameters, so no audible clicks or similar distortions occur
4209 * @param compensation_distance distance in output samples over which the compensation should be performed
4210 * @param sample_delta number of output samples which should be output less
4212 * example: av_resample_compensate(c, 10, 500)
4213 * here instead of 510 samples only 500 samples would be output
4215 * note, due to rounding the actual compensation might be slightly different,
4216 * especially if the compensation_distance is large and the in_rate used during init is small
4218 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4219 void av_resample_close(struct AVResampleContext *c);
4226 * @addtogroup lavc_picture
4231 * Allocate memory for a picture. Call avpicture_free() to free it.
4233 * @see avpicture_fill()
4235 * @param picture the picture to be filled in
4236 * @param pix_fmt the format of the picture
4237 * @param width the width of the picture
4238 * @param height the height of the picture
4239 * @return zero if successful, a negative value if not
4241 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4244 * Free a picture previously allocated by avpicture_alloc().
4245 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4248 * @param picture the AVPicture to be freed
4250 void avpicture_free(AVPicture *picture);
4253 * Fill in the AVPicture fields.
4254 * The fields of the given AVPicture are filled in by using the 'ptr' address
4255 * which points to the image data buffer. Depending on the specified picture
4256 * format, one or multiple image data pointers and line sizes will be set.
4257 * If a planar format is specified, several pointers will be set pointing to
4258 * the different picture planes and the line sizes of the different planes
4259 * will be stored in the lines_sizes array.
4260 * Call with ptr == NULL to get the required size for the ptr buffer.
4262 * To allocate the buffer and fill in the AVPicture fields in one call,
4263 * use avpicture_alloc().
4265 * @param picture AVPicture whose fields are to be filled in
4266 * @param ptr Buffer which will contain or contains the actual image data
4267 * @param pix_fmt The format in which the picture data is stored.
4268 * @param width the width of the image in pixels
4269 * @param height the height of the image in pixels
4270 * @return size of the image data in bytes
4272 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4273 enum PixelFormat pix_fmt, int width, int height);
4276 * Copy pixel data from an AVPicture into a buffer.
4277 * The data is stored compactly, without any gaps for alignment or padding
4278 * which may be applied by avpicture_fill().
4280 * @see avpicture_get_size()
4282 * @param[in] src AVPicture containing image data
4283 * @param[in] pix_fmt The format in which the picture data is stored.
4284 * @param[in] width the width of the image in pixels.
4285 * @param[in] height the height of the image in pixels.
4286 * @param[out] dest A buffer into which picture data will be copied.
4287 * @param[in] dest_size The size of 'dest'.
4288 * @return The number of bytes written to dest, or a negative value (error code) on error.
4290 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4291 unsigned char *dest, int dest_size);
4294 * Calculate the size in bytes that a picture of the given width and height
4295 * would occupy if stored in the given picture format.
4296 * Note that this returns the size of a compact representation as generated
4297 * by avpicture_layout(), which can be smaller than the size required for e.g.
4300 * @param pix_fmt the given picture format
4301 * @param width the width of the image
4302 * @param height the height of the image
4303 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4305 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4308 * deinterlace - if not supported return -1
4310 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4311 enum PixelFormat pix_fmt, int width, int height);
4313 * Copy image src to dst. Wraps av_picture_data_copy() above.
4315 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4316 enum PixelFormat pix_fmt, int width, int height);
4319 * Crop image top and left side.
4321 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4322 enum PixelFormat pix_fmt, int top_band, int left_band);
4327 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4328 int padtop, int padbottom, int padleft, int padright, int *color);
4335 * @defgroup lavc_misc Utility functions
4338 * Miscellaneous utility functions related to both encoding and decoding
4344 * @defgroup lavc_misc_pixfmt Pixel formats
4346 * Functions for working with pixel formats.
4350 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4353 * Return a value representing the fourCC code associated to the
4354 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4357 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4359 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4360 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4361 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4362 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4363 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4364 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4367 * Compute what kind of losses will occur when converting from one specific
4368 * pixel format to another.
4369 * When converting from one pixel format to another, information loss may occur.
4370 * For example, when converting from RGB24 to GRAY, the color information will
4371 * be lost. Similarly, other losses occur when converting from some formats to
4372 * other formats. These losses can involve loss of chroma, but also loss of
4373 * resolution, loss of color depth, loss due to the color space conversion, loss
4374 * of the alpha bits or loss due to color quantization.
4375 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4376 * which will occur when converting from one pixel format to another.
4378 * @param[in] dst_pix_fmt destination pixel format
4379 * @param[in] src_pix_fmt source pixel format
4380 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4381 * @return Combination of flags informing you what kind of losses will occur
4382 * (maximum loss for an invalid dst_pix_fmt).
4384 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4388 * Find the best pixel format to convert to given a certain source pixel
4389 * format. When converting from one pixel format to another, information loss
4390 * may occur. For example, when converting from RGB24 to GRAY, the color
4391 * information will be lost. Similarly, other losses occur when converting from
4392 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4393 * the given pixel formats should be used to suffer the least amount of loss.
4394 * The pixel formats from which it chooses one, are determined by the
4395 * pix_fmt_mask parameter.
4397 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4400 * src_pix_fmt = PIX_FMT_YUV420P;
4401 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
4402 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4405 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4406 * @param[in] src_pix_fmt source pixel format
4407 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4408 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4409 * @return The best pixel format to convert to or -1 if none was found.
4411 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4412 int has_alpha, int *loss_ptr);
4415 * Find the best pixel format to convert to given a certain source pixel
4416 * format and a selection of two destination pixel formats. When converting from
4417 * one pixel format to another, information loss may occur. For example, when converting
4418 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4419 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
4420 * the given pixel formats should be used to suffer the least amount of loss.
4422 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
4426 * src_pix_fmt = PIX_FMT_YUV420P;
4427 * dst_pix_fmt1= PIX_FMT_RGB24;
4428 * dst_pix_fmt2= PIX_FMT_GRAY8;
4429 * dst_pix_fmt3= PIX_FMT_RGB8;
4430 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4431 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4432 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4435 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4436 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4437 * @param[in] src_pix_fmt Source pixel format
4438 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4439 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4440 * NULL or value of zero means we care about all losses. Out: the loss
4441 * that occurs when converting from src to selected dst pixel format.
4442 * @return The best pixel format to convert to or -1 if none was found.
4444 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4445 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4447 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4453 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4456 * Put a string representing the codec tag codec_tag in buf.
4458 * @param buf_size size in bytes of buf
4459 * @return the length of the string that would have been generated if
4460 * enough space had been available, excluding the trailing null
4462 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4464 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4467 * Return a name for the specified profile, if available.
4469 * @param codec the codec that is searched for the given profile
4470 * @param profile the profile value for which a name is requested
4471 * @return A name for the profile if found, NULL otherwise.
4473 const char *av_get_profile_name(const AVCodec *codec, int profile);
4475 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4476 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4477 //FIXME func typedef
4480 * Fill audio frame data and linesize.
4481 * AVFrame extended_data channel pointers are allocated if necessary for
4484 * @param frame the AVFrame
4485 * frame->nb_samples must be set prior to calling the
4486 * function. This function fills in frame->data,
4487 * frame->extended_data, frame->linesize[0].
4488 * @param nb_channels channel count
4489 * @param sample_fmt sample format
4490 * @param buf buffer to use for frame data
4491 * @param buf_size size of buffer
4492 * @param align plane size sample alignment (0 = default)
4493 * @return 0 on success, negative error code on failure
4495 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4496 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4497 int buf_size, int align);
4500 * Flush buffers, should be called when seeking or when switching to a different stream.
4502 void avcodec_flush_buffers(AVCodecContext *avctx);
4504 void avcodec_default_free_buffers(AVCodecContext *s);
4507 * Return codec bits per sample.
4509 * @param[in] codec_id the codec
4510 * @return Number of bits per sample or zero if unknown for the given codec.
4512 int av_get_bits_per_sample(enum CodecID codec_id);
4515 * Return the PCM codec associated with a sample format.
4516 * @param be endianness, 0 for little, 1 for big,
4517 * -1 (or anything else) for native
4518 * @return CODEC_ID_PCM_* or CODEC_ID_NONE
4520 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4523 * Return codec bits per sample.
4524 * Only return non-zero if the bits per sample is exactly correct, not an
4527 * @param[in] codec_id the codec
4528 * @return Number of bits per sample or zero if unknown for the given codec.
4530 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4533 * Return audio frame duration.
4535 * @param avctx codec context
4536 * @param frame_bytes size of the frame, or 0 if unknown
4537 * @return frame duration, in samples, if known. 0 if not able to
4540 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4543 typedef struct AVBitStreamFilterContext {
4545 struct AVBitStreamFilter *filter;
4546 AVCodecParserContext *parser;
4547 struct AVBitStreamFilterContext *next;
4548 } AVBitStreamFilterContext;
4551 typedef struct AVBitStreamFilter {
4554 int (*filter)(AVBitStreamFilterContext *bsfc,
4555 AVCodecContext *avctx, const char *args,
4556 uint8_t **poutbuf, int *poutbuf_size,
4557 const uint8_t *buf, int buf_size, int keyframe);
4558 void (*close)(AVBitStreamFilterContext *bsfc);
4559 struct AVBitStreamFilter *next;
4560 } AVBitStreamFilter;
4562 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4563 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4564 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4565 AVCodecContext *avctx, const char *args,
4566 uint8_t **poutbuf, int *poutbuf_size,
4567 const uint8_t *buf, int buf_size, int keyframe);
4568 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4570 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4575 * Reallocate the given block if it is not large enough, otherwise do nothing.
4579 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4582 * Allocate a buffer, reusing the given one if large enough.
4584 * Contrary to av_fast_realloc the current buffer contents might not be
4585 * preserved and on error the old buffer is freed, thus no special
4586 * handling to avoid memleaks is necessary.
4588 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4589 * @param size size of the buffer *ptr points to
4590 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4591 * *size 0 if an error occurred.
4593 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4596 * Same behaviour av_fast_malloc but the buffer has additional
4597 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4599 * In addition the whole buffer will initially and after resizes
4600 * be 0-initialized so that no uninitialized data will ever appear.
4602 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4605 * Encode extradata length to a buffer. Used by xiph codecs.
4607 * @param s buffer to write to; must be at least (v/255+1) bytes long
4608 * @param v size of extradata in bytes
4609 * @return number of bytes written to the buffer.
4611 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4614 * Log a generic warning message about a missing feature. This function is
4615 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4616 * only, and would normally not be used by applications.
4617 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4618 * a pointer to an AVClass struct
4619 * @param[in] feature string containing the name of the missing feature
4620 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4621 * If want_sample is non-zero, additional verbage will be added to the log
4622 * message which tells the user how to report samples to the development
4625 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4628 * Log a generic warning message asking for a sample. This function is
4629 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4630 * only, and would normally not be used by applications.
4631 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4632 * a pointer to an AVClass struct
4633 * @param[in] msg string containing an optional message, or NULL if no message
4635 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4638 * Register the hardware accelerator hwaccel.
4640 void av_register_hwaccel(AVHWAccel *hwaccel);
4643 * If hwaccel is NULL, returns the first registered hardware accelerator,
4644 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4645 * after hwaccel, or NULL if hwaccel is the last one.
4647 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4651 * Lock operation used by lockmgr
4654 AV_LOCK_CREATE, ///< Create a mutex
4655 AV_LOCK_OBTAIN, ///< Lock the mutex
4656 AV_LOCK_RELEASE, ///< Unlock the mutex
4657 AV_LOCK_DESTROY, ///< Free mutex resources
4661 * Register a user provided lock manager supporting the operations
4662 * specified by AVLockOp. mutex points to a (void *) where the
4663 * lockmgr should store/get a pointer to a user allocated mutex. It's
4664 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4666 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4667 * callback during the call to av_lockmgr_register().
4668 * Thus, the application must be prepared to handle that.
4669 * If cb is set to NULL the lockmgr will be unregistered.
4670 * Also note that during unregistration the previously registered
4671 * lockmgr callback may also be invoked.
4673 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4676 * Get the type of the given codec.
4678 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4681 * Get the name of a codec.
4682 * @return a static string identifying the codec; never NULL
4684 const char *avcodec_get_name(enum CodecID id);
4687 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4688 * with no corresponding avcodec_close()), 0 otherwise.
4690 int avcodec_is_open(AVCodecContext *s);
4693 * @return a non-zero number if codec is an encoder, zero otherwise
4695 int av_codec_is_encoder(AVCodec *codec);
4698 * @return a non-zero number if codec is a decoder, zero otherwise
4700 int av_codec_is_decoder(AVCodec *codec);
4706 #endif /* AVCODEC_AVCODEC_H */