2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav 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 * Libav 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 Libav; 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"
38 #include "libavcodec/version.h"
40 * @defgroup libavc Encoding/Decoding Library
43 * @defgroup lavc_decoding Decoding
47 * @defgroup lavc_encoding Encoding
51 * @defgroup lavc_codec Codecs
53 * @defgroup lavc_codec_native Native Codecs
56 * @defgroup lavc_codec_wrappers External library wrappers
59 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
63 * @defgroup lavc_internal Internal
72 * Identify the syntax and semantics of the bitstream.
73 * The principle is roughly:
74 * Two decoders with the same ID can decode the same streams.
75 * Two encoders with the same ID can encode compatible streams.
76 * There may be slight deviations from the principle due to implementation
79 * If you add a codec ID to this list, add it so that
80 * 1. no value of a existing codec ID changes (that would break ABI),
81 * 2. it is as close as possible to similar codecs.
88 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
89 CODEC_ID_MPEG2VIDEO_XVMC,
126 CODEC_ID_INTERPLAY_VIDEO,
138 CODEC_ID_TRUEMOTION1,
165 CODEC_ID_TRUEMOTION2,
182 CODEC_ID_DSICINVIDEO,
183 CODEC_ID_TIERTEXSEQVIDEO,
186 #if LIBAVCODEC_VERSION_MAJOR == 53
194 CODEC_ID_BETHSOFTVID,
206 #if LIBAVCODEC_VERSION_MAJOR == 53
214 CODEC_ID_MOTIONPIXELS,
232 CODEC_ID_IFF_BYTERUN1,
248 #if LIBAVCODEC_VERSION_MAJOR == 53
259 /* various PCM "codecs" */
260 CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
261 CODEC_ID_PCM_S16LE = 0x10000,
277 CODEC_ID_PCM_S24DAUD,
279 CODEC_ID_PCM_S16LE_PLANAR,
288 CODEC_ID_PCM_S8_PLANAR,
290 /* various ADPCM codecs */
291 CODEC_ID_ADPCM_IMA_QT = 0x11000,
292 CODEC_ID_ADPCM_IMA_WAV,
293 CODEC_ID_ADPCM_IMA_DK3,
294 CODEC_ID_ADPCM_IMA_DK4,
295 CODEC_ID_ADPCM_IMA_WS,
296 CODEC_ID_ADPCM_IMA_SMJPEG,
305 CODEC_ID_ADPCM_YAMAHA,
306 CODEC_ID_ADPCM_SBPRO_4,
307 CODEC_ID_ADPCM_SBPRO_3,
308 CODEC_ID_ADPCM_SBPRO_2,
310 CODEC_ID_ADPCM_IMA_AMV,
311 CODEC_ID_ADPCM_EA_R1,
312 CODEC_ID_ADPCM_EA_R3,
313 CODEC_ID_ADPCM_EA_R2,
314 CODEC_ID_ADPCM_IMA_EA_SEAD,
315 CODEC_ID_ADPCM_IMA_EA_EACS,
316 CODEC_ID_ADPCM_EA_XAS,
317 CODEC_ID_ADPCM_EA_MAXIS_XA,
318 CODEC_ID_ADPCM_IMA_ISS,
320 CODEC_ID_ADPCM_IMA_APC,
323 CODEC_ID_AMR_NB = 0x12000,
326 /* RealAudio codecs*/
327 CODEC_ID_RA_144 = 0x13000,
330 /* various DPCM codecs */
331 CODEC_ID_ROQ_DPCM = 0x14000,
332 CODEC_ID_INTERPLAY_DPCM,
337 CODEC_ID_MP2 = 0x15000,
338 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
349 #if LIBAVCODEC_VERSION_MAJOR == 53
358 CODEC_ID_WESTWOOD_SND1,
359 CODEC_ID_GSM, ///< as in Berlin toast format
367 CODEC_ID_DSICINAUDIO,
371 CODEC_ID_GSM_MS, /* as found in WAV */
380 CODEC_ID_WMALOSSLESS,
389 CODEC_ID_BINKAUDIO_RDFT,
390 CODEC_ID_BINKAUDIO_DCT,
394 #if LIBAVCODEC_VERSION_MAJOR > 53
402 /* subtitle codecs */
403 CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
404 CODEC_ID_DVD_SUBTITLE = 0x17000,
405 CODEC_ID_DVB_SUBTITLE,
406 CODEC_ID_TEXT, ///< raw UTF-8 text
410 CODEC_ID_HDMV_PGS_SUBTITLE,
411 CODEC_ID_DVB_TELETEXT,
414 /* other specific kind of codecs (generally used for attachments) */
415 CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
416 CODEC_ID_TTF = 0x18000,
418 CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
420 CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
421 * stream (only used by libavformat) */
422 CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
423 * stream (only used by libavformat) */
424 CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
427 #if FF_API_OLD_DECODE_AUDIO
429 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
433 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
434 * This is mainly needed because some optimized bitstream readers read
435 * 32 or 64 bit at once and could read over the end.<br>
436 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
437 * MPEG bitstreams could cause overread and segfault.
439 #define FF_INPUT_BUFFER_PADDING_SIZE 8
442 * minimum encoding buffer size
443 * Used to avoid some checks during header writing.
445 #define FF_MIN_BUFFER_SIZE 16384
449 * motion estimation type.
452 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
456 ME_EPZS, ///< enhanced predictive zonal search
457 ME_X1, ///< reserved for experiments
458 ME_HEX, ///< hexagon based search
459 ME_UMH, ///< uneven multi-hexagon search
460 ME_ITER, ///< iterative search
461 ME_TESA, ///< transformed exhaustive search algorithm
465 /* We leave some space between them for extensions (drop some
466 * keyframes for intra-only or drop just some bidir frames). */
467 AVDISCARD_NONE =-16, ///< discard nothing
468 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
469 AVDISCARD_NONREF = 8, ///< discard all non reference
470 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
471 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
472 AVDISCARD_ALL = 48, ///< discard all
475 enum AVColorPrimaries{
476 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
477 AVCOL_PRI_UNSPECIFIED=2,
479 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
480 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
481 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
483 AVCOL_PRI_NB , ///< Not part of ABI
486 enum AVColorTransferCharacteristic{
487 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
488 AVCOL_TRC_UNSPECIFIED=2,
489 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
490 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
491 AVCOL_TRC_NB , ///< Not part of ABI
496 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
497 AVCOL_SPC_UNSPECIFIED=2,
499 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
500 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
501 AVCOL_SPC_SMPTE240M =7,
502 AVCOL_SPC_NB , ///< Not part of ABI
506 AVCOL_RANGE_UNSPECIFIED=0,
507 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
508 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
509 AVCOL_RANGE_NB , ///< Not part of ABI
513 * X X 3 4 X X are luma samples,
514 * 1 2 1-6 are possible chroma positions
515 * X X 5 6 X 0 is undefined/unknown position
517 enum AVChromaLocation{
518 AVCHROMA_LOC_UNSPECIFIED=0,
519 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
520 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
521 AVCHROMA_LOC_TOPLEFT =3, ///< DV
523 AVCHROMA_LOC_BOTTOMLEFT =5,
524 AVCHROMA_LOC_BOTTOM =6,
525 AVCHROMA_LOC_NB , ///< Not part of ABI
528 #if FF_API_FLAC_GLOBAL_OPTS
533 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
534 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
535 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
536 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
537 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
538 AV_LPC_TYPE_NB , ///< Not part of ABI
542 enum AVAudioServiceType {
543 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
544 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
545 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
546 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
547 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
548 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
549 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
550 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
551 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
552 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
555 typedef struct RcOverride{
558 int qscale; // If this is 0 then quality_factor will be used instead.
559 float quality_factor;
562 #define FF_MAX_B_FRAMES 16
565 These flags can be passed in AVCodecContext.flags before initialization.
566 Note: Not everything is supported yet.
569 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
570 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
571 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
572 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
573 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
575 * The parent program guarantees that the input for B-frames containing
576 * streams is not written to for at least s->max_b_frames+1 frames, if
577 * this is not set the input will be copied.
579 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
580 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
581 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
582 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
583 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
584 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
585 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
586 location instead of only at frame boundaries. */
587 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
588 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
589 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
590 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
591 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
592 /* Fx : Flag for h263+ extra options */
593 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
594 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
595 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
596 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
597 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
598 #define CODEC_FLAG_CLOSED_GOP 0x80000000
599 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
600 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
601 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
602 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
603 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
604 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
606 * @defgroup deprecated_flags Deprecated codec flags
607 * Use corresponding private codec options instead.
610 #if FF_API_MJPEG_GLOBAL_OPTS
611 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
613 #if FF_API_SNOW_GLOBAL_OPTS
614 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
616 #if FF_API_LAME_GLOBAL_OPTS
617 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
623 /* Unsupported options :
624 * Syntax Arithmetic coding (SAC)
625 * Reference Picture Selection
626 * Independent Segment Decoding */
628 /* codec capabilities */
630 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
632 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
633 * If not set, it might not use get_buffer() at all or use operations that
634 * assume the buffer was allocated by avcodec_default_get_buffer.
636 #define CODEC_CAP_DR1 0x0002
637 #if FF_API_PARSE_FRAME
638 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
639 #define CODEC_CAP_PARSE_ONLY 0x0004
641 #define CODEC_CAP_TRUNCATED 0x0008
642 /* Codec can export data for HW decoding (XvMC). */
643 #define CODEC_CAP_HWACCEL 0x0010
645 * Encoder or decoder requires flushing with NULL input at the end in order to
646 * give the complete and correct output.
648 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
649 * with NULL data. The user can still send NULL data to the public encode
650 * or decode function, but libavcodec will not pass it along to the codec
651 * unless this flag is set.
654 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
655 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
659 * The encoder needs to be fed with NULL data at the end of encoding until the
660 * encoder no longer returns data.
662 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
663 * flag also means that the encoder must set the pts and duration for
664 * each output packet. If this flag is not set, the pts and duration will
665 * be determined by libavcodec from the input frame.
667 #define CODEC_CAP_DELAY 0x0020
669 * Codec can be fed a final frame with a smaller size.
670 * This can be used to prevent truncation of the last audio samples.
672 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
674 * Codec can export data for HW decoding (VDPAU).
676 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
678 * Codec can output multiple frames per AVPacket
679 * Normally demuxers return one frame at a time, demuxers which do not do
680 * are connected to a parser to split what they return into proper frames.
681 * This flag is reserved to the very rare category of codecs which have a
682 * bitstream that cannot be split into frames without timeconsuming
683 * operations like full decoding. Demuxers carring such bitstreams thus
684 * may return multiple frames in a packet. This has many disadvantages like
685 * prohibiting stream copy in many cases thus it should only be considered
688 #define CODEC_CAP_SUBFRAMES 0x0100
690 * Codec is experimental and is thus avoided in favor of non experimental
693 #define CODEC_CAP_EXPERIMENTAL 0x0200
695 * Codec should fill in channel configuration and samplerate instead of container
697 #define CODEC_CAP_CHANNEL_CONF 0x0400
699 * Codec is able to deal with negative linesizes
701 #define CODEC_CAP_NEG_LINESIZES 0x0800
703 * Codec supports frame-level multithreading.
705 #define CODEC_CAP_FRAME_THREADS 0x1000
707 * Codec supports slice-based (or partition-based) multithreading.
709 #define CODEC_CAP_SLICE_THREADS 0x2000
711 * Codec supports changed parameters at any point.
713 #define CODEC_CAP_PARAM_CHANGE 0x4000
715 * Codec supports avctx->thread_count == 0 (auto).
717 #define CODEC_CAP_AUTO_THREADS 0x8000
719 * Audio encoder supports receiving a different number of samples in each call.
721 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
723 //The following defines may change, don't expect compatibility if you use them.
724 #define MB_TYPE_INTRA4x4 0x0001
725 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
726 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
727 #define MB_TYPE_16x16 0x0008
728 #define MB_TYPE_16x8 0x0010
729 #define MB_TYPE_8x16 0x0020
730 #define MB_TYPE_8x8 0x0040
731 #define MB_TYPE_INTERLACED 0x0080
732 #define MB_TYPE_DIRECT2 0x0100 //FIXME
733 #define MB_TYPE_ACPRED 0x0200
734 #define MB_TYPE_GMC 0x0400
735 #define MB_TYPE_SKIP 0x0800
736 #define MB_TYPE_P0L0 0x1000
737 #define MB_TYPE_P1L0 0x2000
738 #define MB_TYPE_P0L1 0x4000
739 #define MB_TYPE_P1L1 0x8000
740 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
741 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
742 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
743 #define MB_TYPE_QUANT 0x00010000
744 #define MB_TYPE_CBP 0x00020000
745 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
749 * This specifies the area which should be displayed.
750 * Note there may be multiple such areas for one frame.
752 typedef struct AVPanScan{
755 * - encoding: Set by user.
756 * - decoding: Set by libavcodec.
761 * width and height in 1/16 pel
762 * - encoding: Set by user.
763 * - decoding: Set by libavcodec.
769 * position of the top left corner in 1/16 pel for up to 3 fields/frames
770 * - encoding: Set by user.
771 * - decoding: Set by libavcodec.
773 int16_t position[3][2];
776 #define FF_QSCALE_TYPE_MPEG1 0
777 #define FF_QSCALE_TYPE_MPEG2 1
778 #define FF_QSCALE_TYPE_H264 2
779 #define FF_QSCALE_TYPE_VP56 3
781 #define FF_BUFFER_TYPE_INTERNAL 1
782 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
783 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
784 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
786 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
787 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
788 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
789 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
791 enum AVPacketSideDataType {
793 AV_PKT_DATA_NEW_EXTRADATA,
794 AV_PKT_DATA_PARAM_CHANGE,
797 typedef struct AVPacket {
799 * Presentation timestamp in AVStream->time_base units; the time at which
800 * the decompressed packet will be presented to the user.
801 * Can be AV_NOPTS_VALUE if it is not stored in the file.
802 * pts MUST be larger or equal to dts as presentation cannot happen before
803 * decompression, unless one wants to view hex dumps. Some formats misuse
804 * the terms dts and pts/cts to mean something different. Such timestamps
805 * must be converted to true pts/dts before they are stored in AVPacket.
809 * Decompression timestamp in AVStream->time_base units; the time at which
810 * the packet is decompressed.
811 * Can be AV_NOPTS_VALUE if it is not stored in the file.
818 * A combination of AV_PKT_FLAG values
822 * Additional packet data that can be provided by the container.
823 * Packet can contain several types of side information.
828 enum AVPacketSideDataType type;
833 * Duration of this packet in AVStream->time_base units, 0 if unknown.
834 * Equals next_pts - this_pts in presentation order.
837 void (*destruct)(struct AVPacket *);
839 int64_t pos; ///< byte position in stream, -1 if unknown
842 * Time difference in AVStream->time_base units from the pts of this
843 * packet to the point at which the output from the decoder has converged
844 * independent from the availability of previous frames. That is, the
845 * frames are virtually identical no matter if decoding started from
846 * the very first frame or from this keyframe.
847 * Is AV_NOPTS_VALUE if unknown.
848 * This field is not the display duration of the current packet.
849 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
852 * The purpose of this field is to allow seeking in streams that have no
853 * keyframes in the conventional sense. It corresponds to the
854 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
855 * essential for some types of subtitle streams to ensure that all
856 * subtitles are correctly displayed after seeking.
858 int64_t convergence_duration;
860 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
861 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
864 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
866 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
867 * s32le channel_count
868 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
869 * u64le channel_layout
870 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
872 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
877 enum AVSideDataParamChangeFlags {
878 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
879 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
880 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
881 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
886 * New fields can be added to the end of AVFRAME with minor version
887 * bumps. Removal, reordering and changes to existing fields require
888 * a major version bump.
889 * sizeof(AVFrame) must not be used outside libav*.
891 typedef struct AVFrame {
892 #if FF_API_DATA_POINTERS
893 #define AV_NUM_DATA_POINTERS 4
895 #define AV_NUM_DATA_POINTERS 8
898 * pointer to the picture/channel planes.
899 * This might be different from the first allocated byte
900 * - encoding: Set by user
901 * - decoding: set by AVCodecContext.get_buffer()
903 uint8_t *data[AV_NUM_DATA_POINTERS];
906 * Size, in bytes, of the data for each picture/channel plane.
908 * For audio, only linesize[0] may be set. For planar audio, each channel
909 * plane must be the same size.
911 * - encoding: Set by user (video only)
912 * - decoding: set by AVCodecContext.get_buffer()
914 int linesize[AV_NUM_DATA_POINTERS];
917 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
918 * This isn't used by libavcodec unless the default get/release_buffer() is used.
922 uint8_t *base[AV_NUM_DATA_POINTERS];
924 * 1 -> keyframe, 0-> not
925 * - encoding: Set by libavcodec.
926 * - decoding: Set by libavcodec.
931 * Picture type of the frame, see ?_TYPE below.
932 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
933 * - decoding: Set by libavcodec.
935 enum AVPictureType pict_type;
938 * presentation timestamp in time_base units (time when frame should be shown to user)
939 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
940 * - encoding: MUST be set by user.
941 * - decoding: Set by libavcodec.
946 * picture number in bitstream order
948 * - decoding: Set by libavcodec.
950 int coded_picture_number;
952 * picture number in display order
954 * - decoding: Set by libavcodec.
956 int display_picture_number;
959 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
960 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
961 * - decoding: Set by libavcodec.
965 #if FF_API_AVFRAME_AGE
969 attribute_deprecated int age;
973 * is this picture used as reference
974 * The values for this are the same as the MpegEncContext.picture_structure
975 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
976 * Set to 4 for delayed, non-reference frames.
978 * - decoding: Set by libavcodec. (before get_buffer() call)).
985 * - decoding: Set by libavcodec.
987 int8_t *qscale_table;
991 * - decoding: Set by libavcodec.
996 * mbskip_table[mb]>=1 if MB didn't change
997 * stride= mb_width = (width+15)>>4
999 * - decoding: Set by libavcodec.
1001 uint8_t *mbskip_table;
1004 * motion vector table
1007 * int mv_sample_log2= 4 - motion_subsample_log2;
1008 * int mb_width= (width+15)>>4;
1009 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1010 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1012 * - encoding: Set by user.
1013 * - decoding: Set by libavcodec.
1015 int16_t (*motion_val[2])[2];
1018 * macroblock type table
1019 * mb_type_base + mb_width + 2
1020 * - encoding: Set by user.
1021 * - decoding: Set by libavcodec.
1026 * log2 of the size of the block which a single vector in motion_val represents:
1027 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1028 * - encoding: unused
1029 * - decoding: Set by libavcodec.
1031 uint8_t motion_subsample_log2;
1034 * for some private data of the user
1035 * - encoding: unused
1036 * - decoding: Set by user.
1042 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1043 * - decoding: unused
1045 uint64_t error[AV_NUM_DATA_POINTERS];
1048 * type of the buffer (to keep track of who has to deallocate data[*])
1049 * - encoding: Set by the one who allocates it.
1050 * - decoding: Set by the one who allocates it.
1051 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1056 * When decoding, this signals how much the picture must be delayed.
1057 * extra_delay = repeat_pict / (2*fps)
1058 * - encoding: unused
1059 * - decoding: Set by libavcodec.
1069 * The content of the picture is interlaced.
1070 * - encoding: Set by user.
1071 * - decoding: Set by libavcodec. (default 0)
1073 int interlaced_frame;
1076 * If the content is interlaced, is top field displayed first.
1077 * - encoding: Set by user.
1078 * - decoding: Set by libavcodec.
1080 int top_field_first;
1084 * - encoding: Set by user.
1085 * - decoding: Set by libavcodec.
1087 AVPanScan *pan_scan;
1090 * Tell user application that palette has changed from previous frame.
1091 * - encoding: ??? (no palette-enabled encoder yet)
1092 * - decoding: Set by libavcodec. (default 0).
1094 int palette_has_changed;
1097 * codec suggestion on buffer type if != 0
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec. (before get_buffer() call)).
1105 * - encoding: unused
1106 * - decoding: Set by libavcodec.
1111 * motion reference frame index
1112 * the order in which these are stored can depend on the codec.
1113 * - encoding: Set by user.
1114 * - decoding: Set by libavcodec.
1116 int8_t *ref_index[2];
1119 * reordered opaque 64bit (generally an integer or a double precision float
1120 * PTS but can be anything).
1121 * The user sets AVCodecContext.reordered_opaque to represent the input at
1123 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1124 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1125 * @deprecated in favor of pkt_pts
1126 * - encoding: unused
1127 * - decoding: Read by user.
1129 int64_t reordered_opaque;
1132 * hardware accelerator private data (Libav-allocated)
1133 * - encoding: unused
1134 * - decoding: Set by libavcodec
1136 void *hwaccel_picture_private;
1139 * reordered pts from the last AVPacket that has been input into the decoder
1140 * - encoding: unused
1141 * - decoding: Read by user.
1146 * dts from the last AVPacket that has been input into the decoder
1147 * - encoding: unused
1148 * - decoding: Read by user.
1153 * the AVCodecContext which ff_thread_get_buffer() was last called on
1154 * - encoding: Set by libavcodec.
1155 * - decoding: Set by libavcodec.
1157 struct AVCodecContext *owner;
1160 * used by multithreading to store frame-specific info
1161 * - encoding: Set by libavcodec.
1162 * - decoding: Set by libavcodec.
1164 void *thread_opaque;
1167 * number of audio samples (per channel) described by this frame
1168 * - encoding: unused
1169 * - decoding: Set by libavcodec
1174 * pointers to the data planes/channels.
1176 * For video, this should simply point to data[].
1178 * For planar audio, each channel has a separate data pointer, and
1179 * linesize[0] contains the size of each channel buffer.
1180 * For packed audio, there is just one data pointer, and linesize[0]
1181 * contains the total size of the buffer for all channels.
1183 * Note: Both data and extended_data will always be set by get_buffer(),
1184 * but for planar audio with more channels that can fit in data,
1185 * extended_data must be used by the decoder in order to access all
1189 * decoding: set by AVCodecContext.get_buffer()
1191 uint8_t **extended_data;
1194 * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1195 * - encoding: unused
1196 * - decoding: Read by user.
1198 AVRational sample_aspect_ratio;
1201 * width and height of the video frame
1202 * - encoding: unused
1203 * - decoding: Read by user.
1208 * format of the frame, -1 if unknown or unset
1209 * Values correspond to enum PixelFormat for video frames,
1210 * enum AVSampleFormat for audio)
1211 * - encoding: unused
1212 * - decoding: Read by user.
1217 struct AVCodecInternal;
1221 AV_FIELD_PROGRESSIVE,
1222 AV_FIELD_TT, //< Top coded_first, top displayed first
1223 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1224 AV_FIELD_TB, //< Top coded first, bottom displayed first
1225 AV_FIELD_BT, //< Bottom coded first, top displayed first
1229 * main external API structure.
1230 * New fields can be added to the end with minor version bumps.
1231 * Removal, reordering and changes to existing fields require a major
1233 * sizeof(AVCodecContext) must not be used outside libav*.
1235 typedef struct AVCodecContext {
1237 * information on struct for av_log
1238 * - set by avcodec_alloc_context3
1240 const AVClass *av_class;
1242 * the average bitrate
1243 * - encoding: Set by user; unused for constant quantizer encoding.
1244 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1249 * number of bits the bitstream is allowed to diverge from the reference.
1250 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1251 * - encoding: Set by user; unused for constant quantizer encoding.
1252 * - decoding: unused
1254 int bit_rate_tolerance;
1258 * - encoding: Set by user.
1259 * - decoding: Set by user.
1264 * Some codecs need additional format info. It is stored here.
1265 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1266 * specific codec MUST set it correctly otherwise stream copy breaks.
1267 * In general use of this field by muxers is not recommended.
1268 * - encoding: Set by libavcodec.
1269 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1274 * Motion estimation algorithm used for video coding.
1275 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1276 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1277 * - encoding: MUST be set by user.
1278 * - decoding: unused
1283 * some codecs need / can use extradata like Huffman tables.
1284 * mjpeg: Huffman tables
1285 * rv10: additional flags
1286 * mpeg4: global headers (they can be in the bitstream or here)
1287 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1288 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1289 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1290 * - encoding: Set/allocated/freed by libavcodec.
1291 * - decoding: Set/allocated/freed by user.
1297 * This is the fundamental unit of time (in seconds) in terms
1298 * of which frame timestamps are represented. For fixed-fps content,
1299 * timebase should be 1/framerate and timestamp increments should be
1301 * - encoding: MUST be set by user.
1302 * - decoding: Set by libavcodec.
1304 AVRational time_base;
1308 * picture width / height.
1309 * - encoding: MUST be set by user.
1310 * - decoding: Set by libavcodec.
1311 * Note: For compatibility it is possible to set this instead of
1312 * coded_width/height before decoding.
1316 #define FF_ASPECT_EXTENDED 15
1319 * the number of pictures in a group of pictures, or 0 for intra_only
1320 * - encoding: Set by user.
1321 * - decoding: unused
1326 * Pixel format, see PIX_FMT_xxx.
1327 * May be set by the demuxer if known from headers.
1328 * May be overriden by the decoder if it knows better.
1329 * - encoding: Set by user.
1330 * - decoding: Set by user if known, overridden by libavcodec if known
1332 enum PixelFormat pix_fmt;
1335 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1336 * decoder to draw a horizontal band. It improves cache usage. Not
1337 * all codecs can do that. You must check the codec capabilities
1339 * When multithreading is used, it may be called from multiple threads
1340 * at the same time; threads might draw different parts of the same AVFrame,
1341 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1343 * The function is also used by hardware acceleration APIs.
1344 * It is called at least once during frame decoding to pass
1345 * the data needed for hardware render.
1346 * In that mode instead of pixel data, AVFrame points to
1347 * a structure specific to the acceleration API. The application
1348 * reads the structure and can change some fields to indicate progress
1350 * - encoding: unused
1351 * - decoding: Set by user.
1352 * @param height the height of the slice
1353 * @param y the y position of the slice
1354 * @param type 1->top field, 2->bottom field, 3->frame
1355 * @param offset offset into the AVFrame.data from which the slice should be read
1357 void (*draw_horiz_band)(struct AVCodecContext *s,
1358 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1359 int y, int type, int height);
1362 int sample_rate; ///< samples per second
1363 int channels; ///< number of audio channels
1366 * audio sample format
1367 * - encoding: Set by user.
1368 * - decoding: Set by libavcodec.
1370 enum AVSampleFormat sample_fmt; ///< sample format
1372 /* The following data should not be initialized. */
1374 * Samples per packet, initialized when calling 'init'.
1377 int frame_number; ///< audio or video frame number
1380 * Number of frames the decoded output will be delayed relative to
1381 * the encoded input.
1382 * - encoding: Set by libavcodec.
1383 * - decoding: unused
1387 /* - encoding parameters */
1388 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1389 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1393 * - encoding: Set by user.
1394 * - decoding: unused
1400 * - encoding: Set by user.
1401 * - decoding: unused
1406 * maximum quantizer difference between frames
1407 * - encoding: Set by user.
1408 * - decoding: unused
1413 * maximum number of B-frames between non-B-frames
1414 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1415 * - encoding: Set by user.
1416 * - decoding: unused
1421 * qscale factor between IP and B-frames
1422 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1423 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1424 * - encoding: Set by user.
1425 * - decoding: unused
1427 float b_quant_factor;
1429 /** obsolete FIXME remove */
1431 #define FF_RC_STRATEGY_XVID 1
1433 int b_frame_strategy;
1435 struct AVCodec *codec;
1439 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1440 /* do its best to deliver a chunk with size */
1441 /* below rtp_payload_size, the chunk will start */
1442 /* with a start code on some codecs like H.263. */
1443 /* This doesn't take account of any particular */
1444 /* headers inside the transmitted RTP payload. */
1447 /* The RTP callback: This function is called */
1448 /* every time the encoder has a packet to send. */
1449 /* It depends on the encoder if the data starts */
1450 /* with a Start Code (it should). H.263 does. */
1451 /* mb_nb contains the number of macroblocks */
1452 /* encoded in the RTP payload. */
1453 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1455 /* statistics, used for 2-pass encoding */
1466 * number of bits used for the previously encoded frame
1467 * - encoding: Set by libavcodec.
1468 * - decoding: unused
1473 * Private data of the user, can be used to carry app specific stuff.
1474 * - encoding: Set by user.
1475 * - decoding: Set by user.
1479 char codec_name[32];
1480 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1481 enum CodecID codec_id; /* see CODEC_ID_xxx */
1484 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1485 * This is used to work around some encoder bugs.
1486 * A demuxer should set this to what is stored in the field used to identify the codec.
1487 * If there are multiple such fields in a container then the demuxer should choose the one
1488 * which maximizes the information about the used codec.
1489 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1490 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1491 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1493 * - encoding: Set by user, if not then the default based on codec_id will be used.
1494 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1496 unsigned int codec_tag;
1499 * Work around bugs in encoders which sometimes cannot be detected automatically.
1500 * - encoding: Set by user
1501 * - decoding: Set by user
1503 int workaround_bugs;
1504 #define FF_BUG_AUTODETECT 1 ///< autodetection
1505 #define FF_BUG_OLD_MSMPEG4 2
1506 #define FF_BUG_XVID_ILACE 4
1507 #define FF_BUG_UMP4 8
1508 #define FF_BUG_NO_PADDING 16
1509 #define FF_BUG_AMV 32
1510 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1511 #define FF_BUG_QPEL_CHROMA 64
1512 #define FF_BUG_STD_QPEL 128
1513 #define FF_BUG_QPEL_CHROMA2 256
1514 #define FF_BUG_DIRECT_BLOCKSIZE 512
1515 #define FF_BUG_EDGE 1024
1516 #define FF_BUG_HPEL_CHROMA 2048
1517 #define FF_BUG_DC_CLIP 4096
1518 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1519 #define FF_BUG_TRUNCATED 16384
1520 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1523 * luma single coefficient elimination threshold
1524 * - encoding: Set by user.
1525 * - decoding: unused
1527 int luma_elim_threshold;
1530 * chroma single coeff elimination threshold
1531 * - encoding: Set by user.
1532 * - decoding: unused
1534 int chroma_elim_threshold;
1537 * strictly follow the standard (MPEG4, ...).
1538 * - encoding: Set by user.
1539 * - decoding: Set by user.
1540 * Setting this to STRICT or higher means the encoder and decoder will
1541 * generally do stupid things, whereas setting it to unofficial or lower
1542 * will mean the encoder might produce output that is not supported by all
1543 * spec-compliant decoders. Decoders don't differentiate between normal,
1544 * unofficial and experimental (that is, they always try to decode things
1545 * when they can) unless they are explicitly asked to behave stupidly
1546 * (=strictly conform to the specs)
1548 int strict_std_compliance;
1549 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1550 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1551 #define FF_COMPLIANCE_NORMAL 0
1552 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1553 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1556 * qscale offset between IP and B-frames
1557 * - encoding: Set by user.
1558 * - decoding: unused
1560 float b_quant_offset;
1564 * Error recognition; higher values will detect more errors but may
1565 * misdetect some more or less valid parts as errors.
1566 * - encoding: unused
1567 * - decoding: Set by user.
1569 attribute_deprecated int error_recognition;
1570 #define FF_ER_CAREFUL 1
1571 #define FF_ER_COMPLIANT 2
1572 #define FF_ER_AGGRESSIVE 3
1573 #define FF_ER_VERY_AGGRESSIVE 4
1574 #define FF_ER_EXPLODE 5
1575 #endif /* FF_API_ER */
1578 * Called at the beginning of each frame to get a buffer for it.
1580 * The function will set AVFrame.data[], AVFrame.linesize[].
1581 * AVFrame.extended_data[] must also be set, but it should be the same as
1582 * AVFrame.data[] except for planar audio with more channels than can fit
1583 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1584 * many data pointers as it can hold.
1586 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1587 * avcodec_default_get_buffer() instead of providing buffers allocated by
1590 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1591 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1592 * but if get_buffer() is overridden then alignment considerations should
1593 * be taken into account.
1595 * @see avcodec_default_get_buffer()
1599 * If pic.reference is set then the frame will be read later by libavcodec.
1600 * avcodec_align_dimensions2() should be used to find the required width and
1601 * height, as they normally need to be rounded up to the next multiple of 16.
1603 * If frame multithreading is used and thread_safe_callbacks is set,
1604 * it may be called from a different thread, but not from more than one at
1605 * once. Does not need to be reentrant.
1607 * @see release_buffer(), reget_buffer()
1608 * @see avcodec_align_dimensions2()
1612 * Decoders request a buffer of a particular size by setting
1613 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1614 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1615 * to a smaller value in the output frame.
1617 * Decoders cannot use the buffer after returning from
1618 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1619 * is assumed to be released immediately upon return.
1621 * As a convenience, av_samples_get_buffer_size() and
1622 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1623 * functions to find the required data size and to fill data pointers and
1624 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1625 * since all planes must be the same size.
1627 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1629 * - encoding: unused
1630 * - decoding: Set by libavcodec, user can override.
1632 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1635 * Called to release buffers which were allocated with get_buffer.
1636 * A released buffer can be reused in get_buffer().
1637 * pic.data[*] must be set to NULL.
1638 * May be called from a different thread if frame multithreading is used,
1639 * but not by more than one thread at once, so does not need to be reentrant.
1640 * - encoding: unused
1641 * - decoding: Set by libavcodec, user can override.
1643 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1646 * Size of the frame reordering buffer in the decoder.
1647 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1648 * - encoding: Set by libavcodec.
1649 * - decoding: Set by libavcodec.
1654 * number of bytes per packet if constant and known or 0
1655 * Used by some WAV based audio codecs.
1659 #if FF_API_PARSE_FRAME
1661 * If true, only parsing is done. The frame data is returned.
1662 * Only MPEG audio decoders support this now.
1663 * - encoding: unused
1664 * - decoding: Set by user
1666 attribute_deprecated int parse_only;
1670 * 0-> h263 quant 1-> mpeg quant
1671 * - encoding: Set by user.
1672 * - decoding: unused
1677 * pass1 encoding statistics output buffer
1678 * - encoding: Set by libavcodec.
1679 * - decoding: unused
1684 * pass2 encoding statistics input buffer
1685 * Concatenated stuff from stats_out of pass1 should be placed here.
1686 * - encoding: Allocated/set/freed by user.
1687 * - decoding: unused
1692 * ratecontrol qmin qmax limiting method
1693 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1694 * - encoding: Set by user.
1695 * - decoding: unused
1703 * ratecontrol override, see RcOverride
1704 * - encoding: Allocated/set/freed by user.
1705 * - decoding: unused
1707 RcOverride *rc_override;
1708 int rc_override_count;
1711 * rate control equation
1712 * - encoding: Set by user
1713 * - decoding: unused
1719 * - encoding: Set by user.
1720 * - decoding: unused
1726 * - encoding: Set by user.
1727 * - decoding: unused
1732 * decoder bitstream buffer size
1733 * - encoding: Set by user.
1734 * - decoding: unused
1737 float rc_buffer_aggressivity;
1740 * qscale factor between P and I-frames
1741 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1742 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1743 * - encoding: Set by user.
1744 * - decoding: unused
1746 float i_quant_factor;
1749 * qscale offset between P and I-frames
1750 * - encoding: Set by user.
1751 * - decoding: unused
1753 float i_quant_offset;
1756 * initial complexity for pass1 ratecontrol
1757 * - encoding: Set by user.
1758 * - decoding: unused
1760 float rc_initial_cplx;
1763 * DCT algorithm, see FF_DCT_* below
1764 * - encoding: Set by user.
1765 * - decoding: unused
1768 #define FF_DCT_AUTO 0
1769 #define FF_DCT_FASTINT 1
1770 #define FF_DCT_INT 2
1771 #define FF_DCT_MMX 3
1772 #define FF_DCT_MLIB 4
1773 #define FF_DCT_ALTIVEC 5
1774 #define FF_DCT_FAAN 6
1777 * luminance masking (0-> disabled)
1778 * - encoding: Set by user.
1779 * - decoding: unused
1784 * temporary complexity masking (0-> disabled)
1785 * - encoding: Set by user.
1786 * - decoding: unused
1788 float temporal_cplx_masking;
1791 * spatial complexity masking (0-> disabled)
1792 * - encoding: Set by user.
1793 * - decoding: unused
1795 float spatial_cplx_masking;
1798 * p block masking (0-> disabled)
1799 * - encoding: Set by user.
1800 * - decoding: unused
1805 * darkness masking (0-> disabled)
1806 * - encoding: Set by user.
1807 * - decoding: unused
1812 * IDCT algorithm, see FF_IDCT_* below.
1813 * - encoding: Set by user.
1814 * - decoding: Set by user.
1817 #define FF_IDCT_AUTO 0
1818 #define FF_IDCT_INT 1
1819 #define FF_IDCT_SIMPLE 2
1820 #define FF_IDCT_SIMPLEMMX 3
1821 #define FF_IDCT_LIBMPEG2MMX 4
1822 #define FF_IDCT_PS2 5
1823 #define FF_IDCT_MLIB 6
1824 #define FF_IDCT_ARM 7
1825 #define FF_IDCT_ALTIVEC 8
1826 #define FF_IDCT_SH4 9
1827 #define FF_IDCT_SIMPLEARM 10
1828 #define FF_IDCT_H264 11
1829 #define FF_IDCT_VP3 12
1830 #define FF_IDCT_IPP 13
1831 #define FF_IDCT_XVIDMMX 14
1832 #define FF_IDCT_CAVS 15
1833 #define FF_IDCT_SIMPLEARMV5TE 16
1834 #define FF_IDCT_SIMPLEARMV6 17
1835 #define FF_IDCT_SIMPLEVIS 18
1836 #define FF_IDCT_WMV2 19
1837 #define FF_IDCT_FAAN 20
1838 #define FF_IDCT_EA 21
1839 #define FF_IDCT_SIMPLENEON 22
1840 #define FF_IDCT_SIMPLEALPHA 23
1841 #define FF_IDCT_BINK 24
1845 * - encoding: Set by libavcodec.
1846 * - decoding: Set by user (or 0).
1850 * slice offsets in the frame in bytes
1851 * - encoding: Set/allocated by libavcodec.
1852 * - decoding: Set/allocated by user (or NULL).
1857 * error concealment flags
1858 * - encoding: unused
1859 * - decoding: Set by user.
1861 int error_concealment;
1862 #define FF_EC_GUESS_MVS 1
1863 #define FF_EC_DEBLOCK 2
1866 * dsp_mask could be add used to disable unwanted CPU features
1867 * CPU features (i.e. MMX, SSE. ...)
1869 * With the FORCE flag you may instead enable given CPU features.
1870 * (Dangerous: Usable in case of misdetection, improper usage however will
1871 * result into program crash.)
1876 * bits per sample/pixel from the demuxer (needed for huffyuv).
1877 * - encoding: Set by libavcodec.
1878 * - decoding: Set by user.
1880 int bits_per_coded_sample;
1883 * prediction method (needed for huffyuv)
1884 * - encoding: Set by user.
1885 * - decoding: unused
1887 int prediction_method;
1888 #define FF_PRED_LEFT 0
1889 #define FF_PRED_PLANE 1
1890 #define FF_PRED_MEDIAN 2
1893 * sample aspect ratio (0 if unknown)
1894 * That is the width of a pixel divided by the height of the pixel.
1895 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1896 * - encoding: Set by user.
1897 * - decoding: Set by libavcodec.
1899 AVRational sample_aspect_ratio;
1902 * the picture in the bitstream
1903 * - encoding: Set by libavcodec.
1904 * - decoding: Set by libavcodec.
1906 AVFrame *coded_frame;
1910 * - encoding: Set by user.
1911 * - decoding: Set by user.
1914 #define FF_DEBUG_PICT_INFO 1
1915 #define FF_DEBUG_RC 2
1916 #define FF_DEBUG_BITSTREAM 4
1917 #define FF_DEBUG_MB_TYPE 8
1918 #define FF_DEBUG_QP 16
1919 #define FF_DEBUG_MV 32
1920 #define FF_DEBUG_DCT_COEFF 0x00000040
1921 #define FF_DEBUG_SKIP 0x00000080
1922 #define FF_DEBUG_STARTCODE 0x00000100
1923 #define FF_DEBUG_PTS 0x00000200
1924 #define FF_DEBUG_ER 0x00000400
1925 #define FF_DEBUG_MMCO 0x00000800
1926 #define FF_DEBUG_BUGS 0x00001000
1927 #define FF_DEBUG_VIS_QP 0x00002000
1928 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1929 #define FF_DEBUG_BUFFERS 0x00008000
1930 #define FF_DEBUG_THREADS 0x00010000
1934 * - encoding: Set by user.
1935 * - decoding: Set by user.
1938 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1939 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1940 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1944 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1945 * - decoding: unused
1947 uint64_t error[AV_NUM_DATA_POINTERS];
1950 * motion estimation comparison function
1951 * - encoding: Set by user.
1952 * - decoding: unused
1956 * subpixel motion estimation comparison function
1957 * - encoding: Set by user.
1958 * - decoding: unused
1962 * macroblock comparison function (not supported yet)
1963 * - encoding: Set by user.
1964 * - decoding: unused
1968 * interlaced DCT comparison function
1969 * - encoding: Set by user.
1970 * - decoding: unused
1973 #define FF_CMP_SAD 0
1974 #define FF_CMP_SSE 1
1975 #define FF_CMP_SATD 2
1976 #define FF_CMP_DCT 3
1977 #define FF_CMP_PSNR 4
1978 #define FF_CMP_BIT 5
1980 #define FF_CMP_ZERO 7
1981 #define FF_CMP_VSAD 8
1982 #define FF_CMP_VSSE 9
1983 #define FF_CMP_NSSE 10
1984 #define FF_CMP_W53 11
1985 #define FF_CMP_W97 12
1986 #define FF_CMP_DCTMAX 13
1987 #define FF_CMP_DCT264 14
1988 #define FF_CMP_CHROMA 256
1991 * ME diamond size & shape
1992 * - encoding: Set by user.
1993 * - decoding: unused
1998 * amount of previous MV predictors (2a+1 x 2a+1 square)
1999 * - encoding: Set by user.
2000 * - decoding: unused
2002 int last_predictor_count;
2005 * prepass for motion estimation
2006 * - encoding: Set by user.
2007 * - decoding: unused
2012 * motion estimation prepass comparison function
2013 * - encoding: Set by user.
2014 * - decoding: unused
2019 * ME prepass diamond size & shape
2020 * - encoding: Set by user.
2021 * - decoding: unused
2027 * - encoding: Set by user.
2028 * - decoding: unused
2030 int me_subpel_quality;
2033 * callback to negotiate the pixelFormat
2034 * @param fmt is the list of formats which are supported by the codec,
2035 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2036 * The first is always the native one.
2037 * @return the chosen format
2038 * - encoding: unused
2039 * - decoding: Set by user, if not set the native format will be chosen.
2041 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
2044 * DTG active format information (additional aspect ratio
2045 * information only used in DVB MPEG-2 transport streams)
2048 * - encoding: unused
2049 * - decoding: Set by decoder.
2051 int dtg_active_format;
2052 #define FF_DTG_AFD_SAME 8
2053 #define FF_DTG_AFD_4_3 9
2054 #define FF_DTG_AFD_16_9 10
2055 #define FF_DTG_AFD_14_9 11
2056 #define FF_DTG_AFD_4_3_SP_14_9 13
2057 #define FF_DTG_AFD_16_9_SP_14_9 14
2058 #define FF_DTG_AFD_SP_4_3 15
2061 * maximum motion estimation search range in subpel units
2062 * If 0 then no limit.
2064 * - encoding: Set by user.
2065 * - decoding: unused
2070 * intra quantizer bias
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 int intra_quant_bias;
2075 #define FF_DEFAULT_QUANT_BIAS 999999
2078 * inter quantizer bias
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 int inter_quant_bias;
2086 * - encoding: unused
2087 * - decoding: Which clrtable should be used for 8bit RGB images.
2088 * Tables have to be stored somewhere. FIXME
2092 #if FF_API_INTERNAL_CONTEXT
2094 * internal_buffer count
2095 * Don't touch, used by libavcodec default_get_buffer().
2096 * @deprecated this field was moved to an internal context
2098 attribute_deprecated int internal_buffer_count;
2102 * Don't touch, used by libavcodec default_get_buffer().
2103 * @deprecated this field was moved to an internal context
2105 attribute_deprecated void *internal_buffer;
2109 * Global quality for codecs which cannot change it per frame.
2110 * This should be proportional to MPEG-1/2/4 qscale.
2111 * - encoding: Set by user.
2112 * - decoding: unused
2116 #define FF_CODER_TYPE_VLC 0
2117 #define FF_CODER_TYPE_AC 1
2118 #define FF_CODER_TYPE_RAW 2
2119 #define FF_CODER_TYPE_RLE 3
2120 #define FF_CODER_TYPE_DEFLATE 4
2123 * - encoding: Set by user.
2124 * - decoding: unused
2130 * - encoding: Set by user.
2131 * - decoding: unused
2137 * - encoding: unused
2138 * - decoding: Set by user.
2140 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2145 * - encoding: unused
2146 * - decoding: Set by user.
2149 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2150 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2151 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2154 * XVideo Motion Acceleration
2155 * - encoding: forbidden
2156 * - decoding: set by decoder
2158 int xvmc_acceleration;
2161 * macroblock decision mode
2162 * - encoding: Set by user.
2163 * - decoding: unused
2166 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2167 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2168 #define FF_MB_DECISION_RD 2 ///< rate distortion
2171 * custom intra quantization matrix
2172 * - encoding: Set by user, can be NULL.
2173 * - decoding: Set by libavcodec.
2175 uint16_t *intra_matrix;
2178 * custom inter quantization matrix
2179 * - encoding: Set by user, can be NULL.
2180 * - decoding: Set by libavcodec.
2182 uint16_t *inter_matrix;
2185 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2186 * This is used to work around some encoder bugs.
2187 * - encoding: unused
2188 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2190 unsigned int stream_codec_tag;
2193 * scene change detection threshold
2194 * 0 is default, larger means fewer detected scene changes.
2195 * - encoding: Set by user.
2196 * - decoding: unused
2198 int scenechange_threshold;
2201 * minimum Lagrange multipler
2202 * - encoding: Set by user.
2203 * - decoding: unused
2208 * maximum Lagrange multipler
2209 * - encoding: Set by user.
2210 * - decoding: unused
2215 * noise reduction strength
2216 * - encoding: Set by user.
2217 * - decoding: unused
2219 int noise_reduction;
2222 * Called at the beginning of a frame to get cr buffer for it.
2223 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2224 * libavcodec will pass previous buffer in pic, function should return
2225 * same buffer or new buffer with old frame "painted" into it.
2226 * If pic.data[0] == NULL must behave like get_buffer().
2227 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2228 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2230 * - encoding: unused
2231 * - decoding: Set by libavcodec, user can override.
2233 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2236 * Number of bits which should be loaded into the rc buffer before decoding starts.
2237 * - encoding: Set by user.
2238 * - decoding: unused
2240 int rc_initial_buffer_occupancy;
2244 * - encoding: Set by user.
2245 * - decoding: unused
2247 int inter_threshold;
2251 * - encoding: Set by user.
2252 * - decoding: Set by user.
2257 * Simulates errors in the bitstream to test error concealment.
2258 * - encoding: Set by user.
2259 * - decoding: unused
2264 * quantizer noise shaping
2265 * - encoding: Set by user.
2266 * - decoding: unused
2268 int quantizer_noise_shaping;
2272 * is used to decide how many independent tasks should be passed to execute()
2273 * - encoding: Set by user.
2274 * - decoding: Set by user.
2279 * The codec may call this to execute several independent things.
2280 * It will return only after finishing all tasks.
2281 * The user may replace this with some multithreaded implementation,
2282 * the default implementation will execute the parts serially.
2283 * @param count the number of things to execute
2284 * - encoding: Set by libavcodec, user can override.
2285 * - decoding: Set by libavcodec, user can override.
2287 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2291 * Can be used by execute() to store some per AVCodecContext stuff.
2292 * - encoding: set by execute()
2293 * - decoding: set by execute()
2295 void *thread_opaque;
2298 * Motion estimation threshold below which no motion estimation is
2299 * performed, but instead the user specified motion vectors are used.
2301 * - encoding: Set by user.
2302 * - decoding: unused
2307 * Macroblock threshold below which the user specified macroblock types will be used.
2308 * - encoding: Set by user.
2309 * - decoding: unused
2314 * precision of the intra DC coefficient - 8
2315 * - encoding: Set by user.
2316 * - decoding: unused
2318 int intra_dc_precision;
2321 * noise vs. sse weight for the nsse comparsion function
2322 * - encoding: Set by user.
2323 * - decoding: unused
2328 * Number of macroblock rows at the top which are skipped.
2329 * - encoding: unused
2330 * - decoding: Set by user.
2335 * Number of macroblock rows at the bottom which are skipped.
2336 * - encoding: unused
2337 * - decoding: Set by user.
2343 * - encoding: Set by user.
2344 * - decoding: Set by libavcodec.
2347 #define FF_PROFILE_UNKNOWN -99
2348 #define FF_PROFILE_RESERVED -100
2350 #define FF_PROFILE_AAC_MAIN 0
2351 #define FF_PROFILE_AAC_LOW 1
2352 #define FF_PROFILE_AAC_SSR 2
2353 #define FF_PROFILE_AAC_LTP 3
2355 #define FF_PROFILE_DTS 20
2356 #define FF_PROFILE_DTS_ES 30
2357 #define FF_PROFILE_DTS_96_24 40
2358 #define FF_PROFILE_DTS_HD_HRA 50
2359 #define FF_PROFILE_DTS_HD_MA 60
2361 #define FF_PROFILE_MPEG2_422 0
2362 #define FF_PROFILE_MPEG2_HIGH 1
2363 #define FF_PROFILE_MPEG2_SS 2
2364 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2365 #define FF_PROFILE_MPEG2_MAIN 4
2366 #define FF_PROFILE_MPEG2_SIMPLE 5
2368 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2369 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2371 #define FF_PROFILE_H264_BASELINE 66
2372 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2373 #define FF_PROFILE_H264_MAIN 77
2374 #define FF_PROFILE_H264_EXTENDED 88
2375 #define FF_PROFILE_H264_HIGH 100
2376 #define FF_PROFILE_H264_HIGH_10 110
2377 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2378 #define FF_PROFILE_H264_HIGH_422 122
2379 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2380 #define FF_PROFILE_H264_HIGH_444 144
2381 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2382 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2383 #define FF_PROFILE_H264_CAVLC_444 44
2385 #define FF_PROFILE_VC1_SIMPLE 0
2386 #define FF_PROFILE_VC1_MAIN 1
2387 #define FF_PROFILE_VC1_COMPLEX 2
2388 #define FF_PROFILE_VC1_ADVANCED 3
2390 #define FF_PROFILE_MPEG4_SIMPLE 0
2391 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2392 #define FF_PROFILE_MPEG4_CORE 2
2393 #define FF_PROFILE_MPEG4_MAIN 3
2394 #define FF_PROFILE_MPEG4_N_BIT 4
2395 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2396 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2397 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2398 #define FF_PROFILE_MPEG4_HYBRID 8
2399 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2400 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2401 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2402 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2403 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2404 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2405 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2409 * - encoding: Set by user.
2410 * - decoding: Set by libavcodec.
2413 #define FF_LEVEL_UNKNOWN -99
2416 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2417 * - encoding: unused
2418 * - decoding: Set by user.
2423 * Bitstream width / height, may be different from width/height if lowres enabled.
2424 * - encoding: unused
2425 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2427 int coded_width, coded_height;
2430 * frame skip threshold
2431 * - encoding: Set by user.
2432 * - decoding: unused
2434 int frame_skip_threshold;
2438 * - encoding: Set by user.
2439 * - decoding: unused
2441 int frame_skip_factor;
2444 * frame skip exponent
2445 * - encoding: Set by user.
2446 * - decoding: unused
2451 * frame skip comparison function
2452 * - encoding: Set by user.
2453 * - decoding: unused
2458 * Border processing masking, raises the quantizer for mbs on the borders
2460 * - encoding: Set by user.
2461 * - decoding: unused
2463 float border_masking;
2466 * minimum MB lagrange multipler
2467 * - encoding: Set by user.
2468 * - decoding: unused
2473 * maximum MB lagrange multipler
2474 * - encoding: Set by user.
2475 * - decoding: unused
2481 * - encoding: Set by user.
2482 * - decoding: unused
2484 int me_penalty_compensation;
2488 * - encoding: unused
2489 * - decoding: Set by user.
2491 enum AVDiscard skip_loop_filter;
2495 * - encoding: unused
2496 * - decoding: Set by user.
2498 enum AVDiscard skip_idct;
2502 * - encoding: unused
2503 * - decoding: Set by user.
2505 enum AVDiscard skip_frame;
2509 * - encoding: Set by user.
2510 * - decoding: unused
2516 * - encoding: Set by user.
2517 * - decoding: unused
2523 * - encoding: Set by user.
2524 * - decoding: unused
2529 * number of reference frames
2530 * - encoding: Set by user.
2531 * - decoding: Set by lavc.
2536 * chroma qp offset from luma
2537 * - encoding: Set by user.
2538 * - decoding: unused
2543 * trellis RD quantization
2544 * - encoding: Set by user.
2545 * - decoding: unused
2550 * Audio cutoff bandwidth (0 means "automatic")
2551 * - encoding: Set by user.
2552 * - decoding: unused
2557 * Multiplied by qscale for each frame and added to scene_change_score.
2558 * - encoding: Set by user.
2559 * - decoding: unused
2561 int scenechange_factor;
2565 * Note: Value depends upon the compare function used for fullpel ME.
2566 * - encoding: Set by user.
2567 * - decoding: unused
2572 * Adjust sensitivity of b_frame_strategy 1.
2573 * - encoding: Set by user.
2574 * - decoding: unused
2579 * - encoding: Set by user.
2580 * - decoding: unused
2582 int compression_level;
2583 #define FF_COMPRESSION_DEFAULT -1
2586 * - encoding: Set by user.
2587 * - decoding: unused
2589 int min_prediction_order;
2592 * - encoding: Set by user.
2593 * - decoding: unused
2595 int max_prediction_order;
2597 #if FF_API_FLAC_GLOBAL_OPTS
2599 * @name FLAC options
2600 * @deprecated Use FLAC encoder private options instead.
2605 * LPC coefficient precision - used by FLAC encoder
2606 * - encoding: Set by user.
2607 * - decoding: unused
2609 attribute_deprecated int lpc_coeff_precision;
2612 * search method for selecting prediction order
2613 * - encoding: Set by user.
2614 * - decoding: unused
2616 attribute_deprecated int prediction_order_method;
2619 * - encoding: Set by user.
2620 * - decoding: unused
2622 attribute_deprecated int min_partition_order;
2625 * - encoding: Set by user.
2626 * - decoding: unused
2628 attribute_deprecated int max_partition_order;
2635 * GOP timecode frame start number, in non drop frame format
2636 * - encoding: Set by user.
2637 * - decoding: unused
2639 int64_t timecode_frame_start;
2641 #if FF_API_REQUEST_CHANNELS
2643 * Decoder should decode to this many channels if it can (0 for default)
2644 * - encoding: unused
2645 * - decoding: Set by user.
2646 * @deprecated Deprecated in favor of request_channel_layout.
2648 int request_channels;
2651 #if FF_API_DRC_SCALE
2653 * Percentage of dynamic range compression to be applied by the decoder.
2654 * The default value is 1.0, corresponding to full compression.
2655 * - encoding: unused
2656 * - decoding: Set by user.
2657 * @deprecated use AC3 decoder private option instead.
2659 attribute_deprecated float drc_scale;
2663 * opaque 64bit number (generally a PTS) that will be reordered and
2664 * output in AVFrame.reordered_opaque
2665 * @deprecated in favor of pkt_pts
2666 * - encoding: unused
2667 * - decoding: Set by user.
2669 int64_t reordered_opaque;
2672 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2673 * - encoding: set by user.
2674 * - decoding: set by libavcodec.
2676 int bits_per_raw_sample;
2679 * Audio channel layout.
2680 * - encoding: set by user.
2681 * - decoding: set by libavcodec.
2683 uint64_t channel_layout;
2686 * Request decoder to use this channel layout if it can (0 for default)
2687 * - encoding: unused
2688 * - decoding: Set by user.
2690 uint64_t request_channel_layout;
2693 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2694 * - encoding: Set by user.
2695 * - decoding: unused.
2697 float rc_max_available_vbv_use;
2700 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2701 * - encoding: Set by user.
2702 * - decoding: unused.
2704 float rc_min_vbv_overflow_use;
2707 * Hardware accelerator in use
2708 * - encoding: unused.
2709 * - decoding: Set by libavcodec
2711 struct AVHWAccel *hwaccel;
2714 * For some codecs, the time base is closer to the field rate than the frame rate.
2715 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2716 * if no telecine is used ...
2718 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2720 int ticks_per_frame;
2723 * Hardware accelerator context.
2724 * For some hardware accelerators, a global context needs to be
2725 * provided by the user. In that case, this holds display-dependent
2726 * data Libav cannot instantiate itself. Please refer to the
2727 * Libav HW accelerator documentation to know how to fill this
2728 * is. e.g. for VA API, this is a struct vaapi_context.
2729 * - encoding: unused
2730 * - decoding: Set by user
2732 void *hwaccel_context;
2735 * Chromaticity coordinates of the source primaries.
2736 * - encoding: Set by user
2737 * - decoding: Set by libavcodec
2739 enum AVColorPrimaries color_primaries;
2742 * Color Transfer Characteristic.
2743 * - encoding: Set by user
2744 * - decoding: Set by libavcodec
2746 enum AVColorTransferCharacteristic color_trc;
2749 * YUV colorspace type.
2750 * - encoding: Set by user
2751 * - decoding: Set by libavcodec
2753 enum AVColorSpace colorspace;
2756 * MPEG vs JPEG YUV range.
2757 * - encoding: Set by user
2758 * - decoding: Set by libavcodec
2760 enum AVColorRange color_range;
2763 * This defines the location of chroma samples.
2764 * - encoding: Set by user
2765 * - decoding: Set by libavcodec
2767 enum AVChromaLocation chroma_sample_location;
2770 * The codec may call this to execute several independent things.
2771 * It will return only after finishing all tasks.
2772 * The user may replace this with some multithreaded implementation,
2773 * the default implementation will execute the parts serially.
2774 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2775 * @param c context passed also to func
2776 * @param count the number of things to execute
2777 * @param arg2 argument passed unchanged to func
2778 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2779 * @param func function that will be called count times, with jobnr from 0 to count-1.
2780 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2781 * two instances of func executing at the same time will have the same threadnr.
2782 * @return always 0 currently, but code should handle a future improvement where when any call to func
2783 * returns < 0 no further calls to func may be done and < 0 is returned.
2784 * - encoding: Set by libavcodec, user can override.
2785 * - decoding: Set by libavcodec, user can override.
2787 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2789 int log_level_offset;
2791 #if FF_API_FLAC_GLOBAL_OPTS
2793 * Determine which LPC analysis algorithm to use.
2794 * - encoding: Set by user
2795 * - decoding: unused
2797 attribute_deprecated enum AVLPCType lpc_type;
2800 * Number of passes to use for Cholesky factorization during LPC analysis
2801 * - encoding: Set by user
2802 * - decoding: unused
2804 attribute_deprecated int lpc_passes;
2809 * Indicates number of picture subdivisions. Used for parallelized
2811 * - encoding: Set by user
2812 * - decoding: unused
2817 * Header containing style information for text subtitles.
2818 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2819 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2820 * the Format line following. It shouldn't include any Dialogue line.
2821 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2822 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2824 uint8_t *subtitle_header;
2825 int subtitle_header_size;
2828 * Current packet as passed into the decoder, to avoid having
2829 * to pass the packet into every function. Currently only valid
2830 * inside lavc and get/release_buffer callbacks.
2831 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2832 * - encoding: unused
2836 #if FF_API_INTERNAL_CONTEXT
2838 * Whether this is a copy of the context which had init() called on it.
2839 * This is used by multithreading - shared tables and picture pointers
2840 * should be freed from the original context only.
2841 * - encoding: Set by libavcodec.
2842 * - decoding: Set by libavcodec.
2844 * @deprecated this field has been moved to an internal context
2846 attribute_deprecated int is_copy;
2850 * Which multithreading methods to use.
2851 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2852 * so clients which cannot provide future frames should not use it.
2854 * - encoding: Set by user, otherwise the default is used.
2855 * - decoding: Set by user, otherwise the default is used.
2858 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2859 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2862 * Which multithreading methods are in use by the codec.
2863 * - encoding: Set by libavcodec.
2864 * - decoding: Set by libavcodec.
2866 int active_thread_type;
2869 * Set by the client if its custom get_buffer() callback can be called
2870 * from another thread, which allows faster multithreaded decoding.
2871 * draw_horiz_band() will be called from other threads regardless of this setting.
2872 * Ignored if the default get_buffer() is used.
2873 * - encoding: Set by user.
2874 * - decoding: Set by user.
2876 int thread_safe_callbacks;
2879 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2880 * Used for compliant TS muxing.
2881 * - encoding: Set by libavcodec.
2882 * - decoding: unused.
2887 * Type of service that the audio stream conveys.
2888 * - encoding: Set by user.
2889 * - decoding: Set by libavcodec.
2891 enum AVAudioServiceType audio_service_type;
2894 * Used to request a sample format from the decoder.
2895 * - encoding: unused.
2896 * - decoding: Set by user.
2898 enum AVSampleFormat request_sample_fmt;
2901 * Error recognition; may misdetect some more or less valid parts as errors.
2902 * - encoding: unused
2903 * - decoding: Set by user.
2905 int err_recognition;
2906 #define AV_EF_CRCCHECK (1<<0)
2907 #define AV_EF_BITSTREAM (1<<1)
2908 #define AV_EF_BUFFER (1<<2)
2909 #define AV_EF_EXPLODE (1<<3)
2912 * Private context used for internal data.
2914 * Unlike priv_data, this is not codec-specific. It is used in general
2915 * libavcodec functions.
2917 struct AVCodecInternal *internal;
2920 * - encoding: set by libavcodec
2921 * - decoding: Set by libavcodec
2923 enum AVFieldOrder field_order;
2929 typedef struct AVProfile {
2931 const char *name; ///< short name for the profile
2934 typedef struct AVCodecDefault AVCodecDefault;
2939 typedef struct AVCodec {
2941 * Name of the codec implementation.
2942 * The name is globally unique among encoders and among decoders (but an
2943 * encoder and a decoder can share the same name).
2944 * This is the primary way to find a codec from the user perspective.
2947 enum AVMediaType type;
2950 int (*init)(AVCodecContext *);
2951 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2952 int (*close)(AVCodecContext *);
2953 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2955 * Codec capabilities.
2959 struct AVCodec *next;
2962 * Will be called when seeking
2964 void (*flush)(AVCodecContext *);
2965 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2966 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2968 * Descriptive name for the codec, meant to be more human readable than name.
2969 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2971 const char *long_name;
2972 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2973 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2974 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2975 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2976 const AVClass *priv_class; ///< AVClass for the private context
2977 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2980 * @name Frame-level threading support functions
2984 * If defined, called on thread contexts when they are created.
2985 * If the codec allocates writable tables in init(), re-allocate them here.
2986 * priv_data will be set to a copy of the original.
2988 int (*init_thread_copy)(AVCodecContext *);
2990 * Copy necessary context variables from a previous thread context to the current one.
2991 * If not defined, the next thread will start automatically; otherwise, the codec
2992 * must call ff_thread_finish_setup().
2994 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2996 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3000 * Private codec-specific defaults.
3002 const AVCodecDefault *defaults;
3005 * Initialize codec static data, called from avcodec_register().
3007 void (*init_static_data)(struct AVCodec *codec);
3010 * Encode data to an AVPacket.
3012 * @param avctx codec context
3013 * @param avpkt output AVPacket (may contain a user-provided buffer)
3014 * @param[in] frame AVFrame containing the raw data to be encoded
3015 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3016 * non-empty packet was returned in avpkt.
3017 * @return 0 on success, negative error code on failure
3019 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3020 int *got_packet_ptr);
3026 typedef struct AVHWAccel {
3028 * Name of the hardware accelerated codec.
3029 * The name is globally unique among encoders and among decoders (but an
3030 * encoder and a decoder can share the same name).
3035 * Type of codec implemented by the hardware accelerator.
3037 * See AVMEDIA_TYPE_xxx
3039 enum AVMediaType type;
3042 * Codec implemented by the hardware accelerator.
3049 * Supported pixel format.
3051 * Only hardware accelerated formats are supported here.
3053 enum PixelFormat pix_fmt;
3056 * Hardware accelerated codec capabilities.
3057 * see FF_HWACCEL_CODEC_CAP_*
3061 struct AVHWAccel *next;
3064 * Called at the beginning of each frame or field picture.
3066 * Meaningful frame information (codec specific) is guaranteed to
3067 * be parsed at this point. This function is mandatory.
3069 * Note that buf can be NULL along with buf_size set to 0.
3070 * Otherwise, this means the whole frame is available at this point.
3072 * @param avctx the codec context
3073 * @param buf the frame data buffer base
3074 * @param buf_size the size of the frame in bytes
3075 * @return zero if successful, a negative value otherwise
3077 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3080 * Callback for each slice.
3082 * Meaningful slice information (codec specific) is guaranteed to
3083 * be parsed at this point. This function is mandatory.
3085 * @param avctx the codec context
3086 * @param buf the slice data buffer base
3087 * @param buf_size the size of the slice in bytes
3088 * @return zero if successful, a negative value otherwise
3090 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3093 * Called at the end of each frame or field picture.
3095 * The whole picture is parsed at this point and can now be sent
3096 * to the hardware accelerator. This function is mandatory.
3098 * @param avctx the codec context
3099 * @return zero if successful, a negative value otherwise
3101 int (*end_frame)(AVCodecContext *avctx);
3104 * Size of HW accelerator private data.
3106 * Private data is allocated with av_mallocz() before
3107 * AVCodecContext.get_buffer() and deallocated after
3108 * AVCodecContext.release_buffer().
3114 * four components are given, that's all.
3115 * the last component is alpha
3117 typedef struct AVPicture {
3118 uint8_t *data[AV_NUM_DATA_POINTERS];
3119 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3122 #define AVPALETTE_SIZE 1024
3123 #define AVPALETTE_COUNT 256
3125 enum AVSubtitleType {
3128 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3131 * Plain text, the text field must be set by the decoder and is
3132 * authoritative. ass and pict fields may contain approximations.
3137 * Formatted text, the ass field must be set by the decoder and is
3138 * authoritative. pict and text fields may contain approximations.
3143 typedef struct AVSubtitleRect {
3144 int x; ///< top left corner of pict, undefined when pict is not set
3145 int y; ///< top left corner of pict, undefined when pict is not set
3146 int w; ///< width of pict, undefined when pict is not set
3147 int h; ///< height of pict, undefined when pict is not set
3148 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3151 * data+linesize for the bitmap of this subtitle.
3152 * can be set for text/ass as well once they where rendered
3155 enum AVSubtitleType type;
3157 char *text; ///< 0 terminated plain UTF-8 text
3160 * 0 terminated ASS/SSA compatible event line.
3161 * The pressentation of this is unaffected by the other values in this
3167 typedef struct AVSubtitle {
3168 uint16_t format; /* 0 = graphics */
3169 uint32_t start_display_time; /* relative to packet pts, in ms */
3170 uint32_t end_display_time; /* relative to packet pts, in ms */
3172 AVSubtitleRect **rects;
3173 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3176 /* packet functions */
3179 * @deprecated use NULL instead
3181 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3184 * Default packet destructor.
3186 void av_destruct_packet(AVPacket *pkt);
3189 * Initialize optional fields of a packet with default values.
3193 void av_init_packet(AVPacket *pkt);
3196 * Allocate the payload of a packet and initialize its fields with
3200 * @param size wanted payload size
3201 * @return 0 if OK, AVERROR_xxx otherwise
3203 int av_new_packet(AVPacket *pkt, int size);
3206 * Reduce packet size, correctly zeroing padding
3209 * @param size new size
3211 void av_shrink_packet(AVPacket *pkt, int size);
3214 * Increase packet size, correctly zeroing padding
3217 * @param grow_by number of bytes by which to increase the size of the packet
3219 int av_grow_packet(AVPacket *pkt, int grow_by);
3222 * @warning This is a hack - the packet memory allocation stuff is broken. The
3223 * packet is allocated if it was not really allocated.
3225 int av_dup_packet(AVPacket *pkt);
3230 * @param pkt packet to free
3232 void av_free_packet(AVPacket *pkt);
3235 * Allocate new information of a packet.
3238 * @param type side information type
3239 * @param size side information size
3240 * @return pointer to fresh allocated data or NULL otherwise
3242 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3246 * Get side information from packet.
3249 * @param type desired side information type
3250 * @param size pointer for side information size to store (optional)
3251 * @return pointer to data if present or NULL otherwise
3253 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3258 struct ReSampleContext;
3259 struct AVResampleContext;
3261 typedef struct ReSampleContext ReSampleContext;
3264 * Initialize audio resampling context.
3266 * @param output_channels number of output channels
3267 * @param input_channels number of input channels
3268 * @param output_rate output sample rate
3269 * @param input_rate input sample rate
3270 * @param sample_fmt_out requested output sample format
3271 * @param sample_fmt_in input sample format
3272 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3273 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3274 * @param linear if 1 then the used FIR filter will be linearly interpolated
3275 between the 2 closest, if 0 the closest will be used
3276 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3277 * @return allocated ReSampleContext, NULL if error occurred
3279 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3280 int output_rate, int input_rate,
3281 enum AVSampleFormat sample_fmt_out,
3282 enum AVSampleFormat sample_fmt_in,
3283 int filter_length, int log2_phase_count,
3284 int linear, double cutoff);
3286 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3289 * Free resample context.
3291 * @param s a non-NULL pointer to a resample context previously
3292 * created with av_audio_resample_init()
3294 void audio_resample_close(ReSampleContext *s);
3298 * Initialize an audio resampler.
3299 * Note, if either rate is not an integer then simply scale both rates up so they are.
3300 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3301 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3302 * @param linear If 1 then the used FIR filter will be linearly interpolated
3303 between the 2 closest, if 0 the closest will be used
3304 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3306 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3309 * Resample an array of samples using a previously configured context.
3310 * @param src an array of unconsumed samples
3311 * @param consumed the number of samples of src which have been consumed are returned here
3312 * @param src_size the number of unconsumed samples available
3313 * @param dst_size the amount of space in samples available in dst
3314 * @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.
3315 * @return the number of samples written in dst or -1 if an error occurred
3317 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3321 * Compensate samplerate/timestamp drift. The compensation is done by changing
3322 * the resampler parameters, so no audible clicks or similar distortions occur
3323 * @param compensation_distance distance in output samples over which the compensation should be performed
3324 * @param sample_delta number of output samples which should be output less
3326 * example: av_resample_compensate(c, 10, 500)
3327 * here instead of 510 samples only 500 samples would be output
3329 * note, due to rounding the actual compensation might be slightly different,
3330 * especially if the compensation_distance is large and the in_rate used during init is small
3332 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3333 void av_resample_close(struct AVResampleContext *c);
3336 * Allocate memory for a picture. Call avpicture_free() to free it.
3338 * @see avpicture_fill()
3340 * @param picture the picture to be filled in
3341 * @param pix_fmt the format of the picture
3342 * @param width the width of the picture
3343 * @param height the height of the picture
3344 * @return zero if successful, a negative value if not
3346 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3349 * Free a picture previously allocated by avpicture_alloc().
3350 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3353 * @param picture the AVPicture to be freed
3355 void avpicture_free(AVPicture *picture);
3358 * Fill in the AVPicture fields.
3359 * The fields of the given AVPicture are filled in by using the 'ptr' address
3360 * which points to the image data buffer. Depending on the specified picture
3361 * format, one or multiple image data pointers and line sizes will be set.
3362 * If a planar format is specified, several pointers will be set pointing to
3363 * the different picture planes and the line sizes of the different planes
3364 * will be stored in the lines_sizes array.
3365 * Call with ptr == NULL to get the required size for the ptr buffer.
3367 * To allocate the buffer and fill in the AVPicture fields in one call,
3368 * use avpicture_alloc().
3370 * @param picture AVPicture whose fields are to be filled in
3371 * @param ptr Buffer which will contain or contains the actual image data
3372 * @param pix_fmt The format in which the picture data is stored.
3373 * @param width the width of the image in pixels
3374 * @param height the height of the image in pixels
3375 * @return size of the image data in bytes
3377 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3378 enum PixelFormat pix_fmt, int width, int height);
3381 * Copy pixel data from an AVPicture into a buffer.
3382 * The data is stored compactly, without any gaps for alignment or padding
3383 * which may be applied by avpicture_fill().
3385 * @see avpicture_get_size()
3387 * @param[in] src AVPicture containing image data
3388 * @param[in] pix_fmt The format in which the picture data is stored.
3389 * @param[in] width the width of the image in pixels.
3390 * @param[in] height the height of the image in pixels.
3391 * @param[out] dest A buffer into which picture data will be copied.
3392 * @param[in] dest_size The size of 'dest'.
3393 * @return The number of bytes written to dest, or a negative value (error code) on error.
3395 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3396 unsigned char *dest, int dest_size);
3399 * Calculate the size in bytes that a picture of the given width and height
3400 * would occupy if stored in the given picture format.
3401 * Note that this returns the size of a compact representation as generated
3402 * by avpicture_layout(), which can be smaller than the size required for e.g.
3405 * @param pix_fmt the given picture format
3406 * @param width the width of the image
3407 * @param height the height of the image
3408 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3410 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3411 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3413 #if FF_API_GET_PIX_FMT_NAME
3415 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3417 attribute_deprecated
3418 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3421 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3424 * Return a value representing the fourCC code associated to the
3425 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3428 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3431 * Put a string representing the codec tag codec_tag in buf.
3433 * @param buf_size size in bytes of buf
3434 * @return the length of the string that would have been generated if
3435 * enough space had been available, excluding the trailing null
3437 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3439 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3440 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3441 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3442 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3443 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3444 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3447 * Compute what kind of losses will occur when converting from one specific
3448 * pixel format to another.
3449 * When converting from one pixel format to another, information loss may occur.
3450 * For example, when converting from RGB24 to GRAY, the color information will
3451 * be lost. Similarly, other losses occur when converting from some formats to
3452 * other formats. These losses can involve loss of chroma, but also loss of
3453 * resolution, loss of color depth, loss due to the color space conversion, loss
3454 * of the alpha bits or loss due to color quantization.
3455 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3456 * which will occur when converting from one pixel format to another.
3458 * @param[in] dst_pix_fmt destination pixel format
3459 * @param[in] src_pix_fmt source pixel format
3460 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3461 * @return Combination of flags informing you what kind of losses will occur.
3463 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3467 * Find the best pixel format to convert to given a certain source pixel
3468 * format. When converting from one pixel format to another, information loss
3469 * may occur. For example, when converting from RGB24 to GRAY, the color
3470 * information will be lost. Similarly, other losses occur when converting from
3471 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3472 * the given pixel formats should be used to suffer the least amount of loss.
3473 * The pixel formats from which it chooses one, are determined by the
3474 * pix_fmt_mask parameter.
3477 * src_pix_fmt = PIX_FMT_YUV420P;
3478 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3479 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3482 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3483 * @param[in] src_pix_fmt source pixel format
3484 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3485 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3486 * @return The best pixel format to convert to or -1 if none was found.
3488 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3489 int has_alpha, int *loss_ptr);
3491 #if FF_API_GET_ALPHA_INFO
3492 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3493 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3496 * Tell if an image really has transparent alpha values.
3497 * @return ored mask of FF_ALPHA_xxx constants
3499 attribute_deprecated
3500 int img_get_alpha_info(const AVPicture *src,
3501 enum PixelFormat pix_fmt, int width, int height);
3504 /* deinterlace a picture */
3505 /* deinterlace - if not supported return -1 */
3506 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3507 enum PixelFormat pix_fmt, int width, int height);
3509 /* external high level API */
3512 * If c is NULL, returns the first registered codec,
3513 * if c is non-NULL, returns the next registered codec after c,
3514 * or NULL if c is the last one.
3516 AVCodec *av_codec_next(AVCodec *c);
3519 * Return the LIBAVCODEC_VERSION_INT constant.
3521 unsigned avcodec_version(void);
3524 * Return the libavcodec build-time configuration.
3526 const char *avcodec_configuration(void);
3529 * Return the libavcodec license.
3531 const char *avcodec_license(void);
3533 #if FF_API_AVCODEC_INIT
3535 * @deprecated this function is called automatically from avcodec_register()
3536 * and avcodec_register_all(), there is no need to call it manually
3538 attribute_deprecated
3539 void avcodec_init(void);
3543 * Register the codec codec and initialize libavcodec.
3545 * @warning either this function or avcodec_register_all() must be called
3546 * before any other libavcodec functions.
3548 * @see avcodec_register_all()
3550 void avcodec_register(AVCodec *codec);
3553 * Find a registered encoder with a matching codec ID.
3555 * @param id CodecID of the requested encoder
3556 * @return An encoder if one was found, NULL otherwise.
3558 AVCodec *avcodec_find_encoder(enum CodecID id);
3561 * Find a registered encoder with the specified name.
3563 * @param name name of the requested encoder
3564 * @return An encoder if one was found, NULL otherwise.
3566 AVCodec *avcodec_find_encoder_by_name(const char *name);
3569 * Find a registered decoder with a matching codec ID.
3571 * @param id CodecID of the requested decoder
3572 * @return A decoder if one was found, NULL otherwise.
3574 AVCodec *avcodec_find_decoder(enum CodecID id);
3577 * Find a registered decoder with the specified name.
3579 * @param name name of the requested decoder
3580 * @return A decoder if one was found, NULL otherwise.
3582 AVCodec *avcodec_find_decoder_by_name(const char *name);
3583 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3586 * Return a name for the specified profile, if available.
3588 * @param codec the codec that is searched for the given profile
3589 * @param profile the profile value for which a name is requested
3590 * @return A name for the profile if found, NULL otherwise.
3592 const char *av_get_profile_name(const AVCodec *codec, int profile);
3594 #if FF_API_ALLOC_CONTEXT
3596 * Set the fields of the given AVCodecContext to default values.
3598 * @param s The AVCodecContext of which the fields should be set to default values.
3599 * @deprecated use avcodec_get_context_defaults3
3601 attribute_deprecated
3602 void avcodec_get_context_defaults(AVCodecContext *s);
3604 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3605 * we WILL change its arguments and name a few times! */
3606 attribute_deprecated
3607 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3611 * Set the fields of the given AVCodecContext to default values corresponding
3612 * to the given codec (defaults may be codec-dependent).
3614 * Do not call this function if a non-NULL codec has been passed
3615 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3616 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3617 * different codec on this AVCodecContext.
3619 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3621 #if FF_API_ALLOC_CONTEXT
3623 * Allocate an AVCodecContext and set its fields to default values. The
3624 * resulting struct can be deallocated by simply calling av_free().
3626 * @return An AVCodecContext filled with default values or NULL on failure.
3627 * @see avcodec_get_context_defaults
3629 * @deprecated use avcodec_alloc_context3()
3631 attribute_deprecated
3632 AVCodecContext *avcodec_alloc_context(void);
3634 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3635 * we WILL change its arguments and name a few times! */
3636 attribute_deprecated
3637 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3641 * Allocate an AVCodecContext and set its fields to default values. The
3642 * resulting struct can be deallocated by simply calling av_free().
3644 * @param codec if non-NULL, allocate private data and initialize defaults
3645 * for the given codec. It is illegal to then call avcodec_open2()
3646 * with a different codec.
3648 * @return An AVCodecContext filled with default values or NULL on failure.
3649 * @see avcodec_get_context_defaults
3651 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3654 * Copy the settings of the source AVCodecContext into the destination
3655 * AVCodecContext. The resulting destination codec context will be
3656 * unopened, i.e. you are required to call avcodec_open2() before you
3657 * can use this AVCodecContext to decode/encode video/audio data.
3659 * @param dest target codec context, should be initialized with
3660 * avcodec_alloc_context3(), but otherwise uninitialized
3661 * @param src source codec context
3662 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3664 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3667 * Set the fields of the given AVFrame to default values.
3669 * @param pic The AVFrame of which the fields should be set to default values.
3671 void avcodec_get_frame_defaults(AVFrame *pic);
3674 * Allocate an AVFrame and set its fields to default values. The resulting
3675 * struct can be deallocated by simply calling av_free().
3677 * @return An AVFrame filled with default values or NULL on failure.
3678 * @see avcodec_get_frame_defaults
3680 AVFrame *avcodec_alloc_frame(void);
3682 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3683 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3684 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3687 * Return the amount of padding in pixels which the get_buffer callback must
3688 * provide around the edge of the image for codecs which do not have the
3689 * CODEC_FLAG_EMU_EDGE flag.
3691 * @return Required padding in pixels.
3693 unsigned avcodec_get_edge_width(void);
3695 * Modify width and height values so that they will result in a memory
3696 * buffer that is acceptable for the codec if you do not use any horizontal
3699 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3700 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3701 * according to avcodec_get_edge_width() before.
3703 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3705 * Modify width and height values so that they will result in a memory
3706 * buffer that is acceptable for the codec if you also ensure that all
3707 * line sizes are a multiple of the respective linesize_align[i].
3709 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3710 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3711 * according to avcodec_get_edge_width() before.
3713 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3714 int linesize_align[AV_NUM_DATA_POINTERS]);
3716 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3718 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3719 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3720 //FIXME func typedef
3722 #if FF_API_AVCODEC_OPEN
3724 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3725 * function the context has to be allocated.
3727 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3728 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3729 * retrieving a codec.
3731 * @warning This function is not thread safe!
3734 * avcodec_register_all();
3735 * codec = avcodec_find_decoder(CODEC_ID_H264);
3739 * context = avcodec_alloc_context3(codec);
3741 * if (avcodec_open(context, codec) < 0)
3745 * @param avctx The context which will be set up to use the given codec.
3746 * @param codec The codec to use within the context.
3747 * @return zero on success, a negative value on error
3748 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3750 * @deprecated use avcodec_open2
3752 attribute_deprecated
3753 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3757 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3758 * function the context has to be allocated with avcodec_alloc_context3().
3760 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3761 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3762 * retrieving a codec.
3764 * @warning This function is not thread safe!
3767 * avcodec_register_all();
3768 * av_dict_set(&opts, "b", "2.5M", 0);
3769 * codec = avcodec_find_decoder(CODEC_ID_H264);
3773 * context = avcodec_alloc_context3(codec);
3775 * if (avcodec_open2(context, codec, opts) < 0)
3779 * @param avctx The context to initialize.
3780 * @param options A dictionary filled with AVCodecContext and codec-private options.
3781 * On return this object will be filled with options that were not found.
3783 * @return zero on success, a negative value on error
3784 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3785 * av_dict_set(), av_opt_find().
3787 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3789 #if FF_API_OLD_DECODE_AUDIO
3791 * Wrapper function which calls avcodec_decode_audio4.
3793 * @deprecated Use avcodec_decode_audio4 instead.
3795 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3796 * Some decoders may support multiple frames in a single AVPacket, such
3797 * decoders would then just decode the first frame. In this case,
3798 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3799 * the remaining data in order to decode the second frame etc.
3801 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3802 * decompressed frame size in bytes.
3804 * @warning You must set frame_size_ptr to the allocated size of the
3805 * output buffer before calling avcodec_decode_audio3().
3807 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3808 * the actual read bytes because some optimized bitstream readers read 32 or 64
3809 * bits at once and could read over the end.
3811 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3812 * no overreading happens for damaged MPEG streams.
3814 * @warning You must not provide a custom get_buffer() when using
3815 * avcodec_decode_audio3(). Doing so will override it with
3816 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3817 * which does allow the application to provide a custom get_buffer().
3819 * @note You might have to align the input buffer avpkt->data and output buffer
3820 * samples. 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 and
3825 * samples should be 16 byte aligned unless the CPU doesn't need it
3826 * (AltiVec and SSE do).
3828 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3829 * between input and output, these need to be fed with avpkt->data=NULL,
3830 * avpkt->size=0 at the end to return the remaining frames.
3832 * @param avctx the codec context
3833 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3834 * If the sample format is planar, each channel plane will
3835 * be the same size, with no padding between channels.
3836 * @param[in,out] frame_size_ptr the output buffer size in bytes
3837 * @param[in] avpkt The input AVPacket containing the input buffer.
3838 * You can create such packet with av_init_packet() and by then setting
3839 * data and size, some decoders might in addition need other fields.
3840 * All decoders are designed to use the least fields possible though.
3841 * @return On error a negative value is returned, otherwise the number of bytes
3842 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3844 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3845 int *frame_size_ptr,
3850 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3852 * Some decoders may support multiple frames in a single AVPacket. Such
3853 * decoders would then just decode the first frame. In this case,
3854 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3855 * the remaining data in order to decode the second frame, etc...
3856 * Even if no frames are returned, the packet needs to be fed to the decoder
3857 * with remaining data until it is completely consumed or an error occurs.
3859 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3860 * larger than the actual read bytes because some optimized bitstream
3861 * readers read 32 or 64 bits at once and could read over the end.
3863 * @note You might have to align the input buffer. The alignment requirements
3864 * depend on the CPU and the decoder.
3866 * @param avctx the codec context
3867 * @param[out] frame The AVFrame in which to store decoded audio samples.
3868 * Decoders request a buffer of a particular size by setting
3869 * AVFrame.nb_samples prior to calling get_buffer(). The
3870 * decoder may, however, only utilize part of the buffer by
3871 * setting AVFrame.nb_samples to a smaller value in the
3873 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3875 * @param[in] avpkt The input AVPacket containing the input buffer.
3876 * At least avpkt->data and avpkt->size should be set. Some
3877 * decoders might also require additional fields to be set.
3878 * @return A negative error code is returned if an error occurred during
3879 * decoding, otherwise the number of bytes consumed from the input
3880 * AVPacket is returned.
3882 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3883 int *got_frame_ptr, AVPacket *avpkt);
3886 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3887 * Some decoders may support multiple frames in a single AVPacket, such
3888 * decoders would then just decode the first frame.
3890 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3891 * the actual read bytes because some optimized bitstream readers read 32 or 64
3892 * bits at once and could read over the end.
3894 * @warning The end of the input buffer buf should be set to 0 to ensure that
3895 * no overreading happens for damaged MPEG streams.
3897 * @note You might have to align the input buffer avpkt->data.
3898 * The alignment requirements depend on the CPU: on some CPUs it isn't
3899 * necessary at all, on others it won't work at all if not aligned and on others
3900 * it will work but it will have an impact on performance.
3902 * In practice, avpkt->data should have 4 byte alignment at minimum.
3904 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3905 * between input and output, these need to be fed with avpkt->data=NULL,
3906 * avpkt->size=0 at the end to return the remaining frames.
3908 * @param avctx the codec context
3909 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3910 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3911 * allocate memory for the actual bitmap.
3912 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3913 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3914 * decodes and the decoder tells the user once it does not need the data anymore,
3915 * the user app can at this point free/reuse/keep the memory as it sees fit.
3917 * @param[in] avpkt The input AVpacket containing the input buffer.
3918 * You can create such packet with av_init_packet() and by then setting
3919 * data and size, some decoders might in addition need other fields like
3920 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3922 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3923 * @return On error a negative value is returned, otherwise the number of bytes
3924 * used or zero if no frame could be decompressed.
3926 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3927 int *got_picture_ptr,
3931 * Decode a subtitle message.
3932 * Return a negative value on error, otherwise return the number of bytes used.
3933 * If no subtitle could be decompressed, got_sub_ptr is zero.
3934 * Otherwise, the subtitle is stored in *sub.
3935 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3936 * simplicity, because the performance difference is expect to be negligible
3937 * and reusing a get_buffer written for video codecs would probably perform badly
3938 * due to a potentially very different allocation pattern.
3940 * @param avctx the codec context
3941 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3942 freed with avsubtitle_free if *got_sub_ptr is set.
3943 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3944 * @param[in] avpkt The input AVPacket containing the input buffer.
3946 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3951 * Free all allocated data in the given subtitle struct.
3953 * @param sub AVSubtitle to free.
3955 void avsubtitle_free(AVSubtitle *sub);
3957 #if FF_API_OLD_ENCODE_AUDIO
3959 * Encode an audio frame from samples into buf.
3961 * @deprecated Use avcodec_encode_audio2 instead.
3963 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3964 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3965 * will know how much space is needed because it depends on the value passed
3966 * in buf_size as described below. In that case a lower value can be used.
3968 * @param avctx the codec context
3969 * @param[out] buf the output buffer
3970 * @param[in] buf_size the output buffer size
3971 * @param[in] samples the input buffer containing the samples
3972 * The number of samples read from this buffer is frame_size*channels,
3973 * both of which are defined in avctx.
3974 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3975 * samples read from samples is equal to:
3976 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3977 * This also implies that av_get_bits_per_sample() must not return 0 for these
3979 * @return On error a negative value is returned, on success zero or the number
3980 * of bytes used to encode the data read from the input buffer.
3982 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3983 uint8_t *buf, int buf_size,
3984 const short *samples);
3988 * Encode a frame of audio.
3990 * Takes input samples from frame and writes the next output packet, if
3991 * available, to avpkt. The output packet does not necessarily contain data for
3992 * the most recent frame, as encoders can delay, split, and combine input frames
3993 * internally as needed.
3995 * @param avctx codec context
3996 * @param avpkt output AVPacket.
3997 * The user can supply an output buffer by setting
3998 * avpkt->data and avpkt->size prior to calling the
3999 * function, but if the size of the user-provided data is not
4000 * large enough, encoding will fail. All other AVPacket fields
4001 * will be reset by the encoder using av_init_packet(). If
4002 * avpkt->data is NULL, the encoder will allocate it.
4003 * The encoder will set avpkt->size to the size of the
4005 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4006 * May be NULL when flushing an encoder that has the
4007 * CODEC_CAP_DELAY capability set.
4008 * There are 2 codec capabilities that affect the allowed
4009 * values of frame->nb_samples.
4010 * If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
4011 * frame may be smaller than avctx->frame_size, and all other
4012 * frames must be equal to avctx->frame_size.
4013 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4014 * can have any number of samples.
4015 * If neither is set, frame->nb_samples must be equal to
4016 * avctx->frame_size for all frames.
4017 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4018 * output packet is non-empty, and to 0 if it is
4019 * empty. If the function returns an error, the
4020 * packet can be assumed to be invalid, and the
4021 * value of got_packet_ptr is undefined and should
4023 * @return 0 on success, negative error code on failure
4025 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4026 const AVFrame *frame, int *got_packet_ptr);
4029 * Fill audio frame data and linesize.
4030 * AVFrame extended_data channel pointers are allocated if necessary for
4033 * @param frame the AVFrame
4034 * frame->nb_samples must be set prior to calling the
4035 * function. This function fills in frame->data,
4036 * frame->extended_data, frame->linesize[0].
4037 * @param nb_channels channel count
4038 * @param sample_fmt sample format
4039 * @param buf buffer to use for frame data
4040 * @param buf_size size of buffer
4041 * @param align plane size sample alignment
4042 * @return 0 on success, negative error code on failure
4044 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4045 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4046 int buf_size, int align);
4049 * Encode a video frame from pict into buf.
4050 * The input picture should be
4051 * stored using a specific format, namely avctx.pix_fmt.
4053 * @param avctx the codec context
4054 * @param[out] buf the output buffer for the bitstream of encoded frame
4055 * @param[in] buf_size the size of the output buffer in bytes
4056 * @param[in] pict the input picture to encode
4057 * @return On error a negative value is returned, on success zero or the number
4058 * of bytes used from the output buffer.
4060 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4061 const AVFrame *pict);
4062 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4063 const AVSubtitle *sub);
4065 int avcodec_close(AVCodecContext *avctx);
4068 * Register all the codecs, parsers and bitstream filters which were enabled at
4069 * configuration time. If you do not call this function you can select exactly
4070 * which formats you want to support, by using the individual registration
4073 * @see avcodec_register
4074 * @see av_register_codec_parser
4075 * @see av_register_bitstream_filter
4077 void avcodec_register_all(void);
4080 * Flush buffers, should be called when seeking or when switching to a different stream.
4082 void avcodec_flush_buffers(AVCodecContext *avctx);
4084 void avcodec_default_free_buffers(AVCodecContext *s);
4086 /* misc useful functions */
4089 * Return codec bits per sample.
4091 * @param[in] codec_id the codec
4092 * @return Number of bits per sample or zero if unknown for the given codec.
4094 int av_get_bits_per_sample(enum CodecID codec_id);
4097 typedef struct AVCodecParserContext {
4099 struct AVCodecParser *parser;
4100 int64_t frame_offset; /* offset of the current frame */
4101 int64_t cur_offset; /* current offset
4102 (incremented by each av_parser_parse()) */
4103 int64_t next_frame_offset; /* offset of the next frame */
4105 int pict_type; /* XXX: Put it back in AVCodecContext. */
4107 * This field is used for proper frame duration computation in lavf.
4108 * It signals, how much longer the frame duration of the current frame
4109 * is compared to normal frame duration.
4111 * frame_duration = (1 + repeat_pict) * time_base
4113 * It is used by codecs like H.264 to display telecined material.
4115 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4116 int64_t pts; /* pts of the current frame */
4117 int64_t dts; /* dts of the current frame */
4122 int fetch_timestamp;
4124 #define AV_PARSER_PTS_NB 4
4125 int cur_frame_start_index;
4126 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4127 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4128 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4131 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4132 #define PARSER_FLAG_ONCE 0x0002
4133 /// Set if the parser has a valid file offset
4134 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4136 int64_t offset; ///< byte offset from starting packet start
4137 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4140 * Set by parser to 1 for key frames and 0 for non-key frames.
4141 * It is initialized to -1, so if the parser doesn't set this flag,
4142 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4148 * Time difference in stream time base units from the pts of this
4149 * packet to the point at which the output from the decoder has converged
4150 * independent from the availability of previous frames. That is, the
4151 * frames are virtually identical no matter if decoding started from
4152 * the very first frame or from this keyframe.
4153 * Is AV_NOPTS_VALUE if unknown.
4154 * This field is not the display duration of the current frame.
4155 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4158 * The purpose of this field is to allow seeking in streams that have no
4159 * keyframes in the conventional sense. It corresponds to the
4160 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4161 * essential for some types of subtitle streams to ensure that all
4162 * subtitles are correctly displayed after seeking.
4164 int64_t convergence_duration;
4166 // Timestamp generation support:
4168 * Synchronization point for start of timestamp generation.
4170 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4173 * For example, this corresponds to presence of H.264 buffering period
4179 * Offset of the current timestamp against last timestamp sync point in
4180 * units of AVCodecContext.time_base.
4182 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4183 * contain a valid timestamp offset.
4185 * Note that the timestamp of sync point has usually a nonzero
4186 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4187 * the next frame after timestamp sync point will be usually 1.
4189 * For example, this corresponds to H.264 cpb_removal_delay.
4191 int dts_ref_dts_delta;
4194 * Presentation delay of current frame in units of AVCodecContext.time_base.
4196 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4197 * contain valid non-negative timestamp delta (presentation time of a frame
4198 * must not lie in the past).
4200 * This delay represents the difference between decoding and presentation
4201 * time of the frame.
4203 * For example, this corresponds to H.264 dpb_output_delay.
4208 * Position of the packet in file.
4210 * Analogous to cur_frame_pts/dts
4212 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4215 * Byte position of currently parsed frame in stream.
4220 * Previous frame byte position.
4223 } AVCodecParserContext;
4225 typedef struct AVCodecParser {
4226 int codec_ids[5]; /* several codec IDs are permitted */
4228 int (*parser_init)(AVCodecParserContext *s);
4229 int (*parser_parse)(AVCodecParserContext *s,
4230 AVCodecContext *avctx,
4231 const uint8_t **poutbuf, int *poutbuf_size,
4232 const uint8_t *buf, int buf_size);
4233 void (*parser_close)(AVCodecParserContext *s);
4234 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4235 struct AVCodecParser *next;
4238 AVCodecParser *av_parser_next(AVCodecParser *c);
4240 void av_register_codec_parser(AVCodecParser *parser);
4241 AVCodecParserContext *av_parser_init(int codec_id);
4246 * @param s parser context.
4247 * @param avctx codec context.
4248 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4249 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4250 * @param buf input buffer.
4251 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4252 * @param pts input presentation timestamp.
4253 * @param dts input decoding timestamp.
4254 * @param pos input byte position in stream.
4255 * @return the number of bytes of the input bitstream used.
4260 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4267 * decode_frame(data, size);
4271 int av_parser_parse2(AVCodecParserContext *s,
4272 AVCodecContext *avctx,
4273 uint8_t **poutbuf, int *poutbuf_size,
4274 const uint8_t *buf, int buf_size,
4275 int64_t pts, int64_t dts,
4278 int av_parser_change(AVCodecParserContext *s,
4279 AVCodecContext *avctx,
4280 uint8_t **poutbuf, int *poutbuf_size,
4281 const uint8_t *buf, int buf_size, int keyframe);
4282 void av_parser_close(AVCodecParserContext *s);
4285 typedef struct AVBitStreamFilterContext {
4287 struct AVBitStreamFilter *filter;
4288 AVCodecParserContext *parser;
4289 struct AVBitStreamFilterContext *next;
4290 } AVBitStreamFilterContext;
4293 typedef struct AVBitStreamFilter {
4296 int (*filter)(AVBitStreamFilterContext *bsfc,
4297 AVCodecContext *avctx, const char *args,
4298 uint8_t **poutbuf, int *poutbuf_size,
4299 const uint8_t *buf, int buf_size, int keyframe);
4300 void (*close)(AVBitStreamFilterContext *bsfc);
4301 struct AVBitStreamFilter *next;
4302 } AVBitStreamFilter;
4304 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4305 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4306 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4307 AVCodecContext *avctx, const char *args,
4308 uint8_t **poutbuf, int *poutbuf_size,
4309 const uint8_t *buf, int buf_size, int keyframe);
4310 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4312 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4317 * Reallocate the given block if it is not large enough, otherwise do nothing.
4321 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4324 * Allocate a buffer, reusing the given one if large enough.
4326 * Contrary to av_fast_realloc the current buffer contents might not be
4327 * preserved and on error the old buffer is freed, thus no special
4328 * handling to avoid memleaks is necessary.
4330 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4331 * @param size size of the buffer *ptr points to
4332 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4333 * *size 0 if an error occurred.
4335 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4338 * Copy image src to dst. Wraps av_picture_data_copy() above.
4340 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4341 enum PixelFormat pix_fmt, int width, int height);
4344 * Crop image top and left side.
4346 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4347 enum PixelFormat pix_fmt, int top_band, int left_band);
4352 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4353 int padtop, int padbottom, int padleft, int padright, int *color);
4356 * Encode extradata length to a buffer. Used by xiph codecs.
4358 * @param s buffer to write to; must be at least (v/255+1) bytes long
4359 * @param v size of extradata in bytes
4360 * @return number of bytes written to the buffer.
4362 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4365 * Log a generic warning message about a missing feature. This function is
4366 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4367 * only, and would normally not be used by applications.
4368 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4369 * a pointer to an AVClass struct
4370 * @param[in] feature string containing the name of the missing feature
4371 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4372 * If want_sample is non-zero, additional verbage will be added to the log
4373 * message which tells the user how to report samples to the development
4376 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4379 * Log a generic warning message asking for a sample. This function is
4380 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4381 * only, and would normally not be used by applications.
4382 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4383 * a pointer to an AVClass struct
4384 * @param[in] msg string containing an optional message, or NULL if no message
4386 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4389 * Register the hardware accelerator hwaccel.
4391 void av_register_hwaccel(AVHWAccel *hwaccel);
4394 * If hwaccel is NULL, returns the first registered hardware accelerator,
4395 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4396 * after hwaccel, or NULL if hwaccel is the last one.
4398 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4402 * Lock operation used by lockmgr
4405 AV_LOCK_CREATE, ///< Create a mutex
4406 AV_LOCK_OBTAIN, ///< Lock the mutex
4407 AV_LOCK_RELEASE, ///< Unlock the mutex
4408 AV_LOCK_DESTROY, ///< Free mutex resources
4412 * Register a user provided lock manager supporting the operations
4413 * specified by AVLockOp. mutex points to a (void *) where the
4414 * lockmgr should store/get a pointer to a user allocated mutex. It's
4415 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4417 * @param cb User defined callback. Note: Libav may invoke calls to this
4418 * callback during the call to av_lockmgr_register().
4419 * Thus, the application must be prepared to handle that.
4420 * If cb is set to NULL the lockmgr will be unregistered.
4421 * Also note that during unregistration the previously registered
4422 * lockmgr callback may also be invoked.
4424 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4427 * Get the type of the given codec.
4429 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4432 * Get the AVClass for AVCodecContext. It can be used in combination with
4433 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4435 * @see av_opt_find().
4437 const AVClass *avcodec_get_class(void);
4439 #endif /* AVCODEC_AVCODEC_H */