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,
188 #if LIBAVCODEC_VERSION_MAJOR == 53
196 CODEC_ID_BETHSOFTVID,
208 #if LIBAVCODEC_VERSION_MAJOR == 53
216 CODEC_ID_MOTIONPIXELS,
234 CODEC_ID_IFF_BYTERUN1,
250 #if LIBAVCODEC_VERSION_MAJOR == 53
251 CODEC_ID_G723_1_DEPRECATED,
252 CODEC_ID_G729_DEPRECATED,
254 CODEC_ID_UTVIDEO_DEPRECATED,
260 CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
261 CODEC_ID_UTVIDEO = 0x800,
262 CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
263 CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
265 CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
266 CODEC_ID_V308 = MKBETAG('V','3','0','8'),
267 CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
269 /* various PCM "codecs" */
270 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
271 CODEC_ID_PCM_S16LE = 0x10000,
287 CODEC_ID_PCM_S24DAUD,
289 CODEC_ID_PCM_S16LE_PLANAR,
298 CODEC_ID_PCM_S8_PLANAR,
300 /* various ADPCM codecs */
301 CODEC_ID_ADPCM_IMA_QT = 0x11000,
302 CODEC_ID_ADPCM_IMA_WAV,
303 CODEC_ID_ADPCM_IMA_DK3,
304 CODEC_ID_ADPCM_IMA_DK4,
305 CODEC_ID_ADPCM_IMA_WS,
306 CODEC_ID_ADPCM_IMA_SMJPEG,
315 CODEC_ID_ADPCM_YAMAHA,
316 CODEC_ID_ADPCM_SBPRO_4,
317 CODEC_ID_ADPCM_SBPRO_3,
318 CODEC_ID_ADPCM_SBPRO_2,
320 CODEC_ID_ADPCM_IMA_AMV,
321 CODEC_ID_ADPCM_EA_R1,
322 CODEC_ID_ADPCM_EA_R3,
323 CODEC_ID_ADPCM_EA_R2,
324 CODEC_ID_ADPCM_IMA_EA_SEAD,
325 CODEC_ID_ADPCM_IMA_EA_EACS,
326 CODEC_ID_ADPCM_EA_XAS,
327 CODEC_ID_ADPCM_EA_MAXIS_XA,
328 CODEC_ID_ADPCM_IMA_ISS,
330 CODEC_ID_ADPCM_IMA_APC,
333 CODEC_ID_AMR_NB = 0x12000,
336 /* RealAudio codecs*/
337 CODEC_ID_RA_144 = 0x13000,
340 /* various DPCM codecs */
341 CODEC_ID_ROQ_DPCM = 0x14000,
342 CODEC_ID_INTERPLAY_DPCM,
347 CODEC_ID_MP2 = 0x15000,
348 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
364 CODEC_ID_WESTWOOD_SND1,
365 CODEC_ID_GSM, ///< as in Berlin toast format
373 CODEC_ID_DSICINAUDIO,
377 CODEC_ID_GSM_MS, /* as found in WAV */
386 CODEC_ID_WMALOSSLESS,
395 CODEC_ID_BINKAUDIO_RDFT,
396 CODEC_ID_BINKAUDIO_DCT,
400 #if LIBAVCODEC_VERSION_MAJOR > 53
401 CODEC_ID_G723_1_DEPRECATED,
402 CODEC_ID_G729_DEPRECATED,
407 CODEC_ID_G729 = 0x15800,
408 CODEC_ID_G723_1= 0x15801,
409 CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
410 CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
411 CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
412 CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
414 /* subtitle codecs */
415 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
416 CODEC_ID_DVD_SUBTITLE = 0x17000,
417 CODEC_ID_DVB_SUBTITLE,
418 CODEC_ID_TEXT, ///< raw UTF-8 text
422 CODEC_ID_HDMV_PGS_SUBTITLE,
423 CODEC_ID_DVB_TELETEXT,
425 CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
427 /* other specific kind of codecs (generally used for attachments) */
428 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
429 CODEC_ID_TTF = 0x18000,
430 CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
431 CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
432 CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
434 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
436 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
437 * stream (only used by libavformat) */
438 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
439 * stream (only used by libavformat) */
440 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
443 #if FF_API_OLD_DECODE_AUDIO
445 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
449 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
450 * This is mainly needed because some optimized bitstream readers read
451 * 32 or 64 bit at once and could read over the end.<br>
452 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
453 * MPEG bitstreams could cause overread and segfault.
455 #define FF_INPUT_BUFFER_PADDING_SIZE 16
458 * minimum encoding buffer size
459 * Used to avoid some checks during header writing.
461 #define FF_MIN_BUFFER_SIZE 16384
465 * motion estimation type.
468 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
472 ME_EPZS, ///< enhanced predictive zonal search
473 ME_X1, ///< reserved for experiments
474 ME_HEX, ///< hexagon based search
475 ME_UMH, ///< uneven multi-hexagon search
476 ME_ITER, ///< iterative search
477 ME_TESA, ///< transformed exhaustive search algorithm
481 /* We leave some space between them for extensions (drop some
482 * keyframes for intra-only or drop just some bidir frames). */
483 AVDISCARD_NONE =-16, ///< discard nothing
484 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
485 AVDISCARD_NONREF = 8, ///< discard all non reference
486 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
487 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
488 AVDISCARD_ALL = 48, ///< discard all
491 enum AVColorPrimaries{
492 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
493 AVCOL_PRI_UNSPECIFIED=2,
495 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
496 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
497 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
499 AVCOL_PRI_NB , ///< Not part of ABI
502 enum AVColorTransferCharacteristic{
503 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
504 AVCOL_TRC_UNSPECIFIED=2,
505 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
506 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
507 AVCOL_TRC_SMPTE240M =7,
508 AVCOL_TRC_NB , ///< Not part of ABI
513 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
514 AVCOL_SPC_UNSPECIFIED=2,
516 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
517 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
518 AVCOL_SPC_SMPTE240M =7,
520 AVCOL_SPC_NB , ///< Not part of ABI
524 AVCOL_RANGE_UNSPECIFIED=0,
525 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
526 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
527 AVCOL_RANGE_NB , ///< Not part of ABI
531 * X X 3 4 X X are luma samples,
532 * 1 2 1-6 are possible chroma positions
533 * X X 5 6 X 0 is undefined/unknown position
535 enum AVChromaLocation{
536 AVCHROMA_LOC_UNSPECIFIED=0,
537 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
538 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
539 AVCHROMA_LOC_TOPLEFT =3, ///< DV
541 AVCHROMA_LOC_BOTTOMLEFT =5,
542 AVCHROMA_LOC_BOTTOM =6,
543 AVCHROMA_LOC_NB , ///< Not part of ABI
546 enum AVAudioServiceType {
547 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
548 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
549 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
550 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
551 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
552 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
553 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
554 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
555 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
556 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
559 typedef struct RcOverride{
562 int qscale; // If this is 0 then quality_factor will be used instead.
563 float quality_factor;
566 #define FF_MAX_B_FRAMES 16
569 These flags can be passed in AVCodecContext.flags before initialization.
570 Note: Not everything is supported yet.
573 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
574 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
575 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
576 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
577 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
579 * The parent program guarantees that the input for B-frames containing
580 * streams is not written to for at least s->max_b_frames+1 frames, if
581 * this is not set the input will be copied.
583 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
584 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
585 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
586 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
587 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
588 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
589 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
590 location instead of only at frame boundaries. */
591 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
592 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
593 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
594 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
595 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
596 /* Fx : Flag for h263+ extra options */
597 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
598 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
599 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
600 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
601 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
602 #define CODEC_FLAG_CLOSED_GOP 0x80000000
603 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
604 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
605 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
606 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
607 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
608 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
609 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
610 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
612 /* Unsupported options :
613 * Syntax Arithmetic coding (SAC)
614 * Reference Picture Selection
615 * Independent Segment Decoding */
617 /* codec capabilities */
619 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
621 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
622 * If not set, it might not use get_buffer() at all or use operations that
623 * assume the buffer was allocated by avcodec_default_get_buffer.
625 #define CODEC_CAP_DR1 0x0002
626 #define CODEC_CAP_TRUNCATED 0x0008
627 /* Codec can export data for HW decoding (XvMC). */
628 #define CODEC_CAP_HWACCEL 0x0010
630 * Encoder or decoder requires flushing with NULL input at the end in order to
631 * give the complete and correct output.
633 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
634 * with NULL data. The user can still send NULL data to the public encode
635 * or decode function, but libavcodec will not pass it along to the codec
636 * unless this flag is set.
639 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
640 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
644 * The encoder needs to be fed with NULL data at the end of encoding until the
645 * encoder no longer returns data.
647 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
648 * flag also means that the encoder must set the pts and duration for
649 * each output packet. If this flag is not set, the pts and duration will
650 * be determined by libavcodec from the input frame.
652 #define CODEC_CAP_DELAY 0x0020
654 * Codec can be fed a final frame with a smaller size.
655 * This can be used to prevent truncation of the last audio samples.
657 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
659 * Codec can export data for HW decoding (VDPAU).
661 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
663 * Codec can output multiple frames per AVPacket
664 * Normally demuxers return one frame at a time, demuxers which do not do
665 * are connected to a parser to split what they return into proper frames.
666 * This flag is reserved to the very rare category of codecs which have a
667 * bitstream that cannot be split into frames without timeconsuming
668 * operations like full decoding. Demuxers carring such bitstreams thus
669 * may return multiple frames in a packet. This has many disadvantages like
670 * prohibiting stream copy in many cases thus it should only be considered
673 #define CODEC_CAP_SUBFRAMES 0x0100
675 * Codec is experimental and is thus avoided in favor of non experimental
678 #define CODEC_CAP_EXPERIMENTAL 0x0200
680 * Codec should fill in channel configuration and samplerate instead of container
682 #define CODEC_CAP_CHANNEL_CONF 0x0400
685 * Codec is able to deal with negative linesizes
687 #define CODEC_CAP_NEG_LINESIZES 0x0800
690 * Codec supports frame-level multithreading.
692 #define CODEC_CAP_FRAME_THREADS 0x1000
694 * Codec supports slice-based (or partition-based) multithreading.
696 #define CODEC_CAP_SLICE_THREADS 0x2000
698 * Codec supports changed parameters at any point.
700 #define CODEC_CAP_PARAM_CHANGE 0x4000
702 * Codec supports avctx->thread_count == 0 (auto).
704 #define CODEC_CAP_AUTO_THREADS 0x8000
706 * Audio encoder supports receiving a different number of samples in each call.
708 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
712 #define CODEC_CAP_LOSSLESS 0x80000000
714 //The following defines may change, don't expect compatibility if you use them.
715 #define MB_TYPE_INTRA4x4 0x0001
716 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
717 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
718 #define MB_TYPE_16x16 0x0008
719 #define MB_TYPE_16x8 0x0010
720 #define MB_TYPE_8x16 0x0020
721 #define MB_TYPE_8x8 0x0040
722 #define MB_TYPE_INTERLACED 0x0080
723 #define MB_TYPE_DIRECT2 0x0100 //FIXME
724 #define MB_TYPE_ACPRED 0x0200
725 #define MB_TYPE_GMC 0x0400
726 #define MB_TYPE_SKIP 0x0800
727 #define MB_TYPE_P0L0 0x1000
728 #define MB_TYPE_P1L0 0x2000
729 #define MB_TYPE_P0L1 0x4000
730 #define MB_TYPE_P1L1 0x8000
731 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
732 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
733 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
734 #define MB_TYPE_QUANT 0x00010000
735 #define MB_TYPE_CBP 0x00020000
736 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
740 * This specifies the area which should be displayed.
741 * Note there may be multiple such areas for one frame.
743 typedef struct AVPanScan{
746 * - encoding: Set by user.
747 * - decoding: Set by libavcodec.
752 * width and height in 1/16 pel
753 * - encoding: Set by user.
754 * - decoding: Set by libavcodec.
760 * position of the top left corner in 1/16 pel for up to 3 fields/frames
761 * - encoding: Set by user.
762 * - decoding: Set by libavcodec.
764 int16_t position[3][2];
767 #define FF_QSCALE_TYPE_MPEG1 0
768 #define FF_QSCALE_TYPE_MPEG2 1
769 #define FF_QSCALE_TYPE_H264 2
770 #define FF_QSCALE_TYPE_VP56 3
772 #define FF_BUFFER_TYPE_INTERNAL 1
773 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
774 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
775 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
777 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
778 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
779 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
780 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
782 enum AVPacketSideDataType {
784 AV_PKT_DATA_NEW_EXTRADATA,
785 AV_PKT_DATA_PARAM_CHANGE,
788 typedef struct AVPacket {
790 * Presentation timestamp in AVStream->time_base units; the time at which
791 * the decompressed packet will be presented to the user.
792 * Can be AV_NOPTS_VALUE if it is not stored in the file.
793 * pts MUST be larger or equal to dts as presentation cannot happen before
794 * decompression, unless one wants to view hex dumps. Some formats misuse
795 * the terms dts and pts/cts to mean something different. Such timestamps
796 * must be converted to true pts/dts before they are stored in AVPacket.
800 * Decompression timestamp in AVStream->time_base units; the time at which
801 * the packet is decompressed.
802 * Can be AV_NOPTS_VALUE if it is not stored in the file.
809 * A combination of AV_PKT_FLAG values
813 * Additional packet data that can be provided by the container.
814 * Packet can contain several types of side information.
819 enum AVPacketSideDataType type;
824 * Duration of this packet in AVStream->time_base units, 0 if unknown.
825 * Equals next_pts - this_pts in presentation order.
828 void (*destruct)(struct AVPacket *);
830 int64_t pos; ///< byte position in stream, -1 if unknown
833 * Time difference in AVStream->time_base units from the pts of this
834 * packet to the point at which the output from the decoder has converged
835 * independent from the availability of previous frames. That is, the
836 * frames are virtually identical no matter if decoding started from
837 * the very first frame or from this keyframe.
838 * Is AV_NOPTS_VALUE if unknown.
839 * This field is not the display duration of the current packet.
840 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
843 * The purpose of this field is to allow seeking in streams that have no
844 * keyframes in the conventional sense. It corresponds to the
845 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
846 * essential for some types of subtitle streams to ensure that all
847 * subtitles are correctly displayed after seeking.
849 int64_t convergence_duration;
851 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
852 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
855 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
857 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
858 * s32le channel_count
859 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
860 * u64le channel_layout
861 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
863 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
868 enum AVSideDataParamChangeFlags {
869 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
870 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
871 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
872 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
877 * New fields can be added to the end of AVFRAME with minor version
878 * bumps. Similarly fields that are marked as to be only accessed by
879 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
880 * without breaking compatibility with each other.
881 * Removal, reordering and changes in the remaining cases require
882 * a major version bump.
883 * sizeof(AVFrame) must not be used outside libavcodec.
885 typedef struct AVFrame {
886 #define AV_NUM_DATA_POINTERS 8
888 * pointer to the picture/channel planes.
889 * This might be different from the first allocated byte
890 * - encoding: Set by user
891 * - decoding: set by AVCodecContext.get_buffer()
893 uint8_t *data[AV_NUM_DATA_POINTERS];
896 * Size, in bytes, of the data for each picture/channel plane.
898 * For audio, only linesize[0] may be set. For planar audio, each channel
899 * plane must be the same size.
901 * - encoding: Set by user (video only)
902 * - decoding: set by AVCodecContext.get_buffer()
904 int linesize[AV_NUM_DATA_POINTERS];
907 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
908 * This isn't used by libavcodec unless the default get/release_buffer() is used.
912 uint8_t *base[AV_NUM_DATA_POINTERS];
914 * 1 -> keyframe, 0-> not
915 * - encoding: Set by libavcodec.
916 * - decoding: Set by libavcodec.
921 * Picture type of the frame, see ?_TYPE below.
922 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
923 * - decoding: Set by libavcodec.
925 enum AVPictureType pict_type;
928 * presentation timestamp in time_base units (time when frame should be shown to user)
929 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
930 * - encoding: MUST be set by user.
931 * - decoding: Set by libavcodec.
936 * picture number in bitstream order
938 * - decoding: Set by libavcodec.
940 int coded_picture_number;
942 * picture number in display order
944 * - decoding: Set by libavcodec.
946 int display_picture_number;
949 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
950 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
951 * - decoding: Set by libavcodec.
956 * is this picture used as reference
957 * The values for this are the same as the MpegEncContext.picture_structure
958 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
959 * Set to 4 for delayed, non-reference frames.
961 * - decoding: Set by libavcodec. (before get_buffer() call)).
968 * - decoding: Set by libavcodec.
970 int8_t *qscale_table;
974 * - decoding: Set by libavcodec.
979 * mbskip_table[mb]>=1 if MB didn't change
980 * stride= mb_width = (width+15)>>4
982 * - decoding: Set by libavcodec.
984 uint8_t *mbskip_table;
987 * motion vector table
990 * int mv_sample_log2= 4 - motion_subsample_log2;
991 * int mb_width= (width+15)>>4;
992 * int mv_stride= (mb_width << mv_sample_log2) + 1;
993 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
995 * - encoding: Set by user.
996 * - decoding: Set by libavcodec.
998 int16_t (*motion_val[2])[2];
1001 * macroblock type table
1002 * mb_type_base + mb_width + 2
1003 * - encoding: Set by user.
1004 * - decoding: Set by libavcodec.
1009 * log2 of the size of the block which a single vector in motion_val represents:
1010 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1011 * - encoding: unused
1012 * - decoding: Set by libavcodec.
1014 uint8_t motion_subsample_log2;
1017 * for some private data of the user
1018 * - encoding: unused
1019 * - decoding: Set by user.
1025 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1026 * - decoding: unused
1028 uint64_t error[AV_NUM_DATA_POINTERS];
1031 * type of the buffer (to keep track of who has to deallocate data[*])
1032 * - encoding: Set by the one who allocates it.
1033 * - decoding: Set by the one who allocates it.
1034 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1039 * When decoding, this signals how much the picture must be delayed.
1040 * extra_delay = repeat_pict / (2*fps)
1041 * - encoding: unused
1042 * - decoding: Set by libavcodec.
1052 * The content of the picture is interlaced.
1053 * - encoding: Set by user.
1054 * - decoding: Set by libavcodec. (default 0)
1056 int interlaced_frame;
1059 * If the content is interlaced, is top field displayed first.
1060 * - encoding: Set by user.
1061 * - decoding: Set by libavcodec.
1063 int top_field_first;
1067 * - encoding: Set by user.
1068 * - decoding: Set by libavcodec.
1070 AVPanScan *pan_scan;
1073 * Tell user application that palette has changed from previous frame.
1074 * - encoding: ??? (no palette-enabled encoder yet)
1075 * - decoding: Set by libavcodec. (default 0).
1077 int palette_has_changed;
1080 * codec suggestion on buffer type if != 0
1081 * - encoding: unused
1082 * - decoding: Set by libavcodec. (before get_buffer() call)).
1088 * - encoding: unused
1089 * - decoding: Set by libavcodec.
1094 * motion reference frame index
1095 * the order in which these are stored can depend on the codec.
1096 * - encoding: Set by user.
1097 * - decoding: Set by libavcodec.
1099 int8_t *ref_index[2];
1102 * reordered opaque 64bit (generally an integer or a double precision float
1103 * PTS but can be anything).
1104 * The user sets AVCodecContext.reordered_opaque to represent the input at
1106 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1107 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1108 * @deprecated in favor of pkt_pts
1109 * - encoding: unused
1110 * - decoding: Read by user.
1112 int64_t reordered_opaque;
1115 * hardware accelerator private data (FFmpeg-allocated)
1116 * - encoding: unused
1117 * - decoding: Set by libavcodec
1119 void *hwaccel_picture_private;
1122 * reordered pts from the last AVPacket that has been input into the decoder
1123 * - encoding: unused
1124 * - decoding: Read by user.
1129 * dts from the last AVPacket that has been input into the decoder
1130 * - encoding: unused
1131 * - decoding: Read by user.
1136 * the AVCodecContext which ff_thread_get_buffer() was last called on
1137 * - encoding: Set by libavcodec.
1138 * - decoding: Set by libavcodec.
1140 struct AVCodecContext *owner;
1143 * used by multithreading to store frame-specific info
1144 * - encoding: Set by libavcodec.
1145 * - decoding: Set by libavcodec.
1147 void *thread_opaque;
1150 * number of audio samples (per channel) described by this frame
1151 * - encoding: unused
1152 * - decoding: Set by libavcodec
1157 * pointers to the data planes/channels.
1159 * For video, this should simply point to data[].
1161 * For planar audio, each channel has a separate data pointer, and
1162 * linesize[0] contains the size of each channel buffer.
1163 * For packed audio, there is just one data pointer, and linesize[0]
1164 * contains the total size of the buffer for all channels.
1166 * Note: Both data and extended_data will always be set by get_buffer(),
1167 * but for planar audio with more channels that can fit in data,
1168 * extended_data must be used by the decoder in order to access all
1172 * decoding: set by AVCodecContext.get_buffer()
1174 uint8_t **extended_data;
1177 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1178 * - encoding: unused
1179 * - decoding: Read by user.
1181 AVRational sample_aspect_ratio;
1184 * width and height of the video frame
1185 * - encoding: unused
1186 * - decoding: Read by user.
1191 * format of the frame, -1 if unknown or unset
1192 * Values correspond to enum PixelFormat for video frames,
1193 * enum AVSampleFormat for audio)
1194 * - encoding: unused
1195 * - decoding: Read by user.
1200 * frame timestamp estimated using various heuristics, in stream time base
1201 * Code outside libavcodec should access this field using:
1202 * av_opt_ptr(avcodec_get_frame_class(), frame, "best_effort_timestamp");
1203 * - encoding: unused
1204 * - decoding: set by libavcodec, read by user.
1206 int64_t best_effort_timestamp;
1209 * reordered pos from the last AVPacket that has been input into the decoder
1210 * Code outside libavcodec should access this field using:
1211 * av_opt_ptr(avcodec_get_frame_class(), frame, "pkt_pos");
1212 * - encoding: unused
1213 * - decoding: Read by user.
1219 struct AVCodecInternal;
1223 AV_FIELD_PROGRESSIVE,
1224 AV_FIELD_TT, //< Top coded_first, top displayed first
1225 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1226 AV_FIELD_TB, //< Top coded first, bottom displayed first
1227 AV_FIELD_BT, //< Bottom coded first, top displayed first
1231 * main external API structure.
1232 * New fields can be added to the end with minor version bumps.
1233 * Removal, reordering and changes to existing fields require a major
1235 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1237 * sizeof(AVCodecContext) must not be used outside libav*.
1239 typedef struct AVCodecContext {
1241 * information on struct for av_log
1242 * - set by avcodec_alloc_context3
1244 const AVClass *av_class;
1246 * the average bitrate
1247 * - encoding: Set by user; unused for constant quantizer encoding.
1248 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1253 * number of bits the bitstream is allowed to diverge from the reference.
1254 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1255 * - encoding: Set by user; unused for constant quantizer encoding.
1256 * - decoding: unused
1258 int bit_rate_tolerance;
1262 * - encoding: Set by user.
1263 * - decoding: Set by user.
1268 * Some codecs need additional format info. It is stored here.
1269 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1270 * specific codec MUST set it correctly otherwise stream copy breaks.
1271 * In general use of this field by muxers is not recommended.
1272 * - encoding: Set by libavcodec.
1273 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1278 * Motion estimation algorithm used for video coding.
1279 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1280 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1281 * - encoding: MUST be set by user.
1282 * - decoding: unused
1287 * some codecs need / can use extradata like Huffman tables.
1288 * mjpeg: Huffman tables
1289 * rv10: additional flags
1290 * mpeg4: global headers (they can be in the bitstream or here)
1291 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1292 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1293 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1294 * - encoding: Set/allocated/freed by libavcodec.
1295 * - decoding: Set/allocated/freed by user.
1301 * This is the fundamental unit of time (in seconds) in terms
1302 * of which frame timestamps are represented. For fixed-fps content,
1303 * timebase should be 1/framerate and timestamp increments should be
1305 * - encoding: MUST be set by user.
1306 * - decoding: Set by libavcodec.
1308 AVRational time_base;
1312 * picture width / height.
1313 * - encoding: MUST be set by user.
1314 * - decoding: Set by libavcodec.
1315 * Note: For compatibility it is possible to set this instead of
1316 * coded_width/height before decoding.
1320 #define FF_ASPECT_EXTENDED 15
1323 * the number of pictures in a group of pictures, or 0 for intra_only
1324 * - encoding: Set by user.
1325 * - decoding: unused
1330 * Pixel format, see PIX_FMT_xxx.
1331 * May be set by the demuxer if known from headers.
1332 * May be overriden by the decoder if it knows better.
1333 * - encoding: Set by user.
1334 * - decoding: Set by user if known, overridden by libavcodec if known
1336 enum PixelFormat pix_fmt;
1339 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1340 * decoder to draw a horizontal band. It improves cache usage. Not
1341 * all codecs can do that. You must check the codec capabilities
1343 * When multithreading is used, it may be called from multiple threads
1344 * at the same time; threads might draw different parts of the same AVFrame,
1345 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1347 * The function is also used by hardware acceleration APIs.
1348 * It is called at least once during frame decoding to pass
1349 * the data needed for hardware render.
1350 * In that mode instead of pixel data, AVFrame points to
1351 * a structure specific to the acceleration API. The application
1352 * reads the structure and can change some fields to indicate progress
1354 * - encoding: unused
1355 * - decoding: Set by user.
1356 * @param height the height of the slice
1357 * @param y the y position of the slice
1358 * @param type 1->top field, 2->bottom field, 3->frame
1359 * @param offset offset into the AVFrame.data from which the slice should be read
1361 void (*draw_horiz_band)(struct AVCodecContext *s,
1362 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1363 int y, int type, int height);
1366 int sample_rate; ///< samples per second
1367 int channels; ///< number of audio channels
1370 * audio sample format
1371 * - encoding: Set by user.
1372 * - decoding: Set by libavcodec.
1374 enum AVSampleFormat sample_fmt; ///< sample format
1376 /* The following data should not be initialized. */
1378 * Samples per packet, initialized when calling 'init'.
1381 int frame_number; ///< audio or video frame number
1384 * Encoding: Number of frames delay there will be from the encoder input to
1385 * the decoder output. (we assume the decoder matches the spec)
1386 * Decoding: Number of frames delay in addition to what a standard decoder
1387 * as specified in the spec would produce.
1388 * - encoding: Set by libavcodec.
1389 * - decoding: Set by libavcodec.
1393 /* - encoding parameters */
1394 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1395 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1399 * - encoding: Set by user.
1400 * - decoding: unused
1406 * - encoding: Set by user.
1407 * - decoding: unused
1412 * maximum quantizer difference between frames
1413 * - encoding: Set by user.
1414 * - decoding: unused
1419 * maximum number of B-frames between non-B-frames
1420 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1421 * - encoding: Set by user.
1422 * - decoding: unused
1427 * qscale factor between IP and B-frames
1428 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1429 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1430 * - encoding: Set by user.
1431 * - decoding: unused
1433 float b_quant_factor;
1435 /** obsolete FIXME remove */
1437 #define FF_RC_STRATEGY_XVID 1
1439 int b_frame_strategy;
1441 struct AVCodec *codec;
1445 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1446 /* do its best to deliver a chunk with size */
1447 /* below rtp_payload_size, the chunk will start */
1448 /* with a start code on some codecs like H.263. */
1449 /* This doesn't take account of any particular */
1450 /* headers inside the transmitted RTP payload. */
1453 /* The RTP callback: This function is called */
1454 /* every time the encoder has a packet to send. */
1455 /* It depends on the encoder if the data starts */
1456 /* with a Start Code (it should). H.263 does. */
1457 /* mb_nb contains the number of macroblocks */
1458 /* encoded in the RTP payload. */
1459 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1461 /* statistics, used for 2-pass encoding */
1472 * number of bits used for the previously encoded frame
1473 * - encoding: Set by libavcodec.
1474 * - decoding: unused
1479 * Private data of the user, can be used to carry app specific stuff.
1480 * - encoding: Set by user.
1481 * - decoding: Set by user.
1485 char codec_name[32];
1486 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1487 enum CodecID codec_id; /* see CODEC_ID_xxx */
1490 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1491 * This is used to work around some encoder bugs.
1492 * A demuxer should set this to what is stored in the field used to identify the codec.
1493 * If there are multiple such fields in a container then the demuxer should choose the one
1494 * which maximizes the information about the used codec.
1495 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1496 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1497 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1499 * - encoding: Set by user, if not then the default based on codec_id will be used.
1500 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1502 unsigned int codec_tag;
1505 * Work around bugs in encoders which sometimes cannot be detected automatically.
1506 * - encoding: Set by user
1507 * - decoding: Set by user
1509 int workaround_bugs;
1510 #define FF_BUG_AUTODETECT 1 ///< autodetection
1511 #define FF_BUG_OLD_MSMPEG4 2
1512 #define FF_BUG_XVID_ILACE 4
1513 #define FF_BUG_UMP4 8
1514 #define FF_BUG_NO_PADDING 16
1515 #define FF_BUG_AMV 32
1516 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1517 #define FF_BUG_QPEL_CHROMA 64
1518 #define FF_BUG_STD_QPEL 128
1519 #define FF_BUG_QPEL_CHROMA2 256
1520 #define FF_BUG_DIRECT_BLOCKSIZE 512
1521 #define FF_BUG_EDGE 1024
1522 #define FF_BUG_HPEL_CHROMA 2048
1523 #define FF_BUG_DC_CLIP 4096
1524 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1525 #define FF_BUG_TRUNCATED 16384
1526 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1529 * luma single coefficient elimination threshold
1530 * - encoding: Set by user.
1531 * - decoding: unused
1533 int luma_elim_threshold;
1536 * chroma single coeff elimination threshold
1537 * - encoding: Set by user.
1538 * - decoding: unused
1540 int chroma_elim_threshold;
1543 * strictly follow the standard (MPEG4, ...).
1544 * - encoding: Set by user.
1545 * - decoding: Set by user.
1546 * Setting this to STRICT or higher means the encoder and decoder will
1547 * generally do stupid things, whereas setting it to unofficial or lower
1548 * will mean the encoder might produce output that is not supported by all
1549 * spec-compliant decoders. Decoders don't differentiate between normal,
1550 * unofficial and experimental (that is, they always try to decode things
1551 * when they can) unless they are explicitly asked to behave stupidly
1552 * (=strictly conform to the specs)
1554 int strict_std_compliance;
1555 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1556 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1557 #define FF_COMPLIANCE_NORMAL 0
1558 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1559 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1562 * qscale offset between IP and B-frames
1563 * - encoding: Set by user.
1564 * - decoding: unused
1566 float b_quant_offset;
1569 * Called at the beginning of each frame to get a buffer for it.
1571 * The function will set AVFrame.data[], AVFrame.linesize[].
1572 * AVFrame.extended_data[] must also be set, but it should be the same as
1573 * AVFrame.data[] except for planar audio with more channels than can fit
1574 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1575 * many data pointers as it can hold.
1577 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1578 * avcodec_default_get_buffer() instead of providing buffers allocated by
1581 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1582 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1583 * but if get_buffer() is overridden then alignment considerations should
1584 * be taken into account.
1586 * @see avcodec_default_get_buffer()
1590 * If pic.reference is set then the frame will be read later by libavcodec.
1591 * avcodec_align_dimensions2() should be used to find the required width and
1592 * height, as they normally need to be rounded up to the next multiple of 16.
1594 * If frame multithreading is used and thread_safe_callbacks is set,
1595 * it may be called from a different thread, but not from more than one at
1596 * once. Does not need to be reentrant.
1598 * @see release_buffer(), reget_buffer()
1599 * @see avcodec_align_dimensions2()
1603 * Decoders request a buffer of a particular size by setting
1604 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1605 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1606 * to a smaller value in the output frame.
1608 * Decoders cannot use the buffer after returning from
1609 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1610 * is assumed to be released immediately upon return.
1612 * As a convenience, av_samples_get_buffer_size() and
1613 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1614 * functions to find the required data size and to fill data pointers and
1615 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1616 * since all planes must be the same size.
1618 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1620 * - encoding: unused
1621 * - decoding: Set by libavcodec, user can override.
1623 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1626 * Called to release buffers which were allocated with get_buffer.
1627 * A released buffer can be reused in get_buffer().
1628 * pic.data[*] must be set to NULL.
1629 * May be called from a different thread if frame multithreading is used,
1630 * but not by more than one thread at once, so does not need to be reentrant.
1631 * - encoding: unused
1632 * - decoding: Set by libavcodec, user can override.
1634 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1637 * Size of the frame reordering buffer in the decoder.
1638 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1639 * - encoding: Set by libavcodec.
1640 * - decoding: Set by libavcodec.
1645 * number of bytes per packet if constant and known or 0
1646 * Used by some WAV based audio codecs.
1651 * 0-> h263 quant 1-> mpeg quant
1652 * - encoding: Set by user.
1653 * - decoding: unused
1658 * pass1 encoding statistics output buffer
1659 * - encoding: Set by libavcodec.
1660 * - decoding: unused
1665 * pass2 encoding statistics input buffer
1666 * Concatenated stuff from stats_out of pass1 should be placed here.
1667 * - encoding: Allocated/set/freed by user.
1668 * - decoding: unused
1673 * ratecontrol qmin qmax limiting method
1674 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1675 * - encoding: Set by user.
1676 * - decoding: unused
1684 * ratecontrol override, see RcOverride
1685 * - encoding: Allocated/set/freed by user.
1686 * - decoding: unused
1688 RcOverride *rc_override;
1689 int rc_override_count;
1692 * rate control equation
1693 * - encoding: Set by user
1694 * - decoding: unused
1700 * - encoding: Set by user.
1701 * - decoding: unused
1707 * - encoding: Set by user.
1708 * - decoding: unused
1713 * decoder bitstream buffer size
1714 * - encoding: Set by user.
1715 * - decoding: unused
1718 float rc_buffer_aggressivity;
1721 * qscale factor between P and I-frames
1722 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1723 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1724 * - encoding: Set by user.
1725 * - decoding: unused
1727 float i_quant_factor;
1730 * qscale offset between P and I-frames
1731 * - encoding: Set by user.
1732 * - decoding: unused
1734 float i_quant_offset;
1737 * initial complexity for pass1 ratecontrol
1738 * - encoding: Set by user.
1739 * - decoding: unused
1741 float rc_initial_cplx;
1744 * DCT algorithm, see FF_DCT_* below
1745 * - encoding: Set by user.
1746 * - decoding: unused
1749 #define FF_DCT_AUTO 0
1750 #define FF_DCT_FASTINT 1
1751 #define FF_DCT_INT 2
1752 #define FF_DCT_MMX 3
1753 #define FF_DCT_MLIB 4
1754 #define FF_DCT_ALTIVEC 5
1755 #define FF_DCT_FAAN 6
1758 * luminance masking (0-> disabled)
1759 * - encoding: Set by user.
1760 * - decoding: unused
1765 * temporary complexity masking (0-> disabled)
1766 * - encoding: Set by user.
1767 * - decoding: unused
1769 float temporal_cplx_masking;
1772 * spatial complexity masking (0-> disabled)
1773 * - encoding: Set by user.
1774 * - decoding: unused
1776 float spatial_cplx_masking;
1779 * p block masking (0-> disabled)
1780 * - encoding: Set by user.
1781 * - decoding: unused
1786 * darkness masking (0-> disabled)
1787 * - encoding: Set by user.
1788 * - decoding: unused
1793 * IDCT algorithm, see FF_IDCT_* below.
1794 * - encoding: Set by user.
1795 * - decoding: Set by user.
1798 #define FF_IDCT_AUTO 0
1799 #define FF_IDCT_INT 1
1800 #define FF_IDCT_SIMPLE 2
1801 #define FF_IDCT_SIMPLEMMX 3
1802 #define FF_IDCT_LIBMPEG2MMX 4
1803 #define FF_IDCT_PS2 5
1804 #define FF_IDCT_MLIB 6
1805 #define FF_IDCT_ARM 7
1806 #define FF_IDCT_ALTIVEC 8
1807 #define FF_IDCT_SH4 9
1808 #define FF_IDCT_SIMPLEARM 10
1809 #define FF_IDCT_H264 11
1810 #define FF_IDCT_VP3 12
1811 #define FF_IDCT_IPP 13
1812 #define FF_IDCT_XVIDMMX 14
1813 #define FF_IDCT_CAVS 15
1814 #define FF_IDCT_SIMPLEARMV5TE 16
1815 #define FF_IDCT_SIMPLEARMV6 17
1816 #define FF_IDCT_SIMPLEVIS 18
1817 #define FF_IDCT_WMV2 19
1818 #define FF_IDCT_FAAN 20
1819 #define FF_IDCT_EA 21
1820 #define FF_IDCT_SIMPLENEON 22
1821 #define FF_IDCT_SIMPLEALPHA 23
1822 #define FF_IDCT_BINK 24
1826 * - encoding: Set by libavcodec.
1827 * - decoding: Set by user (or 0).
1831 * slice offsets in the frame in bytes
1832 * - encoding: Set/allocated by libavcodec.
1833 * - decoding: Set/allocated by user (or NULL).
1838 * error concealment flags
1839 * - encoding: unused
1840 * - decoding: Set by user.
1842 int error_concealment;
1843 #define FF_EC_GUESS_MVS 1
1844 #define FF_EC_DEBLOCK 2
1847 * dsp_mask could be add used to disable unwanted CPU features
1848 * CPU features (i.e. MMX, SSE. ...)
1850 * With the FORCE flag you may instead enable given CPU features.
1851 * (Dangerous: Usable in case of misdetection, improper usage however will
1852 * result into program crash.)
1857 * bits per sample/pixel from the demuxer (needed for huffyuv).
1858 * - encoding: Set by libavcodec.
1859 * - decoding: Set by user.
1861 int bits_per_coded_sample;
1864 * prediction method (needed for huffyuv)
1865 * - encoding: Set by user.
1866 * - decoding: unused
1868 int prediction_method;
1869 #define FF_PRED_LEFT 0
1870 #define FF_PRED_PLANE 1
1871 #define FF_PRED_MEDIAN 2
1874 * sample aspect ratio (0 if unknown)
1875 * That is the width of a pixel divided by the height of the pixel.
1876 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1877 * - encoding: Set by user.
1878 * - decoding: Set by libavcodec.
1880 AVRational sample_aspect_ratio;
1883 * the picture in the bitstream
1884 * - encoding: Set by libavcodec.
1885 * - decoding: Set by libavcodec.
1887 AVFrame *coded_frame;
1891 * - encoding: Set by user.
1892 * - decoding: Set by user.
1895 #define FF_DEBUG_PICT_INFO 1
1896 #define FF_DEBUG_RC 2
1897 #define FF_DEBUG_BITSTREAM 4
1898 #define FF_DEBUG_MB_TYPE 8
1899 #define FF_DEBUG_QP 16
1900 #define FF_DEBUG_MV 32
1901 #define FF_DEBUG_DCT_COEFF 0x00000040
1902 #define FF_DEBUG_SKIP 0x00000080
1903 #define FF_DEBUG_STARTCODE 0x00000100
1904 #define FF_DEBUG_PTS 0x00000200
1905 #define FF_DEBUG_ER 0x00000400
1906 #define FF_DEBUG_MMCO 0x00000800
1907 #define FF_DEBUG_BUGS 0x00001000
1908 #define FF_DEBUG_VIS_QP 0x00002000
1909 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1910 #define FF_DEBUG_BUFFERS 0x00008000
1911 #define FF_DEBUG_THREADS 0x00010000
1915 * - encoding: Set by user.
1916 * - decoding: Set by user.
1919 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1920 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1921 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1925 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1926 * - decoding: unused
1928 uint64_t error[AV_NUM_DATA_POINTERS];
1931 * motion estimation comparison function
1932 * - encoding: Set by user.
1933 * - decoding: unused
1937 * subpixel motion estimation comparison function
1938 * - encoding: Set by user.
1939 * - decoding: unused
1943 * macroblock comparison function (not supported yet)
1944 * - encoding: Set by user.
1945 * - decoding: unused
1949 * interlaced DCT comparison function
1950 * - encoding: Set by user.
1951 * - decoding: unused
1954 #define FF_CMP_SAD 0
1955 #define FF_CMP_SSE 1
1956 #define FF_CMP_SATD 2
1957 #define FF_CMP_DCT 3
1958 #define FF_CMP_PSNR 4
1959 #define FF_CMP_BIT 5
1961 #define FF_CMP_ZERO 7
1962 #define FF_CMP_VSAD 8
1963 #define FF_CMP_VSSE 9
1964 #define FF_CMP_NSSE 10
1965 #define FF_CMP_W53 11
1966 #define FF_CMP_W97 12
1967 #define FF_CMP_DCTMAX 13
1968 #define FF_CMP_DCT264 14
1969 #define FF_CMP_CHROMA 256
1972 * ME diamond size & shape
1973 * - encoding: Set by user.
1974 * - decoding: unused
1979 * amount of previous MV predictors (2a+1 x 2a+1 square)
1980 * - encoding: Set by user.
1981 * - decoding: unused
1983 int last_predictor_count;
1986 * prepass for motion estimation
1987 * - encoding: Set by user.
1988 * - decoding: unused
1993 * motion estimation prepass comparison function
1994 * - encoding: Set by user.
1995 * - decoding: unused
2000 * ME prepass diamond size & shape
2001 * - encoding: Set by user.
2002 * - decoding: unused
2008 * - encoding: Set by user.
2009 * - decoding: unused
2011 int me_subpel_quality;
2014 * callback to negotiate the pixelFormat
2015 * @param fmt is the list of formats which are supported by the codec,
2016 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2017 * The first is always the native one.
2018 * @return the chosen format
2019 * - encoding: unused
2020 * - decoding: Set by user, if not set the native format will be chosen.
2022 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2025 * DTG active format information (additional aspect ratio
2026 * information only used in DVB MPEG-2 transport streams)
2029 * - encoding: unused
2030 * - decoding: Set by decoder.
2032 int dtg_active_format;
2033 #define FF_DTG_AFD_SAME 8
2034 #define FF_DTG_AFD_4_3 9
2035 #define FF_DTG_AFD_16_9 10
2036 #define FF_DTG_AFD_14_9 11
2037 #define FF_DTG_AFD_4_3_SP_14_9 13
2038 #define FF_DTG_AFD_16_9_SP_14_9 14
2039 #define FF_DTG_AFD_SP_4_3 15
2042 * maximum motion estimation search range in subpel units
2043 * If 0 then no limit.
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * intra quantizer bias
2052 * - encoding: Set by user.
2053 * - decoding: unused
2055 int intra_quant_bias;
2056 #define FF_DEFAULT_QUANT_BIAS 999999
2059 * inter quantizer bias
2060 * - encoding: Set by user.
2061 * - decoding: unused
2063 int inter_quant_bias;
2067 * - encoding: unused
2068 * - decoding: Which clrtable should be used for 8bit RGB images.
2069 * Tables have to be stored somewhere. FIXME
2074 * Global quality for codecs which cannot change it per frame.
2075 * This should be proportional to MPEG-1/2/4 qscale.
2076 * - encoding: Set by user.
2077 * - decoding: unused
2081 #define FF_CODER_TYPE_VLC 0
2082 #define FF_CODER_TYPE_AC 1
2083 #define FF_CODER_TYPE_RAW 2
2084 #define FF_CODER_TYPE_RLE 3
2085 #define FF_CODER_TYPE_DEFLATE 4
2088 * - encoding: Set by user.
2089 * - decoding: unused
2095 * - encoding: Set by user.
2096 * - decoding: unused
2102 * - encoding: unused
2103 * - decoding: Set by user.
2105 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2110 * - encoding: unused
2111 * - decoding: Set by user.
2114 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2115 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2116 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2119 * XVideo Motion Acceleration
2120 * - encoding: forbidden
2121 * - decoding: set by decoder
2123 int xvmc_acceleration;
2126 * macroblock decision mode
2127 * - encoding: Set by user.
2128 * - decoding: unused
2131 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2132 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2133 #define FF_MB_DECISION_RD 2 ///< rate distortion
2136 * custom intra quantization matrix
2137 * - encoding: Set by user, can be NULL.
2138 * - decoding: Set by libavcodec.
2140 uint16_t *intra_matrix;
2143 * custom inter quantization matrix
2144 * - encoding: Set by user, can be NULL.
2145 * - decoding: Set by libavcodec.
2147 uint16_t *inter_matrix;
2150 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2151 * This is used to work around some encoder bugs.
2152 * - encoding: unused
2153 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2155 unsigned int stream_codec_tag;
2158 * scene change detection threshold
2159 * 0 is default, larger means fewer detected scene changes.
2160 * - encoding: Set by user.
2161 * - decoding: unused
2163 int scenechange_threshold;
2166 * minimum Lagrange multipler
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * maximum Lagrange multipler
2174 * - encoding: Set by user.
2175 * - decoding: unused
2180 * noise reduction strength
2181 * - encoding: Set by user.
2182 * - decoding: unused
2184 int noise_reduction;
2187 * Called at the beginning of a frame to get cr buffer for it.
2188 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2189 * libavcodec will pass previous buffer in pic, function should return
2190 * same buffer or new buffer with old frame "painted" into it.
2191 * If pic.data[0] == NULL must behave like get_buffer().
2192 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2193 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2195 * - encoding: unused
2196 * - decoding: Set by libavcodec, user can override.
2198 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2201 * Number of bits which should be loaded into the rc buffer before decoding starts.
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int rc_initial_buffer_occupancy;
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int inter_threshold;
2216 * - encoding: Set by user.
2217 * - decoding: Set by user.
2222 * Simulates errors in the bitstream to test error concealment.
2223 * - encoding: Set by user.
2224 * - decoding: unused
2229 * quantizer noise shaping
2230 * - encoding: Set by user.
2231 * - decoding: unused
2233 int quantizer_noise_shaping;
2237 * is used to decide how many independent tasks should be passed to execute()
2238 * - encoding: Set by user.
2239 * - decoding: Set by user.
2244 * The codec may call this to execute several independent things.
2245 * It will return only after finishing all tasks.
2246 * The user may replace this with some multithreaded implementation,
2247 * the default implementation will execute the parts serially.
2248 * @param count the number of things to execute
2249 * - encoding: Set by libavcodec, user can override.
2250 * - decoding: Set by libavcodec, user can override.
2252 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2256 * Can be used by execute() to store some per AVCodecContext stuff.
2257 * - encoding: set by execute()
2258 * - decoding: set by execute()
2260 void *thread_opaque;
2263 * Motion estimation threshold below which no motion estimation is
2264 * performed, but instead the user specified motion vectors are used.
2266 * - encoding: Set by user.
2267 * - decoding: unused
2272 * Macroblock threshold below which the user specified macroblock types will be used.
2273 * - encoding: Set by user.
2274 * - decoding: unused
2279 * precision of the intra DC coefficient - 8
2280 * - encoding: Set by user.
2281 * - decoding: unused
2283 int intra_dc_precision;
2286 * noise vs. sse weight for the nsse comparsion function
2287 * - encoding: Set by user.
2288 * - decoding: unused
2293 * Number of macroblock rows at the top which are skipped.
2294 * - encoding: unused
2295 * - decoding: Set by user.
2300 * Number of macroblock rows at the bottom which are skipped.
2301 * - encoding: unused
2302 * - decoding: Set by user.
2308 * - encoding: Set by user.
2309 * - decoding: Set by libavcodec.
2312 #define FF_PROFILE_UNKNOWN -99
2313 #define FF_PROFILE_RESERVED -100
2315 #define FF_PROFILE_AAC_MAIN 0
2316 #define FF_PROFILE_AAC_LOW 1
2317 #define FF_PROFILE_AAC_SSR 2
2318 #define FF_PROFILE_AAC_LTP 3
2320 #define FF_PROFILE_DTS 20
2321 #define FF_PROFILE_DTS_ES 30
2322 #define FF_PROFILE_DTS_96_24 40
2323 #define FF_PROFILE_DTS_HD_HRA 50
2324 #define FF_PROFILE_DTS_HD_MA 60
2326 #define FF_PROFILE_MPEG2_422 0
2327 #define FF_PROFILE_MPEG2_HIGH 1
2328 #define FF_PROFILE_MPEG2_SS 2
2329 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2330 #define FF_PROFILE_MPEG2_MAIN 4
2331 #define FF_PROFILE_MPEG2_SIMPLE 5
2333 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2334 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2336 #define FF_PROFILE_H264_BASELINE 66
2337 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2338 #define FF_PROFILE_H264_MAIN 77
2339 #define FF_PROFILE_H264_EXTENDED 88
2340 #define FF_PROFILE_H264_HIGH 100
2341 #define FF_PROFILE_H264_HIGH_10 110
2342 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2343 #define FF_PROFILE_H264_HIGH_422 122
2344 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2345 #define FF_PROFILE_H264_HIGH_444 144
2346 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2347 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2348 #define FF_PROFILE_H264_CAVLC_444 44
2350 #define FF_PROFILE_VC1_SIMPLE 0
2351 #define FF_PROFILE_VC1_MAIN 1
2352 #define FF_PROFILE_VC1_COMPLEX 2
2353 #define FF_PROFILE_VC1_ADVANCED 3
2355 #define FF_PROFILE_MPEG4_SIMPLE 0
2356 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2357 #define FF_PROFILE_MPEG4_CORE 2
2358 #define FF_PROFILE_MPEG4_MAIN 3
2359 #define FF_PROFILE_MPEG4_N_BIT 4
2360 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2361 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2362 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2363 #define FF_PROFILE_MPEG4_HYBRID 8
2364 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2365 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2366 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2367 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2368 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2369 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2370 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2374 * - encoding: Set by user.
2375 * - decoding: Set by libavcodec.
2378 #define FF_LEVEL_UNKNOWN -99
2381 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2382 * - encoding: unused
2383 * - decoding: Set by user.
2388 * Bitstream width / height, may be different from width/height if lowres enabled.
2389 * - encoding: unused
2390 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2392 int coded_width, coded_height;
2395 * frame skip threshold
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 int frame_skip_threshold;
2403 * - encoding: Set by user.
2404 * - decoding: unused
2406 int frame_skip_factor;
2409 * frame skip exponent
2410 * - encoding: Set by user.
2411 * - decoding: unused
2416 * frame skip comparison function
2417 * - encoding: Set by user.
2418 * - decoding: unused
2423 * Border processing masking, raises the quantizer for mbs on the borders
2425 * - encoding: Set by user.
2426 * - decoding: unused
2428 float border_masking;
2431 * minimum MB lagrange multipler
2432 * - encoding: Set by user.
2433 * - decoding: unused
2438 * maximum MB lagrange multipler
2439 * - encoding: Set by user.
2440 * - decoding: unused
2446 * - encoding: Set by user.
2447 * - decoding: unused
2449 int me_penalty_compensation;
2453 * - encoding: unused
2454 * - decoding: Set by user.
2456 enum AVDiscard skip_loop_filter;
2460 * - encoding: unused
2461 * - decoding: Set by user.
2463 enum AVDiscard skip_idct;
2467 * - encoding: unused
2468 * - decoding: Set by user.
2470 enum AVDiscard skip_frame;
2474 * - encoding: Set by user.
2475 * - decoding: unused
2481 * - encoding: Set by user.
2482 * - decoding: unused
2488 * - encoding: Set by user.
2489 * - decoding: unused
2494 * number of reference frames
2495 * - encoding: Set by user.
2496 * - decoding: Set by lavc.
2501 * chroma qp offset from luma
2502 * - encoding: Set by user.
2503 * - decoding: unused
2508 * trellis RD quantization
2509 * - encoding: Set by user.
2510 * - decoding: unused
2515 * Audio cutoff bandwidth (0 means "automatic")
2516 * - encoding: Set by user.
2517 * - decoding: unused
2522 * Multiplied by qscale for each frame and added to scene_change_score.
2523 * - encoding: Set by user.
2524 * - decoding: unused
2526 int scenechange_factor;
2530 * Note: Value depends upon the compare function used for fullpel ME.
2531 * - encoding: Set by user.
2532 * - decoding: unused
2537 * Adjust sensitivity of b_frame_strategy 1.
2538 * - encoding: Set by user.
2539 * - decoding: unused
2544 * - encoding: Set by user.
2545 * - decoding: unused
2547 int compression_level;
2548 #define FF_COMPRESSION_DEFAULT -1
2551 * - encoding: Set by user.
2552 * - decoding: unused
2554 int min_prediction_order;
2557 * - encoding: Set by user.
2558 * - decoding: unused
2560 int max_prediction_order;
2563 * GOP timecode frame start number
2564 * - encoding: Set by user, in non drop frame format
2565 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2567 int64_t timecode_frame_start;
2569 #if FF_API_REQUEST_CHANNELS
2571 * Decoder should decode to this many channels if it can (0 for default)
2572 * - encoding: unused
2573 * - decoding: Set by user.
2574 * @deprecated Deprecated in favor of request_channel_layout.
2576 int request_channels;
2580 * opaque 64bit number (generally a PTS) that will be reordered and
2581 * output in AVFrame.reordered_opaque
2582 * @deprecated in favor of pkt_pts
2583 * - encoding: unused
2584 * - decoding: Set by user.
2586 int64_t reordered_opaque;
2589 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2590 * - encoding: set by user.
2591 * - decoding: set by libavcodec.
2593 int bits_per_raw_sample;
2596 * Audio channel layout.
2597 * - encoding: set by user.
2598 * - decoding: set by user, may be overwritten by libavcodec.
2600 uint64_t channel_layout;
2603 * Request decoder to use this channel layout if it can (0 for default)
2604 * - encoding: unused
2605 * - decoding: Set by user.
2607 uint64_t request_channel_layout;
2610 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2611 * - encoding: Set by user.
2612 * - decoding: unused.
2614 float rc_max_available_vbv_use;
2617 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2618 * - encoding: Set by user.
2619 * - decoding: unused.
2621 float rc_min_vbv_overflow_use;
2624 * Hardware accelerator in use
2625 * - encoding: unused.
2626 * - decoding: Set by libavcodec
2628 struct AVHWAccel *hwaccel;
2631 * For some codecs, the time base is closer to the field rate than the frame rate.
2632 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2633 * if no telecine is used ...
2635 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2637 int ticks_per_frame;
2640 * Hardware accelerator context.
2641 * For some hardware accelerators, a global context needs to be
2642 * provided by the user. In that case, this holds display-dependent
2643 * data FFmpeg cannot instantiate itself. Please refer to the
2644 * FFmpeg HW accelerator documentation to know how to fill this
2645 * is. e.g. for VA API, this is a struct vaapi_context.
2646 * - encoding: unused
2647 * - decoding: Set by user
2649 void *hwaccel_context;
2652 * Chromaticity coordinates of the source primaries.
2653 * - encoding: Set by user
2654 * - decoding: Set by libavcodec
2656 enum AVColorPrimaries color_primaries;
2659 * Color Transfer Characteristic.
2660 * - encoding: Set by user
2661 * - decoding: Set by libavcodec
2663 enum AVColorTransferCharacteristic color_trc;
2666 * YUV colorspace type.
2667 * - encoding: Set by user
2668 * - decoding: Set by libavcodec
2670 enum AVColorSpace colorspace;
2673 * MPEG vs JPEG YUV range.
2674 * - encoding: Set by user
2675 * - decoding: Set by libavcodec
2677 enum AVColorRange color_range;
2680 * This defines the location of chroma samples.
2681 * - encoding: Set by user
2682 * - decoding: Set by libavcodec
2684 enum AVChromaLocation chroma_sample_location;
2687 * The codec may call this to execute several independent things.
2688 * It will return only after finishing all tasks.
2689 * The user may replace this with some multithreaded implementation,
2690 * the default implementation will execute the parts serially.
2691 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2692 * @param c context passed also to func
2693 * @param count the number of things to execute
2694 * @param arg2 argument passed unchanged to func
2695 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2696 * @param func function that will be called count times, with jobnr from 0 to count-1.
2697 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2698 * two instances of func executing at the same time will have the same threadnr.
2699 * @return always 0 currently, but code should handle a future improvement where when any call to func
2700 * returns < 0 no further calls to func may be done and < 0 is returned.
2701 * - encoding: Set by libavcodec, user can override.
2702 * - decoding: Set by libavcodec, user can override.
2704 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2706 int log_level_offset;
2710 * Indicates number of picture subdivisions. Used for parallelized
2712 * - encoding: Set by user
2713 * - decoding: unused
2718 * Header containing style information for text subtitles.
2719 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2720 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2721 * the Format line following. It shouldn't include any Dialogue line.
2722 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2723 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2725 uint8_t *subtitle_header;
2726 int subtitle_header_size;
2729 * Current packet as passed into the decoder, to avoid having
2730 * to pass the packet into every function. Currently only valid
2731 * inside lavc and get/release_buffer callbacks.
2732 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2733 * - encoding: unused
2738 * Which multithreading methods to use.
2739 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2740 * so clients which cannot provide future frames should not use it.
2742 * - encoding: Set by user, otherwise the default is used.
2743 * - decoding: Set by user, otherwise the default is used.
2746 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2747 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2750 * Which multithreading methods are in use by the codec.
2751 * - encoding: Set by libavcodec.
2752 * - decoding: Set by libavcodec.
2754 int active_thread_type;
2757 * Set by the client if its custom get_buffer() callback can be called
2758 * from another thread, which allows faster multithreaded decoding.
2759 * draw_horiz_band() will be called from other threads regardless of this setting.
2760 * Ignored if the default get_buffer() is used.
2761 * - encoding: Set by user.
2762 * - decoding: Set by user.
2764 int thread_safe_callbacks;
2767 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2768 * Used for compliant TS muxing.
2769 * - encoding: Set by libavcodec.
2770 * - decoding: unused.
2775 * Type of service that the audio stream conveys.
2776 * - encoding: Set by user.
2777 * - decoding: Set by libavcodec.
2779 enum AVAudioServiceType audio_service_type;
2782 * desired sample format
2783 * - encoding: Not used.
2784 * - decoding: Set by user.
2785 * Decoder will decode to this format if it can.
2787 enum AVSampleFormat request_sample_fmt;
2790 * Error recognition; may misdetect some more or less valid parts as errors.
2791 * - encoding: unused
2792 * - decoding: Set by user.
2794 int err_recognition;
2795 #define AV_EF_CRCCHECK (1<<0)
2796 #define AV_EF_BITSTREAM (1<<1)
2797 #define AV_EF_BUFFER (1<<2)
2798 #define AV_EF_EXPLODE (1<<3)
2800 #define AV_EF_CAREFUL (1<<16)
2801 #define AV_EF_COMPLIANT (1<<17)
2802 #define AV_EF_AGGRESSIVE (1<<18)
2805 * Private context used for internal data.
2807 * Unlike priv_data, this is not codec-specific. It is used in general
2808 * libavcodec functions.
2810 struct AVCodecInternal *internal;
2813 * - encoding: set by libavcodec
2814 * - decoding: Set by libavcodec
2816 enum AVFieldOrder field_order;
2819 * Current statistics for PTS correction.
2820 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2821 * - encoding: unused
2823 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2824 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2825 int64_t pts_correction_last_pts; /// PTS of the last frame
2826 int64_t pts_correction_last_dts; /// DTS of the last frame
2833 typedef struct AVProfile {
2835 const char *name; ///< short name for the profile
2838 typedef struct AVCodecDefault AVCodecDefault;
2843 typedef struct AVCodec {
2845 * Name of the codec implementation.
2846 * The name is globally unique among encoders and among decoders (but an
2847 * encoder and a decoder can share the same name).
2848 * This is the primary way to find a codec from the user perspective.
2851 enum AVMediaType type;
2854 int (*init)(AVCodecContext *);
2855 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2856 int (*close)(AVCodecContext *);
2857 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2859 * Codec capabilities.
2863 struct AVCodec *next;
2866 * Will be called when seeking
2868 void (*flush)(AVCodecContext *);
2869 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2870 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2872 * Descriptive name for the codec, meant to be more human readable than name.
2873 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2875 const char *long_name;
2876 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2877 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2878 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2879 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2880 const AVClass *priv_class; ///< AVClass for the private context
2881 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2884 * @name Frame-level threading support functions
2888 * If defined, called on thread contexts when they are created.
2889 * If the codec allocates writable tables in init(), re-allocate them here.
2890 * priv_data will be set to a copy of the original.
2892 int (*init_thread_copy)(AVCodecContext *);
2894 * Copy necessary context variables from a previous thread context to the current one.
2895 * If not defined, the next thread will start automatically; otherwise, the codec
2896 * must call ff_thread_finish_setup().
2898 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2900 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2904 * Private codec-specific defaults.
2906 const AVCodecDefault *defaults;
2909 * Initialize codec static data, called from avcodec_register().
2911 void (*init_static_data)(struct AVCodec *codec);
2914 * Encode data to an AVPacket.
2916 * @param avctx codec context
2917 * @param avpkt output AVPacket (may contain a user-provided buffer)
2918 * @param[in] frame AVFrame containing the raw data to be encoded
2919 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2920 * non-empty packet was returned in avpkt.
2921 * @return 0 on success, negative error code on failure
2923 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2924 int *got_packet_ptr);
2930 typedef struct AVHWAccel {
2932 * Name of the hardware accelerated codec.
2933 * The name is globally unique among encoders and among decoders (but an
2934 * encoder and a decoder can share the same name).
2939 * Type of codec implemented by the hardware accelerator.
2941 * See AVMEDIA_TYPE_xxx
2943 enum AVMediaType type;
2946 * Codec implemented by the hardware accelerator.
2953 * Supported pixel format.
2955 * Only hardware accelerated formats are supported here.
2957 enum PixelFormat pix_fmt;
2960 * Hardware accelerated codec capabilities.
2961 * see FF_HWACCEL_CODEC_CAP_*
2965 struct AVHWAccel *next;
2968 * Called at the beginning of each frame or field picture.
2970 * Meaningful frame information (codec specific) is guaranteed to
2971 * be parsed at this point. This function is mandatory.
2973 * Note that buf can be NULL along with buf_size set to 0.
2974 * Otherwise, this means the whole frame is available at this point.
2976 * @param avctx the codec context
2977 * @param buf the frame data buffer base
2978 * @param buf_size the size of the frame in bytes
2979 * @return zero if successful, a negative value otherwise
2981 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2984 * Callback for each slice.
2986 * Meaningful slice information (codec specific) is guaranteed to
2987 * be parsed at this point. This function is mandatory.
2989 * @param avctx the codec context
2990 * @param buf the slice data buffer base
2991 * @param buf_size the size of the slice in bytes
2992 * @return zero if successful, a negative value otherwise
2994 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2997 * Called at the end of each frame or field picture.
2999 * The whole picture is parsed at this point and can now be sent
3000 * to the hardware accelerator. This function is mandatory.
3002 * @param avctx the codec context
3003 * @return zero if successful, a negative value otherwise
3005 int (*end_frame)(AVCodecContext *avctx);
3008 * Size of HW accelerator private data.
3010 * Private data is allocated with av_mallocz() before
3011 * AVCodecContext.get_buffer() and deallocated after
3012 * AVCodecContext.release_buffer().
3018 * four components are given, that's all.
3019 * the last component is alpha
3021 typedef struct AVPicture {
3022 uint8_t *data[AV_NUM_DATA_POINTERS];
3023 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3026 #define AVPALETTE_SIZE 1024
3027 #define AVPALETTE_COUNT 256
3029 enum AVSubtitleType {
3032 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3035 * Plain text, the text field must be set by the decoder and is
3036 * authoritative. ass and pict fields may contain approximations.
3041 * Formatted text, the ass field must be set by the decoder and is
3042 * authoritative. pict and text fields may contain approximations.
3047 typedef struct AVSubtitleRect {
3048 int x; ///< top left corner of pict, undefined when pict is not set
3049 int y; ///< top left corner of pict, undefined when pict is not set
3050 int w; ///< width of pict, undefined when pict is not set
3051 int h; ///< height of pict, undefined when pict is not set
3052 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3055 * data+linesize for the bitmap of this subtitle.
3056 * can be set for text/ass as well once they where rendered
3059 enum AVSubtitleType type;
3061 char *text; ///< 0 terminated plain UTF-8 text
3064 * 0 terminated ASS/SSA compatible event line.
3065 * The pressentation of this is unaffected by the other values in this
3071 typedef struct AVSubtitle {
3072 uint16_t format; /* 0 = graphics */
3073 uint32_t start_display_time; /* relative to packet pts, in ms */
3074 uint32_t end_display_time; /* relative to packet pts, in ms */
3076 AVSubtitleRect **rects;
3077 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3080 /* packet functions */
3083 * @deprecated use NULL instead
3085 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3088 * Default packet destructor.
3090 void av_destruct_packet(AVPacket *pkt);
3093 * Initialize optional fields of a packet with default values.
3097 void av_init_packet(AVPacket *pkt);
3100 * Allocate the payload of a packet and initialize its fields with
3104 * @param size wanted payload size
3105 * @return 0 if OK, AVERROR_xxx otherwise
3107 int av_new_packet(AVPacket *pkt, int size);
3110 * Reduce packet size, correctly zeroing padding
3113 * @param size new size
3115 void av_shrink_packet(AVPacket *pkt, int size);
3118 * Increase packet size, correctly zeroing padding
3121 * @param grow_by number of bytes by which to increase the size of the packet
3123 int av_grow_packet(AVPacket *pkt, int grow_by);
3126 * @warning This is a hack - the packet memory allocation stuff is broken. The
3127 * packet is allocated if it was not really allocated.
3129 int av_dup_packet(AVPacket *pkt);
3134 * @param pkt packet to free
3136 void av_free_packet(AVPacket *pkt);
3139 * Allocate new information of a packet.
3142 * @param type side information type
3143 * @param size side information size
3144 * @return pointer to fresh allocated data or NULL otherwise
3146 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3150 * Get side information from packet.
3153 * @param type desired side information type
3154 * @param size pointer for side information size to store (optional)
3155 * @return pointer to data if present or NULL otherwise
3157 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3160 int av_packet_merge_side_data(AVPacket *pkt);
3162 int av_packet_split_side_data(AVPacket *pkt);
3167 struct ReSampleContext;
3168 struct AVResampleContext;
3170 typedef struct ReSampleContext ReSampleContext;
3173 * Initialize audio resampling context.
3175 * @param output_channels number of output channels
3176 * @param input_channels number of input channels
3177 * @param output_rate output sample rate
3178 * @param input_rate input sample rate
3179 * @param sample_fmt_out requested output sample format
3180 * @param sample_fmt_in input sample format
3181 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3182 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3183 * @param linear if 1 then the used FIR filter will be linearly interpolated
3184 between the 2 closest, if 0 the closest will be used
3185 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3186 * @return allocated ReSampleContext, NULL if error occurred
3188 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3189 int output_rate, int input_rate,
3190 enum AVSampleFormat sample_fmt_out,
3191 enum AVSampleFormat sample_fmt_in,
3192 int filter_length, int log2_phase_count,
3193 int linear, double cutoff);
3195 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3198 * Free resample context.
3200 * @param s a non-NULL pointer to a resample context previously
3201 * created with av_audio_resample_init()
3203 void audio_resample_close(ReSampleContext *s);
3207 * Initialize an audio resampler.
3208 * Note, if either rate is not an integer then simply scale both rates up so they are.
3209 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3210 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3211 * @param linear If 1 then the used FIR filter will be linearly interpolated
3212 between the 2 closest, if 0 the closest will be used
3213 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3215 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3218 * Resample an array of samples using a previously configured context.
3219 * @param src an array of unconsumed samples
3220 * @param consumed the number of samples of src which have been consumed are returned here
3221 * @param src_size the number of unconsumed samples available
3222 * @param dst_size the amount of space in samples available in dst
3223 * @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.
3224 * @return the number of samples written in dst or -1 if an error occurred
3226 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3230 * Compensate samplerate/timestamp drift. The compensation is done by changing
3231 * the resampler parameters, so no audible clicks or similar distortions occur
3232 * @param compensation_distance distance in output samples over which the compensation should be performed
3233 * @param sample_delta number of output samples which should be output less
3235 * example: av_resample_compensate(c, 10, 500)
3236 * here instead of 510 samples only 500 samples would be output
3238 * note, due to rounding the actual compensation might be slightly different,
3239 * especially if the compensation_distance is large and the in_rate used during init is small
3241 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3242 void av_resample_close(struct AVResampleContext *c);
3245 * Allocate memory for a picture. Call avpicture_free() to free it.
3247 * @see avpicture_fill()
3249 * @param picture the picture to be filled in
3250 * @param pix_fmt the format of the picture
3251 * @param width the width of the picture
3252 * @param height the height of the picture
3253 * @return zero if successful, a negative value if not
3255 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3258 * Free a picture previously allocated by avpicture_alloc().
3259 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3262 * @param picture the AVPicture to be freed
3264 void avpicture_free(AVPicture *picture);
3267 * Fill in the AVPicture fields.
3268 * The fields of the given AVPicture are filled in by using the 'ptr' address
3269 * which points to the image data buffer. Depending on the specified picture
3270 * format, one or multiple image data pointers and line sizes will be set.
3271 * If a planar format is specified, several pointers will be set pointing to
3272 * the different picture planes and the line sizes of the different planes
3273 * will be stored in the lines_sizes array.
3274 * Call with ptr == NULL to get the required size for the ptr buffer.
3276 * To allocate the buffer and fill in the AVPicture fields in one call,
3277 * use avpicture_alloc().
3279 * @param picture AVPicture whose fields are to be filled in
3280 * @param ptr Buffer which will contain or contains the actual image data
3281 * @param pix_fmt The format in which the picture data is stored.
3282 * @param width the width of the image in pixels
3283 * @param height the height of the image in pixels
3284 * @return size of the image data in bytes
3286 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3287 enum PixelFormat pix_fmt, int width, int height);
3290 * Copy pixel data from an AVPicture into a buffer.
3291 * The data is stored compactly, without any gaps for alignment or padding
3292 * which may be applied by avpicture_fill().
3294 * @see avpicture_get_size()
3296 * @param[in] src AVPicture containing image data
3297 * @param[in] pix_fmt The format in which the picture data is stored.
3298 * @param[in] width the width of the image in pixels.
3299 * @param[in] height the height of the image in pixels.
3300 * @param[out] dest A buffer into which picture data will be copied.
3301 * @param[in] dest_size The size of 'dest'.
3302 * @return The number of bytes written to dest, or a negative value (error code) on error.
3304 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3305 unsigned char *dest, int dest_size);
3308 * Calculate the size in bytes that a picture of the given width and height
3309 * would occupy if stored in the given picture format.
3310 * Note that this returns the size of a compact representation as generated
3311 * by avpicture_layout(), which can be smaller than the size required for e.g.
3314 * @param pix_fmt the given picture format
3315 * @param width the width of the image
3316 * @param height the height of the image
3317 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3319 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3320 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3323 * Get the name of a codec.
3324 * @return a static string identifying the codec; never NULL
3326 const char *avcodec_get_name(enum CodecID id);
3328 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3331 * Return a value representing the fourCC code associated to the
3332 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3335 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3338 * Put a string representing the codec tag codec_tag in buf.
3340 * @param buf_size size in bytes of buf
3341 * @return the length of the string that would have been generated if
3342 * enough space had been available, excluding the trailing null
3344 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3346 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3347 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3348 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3349 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3350 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3351 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3354 * Compute what kind of losses will occur when converting from one specific
3355 * pixel format to another.
3356 * When converting from one pixel format to another, information loss may occur.
3357 * For example, when converting from RGB24 to GRAY, the color information will
3358 * be lost. Similarly, other losses occur when converting from some formats to
3359 * other formats. These losses can involve loss of chroma, but also loss of
3360 * resolution, loss of color depth, loss due to the color space conversion, loss
3361 * of the alpha bits or loss due to color quantization.
3362 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3363 * which will occur when converting from one pixel format to another.
3365 * @param[in] dst_pix_fmt destination pixel format
3366 * @param[in] src_pix_fmt source pixel format
3367 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3368 * @return Combination of flags informing you what kind of losses will occur
3369 * (maximum loss for an invalid dst_pix_fmt).
3371 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3375 * Find the best pixel format to convert to given a certain source pixel
3376 * format. When converting from one pixel format to another, information loss
3377 * may occur. For example, when converting from RGB24 to GRAY, the color
3378 * information will be lost. Similarly, other losses occur when converting from
3379 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3380 * the given pixel formats should be used to suffer the least amount of loss.
3381 * The pixel formats from which it chooses one, are determined by the
3382 * pix_fmt_mask parameter.
3384 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3387 * src_pix_fmt = PIX_FMT_YUV420P;
3388 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3389 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3392 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3393 * @param[in] src_pix_fmt source pixel format
3394 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3395 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3396 * @return The best pixel format to convert to or -1 if none was found.
3398 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3399 int has_alpha, int *loss_ptr);
3402 * Find the best pixel format to convert to given a certain source pixel
3403 * format and a selection of two destination pixel formats. When converting from
3404 * one pixel format to another, information loss may occur. For example, when converting
3405 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3406 * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3407 * the given pixel formats should be used to suffer the least amount of loss.
3409 * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3413 * src_pix_fmt = PIX_FMT_YUV420P;
3414 * dst_pix_fmt1= PIX_FMT_RGB24;
3415 * dst_pix_fmt2= PIX_FMT_GRAY8;
3416 * dst_pix_fmt3= PIX_FMT_RGB8;
3417 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3418 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3419 * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3422 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3423 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3424 * @param[in] src_pix_fmt Source pixel format
3425 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3426 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3427 * NULL or value of zero means we care about all losses. Out: the loss
3428 * that occurs when converting from src to selected dst pixel format.
3429 * @return The best pixel format to convert to or -1 if none was found.
3431 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3432 enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3435 /* deinterlace a picture */
3436 /* deinterlace - if not supported return -1 */
3437 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3438 enum PixelFormat pix_fmt, int width, int height);
3440 /* external high level API */
3443 * If c is NULL, returns the first registered codec,
3444 * if c is non-NULL, returns the next registered codec after c,
3445 * or NULL if c is the last one.
3447 AVCodec *av_codec_next(AVCodec *c);
3450 * Return the LIBAVCODEC_VERSION_INT constant.
3452 unsigned avcodec_version(void);
3455 * Return the libavcodec build-time configuration.
3457 const char *avcodec_configuration(void);
3460 * Return the libavcodec license.
3462 const char *avcodec_license(void);
3465 * Register the codec codec and initialize libavcodec.
3467 * @warning either this function or avcodec_register_all() must be called
3468 * before any other libavcodec functions.
3470 * @see avcodec_register_all()
3472 void avcodec_register(AVCodec *codec);
3475 * Find a registered encoder with a matching codec ID.
3477 * @param id CodecID of the requested encoder
3478 * @return An encoder if one was found, NULL otherwise.
3480 AVCodec *avcodec_find_encoder(enum CodecID id);
3483 * Find a registered encoder with the specified name.
3485 * @param name name of the requested encoder
3486 * @return An encoder if one was found, NULL otherwise.
3488 AVCodec *avcodec_find_encoder_by_name(const char *name);
3491 * Find a registered decoder with a matching codec ID.
3493 * @param id CodecID of the requested decoder
3494 * @return A decoder if one was found, NULL otherwise.
3496 AVCodec *avcodec_find_decoder(enum CodecID id);
3499 * Find a registered decoder with the specified name.
3501 * @param name name of the requested decoder
3502 * @return A decoder if one was found, NULL otherwise.
3504 AVCodec *avcodec_find_decoder_by_name(const char *name);
3505 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3508 * Return a name for the specified profile, if available.
3510 * @param codec the codec that is searched for the given profile
3511 * @param profile the profile value for which a name is requested
3512 * @return A name for the profile if found, NULL otherwise.
3514 const char *av_get_profile_name(const AVCodec *codec, int profile);
3516 #if FF_API_ALLOC_CONTEXT
3518 * Set the fields of the given AVCodecContext to default values.
3520 * @param s The AVCodecContext of which the fields should be set to default values.
3521 * @deprecated use avcodec_get_context_defaults3
3523 attribute_deprecated
3524 void avcodec_get_context_defaults(AVCodecContext *s);
3526 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3527 * we WILL change its arguments and name a few times! */
3528 attribute_deprecated
3529 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3533 * Set the fields of the given AVCodecContext to default values corresponding
3534 * to the given codec (defaults may be codec-dependent).
3536 * Do not call this function if a non-NULL codec has been passed
3537 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3538 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3539 * different codec on this AVCodecContext.
3541 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3543 #if FF_API_ALLOC_CONTEXT
3545 * Allocate an AVCodecContext and set its fields to default values. The
3546 * resulting struct can be deallocated by simply calling av_free().
3548 * @return An AVCodecContext filled with default values or NULL on failure.
3549 * @see avcodec_get_context_defaults
3551 * @deprecated use avcodec_alloc_context3()
3553 attribute_deprecated
3554 AVCodecContext *avcodec_alloc_context(void);
3556 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3557 * we WILL change its arguments and name a few times! */
3558 attribute_deprecated
3559 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3563 * Allocate an AVCodecContext and set its fields to default values. The
3564 * resulting struct can be deallocated by simply calling av_free().
3566 * @param codec if non-NULL, allocate private data and initialize defaults
3567 * for the given codec. It is illegal to then call avcodec_open2()
3568 * with a different codec.
3570 * @return An AVCodecContext filled with default values or NULL on failure.
3571 * @see avcodec_get_context_defaults
3573 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3576 * Copy the settings of the source AVCodecContext into the destination
3577 * AVCodecContext. The resulting destination codec context will be
3578 * unopened, i.e. you are required to call avcodec_open2() before you
3579 * can use this AVCodecContext to decode/encode video/audio data.
3581 * @param dest target codec context, should be initialized with
3582 * avcodec_alloc_context3(), but otherwise uninitialized
3583 * @param src source codec context
3584 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3586 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3589 * Set the fields of the given AVFrame to default values.
3591 * @param pic The AVFrame of which the fields should be set to default values.
3593 void avcodec_get_frame_defaults(AVFrame *pic);
3596 * Allocate an AVFrame and set its fields to default values. The resulting
3597 * struct can be deallocated by simply calling av_free().
3599 * @return An AVFrame filled with default values or NULL on failure.
3600 * @see avcodec_get_frame_defaults
3602 AVFrame *avcodec_alloc_frame(void);
3604 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3605 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3606 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3609 * Return the amount of padding in pixels which the get_buffer callback must
3610 * provide around the edge of the image for codecs which do not have the
3611 * CODEC_FLAG_EMU_EDGE flag.
3613 * @return Required padding in pixels.
3615 unsigned avcodec_get_edge_width(void);
3617 * Modify width and height values so that they will result in a memory
3618 * buffer that is acceptable for the codec if you do not use any horizontal
3621 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3622 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3623 * according to avcodec_get_edge_width() before.
3625 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3627 * Modify width and height values so that they will result in a memory
3628 * buffer that is acceptable for the codec if you also ensure that all
3629 * line sizes are a multiple of the respective linesize_align[i].
3631 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3632 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3633 * according to avcodec_get_edge_width() before.
3635 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3636 int linesize_align[AV_NUM_DATA_POINTERS]);
3638 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3640 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3641 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3642 //FIXME func typedef
3644 #if FF_API_AVCODEC_OPEN
3646 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3647 * function the context has to be allocated.
3649 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3650 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3651 * retrieving a codec.
3653 * @warning This function is not thread safe!
3656 * avcodec_register_all();
3657 * codec = avcodec_find_decoder(CODEC_ID_H264);
3661 * context = avcodec_alloc_context3(codec);
3663 * if (avcodec_open(context, codec) < 0)
3667 * @param avctx The context which will be set up to use the given codec.
3668 * @param codec The codec to use within the context.
3669 * @return zero on success, a negative value on error
3670 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3672 * @deprecated use avcodec_open2
3674 attribute_deprecated
3675 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3679 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3680 * function the context has to be allocated with avcodec_alloc_context3().
3682 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3683 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3684 * retrieving a codec.
3686 * @warning This function is not thread safe!
3689 * avcodec_register_all();
3690 * av_dict_set(&opts, "b", "2.5M", 0);
3691 * codec = avcodec_find_decoder(CODEC_ID_H264);
3695 * context = avcodec_alloc_context3(codec);
3697 * if (avcodec_open2(context, codec, opts) < 0)
3701 * @param avctx The context to initialize.
3702 * @param options A dictionary filled with AVCodecContext and codec-private options.
3703 * On return this object will be filled with options that were not found.
3705 * @return zero on success, a negative value on error
3706 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3707 * av_dict_set(), av_opt_find().
3709 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3711 #if FF_API_OLD_DECODE_AUDIO
3713 * Wrapper function which calls avcodec_decode_audio4.
3715 * @deprecated Use avcodec_decode_audio4 instead.
3717 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3718 * Some decoders may support multiple frames in a single AVPacket, such
3719 * decoders would then just decode the first frame. In this case,
3720 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3721 * the remaining data in order to decode the second frame etc.
3723 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3724 * decompressed frame size in bytes.
3726 * @warning You must set frame_size_ptr to the allocated size of the
3727 * output buffer before calling avcodec_decode_audio3().
3729 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3730 * the actual read bytes because some optimized bitstream readers read 32 or 64
3731 * bits at once and could read over the end.
3733 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3734 * no overreading happens for damaged MPEG streams.
3736 * @warning You must not provide a custom get_buffer() when using
3737 * avcodec_decode_audio3(). Doing so will override it with
3738 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3739 * which does allow the application to provide a custom get_buffer().
3741 * @note You might have to align the input buffer avpkt->data and output buffer
3742 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3743 * necessary at all, on others it won't work at all if not aligned and on others
3744 * it will work but it will have an impact on performance.
3746 * In practice, avpkt->data should have 4 byte alignment at minimum and
3747 * samples should be 16 byte aligned unless the CPU doesn't need it
3748 * (AltiVec and SSE do).
3750 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3751 * between input and output, these need to be fed with avpkt->data=NULL,
3752 * avpkt->size=0 at the end to return the remaining frames.
3754 * @param avctx the codec context
3755 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3756 * If the sample format is planar, each channel plane will
3757 * be the same size, with no padding between channels.
3758 * @param[in,out] frame_size_ptr the output buffer size in bytes
3759 * @param[in] avpkt The input AVPacket containing the input buffer.
3760 * You can create such packet with av_init_packet() and by then setting
3761 * data and size, some decoders might in addition need other fields.
3762 * All decoders are designed to use the least fields possible though.
3763 * @return On error a negative value is returned, otherwise the number of bytes
3764 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3766 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3767 int *frame_size_ptr,
3772 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3774 * Some decoders may support multiple frames in a single AVPacket. Such
3775 * decoders would then just decode the first frame. In this case,
3776 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3777 * the remaining data in order to decode the second frame, etc...
3778 * Even if no frames are returned, the packet needs to be fed to the decoder
3779 * with remaining data until it is completely consumed or an error occurs.
3781 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3782 * larger than the actual read bytes because some optimized bitstream
3783 * readers read 32 or 64 bits at once and could read over the end.
3785 * @note You might have to align the input buffer. The alignment requirements
3786 * depend on the CPU and the decoder.
3788 * @param avctx the codec context
3789 * @param[out] frame The AVFrame in which to store decoded audio samples.
3790 * Decoders request a buffer of a particular size by setting
3791 * AVFrame.nb_samples prior to calling get_buffer(). The
3792 * decoder may, however, only utilize part of the buffer by
3793 * setting AVFrame.nb_samples to a smaller value in the
3795 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3797 * @param[in] avpkt The input AVPacket containing the input buffer.
3798 * At least avpkt->data and avpkt->size should be set. Some
3799 * decoders might also require additional fields to be set.
3800 * @return A negative error code is returned if an error occurred during
3801 * decoding, otherwise the number of bytes consumed from the input
3802 * AVPacket is returned.
3804 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3805 int *got_frame_ptr, AVPacket *avpkt);
3808 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3809 * Some decoders may support multiple frames in a single AVPacket, such
3810 * decoders would then just decode the first frame.
3812 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3813 * the actual read bytes because some optimized bitstream readers read 32 or 64
3814 * bits at once and could read over the end.
3816 * @warning The end of the input buffer buf should be set to 0 to ensure that
3817 * no overreading happens for damaged MPEG streams.
3819 * @note You might have to align the input buffer avpkt->data.
3820 * The alignment requirements depend on the CPU: on some CPUs it isn't
3821 * necessary at all, on others it won't work at all if not aligned and on others
3822 * it will work but it will have an impact on performance.
3824 * In practice, avpkt->data should have 4 byte alignment at minimum.
3826 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3827 * between input and output, these need to be fed with avpkt->data=NULL,
3828 * avpkt->size=0 at the end to return the remaining frames.
3830 * @param avctx the codec context
3831 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3832 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3833 * allocate memory for the actual bitmap.
3834 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3835 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3836 * decodes and the decoder tells the user once it does not need the data anymore,
3837 * the user app can at this point free/reuse/keep the memory as it sees fit.
3839 * @param[in] avpkt The input AVpacket containing the input buffer.
3840 * You can create such packet with av_init_packet() and by then setting
3841 * data and size, some decoders might in addition need other fields like
3842 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3844 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3845 * @return On error a negative value is returned, otherwise the number of bytes
3846 * used or zero if no frame could be decompressed.
3848 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3849 int *got_picture_ptr,
3850 const AVPacket *avpkt);
3853 * Decode a subtitle message.
3854 * Return a negative value on error, otherwise return the number of bytes used.
3855 * If no subtitle could be decompressed, got_sub_ptr is zero.
3856 * Otherwise, the subtitle is stored in *sub.
3857 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3858 * simplicity, because the performance difference is expect to be negligible
3859 * and reusing a get_buffer written for video codecs would probably perform badly
3860 * due to a potentially very different allocation pattern.
3862 * @param avctx the codec context
3863 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3864 freed with avsubtitle_free if *got_sub_ptr is set.
3865 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3866 * @param[in] avpkt The input AVPacket containing the input buffer.
3868 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3873 * Free all allocated data in the given subtitle struct.
3875 * @param sub AVSubtitle to free.
3877 void avsubtitle_free(AVSubtitle *sub);
3879 #if FF_API_OLD_ENCODE_AUDIO
3881 * Encode an audio frame from samples into buf.
3883 * @deprecated Use avcodec_encode_audio2 instead.
3885 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3886 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3887 * will know how much space is needed because it depends on the value passed
3888 * in buf_size as described below. In that case a lower value can be used.
3890 * @param avctx the codec context
3891 * @param[out] buf the output buffer
3892 * @param[in] buf_size the output buffer size
3893 * @param[in] samples the input buffer containing the samples
3894 * The number of samples read from this buffer is frame_size*channels,
3895 * both of which are defined in avctx.
3896 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3897 * samples read from samples is equal to:
3898 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3899 * This also implies that av_get_bits_per_sample() must not return 0 for these
3901 * @return On error a negative value is returned, on success zero or the number
3902 * of bytes used to encode the data read from the input buffer.
3904 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3905 uint8_t *buf, int buf_size,
3906 const short *samples);
3910 * Encode a frame of audio.
3912 * Takes input samples from frame and writes the next output packet, if
3913 * available, to avpkt. The output packet does not necessarily contain data for
3914 * the most recent frame, as encoders can delay, split, and combine input frames
3915 * internally as needed.
3917 * @param avctx codec context
3918 * @param avpkt output AVPacket.
3919 * The user can supply an output buffer by setting
3920 * avpkt->data and avpkt->size prior to calling the
3921 * function, but if the size of the user-provided data is not
3922 * large enough, encoding will fail. All other AVPacket fields
3923 * will be reset by the encoder using av_init_packet(). If
3924 * avpkt->data is NULL, the encoder will allocate it.
3925 * The encoder will set avpkt->size to the size of the
3927 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3928 * May be NULL when flushing an encoder that has the
3929 * CODEC_CAP_DELAY capability set.
3930 * There are 2 codec capabilities that affect the allowed
3931 * values of frame->nb_samples.
3932 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3933 * frame may be smaller than avctx->frame_size, and all other
3934 * frames must be equal to avctx->frame_size.
3935 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3936 * can have any number of samples.
3937 * If neither is set, frame->nb_samples must be equal to
3938 * avctx->frame_size for all frames.
3939 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3940 * output packet is non-empty, and to 0 if it is
3941 * empty. If the function returns an error, the
3942 * packet can be assumed to be invalid, and the
3943 * value of got_packet_ptr is undefined and should
3945 * @return 0 on success, negative error code on failure
3947 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3948 const AVFrame *frame, int *got_packet_ptr);
3951 * Fill audio frame data and linesize.
3952 * AVFrame extended_data channel pointers are allocated if necessary for
3955 * @param frame the AVFrame
3956 * frame->nb_samples must be set prior to calling the
3957 * function. This function fills in frame->data,
3958 * frame->extended_data, frame->linesize[0].
3959 * @param nb_channels channel count
3960 * @param sample_fmt sample format
3961 * @param buf buffer to use for frame data
3962 * @param buf_size size of buffer
3963 * @param align plane size sample alignment
3964 * @return 0 on success, negative error code on failure
3966 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3967 enum AVSampleFormat sample_fmt, const uint8_t *buf,
3968 int buf_size, int align);
3971 * Encode a video frame from pict into buf.
3972 * The input picture should be
3973 * stored using a specific format, namely avctx.pix_fmt.
3975 * @param avctx the codec context
3976 * @param[out] buf the output buffer for the bitstream of encoded frame
3977 * @param[in] buf_size the size of the output buffer in bytes
3978 * @param[in] pict the input picture to encode
3979 * @return On error a negative value is returned, on success zero or the number
3980 * of bytes used from the output buffer.
3982 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3983 const AVFrame *pict);
3984 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3985 const AVSubtitle *sub);
3987 int avcodec_close(AVCodecContext *avctx);
3990 * Register all the codecs, parsers and bitstream filters which were enabled at
3991 * configuration time. If you do not call this function you can select exactly
3992 * which formats you want to support, by using the individual registration
3995 * @see avcodec_register
3996 * @see av_register_codec_parser
3997 * @see av_register_bitstream_filter
3999 void avcodec_register_all(void);
4002 * Flush buffers, should be called when seeking or when switching to a different stream.
4004 void avcodec_flush_buffers(AVCodecContext *avctx);
4006 void avcodec_default_free_buffers(AVCodecContext *s);
4008 /* misc useful functions */
4011 * Return codec bits per sample.
4013 * @param[in] codec_id the codec
4014 * @return Number of bits per sample or zero if unknown for the given codec.
4016 int av_get_bits_per_sample(enum CodecID codec_id);
4019 typedef struct AVCodecParserContext {
4021 struct AVCodecParser *parser;
4022 int64_t frame_offset; /* offset of the current frame */
4023 int64_t cur_offset; /* current offset
4024 (incremented by each av_parser_parse()) */
4025 int64_t next_frame_offset; /* offset of the next frame */
4027 int pict_type; /* XXX: Put it back in AVCodecContext. */
4029 * This field is used for proper frame duration computation in lavf.
4030 * It signals, how much longer the frame duration of the current frame
4031 * is compared to normal frame duration.
4033 * frame_duration = (1 + repeat_pict) * time_base
4035 * It is used by codecs like H.264 to display telecined material.
4037 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4038 int64_t pts; /* pts of the current frame */
4039 int64_t dts; /* dts of the current frame */
4044 int fetch_timestamp;
4046 #define AV_PARSER_PTS_NB 4
4047 int cur_frame_start_index;
4048 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4049 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4050 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4053 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4054 #define PARSER_FLAG_ONCE 0x0002
4055 /// Set if the parser has a valid file offset
4056 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4058 int64_t offset; ///< byte offset from starting packet start
4059 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4062 * Set by parser to 1 for key frames and 0 for non-key frames.
4063 * It is initialized to -1, so if the parser doesn't set this flag,
4064 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4070 * Time difference in stream time base units from the pts of this
4071 * packet to the point at which the output from the decoder has converged
4072 * independent from the availability of previous frames. That is, the
4073 * frames are virtually identical no matter if decoding started from
4074 * the very first frame or from this keyframe.
4075 * Is AV_NOPTS_VALUE if unknown.
4076 * This field is not the display duration of the current frame.
4077 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4080 * The purpose of this field is to allow seeking in streams that have no
4081 * keyframes in the conventional sense. It corresponds to the
4082 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4083 * essential for some types of subtitle streams to ensure that all
4084 * subtitles are correctly displayed after seeking.
4086 int64_t convergence_duration;
4088 // Timestamp generation support:
4090 * Synchronization point for start of timestamp generation.
4092 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4095 * For example, this corresponds to presence of H.264 buffering period
4101 * Offset of the current timestamp against last timestamp sync point in
4102 * units of AVCodecContext.time_base.
4104 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4105 * contain a valid timestamp offset.
4107 * Note that the timestamp of sync point has usually a nonzero
4108 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4109 * the next frame after timestamp sync point will be usually 1.
4111 * For example, this corresponds to H.264 cpb_removal_delay.
4113 int dts_ref_dts_delta;
4116 * Presentation delay of current frame in units of AVCodecContext.time_base.
4118 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4119 * contain valid non-negative timestamp delta (presentation time of a frame
4120 * must not lie in the past).
4122 * This delay represents the difference between decoding and presentation
4123 * time of the frame.
4125 * For example, this corresponds to H.264 dpb_output_delay.
4130 * Position of the packet in file.
4132 * Analogous to cur_frame_pts/dts
4134 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4137 * Byte position of currently parsed frame in stream.
4142 * Previous frame byte position.
4145 } AVCodecParserContext;
4147 typedef struct AVCodecParser {
4148 int codec_ids[5]; /* several codec IDs are permitted */
4150 int (*parser_init)(AVCodecParserContext *s);
4151 int (*parser_parse)(AVCodecParserContext *s,
4152 AVCodecContext *avctx,
4153 const uint8_t **poutbuf, int *poutbuf_size,
4154 const uint8_t *buf, int buf_size);
4155 void (*parser_close)(AVCodecParserContext *s);
4156 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4157 struct AVCodecParser *next;
4160 AVCodecParser *av_parser_next(AVCodecParser *c);
4162 void av_register_codec_parser(AVCodecParser *parser);
4163 AVCodecParserContext *av_parser_init(int codec_id);
4168 * @param s parser context.
4169 * @param avctx codec context.
4170 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4171 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4172 * @param buf input buffer.
4173 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4174 * @param pts input presentation timestamp.
4175 * @param dts input decoding timestamp.
4176 * @param pos input byte position in stream.
4177 * @return the number of bytes of the input bitstream used.
4182 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4189 * decode_frame(data, size);
4193 int av_parser_parse2(AVCodecParserContext *s,
4194 AVCodecContext *avctx,
4195 uint8_t **poutbuf, int *poutbuf_size,
4196 const uint8_t *buf, int buf_size,
4197 int64_t pts, int64_t dts,
4200 int av_parser_change(AVCodecParserContext *s,
4201 AVCodecContext *avctx,
4202 uint8_t **poutbuf, int *poutbuf_size,
4203 const uint8_t *buf, int buf_size, int keyframe);
4204 void av_parser_close(AVCodecParserContext *s);
4207 typedef struct AVBitStreamFilterContext {
4209 struct AVBitStreamFilter *filter;
4210 AVCodecParserContext *parser;
4211 struct AVBitStreamFilterContext *next;
4212 } AVBitStreamFilterContext;
4215 typedef struct AVBitStreamFilter {
4218 int (*filter)(AVBitStreamFilterContext *bsfc,
4219 AVCodecContext *avctx, const char *args,
4220 uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size, int keyframe);
4222 void (*close)(AVBitStreamFilterContext *bsfc);
4223 struct AVBitStreamFilter *next;
4224 } AVBitStreamFilter;
4226 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4227 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4228 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4229 AVCodecContext *avctx, const char *args,
4230 uint8_t **poutbuf, int *poutbuf_size,
4231 const uint8_t *buf, int buf_size, int keyframe);
4232 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4234 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4239 * Reallocate the given block if it is not large enough, otherwise do nothing.
4243 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4246 * Allocate a buffer, reusing the given one if large enough.
4248 * Contrary to av_fast_realloc the current buffer contents might not be
4249 * preserved and on error the old buffer is freed, thus no special
4250 * handling to avoid memleaks is necessary.
4252 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4253 * @param size size of the buffer *ptr points to
4254 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4255 * *size 0 if an error occurred.
4257 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4260 * Same behaviour av_fast_malloc but the buffer has additional
4261 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4263 * In addition the whole buffer will initially and after resizes
4264 * be 0-initialized so that no uninitialized data will ever appear.
4266 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4269 * Copy image src to dst. Wraps av_picture_data_copy() above.
4271 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4272 enum PixelFormat pix_fmt, int width, int height);
4275 * Crop image top and left side.
4277 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4278 enum PixelFormat pix_fmt, int top_band, int left_band);
4283 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4284 int padtop, int padbottom, int padleft, int padright, int *color);
4287 * Encode extradata length to a buffer. Used by xiph codecs.
4289 * @param s buffer to write to; must be at least (v/255+1) bytes long
4290 * @param v size of extradata in bytes
4291 * @return number of bytes written to the buffer.
4293 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4296 * Log a generic warning message about a missing feature. This function is
4297 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4298 * only, and would normally not be used by applications.
4299 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4300 * a pointer to an AVClass struct
4301 * @param[in] feature string containing the name of the missing feature
4302 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4303 * If want_sample is non-zero, additional verbage will be added to the log
4304 * message which tells the user how to report samples to the development
4307 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4310 * Log a generic warning message asking for a sample. This function is
4311 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4312 * only, and would normally not be used by applications.
4313 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4314 * a pointer to an AVClass struct
4315 * @param[in] msg string containing an optional message, or NULL if no message
4317 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4320 * Register the hardware accelerator hwaccel.
4322 void av_register_hwaccel(AVHWAccel *hwaccel);
4325 * If hwaccel is NULL, returns the first registered hardware accelerator,
4326 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4327 * after hwaccel, or NULL if hwaccel is the last one.
4329 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4333 * Lock operation used by lockmgr
4336 AV_LOCK_CREATE, ///< Create a mutex
4337 AV_LOCK_OBTAIN, ///< Lock the mutex
4338 AV_LOCK_RELEASE, ///< Unlock the mutex
4339 AV_LOCK_DESTROY, ///< Free mutex resources
4343 * Register a user provided lock manager supporting the operations
4344 * specified by AVLockOp. mutex points to a (void *) where the
4345 * lockmgr should store/get a pointer to a user allocated mutex. It's
4346 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4348 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4349 * callback during the call to av_lockmgr_register().
4350 * Thus, the application must be prepared to handle that.
4351 * If cb is set to NULL the lockmgr will be unregistered.
4352 * Also note that during unregistration the previously registered
4353 * lockmgr callback may also be invoked.
4355 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4358 * Get the type of the given codec.
4360 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4363 * Get the AVClass for AVCodecContext. It can be used in combination with
4364 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4366 * @see av_opt_find().
4368 const AVClass *avcodec_get_class(void);
4371 * Get the AVClass for AVFrame. It can be used in combination with
4372 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4374 * @see av_opt_find().
4376 const AVClass *avcodec_get_frame_class(void);
4378 #endif /* AVCODEC_AVCODEC_H */