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,
264 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
265 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
266 CODEC_ID_EXR = MKBETAG('0','E','X','R'),
267 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
269 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
270 CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
271 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
272 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
273 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
274 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
275 CODEC_ID_SANM = MKBETAG('S','A','N','M'),
276 CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
278 /* various PCM "codecs" */
279 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
280 CODEC_ID_PCM_S16LE = 0x10000,
296 CODEC_ID_PCM_S24DAUD,
298 CODEC_ID_PCM_S16LE_PLANAR,
307 CODEC_ID_PCM_S8_PLANAR,
309 /* various ADPCM codecs */
310 CODEC_ID_ADPCM_IMA_QT = 0x11000,
311 CODEC_ID_ADPCM_IMA_WAV,
312 CODEC_ID_ADPCM_IMA_DK3,
313 CODEC_ID_ADPCM_IMA_DK4,
314 CODEC_ID_ADPCM_IMA_WS,
315 CODEC_ID_ADPCM_IMA_SMJPEG,
324 CODEC_ID_ADPCM_YAMAHA,
325 CODEC_ID_ADPCM_SBPRO_4,
326 CODEC_ID_ADPCM_SBPRO_3,
327 CODEC_ID_ADPCM_SBPRO_2,
329 CODEC_ID_ADPCM_IMA_AMV,
330 CODEC_ID_ADPCM_EA_R1,
331 CODEC_ID_ADPCM_EA_R3,
332 CODEC_ID_ADPCM_EA_R2,
333 CODEC_ID_ADPCM_IMA_EA_SEAD,
334 CODEC_ID_ADPCM_IMA_EA_EACS,
335 CODEC_ID_ADPCM_EA_XAS,
336 CODEC_ID_ADPCM_EA_MAXIS_XA,
337 CODEC_ID_ADPCM_IMA_ISS,
339 CODEC_ID_ADPCM_IMA_APC,
340 CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
343 CODEC_ID_AMR_NB = 0x12000,
346 /* RealAudio codecs*/
347 CODEC_ID_RA_144 = 0x13000,
350 /* various DPCM codecs */
351 CODEC_ID_ROQ_DPCM = 0x14000,
352 CODEC_ID_INTERPLAY_DPCM,
357 CODEC_ID_MP2 = 0x15000,
358 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
374 CODEC_ID_WESTWOOD_SND1,
375 CODEC_ID_GSM, ///< as in Berlin toast format
383 CODEC_ID_DSICINAUDIO,
387 CODEC_ID_GSM_MS, /* as found in WAV */
396 CODEC_ID_WMALOSSLESS,
405 CODEC_ID_BINKAUDIO_RDFT,
406 CODEC_ID_BINKAUDIO_DCT,
418 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
419 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
420 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
421 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
422 CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
424 /* subtitle codecs */
425 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
426 CODEC_ID_DVD_SUBTITLE = 0x17000,
427 CODEC_ID_DVB_SUBTITLE,
428 CODEC_ID_TEXT, ///< raw UTF-8 text
432 CODEC_ID_HDMV_PGS_SUBTITLE,
433 CODEC_ID_DVB_TELETEXT,
435 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
436 CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
437 CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
438 CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
439 CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
441 /* other specific kind of codecs (generally used for attachments) */
442 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
443 CODEC_ID_TTF = 0x18000,
444 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
445 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
446 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
448 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
450 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
451 * stream (only used by libavformat) */
452 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
453 * stream (only used by libavformat) */
454 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
457 #if FF_API_OLD_DECODE_AUDIO
459 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
463 * @ingroup lavc_decoding
464 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
465 * This is mainly needed because some optimized bitstream readers read
466 * 32 or 64 bit at once and could read over the end.<br>
467 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
468 * MPEG bitstreams could cause overread and segfault.
470 #define FF_INPUT_BUFFER_PADDING_SIZE 16
473 * @ingroup lavc_encoding
474 * minimum encoding buffer size
475 * Used to avoid some checks during header writing.
477 #define FF_MIN_BUFFER_SIZE 16384
481 * @ingroup lavc_encoding
482 * motion estimation type.
485 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
489 ME_EPZS, ///< enhanced predictive zonal search
490 ME_X1, ///< reserved for experiments
491 ME_HEX, ///< hexagon based search
492 ME_UMH, ///< uneven multi-hexagon search
493 ME_ITER, ///< iterative search
494 ME_TESA, ///< transformed exhaustive search algorithm
498 * @ingroup lavc_decoding
501 /* We leave some space between them for extensions (drop some
502 * keyframes for intra-only or drop just some bidir frames). */
503 AVDISCARD_NONE =-16, ///< discard nothing
504 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
505 AVDISCARD_NONREF = 8, ///< discard all non reference
506 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
507 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
508 AVDISCARD_ALL = 48, ///< discard all
511 enum AVColorPrimaries{
512 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
513 AVCOL_PRI_UNSPECIFIED = 2,
514 AVCOL_PRI_BT470M = 4,
515 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
516 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
517 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
519 AVCOL_PRI_NB , ///< Not part of ABI
522 enum AVColorTransferCharacteristic{
523 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
524 AVCOL_TRC_UNSPECIFIED = 2,
525 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
526 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
527 AVCOL_TRC_SMPTE240M = 7,
528 AVCOL_TRC_NB , ///< Not part of ABI
533 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
534 AVCOL_SPC_UNSPECIFIED = 2,
536 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
537 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
538 AVCOL_SPC_SMPTE240M = 7,
539 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
540 AVCOL_SPC_NB , ///< Not part of ABI
542 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
545 AVCOL_RANGE_UNSPECIFIED = 0,
546 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
547 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
548 AVCOL_RANGE_NB , ///< Not part of ABI
552 * X X 3 4 X X are luma samples,
553 * 1 2 1-6 are possible chroma positions
554 * X X 5 6 X 0 is undefined/unknown position
556 enum AVChromaLocation{
557 AVCHROMA_LOC_UNSPECIFIED = 0,
558 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
559 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
560 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
561 AVCHROMA_LOC_TOP = 4,
562 AVCHROMA_LOC_BOTTOMLEFT = 5,
563 AVCHROMA_LOC_BOTTOM = 6,
564 AVCHROMA_LOC_NB , ///< Not part of ABI
567 enum AVAudioServiceType {
568 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
569 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
570 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
571 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
572 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
573 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
574 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
575 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
576 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
577 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
581 * @ingroup lavc_encoding
583 typedef struct RcOverride{
586 int qscale; // If this is 0 then quality_factor will be used instead.
587 float quality_factor;
590 #define FF_MAX_B_FRAMES 16
593 These flags can be passed in AVCodecContext.flags before initialization.
594 Note: Not everything is supported yet.
597 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
598 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
599 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
600 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
601 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
603 * The parent program guarantees that the input for B-frames containing
604 * streams is not written to for at least s->max_b_frames+1 frames, if
605 * this is not set the input will be copied.
607 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
608 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
609 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
610 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
611 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
612 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
613 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
614 location instead of only at frame boundaries. */
615 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
616 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
617 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
618 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
619 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
620 /* Fx : Flag for h263+ extra options */
621 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
622 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
623 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
624 #define CODEC_FLAG_CLOSED_GOP 0x80000000
625 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
626 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
627 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
628 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
629 #if FF_API_MPV_GLOBAL_OPTS
630 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
631 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
632 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
633 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
635 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
636 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
638 /* Unsupported options :
639 * Syntax Arithmetic coding (SAC)
640 * Reference Picture Selection
641 * Independent Segment Decoding */
643 /* codec capabilities */
645 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
647 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
648 * If not set, it might not use get_buffer() at all or use operations that
649 * assume the buffer was allocated by avcodec_default_get_buffer.
651 #define CODEC_CAP_DR1 0x0002
652 #define CODEC_CAP_TRUNCATED 0x0008
653 /* Codec can export data for HW decoding (XvMC). */
654 #define CODEC_CAP_HWACCEL 0x0010
656 * Encoder or decoder requires flushing with NULL input at the end in order to
657 * give the complete and correct output.
659 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
660 * with NULL data. The user can still send NULL data to the public encode
661 * or decode function, but libavcodec will not pass it along to the codec
662 * unless this flag is set.
665 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
666 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
670 * The encoder needs to be fed with NULL data at the end of encoding until the
671 * encoder no longer returns data.
673 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
674 * flag also means that the encoder must set the pts and duration for
675 * each output packet. If this flag is not set, the pts and duration will
676 * be determined by libavcodec from the input frame.
678 #define CODEC_CAP_DELAY 0x0020
680 * Codec can be fed a final frame with a smaller size.
681 * This can be used to prevent truncation of the last audio samples.
683 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
685 * Codec can export data for HW decoding (VDPAU).
687 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
689 * Codec can output multiple frames per AVPacket
690 * Normally demuxers return one frame at a time, demuxers which do not do
691 * are connected to a parser to split what they return into proper frames.
692 * This flag is reserved to the very rare category of codecs which have a
693 * bitstream that cannot be split into frames without timeconsuming
694 * operations like full decoding. Demuxers carring such bitstreams thus
695 * may return multiple frames in a packet. This has many disadvantages like
696 * prohibiting stream copy in many cases thus it should only be considered
699 #define CODEC_CAP_SUBFRAMES 0x0100
701 * Codec is experimental and is thus avoided in favor of non experimental
704 #define CODEC_CAP_EXPERIMENTAL 0x0200
706 * Codec should fill in channel configuration and samplerate instead of container
708 #define CODEC_CAP_CHANNEL_CONF 0x0400
711 * Codec is able to deal with negative linesizes
713 #define CODEC_CAP_NEG_LINESIZES 0x0800
716 * Codec supports frame-level multithreading.
718 #define CODEC_CAP_FRAME_THREADS 0x1000
720 * Codec supports slice-based (or partition-based) multithreading.
722 #define CODEC_CAP_SLICE_THREADS 0x2000
724 * Codec supports changed parameters at any point.
726 #define CODEC_CAP_PARAM_CHANGE 0x4000
728 * Codec supports avctx->thread_count == 0 (auto).
730 #define CODEC_CAP_AUTO_THREADS 0x8000
732 * Audio encoder supports receiving a different number of samples in each call.
734 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
736 * Codec is intra only.
738 #define CODEC_CAP_INTRA_ONLY 0x40000000
742 #define CODEC_CAP_LOSSLESS 0x80000000
744 //The following defines may change, don't expect compatibility if you use them.
745 #define MB_TYPE_INTRA4x4 0x0001
746 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
747 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
748 #define MB_TYPE_16x16 0x0008
749 #define MB_TYPE_16x8 0x0010
750 #define MB_TYPE_8x16 0x0020
751 #define MB_TYPE_8x8 0x0040
752 #define MB_TYPE_INTERLACED 0x0080
753 #define MB_TYPE_DIRECT2 0x0100 //FIXME
754 #define MB_TYPE_ACPRED 0x0200
755 #define MB_TYPE_GMC 0x0400
756 #define MB_TYPE_SKIP 0x0800
757 #define MB_TYPE_P0L0 0x1000
758 #define MB_TYPE_P1L0 0x2000
759 #define MB_TYPE_P0L1 0x4000
760 #define MB_TYPE_P1L1 0x8000
761 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
762 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
763 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
764 #define MB_TYPE_QUANT 0x00010000
765 #define MB_TYPE_CBP 0x00020000
766 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
770 * This specifies the area which should be displayed.
771 * Note there may be multiple such areas for one frame.
773 typedef struct AVPanScan{
776 * - encoding: Set by user.
777 * - decoding: Set by libavcodec.
782 * width and height in 1/16 pel
783 * - encoding: Set by user.
784 * - decoding: Set by libavcodec.
790 * position of the top left corner in 1/16 pel for up to 3 fields/frames
791 * - encoding: Set by user.
792 * - decoding: Set by libavcodec.
794 int16_t position[3][2];
797 #define FF_QSCALE_TYPE_MPEG1 0
798 #define FF_QSCALE_TYPE_MPEG2 1
799 #define FF_QSCALE_TYPE_H264 2
800 #define FF_QSCALE_TYPE_VP56 3
802 #define FF_BUFFER_TYPE_INTERNAL 1
803 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
804 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
805 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
807 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
808 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
809 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
810 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
813 * @defgroup lavc_packet AVPacket
815 * Types and functions for working with AVPacket.
818 enum AVPacketSideDataType {
820 AV_PKT_DATA_NEW_EXTRADATA,
823 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
826 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
827 * s32le channel_count
828 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
829 * u64le channel_layout
830 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
832 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
837 AV_PKT_DATA_PARAM_CHANGE,
840 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
841 * structures with info about macroblocks relevant to splitting the
842 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
843 * That is, it does not necessarily contain info about all macroblocks,
844 * as long as the distance between macroblocks in the info is smaller
845 * than the target payload size.
846 * Each MB info structure is 12 bytes, and is laid out as follows:
848 * u32le bit offset from the start of the packet
849 * u8 current quantizer at the start of the macroblock
851 * u16le macroblock address within the GOB
852 * u8 horizontal MV predictor
853 * u8 vertical MV predictor
854 * u8 horizontal MV predictor for block number 3
855 * u8 vertical MV predictor for block number 3
858 AV_PKT_DATA_H263_MB_INFO,
861 * Recommmends skipping the specified number of samples
863 * u32le number of samples to skip from start of this packet
864 * u32le number of samples to skip from end of this packet
865 * u8 reason for start skip
866 * u8 reason for end skip (0=padding silence, 1=convergence)
869 AV_PKT_DATA_SKIP_SAMPLES=70,
872 typedef struct AVPacket {
874 * Presentation timestamp in AVStream->time_base units; the time at which
875 * the decompressed packet will be presented to the user.
876 * Can be AV_NOPTS_VALUE if it is not stored in the file.
877 * pts MUST be larger or equal to dts as presentation cannot happen before
878 * decompression, unless one wants to view hex dumps. Some formats misuse
879 * the terms dts and pts/cts to mean something different. Such timestamps
880 * must be converted to true pts/dts before they are stored in AVPacket.
884 * Decompression timestamp in AVStream->time_base units; the time at which
885 * the packet is decompressed.
886 * Can be AV_NOPTS_VALUE if it is not stored in the file.
893 * A combination of AV_PKT_FLAG values
897 * Additional packet data that can be provided by the container.
898 * Packet can contain several types of side information.
903 enum AVPacketSideDataType type;
908 * Duration of this packet in AVStream->time_base units, 0 if unknown.
909 * Equals next_pts - this_pts in presentation order.
912 void (*destruct)(struct AVPacket *);
914 int64_t pos; ///< byte position in stream, -1 if unknown
917 * Time difference in AVStream->time_base units from the pts of this
918 * packet to the point at which the output from the decoder has converged
919 * independent from the availability of previous frames. That is, the
920 * frames are virtually identical no matter if decoding started from
921 * the very first frame or from this keyframe.
922 * Is AV_NOPTS_VALUE if unknown.
923 * This field is not the display duration of the current packet.
924 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
927 * The purpose of this field is to allow seeking in streams that have no
928 * keyframes in the conventional sense. It corresponds to the
929 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
930 * essential for some types of subtitle streams to ensure that all
931 * subtitles are correctly displayed after seeking.
933 int64_t convergence_duration;
935 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
936 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
938 enum AVSideDataParamChangeFlags {
939 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
940 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
941 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
942 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
950 * New fields can be added to the end of AVFRAME with minor version
951 * bumps. Similarly fields that are marked as to be only accessed by
952 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
953 * without breaking compatibility with each other.
954 * Removal, reordering and changes in the remaining cases require
955 * a major version bump.
956 * sizeof(AVFrame) must not be used outside libavcodec.
958 typedef struct AVFrame {
959 #define AV_NUM_DATA_POINTERS 8
961 * pointer to the picture/channel planes.
962 * This might be different from the first allocated byte
963 * - encoding: Set by user
964 * - decoding: set by AVCodecContext.get_buffer()
966 uint8_t *data[AV_NUM_DATA_POINTERS];
969 * Size, in bytes, of the data for each picture/channel plane.
971 * For audio, only linesize[0] may be set. For planar audio, each channel
972 * plane must be the same size.
974 * - encoding: Set by user
975 * - decoding: set by AVCodecContext.get_buffer()
977 int linesize[AV_NUM_DATA_POINTERS];
980 * pointers to the data planes/channels.
982 * For video, this should simply point to data[].
984 * For planar audio, each channel has a separate data pointer, and
985 * linesize[0] contains the size of each channel buffer.
986 * For packed audio, there is just one data pointer, and linesize[0]
987 * contains the total size of the buffer for all channels.
989 * Note: Both data and extended_data will always be set by get_buffer(),
990 * but for planar audio with more channels that can fit in data,
991 * extended_data must be used by the decoder in order to access all
995 * decoding: set by AVCodecContext.get_buffer()
997 uint8_t **extended_data;
1000 * width and height of the video frame
1001 * - encoding: unused
1002 * - decoding: Read by user.
1007 * number of audio samples (per channel) described by this frame
1008 * - encoding: Set by user
1009 * - decoding: Set by libavcodec
1014 * format of the frame, -1 if unknown or unset
1015 * Values correspond to enum PixelFormat for video frames,
1016 * enum AVSampleFormat for audio)
1017 * - encoding: unused
1018 * - decoding: Read by user.
1023 * 1 -> keyframe, 0-> not
1024 * - encoding: Set by libavcodec.
1025 * - decoding: Set by libavcodec.
1030 * Picture type of the frame, see ?_TYPE below.
1031 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1032 * - decoding: Set by libavcodec.
1034 enum AVPictureType pict_type;
1037 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1038 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1042 uint8_t *base[AV_NUM_DATA_POINTERS];
1045 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1046 * - encoding: unused
1047 * - decoding: Read by user.
1049 AVRational sample_aspect_ratio;
1052 * presentation timestamp in time_base units (time when frame should be shown to user)
1053 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1054 * - encoding: MUST be set by user.
1055 * - decoding: Set by libavcodec.
1060 * reordered pts from the last AVPacket that has been input into the decoder
1061 * - encoding: unused
1062 * - decoding: Read by user.
1067 * dts from the last AVPacket that has been input into the decoder
1068 * - encoding: unused
1069 * - decoding: Read by user.
1074 * picture number in bitstream order
1075 * - encoding: set by
1076 * - decoding: Set by libavcodec.
1078 int coded_picture_number;
1080 * picture number in display order
1081 * - encoding: set by
1082 * - decoding: Set by libavcodec.
1084 int display_picture_number;
1087 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1088 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1089 * - decoding: Set by libavcodec.
1094 * is this picture used as reference
1095 * The values for this are the same as the MpegEncContext.picture_structure
1096 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1097 * Set to 4 for delayed, non-reference frames.
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec. (before get_buffer() call)).
1105 * - encoding: unused
1106 * - decoding: Set by libavcodec.
1108 int8_t *qscale_table;
1111 * - encoding: unused
1112 * - decoding: Set by libavcodec.
1122 * mbskip_table[mb]>=1 if MB didn't change
1123 * stride= mb_width = (width+15)>>4
1124 * - encoding: unused
1125 * - decoding: Set by libavcodec.
1127 uint8_t *mbskip_table;
1130 * motion vector table
1133 * int mv_sample_log2= 4 - motion_subsample_log2;
1134 * int mb_width= (width+15)>>4;
1135 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1136 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1138 * - encoding: Set by user.
1139 * - decoding: Set by libavcodec.
1141 int16_t (*motion_val[2])[2];
1144 * macroblock type table
1145 * mb_type_base + mb_width + 2
1146 * - encoding: Set by user.
1147 * - decoding: Set by libavcodec.
1153 * - encoding: unused
1154 * - decoding: Set by libavcodec.
1159 * motion reference frame index
1160 * the order in which these are stored can depend on the codec.
1161 * - encoding: Set by user.
1162 * - decoding: Set by libavcodec.
1164 int8_t *ref_index[2];
1167 * for some private data of the user
1168 * - encoding: unused
1169 * - decoding: Set by user.
1175 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1176 * - decoding: unused
1178 uint64_t error[AV_NUM_DATA_POINTERS];
1181 * type of the buffer (to keep track of who has to deallocate data[*])
1182 * - encoding: Set by the one who allocates it.
1183 * - decoding: Set by the one who allocates it.
1184 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1189 * When decoding, this signals how much the picture must be delayed.
1190 * extra_delay = repeat_pict / (2*fps)
1191 * - encoding: unused
1192 * - decoding: Set by libavcodec.
1197 * The content of the picture is interlaced.
1198 * - encoding: Set by user.
1199 * - decoding: Set by libavcodec. (default 0)
1201 int interlaced_frame;
1204 * If the content is interlaced, is top field displayed first.
1205 * - encoding: Set by user.
1206 * - decoding: Set by libavcodec.
1208 int top_field_first;
1211 * Tell user application that palette has changed from previous frame.
1212 * - encoding: ??? (no palette-enabled encoder yet)
1213 * - decoding: Set by libavcodec. (default 0).
1215 int palette_has_changed;
1218 * codec suggestion on buffer type if != 0
1219 * - encoding: unused
1220 * - decoding: Set by libavcodec. (before get_buffer() call)).
1226 * - encoding: Set by user.
1227 * - decoding: Set by libavcodec.
1229 AVPanScan *pan_scan;
1232 * reordered opaque 64bit (generally an integer or a double precision float
1233 * PTS but can be anything).
1234 * The user sets AVCodecContext.reordered_opaque to represent the input at
1236 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1237 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1238 * @deprecated in favor of pkt_pts
1239 * - encoding: unused
1240 * - decoding: Read by user.
1242 int64_t reordered_opaque;
1245 * hardware accelerator private data (FFmpeg-allocated)
1246 * - encoding: unused
1247 * - decoding: Set by libavcodec
1249 void *hwaccel_picture_private;
1252 * the AVCodecContext which ff_thread_get_buffer() was last called on
1253 * - encoding: Set by libavcodec.
1254 * - decoding: Set by libavcodec.
1256 struct AVCodecContext *owner;
1259 * used by multithreading to store frame-specific info
1260 * - encoding: Set by libavcodec.
1261 * - decoding: Set by libavcodec.
1263 void *thread_opaque;
1266 * log2 of the size of the block which a single vector in motion_val represents:
1267 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1268 * - encoding: unused
1269 * - decoding: Set by libavcodec.
1271 uint8_t motion_subsample_log2;
1274 * Sample rate of the audio data.
1276 * - encoding: unused
1277 * - decoding: read by user
1282 * Channel layout of the audio data.
1284 * - encoding: unused
1285 * - decoding: read by user.
1287 uint64_t channel_layout;
1290 * frame timestamp estimated using various heuristics, in stream time base
1291 * Code outside libavcodec should access this field using:
1292 * av_frame_get_best_effort_timestamp(frame)
1293 * - encoding: unused
1294 * - decoding: set by libavcodec, read by user.
1296 int64_t best_effort_timestamp;
1299 * reordered pos from the last AVPacket that has been input into the decoder
1300 * Code outside libavcodec should access this field using:
1301 * av_frame_get_pkt_pos(frame)
1302 * - encoding: unused
1303 * - decoding: Read by user.
1308 * duration of the corresponding packet, expressed in
1309 * AVStream->time_base units, 0 if unknown.
1310 * Code outside libavcodec should access this field using:
1311 * av_frame_get_pkt_duration(frame)
1312 * - encoding: unused
1313 * - decoding: Read by user.
1315 int64_t pkt_duration;
1319 * Code outside libavcodec should access this field using:
1320 * av_frame_get_metadata(frame)
1321 * - encoding: Set by user.
1322 * - decoding: Set by libavcodec.
1324 AVDictionary *metadata;
1328 * Accessors for some AVFrame fields.
1329 * The position of these field in the structure is not part of the ABI,
1330 * they should not be accessed directly outside libavcodec.
1332 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1333 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1334 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1335 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1336 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1337 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1338 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1339 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1340 int av_frame_get_sample_rate (const AVFrame *frame);
1341 void av_frame_set_sample_rate (AVFrame *frame, int val);
1342 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1343 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1345 struct AVCodecInternal;
1349 AV_FIELD_PROGRESSIVE,
1350 AV_FIELD_TT, //< Top coded_first, top displayed first
1351 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1352 AV_FIELD_TB, //< Top coded first, bottom displayed first
1353 AV_FIELD_BT, //< Bottom coded first, top displayed first
1357 * main external API structure.
1358 * New fields can be added to the end with minor version bumps.
1359 * Removal, reordering and changes to existing fields require a major
1361 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1363 * sizeof(AVCodecContext) must not be used outside libav*.
1365 typedef struct AVCodecContext {
1367 * information on struct for av_log
1368 * - set by avcodec_alloc_context3
1370 const AVClass *av_class;
1371 int log_level_offset;
1373 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1374 struct AVCodec *codec;
1375 char codec_name[32];
1376 enum CodecID codec_id; /* see CODEC_ID_xxx */
1379 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1380 * This is used to work around some encoder bugs.
1381 * A demuxer should set this to what is stored in the field used to identify the codec.
1382 * If there are multiple such fields in a container then the demuxer should choose the one
1383 * which maximizes the information about the used codec.
1384 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1385 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1386 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1388 * - encoding: Set by user, if not then the default based on codec_id will be used.
1389 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1391 unsigned int codec_tag;
1394 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1395 * This is used to work around some encoder bugs.
1396 * - encoding: unused
1397 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1399 unsigned int stream_codec_tag;
1403 * @deprecated this field is unused
1405 attribute_deprecated int sub_id;
1411 * Private context used for internal data.
1413 * Unlike priv_data, this is not codec-specific. It is used in general
1414 * libavcodec functions.
1416 struct AVCodecInternal *internal;
1419 * Private data of the user, can be used to carry app specific stuff.
1420 * - encoding: Set by user.
1421 * - decoding: Set by user.
1426 * the average bitrate
1427 * - encoding: Set by user; unused for constant quantizer encoding.
1428 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1433 * number of bits the bitstream is allowed to diverge from the reference.
1434 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1435 * - encoding: Set by user; unused for constant quantizer encoding.
1436 * - decoding: unused
1438 int bit_rate_tolerance;
1441 * Global quality for codecs which cannot change it per frame.
1442 * This should be proportional to MPEG-1/2/4 qscale.
1443 * - encoding: Set by user.
1444 * - decoding: unused
1449 * - encoding: Set by user.
1450 * - decoding: unused
1452 int compression_level;
1453 #define FF_COMPRESSION_DEFAULT -1
1457 * - encoding: Set by user.
1458 * - decoding: Set by user.
1464 * - encoding: Set by user.
1465 * - decoding: Set by user.
1470 * some codecs need / can use extradata like Huffman tables.
1471 * mjpeg: Huffman tables
1472 * rv10: additional flags
1473 * mpeg4: global headers (they can be in the bitstream or here)
1474 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1475 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1476 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1477 * - encoding: Set/allocated/freed by libavcodec.
1478 * - decoding: Set/allocated/freed by user.
1484 * This is the fundamental unit of time (in seconds) in terms
1485 * of which frame timestamps are represented. For fixed-fps content,
1486 * timebase should be 1/framerate and timestamp increments should be
1488 * - encoding: MUST be set by user.
1489 * - decoding: Set by libavcodec.
1491 AVRational time_base;
1494 * For some codecs, the time base is closer to the field rate than the frame rate.
1495 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1496 * if no telecine is used ...
1498 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1500 int ticks_per_frame;
1503 * Encoding: Number of frames delay there will be from the encoder input to
1504 * the decoder output. (we assume the decoder matches the spec)
1505 * Decoding: Number of frames delay in addition to what a standard decoder
1506 * as specified in the spec would produce.
1509 * Number of frames the decoded output will be delayed relative to the
1513 * Number of "priming" samples added to the beginning of the stream
1514 * during encoding. The decoded output will be delayed by this many
1515 * samples relative to the input to the encoder. Note that this field is
1516 * purely informational and does not directly affect the pts output by
1517 * the encoder, which should always be based on the actual presentation
1518 * time, including any delay.
1520 * - encoding: Set by libavcodec.
1521 * - decoding: Set by libavcodec.
1528 * picture width / height.
1529 * - encoding: MUST be set by user.
1530 * - decoding: Set by libavcodec.
1531 * Note: For compatibility it is possible to set this instead of
1532 * coded_width/height before decoding.
1537 * Bitstream width / height, may be different from width/height if lowres enabled.
1538 * - encoding: unused
1539 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1541 int coded_width, coded_height;
1543 #define FF_ASPECT_EXTENDED 15
1546 * the number of pictures in a group of pictures, or 0 for intra_only
1547 * - encoding: Set by user.
1548 * - decoding: unused
1553 * Pixel format, see PIX_FMT_xxx.
1554 * May be set by the demuxer if known from headers.
1555 * May be overridden by the decoder if it knows better.
1556 * - encoding: Set by user.
1557 * - decoding: Set by user if known, overridden by libavcodec if known
1559 enum PixelFormat pix_fmt;
1562 * Motion estimation algorithm used for video coding.
1563 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1564 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1565 * - encoding: MUST be set by user.
1566 * - decoding: unused
1571 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1572 * decoder to draw a horizontal band. It improves cache usage. Not
1573 * all codecs can do that. You must check the codec capabilities
1575 * When multithreading is used, it may be called from multiple threads
1576 * at the same time; threads might draw different parts of the same AVFrame,
1577 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1579 * The function is also used by hardware acceleration APIs.
1580 * It is called at least once during frame decoding to pass
1581 * the data needed for hardware render.
1582 * In that mode instead of pixel data, AVFrame points to
1583 * a structure specific to the acceleration API. The application
1584 * reads the structure and can change some fields to indicate progress
1586 * - encoding: unused
1587 * - decoding: Set by user.
1588 * @param height the height of the slice
1589 * @param y the y position of the slice
1590 * @param type 1->top field, 2->bottom field, 3->frame
1591 * @param offset offset into the AVFrame.data from which the slice should be read
1593 void (*draw_horiz_band)(struct AVCodecContext *s,
1594 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1595 int y, int type, int height);
1598 * callback to negotiate the pixelFormat
1599 * @param fmt is the list of formats which are supported by the codec,
1600 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1601 * The first is always the native one.
1602 * @return the chosen format
1603 * - encoding: unused
1604 * - decoding: Set by user, if not set the native format will be chosen.
1606 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1609 * maximum number of B-frames between non-B-frames
1610 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1611 * - encoding: Set by user.
1612 * - decoding: unused
1617 * qscale factor between IP and B-frames
1618 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1619 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 float b_quant_factor;
1625 /** obsolete FIXME remove */
1627 #define FF_RC_STRATEGY_XVID 1
1629 int b_frame_strategy;
1631 #if FF_API_MPV_GLOBAL_OPTS
1633 * luma single coefficient elimination threshold
1634 * - encoding: Set by user.
1635 * - decoding: unused
1637 attribute_deprecated int luma_elim_threshold;
1640 * chroma single coeff elimination threshold
1641 * - encoding: Set by user.
1642 * - decoding: unused
1644 attribute_deprecated int chroma_elim_threshold;
1648 * qscale offset between IP and B-frames
1649 * - encoding: Set by user.
1650 * - decoding: unused
1652 float b_quant_offset;
1655 * Size of the frame reordering buffer in the decoder.
1656 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1657 * - encoding: Set by libavcodec.
1658 * - decoding: Set by libavcodec.
1663 * 0-> h263 quant 1-> mpeg quant
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * qscale factor between P and I-frames
1671 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1672 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1673 * - encoding: Set by user.
1674 * - decoding: unused
1676 float i_quant_factor;
1679 * qscale offset between P and I-frames
1680 * - encoding: Set by user.
1681 * - decoding: unused
1683 float i_quant_offset;
1686 * luminance masking (0-> disabled)
1687 * - encoding: Set by user.
1688 * - decoding: unused
1693 * temporary complexity masking (0-> disabled)
1694 * - encoding: Set by user.
1695 * - decoding: unused
1697 float temporal_cplx_masking;
1700 * spatial complexity masking (0-> disabled)
1701 * - encoding: Set by user.
1702 * - decoding: unused
1704 float spatial_cplx_masking;
1707 * p block masking (0-> disabled)
1708 * - encoding: Set by user.
1709 * - decoding: unused
1714 * darkness masking (0-> disabled)
1715 * - encoding: Set by user.
1716 * - decoding: unused
1722 * - encoding: Set by libavcodec.
1723 * - decoding: Set by user (or 0).
1727 * prediction method (needed for huffyuv)
1728 * - encoding: Set by user.
1729 * - decoding: unused
1731 int prediction_method;
1732 #define FF_PRED_LEFT 0
1733 #define FF_PRED_PLANE 1
1734 #define FF_PRED_MEDIAN 2
1737 * slice offsets in the frame in bytes
1738 * - encoding: Set/allocated by libavcodec.
1739 * - decoding: Set/allocated by user (or NULL).
1744 * sample aspect ratio (0 if unknown)
1745 * That is the width of a pixel divided by the height of the pixel.
1746 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1747 * - encoding: Set by user.
1748 * - decoding: Set by libavcodec.
1750 AVRational sample_aspect_ratio;
1753 * motion estimation comparison function
1754 * - encoding: Set by user.
1755 * - decoding: unused
1759 * subpixel motion estimation comparison function
1760 * - encoding: Set by user.
1761 * - decoding: unused
1765 * macroblock comparison function (not supported yet)
1766 * - encoding: Set by user.
1767 * - decoding: unused
1771 * interlaced DCT comparison function
1772 * - encoding: Set by user.
1773 * - decoding: unused
1776 #define FF_CMP_SAD 0
1777 #define FF_CMP_SSE 1
1778 #define FF_CMP_SATD 2
1779 #define FF_CMP_DCT 3
1780 #define FF_CMP_PSNR 4
1781 #define FF_CMP_BIT 5
1783 #define FF_CMP_ZERO 7
1784 #define FF_CMP_VSAD 8
1785 #define FF_CMP_VSSE 9
1786 #define FF_CMP_NSSE 10
1787 #define FF_CMP_W53 11
1788 #define FF_CMP_W97 12
1789 #define FF_CMP_DCTMAX 13
1790 #define FF_CMP_DCT264 14
1791 #define FF_CMP_CHROMA 256
1794 * ME diamond size & shape
1795 * - encoding: Set by user.
1796 * - decoding: unused
1801 * amount of previous MV predictors (2a+1 x 2a+1 square)
1802 * - encoding: Set by user.
1803 * - decoding: unused
1805 int last_predictor_count;
1808 * prepass for motion estimation
1809 * - encoding: Set by user.
1810 * - decoding: unused
1815 * motion estimation prepass comparison function
1816 * - encoding: Set by user.
1817 * - decoding: unused
1822 * ME prepass diamond size & shape
1823 * - encoding: Set by user.
1824 * - decoding: unused
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 int me_subpel_quality;
1836 * DTG active format information (additional aspect ratio
1837 * information only used in DVB MPEG-2 transport streams)
1840 * - encoding: unused
1841 * - decoding: Set by decoder.
1843 int dtg_active_format;
1844 #define FF_DTG_AFD_SAME 8
1845 #define FF_DTG_AFD_4_3 9
1846 #define FF_DTG_AFD_16_9 10
1847 #define FF_DTG_AFD_14_9 11
1848 #define FF_DTG_AFD_4_3_SP_14_9 13
1849 #define FF_DTG_AFD_16_9_SP_14_9 14
1850 #define FF_DTG_AFD_SP_4_3 15
1853 * maximum motion estimation search range in subpel units
1854 * If 0 then no limit.
1856 * - encoding: Set by user.
1857 * - decoding: unused
1862 * intra quantizer bias
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int intra_quant_bias;
1867 #define FF_DEFAULT_QUANT_BIAS 999999
1870 * inter quantizer bias
1871 * - encoding: Set by user.
1872 * - decoding: unused
1874 int inter_quant_bias;
1876 #if FF_API_COLOR_TABLE_ID
1879 * - encoding: unused
1880 * - decoding: Which clrtable should be used for 8bit RGB images.
1881 * Tables have to be stored somewhere. FIXME
1883 attribute_deprecated int color_table_id;
1888 * - encoding: unused
1889 * - decoding: Set by user.
1892 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1893 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1894 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1897 * XVideo Motion Acceleration
1898 * - encoding: forbidden
1899 * - decoding: set by decoder
1901 int xvmc_acceleration;
1904 * macroblock decision mode
1905 * - encoding: Set by user.
1906 * - decoding: unused
1909 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1910 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1911 #define FF_MB_DECISION_RD 2 ///< rate distortion
1914 * custom intra quantization matrix
1915 * - encoding: Set by user, can be NULL.
1916 * - decoding: Set by libavcodec.
1918 uint16_t *intra_matrix;
1921 * custom inter quantization matrix
1922 * - encoding: Set by user, can be NULL.
1923 * - decoding: Set by libavcodec.
1925 uint16_t *inter_matrix;
1928 * scene change detection threshold
1929 * 0 is default, larger means fewer detected scene changes.
1930 * - encoding: Set by user.
1931 * - decoding: unused
1933 int scenechange_threshold;
1936 * noise reduction strength
1937 * - encoding: Set by user.
1938 * - decoding: unused
1940 int noise_reduction;
1942 #if FF_API_INTER_THRESHOLD
1944 * @deprecated this field is unused
1946 attribute_deprecated int inter_threshold;
1949 #if FF_API_MPV_GLOBAL_OPTS
1951 * @deprecated use mpegvideo private options instead
1953 attribute_deprecated int quantizer_noise_shaping;
1957 * Motion estimation threshold below which no motion estimation is
1958 * performed, but instead the user specified motion vectors are used.
1960 * - encoding: Set by user.
1961 * - decoding: unused
1966 * Macroblock threshold below which the user specified macroblock types will be used.
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * precision of the intra DC coefficient - 8
1974 * - encoding: Set by user.
1975 * - decoding: unused
1977 int intra_dc_precision;
1980 * Number of macroblock rows at the top which are skipped.
1981 * - encoding: unused
1982 * - decoding: Set by user.
1987 * Number of macroblock rows at the bottom which are skipped.
1988 * - encoding: unused
1989 * - decoding: Set by user.
1994 * Border processing masking, raises the quantizer for mbs on the borders
1996 * - encoding: Set by user.
1997 * - decoding: unused
1999 float border_masking;
2002 * minimum MB lagrange multipler
2003 * - encoding: Set by user.
2004 * - decoding: unused
2009 * maximum MB lagrange multipler
2010 * - encoding: Set by user.
2011 * - decoding: unused
2017 * - encoding: Set by user.
2018 * - decoding: unused
2020 int me_penalty_compensation;
2024 * - encoding: Set by user.
2025 * - decoding: unused
2031 * - encoding: Set by user.
2032 * - decoding: unused
2038 * - encoding: Set by user.
2039 * - decoding: unused
2044 * number of reference frames
2045 * - encoding: Set by user.
2046 * - decoding: Set by lavc.
2051 * chroma qp offset from luma
2052 * - encoding: Set by user.
2053 * - decoding: unused
2058 * Multiplied by qscale for each frame and added to scene_change_score.
2059 * - encoding: Set by user.
2060 * - decoding: unused
2062 int scenechange_factor;
2066 * Note: Value depends upon the compare function used for fullpel ME.
2067 * - encoding: Set by user.
2068 * - decoding: unused
2073 * Adjust sensitivity of b_frame_strategy 1.
2074 * - encoding: Set by user.
2075 * - decoding: unused
2080 * Chromaticity coordinates of the source primaries.
2081 * - encoding: Set by user
2082 * - decoding: Set by libavcodec
2084 enum AVColorPrimaries color_primaries;
2087 * Color Transfer Characteristic.
2088 * - encoding: Set by user
2089 * - decoding: Set by libavcodec
2091 enum AVColorTransferCharacteristic color_trc;
2094 * YUV colorspace type.
2095 * - encoding: Set by user
2096 * - decoding: Set by libavcodec
2098 enum AVColorSpace colorspace;
2101 * MPEG vs JPEG YUV range.
2102 * - encoding: Set by user
2103 * - decoding: Set by libavcodec
2105 enum AVColorRange color_range;
2108 * This defines the location of chroma samples.
2109 * - encoding: Set by user
2110 * - decoding: Set by libavcodec
2112 enum AVChromaLocation chroma_sample_location;
2116 * Indicates number of picture subdivisions. Used for parallelized
2118 * - encoding: Set by user
2119 * - decoding: unused
2124 * - encoding: set by libavcodec
2125 * - decoding: Set by libavcodec
2127 enum AVFieldOrder field_order;
2130 int sample_rate; ///< samples per second
2131 int channels; ///< number of audio channels
2134 * audio sample format
2135 * - encoding: Set by user.
2136 * - decoding: Set by libavcodec.
2138 enum AVSampleFormat sample_fmt; ///< sample format
2140 /* The following data should not be initialized. */
2142 * Samples per packet, initialized when calling 'init'.
2147 * Frame counter, set by libavcodec.
2149 * - decoding: total number of frames returned from the decoder so far.
2150 * - encoding: total number of frames passed to the encoder so far.
2152 * @note the counter is not incremented if encoding/decoding resulted in
2158 * number of bytes per packet if constant and known or 0
2159 * Used by some WAV based audio codecs.
2164 * Audio cutoff bandwidth (0 means "automatic")
2165 * - encoding: Set by user.
2166 * - decoding: unused
2170 #if FF_API_REQUEST_CHANNELS
2172 * Decoder should decode to this many channels if it can (0 for default)
2173 * - encoding: unused
2174 * - decoding: Set by user.
2175 * @deprecated Deprecated in favor of request_channel_layout.
2177 int request_channels;
2181 * Audio channel layout.
2182 * - encoding: set by user.
2183 * - decoding: set by user, may be overwritten by libavcodec.
2185 uint64_t channel_layout;
2188 * Request decoder to use this channel layout if it can (0 for default)
2189 * - encoding: unused
2190 * - decoding: Set by user.
2192 uint64_t request_channel_layout;
2195 * Type of service that the audio stream conveys.
2196 * - encoding: Set by user.
2197 * - decoding: Set by libavcodec.
2199 enum AVAudioServiceType audio_service_type;
2202 * desired sample format
2203 * - encoding: Not used.
2204 * - decoding: Set by user.
2205 * Decoder will decode to this format if it can.
2207 enum AVSampleFormat request_sample_fmt;
2210 * Called at the beginning of each frame to get a buffer for it.
2212 * The function will set AVFrame.data[], AVFrame.linesize[].
2213 * AVFrame.extended_data[] must also be set, but it should be the same as
2214 * AVFrame.data[] except for planar audio with more channels than can fit
2215 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2216 * many data pointers as it can hold.
2218 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2219 * avcodec_default_get_buffer() instead of providing buffers allocated by
2222 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2223 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2224 * but if get_buffer() is overridden then alignment considerations should
2225 * be taken into account.
2227 * @see avcodec_default_get_buffer()
2231 * If pic.reference is set then the frame will be read later by libavcodec.
2232 * avcodec_align_dimensions2() should be used to find the required width and
2233 * height, as they normally need to be rounded up to the next multiple of 16.
2235 * If frame multithreading is used and thread_safe_callbacks is set,
2236 * it may be called from a different thread, but not from more than one at
2237 * once. Does not need to be reentrant.
2239 * @see release_buffer(), reget_buffer()
2240 * @see avcodec_align_dimensions2()
2244 * Decoders request a buffer of a particular size by setting
2245 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2246 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2247 * to a smaller value in the output frame.
2249 * Decoders cannot use the buffer after returning from
2250 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2251 * is assumed to be released immediately upon return.
2253 * As a convenience, av_samples_get_buffer_size() and
2254 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2255 * functions to find the required data size and to fill data pointers and
2256 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2257 * since all planes must be the same size.
2259 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2261 * - encoding: unused
2262 * - decoding: Set by libavcodec, user can override.
2264 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2267 * Called to release buffers which were allocated with get_buffer.
2268 * A released buffer can be reused in get_buffer().
2269 * pic.data[*] must be set to NULL.
2270 * May be called from a different thread if frame multithreading is used,
2271 * but not by more than one thread at once, so does not need to be reentrant.
2272 * - encoding: unused
2273 * - decoding: Set by libavcodec, user can override.
2275 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2278 * Called at the beginning of a frame to get cr buffer for it.
2279 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2280 * libavcodec will pass previous buffer in pic, function should return
2281 * same buffer or new buffer with old frame "painted" into it.
2282 * If pic.data[0] == NULL must behave like get_buffer().
2283 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2284 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2286 * - encoding: unused
2287 * - decoding: Set by libavcodec, user can override.
2289 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2292 /* - encoding parameters */
2293 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2294 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2298 * - encoding: Set by user.
2299 * - decoding: unused
2305 * - encoding: Set by user.
2306 * - decoding: unused
2311 * maximum quantizer difference between frames
2312 * - encoding: Set by user.
2313 * - decoding: unused
2318 * ratecontrol qmin qmax limiting method
2319 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2320 * - encoding: Set by user.
2321 * - decoding: unused
2329 * decoder bitstream buffer size
2330 * - encoding: Set by user.
2331 * - decoding: unused
2336 * ratecontrol override, see RcOverride
2337 * - encoding: Allocated/set/freed by user.
2338 * - decoding: unused
2340 int rc_override_count;
2341 RcOverride *rc_override;
2344 * rate control equation
2345 * - encoding: Set by user
2346 * - decoding: unused
2352 * - encoding: Set by user.
2353 * - decoding: unused
2359 * - encoding: Set by user.
2360 * - decoding: unused
2364 float rc_buffer_aggressivity;
2367 * initial complexity for pass1 ratecontrol
2368 * - encoding: Set by user.
2369 * - decoding: unused
2371 float rc_initial_cplx;
2374 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2375 * - encoding: Set by user.
2376 * - decoding: unused.
2378 float rc_max_available_vbv_use;
2381 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2382 * - encoding: Set by user.
2383 * - decoding: unused.
2385 float rc_min_vbv_overflow_use;
2388 * Number of bits which should be loaded into the rc buffer before decoding starts.
2389 * - encoding: Set by user.
2390 * - decoding: unused
2392 int rc_initial_buffer_occupancy;
2394 #define FF_CODER_TYPE_VLC 0
2395 #define FF_CODER_TYPE_AC 1
2396 #define FF_CODER_TYPE_RAW 2
2397 #define FF_CODER_TYPE_RLE 3
2398 #define FF_CODER_TYPE_DEFLATE 4
2401 * - encoding: Set by user.
2402 * - decoding: unused
2408 * - encoding: Set by user.
2409 * - decoding: unused
2414 * minimum Lagrange multipler
2415 * - encoding: Set by user.
2416 * - decoding: unused
2421 * maximum Lagrange multipler
2422 * - encoding: Set by user.
2423 * - decoding: unused
2428 * frame skip threshold
2429 * - encoding: Set by user.
2430 * - decoding: unused
2432 int frame_skip_threshold;
2436 * - encoding: Set by user.
2437 * - decoding: unused
2439 int frame_skip_factor;
2442 * frame skip exponent
2443 * - encoding: Set by user.
2444 * - decoding: unused
2449 * frame skip comparison function
2450 * - encoding: Set by user.
2451 * - decoding: unused
2456 * trellis RD quantization
2457 * - encoding: Set by user.
2458 * - decoding: unused
2463 * - encoding: Set by user.
2464 * - decoding: unused
2466 int min_prediction_order;
2469 * - encoding: Set by user.
2470 * - decoding: unused
2472 int max_prediction_order;
2475 * GOP timecode frame start number
2476 * - encoding: Set by user, in non drop frame format
2477 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2479 int64_t timecode_frame_start;
2481 /* The RTP callback: This function is called */
2482 /* every time the encoder has a packet to send. */
2483 /* It depends on the encoder if the data starts */
2484 /* with a Start Code (it should). H.263 does. */
2485 /* mb_nb contains the number of macroblocks */
2486 /* encoded in the RTP payload. */
2487 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2489 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2490 /* do its best to deliver a chunk with size */
2491 /* below rtp_payload_size, the chunk will start */
2492 /* with a start code on some codecs like H.263. */
2493 /* This doesn't take account of any particular */
2494 /* headers inside the transmitted RTP payload. */
2496 /* statistics, used for 2-pass encoding */
2507 * number of bits used for the previously encoded frame
2508 * - encoding: Set by libavcodec.
2509 * - decoding: unused
2514 * pass1 encoding statistics output buffer
2515 * - encoding: Set by libavcodec.
2516 * - decoding: unused
2521 * pass2 encoding statistics input buffer
2522 * Concatenated stuff from stats_out of pass1 should be placed here.
2523 * - encoding: Allocated/set/freed by user.
2524 * - decoding: unused
2529 * Work around bugs in encoders which sometimes cannot be detected automatically.
2530 * - encoding: Set by user
2531 * - decoding: Set by user
2533 int workaround_bugs;
2534 #define FF_BUG_AUTODETECT 1 ///< autodetection
2535 #define FF_BUG_OLD_MSMPEG4 2
2536 #define FF_BUG_XVID_ILACE 4
2537 #define FF_BUG_UMP4 8
2538 #define FF_BUG_NO_PADDING 16
2539 #define FF_BUG_AMV 32
2540 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2541 #define FF_BUG_QPEL_CHROMA 64
2542 #define FF_BUG_STD_QPEL 128
2543 #define FF_BUG_QPEL_CHROMA2 256
2544 #define FF_BUG_DIRECT_BLOCKSIZE 512
2545 #define FF_BUG_EDGE 1024
2546 #define FF_BUG_HPEL_CHROMA 2048
2547 #define FF_BUG_DC_CLIP 4096
2548 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2549 #define FF_BUG_TRUNCATED 16384
2552 * strictly follow the standard (MPEG4, ...).
2553 * - encoding: Set by user.
2554 * - decoding: Set by user.
2555 * Setting this to STRICT or higher means the encoder and decoder will
2556 * generally do stupid things, whereas setting it to unofficial or lower
2557 * will mean the encoder might produce output that is not supported by all
2558 * spec-compliant decoders. Decoders don't differentiate between normal,
2559 * unofficial and experimental (that is, they always try to decode things
2560 * when they can) unless they are explicitly asked to behave stupidly
2561 * (=strictly conform to the specs)
2563 int strict_std_compliance;
2564 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2565 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2566 #define FF_COMPLIANCE_NORMAL 0
2567 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2568 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2571 * error concealment flags
2572 * - encoding: unused
2573 * - decoding: Set by user.
2575 int error_concealment;
2576 #define FF_EC_GUESS_MVS 1
2577 #define FF_EC_DEBLOCK 2
2581 * - encoding: Set by user.
2582 * - decoding: Set by user.
2585 #define FF_DEBUG_PICT_INFO 1
2586 #define FF_DEBUG_RC 2
2587 #define FF_DEBUG_BITSTREAM 4
2588 #define FF_DEBUG_MB_TYPE 8
2589 #define FF_DEBUG_QP 16
2590 #define FF_DEBUG_MV 32
2591 #define FF_DEBUG_DCT_COEFF 0x00000040
2592 #define FF_DEBUG_SKIP 0x00000080
2593 #define FF_DEBUG_STARTCODE 0x00000100
2594 #define FF_DEBUG_PTS 0x00000200
2595 #define FF_DEBUG_ER 0x00000400
2596 #define FF_DEBUG_MMCO 0x00000800
2597 #define FF_DEBUG_BUGS 0x00001000
2598 #define FF_DEBUG_VIS_QP 0x00002000
2599 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2600 #define FF_DEBUG_BUFFERS 0x00008000
2601 #define FF_DEBUG_THREADS 0x00010000
2605 * - encoding: Set by user.
2606 * - decoding: Set by user.
2609 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2610 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2611 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2614 * Error recognition; may misdetect some more or less valid parts as errors.
2615 * - encoding: unused
2616 * - decoding: Set by user.
2618 int err_recognition;
2619 #define AV_EF_CRCCHECK (1<<0)
2620 #define AV_EF_BITSTREAM (1<<1)
2621 #define AV_EF_BUFFER (1<<2)
2622 #define AV_EF_EXPLODE (1<<3)
2624 #define AV_EF_CAREFUL (1<<16)
2625 #define AV_EF_COMPLIANT (1<<17)
2626 #define AV_EF_AGGRESSIVE (1<<18)
2630 * opaque 64bit number (generally a PTS) that will be reordered and
2631 * output in AVFrame.reordered_opaque
2632 * @deprecated in favor of pkt_pts
2633 * - encoding: unused
2634 * - decoding: Set by user.
2636 int64_t reordered_opaque;
2639 * Hardware accelerator in use
2640 * - encoding: unused.
2641 * - decoding: Set by libavcodec
2643 struct AVHWAccel *hwaccel;
2646 * Hardware accelerator context.
2647 * For some hardware accelerators, a global context needs to be
2648 * provided by the user. In that case, this holds display-dependent
2649 * data FFmpeg cannot instantiate itself. Please refer to the
2650 * FFmpeg HW accelerator documentation to know how to fill this
2651 * is. e.g. for VA API, this is a struct vaapi_context.
2652 * - encoding: unused
2653 * - decoding: Set by user
2655 void *hwaccel_context;
2659 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2660 * - decoding: unused
2662 uint64_t error[AV_NUM_DATA_POINTERS];
2665 * DCT algorithm, see FF_DCT_* below
2666 * - encoding: Set by user.
2667 * - decoding: unused
2670 #define FF_DCT_AUTO 0
2671 #define FF_DCT_FASTINT 1
2672 #define FF_DCT_INT 2
2673 #define FF_DCT_MMX 3
2674 #define FF_DCT_ALTIVEC 5
2675 #define FF_DCT_FAAN 6
2678 * IDCT algorithm, see FF_IDCT_* below.
2679 * - encoding: Set by user.
2680 * - decoding: Set by user.
2683 #define FF_IDCT_AUTO 0
2684 #define FF_IDCT_INT 1
2685 #define FF_IDCT_SIMPLE 2
2686 #define FF_IDCT_SIMPLEMMX 3
2687 #define FF_IDCT_LIBMPEG2MMX 4
2688 #define FF_IDCT_MMI 5
2689 #define FF_IDCT_ARM 7
2690 #define FF_IDCT_ALTIVEC 8
2691 #define FF_IDCT_SH4 9
2692 #define FF_IDCT_SIMPLEARM 10
2693 #define FF_IDCT_H264 11
2694 #define FF_IDCT_VP3 12
2695 #define FF_IDCT_IPP 13
2696 #define FF_IDCT_XVIDMMX 14
2697 #define FF_IDCT_CAVS 15
2698 #define FF_IDCT_SIMPLEARMV5TE 16
2699 #define FF_IDCT_SIMPLEARMV6 17
2700 #define FF_IDCT_SIMPLEVIS 18
2701 #define FF_IDCT_WMV2 19
2702 #define FF_IDCT_FAAN 20
2703 #define FF_IDCT_EA 21
2704 #define FF_IDCT_SIMPLENEON 22
2705 #define FF_IDCT_SIMPLEALPHA 23
2706 #define FF_IDCT_BINK 24
2711 * @deprecated use av_set_cpu_flags_mask() instead.
2713 attribute_deprecated unsigned dsp_mask;
2717 * bits per sample/pixel from the demuxer (needed for huffyuv).
2718 * - encoding: Set by libavcodec.
2719 * - decoding: Set by user.
2721 int bits_per_coded_sample;
2724 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2725 * - encoding: set by user.
2726 * - decoding: set by libavcodec.
2728 int bits_per_raw_sample;
2731 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2732 * - encoding: unused
2733 * - decoding: Set by user.
2738 * the picture in the bitstream
2739 * - encoding: Set by libavcodec.
2740 * - decoding: Set by libavcodec.
2742 AVFrame *coded_frame;
2746 * is used to decide how many independent tasks should be passed to execute()
2747 * - encoding: Set by user.
2748 * - decoding: Set by user.
2753 * Which multithreading methods to use.
2754 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2755 * so clients which cannot provide future frames should not use it.
2757 * - encoding: Set by user, otherwise the default is used.
2758 * - decoding: Set by user, otherwise the default is used.
2761 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2762 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2765 * Which multithreading methods are in use by the codec.
2766 * - encoding: Set by libavcodec.
2767 * - decoding: Set by libavcodec.
2769 int active_thread_type;
2772 * Set by the client if its custom get_buffer() callback can be called
2773 * synchronously from another thread, which allows faster multithreaded decoding.
2774 * draw_horiz_band() will be called from other threads regardless of this setting.
2775 * Ignored if the default get_buffer() is used.
2776 * - encoding: Set by user.
2777 * - decoding: Set by user.
2779 int thread_safe_callbacks;
2782 * The codec may call this to execute several independent things.
2783 * It will return only after finishing all tasks.
2784 * The user may replace this with some multithreaded implementation,
2785 * the default implementation will execute the parts serially.
2786 * @param count the number of things to execute
2787 * - encoding: Set by libavcodec, user can override.
2788 * - decoding: Set by libavcodec, user can override.
2790 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2793 * The codec may call this to execute several independent things.
2794 * It will return only after finishing all tasks.
2795 * The user may replace this with some multithreaded implementation,
2796 * the default implementation will execute the parts serially.
2797 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2798 * @param c context passed also to func
2799 * @param count the number of things to execute
2800 * @param arg2 argument passed unchanged to func
2801 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2802 * @param func function that will be called count times, with jobnr from 0 to count-1.
2803 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2804 * two instances of func executing at the same time will have the same threadnr.
2805 * @return always 0 currently, but code should handle a future improvement where when any call to func
2806 * returns < 0 no further calls to func may be done and < 0 is returned.
2807 * - encoding: Set by libavcodec, user can override.
2808 * - decoding: Set by libavcodec, user can override.
2810 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2814 * Can be used by execute() to store some per AVCodecContext stuff.
2815 * - encoding: set by execute()
2816 * - decoding: set by execute()
2818 void *thread_opaque;
2821 * noise vs. sse weight for the nsse comparsion function
2822 * - encoding: Set by user.
2823 * - decoding: unused
2829 * - encoding: Set by user.
2830 * - decoding: Set by libavcodec.
2833 #define FF_PROFILE_UNKNOWN -99
2834 #define FF_PROFILE_RESERVED -100
2836 #define FF_PROFILE_AAC_MAIN 0
2837 #define FF_PROFILE_AAC_LOW 1
2838 #define FF_PROFILE_AAC_SSR 2
2839 #define FF_PROFILE_AAC_LTP 3
2840 #define FF_PROFILE_AAC_HE 4
2841 #define FF_PROFILE_AAC_HE_V2 28
2842 #define FF_PROFILE_AAC_LD 22
2843 #define FF_PROFILE_AAC_ELD 38
2845 #define FF_PROFILE_DTS 20
2846 #define FF_PROFILE_DTS_ES 30
2847 #define FF_PROFILE_DTS_96_24 40
2848 #define FF_PROFILE_DTS_HD_HRA 50
2849 #define FF_PROFILE_DTS_HD_MA 60
2851 #define FF_PROFILE_MPEG2_422 0
2852 #define FF_PROFILE_MPEG2_HIGH 1
2853 #define FF_PROFILE_MPEG2_SS 2
2854 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2855 #define FF_PROFILE_MPEG2_MAIN 4
2856 #define FF_PROFILE_MPEG2_SIMPLE 5
2858 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2859 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2861 #define FF_PROFILE_H264_BASELINE 66
2862 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2863 #define FF_PROFILE_H264_MAIN 77
2864 #define FF_PROFILE_H264_EXTENDED 88
2865 #define FF_PROFILE_H264_HIGH 100
2866 #define FF_PROFILE_H264_HIGH_10 110
2867 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2868 #define FF_PROFILE_H264_HIGH_422 122
2869 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2870 #define FF_PROFILE_H264_HIGH_444 144
2871 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2872 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2873 #define FF_PROFILE_H264_CAVLC_444 44
2875 #define FF_PROFILE_VC1_SIMPLE 0
2876 #define FF_PROFILE_VC1_MAIN 1
2877 #define FF_PROFILE_VC1_COMPLEX 2
2878 #define FF_PROFILE_VC1_ADVANCED 3
2880 #define FF_PROFILE_MPEG4_SIMPLE 0
2881 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2882 #define FF_PROFILE_MPEG4_CORE 2
2883 #define FF_PROFILE_MPEG4_MAIN 3
2884 #define FF_PROFILE_MPEG4_N_BIT 4
2885 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2886 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2887 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2888 #define FF_PROFILE_MPEG4_HYBRID 8
2889 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2890 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2891 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2892 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2893 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2894 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2895 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2899 * - encoding: Set by user.
2900 * - decoding: Set by libavcodec.
2903 #define FF_LEVEL_UNKNOWN -99
2907 * - encoding: unused
2908 * - decoding: Set by user.
2910 enum AVDiscard skip_loop_filter;
2914 * - encoding: unused
2915 * - decoding: Set by user.
2917 enum AVDiscard skip_idct;
2921 * - encoding: unused
2922 * - decoding: Set by user.
2924 enum AVDiscard skip_frame;
2927 * Header containing style information for text subtitles.
2928 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2929 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2930 * the Format line following. It shouldn't include any Dialogue line.
2931 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2932 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2934 uint8_t *subtitle_header;
2935 int subtitle_header_size;
2938 * Simulates errors in the bitstream to test error concealment.
2939 * - encoding: Set by user.
2940 * - decoding: unused
2945 * Current packet as passed into the decoder, to avoid having
2946 * to pass the packet into every function. Currently only valid
2947 * inside lavc and get/release_buffer callbacks.
2948 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2949 * - encoding: unused
2954 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2955 * Used for compliant TS muxing.
2956 * - encoding: Set by libavcodec.
2957 * - decoding: unused.
2962 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
2963 * Code outside libavcodec should access this field using:
2964 * avcodec_set_pkt_timebase(avctx)
2965 * - encoding unused.
2966 * - decodimg set by user
2968 AVRational pkt_timebase;
2971 * Current statistics for PTS correction.
2972 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2973 * - encoding: unused
2975 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2976 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2977 int64_t pts_correction_last_pts; /// PTS of the last frame
2978 int64_t pts_correction_last_dts; /// DTS of the last frame
2981 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
2982 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
2987 typedef struct AVProfile {
2989 const char *name; ///< short name for the profile
2992 typedef struct AVCodecDefault AVCodecDefault;
2997 typedef struct AVCodec {
2999 * Name of the codec implementation.
3000 * The name is globally unique among encoders and among decoders (but an
3001 * encoder and a decoder can share the same name).
3002 * This is the primary way to find a codec from the user perspective.
3006 * Descriptive name for the codec, meant to be more human readable than name.
3007 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3009 const char *long_name;
3010 enum AVMediaType type;
3013 * Codec capabilities.
3017 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3018 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3019 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3020 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3021 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3022 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3023 const AVClass *priv_class; ///< AVClass for the private context
3024 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3026 /*****************************************************************
3027 * No fields below this line are part of the public API. They
3028 * may not be used outside of libavcodec and can be changed and
3030 * New public fields should be added right above.
3031 *****************************************************************
3034 struct AVCodec *next;
3036 * @name Frame-level threading support functions
3040 * If defined, called on thread contexts when they are created.
3041 * If the codec allocates writable tables in init(), re-allocate them here.
3042 * priv_data will be set to a copy of the original.
3044 int (*init_thread_copy)(AVCodecContext *);
3046 * Copy necessary context variables from a previous thread context to the current one.
3047 * If not defined, the next thread will start automatically; otherwise, the codec
3048 * must call ff_thread_finish_setup().
3050 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3052 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3056 * Private codec-specific defaults.
3058 const AVCodecDefault *defaults;
3061 * Initialize codec static data, called from avcodec_register().
3063 void (*init_static_data)(struct AVCodec *codec);
3065 int (*init)(AVCodecContext *);
3066 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3068 * Encode data to an AVPacket.
3070 * @param avctx codec context
3071 * @param avpkt output AVPacket (may contain a user-provided buffer)
3072 * @param[in] frame AVFrame containing the raw data to be encoded
3073 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3074 * non-empty packet was returned in avpkt.
3075 * @return 0 on success, negative error code on failure
3077 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3078 int *got_packet_ptr);
3079 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3080 int (*close)(AVCodecContext *);
3083 * Will be called when seeking
3085 void (*flush)(AVCodecContext *);
3091 typedef struct AVHWAccel {
3093 * Name of the hardware accelerated codec.
3094 * The name is globally unique among encoders and among decoders (but an
3095 * encoder and a decoder can share the same name).
3100 * Type of codec implemented by the hardware accelerator.
3102 * See AVMEDIA_TYPE_xxx
3104 enum AVMediaType type;
3107 * Codec implemented by the hardware accelerator.
3114 * Supported pixel format.
3116 * Only hardware accelerated formats are supported here.
3118 enum PixelFormat pix_fmt;
3121 * Hardware accelerated codec capabilities.
3122 * see FF_HWACCEL_CODEC_CAP_*
3126 struct AVHWAccel *next;
3129 * Called at the beginning of each frame or field picture.
3131 * Meaningful frame information (codec specific) is guaranteed to
3132 * be parsed at this point. This function is mandatory.
3134 * Note that buf can be NULL along with buf_size set to 0.
3135 * Otherwise, this means the whole frame is available at this point.
3137 * @param avctx the codec context
3138 * @param buf the frame data buffer base
3139 * @param buf_size the size of the frame in bytes
3140 * @return zero if successful, a negative value otherwise
3142 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3145 * Callback for each slice.
3147 * Meaningful slice information (codec specific) is guaranteed to
3148 * be parsed at this point. This function is mandatory.
3150 * @param avctx the codec context
3151 * @param buf the slice data buffer base
3152 * @param buf_size the size of the slice in bytes
3153 * @return zero if successful, a negative value otherwise
3155 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3158 * Called at the end of each frame or field picture.
3160 * The whole picture is parsed at this point and can now be sent
3161 * to the hardware accelerator. This function is mandatory.
3163 * @param avctx the codec context
3164 * @return zero if successful, a negative value otherwise
3166 int (*end_frame)(AVCodecContext *avctx);
3169 * Size of HW accelerator private data.
3171 * Private data is allocated with av_mallocz() before
3172 * AVCodecContext.get_buffer() and deallocated after
3173 * AVCodecContext.release_buffer().
3179 * @defgroup lavc_picture AVPicture
3181 * Functions for working with AVPicture
3186 * four components are given, that's all.
3187 * the last component is alpha
3189 typedef struct AVPicture {
3190 uint8_t *data[AV_NUM_DATA_POINTERS];
3191 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3198 enum AVSubtitleType {
3201 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3204 * Plain text, the text field must be set by the decoder and is
3205 * authoritative. ass and pict fields may contain approximations.
3210 * Formatted text, the ass field must be set by the decoder and is
3211 * authoritative. pict and text fields may contain approximations.
3216 typedef struct AVSubtitleRect {
3217 int x; ///< top left corner of pict, undefined when pict is not set
3218 int y; ///< top left corner of pict, undefined when pict is not set
3219 int w; ///< width of pict, undefined when pict is not set
3220 int h; ///< height of pict, undefined when pict is not set
3221 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3224 * data+linesize for the bitmap of this subtitle.
3225 * can be set for text/ass as well once they where rendered
3228 enum AVSubtitleType type;
3230 char *text; ///< 0 terminated plain UTF-8 text
3233 * 0 terminated ASS/SSA compatible event line.
3234 * The presentation of this is unaffected by the other values in this
3240 * 1 indicates this subtitle is a forced subtitle.
3241 * A forced subtitle should be displayed even when subtitles are hidden.
3246 typedef struct AVSubtitle {
3247 uint16_t format; /* 0 = graphics */
3248 uint32_t start_display_time; /* relative to packet pts, in ms */
3249 uint32_t end_display_time; /* relative to packet pts, in ms */
3251 AVSubtitleRect **rects;
3252 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3256 * If c is NULL, returns the first registered codec,
3257 * if c is non-NULL, returns the next registered codec after c,
3258 * or NULL if c is the last one.
3260 AVCodec *av_codec_next(AVCodec *c);
3263 * Return the LIBAVCODEC_VERSION_INT constant.
3265 unsigned avcodec_version(void);
3268 * Return the libavcodec build-time configuration.
3270 const char *avcodec_configuration(void);
3273 * Return the libavcodec license.
3275 const char *avcodec_license(void);
3278 * Register the codec codec and initialize libavcodec.
3280 * @warning either this function or avcodec_register_all() must be called
3281 * before any other libavcodec functions.
3283 * @see avcodec_register_all()
3285 void avcodec_register(AVCodec *codec);
3288 * Register all the codecs, parsers and bitstream filters which were enabled at
3289 * configuration time. If you do not call this function you can select exactly
3290 * which formats you want to support, by using the individual registration
3293 * @see avcodec_register
3294 * @see av_register_codec_parser
3295 * @see av_register_bitstream_filter
3297 void avcodec_register_all(void);
3300 #if FF_API_ALLOC_CONTEXT
3302 * Allocate an AVCodecContext and set its fields to default values. The
3303 * resulting struct can be deallocated by simply calling av_free().
3305 * @return An AVCodecContext filled with default values or NULL on failure.
3306 * @see avcodec_get_context_defaults
3308 * @deprecated use avcodec_alloc_context3()
3310 attribute_deprecated
3311 AVCodecContext *avcodec_alloc_context(void);
3313 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3314 * we WILL change its arguments and name a few times! */
3315 attribute_deprecated
3316 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3319 * Set the fields of the given AVCodecContext to default values.
3321 * @param s The AVCodecContext of which the fields should be set to default values.
3322 * @deprecated use avcodec_get_context_defaults3
3324 attribute_deprecated
3325 void avcodec_get_context_defaults(AVCodecContext *s);
3327 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3328 * we WILL change its arguments and name a few times! */
3329 attribute_deprecated
3330 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3334 * Allocate an AVCodecContext and set its fields to default values. The
3335 * resulting struct can be deallocated by calling avcodec_close() on it followed
3338 * @param codec if non-NULL, allocate private data and initialize defaults
3339 * for the given codec. It is illegal to then call avcodec_open2()
3340 * with a different codec.
3341 * If NULL, then the codec-specific defaults won't be initialized,
3342 * which may result in suboptimal default settings (this is
3343 * important mainly for encoders, e.g. libx264).
3345 * @return An AVCodecContext filled with default values or NULL on failure.
3346 * @see avcodec_get_context_defaults
3348 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3351 * Set the fields of the given AVCodecContext to default values corresponding
3352 * to the given codec (defaults may be codec-dependent).
3354 * Do not call this function if a non-NULL codec has been passed
3355 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3356 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3357 * different codec on this AVCodecContext.
3359 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3362 * Get the AVClass for AVCodecContext. It can be used in combination with
3363 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3365 * @see av_opt_find().
3367 const AVClass *avcodec_get_class(void);
3370 * Get the AVClass for AVFrame. It can be used in combination with
3371 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3373 * @see av_opt_find().
3375 const AVClass *avcodec_get_frame_class(void);
3378 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3379 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3381 * @see av_opt_find().
3383 const AVClass *avcodec_get_subtitle_rect_class(void);
3386 * Copy the settings of the source AVCodecContext into the destination
3387 * AVCodecContext. The resulting destination codec context will be
3388 * unopened, i.e. you are required to call avcodec_open2() before you
3389 * can use this AVCodecContext to decode/encode video/audio data.
3391 * @param dest target codec context, should be initialized with
3392 * avcodec_alloc_context3(), but otherwise uninitialized
3393 * @param src source codec context
3394 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3396 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3399 * Allocate an AVFrame and set its fields to default values. The resulting
3400 * struct can be deallocated by simply calling av_free().
3402 * @return An AVFrame filled with default values or NULL on failure.
3403 * @see avcodec_get_frame_defaults
3405 AVFrame *avcodec_alloc_frame(void);
3408 * Set the fields of the given AVFrame to default values.
3410 * @param pic The AVFrame of which the fields should be set to default values.
3412 void avcodec_get_frame_defaults(AVFrame *pic);
3414 #if FF_API_AVCODEC_OPEN
3416 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3417 * function the context has to be allocated.
3419 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3420 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3421 * retrieving a codec.
3423 * @warning This function is not thread safe!
3426 * avcodec_register_all();
3427 * codec = avcodec_find_decoder(CODEC_ID_H264);
3431 * context = avcodec_alloc_context3(codec);
3433 * if (avcodec_open(context, codec) < 0)
3437 * @param avctx The context which will be set up to use the given codec.
3438 * @param codec The codec to use within the context.
3439 * @return zero on success, a negative value on error
3440 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3442 * @deprecated use avcodec_open2
3444 attribute_deprecated
3445 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3449 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3450 * function the context has to be allocated with avcodec_alloc_context3().
3452 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3453 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3454 * retrieving a codec.
3456 * @warning This function is not thread safe!
3459 * avcodec_register_all();
3460 * av_dict_set(&opts, "b", "2.5M", 0);
3461 * codec = avcodec_find_decoder(CODEC_ID_H264);
3465 * context = avcodec_alloc_context3(codec);
3467 * if (avcodec_open2(context, codec, opts) < 0)
3471 * @param avctx The context to initialize.
3472 * @param codec The codec to open this context for. If a non-NULL codec has been
3473 * previously passed to avcodec_alloc_context3() or
3474 * avcodec_get_context_defaults3() for this context, then this
3475 * parameter MUST be either NULL or equal to the previously passed
3477 * @param options A dictionary filled with AVCodecContext and codec-private options.
3478 * On return this object will be filled with options that were not found.
3480 * @return zero on success, a negative value on error
3481 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3482 * av_dict_set(), av_opt_find().
3484 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3487 * Close a given AVCodecContext and free all the data associated with it
3488 * (but not the AVCodecContext itself).
3490 * Calling this function on an AVCodecContext that hasn't been opened will free
3491 * the codec-specific data allocated in avcodec_alloc_context3() /
3492 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3495 int avcodec_close(AVCodecContext *avctx);
3498 * Free all allocated data in the given subtitle struct.
3500 * @param sub AVSubtitle to free.
3502 void avsubtitle_free(AVSubtitle *sub);
3509 * @addtogroup lavc_packet
3514 * @deprecated use NULL instead
3516 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3519 * Default packet destructor.
3521 void av_destruct_packet(AVPacket *pkt);
3524 * Initialize optional fields of a packet with default values.
3526 * Note, this does not touch the data and size members, which have to be
3527 * initialized separately.
3531 void av_init_packet(AVPacket *pkt);
3534 * Allocate the payload of a packet and initialize its fields with
3538 * @param size wanted payload size
3539 * @return 0 if OK, AVERROR_xxx otherwise
3541 int av_new_packet(AVPacket *pkt, int size);
3544 * Reduce packet size, correctly zeroing padding
3547 * @param size new size
3549 void av_shrink_packet(AVPacket *pkt, int size);
3552 * Increase packet size, correctly zeroing padding
3555 * @param grow_by number of bytes by which to increase the size of the packet
3557 int av_grow_packet(AVPacket *pkt, int grow_by);
3560 * @warning This is a hack - the packet memory allocation stuff is broken. The
3561 * packet is allocated if it was not really allocated.
3563 int av_dup_packet(AVPacket *pkt);
3568 * @param pkt packet to free
3570 void av_free_packet(AVPacket *pkt);
3573 * Allocate new information of a packet.
3576 * @param type side information type
3577 * @param size side information size
3578 * @return pointer to fresh allocated data or NULL otherwise
3580 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3584 * Shrink the already allocated side data buffer
3587 * @param type side information type
3588 * @param size new side information size
3589 * @return 0 on success, < 0 on failure
3591 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3595 * Get side information from packet.
3598 * @param type desired side information type
3599 * @param size pointer for side information size to store (optional)
3600 * @return pointer to data if present or NULL otherwise
3602 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3605 int av_packet_merge_side_data(AVPacket *pkt);
3607 int av_packet_split_side_data(AVPacket *pkt);
3615 * @addtogroup lavc_decoding
3620 * Find a registered decoder with a matching codec ID.
3622 * @param id CodecID of the requested decoder
3623 * @return A decoder if one was found, NULL otherwise.
3625 AVCodec *avcodec_find_decoder(enum CodecID id);
3628 * Find a registered decoder with the specified name.
3630 * @param name name of the requested decoder
3631 * @return A decoder if one was found, NULL otherwise.
3633 AVCodec *avcodec_find_decoder_by_name(const char *name);
3635 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3636 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3637 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3640 * Return the amount of padding in pixels which the get_buffer callback must
3641 * provide around the edge of the image for codecs which do not have the
3642 * CODEC_FLAG_EMU_EDGE flag.
3644 * @return Required padding in pixels.
3646 unsigned avcodec_get_edge_width(void);
3649 * Modify width and height values so that they will result in a memory
3650 * buffer that is acceptable for the codec if you do not use any horizontal
3653 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3654 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3655 * according to avcodec_get_edge_width() before.
3657 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3660 * Modify width and height values so that they will result in a memory
3661 * buffer that is acceptable for the codec if you also ensure that all
3662 * line sizes are a multiple of the respective linesize_align[i].
3664 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3665 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3666 * according to avcodec_get_edge_width() before.
3668 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3669 int linesize_align[AV_NUM_DATA_POINTERS]);
3671 #if FF_API_OLD_DECODE_AUDIO
3673 * Wrapper function which calls avcodec_decode_audio4.
3675 * @deprecated Use avcodec_decode_audio4 instead.
3677 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
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_audio3 has to be called again with an AVPacket that contains
3681 * the remaining data in order to decode the second frame etc.
3683 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3684 * decompressed frame size in bytes.
3686 * @warning You must set frame_size_ptr to the allocated size of the
3687 * output buffer before calling avcodec_decode_audio3().
3689 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3690 * the actual read bytes because some optimized bitstream readers read 32 or 64
3691 * bits at once and could read over the end.
3693 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3694 * no overreading happens for damaged MPEG streams.
3696 * @warning You must not provide a custom get_buffer() when using
3697 * avcodec_decode_audio3(). Doing so will override it with
3698 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3699 * which does allow the application to provide a custom get_buffer().
3701 * @note You might have to align the input buffer avpkt->data and output buffer
3702 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3703 * necessary at all, on others it won't work at all if not aligned and on others
3704 * it will work but it will have an impact on performance.
3706 * In practice, avpkt->data should have 4 byte alignment at minimum and
3707 * samples should be 16 byte aligned unless the CPU doesn't need it
3708 * (AltiVec and SSE do).
3710 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3711 * between input and output, these need to be fed with avpkt->data=NULL,
3712 * avpkt->size=0 at the end to return the remaining frames.
3714 * @param avctx the codec context
3715 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3716 * If the sample format is planar, each channel plane will
3717 * be the same size, with no padding between channels.
3718 * @param[in,out] frame_size_ptr the output buffer size in bytes
3719 * @param[in] avpkt The input AVPacket containing the input buffer.
3720 * You can create such packet with av_init_packet() and by then setting
3721 * data and size, some decoders might in addition need other fields.
3722 * All decoders are designed to use the least fields possible though.
3723 * @return On error a negative value is returned, otherwise the number of bytes
3724 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3726 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3727 int *frame_size_ptr,
3732 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3734 * Some decoders may support multiple frames in a single AVPacket. Such
3735 * decoders would then just decode the first frame. In this case,
3736 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3737 * the remaining data in order to decode the second frame, etc...
3738 * Even if no frames are returned, the packet needs to be fed to the decoder
3739 * with remaining data until it is completely consumed or an error occurs.
3741 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3742 * larger than the actual read bytes because some optimized bitstream
3743 * readers read 32 or 64 bits at once and could read over the end.
3745 * @note You might have to align the input buffer. The alignment requirements
3746 * depend on the CPU and the decoder.
3748 * @param avctx the codec context
3749 * @param[out] frame The AVFrame in which to store decoded audio samples.
3750 * Decoders request a buffer of a particular size by setting
3751 * AVFrame.nb_samples prior to calling get_buffer(). The
3752 * decoder may, however, only utilize part of the buffer by
3753 * setting AVFrame.nb_samples to a smaller value in the
3755 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3757 * @param[in] avpkt The input AVPacket containing the input buffer.
3758 * At least avpkt->data and avpkt->size should be set. Some
3759 * decoders might also require additional fields to be set.
3760 * @return A negative error code is returned if an error occurred during
3761 * decoding, otherwise the number of bytes consumed from the input
3762 * AVPacket is returned.
3764 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3765 int *got_frame_ptr, const AVPacket *avpkt);
3768 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3769 * Some decoders may support multiple frames in a single AVPacket, such
3770 * decoders would then just decode the first frame.
3772 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3773 * the actual read bytes because some optimized bitstream readers read 32 or 64
3774 * bits at once and could read over the end.
3776 * @warning The end of the input buffer buf should be set to 0 to ensure that
3777 * no overreading happens for damaged MPEG streams.
3779 * @note You might have to align the input buffer avpkt->data.
3780 * The alignment requirements depend on the CPU: on some CPUs it isn't
3781 * necessary at all, on others it won't work at all if not aligned and on others
3782 * it will work but it will have an impact on performance.
3784 * In practice, avpkt->data should have 4 byte alignment at minimum.
3786 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3787 * between input and output, these need to be fed with avpkt->data=NULL,
3788 * avpkt->size=0 at the end to return the remaining frames.
3790 * @param avctx the codec context
3791 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3792 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3793 * allocate memory for the actual bitmap.
3794 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3795 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3796 * decodes and the decoder tells the user once it does not need the data anymore,
3797 * the user app can at this point free/reuse/keep the memory as it sees fit.
3799 * @param[in] avpkt The input AVpacket containing the input buffer.
3800 * You can create such packet with av_init_packet() and by then setting
3801 * data and size, some decoders might in addition need other fields like
3802 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3804 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3805 * @return On error a negative value is returned, otherwise the number of bytes
3806 * used or zero if no frame could be decompressed.
3808 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3809 int *got_picture_ptr,
3810 const AVPacket *avpkt);
3813 * Decode a subtitle message.
3814 * Return a negative value on error, otherwise return the number of bytes used.
3815 * If no subtitle could be decompressed, got_sub_ptr is zero.
3816 * Otherwise, the subtitle is stored in *sub.
3817 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3818 * simplicity, because the performance difference is expect to be negligible
3819 * and reusing a get_buffer written for video codecs would probably perform badly
3820 * due to a potentially very different allocation pattern.
3822 * @param avctx the codec context
3823 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3824 freed with avsubtitle_free if *got_sub_ptr is set.
3825 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3826 * @param[in] avpkt The input AVPacket containing the input buffer.
3828 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3833 * @defgroup lavc_parsing Frame parsing
3837 typedef struct AVCodecParserContext {
3839 struct AVCodecParser *parser;
3840 int64_t frame_offset; /* offset of the current frame */
3841 int64_t cur_offset; /* current offset
3842 (incremented by each av_parser_parse()) */
3843 int64_t next_frame_offset; /* offset of the next frame */
3845 int pict_type; /* XXX: Put it back in AVCodecContext. */
3847 * This field is used for proper frame duration computation in lavf.
3848 * It signals, how much longer the frame duration of the current frame
3849 * is compared to normal frame duration.
3851 * frame_duration = (1 + repeat_pict) * time_base
3853 * It is used by codecs like H.264 to display telecined material.
3855 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3856 int64_t pts; /* pts of the current frame */
3857 int64_t dts; /* dts of the current frame */
3862 int fetch_timestamp;
3864 #define AV_PARSER_PTS_NB 4
3865 int cur_frame_start_index;
3866 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3867 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3868 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3871 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3872 #define PARSER_FLAG_ONCE 0x0002
3873 /// Set if the parser has a valid file offset
3874 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3875 #define PARSER_FLAG_USE_CODEC_TS 0x1000
3877 int64_t offset; ///< byte offset from starting packet start
3878 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3881 * Set by parser to 1 for key frames and 0 for non-key frames.
3882 * It is initialized to -1, so if the parser doesn't set this flag,
3883 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3889 * Time difference in stream time base units from the pts of this
3890 * packet to the point at which the output from the decoder has converged
3891 * independent from the availability of previous frames. That is, the
3892 * frames are virtually identical no matter if decoding started from
3893 * the very first frame or from this keyframe.
3894 * Is AV_NOPTS_VALUE if unknown.
3895 * This field is not the display duration of the current frame.
3896 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3899 * The purpose of this field is to allow seeking in streams that have no
3900 * keyframes in the conventional sense. It corresponds to the
3901 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3902 * essential for some types of subtitle streams to ensure that all
3903 * subtitles are correctly displayed after seeking.
3905 int64_t convergence_duration;
3907 // Timestamp generation support:
3909 * Synchronization point for start of timestamp generation.
3911 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3914 * For example, this corresponds to presence of H.264 buffering period
3920 * Offset of the current timestamp against last timestamp sync point in
3921 * units of AVCodecContext.time_base.
3923 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3924 * contain a valid timestamp offset.
3926 * Note that the timestamp of sync point has usually a nonzero
3927 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3928 * the next frame after timestamp sync point will be usually 1.
3930 * For example, this corresponds to H.264 cpb_removal_delay.
3932 int dts_ref_dts_delta;
3935 * Presentation delay of current frame in units of AVCodecContext.time_base.
3937 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3938 * contain valid non-negative timestamp delta (presentation time of a frame
3939 * must not lie in the past).
3941 * This delay represents the difference between decoding and presentation
3942 * time of the frame.
3944 * For example, this corresponds to H.264 dpb_output_delay.
3949 * Position of the packet in file.
3951 * Analogous to cur_frame_pts/dts
3953 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3956 * Byte position of currently parsed frame in stream.
3961 * Previous frame byte position.
3966 * Duration of the current frame.
3967 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3968 * For all other types, this is in units of AVCodecContext.time_base.
3971 } AVCodecParserContext;
3973 typedef struct AVCodecParser {
3974 int codec_ids[5]; /* several codec IDs are permitted */
3976 int (*parser_init)(AVCodecParserContext *s);
3977 int (*parser_parse)(AVCodecParserContext *s,
3978 AVCodecContext *avctx,
3979 const uint8_t **poutbuf, int *poutbuf_size,
3980 const uint8_t *buf, int buf_size);
3981 void (*parser_close)(AVCodecParserContext *s);
3982 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3983 struct AVCodecParser *next;
3986 AVCodecParser *av_parser_next(AVCodecParser *c);
3988 void av_register_codec_parser(AVCodecParser *parser);
3989 AVCodecParserContext *av_parser_init(int codec_id);
3994 * @param s parser context.
3995 * @param avctx codec context.
3996 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3997 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3998 * @param buf input buffer.
3999 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4000 * @param pts input presentation timestamp.
4001 * @param dts input decoding timestamp.
4002 * @param pos input byte position in stream.
4003 * @return the number of bytes of the input bitstream used.
4008 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4015 * decode_frame(data, size);
4019 int av_parser_parse2(AVCodecParserContext *s,
4020 AVCodecContext *avctx,
4021 uint8_t **poutbuf, int *poutbuf_size,
4022 const uint8_t *buf, int buf_size,
4023 int64_t pts, int64_t dts,
4026 int av_parser_change(AVCodecParserContext *s,
4027 AVCodecContext *avctx,
4028 uint8_t **poutbuf, int *poutbuf_size,
4029 const uint8_t *buf, int buf_size, int keyframe);
4030 void av_parser_close(AVCodecParserContext *s);
4038 * @addtogroup lavc_encoding
4043 * Find a registered encoder with a matching codec ID.
4045 * @param id CodecID of the requested encoder
4046 * @return An encoder if one was found, NULL otherwise.
4048 AVCodec *avcodec_find_encoder(enum CodecID id);
4051 * Find a registered encoder with the specified name.
4053 * @param name name of the requested encoder
4054 * @return An encoder if one was found, NULL otherwise.
4056 AVCodec *avcodec_find_encoder_by_name(const char *name);
4058 #if FF_API_OLD_ENCODE_AUDIO
4060 * Encode an audio frame from samples into buf.
4062 * @deprecated Use avcodec_encode_audio2 instead.
4064 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4065 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4066 * will know how much space is needed because it depends on the value passed
4067 * in buf_size as described below. In that case a lower value can be used.
4069 * @param avctx the codec context
4070 * @param[out] buf the output buffer
4071 * @param[in] buf_size the output buffer size
4072 * @param[in] samples the input buffer containing the samples
4073 * The number of samples read from this buffer is frame_size*channels,
4074 * both of which are defined in avctx.
4075 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4076 * samples read from samples is equal to:
4077 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4078 * This also implies that av_get_bits_per_sample() must not return 0 for these
4080 * @return On error a negative value is returned, on success zero or the number
4081 * of bytes used to encode the data read from the input buffer.
4083 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4084 uint8_t *buf, int buf_size,
4085 const short *samples);
4089 * Encode a frame of audio.
4091 * Takes input samples from frame and writes the next output packet, if
4092 * available, to avpkt. The output packet does not necessarily contain data for
4093 * the most recent frame, as encoders can delay, split, and combine input frames
4094 * internally as needed.
4096 * @param avctx codec context
4097 * @param avpkt output AVPacket.
4098 * The user can supply an output buffer by setting
4099 * avpkt->data and avpkt->size prior to calling the
4100 * function, but if the size of the user-provided data is not
4101 * large enough, encoding will fail. If avpkt->data and
4102 * avpkt->size are set, avpkt->destruct must also be set. All
4103 * other AVPacket fields will be reset by the encoder using
4104 * av_init_packet(). If avpkt->data is NULL, the encoder will
4105 * allocate it. The encoder will set avpkt->size to the size
4106 * of the output packet.
4108 * If this function fails or produces no output, avpkt will be
4109 * freed using av_free_packet() (i.e. avpkt->destruct will be
4110 * called to free the user supplied buffer).
4111 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4112 * May be NULL when flushing an encoder that has the
4113 * CODEC_CAP_DELAY capability set.
4114 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4115 * can have any number of samples.
4116 * If it is not set, frame->nb_samples must be equal to
4117 * avctx->frame_size for all frames except the last.
4118 * The final frame may be smaller than avctx->frame_size.
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_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4128 const AVFrame *frame, int *got_packet_ptr);
4130 #if FF_API_OLD_ENCODE_VIDEO
4132 * @deprecated use avcodec_encode_video2() instead.
4134 * Encode a video frame from pict into buf.
4135 * The input picture should be
4136 * stored using a specific format, namely avctx.pix_fmt.
4138 * @param avctx the codec context
4139 * @param[out] buf the output buffer for the bitstream of encoded frame
4140 * @param[in] buf_size the size of the output buffer in bytes
4141 * @param[in] pict the input picture to encode
4142 * @return On error a negative value is returned, on success zero or the number
4143 * of bytes used from the output buffer.
4145 attribute_deprecated
4146 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4147 const AVFrame *pict);
4151 * Encode a frame of video.
4153 * Takes input raw video data from frame and writes the next output packet, if
4154 * available, to avpkt. The output packet does not necessarily contain data for
4155 * the most recent frame, as encoders can delay and reorder input frames
4156 * internally as needed.
4158 * @param avctx codec context
4159 * @param avpkt output AVPacket.
4160 * The user can supply an output buffer by setting
4161 * avpkt->data and avpkt->size prior to calling the
4162 * function, but if the size of the user-provided data is not
4163 * large enough, encoding will fail. All other AVPacket fields
4164 * will be reset by the encoder using av_init_packet(). If
4165 * avpkt->data is NULL, the encoder will allocate it.
4166 * The encoder will set avpkt->size to the size of the
4167 * output packet. The returned data (if any) belongs to the
4168 * caller, he is responsible for freeing it.
4170 * If this function fails or produces no output, avpkt will be
4171 * freed using av_free_packet() (i.e. avpkt->destruct will be
4172 * called to free the user supplied buffer).
4173 * @param[in] frame AVFrame containing the raw video data to be encoded.
4174 * May be NULL when flushing an encoder that has the
4175 * CODEC_CAP_DELAY capability set.
4176 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4177 * output packet is non-empty, and to 0 if it is
4178 * empty. If the function returns an error, the
4179 * packet can be assumed to be invalid, and the
4180 * value of got_packet_ptr is undefined and should
4182 * @return 0 on success, negative error code on failure
4184 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4185 const AVFrame *frame, int *got_packet_ptr);
4187 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4188 const AVSubtitle *sub);
4196 * @defgroup lavc_resample Audio resampling
4201 struct ReSampleContext;
4202 struct AVResampleContext;
4204 typedef struct ReSampleContext ReSampleContext;
4207 * Initialize audio resampling context.
4209 * @param output_channels number of output channels
4210 * @param input_channels number of input channels
4211 * @param output_rate output sample rate
4212 * @param input_rate input sample rate
4213 * @param sample_fmt_out requested output sample format
4214 * @param sample_fmt_in input sample format
4215 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4216 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4217 * @param linear if 1 then the used FIR filter will be linearly interpolated
4218 between the 2 closest, if 0 the closest will be used
4219 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4220 * @return allocated ReSampleContext, NULL if error occurred
4222 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4223 int output_rate, int input_rate,
4224 enum AVSampleFormat sample_fmt_out,
4225 enum AVSampleFormat sample_fmt_in,
4226 int filter_length, int log2_phase_count,
4227 int linear, double cutoff);
4229 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4232 * Free resample context.
4234 * @param s a non-NULL pointer to a resample context previously
4235 * created with av_audio_resample_init()
4237 void audio_resample_close(ReSampleContext *s);
4241 * Initialize an audio resampler.
4242 * Note, if either rate is not an integer then simply scale both rates up so they are.
4243 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4244 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4245 * @param linear If 1 then the used FIR filter will be linearly interpolated
4246 between the 2 closest, if 0 the closest will be used
4247 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4249 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4252 * Resample an array of samples using a previously configured context.
4253 * @param src an array of unconsumed samples
4254 * @param consumed the number of samples of src which have been consumed are returned here
4255 * @param src_size the number of unconsumed samples available
4256 * @param dst_size the amount of space in samples available in dst
4257 * @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.
4258 * @return the number of samples written in dst or -1 if an error occurred
4260 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4264 * Compensate samplerate/timestamp drift. The compensation is done by changing
4265 * the resampler parameters, so no audible clicks or similar distortions occur
4266 * @param compensation_distance distance in output samples over which the compensation should be performed
4267 * @param sample_delta number of output samples which should be output less
4269 * example: av_resample_compensate(c, 10, 500)
4270 * here instead of 510 samples only 500 samples would be output
4272 * note, due to rounding the actual compensation might be slightly different,
4273 * especially if the compensation_distance is large and the in_rate used during init is small
4275 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4276 void av_resample_close(struct AVResampleContext *c);
4283 * @addtogroup lavc_picture
4288 * Allocate memory for a picture. Call avpicture_free() to free it.
4290 * @see avpicture_fill()
4292 * @param picture the picture to be filled in
4293 * @param pix_fmt the format of the picture
4294 * @param width the width of the picture
4295 * @param height the height of the picture
4296 * @return zero if successful, a negative value if not
4298 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
4301 * Free a picture previously allocated by avpicture_alloc().
4302 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4305 * @param picture the AVPicture to be freed
4307 void avpicture_free(AVPicture *picture);
4310 * Fill in the AVPicture fields, always assume a linesize alignment of
4313 * @see av_image_fill_arrays()
4315 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4316 enum PixelFormat pix_fmt, int width, int height);
4319 * Copy pixel data from an AVPicture into a buffer, always assume a
4320 * linesize alignment of 1.
4322 * @see av_image_copy_to_buffer()
4324 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
4325 unsigned char *dest, int dest_size);
4328 * Calculate the size in bytes that a picture of the given width and height
4329 * would occupy if stored in the given picture format.
4330 * Always assume a linesize alignment of 1.
4332 * @see av_image_get_buffer_size().
4334 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
4337 * deinterlace - if not supported return -1
4339 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4340 enum PixelFormat pix_fmt, int width, int height);
4342 * Copy image src to dst. Wraps av_image_copy().
4344 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4345 enum PixelFormat pix_fmt, int width, int height);
4348 * Crop image top and left side.
4350 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4351 enum PixelFormat pix_fmt, int top_band, int left_band);
4356 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4357 int padtop, int padbottom, int padleft, int padright, int *color);
4364 * @defgroup lavc_misc Utility functions
4367 * Miscellaneous utility functions related to both encoding and decoding
4373 * @defgroup lavc_misc_pixfmt Pixel formats
4375 * Functions for working with pixel formats.
4379 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
4382 * Return a value representing the fourCC code associated to the
4383 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4386 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
4388 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4389 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4390 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4391 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4392 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4393 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4396 * Compute what kind of losses will occur when converting from one specific
4397 * pixel format to another.
4398 * When converting from one pixel format to another, information loss may occur.
4399 * For example, when converting from RGB24 to GRAY, the color information will
4400 * be lost. Similarly, other losses occur when converting from some formats to
4401 * other formats. These losses can involve loss of chroma, but also loss of
4402 * resolution, loss of color depth, loss due to the color space conversion, loss
4403 * of the alpha bits or loss due to color quantization.
4404 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4405 * which will occur when converting from one pixel format to another.
4407 * @param[in] dst_pix_fmt destination pixel format
4408 * @param[in] src_pix_fmt source pixel format
4409 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4410 * @return Combination of flags informing you what kind of losses will occur
4411 * (maximum loss for an invalid dst_pix_fmt).
4413 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
4416 #if FF_API_FIND_BEST_PIX_FMT
4418 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4420 * Find the best pixel format to convert to given a certain source pixel
4421 * format. When converting from one pixel format to another, information loss
4422 * may occur. For example, when converting from RGB24 to GRAY, the color
4423 * information will be lost. Similarly, other losses occur when converting from
4424 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4425 * the given pixel formats should be used to suffer the least amount of loss.
4426 * The pixel formats from which it chooses one, are determined by the
4427 * pix_fmt_mask parameter.
4429 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4432 * src_pix_fmt = PIX_FMT_YUV420P;
4433 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
4434 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4437 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4438 * @param[in] src_pix_fmt source pixel format
4439 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4440 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4441 * @return The best pixel format to convert to or -1 if none was found.
4443 attribute_deprecated
4444 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
4445 int has_alpha, int *loss_ptr);
4446 #endif /* FF_API_FIND_BEST_PIX_FMT */
4449 * Find the best pixel format to convert to given a certain source pixel
4450 * format. When converting from one pixel format to another, information loss
4451 * may occur. For example, when converting from RGB24 to GRAY, the color
4452 * information will be lost. Similarly, other losses occur when converting from
4453 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4454 * the given pixel formats should be used to suffer the least amount of loss.
4455 * The pixel formats from which it chooses one, are determined by the
4456 * pix_fmt_list parameter.
4459 * @param[in] pix_fmt_list PIX_FMT_NONE terminated array of pixel formats to choose from
4460 * @param[in] src_pix_fmt source pixel format
4461 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4462 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4463 * @return The best pixel format to convert to or -1 if none was found.
4465 enum PixelFormat avcodec_find_best_pix_fmt_of_list(enum PixelFormat *pix_fmt_list,
4466 enum PixelFormat src_pix_fmt,
4467 int has_alpha, int *loss_ptr);
4470 * Find the best pixel format to convert to given a certain source pixel
4471 * format and a selection of two destination pixel formats. When converting from
4472 * one pixel format to another, information loss may occur. For example, when converting
4473 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4474 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
4475 * the given pixel formats should be used to suffer the least amount of loss.
4477 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
4481 * src_pix_fmt = PIX_FMT_YUV420P;
4482 * dst_pix_fmt1= PIX_FMT_RGB24;
4483 * dst_pix_fmt2= PIX_FMT_GRAY8;
4484 * dst_pix_fmt3= PIX_FMT_RGB8;
4485 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4486 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4487 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4490 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4491 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4492 * @param[in] src_pix_fmt Source pixel format
4493 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4494 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4495 * NULL or value of zero means we care about all losses. Out: the loss
4496 * that occurs when converting from src to selected dst pixel format.
4497 * @return The best pixel format to convert to or -1 if none was found.
4499 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
4500 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4502 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
4508 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4511 * Put a string representing the codec tag codec_tag in buf.
4513 * @param buf_size size in bytes of buf
4514 * @return the length of the string that would have been generated if
4515 * enough space had been available, excluding the trailing null
4517 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4519 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4522 * Return a name for the specified profile, if available.
4524 * @param codec the codec that is searched for the given profile
4525 * @param profile the profile value for which a name is requested
4526 * @return A name for the profile if found, NULL otherwise.
4528 const char *av_get_profile_name(const AVCodec *codec, int profile);
4530 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4531 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4532 //FIXME func typedef
4535 * Fill audio frame data and linesize.
4536 * AVFrame extended_data channel pointers are allocated if necessary for
4539 * @param frame the AVFrame
4540 * frame->nb_samples must be set prior to calling the
4541 * function. This function fills in frame->data,
4542 * frame->extended_data, frame->linesize[0].
4543 * @param nb_channels channel count
4544 * @param sample_fmt sample format
4545 * @param buf buffer to use for frame data
4546 * @param buf_size size of buffer
4547 * @param align plane size sample alignment (0 = default)
4548 * @return 0 on success, negative error code on failure
4550 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4551 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4552 int buf_size, int align);
4555 * Flush buffers, should be called when seeking or when switching to a different stream.
4557 void avcodec_flush_buffers(AVCodecContext *avctx);
4559 void avcodec_default_free_buffers(AVCodecContext *s);
4562 * Return codec bits per sample.
4564 * @param[in] codec_id the codec
4565 * @return Number of bits per sample or zero if unknown for the given codec.
4567 int av_get_bits_per_sample(enum CodecID codec_id);
4570 * Return the PCM codec associated with a sample format.
4571 * @param be endianness, 0 for little, 1 for big,
4572 * -1 (or anything else) for native
4573 * @return CODEC_ID_PCM_* or CODEC_ID_NONE
4575 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4578 * Return codec bits per sample.
4579 * Only return non-zero if the bits per sample is exactly correct, not an
4582 * @param[in] codec_id the codec
4583 * @return Number of bits per sample or zero if unknown for the given codec.
4585 int av_get_exact_bits_per_sample(enum CodecID codec_id);
4588 * Return audio frame duration.
4590 * @param avctx codec context
4591 * @param frame_bytes size of the frame, or 0 if unknown
4592 * @return frame duration, in samples, if known. 0 if not able to
4595 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4598 typedef struct AVBitStreamFilterContext {
4600 struct AVBitStreamFilter *filter;
4601 AVCodecParserContext *parser;
4602 struct AVBitStreamFilterContext *next;
4603 } AVBitStreamFilterContext;
4606 typedef struct AVBitStreamFilter {
4609 int (*filter)(AVBitStreamFilterContext *bsfc,
4610 AVCodecContext *avctx, const char *args,
4611 uint8_t **poutbuf, int *poutbuf_size,
4612 const uint8_t *buf, int buf_size, int keyframe);
4613 void (*close)(AVBitStreamFilterContext *bsfc);
4614 struct AVBitStreamFilter *next;
4615 } AVBitStreamFilter;
4617 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4618 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4619 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4620 AVCodecContext *avctx, const char *args,
4621 uint8_t **poutbuf, int *poutbuf_size,
4622 const uint8_t *buf, int buf_size, int keyframe);
4623 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4625 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4630 * Reallocate the given block if it is not large enough, otherwise do nothing.
4634 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4637 * Allocate a buffer, reusing the given one if large enough.
4639 * Contrary to av_fast_realloc the current buffer contents might not be
4640 * preserved and on error the old buffer is freed, thus no special
4641 * handling to avoid memleaks is necessary.
4643 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4644 * @param size size of the buffer *ptr points to
4645 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4646 * *size 0 if an error occurred.
4648 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4651 * Same behaviour av_fast_malloc but the buffer has additional
4652 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4654 * In addition the whole buffer will initially and after resizes
4655 * be 0-initialized so that no uninitialized data will ever appear.
4657 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4660 * Same behaviour av_fast_padded_malloc except that buffer will always
4661 * be 0-initialized after call.
4663 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4666 * Encode extradata length to a buffer. Used by xiph codecs.
4668 * @param s buffer to write to; must be at least (v/255+1) bytes long
4669 * @param v size of extradata in bytes
4670 * @return number of bytes written to the buffer.
4672 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4675 * Log a generic warning message about a missing feature. This function is
4676 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4677 * only, and would normally not be used by applications.
4678 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4679 * a pointer to an AVClass struct
4680 * @param[in] feature string containing the name of the missing feature
4681 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4682 * If want_sample is non-zero, additional verbage will be added to the log
4683 * message which tells the user how to report samples to the development
4686 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4689 * Log a generic warning message asking for a sample. This function is
4690 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4691 * only, and would normally not be used by applications.
4692 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4693 * a pointer to an AVClass struct
4694 * @param[in] msg string containing an optional message, or NULL if no message
4696 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4699 * Register the hardware accelerator hwaccel.
4701 void av_register_hwaccel(AVHWAccel *hwaccel);
4704 * If hwaccel is NULL, returns the first registered hardware accelerator,
4705 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4706 * after hwaccel, or NULL if hwaccel is the last one.
4708 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4712 * Lock operation used by lockmgr
4715 AV_LOCK_CREATE, ///< Create a mutex
4716 AV_LOCK_OBTAIN, ///< Lock the mutex
4717 AV_LOCK_RELEASE, ///< Unlock the mutex
4718 AV_LOCK_DESTROY, ///< Free mutex resources
4722 * Register a user provided lock manager supporting the operations
4723 * specified by AVLockOp. mutex points to a (void *) where the
4724 * lockmgr should store/get a pointer to a user allocated mutex. It's
4725 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4727 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4728 * callback during the call to av_lockmgr_register().
4729 * Thus, the application must be prepared to handle that.
4730 * If cb is set to NULL the lockmgr will be unregistered.
4731 * Also note that during unregistration the previously registered
4732 * lockmgr callback may also be invoked.
4734 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4737 * Get the type of the given codec.
4739 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4742 * Get the name of a codec.
4743 * @return a static string identifying the codec; never NULL
4745 const char *avcodec_get_name(enum CodecID id);
4748 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4749 * with no corresponding avcodec_close()), 0 otherwise.
4751 int avcodec_is_open(AVCodecContext *s);
4754 * @return a non-zero number if codec is an encoder, zero otherwise
4756 int av_codec_is_encoder(AVCodec *codec);
4759 * @return a non-zero number if codec is a decoder, zero otherwise
4761 int av_codec_is_decoder(AVCodec *codec);
4767 #endif /* AVCODEC_AVCODEC_H */