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
73 * Identify the syntax and semantics of the bitstream.
74 * The principle is roughly:
75 * Two decoders with the same ID can decode the same streams.
76 * Two encoders with the same ID can encode compatible streams.
77 * There may be slight deviations from the principle due to implementation
80 * If you add a codec ID to this list, add it so that
81 * 1. no value of a existing codec ID changes (that would break ABI),
82 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
83 * This ensures that 2 forks can independantly add CodecIDs without producing conflicts.
90 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
91 CODEC_ID_MPEG2VIDEO_XVMC,
128 CODEC_ID_INTERPLAY_VIDEO,
140 CODEC_ID_TRUEMOTION1,
167 CODEC_ID_TRUEMOTION2,
184 CODEC_ID_DSICINVIDEO,
185 CODEC_ID_TIERTEXSEQVIDEO,
193 CODEC_ID_BETHSOFTVID,
209 CODEC_ID_MOTIONPIXELS,
227 CODEC_ID_IFF_BYTERUN1,
249 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
250 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
251 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
253 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
254 CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
255 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
256 CODEC_ID_V408 = MKBETAG('V','4','0','8'),
257 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
354 CODEC_ID_WESTWOOD_SND1,
355 CODEC_ID_GSM, ///< as in Berlin toast format
363 CODEC_ID_DSICINAUDIO,
367 CODEC_ID_GSM_MS, /* as found in WAV */
376 CODEC_ID_WMALOSSLESS,
385 CODEC_ID_BINKAUDIO_RDFT,
386 CODEC_ID_BINKAUDIO_DCT,
395 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
396 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
397 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
398 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
400 /* subtitle codecs */
401 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
402 CODEC_ID_DVD_SUBTITLE = 0x17000,
403 CODEC_ID_DVB_SUBTITLE,
404 CODEC_ID_TEXT, ///< raw UTF-8 text
408 CODEC_ID_HDMV_PGS_SUBTITLE,
409 CODEC_ID_DVB_TELETEXT,
411 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
413 /* other specific kind of codecs (generally used for attachments) */
414 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
415 CODEC_ID_TTF = 0x18000,
416 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
417 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
418 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
420 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
422 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
423 * stream (only used by libavformat) */
424 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
425 * stream (only used by libavformat) */
426 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
429 #if FF_API_OLD_DECODE_AUDIO
431 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
435 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
436 * This is mainly needed because some optimized bitstream readers read
437 * 32 or 64 bit at once and could read over the end.<br>
438 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
439 * MPEG bitstreams could cause overread and segfault.
441 #define FF_INPUT_BUFFER_PADDING_SIZE 16
444 * minimum encoding buffer size
445 * Used to avoid some checks during header writing.
447 #define FF_MIN_BUFFER_SIZE 16384
451 * motion estimation type.
454 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
458 ME_EPZS, ///< enhanced predictive zonal search
459 ME_X1, ///< reserved for experiments
460 ME_HEX, ///< hexagon based search
461 ME_UMH, ///< uneven multi-hexagon search
462 ME_ITER, ///< iterative search
463 ME_TESA, ///< transformed exhaustive search algorithm
467 /* We leave some space between them for extensions (drop some
468 * keyframes for intra-only or drop just some bidir frames). */
469 AVDISCARD_NONE =-16, ///< discard nothing
470 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
471 AVDISCARD_NONREF = 8, ///< discard all non reference
472 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
473 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
474 AVDISCARD_ALL = 48, ///< discard all
477 enum AVColorPrimaries{
478 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
479 AVCOL_PRI_UNSPECIFIED=2,
481 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
482 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
483 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
485 AVCOL_PRI_NB , ///< Not part of ABI
488 enum AVColorTransferCharacteristic{
489 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
490 AVCOL_TRC_UNSPECIFIED=2,
491 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
492 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
493 AVCOL_TRC_SMPTE240M =7,
494 AVCOL_TRC_NB , ///< Not part of ABI
499 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
500 AVCOL_SPC_UNSPECIFIED=2,
502 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
503 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
504 AVCOL_SPC_SMPTE240M =7,
506 AVCOL_SPC_NB , ///< Not part of ABI
510 AVCOL_RANGE_UNSPECIFIED=0,
511 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
512 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
513 AVCOL_RANGE_NB , ///< Not part of ABI
517 * X X 3 4 X X are luma samples,
518 * 1 2 1-6 are possible chroma positions
519 * X X 5 6 X 0 is undefined/unknown position
521 enum AVChromaLocation{
522 AVCHROMA_LOC_UNSPECIFIED=0,
523 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
524 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
525 AVCHROMA_LOC_TOPLEFT =3, ///< DV
527 AVCHROMA_LOC_BOTTOMLEFT =5,
528 AVCHROMA_LOC_BOTTOM =6,
529 AVCHROMA_LOC_NB , ///< Not part of ABI
532 enum AVAudioServiceType {
533 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
534 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
535 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
536 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
537 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
538 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
539 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
540 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
541 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
542 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
545 typedef struct RcOverride{
548 int qscale; // If this is 0 then quality_factor will be used instead.
549 float quality_factor;
552 #define FF_MAX_B_FRAMES 16
555 These flags can be passed in AVCodecContext.flags before initialization.
556 Note: Not everything is supported yet.
559 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
560 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
561 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
562 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
563 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
565 * The parent program guarantees that the input for B-frames containing
566 * streams is not written to for at least s->max_b_frames+1 frames, if
567 * this is not set the input will be copied.
569 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
570 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
571 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
572 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
573 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
574 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
575 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
576 location instead of only at frame boundaries. */
577 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
578 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
579 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
580 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
581 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
582 /* Fx : Flag for h263+ extra options */
583 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
584 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
585 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
586 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
587 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
588 #define CODEC_FLAG_CLOSED_GOP 0x80000000
589 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
590 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
591 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
592 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
593 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
594 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
595 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
596 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
598 /* Unsupported options :
599 * Syntax Arithmetic coding (SAC)
600 * Reference Picture Selection
601 * Independent Segment Decoding */
603 /* codec capabilities */
605 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
607 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
608 * If not set, it might not use get_buffer() at all or use operations that
609 * assume the buffer was allocated by avcodec_default_get_buffer.
611 #define CODEC_CAP_DR1 0x0002
612 #define CODEC_CAP_TRUNCATED 0x0008
613 /* Codec can export data for HW decoding (XvMC). */
614 #define CODEC_CAP_HWACCEL 0x0010
616 * Encoder or decoder requires flushing with NULL input at the end in order to
617 * give the complete and correct output.
619 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
620 * with NULL data. The user can still send NULL data to the public encode
621 * or decode function, but libavcodec will not pass it along to the codec
622 * unless this flag is set.
625 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
626 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
630 * The encoder needs to be fed with NULL data at the end of encoding until the
631 * encoder no longer returns data.
633 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
634 * flag also means that the encoder must set the pts and duration for
635 * each output packet. If this flag is not set, the pts and duration will
636 * be determined by libavcodec from the input frame.
638 #define CODEC_CAP_DELAY 0x0020
640 * Codec can be fed a final frame with a smaller size.
641 * This can be used to prevent truncation of the last audio samples.
643 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
645 * Codec can export data for HW decoding (VDPAU).
647 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
649 * Codec can output multiple frames per AVPacket
650 * Normally demuxers return one frame at a time, demuxers which do not do
651 * are connected to a parser to split what they return into proper frames.
652 * This flag is reserved to the very rare category of codecs which have a
653 * bitstream that cannot be split into frames without timeconsuming
654 * operations like full decoding. Demuxers carring such bitstreams thus
655 * may return multiple frames in a packet. This has many disadvantages like
656 * prohibiting stream copy in many cases thus it should only be considered
659 #define CODEC_CAP_SUBFRAMES 0x0100
661 * Codec is experimental and is thus avoided in favor of non experimental
664 #define CODEC_CAP_EXPERIMENTAL 0x0200
666 * Codec should fill in channel configuration and samplerate instead of container
668 #define CODEC_CAP_CHANNEL_CONF 0x0400
671 * Codec is able to deal with negative linesizes
673 #define CODEC_CAP_NEG_LINESIZES 0x0800
676 * Codec supports frame-level multithreading.
678 #define CODEC_CAP_FRAME_THREADS 0x1000
680 * Codec supports slice-based (or partition-based) multithreading.
682 #define CODEC_CAP_SLICE_THREADS 0x2000
684 * Codec supports changed parameters at any point.
686 #define CODEC_CAP_PARAM_CHANGE 0x4000
688 * Codec supports avctx->thread_count == 0 (auto).
690 #define CODEC_CAP_AUTO_THREADS 0x8000
692 * Audio encoder supports receiving a different number of samples in each call.
694 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
698 #define CODEC_CAP_LOSSLESS 0x80000000
700 //The following defines may change, don't expect compatibility if you use them.
701 #define MB_TYPE_INTRA4x4 0x0001
702 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
703 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
704 #define MB_TYPE_16x16 0x0008
705 #define MB_TYPE_16x8 0x0010
706 #define MB_TYPE_8x16 0x0020
707 #define MB_TYPE_8x8 0x0040
708 #define MB_TYPE_INTERLACED 0x0080
709 #define MB_TYPE_DIRECT2 0x0100 //FIXME
710 #define MB_TYPE_ACPRED 0x0200
711 #define MB_TYPE_GMC 0x0400
712 #define MB_TYPE_SKIP 0x0800
713 #define MB_TYPE_P0L0 0x1000
714 #define MB_TYPE_P1L0 0x2000
715 #define MB_TYPE_P0L1 0x4000
716 #define MB_TYPE_P1L1 0x8000
717 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
718 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
719 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
720 #define MB_TYPE_QUANT 0x00010000
721 #define MB_TYPE_CBP 0x00020000
722 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
726 * This specifies the area which should be displayed.
727 * Note there may be multiple such areas for one frame.
729 typedef struct AVPanScan{
732 * - encoding: Set by user.
733 * - decoding: Set by libavcodec.
738 * width and height in 1/16 pel
739 * - encoding: Set by user.
740 * - decoding: Set by libavcodec.
746 * position of the top left corner in 1/16 pel for up to 3 fields/frames
747 * - encoding: Set by user.
748 * - decoding: Set by libavcodec.
750 int16_t position[3][2];
753 #define FF_QSCALE_TYPE_MPEG1 0
754 #define FF_QSCALE_TYPE_MPEG2 1
755 #define FF_QSCALE_TYPE_H264 2
756 #define FF_QSCALE_TYPE_VP56 3
758 #define FF_BUFFER_TYPE_INTERNAL 1
759 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
760 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
761 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
763 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
764 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
765 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
766 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
768 enum AVPacketSideDataType {
770 AV_PKT_DATA_NEW_EXTRADATA,
771 AV_PKT_DATA_PARAM_CHANGE,
774 typedef struct AVPacket {
776 * Presentation timestamp in AVStream->time_base units; the time at which
777 * the decompressed packet will be presented to the user.
778 * Can be AV_NOPTS_VALUE if it is not stored in the file.
779 * pts MUST be larger or equal to dts as presentation cannot happen before
780 * decompression, unless one wants to view hex dumps. Some formats misuse
781 * the terms dts and pts/cts to mean something different. Such timestamps
782 * must be converted to true pts/dts before they are stored in AVPacket.
786 * Decompression timestamp in AVStream->time_base units; the time at which
787 * the packet is decompressed.
788 * Can be AV_NOPTS_VALUE if it is not stored in the file.
795 * A combination of AV_PKT_FLAG values
799 * Additional packet data that can be provided by the container.
800 * Packet can contain several types of side information.
805 enum AVPacketSideDataType type;
810 * Duration of this packet in AVStream->time_base units, 0 if unknown.
811 * Equals next_pts - this_pts in presentation order.
814 void (*destruct)(struct AVPacket *);
816 int64_t pos; ///< byte position in stream, -1 if unknown
819 * Time difference in AVStream->time_base units from the pts of this
820 * packet to the point at which the output from the decoder has converged
821 * independent from the availability of previous frames. That is, the
822 * frames are virtually identical no matter if decoding started from
823 * the very first frame or from this keyframe.
824 * Is AV_NOPTS_VALUE if unknown.
825 * This field is not the display duration of the current packet.
826 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
829 * The purpose of this field is to allow seeking in streams that have no
830 * keyframes in the conventional sense. It corresponds to the
831 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
832 * essential for some types of subtitle streams to ensure that all
833 * subtitles are correctly displayed after seeking.
835 int64_t convergence_duration;
837 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
838 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
841 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
843 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
844 * s32le channel_count
845 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
846 * u64le channel_layout
847 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
849 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
854 enum AVSideDataParamChangeFlags {
855 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
856 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
857 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
858 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
863 * New fields can be added to the end of AVFRAME with minor version
864 * bumps. Similarly fields that are marked as to be only accessed by
865 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
866 * without breaking compatibility with each other.
867 * Removal, reordering and changes in the remaining cases require
868 * a major version bump.
869 * sizeof(AVFrame) must not be used outside libavcodec.
871 typedef struct AVFrame {
872 #define AV_NUM_DATA_POINTERS 8
874 * pointer to the picture/channel planes.
875 * This might be different from the first allocated byte
876 * - encoding: Set by user
877 * - decoding: set by AVCodecContext.get_buffer()
879 uint8_t *data[AV_NUM_DATA_POINTERS];
882 * Size, in bytes, of the data for each picture/channel plane.
884 * For audio, only linesize[0] may be set. For planar audio, each channel
885 * plane must be the same size.
887 * - encoding: Set by user
888 * - decoding: set by AVCodecContext.get_buffer()
890 int linesize[AV_NUM_DATA_POINTERS];
893 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
894 * This isn't used by libavcodec unless the default get/release_buffer() is used.
898 uint8_t *base[AV_NUM_DATA_POINTERS];
900 * 1 -> keyframe, 0-> not
901 * - encoding: Set by libavcodec.
902 * - decoding: Set by libavcodec.
907 * Picture type of the frame, see ?_TYPE below.
908 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
909 * - decoding: Set by libavcodec.
911 enum AVPictureType pict_type;
914 * presentation timestamp in time_base units (time when frame should be shown to user)
915 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
916 * - encoding: MUST be set by user.
917 * - decoding: Set by libavcodec.
922 * picture number in bitstream order
924 * - decoding: Set by libavcodec.
926 int coded_picture_number;
928 * picture number in display order
930 * - decoding: Set by libavcodec.
932 int display_picture_number;
935 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
936 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
937 * - decoding: Set by libavcodec.
942 * is this picture used as reference
943 * The values for this are the same as the MpegEncContext.picture_structure
944 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
945 * Set to 4 for delayed, non-reference frames.
947 * - decoding: Set by libavcodec. (before get_buffer() call)).
954 * - decoding: Set by libavcodec.
956 int8_t *qscale_table;
960 * - decoding: Set by libavcodec.
965 * mbskip_table[mb]>=1 if MB didn't change
966 * stride= mb_width = (width+15)>>4
968 * - decoding: Set by libavcodec.
970 uint8_t *mbskip_table;
973 * motion vector table
976 * int mv_sample_log2= 4 - motion_subsample_log2;
977 * int mb_width= (width+15)>>4;
978 * int mv_stride= (mb_width << mv_sample_log2) + 1;
979 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
981 * - encoding: Set by user.
982 * - decoding: Set by libavcodec.
984 int16_t (*motion_val[2])[2];
987 * macroblock type table
988 * mb_type_base + mb_width + 2
989 * - encoding: Set by user.
990 * - decoding: Set by libavcodec.
995 * log2 of the size of the block which a single vector in motion_val represents:
996 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
998 * - decoding: Set by libavcodec.
1000 uint8_t motion_subsample_log2;
1003 * for some private data of the user
1004 * - encoding: unused
1005 * - decoding: Set by user.
1011 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1012 * - decoding: unused
1014 uint64_t error[AV_NUM_DATA_POINTERS];
1017 * type of the buffer (to keep track of who has to deallocate data[*])
1018 * - encoding: Set by the one who allocates it.
1019 * - decoding: Set by the one who allocates it.
1020 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1025 * When decoding, this signals how much the picture must be delayed.
1026 * extra_delay = repeat_pict / (2*fps)
1027 * - encoding: unused
1028 * - decoding: Set by libavcodec.
1038 * The content of the picture is interlaced.
1039 * - encoding: Set by user.
1040 * - decoding: Set by libavcodec. (default 0)
1042 int interlaced_frame;
1045 * If the content is interlaced, is top field displayed first.
1046 * - encoding: Set by user.
1047 * - decoding: Set by libavcodec.
1049 int top_field_first;
1053 * - encoding: Set by user.
1054 * - decoding: Set by libavcodec.
1056 AVPanScan *pan_scan;
1059 * Tell user application that palette has changed from previous frame.
1060 * - encoding: ??? (no palette-enabled encoder yet)
1061 * - decoding: Set by libavcodec. (default 0).
1063 int palette_has_changed;
1066 * codec suggestion on buffer type if != 0
1067 * - encoding: unused
1068 * - decoding: Set by libavcodec. (before get_buffer() call)).
1074 * - encoding: unused
1075 * - decoding: Set by libavcodec.
1080 * motion reference frame index
1081 * the order in which these are stored can depend on the codec.
1082 * - encoding: Set by user.
1083 * - decoding: Set by libavcodec.
1085 int8_t *ref_index[2];
1088 * reordered opaque 64bit (generally an integer or a double precision float
1089 * PTS but can be anything).
1090 * The user sets AVCodecContext.reordered_opaque to represent the input at
1092 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1093 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1094 * @deprecated in favor of pkt_pts
1095 * - encoding: unused
1096 * - decoding: Read by user.
1098 int64_t reordered_opaque;
1101 * hardware accelerator private data (FFmpeg-allocated)
1102 * - encoding: unused
1103 * - decoding: Set by libavcodec
1105 void *hwaccel_picture_private;
1108 * reordered pts from the last AVPacket that has been input into the decoder
1109 * - encoding: unused
1110 * - decoding: Read by user.
1115 * dts from the last AVPacket that has been input into the decoder
1116 * - encoding: unused
1117 * - decoding: Read by user.
1122 * the AVCodecContext which ff_thread_get_buffer() was last called on
1123 * - encoding: Set by libavcodec.
1124 * - decoding: Set by libavcodec.
1126 struct AVCodecContext *owner;
1129 * used by multithreading to store frame-specific info
1130 * - encoding: Set by libavcodec.
1131 * - decoding: Set by libavcodec.
1133 void *thread_opaque;
1136 * number of audio samples (per channel) described by this frame
1137 * - encoding: Set by user
1138 * - decoding: Set by libavcodec
1143 * pointers to the data planes/channels.
1145 * For video, this should simply point to data[].
1147 * For planar audio, each channel has a separate data pointer, and
1148 * linesize[0] contains the size of each channel buffer.
1149 * For packed audio, there is just one data pointer, and linesize[0]
1150 * contains the total size of the buffer for all channels.
1152 * Note: Both data and extended_data will always be set by get_buffer(),
1153 * but for planar audio with more channels that can fit in data,
1154 * extended_data must be used by the decoder in order to access all
1158 * decoding: set by AVCodecContext.get_buffer()
1160 uint8_t **extended_data;
1163 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1164 * - encoding: unused
1165 * - decoding: Read by user.
1167 AVRational sample_aspect_ratio;
1170 * width and height of the video frame
1171 * - encoding: unused
1172 * - decoding: Read by user.
1177 * format of the frame, -1 if unknown or unset
1178 * Values correspond to enum PixelFormat for video frames,
1179 * enum AVSampleFormat for audio)
1180 * - encoding: unused
1181 * - decoding: Read by user.
1186 * frame timestamp estimated using various heuristics, in stream time base
1187 * Code outside libavcodec should access this field using:
1188 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1189 * - encoding: unused
1190 * - decoding: set by libavcodec, read by user.
1192 int64_t best_effort_timestamp;
1195 * reordered pos from the last AVPacket that has been input into the decoder
1196 * Code outside libavcodec should access this field using:
1197 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1198 * - encoding: unused
1199 * - decoding: Read by user.
1205 struct AVCodecInternal;
1209 AV_FIELD_PROGRESSIVE,
1210 AV_FIELD_TT, //< Top coded_first, top displayed first
1211 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1212 AV_FIELD_TB, //< Top coded first, bottom displayed first
1213 AV_FIELD_BT, //< Bottom coded first, top displayed first
1217 * main external API structure.
1218 * New fields can be added to the end with minor version bumps.
1219 * Removal, reordering and changes to existing fields require a major
1221 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1223 * sizeof(AVCodecContext) must not be used outside libav*.
1225 typedef struct AVCodecContext {
1227 * information on struct for av_log
1228 * - set by avcodec_alloc_context3
1230 const AVClass *av_class;
1232 * the average bitrate
1233 * - encoding: Set by user; unused for constant quantizer encoding.
1234 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1239 * number of bits the bitstream is allowed to diverge from the reference.
1240 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1241 * - encoding: Set by user; unused for constant quantizer encoding.
1242 * - decoding: unused
1244 int bit_rate_tolerance;
1248 * - encoding: Set by user.
1249 * - decoding: Set by user.
1254 * Some codecs need additional format info. It is stored here.
1255 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1256 * specific codec MUST set it correctly otherwise stream copy breaks.
1257 * In general use of this field by muxers is not recommended.
1258 * - encoding: Set by libavcodec.
1259 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1264 * Motion estimation algorithm used for video coding.
1265 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1266 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1267 * - encoding: MUST be set by user.
1268 * - decoding: unused
1273 * some codecs need / can use extradata like Huffman tables.
1274 * mjpeg: Huffman tables
1275 * rv10: additional flags
1276 * mpeg4: global headers (they can be in the bitstream or here)
1277 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1278 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1279 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1280 * - encoding: Set/allocated/freed by libavcodec.
1281 * - decoding: Set/allocated/freed by user.
1287 * This is the fundamental unit of time (in seconds) in terms
1288 * of which frame timestamps are represented. For fixed-fps content,
1289 * timebase should be 1/framerate and timestamp increments should be
1291 * - encoding: MUST be set by user.
1292 * - decoding: Set by libavcodec.
1294 AVRational time_base;
1298 * picture width / height.
1299 * - encoding: MUST be set by user.
1300 * - decoding: Set by libavcodec.
1301 * Note: For compatibility it is possible to set this instead of
1302 * coded_width/height before decoding.
1306 #define FF_ASPECT_EXTENDED 15
1309 * the number of pictures in a group of pictures, or 0 for intra_only
1310 * - encoding: Set by user.
1311 * - decoding: unused
1316 * Pixel format, see PIX_FMT_xxx.
1317 * May be set by the demuxer if known from headers.
1318 * May be overriden by the decoder if it knows better.
1319 * - encoding: Set by user.
1320 * - decoding: Set by user if known, overridden by libavcodec if known
1322 enum PixelFormat pix_fmt;
1325 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1326 * decoder to draw a horizontal band. It improves cache usage. Not
1327 * all codecs can do that. You must check the codec capabilities
1329 * When multithreading is used, it may be called from multiple threads
1330 * at the same time; threads might draw different parts of the same AVFrame,
1331 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1333 * The function is also used by hardware acceleration APIs.
1334 * It is called at least once during frame decoding to pass
1335 * the data needed for hardware render.
1336 * In that mode instead of pixel data, AVFrame points to
1337 * a structure specific to the acceleration API. The application
1338 * reads the structure and can change some fields to indicate progress
1340 * - encoding: unused
1341 * - decoding: Set by user.
1342 * @param height the height of the slice
1343 * @param y the y position of the slice
1344 * @param type 1->top field, 2->bottom field, 3->frame
1345 * @param offset offset into the AVFrame.data from which the slice should be read
1347 void (*draw_horiz_band)(struct AVCodecContext *s,
1348 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1349 int y, int type, int height);
1352 int sample_rate; ///< samples per second
1353 int channels; ///< number of audio channels
1356 * audio sample format
1357 * - encoding: Set by user.
1358 * - decoding: Set by libavcodec.
1360 enum AVSampleFormat sample_fmt; ///< sample format
1362 /* The following data should not be initialized. */
1364 * Samples per packet, initialized when calling 'init'.
1367 int frame_number; ///< audio or video frame number
1370 * Encoding: Number of frames delay there will be from the encoder input to
1371 * the decoder output. (we assume the decoder matches the spec)
1372 * Decoding: Number of frames delay in addition to what a standard decoder
1373 * as specified in the spec would produce.
1374 * - encoding: Set by libavcodec.
1375 * - decoding: Set by libavcodec.
1379 /* - encoding parameters */
1380 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1381 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1385 * - encoding: Set by user.
1386 * - decoding: unused
1392 * - encoding: Set by user.
1393 * - decoding: unused
1398 * maximum quantizer difference between frames
1399 * - encoding: Set by user.
1400 * - decoding: unused
1405 * maximum number of B-frames between non-B-frames
1406 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1407 * - encoding: Set by user.
1408 * - decoding: unused
1413 * qscale factor between IP and B-frames
1414 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1415 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1416 * - encoding: Set by user.
1417 * - decoding: unused
1419 float b_quant_factor;
1421 /** obsolete FIXME remove */
1423 #define FF_RC_STRATEGY_XVID 1
1425 int b_frame_strategy;
1427 struct AVCodec *codec;
1431 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1432 /* do its best to deliver a chunk with size */
1433 /* below rtp_payload_size, the chunk will start */
1434 /* with a start code on some codecs like H.263. */
1435 /* This doesn't take account of any particular */
1436 /* headers inside the transmitted RTP payload. */
1439 /* The RTP callback: This function is called */
1440 /* every time the encoder has a packet to send. */
1441 /* It depends on the encoder if the data starts */
1442 /* with a Start Code (it should). H.263 does. */
1443 /* mb_nb contains the number of macroblocks */
1444 /* encoded in the RTP payload. */
1445 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1447 /* statistics, used for 2-pass encoding */
1458 * number of bits used for the previously encoded frame
1459 * - encoding: Set by libavcodec.
1460 * - decoding: unused
1465 * Private data of the user, can be used to carry app specific stuff.
1466 * - encoding: Set by user.
1467 * - decoding: Set by user.
1471 char codec_name[32];
1472 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1473 enum CodecID codec_id; /* see CODEC_ID_xxx */
1476 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1477 * This is used to work around some encoder bugs.
1478 * A demuxer should set this to what is stored in the field used to identify the codec.
1479 * If there are multiple such fields in a container then the demuxer should choose the one
1480 * which maximizes the information about the used codec.
1481 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1482 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1483 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1485 * - encoding: Set by user, if not then the default based on codec_id will be used.
1486 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1488 unsigned int codec_tag;
1491 * Work around bugs in encoders which sometimes cannot be detected automatically.
1492 * - encoding: Set by user
1493 * - decoding: Set by user
1495 int workaround_bugs;
1496 #define FF_BUG_AUTODETECT 1 ///< autodetection
1497 #define FF_BUG_OLD_MSMPEG4 2
1498 #define FF_BUG_XVID_ILACE 4
1499 #define FF_BUG_UMP4 8
1500 #define FF_BUG_NO_PADDING 16
1501 #define FF_BUG_AMV 32
1502 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1503 #define FF_BUG_QPEL_CHROMA 64
1504 #define FF_BUG_STD_QPEL 128
1505 #define FF_BUG_QPEL_CHROMA2 256
1506 #define FF_BUG_DIRECT_BLOCKSIZE 512
1507 #define FF_BUG_EDGE 1024
1508 #define FF_BUG_HPEL_CHROMA 2048
1509 #define FF_BUG_DC_CLIP 4096
1510 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1511 #define FF_BUG_TRUNCATED 16384
1514 * luma single coefficient elimination threshold
1515 * - encoding: Set by user.
1516 * - decoding: unused
1518 int luma_elim_threshold;
1521 * chroma single coeff elimination threshold
1522 * - encoding: Set by user.
1523 * - decoding: unused
1525 int chroma_elim_threshold;
1528 * strictly follow the standard (MPEG4, ...).
1529 * - encoding: Set by user.
1530 * - decoding: Set by user.
1531 * Setting this to STRICT or higher means the encoder and decoder will
1532 * generally do stupid things, whereas setting it to unofficial or lower
1533 * will mean the encoder might produce output that is not supported by all
1534 * spec-compliant decoders. Decoders don't differentiate between normal,
1535 * unofficial and experimental (that is, they always try to decode things
1536 * when they can) unless they are explicitly asked to behave stupidly
1537 * (=strictly conform to the specs)
1539 int strict_std_compliance;
1540 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1541 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1542 #define FF_COMPLIANCE_NORMAL 0
1543 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1544 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1547 * qscale offset between IP and B-frames
1548 * - encoding: Set by user.
1549 * - decoding: unused
1551 float b_quant_offset;
1554 * Called at the beginning of each frame to get a buffer for it.
1556 * The function will set AVFrame.data[], AVFrame.linesize[].
1557 * AVFrame.extended_data[] must also be set, but it should be the same as
1558 * AVFrame.data[] except for planar audio with more channels than can fit
1559 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1560 * many data pointers as it can hold.
1562 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1563 * avcodec_default_get_buffer() instead of providing buffers allocated by
1566 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1567 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1568 * but if get_buffer() is overridden then alignment considerations should
1569 * be taken into account.
1571 * @see avcodec_default_get_buffer()
1575 * If pic.reference is set then the frame will be read later by libavcodec.
1576 * avcodec_align_dimensions2() should be used to find the required width and
1577 * height, as they normally need to be rounded up to the next multiple of 16.
1579 * If frame multithreading is used and thread_safe_callbacks is set,
1580 * it may be called from a different thread, but not from more than one at
1581 * once. Does not need to be reentrant.
1583 * @see release_buffer(), reget_buffer()
1584 * @see avcodec_align_dimensions2()
1588 * Decoders request a buffer of a particular size by setting
1589 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1590 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1591 * to a smaller value in the output frame.
1593 * Decoders cannot use the buffer after returning from
1594 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1595 * is assumed to be released immediately upon return.
1597 * As a convenience, av_samples_get_buffer_size() and
1598 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1599 * functions to find the required data size and to fill data pointers and
1600 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1601 * since all planes must be the same size.
1603 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1605 * - encoding: unused
1606 * - decoding: Set by libavcodec, user can override.
1608 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1611 * Called to release buffers which were allocated with get_buffer.
1612 * A released buffer can be reused in get_buffer().
1613 * pic.data[*] must be set to NULL.
1614 * May be called from a different thread if frame multithreading is used,
1615 * but not by more than one thread at once, so does not need to be reentrant.
1616 * - encoding: unused
1617 * - decoding: Set by libavcodec, user can override.
1619 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1622 * Size of the frame reordering buffer in the decoder.
1623 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1624 * - encoding: Set by libavcodec.
1625 * - decoding: Set by libavcodec.
1630 * number of bytes per packet if constant and known or 0
1631 * Used by some WAV based audio codecs.
1636 * 0-> h263 quant 1-> mpeg quant
1637 * - encoding: Set by user.
1638 * - decoding: unused
1643 * pass1 encoding statistics output buffer
1644 * - encoding: Set by libavcodec.
1645 * - decoding: unused
1650 * pass2 encoding statistics input buffer
1651 * Concatenated stuff from stats_out of pass1 should be placed here.
1652 * - encoding: Allocated/set/freed by user.
1653 * - decoding: unused
1658 * ratecontrol qmin qmax limiting method
1659 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1660 * - encoding: Set by user.
1661 * - decoding: unused
1669 * ratecontrol override, see RcOverride
1670 * - encoding: Allocated/set/freed by user.
1671 * - decoding: unused
1673 RcOverride *rc_override;
1674 int rc_override_count;
1677 * rate control equation
1678 * - encoding: Set by user
1679 * - decoding: unused
1685 * - encoding: Set by user.
1686 * - decoding: unused
1692 * - encoding: Set by user.
1693 * - decoding: unused
1698 * decoder bitstream buffer size
1699 * - encoding: Set by user.
1700 * - decoding: unused
1703 float rc_buffer_aggressivity;
1706 * qscale factor between P and I-frames
1707 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1708 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1709 * - encoding: Set by user.
1710 * - decoding: unused
1712 float i_quant_factor;
1715 * qscale offset between P and I-frames
1716 * - encoding: Set by user.
1717 * - decoding: unused
1719 float i_quant_offset;
1722 * initial complexity for pass1 ratecontrol
1723 * - encoding: Set by user.
1724 * - decoding: unused
1726 float rc_initial_cplx;
1729 * DCT algorithm, see FF_DCT_* below
1730 * - encoding: Set by user.
1731 * - decoding: unused
1734 #define FF_DCT_AUTO 0
1735 #define FF_DCT_FASTINT 1
1736 #define FF_DCT_INT 2
1737 #define FF_DCT_MMX 3
1738 #define FF_DCT_ALTIVEC 5
1739 #define FF_DCT_FAAN 6
1742 * luminance masking (0-> disabled)
1743 * - encoding: Set by user.
1744 * - decoding: unused
1749 * temporary complexity masking (0-> disabled)
1750 * - encoding: Set by user.
1751 * - decoding: unused
1753 float temporal_cplx_masking;
1756 * spatial complexity masking (0-> disabled)
1757 * - encoding: Set by user.
1758 * - decoding: unused
1760 float spatial_cplx_masking;
1763 * p block masking (0-> disabled)
1764 * - encoding: Set by user.
1765 * - decoding: unused
1770 * darkness masking (0-> disabled)
1771 * - encoding: Set by user.
1772 * - decoding: unused
1777 * IDCT algorithm, see FF_IDCT_* below.
1778 * - encoding: Set by user.
1779 * - decoding: Set by user.
1782 #define FF_IDCT_AUTO 0
1783 #define FF_IDCT_INT 1
1784 #define FF_IDCT_SIMPLE 2
1785 #define FF_IDCT_SIMPLEMMX 3
1786 #define FF_IDCT_LIBMPEG2MMX 4
1787 #define FF_IDCT_PS2 5
1788 #define FF_IDCT_ARM 7
1789 #define FF_IDCT_ALTIVEC 8
1790 #define FF_IDCT_SH4 9
1791 #define FF_IDCT_SIMPLEARM 10
1792 #define FF_IDCT_H264 11
1793 #define FF_IDCT_VP3 12
1794 #define FF_IDCT_IPP 13
1795 #define FF_IDCT_XVIDMMX 14
1796 #define FF_IDCT_CAVS 15
1797 #define FF_IDCT_SIMPLEARMV5TE 16
1798 #define FF_IDCT_SIMPLEARMV6 17
1799 #define FF_IDCT_SIMPLEVIS 18
1800 #define FF_IDCT_WMV2 19
1801 #define FF_IDCT_FAAN 20
1802 #define FF_IDCT_EA 21
1803 #define FF_IDCT_SIMPLENEON 22
1804 #define FF_IDCT_SIMPLEALPHA 23
1805 #define FF_IDCT_BINK 24
1809 * - encoding: Set by libavcodec.
1810 * - decoding: Set by user (or 0).
1814 * slice offsets in the frame in bytes
1815 * - encoding: Set/allocated by libavcodec.
1816 * - decoding: Set/allocated by user (or NULL).
1821 * error concealment flags
1822 * - encoding: unused
1823 * - decoding: Set by user.
1825 int error_concealment;
1826 #define FF_EC_GUESS_MVS 1
1827 #define FF_EC_DEBLOCK 2
1830 * dsp_mask could be add used to disable unwanted CPU features
1831 * CPU features (i.e. MMX, SSE. ...)
1833 * With the FORCE flag you may instead enable given CPU features.
1834 * (Dangerous: Usable in case of misdetection, improper usage however will
1835 * result into program crash.)
1840 * bits per sample/pixel from the demuxer (needed for huffyuv).
1841 * - encoding: Set by libavcodec.
1842 * - decoding: Set by user.
1844 int bits_per_coded_sample;
1847 * prediction method (needed for huffyuv)
1848 * - encoding: Set by user.
1849 * - decoding: unused
1851 int prediction_method;
1852 #define FF_PRED_LEFT 0
1853 #define FF_PRED_PLANE 1
1854 #define FF_PRED_MEDIAN 2
1857 * sample aspect ratio (0 if unknown)
1858 * That is the width of a pixel divided by the height of the pixel.
1859 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1860 * - encoding: Set by user.
1861 * - decoding: Set by libavcodec.
1863 AVRational sample_aspect_ratio;
1866 * the picture in the bitstream
1867 * - encoding: Set by libavcodec.
1868 * - decoding: Set by libavcodec.
1870 AVFrame *coded_frame;
1874 * - encoding: Set by user.
1875 * - decoding: Set by user.
1878 #define FF_DEBUG_PICT_INFO 1
1879 #define FF_DEBUG_RC 2
1880 #define FF_DEBUG_BITSTREAM 4
1881 #define FF_DEBUG_MB_TYPE 8
1882 #define FF_DEBUG_QP 16
1883 #define FF_DEBUG_MV 32
1884 #define FF_DEBUG_DCT_COEFF 0x00000040
1885 #define FF_DEBUG_SKIP 0x00000080
1886 #define FF_DEBUG_STARTCODE 0x00000100
1887 #define FF_DEBUG_PTS 0x00000200
1888 #define FF_DEBUG_ER 0x00000400
1889 #define FF_DEBUG_MMCO 0x00000800
1890 #define FF_DEBUG_BUGS 0x00001000
1891 #define FF_DEBUG_VIS_QP 0x00002000
1892 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1893 #define FF_DEBUG_BUFFERS 0x00008000
1894 #define FF_DEBUG_THREADS 0x00010000
1898 * - encoding: Set by user.
1899 * - decoding: Set by user.
1902 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1903 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1904 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1908 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1909 * - decoding: unused
1911 uint64_t error[AV_NUM_DATA_POINTERS];
1914 * motion estimation comparison function
1915 * - encoding: Set by user.
1916 * - decoding: unused
1920 * subpixel motion estimation comparison function
1921 * - encoding: Set by user.
1922 * - decoding: unused
1926 * macroblock comparison function (not supported yet)
1927 * - encoding: Set by user.
1928 * - decoding: unused
1932 * interlaced DCT comparison function
1933 * - encoding: Set by user.
1934 * - decoding: unused
1937 #define FF_CMP_SAD 0
1938 #define FF_CMP_SSE 1
1939 #define FF_CMP_SATD 2
1940 #define FF_CMP_DCT 3
1941 #define FF_CMP_PSNR 4
1942 #define FF_CMP_BIT 5
1944 #define FF_CMP_ZERO 7
1945 #define FF_CMP_VSAD 8
1946 #define FF_CMP_VSSE 9
1947 #define FF_CMP_NSSE 10
1948 #define FF_CMP_W53 11
1949 #define FF_CMP_W97 12
1950 #define FF_CMP_DCTMAX 13
1951 #define FF_CMP_DCT264 14
1952 #define FF_CMP_CHROMA 256
1955 * ME diamond size & shape
1956 * - encoding: Set by user.
1957 * - decoding: unused
1962 * amount of previous MV predictors (2a+1 x 2a+1 square)
1963 * - encoding: Set by user.
1964 * - decoding: unused
1966 int last_predictor_count;
1969 * prepass for motion estimation
1970 * - encoding: Set by user.
1971 * - decoding: unused
1976 * motion estimation prepass comparison function
1977 * - encoding: Set by user.
1978 * - decoding: unused
1983 * ME prepass diamond size & shape
1984 * - encoding: Set by user.
1985 * - decoding: unused
1991 * - encoding: Set by user.
1992 * - decoding: unused
1994 int me_subpel_quality;
1997 * callback to negotiate the pixelFormat
1998 * @param fmt is the list of formats which are supported by the codec,
1999 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2000 * The first is always the native one.
2001 * @return the chosen format
2002 * - encoding: unused
2003 * - decoding: Set by user, if not set the native format will be chosen.
2005 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2008 * DTG active format information (additional aspect ratio
2009 * information only used in DVB MPEG-2 transport streams)
2012 * - encoding: unused
2013 * - decoding: Set by decoder.
2015 int dtg_active_format;
2016 #define FF_DTG_AFD_SAME 8
2017 #define FF_DTG_AFD_4_3 9
2018 #define FF_DTG_AFD_16_9 10
2019 #define FF_DTG_AFD_14_9 11
2020 #define FF_DTG_AFD_4_3_SP_14_9 13
2021 #define FF_DTG_AFD_16_9_SP_14_9 14
2022 #define FF_DTG_AFD_SP_4_3 15
2025 * maximum motion estimation search range in subpel units
2026 * If 0 then no limit.
2028 * - encoding: Set by user.
2029 * - decoding: unused
2034 * intra quantizer bias
2035 * - encoding: Set by user.
2036 * - decoding: unused
2038 int intra_quant_bias;
2039 #define FF_DEFAULT_QUANT_BIAS 999999
2042 * inter quantizer bias
2043 * - encoding: Set by user.
2044 * - decoding: unused
2046 int inter_quant_bias;
2050 * - encoding: unused
2051 * - decoding: Which clrtable should be used for 8bit RGB images.
2052 * Tables have to be stored somewhere. FIXME
2057 * Global quality for codecs which cannot change it per frame.
2058 * This should be proportional to MPEG-1/2/4 qscale.
2059 * - encoding: Set by user.
2060 * - decoding: unused
2064 #define FF_CODER_TYPE_VLC 0
2065 #define FF_CODER_TYPE_AC 1
2066 #define FF_CODER_TYPE_RAW 2
2067 #define FF_CODER_TYPE_RLE 3
2068 #define FF_CODER_TYPE_DEFLATE 4
2071 * - encoding: Set by user.
2072 * - decoding: unused
2078 * - encoding: Set by user.
2079 * - decoding: unused
2085 * - encoding: unused
2086 * - decoding: Set by user.
2089 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2090 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2091 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2094 * XVideo Motion Acceleration
2095 * - encoding: forbidden
2096 * - decoding: set by decoder
2098 int xvmc_acceleration;
2101 * macroblock decision mode
2102 * - encoding: Set by user.
2103 * - decoding: unused
2106 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2107 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2108 #define FF_MB_DECISION_RD 2 ///< rate distortion
2111 * custom intra quantization matrix
2112 * - encoding: Set by user, can be NULL.
2113 * - decoding: Set by libavcodec.
2115 uint16_t *intra_matrix;
2118 * custom inter quantization matrix
2119 * - encoding: Set by user, can be NULL.
2120 * - decoding: Set by libavcodec.
2122 uint16_t *inter_matrix;
2125 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2126 * This is used to work around some encoder bugs.
2127 * - encoding: unused
2128 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2130 unsigned int stream_codec_tag;
2133 * scene change detection threshold
2134 * 0 is default, larger means fewer detected scene changes.
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int scenechange_threshold;
2141 * minimum Lagrange multipler
2142 * - encoding: Set by user.
2143 * - decoding: unused
2148 * maximum Lagrange multipler
2149 * - encoding: Set by user.
2150 * - decoding: unused
2155 * noise reduction strength
2156 * - encoding: Set by user.
2157 * - decoding: unused
2159 int noise_reduction;
2162 * Called at the beginning of a frame to get cr buffer for it.
2163 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2164 * libavcodec will pass previous buffer in pic, function should return
2165 * same buffer or new buffer with old frame "painted" into it.
2166 * If pic.data[0] == NULL must behave like get_buffer().
2167 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2168 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2170 * - encoding: unused
2171 * - decoding: Set by libavcodec, user can override.
2173 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2176 * Number of bits which should be loaded into the rc buffer before decoding starts.
2177 * - encoding: Set by user.
2178 * - decoding: unused
2180 int rc_initial_buffer_occupancy;
2184 * - encoding: Set by user.
2185 * - decoding: unused
2187 int inter_threshold;
2191 * - encoding: Set by user.
2192 * - decoding: Set by user.
2197 * Simulates errors in the bitstream to test error concealment.
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * quantizer noise shaping
2205 * - encoding: Set by user.
2206 * - decoding: unused
2208 int quantizer_noise_shaping;
2212 * is used to decide how many independent tasks should be passed to execute()
2213 * - encoding: Set by user.
2214 * - decoding: Set by user.
2219 * The codec may call this to execute several independent things.
2220 * It will return only after finishing all tasks.
2221 * The user may replace this with some multithreaded implementation,
2222 * the default implementation will execute the parts serially.
2223 * @param count the number of things to execute
2224 * - encoding: Set by libavcodec, user can override.
2225 * - decoding: Set by libavcodec, user can override.
2227 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2231 * Can be used by execute() to store some per AVCodecContext stuff.
2232 * - encoding: set by execute()
2233 * - decoding: set by execute()
2235 void *thread_opaque;
2238 * Motion estimation threshold below which no motion estimation is
2239 * performed, but instead the user specified motion vectors are used.
2241 * - encoding: Set by user.
2242 * - decoding: unused
2247 * Macroblock threshold below which the user specified macroblock types will be used.
2248 * - encoding: Set by user.
2249 * - decoding: unused
2254 * precision of the intra DC coefficient - 8
2255 * - encoding: Set by user.
2256 * - decoding: unused
2258 int intra_dc_precision;
2261 * noise vs. sse weight for the nsse comparsion function
2262 * - encoding: Set by user.
2263 * - decoding: unused
2268 * Number of macroblock rows at the top which are skipped.
2269 * - encoding: unused
2270 * - decoding: Set by user.
2275 * Number of macroblock rows at the bottom which are skipped.
2276 * - encoding: unused
2277 * - decoding: Set by user.
2283 * - encoding: Set by user.
2284 * - decoding: Set by libavcodec.
2287 #define FF_PROFILE_UNKNOWN -99
2288 #define FF_PROFILE_RESERVED -100
2290 #define FF_PROFILE_AAC_MAIN 0
2291 #define FF_PROFILE_AAC_LOW 1
2292 #define FF_PROFILE_AAC_SSR 2
2293 #define FF_PROFILE_AAC_LTP 3
2295 #define FF_PROFILE_DTS 20
2296 #define FF_PROFILE_DTS_ES 30
2297 #define FF_PROFILE_DTS_96_24 40
2298 #define FF_PROFILE_DTS_HD_HRA 50
2299 #define FF_PROFILE_DTS_HD_MA 60
2301 #define FF_PROFILE_MPEG2_422 0
2302 #define FF_PROFILE_MPEG2_HIGH 1
2303 #define FF_PROFILE_MPEG2_SS 2
2304 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2305 #define FF_PROFILE_MPEG2_MAIN 4
2306 #define FF_PROFILE_MPEG2_SIMPLE 5
2308 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2309 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2311 #define FF_PROFILE_H264_BASELINE 66
2312 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2313 #define FF_PROFILE_H264_MAIN 77
2314 #define FF_PROFILE_H264_EXTENDED 88
2315 #define FF_PROFILE_H264_HIGH 100
2316 #define FF_PROFILE_H264_HIGH_10 110
2317 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2318 #define FF_PROFILE_H264_HIGH_422 122
2319 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2320 #define FF_PROFILE_H264_HIGH_444 144
2321 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2322 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2323 #define FF_PROFILE_H264_CAVLC_444 44
2325 #define FF_PROFILE_VC1_SIMPLE 0
2326 #define FF_PROFILE_VC1_MAIN 1
2327 #define FF_PROFILE_VC1_COMPLEX 2
2328 #define FF_PROFILE_VC1_ADVANCED 3
2330 #define FF_PROFILE_MPEG4_SIMPLE 0
2331 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2332 #define FF_PROFILE_MPEG4_CORE 2
2333 #define FF_PROFILE_MPEG4_MAIN 3
2334 #define FF_PROFILE_MPEG4_N_BIT 4
2335 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2336 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2337 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2338 #define FF_PROFILE_MPEG4_HYBRID 8
2339 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2340 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2341 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2342 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2343 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2344 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2345 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2349 * - encoding: Set by user.
2350 * - decoding: Set by libavcodec.
2353 #define FF_LEVEL_UNKNOWN -99
2356 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2357 * - encoding: unused
2358 * - decoding: Set by user.
2363 * Bitstream width / height, may be different from width/height if lowres enabled.
2364 * - encoding: unused
2365 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2367 int coded_width, coded_height;
2370 * frame skip threshold
2371 * - encoding: Set by user.
2372 * - decoding: unused
2374 int frame_skip_threshold;
2378 * - encoding: Set by user.
2379 * - decoding: unused
2381 int frame_skip_factor;
2384 * frame skip exponent
2385 * - encoding: Set by user.
2386 * - decoding: unused
2391 * frame skip comparison function
2392 * - encoding: Set by user.
2393 * - decoding: unused
2398 * Border processing masking, raises the quantizer for mbs on the borders
2400 * - encoding: Set by user.
2401 * - decoding: unused
2403 float border_masking;
2406 * minimum MB lagrange multipler
2407 * - encoding: Set by user.
2408 * - decoding: unused
2413 * maximum MB lagrange multipler
2414 * - encoding: Set by user.
2415 * - decoding: unused
2421 * - encoding: Set by user.
2422 * - decoding: unused
2424 int me_penalty_compensation;
2428 * - encoding: unused
2429 * - decoding: Set by user.
2431 enum AVDiscard skip_loop_filter;
2435 * - encoding: unused
2436 * - decoding: Set by user.
2438 enum AVDiscard skip_idct;
2442 * - encoding: unused
2443 * - decoding: Set by user.
2445 enum AVDiscard skip_frame;
2449 * - encoding: Set by user.
2450 * - decoding: unused
2456 * - encoding: Set by user.
2457 * - decoding: unused
2463 * - encoding: Set by user.
2464 * - decoding: unused
2469 * number of reference frames
2470 * - encoding: Set by user.
2471 * - decoding: Set by lavc.
2476 * chroma qp offset from luma
2477 * - encoding: Set by user.
2478 * - decoding: unused
2483 * trellis RD quantization
2484 * - encoding: Set by user.
2485 * - decoding: unused
2490 * Audio cutoff bandwidth (0 means "automatic")
2491 * - encoding: Set by user.
2492 * - decoding: unused
2497 * Multiplied by qscale for each frame and added to scene_change_score.
2498 * - encoding: Set by user.
2499 * - decoding: unused
2501 int scenechange_factor;
2505 * Note: Value depends upon the compare function used for fullpel ME.
2506 * - encoding: Set by user.
2507 * - decoding: unused
2512 * Adjust sensitivity of b_frame_strategy 1.
2513 * - encoding: Set by user.
2514 * - decoding: unused
2519 * - encoding: Set by user.
2520 * - decoding: unused
2522 int compression_level;
2523 #define FF_COMPRESSION_DEFAULT -1
2526 * - encoding: Set by user.
2527 * - decoding: unused
2529 int min_prediction_order;
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 int max_prediction_order;
2538 * GOP timecode frame start number
2539 * - encoding: Set by user, in non drop frame format
2540 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2542 int64_t timecode_frame_start;
2544 #if FF_API_REQUEST_CHANNELS
2546 * Decoder should decode to this many channels if it can (0 for default)
2547 * - encoding: unused
2548 * - decoding: Set by user.
2549 * @deprecated Deprecated in favor of request_channel_layout.
2551 int request_channels;
2555 * opaque 64bit number (generally a PTS) that will be reordered and
2556 * output in AVFrame.reordered_opaque
2557 * @deprecated in favor of pkt_pts
2558 * - encoding: unused
2559 * - decoding: Set by user.
2561 int64_t reordered_opaque;
2564 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2565 * - encoding: set by user.
2566 * - decoding: set by libavcodec.
2568 int bits_per_raw_sample;
2571 * Audio channel layout.
2572 * - encoding: set by user.
2573 * - decoding: set by user, may be overwritten by libavcodec.
2575 uint64_t channel_layout;
2578 * Request decoder to use this channel layout if it can (0 for default)
2579 * - encoding: unused
2580 * - decoding: Set by user.
2582 uint64_t request_channel_layout;
2585 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2586 * - encoding: Set by user.
2587 * - decoding: unused.
2589 float rc_max_available_vbv_use;
2592 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2593 * - encoding: Set by user.
2594 * - decoding: unused.
2596 float rc_min_vbv_overflow_use;
2599 * Hardware accelerator in use
2600 * - encoding: unused.
2601 * - decoding: Set by libavcodec
2603 struct AVHWAccel *hwaccel;
2606 * For some codecs, the time base is closer to the field rate than the frame rate.
2607 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2608 * if no telecine is used ...
2610 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2612 int ticks_per_frame;
2615 * Hardware accelerator context.
2616 * For some hardware accelerators, a global context needs to be
2617 * provided by the user. In that case, this holds display-dependent
2618 * data FFmpeg cannot instantiate itself. Please refer to the
2619 * FFmpeg HW accelerator documentation to know how to fill this
2620 * is. e.g. for VA API, this is a struct vaapi_context.
2621 * - encoding: unused
2622 * - decoding: Set by user
2624 void *hwaccel_context;
2627 * Chromaticity coordinates of the source primaries.
2628 * - encoding: Set by user
2629 * - decoding: Set by libavcodec
2631 enum AVColorPrimaries color_primaries;
2634 * Color Transfer Characteristic.
2635 * - encoding: Set by user
2636 * - decoding: Set by libavcodec
2638 enum AVColorTransferCharacteristic color_trc;
2641 * YUV colorspace type.
2642 * - encoding: Set by user
2643 * - decoding: Set by libavcodec
2645 enum AVColorSpace colorspace;
2648 * MPEG vs JPEG YUV range.
2649 * - encoding: Set by user
2650 * - decoding: Set by libavcodec
2652 enum AVColorRange color_range;
2655 * This defines the location of chroma samples.
2656 * - encoding: Set by user
2657 * - decoding: Set by libavcodec
2659 enum AVChromaLocation chroma_sample_location;
2662 * The codec may call this to execute several independent things.
2663 * It will return only after finishing all tasks.
2664 * The user may replace this with some multithreaded implementation,
2665 * the default implementation will execute the parts serially.
2666 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2667 * @param c context passed also to func
2668 * @param count the number of things to execute
2669 * @param arg2 argument passed unchanged to func
2670 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2671 * @param func function that will be called count times, with jobnr from 0 to count-1.
2672 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2673 * two instances of func executing at the same time will have the same threadnr.
2674 * @return always 0 currently, but code should handle a future improvement where when any call to func
2675 * returns < 0 no further calls to func may be done and < 0 is returned.
2676 * - encoding: Set by libavcodec, user can override.
2677 * - decoding: Set by libavcodec, user can override.
2679 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2681 int log_level_offset;
2685 * Indicates number of picture subdivisions. Used for parallelized
2687 * - encoding: Set by user
2688 * - decoding: unused
2693 * Header containing style information for text subtitles.
2694 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2695 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2696 * the Format line following. It shouldn't include any Dialogue line.
2697 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2698 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2700 uint8_t *subtitle_header;
2701 int subtitle_header_size;
2704 * Current packet as passed into the decoder, to avoid having
2705 * to pass the packet into every function. Currently only valid
2706 * inside lavc and get/release_buffer callbacks.
2707 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2708 * - encoding: unused
2713 * Which multithreading methods to use.
2714 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2715 * so clients which cannot provide future frames should not use it.
2717 * - encoding: Set by user, otherwise the default is used.
2718 * - decoding: Set by user, otherwise the default is used.
2721 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2722 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2725 * Which multithreading methods are in use by the codec.
2726 * - encoding: Set by libavcodec.
2727 * - decoding: Set by libavcodec.
2729 int active_thread_type;
2732 * Set by the client if its custom get_buffer() callback can be called
2733 * from another thread, which allows faster multithreaded decoding.
2734 * draw_horiz_band() will be called from other threads regardless of this setting.
2735 * Ignored if the default get_buffer() is used.
2736 * - encoding: Set by user.
2737 * - decoding: Set by user.
2739 int thread_safe_callbacks;
2742 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2743 * Used for compliant TS muxing.
2744 * - encoding: Set by libavcodec.
2745 * - decoding: unused.
2750 * Type of service that the audio stream conveys.
2751 * - encoding: Set by user.
2752 * - decoding: Set by libavcodec.
2754 enum AVAudioServiceType audio_service_type;
2757 * desired sample format
2758 * - encoding: Not used.
2759 * - decoding: Set by user.
2760 * Decoder will decode to this format if it can.
2762 enum AVSampleFormat request_sample_fmt;
2765 * Error recognition; may misdetect some more or less valid parts as errors.
2766 * - encoding: unused
2767 * - decoding: Set by user.
2769 int err_recognition;
2770 #define AV_EF_CRCCHECK (1<<0)
2771 #define AV_EF_BITSTREAM (1<<1)
2772 #define AV_EF_BUFFER (1<<2)
2773 #define AV_EF_EXPLODE (1<<3)
2775 #define AV_EF_CAREFUL (1<<16)
2776 #define AV_EF_COMPLIANT (1<<17)
2777 #define AV_EF_AGGRESSIVE (1<<18)
2780 * Private context used for internal data.
2782 * Unlike priv_data, this is not codec-specific. It is used in general
2783 * libavcodec functions.
2785 struct AVCodecInternal *internal;
2788 * - encoding: set by libavcodec
2789 * - decoding: Set by libavcodec
2791 enum AVFieldOrder field_order;
2794 * Current statistics for PTS correction.
2795 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2796 * - encoding: unused
2798 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2799 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2800 int64_t pts_correction_last_pts; /// PTS of the last frame
2801 int64_t pts_correction_last_dts; /// DTS of the last frame
2808 typedef struct AVProfile {
2810 const char *name; ///< short name for the profile
2813 typedef struct AVCodecDefault AVCodecDefault;
2818 typedef struct AVCodec {
2820 * Name of the codec implementation.
2821 * The name is globally unique among encoders and among decoders (but an
2822 * encoder and a decoder can share the same name).
2823 * This is the primary way to find a codec from the user perspective.
2827 * Descriptive name for the codec, meant to be more human readable than name.
2828 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2830 const char *long_name;
2831 enum AVMediaType type;
2834 * Codec capabilities.
2838 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2839 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2840 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2841 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2842 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2843 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2844 const AVClass *priv_class; ///< AVClass for the private context
2845 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2847 /*****************************************************************
2848 * No fields below this line are part of the public API. They
2849 * may not be used outside of libavcodec and can be changed and
2851 * New public fields should be added right above.
2852 *****************************************************************
2855 struct AVCodec *next;
2857 * @name Frame-level threading support functions
2861 * If defined, called on thread contexts when they are created.
2862 * If the codec allocates writable tables in init(), re-allocate them here.
2863 * priv_data will be set to a copy of the original.
2865 int (*init_thread_copy)(AVCodecContext *);
2867 * Copy necessary context variables from a previous thread context to the current one.
2868 * If not defined, the next thread will start automatically; otherwise, the codec
2869 * must call ff_thread_finish_setup().
2871 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2873 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2877 * Private codec-specific defaults.
2879 const AVCodecDefault *defaults;
2882 * Initialize codec static data, called from avcodec_register().
2884 void (*init_static_data)(struct AVCodec *codec);
2886 int (*init)(AVCodecContext *);
2887 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2889 * Encode data to an AVPacket.
2891 * @param avctx codec context
2892 * @param avpkt output AVPacket (may contain a user-provided buffer)
2893 * @param[in] frame AVFrame containing the raw data to be encoded
2894 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2895 * non-empty packet was returned in avpkt.
2896 * @return 0 on success, negative error code on failure
2898 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2899 int *got_packet_ptr);
2900 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2901 int (*close)(AVCodecContext *);
2904 * Will be called when seeking
2906 void (*flush)(AVCodecContext *);
2912 typedef struct AVHWAccel {
2914 * Name of the hardware accelerated codec.
2915 * The name is globally unique among encoders and among decoders (but an
2916 * encoder and a decoder can share the same name).
2921 * Type of codec implemented by the hardware accelerator.
2923 * See AVMEDIA_TYPE_xxx
2925 enum AVMediaType type;
2928 * Codec implemented by the hardware accelerator.
2935 * Supported pixel format.
2937 * Only hardware accelerated formats are supported here.
2939 enum PixelFormat pix_fmt;
2942 * Hardware accelerated codec capabilities.
2943 * see FF_HWACCEL_CODEC_CAP_*
2947 struct AVHWAccel *next;
2950 * Called at the beginning of each frame or field picture.
2952 * Meaningful frame information (codec specific) is guaranteed to
2953 * be parsed at this point. This function is mandatory.
2955 * Note that buf can be NULL along with buf_size set to 0.
2956 * Otherwise, this means the whole frame is available at this point.
2958 * @param avctx the codec context
2959 * @param buf the frame data buffer base
2960 * @param buf_size the size of the frame in bytes
2961 * @return zero if successful, a negative value otherwise
2963 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2966 * Callback for each slice.
2968 * Meaningful slice information (codec specific) is guaranteed to
2969 * be parsed at this point. This function is mandatory.
2971 * @param avctx the codec context
2972 * @param buf the slice data buffer base
2973 * @param buf_size the size of the slice in bytes
2974 * @return zero if successful, a negative value otherwise
2976 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2979 * Called at the end of each frame or field picture.
2981 * The whole picture is parsed at this point and can now be sent
2982 * to the hardware accelerator. This function is mandatory.
2984 * @param avctx the codec context
2985 * @return zero if successful, a negative value otherwise
2987 int (*end_frame)(AVCodecContext *avctx);
2990 * Size of HW accelerator private data.
2992 * Private data is allocated with av_mallocz() before
2993 * AVCodecContext.get_buffer() and deallocated after
2994 * AVCodecContext.release_buffer().
3000 * four components are given, that's all.
3001 * the last component is alpha
3003 typedef struct AVPicture {
3004 uint8_t *data[AV_NUM_DATA_POINTERS];
3005 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3008 #define AVPALETTE_SIZE 1024
3009 #define AVPALETTE_COUNT 256
3011 enum AVSubtitleType {
3014 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3017 * Plain text, the text field must be set by the decoder and is
3018 * authoritative. ass and pict fields may contain approximations.
3023 * Formatted text, the ass field must be set by the decoder and is
3024 * authoritative. pict and text fields may contain approximations.
3029 typedef struct AVSubtitleRect {
3030 int x; ///< top left corner of pict, undefined when pict is not set
3031 int y; ///< top left corner of pict, undefined when pict is not set
3032 int w; ///< width of pict, undefined when pict is not set
3033 int h; ///< height of pict, undefined when pict is not set
3034 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3037 * data+linesize for the bitmap of this subtitle.
3038 * can be set for text/ass as well once they where rendered
3041 enum AVSubtitleType type;
3043 char *text; ///< 0 terminated plain UTF-8 text
3046 * 0 terminated ASS/SSA compatible event line.
3047 * The pressentation of this is unaffected by the other values in this
3053 typedef struct AVSubtitle {
3054 uint16_t format; /* 0 = graphics */
3055 uint32_t start_display_time; /* relative to packet pts, in ms */
3056 uint32_t end_display_time; /* relative to packet pts, in ms */
3058 AVSubtitleRect **rects;
3059 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3062 /* packet functions */
3065 * @deprecated use NULL instead
3067 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3070 * Default packet destructor.
3072 void av_destruct_packet(AVPacket *pkt);
3075 * Initialize optional fields of a packet with default values.
3079 void av_init_packet(AVPacket *pkt);
3082 * Allocate the payload of a packet and initialize its fields with
3086 * @param size wanted payload size
3087 * @return 0 if OK, AVERROR_xxx otherwise
3089 int av_new_packet(AVPacket *pkt, int size);
3092 * Reduce packet size, correctly zeroing padding
3095 * @param size new size
3097 void av_shrink_packet(AVPacket *pkt, int size);
3100 * Increase packet size, correctly zeroing padding
3103 * @param grow_by number of bytes by which to increase the size of the packet
3105 int av_grow_packet(AVPacket *pkt, int grow_by);
3108 * @warning This is a hack - the packet memory allocation stuff is broken. The
3109 * packet is allocated if it was not really allocated.
3111 int av_dup_packet(AVPacket *pkt);
3116 * @param pkt packet to free
3118 void av_free_packet(AVPacket *pkt);
3121 * Allocate new information of a packet.
3124 * @param type side information type
3125 * @param size side information size
3126 * @return pointer to fresh allocated data or NULL otherwise
3128 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3132 * Get side information from packet.
3135 * @param type desired side information type
3136 * @param size pointer for side information size to store (optional)
3137 * @return pointer to data if present or NULL otherwise
3139 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3142 int av_packet_merge_side_data(AVPacket *pkt);
3144 int av_packet_split_side_data(AVPacket *pkt);
3149 struct ReSampleContext;
3150 struct AVResampleContext;
3152 typedef struct ReSampleContext ReSampleContext;
3155 * Initialize audio resampling context.
3157 * @param output_channels number of output channels
3158 * @param input_channels number of input channels
3159 * @param output_rate output sample rate
3160 * @param input_rate input sample rate
3161 * @param sample_fmt_out requested output sample format
3162 * @param sample_fmt_in input sample format
3163 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3164 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3165 * @param linear if 1 then the used FIR filter will be linearly interpolated
3166 between the 2 closest, if 0 the closest will be used
3167 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3168 * @return allocated ReSampleContext, NULL if error occurred
3170 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3171 int output_rate, int input_rate,
3172 enum AVSampleFormat sample_fmt_out,
3173 enum AVSampleFormat sample_fmt_in,
3174 int filter_length, int log2_phase_count,
3175 int linear, double cutoff);
3177 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3180 * Free resample context.
3182 * @param s a non-NULL pointer to a resample context previously
3183 * created with av_audio_resample_init()
3185 void audio_resample_close(ReSampleContext *s);
3189 * Initialize an audio resampler.
3190 * Note, if either rate is not an integer then simply scale both rates up so they are.
3191 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3192 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3193 * @param linear If 1 then the used FIR filter will be linearly interpolated
3194 between the 2 closest, if 0 the closest will be used
3195 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3197 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3200 * Resample an array of samples using a previously configured context.
3201 * @param src an array of unconsumed samples
3202 * @param consumed the number of samples of src which have been consumed are returned here
3203 * @param src_size the number of unconsumed samples available
3204 * @param dst_size the amount of space in samples available in dst
3205 * @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.
3206 * @return the number of samples written in dst or -1 if an error occurred
3208 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3212 * Compensate samplerate/timestamp drift. The compensation is done by changing
3213 * the resampler parameters, so no audible clicks or similar distortions occur
3214 * @param compensation_distance distance in output samples over which the compensation should be performed
3215 * @param sample_delta number of output samples which should be output less
3217 * example: av_resample_compensate(c, 10, 500)
3218 * here instead of 510 samples only 500 samples would be output
3220 * note, due to rounding the actual compensation might be slightly different,
3221 * especially if the compensation_distance is large and the in_rate used during init is small
3223 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3224 void av_resample_close(struct AVResampleContext *c);
3227 * Allocate memory for a picture. Call avpicture_free() to free it.
3229 * @see avpicture_fill()
3231 * @param picture the picture to be filled in
3232 * @param pix_fmt the format of the picture
3233 * @param width the width of the picture
3234 * @param height the height of the picture
3235 * @return zero if successful, a negative value if not
3237 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3240 * Free a picture previously allocated by avpicture_alloc().
3241 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3244 * @param picture the AVPicture to be freed
3246 void avpicture_free(AVPicture *picture);
3249 * Fill in the AVPicture fields.
3250 * The fields of the given AVPicture are filled in by using the 'ptr' address
3251 * which points to the image data buffer. Depending on the specified picture
3252 * format, one or multiple image data pointers and line sizes will be set.
3253 * If a planar format is specified, several pointers will be set pointing to
3254 * the different picture planes and the line sizes of the different planes
3255 * will be stored in the lines_sizes array.
3256 * Call with ptr == NULL to get the required size for the ptr buffer.
3258 * To allocate the buffer and fill in the AVPicture fields in one call,
3259 * use avpicture_alloc().
3261 * @param picture AVPicture whose fields are to be filled in
3262 * @param ptr Buffer which will contain or contains the actual image data
3263 * @param pix_fmt The format in which the picture data is stored.
3264 * @param width the width of the image in pixels
3265 * @param height the height of the image in pixels
3266 * @return size of the image data in bytes
3268 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3269 enum PixelFormat pix_fmt, int width, int height);
3272 * Copy pixel data from an AVPicture into a buffer.
3273 * The data is stored compactly, without any gaps for alignment or padding
3274 * which may be applied by avpicture_fill().
3276 * @see avpicture_get_size()
3278 * @param[in] src AVPicture containing image data
3279 * @param[in] pix_fmt The format in which the picture data is stored.
3280 * @param[in] width the width of the image in pixels.
3281 * @param[in] height the height of the image in pixels.
3282 * @param[out] dest A buffer into which picture data will be copied.
3283 * @param[in] dest_size The size of 'dest'.
3284 * @return The number of bytes written to dest, or a negative value (error code) on error.
3286 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3287 unsigned char *dest, int dest_size);
3290 * Calculate the size in bytes that a picture of the given width and height
3291 * would occupy if stored in the given picture format.
3292 * Note that this returns the size of a compact representation as generated
3293 * by avpicture_layout(), which can be smaller than the size required for e.g.
3296 * @param pix_fmt the given picture format
3297 * @param width the width of the image
3298 * @param height the height of the image
3299 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3301 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3302 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3305 * Get the name of a codec.
3306 * @return a static string identifying the codec; never NULL
3308 const char *avcodec_get_name(enum CodecID id);
3310 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3313 * Return a value representing the fourCC code associated to the
3314 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3317 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3320 * Put a string representing the codec tag codec_tag in buf.
3322 * @param buf_size size in bytes of buf
3323 * @return the length of the string that would have been generated if
3324 * enough space had been available, excluding the trailing null
3326 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3328 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3329 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3330 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3331 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3332 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3333 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3336 * Compute what kind of losses will occur when converting from one specific
3337 * pixel format to another.
3338 * When converting from one pixel format to another, information loss may occur.
3339 * For example, when converting from RGB24 to GRAY, the color information will
3340 * be lost. Similarly, other losses occur when converting from some formats to
3341 * other formats. These losses can involve loss of chroma, but also loss of
3342 * resolution, loss of color depth, loss due to the color space conversion, loss
3343 * of the alpha bits or loss due to color quantization.
3344 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3345 * which will occur when converting from one pixel format to another.
3347 * @param[in] dst_pix_fmt destination pixel format
3348 * @param[in] src_pix_fmt source pixel format
3349 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3350 * @return Combination of flags informing you what kind of losses will occur
3351 * (maximum loss for an invalid dst_pix_fmt).
3353 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3357 * Find the best pixel format to convert to given a certain source pixel
3358 * format. When converting from one pixel format to another, information loss
3359 * may occur. For example, when converting from RGB24 to GRAY, the color
3360 * information will be lost. Similarly, other losses occur when converting from
3361 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3362 * the given pixel formats should be used to suffer the least amount of loss.
3363 * The pixel formats from which it chooses one, are determined by the
3364 * pix_fmt_mask parameter.
3366 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3369 * src_pix_fmt = PIX_FMT_YUV420P;
3370 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3371 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3374 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3375 * @param[in] src_pix_fmt source pixel format
3376 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3377 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3378 * @return The best pixel format to convert to or -1 if none was found.
3380 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3381 int has_alpha, int *loss_ptr);
3384 * Find the best pixel format to convert to given a certain source pixel
3385 * format and a selection of two destination pixel formats. When converting from
3386 * one pixel format to another, information loss may occur. For example, when converting
3387 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3388 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3389 * the given pixel formats should be used to suffer the least amount of loss.
3391 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3395 * src_pix_fmt = PIX_FMT_YUV420P;
3396 * dst_pix_fmt1= PIX_FMT_RGB24;
3397 * dst_pix_fmt2= PIX_FMT_GRAY8;
3398 * dst_pix_fmt3= PIX_FMT_RGB8;
3399 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3400 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3401 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3404 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3405 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3406 * @param[in] src_pix_fmt Source pixel format
3407 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3408 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3409 * NULL or value of zero means we care about all losses. Out: the loss
3410 * that occurs when converting from src to selected dst pixel format.
3411 * @return The best pixel format to convert to or -1 if none was found.
3413 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3414 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3417 /* deinterlace a picture */
3418 /* deinterlace - if not supported return -1 */
3419 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3420 enum PixelFormat pix_fmt, int width, int height);
3422 /* external high level API */
3425 * If c is NULL, returns the first registered codec,
3426 * if c is non-NULL, returns the next registered codec after c,
3427 * or NULL if c is the last one.
3429 AVCodec *av_codec_next(AVCodec *c);
3432 * Return the LIBAVCODEC_VERSION_INT constant.
3434 unsigned avcodec_version(void);
3437 * Return the libavcodec build-time configuration.
3439 const char *avcodec_configuration(void);
3442 * Return the libavcodec license.
3444 const char *avcodec_license(void);
3447 * Register the codec codec and initialize libavcodec.
3449 * @warning either this function or avcodec_register_all() must be called
3450 * before any other libavcodec functions.
3452 * @see avcodec_register_all()
3454 void avcodec_register(AVCodec *codec);
3457 * Find a registered encoder with a matching codec ID.
3459 * @param id CodecID of the requested encoder
3460 * @return An encoder if one was found, NULL otherwise.
3462 AVCodec *avcodec_find_encoder(enum CodecID id);
3465 * Find a registered encoder with the specified name.
3467 * @param name name of the requested encoder
3468 * @return An encoder if one was found, NULL otherwise.
3470 AVCodec *avcodec_find_encoder_by_name(const char *name);
3473 * Find a registered decoder with a matching codec ID.
3475 * @param id CodecID of the requested decoder
3476 * @return A decoder if one was found, NULL otherwise.
3478 AVCodec *avcodec_find_decoder(enum CodecID id);
3481 * Find a registered decoder with the specified name.
3483 * @param name name of the requested decoder
3484 * @return A decoder if one was found, NULL otherwise.
3486 AVCodec *avcodec_find_decoder_by_name(const char *name);
3487 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3490 * Return a name for the specified profile, if available.
3492 * @param codec the codec that is searched for the given profile
3493 * @param profile the profile value for which a name is requested
3494 * @return A name for the profile if found, NULL otherwise.
3496 const char *av_get_profile_name(const AVCodec *codec, int profile);
3498 #if FF_API_ALLOC_CONTEXT
3500 * Set the fields of the given AVCodecContext to default values.
3502 * @param s The AVCodecContext of which the fields should be set to default values.
3503 * @deprecated use avcodec_get_context_defaults3
3505 attribute_deprecated
3506 void avcodec_get_context_defaults(AVCodecContext *s);
3508 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3509 * we WILL change its arguments and name a few times! */
3510 attribute_deprecated
3511 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3515 * Set the fields of the given AVCodecContext to default values corresponding
3516 * to the given codec (defaults may be codec-dependent).
3518 * Do not call this function if a non-NULL codec has been passed
3519 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3520 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3521 * different codec on this AVCodecContext.
3523 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3525 #if FF_API_ALLOC_CONTEXT
3527 * Allocate an AVCodecContext and set its fields to default values. The
3528 * resulting struct can be deallocated by simply calling av_free().
3530 * @return An AVCodecContext filled with default values or NULL on failure.
3531 * @see avcodec_get_context_defaults
3533 * @deprecated use avcodec_alloc_context3()
3535 attribute_deprecated
3536 AVCodecContext *avcodec_alloc_context(void);
3538 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3539 * we WILL change its arguments and name a few times! */
3540 attribute_deprecated
3541 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3545 * Allocate an AVCodecContext and set its fields to default values. The
3546 * resulting struct can be deallocated by calling avcodec_close() on it followed
3549 * @param codec if non-NULL, allocate private data and initialize defaults
3550 * for the given codec. It is illegal to then call avcodec_open2()
3551 * with a different codec.
3552 * If NULL, then the codec-specific defaults won't be initialized,
3553 * which may result in suboptimal default settings (this is
3554 * important mainly for encoders, e.g. libx264).
3556 * @return An AVCodecContext filled with default values or NULL on failure.
3557 * @see avcodec_get_context_defaults
3559 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3562 * Copy the settings of the source AVCodecContext into the destination
3563 * AVCodecContext. The resulting destination codec context will be
3564 * unopened, i.e. you are required to call avcodec_open2() before you
3565 * can use this AVCodecContext to decode/encode video/audio data.
3567 * @param dest target codec context, should be initialized with
3568 * avcodec_alloc_context3(), but otherwise uninitialized
3569 * @param src source codec context
3570 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3572 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3575 * Set the fields of the given AVFrame to default values.
3577 * @param pic The AVFrame of which the fields should be set to default values.
3579 void avcodec_get_frame_defaults(AVFrame *pic);
3582 * Allocate an AVFrame and set its fields to default values. The resulting
3583 * struct can be deallocated by simply calling av_free().
3585 * @return An AVFrame filled with default values or NULL on failure.
3586 * @see avcodec_get_frame_defaults
3588 AVFrame *avcodec_alloc_frame(void);
3590 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3591 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3592 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3595 * Return the amount of padding in pixels which the get_buffer callback must
3596 * provide around the edge of the image for codecs which do not have the
3597 * CODEC_FLAG_EMU_EDGE flag.
3599 * @return Required padding in pixels.
3601 unsigned avcodec_get_edge_width(void);
3603 * Modify width and height values so that they will result in a memory
3604 * buffer that is acceptable for the codec if you do not use any horizontal
3607 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3608 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3609 * according to avcodec_get_edge_width() before.
3611 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3613 * Modify width and height values so that they will result in a memory
3614 * buffer that is acceptable for the codec if you also ensure that all
3615 * line sizes are a multiple of the respective linesize_align[i].
3617 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3618 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3619 * according to avcodec_get_edge_width() before.
3621 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3622 int linesize_align[AV_NUM_DATA_POINTERS]);
3624 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3626 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3627 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3628 //FIXME func typedef
3630 #if FF_API_AVCODEC_OPEN
3632 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3633 * function the context has to be allocated.
3635 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3636 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3637 * retrieving a codec.
3639 * @warning This function is not thread safe!
3642 * avcodec_register_all();
3643 * codec = avcodec_find_decoder(CODEC_ID_H264);
3647 * context = avcodec_alloc_context3(codec);
3649 * if (avcodec_open(context, codec) < 0)
3653 * @param avctx The context which will be set up to use the given codec.
3654 * @param codec The codec to use within the context.
3655 * @return zero on success, a negative value on error
3656 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3658 * @deprecated use avcodec_open2
3660 attribute_deprecated
3661 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3665 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3666 * function the context has to be allocated with avcodec_alloc_context3().
3668 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3669 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3670 * retrieving a codec.
3672 * @warning This function is not thread safe!
3675 * avcodec_register_all();
3676 * av_dict_set(&opts, "b", "2.5M", 0);
3677 * codec = avcodec_find_decoder(CODEC_ID_H264);
3681 * context = avcodec_alloc_context3(codec);
3683 * if (avcodec_open2(context, codec, opts) < 0)
3687 * @param avctx The context to initialize.
3688 * @param codec The codec to open this context for. If a non-NULL codec has been
3689 * previously passed to avcodec_alloc_context3() or
3690 * avcodec_get_context_defaults3() for this context, then this
3691 * parameter MUST be either NULL or equal to the previously passed
3693 * @param options A dictionary filled with AVCodecContext and codec-private options.
3694 * On return this object will be filled with options that were not found.
3696 * @return zero on success, a negative value on error
3697 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3698 * av_dict_set(), av_opt_find().
3700 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3702 #if FF_API_OLD_DECODE_AUDIO
3704 * Wrapper function which calls avcodec_decode_audio4.
3706 * @deprecated Use avcodec_decode_audio4 instead.
3708 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3709 * Some decoders may support multiple frames in a single AVPacket, such
3710 * decoders would then just decode the first frame. In this case,
3711 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3712 * the remaining data in order to decode the second frame etc.
3714 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3715 * decompressed frame size in bytes.
3717 * @warning You must set frame_size_ptr to the allocated size of the
3718 * output buffer before calling avcodec_decode_audio3().
3720 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3721 * the actual read bytes because some optimized bitstream readers read 32 or 64
3722 * bits at once and could read over the end.
3724 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3725 * no overreading happens for damaged MPEG streams.
3727 * @warning You must not provide a custom get_buffer() when using
3728 * avcodec_decode_audio3(). Doing so will override it with
3729 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3730 * which does allow the application to provide a custom get_buffer().
3732 * @note You might have to align the input buffer avpkt->data and output buffer
3733 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3734 * necessary at all, on others it won't work at all if not aligned and on others
3735 * it will work but it will have an impact on performance.
3737 * In practice, avpkt->data should have 4 byte alignment at minimum and
3738 * samples should be 16 byte aligned unless the CPU doesn't need it
3739 * (AltiVec and SSE do).
3741 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3742 * between input and output, these need to be fed with avpkt->data=NULL,
3743 * avpkt->size=0 at the end to return the remaining frames.
3745 * @param avctx the codec context
3746 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3747 * If the sample format is planar, each channel plane will
3748 * be the same size, with no padding between channels.
3749 * @param[in,out] frame_size_ptr the output buffer size in bytes
3750 * @param[in] avpkt The input AVPacket containing the input buffer.
3751 * You can create such packet with av_init_packet() and by then setting
3752 * data and size, some decoders might in addition need other fields.
3753 * All decoders are designed to use the least fields possible though.
3754 * @return On error a negative value is returned, otherwise the number of bytes
3755 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3757 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3758 int *frame_size_ptr,
3763 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3765 * Some decoders may support multiple frames in a single AVPacket. Such
3766 * decoders would then just decode the first frame. In this case,
3767 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3768 * the remaining data in order to decode the second frame, etc...
3769 * Even if no frames are returned, the packet needs to be fed to the decoder
3770 * with remaining data until it is completely consumed or an error occurs.
3772 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3773 * larger than the actual read bytes because some optimized bitstream
3774 * readers read 32 or 64 bits at once and could read over the end.
3776 * @note You might have to align the input buffer. The alignment requirements
3777 * depend on the CPU and the decoder.
3779 * @param avctx the codec context
3780 * @param[out] frame The AVFrame in which to store decoded audio samples.
3781 * Decoders request a buffer of a particular size by setting
3782 * AVFrame.nb_samples prior to calling get_buffer(). The
3783 * decoder may, however, only utilize part of the buffer by
3784 * setting AVFrame.nb_samples to a smaller value in the
3786 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3788 * @param[in] avpkt The input AVPacket containing the input buffer.
3789 * At least avpkt->data and avpkt->size should be set. Some
3790 * decoders might also require additional fields to be set.
3791 * @return A negative error code is returned if an error occurred during
3792 * decoding, otherwise the number of bytes consumed from the input
3793 * AVPacket is returned.
3795 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3796 int *got_frame_ptr, AVPacket *avpkt);
3799 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3800 * Some decoders may support multiple frames in a single AVPacket, such
3801 * decoders would then just decode the first frame.
3803 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3804 * the actual read bytes because some optimized bitstream readers read 32 or 64
3805 * bits at once and could read over the end.
3807 * @warning The end of the input buffer buf should be set to 0 to ensure that
3808 * no overreading happens for damaged MPEG streams.
3810 * @note You might have to align the input buffer avpkt->data.
3811 * The alignment requirements depend on the CPU: on some CPUs it isn't
3812 * necessary at all, on others it won't work at all if not aligned and on others
3813 * it will work but it will have an impact on performance.
3815 * In practice, avpkt->data should have 4 byte alignment at minimum.
3817 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3818 * between input and output, these need to be fed with avpkt->data=NULL,
3819 * avpkt->size=0 at the end to return the remaining frames.
3821 * @param avctx the codec context
3822 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3823 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3824 * allocate memory for the actual bitmap.
3825 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3826 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3827 * decodes and the decoder tells the user once it does not need the data anymore,
3828 * the user app can at this point free/reuse/keep the memory as it sees fit.
3830 * @param[in] avpkt The input AVpacket containing the input buffer.
3831 * You can create such packet with av_init_packet() and by then setting
3832 * data and size, some decoders might in addition need other fields like
3833 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3835 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3836 * @return On error a negative value is returned, otherwise the number of bytes
3837 * used or zero if no frame could be decompressed.
3839 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3840 int *got_picture_ptr,
3841 const AVPacket *avpkt);
3844 * Decode a subtitle message.
3845 * Return a negative value on error, otherwise return the number of bytes used.
3846 * If no subtitle could be decompressed, got_sub_ptr is zero.
3847 * Otherwise, the subtitle is stored in *sub.
3848 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3849 * simplicity, because the performance difference is expect to be negligible
3850 * and reusing a get_buffer written for video codecs would probably perform badly
3851 * due to a potentially very different allocation pattern.
3853 * @param avctx the codec context
3854 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3855 freed with avsubtitle_free if *got_sub_ptr is set.
3856 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3857 * @param[in] avpkt The input AVPacket containing the input buffer.
3859 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3864 * Free all allocated data in the given subtitle struct.
3866 * @param sub AVSubtitle to free.
3868 void avsubtitle_free(AVSubtitle *sub);
3870 #if FF_API_OLD_ENCODE_AUDIO
3872 * Encode an audio frame from samples into buf.
3874 * @deprecated Use avcodec_encode_audio2 instead.
3876 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3877 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3878 * will know how much space is needed because it depends on the value passed
3879 * in buf_size as described below. In that case a lower value can be used.
3881 * @param avctx the codec context
3882 * @param[out] buf the output buffer
3883 * @param[in] buf_size the output buffer size
3884 * @param[in] samples the input buffer containing the samples
3885 * The number of samples read from this buffer is frame_size*channels,
3886 * both of which are defined in avctx.
3887 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3888 * samples read from samples is equal to:
3889 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3890 * This also implies that av_get_bits_per_sample() must not return 0 for these
3892 * @return On error a negative value is returned, on success zero or the number
3893 * of bytes used to encode the data read from the input buffer.
3895 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3896 uint8_t *buf, int buf_size,
3897 const short *samples);
3901 * Encode a frame of audio.
3903 * Takes input samples from frame and writes the next output packet, if
3904 * available, to avpkt. The output packet does not necessarily contain data for
3905 * the most recent frame, as encoders can delay, split, and combine input frames
3906 * internally as needed.
3908 * @param avctx codec context
3909 * @param avpkt output AVPacket.
3910 * The user can supply an output buffer by setting
3911 * avpkt->data and avpkt->size prior to calling the
3912 * function, but if the size of the user-provided data is not
3913 * large enough, encoding will fail. All other AVPacket fields
3914 * will be reset by the encoder using av_init_packet(). If
3915 * avpkt->data is NULL, the encoder will allocate it.
3916 * The encoder will set avpkt->size to the size of the
3918 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3919 * May be NULL when flushing an encoder that has the
3920 * CODEC_CAP_DELAY capability set.
3921 * There are 2 codec capabilities that affect the allowed
3922 * values of frame->nb_samples.
3923 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3924 * frame may be smaller than avctx->frame_size, and all other
3925 * frames must be equal to avctx->frame_size.
3926 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3927 * can have any number of samples.
3928 * If neither is set, frame->nb_samples must be equal to
3929 * avctx->frame_size for all frames.
3930 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3931 * output packet is non-empty, and to 0 if it is
3932 * empty. If the function returns an error, the
3933 * packet can be assumed to be invalid, and the
3934 * value of got_packet_ptr is undefined and should
3936 * @return 0 on success, negative error code on failure
3938 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3939 const AVFrame *frame, int *got_packet_ptr);
3942 * Fill audio frame data and linesize.
3943 * AVFrame extended_data channel pointers are allocated if necessary for
3946 * @param frame the AVFrame
3947 * frame->nb_samples must be set prior to calling the
3948 * function. This function fills in frame->data,
3949 * frame->extended_data, frame->linesize[0].
3950 * @param nb_channels channel count
3951 * @param sample_fmt sample format
3952 * @param buf buffer to use for frame data
3953 * @param buf_size size of buffer
3954 * @param align plane size sample alignment
3955 * @return 0 on success, negative error code on failure
3957 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3958 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3959 int buf_size, int align);
3961 #if FF_API_OLD_ENCODE_VIDEO
3963 * @deprecated use avcodec_encode_video2() instead.
3965 * Encode a video frame from pict into buf.
3966 * The input picture should be
3967 * stored using a specific format, namely avctx.pix_fmt.
3969 * @param avctx the codec context
3970 * @param[out] buf the output buffer for the bitstream of encoded frame
3971 * @param[in] buf_size the size of the output buffer in bytes
3972 * @param[in] pict the input picture to encode
3973 * @return On error a negative value is returned, on success zero or the number
3974 * of bytes used from the output buffer.
3976 attribute_deprecated
3977 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3978 const AVFrame *pict);
3982 * Encode a frame of video.
3984 * Takes input raw video data from frame and writes the next output packet, if
3985 * available, to avpkt. The output packet does not necessarily contain data for
3986 * the most recent frame, as encoders can delay and reorder input frames
3987 * internally as needed.
3989 * @param avctx codec context
3990 * @param avpkt output AVPacket.
3991 * The user can supply an output buffer by setting
3992 * avpkt->data and avpkt->size prior to calling the
3993 * function, but if the size of the user-provided data is not
3994 * large enough, encoding will fail. All other AVPacket fields
3995 * will be reset by the encoder using av_init_packet(). If
3996 * avpkt->data is NULL, the encoder will allocate it.
3997 * The encoder will set avpkt->size to the size of the
3998 * output packet. The returned data (if any) belongs to the
3999 * caller, he is responsible for freeing it.
4000 * @param[in] frame AVFrame containing the raw video data to be encoded.
4001 * May be NULL when flushing an encoder that has the
4002 * CODEC_CAP_DELAY capability set.
4003 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4004 * output packet is non-empty, and to 0 if it is
4005 * empty. If the function returns an error, the
4006 * packet can be assumed to be invalid, and the
4007 * value of got_packet_ptr is undefined and should
4009 * @return 0 on success, negative error code on failure
4011 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4012 const AVFrame *frame, int *got_packet_ptr);
4014 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4015 const AVSubtitle *sub);
4018 * Close a given AVCodecContext and free all the data associated with it
4019 * (but not the AVCodecContext itself).
4021 * Calling this function on an AVCodecContext that hasn't been opened will free
4022 * the codec-specific data allocated in avcodec_alloc_context3() /
4023 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4026 int avcodec_close(AVCodecContext *avctx);
4029 * Register all the codecs, parsers and bitstream filters which were enabled at
4030 * configuration time. If you do not call this function you can select exactly
4031 * which formats you want to support, by using the individual registration
4034 * @see avcodec_register
4035 * @see av_register_codec_parser
4036 * @see av_register_bitstream_filter
4038 void avcodec_register_all(void);
4041 * Flush buffers, should be called when seeking or when switching to a different stream.
4043 void avcodec_flush_buffers(AVCodecContext *avctx);
4045 void avcodec_default_free_buffers(AVCodecContext *s);
4047 /* misc useful functions */
4050 * Return codec bits per sample.
4052 * @param[in] codec_id the codec
4053 * @return Number of bits per sample or zero if unknown for the given codec.
4055 int av_get_bits_per_sample(enum CodecID codec_id);
4058 typedef struct AVCodecParserContext {
4060 struct AVCodecParser *parser;
4061 int64_t frame_offset; /* offset of the current frame */
4062 int64_t cur_offset; /* current offset
4063 (incremented by each av_parser_parse()) */
4064 int64_t next_frame_offset; /* offset of the next frame */
4066 int pict_type; /* XXX: Put it back in AVCodecContext. */
4068 * This field is used for proper frame duration computation in lavf.
4069 * It signals, how much longer the frame duration of the current frame
4070 * is compared to normal frame duration.
4072 * frame_duration = (1 + repeat_pict) * time_base
4074 * It is used by codecs like H.264 to display telecined material.
4076 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4077 int64_t pts; /* pts of the current frame */
4078 int64_t dts; /* dts of the current frame */
4083 int fetch_timestamp;
4085 #define AV_PARSER_PTS_NB 4
4086 int cur_frame_start_index;
4087 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4088 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4089 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4092 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4093 #define PARSER_FLAG_ONCE 0x0002
4094 /// Set if the parser has a valid file offset
4095 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4097 int64_t offset; ///< byte offset from starting packet start
4098 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4101 * Set by parser to 1 for key frames and 0 for non-key frames.
4102 * It is initialized to -1, so if the parser doesn't set this flag,
4103 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4109 * Time difference in stream time base units from the pts of this
4110 * packet to the point at which the output from the decoder has converged
4111 * independent from the availability of previous frames. That is, the
4112 * frames are virtually identical no matter if decoding started from
4113 * the very first frame or from this keyframe.
4114 * Is AV_NOPTS_VALUE if unknown.
4115 * This field is not the display duration of the current frame.
4116 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4119 * The purpose of this field is to allow seeking in streams that have no
4120 * keyframes in the conventional sense. It corresponds to the
4121 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4122 * essential for some types of subtitle streams to ensure that all
4123 * subtitles are correctly displayed after seeking.
4125 int64_t convergence_duration;
4127 // Timestamp generation support:
4129 * Synchronization point for start of timestamp generation.
4131 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4134 * For example, this corresponds to presence of H.264 buffering period
4140 * Offset of the current timestamp against last timestamp sync point in
4141 * units of AVCodecContext.time_base.
4143 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4144 * contain a valid timestamp offset.
4146 * Note that the timestamp of sync point has usually a nonzero
4147 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4148 * the next frame after timestamp sync point will be usually 1.
4150 * For example, this corresponds to H.264 cpb_removal_delay.
4152 int dts_ref_dts_delta;
4155 * Presentation delay of current frame in units of AVCodecContext.time_base.
4157 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4158 * contain valid non-negative timestamp delta (presentation time of a frame
4159 * must not lie in the past).
4161 * This delay represents the difference between decoding and presentation
4162 * time of the frame.
4164 * For example, this corresponds to H.264 dpb_output_delay.
4169 * Position of the packet in file.
4171 * Analogous to cur_frame_pts/dts
4173 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4176 * Byte position of currently parsed frame in stream.
4181 * Previous frame byte position.
4184 } AVCodecParserContext;
4186 typedef struct AVCodecParser {
4187 int codec_ids[5]; /* several codec IDs are permitted */
4189 int (*parser_init)(AVCodecParserContext *s);
4190 int (*parser_parse)(AVCodecParserContext *s,
4191 AVCodecContext *avctx,
4192 const uint8_t **poutbuf, int *poutbuf_size,
4193 const uint8_t *buf, int buf_size);
4194 void (*parser_close)(AVCodecParserContext *s);
4195 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4196 struct AVCodecParser *next;
4199 AVCodecParser *av_parser_next(AVCodecParser *c);
4201 void av_register_codec_parser(AVCodecParser *parser);
4202 AVCodecParserContext *av_parser_init(int codec_id);
4207 * @param s parser context.
4208 * @param avctx codec context.
4209 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4210 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4211 * @param buf input buffer.
4212 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4213 * @param pts input presentation timestamp.
4214 * @param dts input decoding timestamp.
4215 * @param pos input byte position in stream.
4216 * @return the number of bytes of the input bitstream used.
4221 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4228 * decode_frame(data, size);
4232 int av_parser_parse2(AVCodecParserContext *s,
4233 AVCodecContext *avctx,
4234 uint8_t **poutbuf, int *poutbuf_size,
4235 const uint8_t *buf, int buf_size,
4236 int64_t pts, int64_t dts,
4239 int av_parser_change(AVCodecParserContext *s,
4240 AVCodecContext *avctx,
4241 uint8_t **poutbuf, int *poutbuf_size,
4242 const uint8_t *buf, int buf_size, int keyframe);
4243 void av_parser_close(AVCodecParserContext *s);
4246 typedef struct AVBitStreamFilterContext {
4248 struct AVBitStreamFilter *filter;
4249 AVCodecParserContext *parser;
4250 struct AVBitStreamFilterContext *next;
4251 } AVBitStreamFilterContext;
4254 typedef struct AVBitStreamFilter {
4257 int (*filter)(AVBitStreamFilterContext *bsfc,
4258 AVCodecContext *avctx, const char *args,
4259 uint8_t **poutbuf, int *poutbuf_size,
4260 const uint8_t *buf, int buf_size, int keyframe);
4261 void (*close)(AVBitStreamFilterContext *bsfc);
4262 struct AVBitStreamFilter *next;
4263 } AVBitStreamFilter;
4265 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4266 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4267 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4268 AVCodecContext *avctx, const char *args,
4269 uint8_t **poutbuf, int *poutbuf_size,
4270 const uint8_t *buf, int buf_size, int keyframe);
4271 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4273 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4278 * Reallocate the given block if it is not large enough, otherwise do nothing.
4282 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4285 * Allocate a buffer, reusing the given one if large enough.
4287 * Contrary to av_fast_realloc the current buffer contents might not be
4288 * preserved and on error the old buffer is freed, thus no special
4289 * handling to avoid memleaks is necessary.
4291 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4292 * @param size size of the buffer *ptr points to
4293 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4294 * *size 0 if an error occurred.
4296 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4299 * Same behaviour av_fast_malloc but the buffer has additional
4300 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4302 * In addition the whole buffer will initially and after resizes
4303 * be 0-initialized so that no uninitialized data will ever appear.
4305 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4308 * Copy image src to dst. Wraps av_picture_data_copy() above.
4310 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4311 enum PixelFormat pix_fmt, int width, int height);
4314 * Crop image top and left side.
4316 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4317 enum PixelFormat pix_fmt, int top_band, int left_band);
4322 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4323 int padtop, int padbottom, int padleft, int padright, int *color);
4326 * Encode extradata length to a buffer. Used by xiph codecs.
4328 * @param s buffer to write to; must be at least (v/255+1) bytes long
4329 * @param v size of extradata in bytes
4330 * @return number of bytes written to the buffer.
4332 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4335 * Log a generic warning message about a missing feature. This function is
4336 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4337 * only, and would normally not be used by applications.
4338 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4339 * a pointer to an AVClass struct
4340 * @param[in] feature string containing the name of the missing feature
4341 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4342 * If want_sample is non-zero, additional verbage will be added to the log
4343 * message which tells the user how to report samples to the development
4346 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4349 * Log a generic warning message asking for a sample. This function is
4350 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4351 * only, and would normally not be used by applications.
4352 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4353 * a pointer to an AVClass struct
4354 * @param[in] msg string containing an optional message, or NULL if no message
4356 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4359 * Register the hardware accelerator hwaccel.
4361 void av_register_hwaccel(AVHWAccel *hwaccel);
4364 * If hwaccel is NULL, returns the first registered hardware accelerator,
4365 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4366 * after hwaccel, or NULL if hwaccel is the last one.
4368 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4372 * Lock operation used by lockmgr
4375 AV_LOCK_CREATE, ///< Create a mutex
4376 AV_LOCK_OBTAIN, ///< Lock the mutex
4377 AV_LOCK_RELEASE, ///< Unlock the mutex
4378 AV_LOCK_DESTROY, ///< Free mutex resources
4382 * Register a user provided lock manager supporting the operations
4383 * specified by AVLockOp. mutex points to a (void *) where the
4384 * lockmgr should store/get a pointer to a user allocated mutex. It's
4385 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4387 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4388 * callback during the call to av_lockmgr_register().
4389 * Thus, the application must be prepared to handle that.
4390 * If cb is set to NULL the lockmgr will be unregistered.
4391 * Also note that during unregistration the previously registered
4392 * lockmgr callback may also be invoked.
4394 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4397 * Get the type of the given codec.
4399 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4402 * Get the AVClass for AVCodecContext. It can be used in combination with
4403 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4405 * @see av_opt_find().
4407 const AVClass *avcodec_get_class(void);
4410 * Get the AVClass for AVFrame. It can be used in combination with
4411 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4413 * @see av_opt_find().
4415 const AVClass *avcodec_get_frame_class(void);
4418 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4419 * with no corresponding avcodec_close()), 0 otherwise.
4421 int avcodec_is_open(AVCodecContext *s);
4423 #endif /* AVCODEC_AVCODEC_H */