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
71 * @defgroup lavc_core Core functions/structures.
74 * Basic definitions, functions for querying libavcodec capabilities,
75 * allocating core structures, etc.
81 * Identify the syntax and semantics of the bitstream.
82 * The principle is roughly:
83 * Two decoders with the same ID can decode the same streams.
84 * Two encoders with the same ID can encode compatible streams.
85 * There may be slight deviations from the principle due to implementation
88 * If you add a codec ID to this list, add it so that
89 * 1. no value of a existing codec ID changes (that would break ABI),
90 * 2. it is as close as possible to similar codecs.
92 * After adding new codec IDs, do not forget to add an entry to the codec
93 * descriptor list and bump libavcodec minor version.
99 AV_CODEC_ID_MPEG1VIDEO,
100 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
101 AV_CODEC_ID_MPEG2VIDEO_XVMC,
112 AV_CODEC_ID_RAWVIDEO,
113 AV_CODEC_ID_MSMPEG4V1,
114 AV_CODEC_ID_MSMPEG4V2,
115 AV_CODEC_ID_MSMPEG4V3,
138 AV_CODEC_ID_INTERPLAY_VIDEO,
145 AV_CODEC_ID_MSVIDEO1,
150 AV_CODEC_ID_TRUEMOTION1,
151 AV_CODEC_ID_VMDVIDEO,
177 AV_CODEC_ID_TRUEMOTION2,
183 AV_CODEC_ID_SMACKVIDEO,
188 AV_CODEC_ID_JPEG2000,
194 AV_CODEC_ID_DSICINVIDEO,
195 AV_CODEC_ID_TIERTEXSEQVIDEO,
203 AV_CODEC_ID_BETHSOFTVID,
215 AV_CODEC_ID_ESCAPE124,
219 AV_CODEC_ID_MOTIONPIXELS,
231 AV_CODEC_ID_FLASHSV2,
232 AV_CODEC_ID_CDGRAPHICS,
235 AV_CODEC_ID_BINKVIDEO,
236 AV_CODEC_ID_IFF_ILBM,
237 AV_CODEC_ID_IFF_BYTERUN1,
243 AV_CODEC_ID_A64_MULTI,
244 AV_CODEC_ID_A64_MULTI5,
247 AV_CODEC_ID_LAGARITH,
251 AV_CODEC_ID_WMV3IMAGE,
252 AV_CODEC_ID_VC1IMAGE,
254 AV_CODEC_ID_BMV_VIDEO,
261 AV_CODEC_ID_ZEROCODEC,
269 /* various PCM "codecs" */
270 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
271 AV_CODEC_ID_PCM_S16LE = 0x10000,
272 AV_CODEC_ID_PCM_S16BE,
273 AV_CODEC_ID_PCM_U16LE,
274 AV_CODEC_ID_PCM_U16BE,
277 AV_CODEC_ID_PCM_MULAW,
278 AV_CODEC_ID_PCM_ALAW,
279 AV_CODEC_ID_PCM_S32LE,
280 AV_CODEC_ID_PCM_S32BE,
281 AV_CODEC_ID_PCM_U32LE,
282 AV_CODEC_ID_PCM_U32BE,
283 AV_CODEC_ID_PCM_S24LE,
284 AV_CODEC_ID_PCM_S24BE,
285 AV_CODEC_ID_PCM_U24LE,
286 AV_CODEC_ID_PCM_U24BE,
287 AV_CODEC_ID_PCM_S24DAUD,
288 AV_CODEC_ID_PCM_ZORK,
289 AV_CODEC_ID_PCM_S16LE_PLANAR,
291 AV_CODEC_ID_PCM_F32BE,
292 AV_CODEC_ID_PCM_F32LE,
293 AV_CODEC_ID_PCM_F64BE,
294 AV_CODEC_ID_PCM_F64LE,
295 AV_CODEC_ID_PCM_BLURAY,
298 AV_CODEC_ID_PCM_S8_PLANAR,
300 /* various ADPCM codecs */
301 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
302 AV_CODEC_ID_ADPCM_IMA_WAV,
303 AV_CODEC_ID_ADPCM_IMA_DK3,
304 AV_CODEC_ID_ADPCM_IMA_DK4,
305 AV_CODEC_ID_ADPCM_IMA_WS,
306 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
307 AV_CODEC_ID_ADPCM_MS,
308 AV_CODEC_ID_ADPCM_4XM,
309 AV_CODEC_ID_ADPCM_XA,
310 AV_CODEC_ID_ADPCM_ADX,
311 AV_CODEC_ID_ADPCM_EA,
312 AV_CODEC_ID_ADPCM_G726,
313 AV_CODEC_ID_ADPCM_CT,
314 AV_CODEC_ID_ADPCM_SWF,
315 AV_CODEC_ID_ADPCM_YAMAHA,
316 AV_CODEC_ID_ADPCM_SBPRO_4,
317 AV_CODEC_ID_ADPCM_SBPRO_3,
318 AV_CODEC_ID_ADPCM_SBPRO_2,
319 AV_CODEC_ID_ADPCM_THP,
320 AV_CODEC_ID_ADPCM_IMA_AMV,
321 AV_CODEC_ID_ADPCM_EA_R1,
322 AV_CODEC_ID_ADPCM_EA_R3,
323 AV_CODEC_ID_ADPCM_EA_R2,
324 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
325 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
326 AV_CODEC_ID_ADPCM_EA_XAS,
327 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
328 AV_CODEC_ID_ADPCM_IMA_ISS,
329 AV_CODEC_ID_ADPCM_G722,
330 AV_CODEC_ID_ADPCM_IMA_APC,
333 AV_CODEC_ID_AMR_NB = 0x12000,
336 /* RealAudio codecs*/
337 AV_CODEC_ID_RA_144 = 0x13000,
340 /* various DPCM codecs */
341 AV_CODEC_ID_ROQ_DPCM = 0x14000,
342 AV_CODEC_ID_INTERPLAY_DPCM,
343 AV_CODEC_ID_XAN_DPCM,
344 AV_CODEC_ID_SOL_DPCM,
347 AV_CODEC_ID_MP2 = 0x15000,
348 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
358 AV_CODEC_ID_VMDAUDIO,
364 AV_CODEC_ID_WESTWOOD_SND1,
365 AV_CODEC_ID_GSM, ///< as in Berlin toast format
368 AV_CODEC_ID_TRUESPEECH,
370 AV_CODEC_ID_SMACKAUDIO,
373 AV_CODEC_ID_DSICINAUDIO,
375 AV_CODEC_ID_MUSEPACK7,
377 AV_CODEC_ID_GSM_MS, /* as found in WAV */
381 AV_CODEC_ID_NELLYMOSER,
382 AV_CODEC_ID_MUSEPACK8,
384 AV_CODEC_ID_WMAVOICE,
386 AV_CODEC_ID_WMALOSSLESS,
395 AV_CODEC_ID_BINKAUDIO_RDFT,
396 AV_CODEC_ID_BINKAUDIO_DCT,
397 AV_CODEC_ID_AAC_LATM,
402 AV_CODEC_ID_8SVX_EXP,
403 AV_CODEC_ID_8SVX_FIB,
404 AV_CODEC_ID_BMV_AUDIO,
409 AV_CODEC_ID_COMFORT_NOISE,
411 /* subtitle codecs */
412 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
413 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
414 AV_CODEC_ID_DVB_SUBTITLE,
415 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
418 AV_CODEC_ID_MOV_TEXT,
419 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
420 AV_CODEC_ID_DVB_TELETEXT,
423 /* other specific kind of codecs (generally used for attachments) */
424 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
425 AV_CODEC_ID_TTF = 0x18000,
427 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
429 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
430 * stream (only used by libavformat) */
431 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
432 * stream (only used by libavformat) */
433 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
436 #include "old_codec_ids.h"
441 #define CodecID AVCodecID
445 * This struct describes the properties of a single codec described by an
447 * @see avcodec_get_descriptor()
449 typedef struct AVCodecDescriptor {
451 enum AVMediaType type;
453 * Name of the codec described by this descriptor. It is non-empty and
454 * unique for each codec descriptor. It should contain alphanumeric
455 * characters and '_' only.
459 * A more descriptive name for this codec. May be NULL.
461 const char *long_name;
463 * Codec properties, a combination of AV_CODEC_PROP_* flags.
469 * Codec uses only intra compression.
472 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
474 * Codec supports lossy compression. Audio and video codecs only.
475 * @note a codec may support both lossy and lossless
478 #define AV_CODEC_PROP_LOSSY (1 << 1)
480 * Codec supports lossless compression. Audio and video codecs only.
482 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
484 #if FF_API_OLD_DECODE_AUDIO
486 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
490 * @ingroup lavc_decoding
491 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
492 * This is mainly needed because some optimized bitstream readers read
493 * 32 or 64 bit at once and could read over the end.<br>
494 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
495 * MPEG bitstreams could cause overread and segfault.
497 #define FF_INPUT_BUFFER_PADDING_SIZE 8
500 * @ingroup lavc_encoding
501 * minimum encoding buffer size
502 * Used to avoid some checks during header writing.
504 #define FF_MIN_BUFFER_SIZE 16384
508 * @ingroup lavc_encoding
509 * motion estimation type.
512 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
516 ME_EPZS, ///< enhanced predictive zonal search
517 ME_X1, ///< reserved for experiments
518 ME_HEX, ///< hexagon based search
519 ME_UMH, ///< uneven multi-hexagon search
520 ME_ITER, ///< iterative search
521 ME_TESA, ///< transformed exhaustive search algorithm
525 * @ingroup lavc_decoding
528 /* We leave some space between them for extensions (drop some
529 * keyframes for intra-only or drop just some bidir frames). */
530 AVDISCARD_NONE =-16, ///< discard nothing
531 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
532 AVDISCARD_NONREF = 8, ///< discard all non reference
533 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
534 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
535 AVDISCARD_ALL = 48, ///< discard all
538 enum AVColorPrimaries{
539 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
540 AVCOL_PRI_UNSPECIFIED = 2,
541 AVCOL_PRI_BT470M = 4,
542 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
543 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
544 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
546 AVCOL_PRI_NB , ///< Not part of ABI
549 enum AVColorTransferCharacteristic{
550 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
551 AVCOL_TRC_UNSPECIFIED = 2,
552 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
553 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
554 AVCOL_TRC_SMPTE240M = 7,
555 AVCOL_TRC_NB , ///< Not part of ABI
560 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
561 AVCOL_SPC_UNSPECIFIED = 2,
563 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
564 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
565 AVCOL_SPC_SMPTE240M = 7,
566 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
567 AVCOL_SPC_NB , ///< Not part of ABI
571 AVCOL_RANGE_UNSPECIFIED = 0,
572 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
573 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
574 AVCOL_RANGE_NB , ///< Not part of ABI
578 * X X 3 4 X X are luma samples,
579 * 1 2 1-6 are possible chroma positions
580 * X X 5 6 X 0 is undefined/unknown position
582 enum AVChromaLocation{
583 AVCHROMA_LOC_UNSPECIFIED = 0,
584 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
585 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
586 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
587 AVCHROMA_LOC_TOP = 4,
588 AVCHROMA_LOC_BOTTOMLEFT = 5,
589 AVCHROMA_LOC_BOTTOM = 6,
590 AVCHROMA_LOC_NB , ///< Not part of ABI
593 enum AVAudioServiceType {
594 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
595 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
596 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
597 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
598 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
599 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
600 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
601 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
602 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
603 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
607 * @ingroup lavc_encoding
609 typedef struct RcOverride{
612 int qscale; // If this is 0 then quality_factor will be used instead.
613 float quality_factor;
616 #define FF_MAX_B_FRAMES 16
619 These flags can be passed in AVCodecContext.flags before initialization.
620 Note: Not everything is supported yet.
623 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
624 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
625 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
626 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
627 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
629 * The parent program guarantees that the input for B-frames containing
630 * streams is not written to for at least s->max_b_frames+1 frames, if
631 * this is not set the input will be copied.
633 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
634 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
635 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
636 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
637 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
638 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
639 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
640 location instead of only at frame boundaries. */
641 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
642 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
643 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
644 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
645 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
646 /* Fx : Flag for h263+ extra options */
647 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
648 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
649 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
650 #define CODEC_FLAG_CLOSED_GOP 0x80000000
651 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
652 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
653 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
654 #if FF_API_MPV_GLOBAL_OPTS
655 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
656 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
657 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
658 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
660 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
662 /* Unsupported options :
663 * Syntax Arithmetic coding (SAC)
664 * Reference Picture Selection
665 * Independent Segment Decoding */
667 /* codec capabilities */
669 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
671 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
672 * If not set, it might not use get_buffer() at all or use operations that
673 * assume the buffer was allocated by avcodec_default_get_buffer.
675 #define CODEC_CAP_DR1 0x0002
676 #define CODEC_CAP_TRUNCATED 0x0008
677 /* Codec can export data for HW decoding (XvMC). */
678 #define CODEC_CAP_HWACCEL 0x0010
680 * Encoder or decoder requires flushing with NULL input at the end in order to
681 * give the complete and correct output.
683 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
684 * with NULL data. The user can still send NULL data to the public encode
685 * or decode function, but libavcodec will not pass it along to the codec
686 * unless this flag is set.
689 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
690 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
694 * The encoder needs to be fed with NULL data at the end of encoding until the
695 * encoder no longer returns data.
697 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
698 * flag also means that the encoder must set the pts and duration for
699 * each output packet. If this flag is not set, the pts and duration will
700 * be determined by libavcodec from the input frame.
702 #define CODEC_CAP_DELAY 0x0020
704 * Codec can be fed a final frame with a smaller size.
705 * This can be used to prevent truncation of the last audio samples.
707 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
709 * Codec can export data for HW decoding (VDPAU).
711 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
713 * Codec can output multiple frames per AVPacket
714 * Normally demuxers return one frame at a time, demuxers which do not do
715 * are connected to a parser to split what they return into proper frames.
716 * This flag is reserved to the very rare category of codecs which have a
717 * bitstream that cannot be split into frames without timeconsuming
718 * operations like full decoding. Demuxers carring such bitstreams thus
719 * may return multiple frames in a packet. This has many disadvantages like
720 * prohibiting stream copy in many cases thus it should only be considered
723 #define CODEC_CAP_SUBFRAMES 0x0100
725 * Codec is experimental and is thus avoided in favor of non experimental
728 #define CODEC_CAP_EXPERIMENTAL 0x0200
730 * Codec should fill in channel configuration and samplerate instead of container
732 #define CODEC_CAP_CHANNEL_CONF 0x0400
734 * Codec is able to deal with negative linesizes
736 #define CODEC_CAP_NEG_LINESIZES 0x0800
738 * Codec supports frame-level multithreading.
740 #define CODEC_CAP_FRAME_THREADS 0x1000
742 * Codec supports slice-based (or partition-based) multithreading.
744 #define CODEC_CAP_SLICE_THREADS 0x2000
746 * Codec supports changed parameters at any point.
748 #define CODEC_CAP_PARAM_CHANGE 0x4000
750 * Codec supports avctx->thread_count == 0 (auto).
752 #define CODEC_CAP_AUTO_THREADS 0x8000
754 * Audio encoder supports receiving a different number of samples in each call.
756 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
758 //The following defines may change, don't expect compatibility if you use them.
759 #define MB_TYPE_INTRA4x4 0x0001
760 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
761 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
762 #define MB_TYPE_16x16 0x0008
763 #define MB_TYPE_16x8 0x0010
764 #define MB_TYPE_8x16 0x0020
765 #define MB_TYPE_8x8 0x0040
766 #define MB_TYPE_INTERLACED 0x0080
767 #define MB_TYPE_DIRECT2 0x0100 //FIXME
768 #define MB_TYPE_ACPRED 0x0200
769 #define MB_TYPE_GMC 0x0400
770 #define MB_TYPE_SKIP 0x0800
771 #define MB_TYPE_P0L0 0x1000
772 #define MB_TYPE_P1L0 0x2000
773 #define MB_TYPE_P0L1 0x4000
774 #define MB_TYPE_P1L1 0x8000
775 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
776 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
777 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
778 #define MB_TYPE_QUANT 0x00010000
779 #define MB_TYPE_CBP 0x00020000
780 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
784 * This specifies the area which should be displayed.
785 * Note there may be multiple such areas for one frame.
787 typedef struct AVPanScan{
790 * - encoding: Set by user.
791 * - decoding: Set by libavcodec.
796 * width and height in 1/16 pel
797 * - encoding: Set by user.
798 * - decoding: Set by libavcodec.
804 * position of the top left corner in 1/16 pel for up to 3 fields/frames
805 * - encoding: Set by user.
806 * - decoding: Set by libavcodec.
808 int16_t position[3][2];
811 #define FF_QSCALE_TYPE_MPEG1 0
812 #define FF_QSCALE_TYPE_MPEG2 1
813 #define FF_QSCALE_TYPE_H264 2
814 #define FF_QSCALE_TYPE_VP56 3
816 #define FF_BUFFER_TYPE_INTERNAL 1
817 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
818 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
819 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
821 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
822 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
823 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
824 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
827 * @defgroup lavc_packet AVPacket
829 * Types and functions for working with AVPacket.
832 enum AVPacketSideDataType {
834 AV_PKT_DATA_NEW_EXTRADATA,
837 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
840 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
841 * s32le channel_count
842 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
843 * u64le channel_layout
844 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
846 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
851 AV_PKT_DATA_PARAM_CHANGE,
854 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
855 * structures with info about macroblocks relevant to splitting the
856 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
857 * That is, it does not necessarily contain info about all macroblocks,
858 * as long as the distance between macroblocks in the info is smaller
859 * than the target payload size.
860 * Each MB info structure is 12 bytes, and is laid out as follows:
862 * u32le bit offset from the start of the packet
863 * u8 current quantizer at the start of the macroblock
865 * u16le macroblock address within the GOB
866 * u8 horizontal MV predictor
867 * u8 vertical MV predictor
868 * u8 horizontal MV predictor for block number 3
869 * u8 vertical MV predictor for block number 3
872 AV_PKT_DATA_H263_MB_INFO,
876 * This structure stores compressed data. It is typically exported by demuxers
877 * and then passed as input to decoders, or received as output from encoders and
878 * then passed to muxers.
880 * For video, it should typically contain one compressed frame. For audio it may
881 * contain several compressed frames.
883 * AVPacket is one of the few structs in Libav, whose size is a part of public
884 * ABI. Thus it may be allocated on stack and no new fields can be added to it
885 * without libavcodec and libavformat major bump.
887 * The semantics of data ownership depends on the destruct field.
888 * If it is set, the packet data is dynamically allocated and is valid
889 * indefinitely until av_free_packet() is called (which in turn calls the
890 * destruct callback to free the data). If destruct is not set, the packet data
891 * is typically backed by some static buffer somewhere and is only valid for a
892 * limited time (e.g. until the next read call when demuxing).
894 * The side data is always allocated with av_malloc() and is freed in
897 typedef struct AVPacket {
899 * Presentation timestamp in AVStream->time_base units; the time at which
900 * the decompressed packet will be presented to the user.
901 * Can be AV_NOPTS_VALUE if it is not stored in the file.
902 * pts MUST be larger or equal to dts as presentation cannot happen before
903 * decompression, unless one wants to view hex dumps. Some formats misuse
904 * the terms dts and pts/cts to mean something different. Such timestamps
905 * must be converted to true pts/dts before they are stored in AVPacket.
909 * Decompression timestamp in AVStream->time_base units; the time at which
910 * the packet is decompressed.
911 * Can be AV_NOPTS_VALUE if it is not stored in the file.
918 * A combination of AV_PKT_FLAG values
922 * Additional packet data that can be provided by the container.
923 * Packet can contain several types of side information.
928 enum AVPacketSideDataType type;
933 * Duration of this packet in AVStream->time_base units, 0 if unknown.
934 * Equals next_pts - this_pts in presentation order.
937 void (*destruct)(struct AVPacket *);
939 int64_t pos; ///< byte position in stream, -1 if unknown
942 * Time difference in AVStream->time_base units from the pts of this
943 * packet to the point at which the output from the decoder has converged
944 * independent from the availability of previous frames. That is, the
945 * frames are virtually identical no matter if decoding started from
946 * the very first frame or from this keyframe.
947 * Is AV_NOPTS_VALUE if unknown.
948 * This field is not the display duration of the current packet.
949 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
952 * The purpose of this field is to allow seeking in streams that have no
953 * keyframes in the conventional sense. It corresponds to the
954 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
955 * essential for some types of subtitle streams to ensure that all
956 * subtitles are correctly displayed after seeking.
958 int64_t convergence_duration;
960 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
961 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
963 enum AVSideDataParamChangeFlags {
964 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
965 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
966 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
967 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
975 * New fields can be added to the end of AVFRAME with minor version
976 * bumps. Removal, reordering and changes to existing fields require
977 * a major version bump.
978 * sizeof(AVFrame) must not be used outside libav*.
980 typedef struct AVFrame {
981 #define AV_NUM_DATA_POINTERS 8
983 * pointer to the picture/channel planes.
984 * This might be different from the first allocated byte
985 * - encoding: Set by user
986 * - decoding: set by AVCodecContext.get_buffer()
988 uint8_t *data[AV_NUM_DATA_POINTERS];
991 * Size, in bytes, of the data for each picture/channel plane.
993 * For audio, only linesize[0] may be set. For planar audio, each channel
994 * plane must be the same size.
996 * - encoding: Set by user
997 * - decoding: set by AVCodecContext.get_buffer()
999 int linesize[AV_NUM_DATA_POINTERS];
1002 * pointers to the data planes/channels.
1004 * For video, this should simply point to data[].
1006 * For planar audio, each channel has a separate data pointer, and
1007 * linesize[0] contains the size of each channel buffer.
1008 * For packed audio, there is just one data pointer, and linesize[0]
1009 * contains the total size of the buffer for all channels.
1011 * Note: Both data and extended_data will always be set by get_buffer(),
1012 * but for planar audio with more channels that can fit in data,
1013 * extended_data must be used by the decoder in order to access all
1016 * encoding: set by user
1017 * decoding: set by AVCodecContext.get_buffer()
1019 uint8_t **extended_data;
1022 * width and height of the video frame
1023 * - encoding: unused
1024 * - decoding: Read by user.
1029 * number of audio samples (per channel) described by this frame
1030 * - encoding: Set by user
1031 * - decoding: Set by libavcodec
1036 * format of the frame, -1 if unknown or unset
1037 * Values correspond to enum AVPixelFormat for video frames,
1038 * enum AVSampleFormat for audio)
1039 * - encoding: unused
1040 * - decoding: Read by user.
1045 * 1 -> keyframe, 0-> not
1046 * - encoding: Set by libavcodec.
1047 * - decoding: Set by libavcodec.
1052 * Picture type of the frame, see ?_TYPE below.
1053 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1054 * - decoding: Set by libavcodec.
1056 enum AVPictureType pict_type;
1059 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1060 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1064 uint8_t *base[AV_NUM_DATA_POINTERS];
1067 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1068 * - encoding: unused
1069 * - decoding: Read by user.
1071 AVRational sample_aspect_ratio;
1074 * presentation timestamp in time_base units (time when frame should be shown to user)
1075 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1076 * - encoding: MUST be set by user.
1077 * - decoding: Set by libavcodec.
1082 * reordered pts from the last AVPacket that has been input into the decoder
1083 * - encoding: unused
1084 * - decoding: Read by user.
1089 * dts from the last AVPacket that has been input into the decoder
1090 * - encoding: unused
1091 * - decoding: Read by user.
1096 * picture number in bitstream order
1097 * - encoding: set by
1098 * - decoding: Set by libavcodec.
1100 int coded_picture_number;
1102 * picture number in display order
1103 * - encoding: set by
1104 * - decoding: Set by libavcodec.
1106 int display_picture_number;
1109 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1110 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1111 * - decoding: Set by libavcodec.
1116 * is this picture used as reference
1117 * The values for this are the same as the MpegEncContext.picture_structure
1118 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1119 * Set to 4 for delayed, non-reference frames.
1120 * - encoding: unused
1121 * - decoding: Set by libavcodec. (before get_buffer() call)).
1127 * - encoding: unused
1128 * - decoding: Set by libavcodec.
1130 int8_t *qscale_table;
1133 * - encoding: unused
1134 * - decoding: Set by libavcodec.
1144 * mbskip_table[mb]>=1 if MB didn't change
1145 * stride= mb_width = (width+15)>>4
1146 * - encoding: unused
1147 * - decoding: Set by libavcodec.
1149 uint8_t *mbskip_table;
1152 * motion vector table
1155 * int mv_sample_log2= 4 - motion_subsample_log2;
1156 * int mb_width= (width+15)>>4;
1157 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1158 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1160 * - encoding: Set by user.
1161 * - decoding: Set by libavcodec.
1163 int16_t (*motion_val[2])[2];
1166 * macroblock type table
1167 * mb_type_base + mb_width + 2
1168 * - encoding: Set by user.
1169 * - decoding: Set by libavcodec.
1175 * - encoding: unused
1176 * - decoding: Set by libavcodec.
1181 * motion reference frame index
1182 * the order in which these are stored can depend on the codec.
1183 * - encoding: Set by user.
1184 * - decoding: Set by libavcodec.
1186 int8_t *ref_index[2];
1189 * for some private data of the user
1190 * - encoding: unused
1191 * - decoding: Set by user.
1197 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1198 * - decoding: unused
1200 uint64_t error[AV_NUM_DATA_POINTERS];
1203 * type of the buffer (to keep track of who has to deallocate data[*])
1204 * - encoding: Set by the one who allocates it.
1205 * - decoding: Set by the one who allocates it.
1206 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1211 * When decoding, this signals how much the picture must be delayed.
1212 * extra_delay = repeat_pict / (2*fps)
1213 * - encoding: unused
1214 * - decoding: Set by libavcodec.
1219 * The content of the picture is interlaced.
1220 * - encoding: Set by user.
1221 * - decoding: Set by libavcodec. (default 0)
1223 int interlaced_frame;
1226 * If the content is interlaced, is top field displayed first.
1227 * - encoding: Set by user.
1228 * - decoding: Set by libavcodec.
1230 int top_field_first;
1233 * Tell user application that palette has changed from previous frame.
1234 * - encoding: ??? (no palette-enabled encoder yet)
1235 * - decoding: Set by libavcodec. (default 0).
1237 int palette_has_changed;
1240 * codec suggestion on buffer type if != 0
1241 * - encoding: unused
1242 * - decoding: Set by libavcodec. (before get_buffer() call)).
1248 * - encoding: Set by user.
1249 * - decoding: Set by libavcodec.
1251 AVPanScan *pan_scan;
1254 * reordered opaque 64bit (generally an integer or a double precision float
1255 * PTS but can be anything).
1256 * The user sets AVCodecContext.reordered_opaque to represent the input at
1258 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1259 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1260 * @deprecated in favor of pkt_pts
1261 * - encoding: unused
1262 * - decoding: Read by user.
1264 int64_t reordered_opaque;
1267 * hardware accelerator private data (Libav-allocated)
1268 * - encoding: unused
1269 * - decoding: Set by libavcodec
1271 void *hwaccel_picture_private;
1274 * the AVCodecContext which ff_thread_get_buffer() was last called on
1275 * - encoding: Set by libavcodec.
1276 * - decoding: Set by libavcodec.
1278 struct AVCodecContext *owner;
1281 * used by multithreading to store frame-specific info
1282 * - encoding: Set by libavcodec.
1283 * - decoding: Set by libavcodec.
1285 void *thread_opaque;
1288 * log2 of the size of the block which a single vector in motion_val represents:
1289 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1290 * - encoding: unused
1291 * - decoding: Set by libavcodec.
1293 uint8_t motion_subsample_log2;
1296 * Sample rate of the audio data.
1298 * - encoding: unused
1299 * - decoding: set by get_buffer()
1304 * Channel layout of the audio data.
1306 * - encoding: unused
1307 * - decoding: set by get_buffer()
1309 uint64_t channel_layout;
1312 struct AVCodecInternal;
1316 AV_FIELD_PROGRESSIVE,
1317 AV_FIELD_TT, //< Top coded_first, top displayed first
1318 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1319 AV_FIELD_TB, //< Top coded first, bottom displayed first
1320 AV_FIELD_BT, //< Bottom coded first, top displayed first
1324 * main external API structure.
1325 * New fields can be added to the end with minor version bumps.
1326 * Removal, reordering and changes to existing fields require a major
1328 * sizeof(AVCodecContext) must not be used outside libav*.
1330 typedef struct AVCodecContext {
1332 * information on struct for av_log
1333 * - set by avcodec_alloc_context3
1335 const AVClass *av_class;
1336 int log_level_offset;
1338 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1339 const struct AVCodec *codec;
1340 char codec_name[32];
1341 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1344 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1345 * This is used to work around some encoder bugs.
1346 * A demuxer should set this to what is stored in the field used to identify the codec.
1347 * If there are multiple such fields in a container then the demuxer should choose the one
1348 * which maximizes the information about the used codec.
1349 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1350 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1351 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1353 * - encoding: Set by user, if not then the default based on codec_id will be used.
1354 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1356 unsigned int codec_tag;
1359 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1360 * This is used to work around some encoder bugs.
1361 * - encoding: unused
1362 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1364 unsigned int stream_codec_tag;
1368 * @deprecated this field is unused
1370 attribute_deprecated int sub_id;
1376 * Private context used for internal data.
1378 * Unlike priv_data, this is not codec-specific. It is used in general
1379 * libavcodec functions.
1381 struct AVCodecInternal *internal;
1384 * Private data of the user, can be used to carry app specific stuff.
1385 * - encoding: Set by user.
1386 * - decoding: Set by user.
1391 * the average bitrate
1392 * - encoding: Set by user; unused for constant quantizer encoding.
1393 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1398 * number of bits the bitstream is allowed to diverge from the reference.
1399 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1400 * - encoding: Set by user; unused for constant quantizer encoding.
1401 * - decoding: unused
1403 int bit_rate_tolerance;
1406 * Global quality for codecs which cannot change it per frame.
1407 * This should be proportional to MPEG-1/2/4 qscale.
1408 * - encoding: Set by user.
1409 * - decoding: unused
1414 * - encoding: Set by user.
1415 * - decoding: unused
1417 int compression_level;
1418 #define FF_COMPRESSION_DEFAULT -1
1422 * - encoding: Set by user.
1423 * - decoding: Set by user.
1429 * - encoding: Set by user.
1430 * - decoding: Set by user.
1435 * some codecs need / can use extradata like Huffman tables.
1436 * mjpeg: Huffman tables
1437 * rv10: additional flags
1438 * mpeg4: global headers (they can be in the bitstream or here)
1439 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1440 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1441 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1442 * - encoding: Set/allocated/freed by libavcodec.
1443 * - decoding: Set/allocated/freed by user.
1449 * This is the fundamental unit of time (in seconds) in terms
1450 * of which frame timestamps are represented. For fixed-fps content,
1451 * timebase should be 1/framerate and timestamp increments should be
1453 * - encoding: MUST be set by user.
1454 * - decoding: Set by libavcodec.
1456 AVRational time_base;
1459 * For some codecs, the time base is closer to the field rate than the frame rate.
1460 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1461 * if no telecine is used ...
1463 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1465 int ticks_per_frame;
1471 * Number of frames the decoded output will be delayed relative to the
1475 * For encoding, this is the number of "priming" samples added to the
1476 * beginning of the stream. The decoded output will be delayed by this
1477 * many samples relative to the input to the encoder. Note that this
1478 * field is purely informational and does not directly affect the pts
1479 * output by the encoder, which should always be based on the actual
1480 * presentation time, including any delay.
1481 * For decoding, this is the number of samples the decoder needs to
1482 * output before the decoder's output is valid. When seeking, you should
1483 * start decoding this many samples prior to your desired seek point.
1485 * - encoding: Set by libavcodec.
1486 * - decoding: Set by libavcodec.
1493 * picture width / height.
1494 * - encoding: MUST be set by user.
1495 * - decoding: Set by libavcodec.
1496 * Note: For compatibility it is possible to set this instead of
1497 * coded_width/height before decoding.
1502 * Bitstream width / height, may be different from width/height.
1503 * - encoding: unused
1504 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1506 int coded_width, coded_height;
1508 #define FF_ASPECT_EXTENDED 15
1511 * the number of pictures in a group of pictures, or 0 for intra_only
1512 * - encoding: Set by user.
1513 * - decoding: unused
1518 * Pixel format, see AV_PIX_FMT_xxx.
1519 * May be set by the demuxer if known from headers.
1520 * May be overriden by the decoder if it knows better.
1521 * - encoding: Set by user.
1522 * - decoding: Set by user if known, overridden by libavcodec if known
1524 enum AVPixelFormat pix_fmt;
1527 * Motion estimation algorithm used for video coding.
1528 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1529 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1530 * - encoding: MUST be set by user.
1531 * - decoding: unused
1536 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1537 * decoder to draw a horizontal band. It improves cache usage. Not
1538 * all codecs can do that. You must check the codec capabilities
1540 * When multithreading is used, it may be called from multiple threads
1541 * at the same time; threads might draw different parts of the same AVFrame,
1542 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1544 * The function is also used by hardware acceleration APIs.
1545 * It is called at least once during frame decoding to pass
1546 * the data needed for hardware render.
1547 * In that mode instead of pixel data, AVFrame points to
1548 * a structure specific to the acceleration API. The application
1549 * reads the structure and can change some fields to indicate progress
1551 * - encoding: unused
1552 * - decoding: Set by user.
1553 * @param height the height of the slice
1554 * @param y the y position of the slice
1555 * @param type 1->top field, 2->bottom field, 3->frame
1556 * @param offset offset into the AVFrame.data from which the slice should be read
1558 void (*draw_horiz_band)(struct AVCodecContext *s,
1559 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1560 int y, int type, int height);
1563 * callback to negotiate the pixelFormat
1564 * @param fmt is the list of formats which are supported by the codec,
1565 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1566 * The first is always the native one.
1567 * @return the chosen format
1568 * - encoding: unused
1569 * - decoding: Set by user, if not set the native format will be chosen.
1571 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1574 * maximum number of B-frames between non-B-frames
1575 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1576 * - encoding: Set by user.
1577 * - decoding: unused
1582 * qscale factor between IP and B-frames
1583 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1584 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1585 * - encoding: Set by user.
1586 * - decoding: unused
1588 float b_quant_factor;
1590 /** obsolete FIXME remove */
1592 #define FF_RC_STRATEGY_XVID 1
1594 int b_frame_strategy;
1596 #if FF_API_MPV_GLOBAL_OPTS
1598 * luma single coefficient elimination threshold
1599 * - encoding: Set by user.
1600 * - decoding: unused
1602 attribute_deprecated int luma_elim_threshold;
1605 * chroma single coeff elimination threshold
1606 * - encoding: Set by user.
1607 * - decoding: unused
1609 attribute_deprecated int chroma_elim_threshold;
1613 * qscale offset between IP and B-frames
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 float b_quant_offset;
1620 * Size of the frame reordering buffer in the decoder.
1621 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1622 * - encoding: Set by libavcodec.
1623 * - decoding: Set by libavcodec.
1628 * 0-> h263 quant 1-> mpeg quant
1629 * - encoding: Set by user.
1630 * - decoding: unused
1635 * qscale factor between P and I-frames
1636 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1637 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1638 * - encoding: Set by user.
1639 * - decoding: unused
1641 float i_quant_factor;
1644 * qscale offset between P and I-frames
1645 * - encoding: Set by user.
1646 * - decoding: unused
1648 float i_quant_offset;
1651 * luminance masking (0-> disabled)
1652 * - encoding: Set by user.
1653 * - decoding: unused
1658 * temporary complexity masking (0-> disabled)
1659 * - encoding: Set by user.
1660 * - decoding: unused
1662 float temporal_cplx_masking;
1665 * spatial complexity masking (0-> disabled)
1666 * - encoding: Set by user.
1667 * - decoding: unused
1669 float spatial_cplx_masking;
1672 * p block masking (0-> disabled)
1673 * - encoding: Set by user.
1674 * - decoding: unused
1679 * darkness masking (0-> disabled)
1680 * - encoding: Set by user.
1681 * - decoding: unused
1687 * - encoding: Set by libavcodec.
1688 * - decoding: Set by user (or 0).
1692 * prediction method (needed for huffyuv)
1693 * - encoding: Set by user.
1694 * - decoding: unused
1696 int prediction_method;
1697 #define FF_PRED_LEFT 0
1698 #define FF_PRED_PLANE 1
1699 #define FF_PRED_MEDIAN 2
1702 * slice offsets in the frame in bytes
1703 * - encoding: Set/allocated by libavcodec.
1704 * - decoding: Set/allocated by user (or NULL).
1709 * sample aspect ratio (0 if unknown)
1710 * That is the width of a pixel divided by the height of the pixel.
1711 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1712 * - encoding: Set by user.
1713 * - decoding: Set by libavcodec.
1715 AVRational sample_aspect_ratio;
1718 * motion estimation comparison function
1719 * - encoding: Set by user.
1720 * - decoding: unused
1724 * subpixel motion estimation comparison function
1725 * - encoding: Set by user.
1726 * - decoding: unused
1730 * macroblock comparison function (not supported yet)
1731 * - encoding: Set by user.
1732 * - decoding: unused
1736 * interlaced DCT comparison function
1737 * - encoding: Set by user.
1738 * - decoding: unused
1741 #define FF_CMP_SAD 0
1742 #define FF_CMP_SSE 1
1743 #define FF_CMP_SATD 2
1744 #define FF_CMP_DCT 3
1745 #define FF_CMP_PSNR 4
1746 #define FF_CMP_BIT 5
1748 #define FF_CMP_ZERO 7
1749 #define FF_CMP_VSAD 8
1750 #define FF_CMP_VSSE 9
1751 #define FF_CMP_NSSE 10
1752 #define FF_CMP_W53 11
1753 #define FF_CMP_W97 12
1754 #define FF_CMP_DCTMAX 13
1755 #define FF_CMP_DCT264 14
1756 #define FF_CMP_CHROMA 256
1759 * ME diamond size & shape
1760 * - encoding: Set by user.
1761 * - decoding: unused
1766 * amount of previous MV predictors (2a+1 x 2a+1 square)
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 int last_predictor_count;
1773 * prepass for motion estimation
1774 * - encoding: Set by user.
1775 * - decoding: unused
1780 * motion estimation prepass comparison function
1781 * - encoding: Set by user.
1782 * - decoding: unused
1787 * ME prepass diamond size & shape
1788 * - encoding: Set by user.
1789 * - decoding: unused
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 int me_subpel_quality;
1801 * DTG active format information (additional aspect ratio
1802 * information only used in DVB MPEG-2 transport streams)
1805 * - encoding: unused
1806 * - decoding: Set by decoder.
1808 int dtg_active_format;
1809 #define FF_DTG_AFD_SAME 8
1810 #define FF_DTG_AFD_4_3 9
1811 #define FF_DTG_AFD_16_9 10
1812 #define FF_DTG_AFD_14_9 11
1813 #define FF_DTG_AFD_4_3_SP_14_9 13
1814 #define FF_DTG_AFD_16_9_SP_14_9 14
1815 #define FF_DTG_AFD_SP_4_3 15
1818 * maximum motion estimation search range in subpel units
1819 * If 0 then no limit.
1821 * - encoding: Set by user.
1822 * - decoding: unused
1827 * intra quantizer bias
1828 * - encoding: Set by user.
1829 * - decoding: unused
1831 int intra_quant_bias;
1832 #define FF_DEFAULT_QUANT_BIAS 999999
1835 * inter quantizer bias
1836 * - encoding: Set by user.
1837 * - decoding: unused
1839 int inter_quant_bias;
1841 #if FF_API_COLOR_TABLE_ID
1844 * - encoding: unused
1845 * - decoding: Which clrtable should be used for 8bit RGB images.
1846 * Tables have to be stored somewhere. FIXME
1848 attribute_deprecated int color_table_id;
1853 * - encoding: unused
1854 * - decoding: Set by user.
1857 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1858 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1859 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1862 * XVideo Motion Acceleration
1863 * - encoding: forbidden
1864 * - decoding: set by decoder
1866 int xvmc_acceleration;
1869 * macroblock decision mode
1870 * - encoding: Set by user.
1871 * - decoding: unused
1874 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1875 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1876 #define FF_MB_DECISION_RD 2 ///< rate distortion
1879 * custom intra quantization matrix
1880 * - encoding: Set by user, can be NULL.
1881 * - decoding: Set by libavcodec.
1883 uint16_t *intra_matrix;
1886 * custom inter quantization matrix
1887 * - encoding: Set by user, can be NULL.
1888 * - decoding: Set by libavcodec.
1890 uint16_t *inter_matrix;
1893 * scene change detection threshold
1894 * 0 is default, larger means fewer detected scene changes.
1895 * - encoding: Set by user.
1896 * - decoding: unused
1898 int scenechange_threshold;
1901 * noise reduction strength
1902 * - encoding: Set by user.
1903 * - decoding: unused
1905 int noise_reduction;
1907 #if FF_API_INTER_THRESHOLD
1909 * @deprecated this field is unused
1911 attribute_deprecated int inter_threshold;
1914 #if FF_API_MPV_GLOBAL_OPTS
1916 * @deprecated use mpegvideo private options instead
1918 attribute_deprecated int quantizer_noise_shaping;
1922 * Motion estimation threshold below which no motion estimation is
1923 * performed, but instead the user specified motion vectors are used.
1925 * - encoding: Set by user.
1926 * - decoding: unused
1931 * Macroblock threshold below which the user specified macroblock types will be used.
1932 * - encoding: Set by user.
1933 * - decoding: unused
1938 * precision of the intra DC coefficient - 8
1939 * - encoding: Set by user.
1940 * - decoding: unused
1942 int intra_dc_precision;
1945 * Number of macroblock rows at the top which are skipped.
1946 * - encoding: unused
1947 * - decoding: Set by user.
1952 * Number of macroblock rows at the bottom which are skipped.
1953 * - encoding: unused
1954 * - decoding: Set by user.
1959 * Border processing masking, raises the quantizer for mbs on the borders
1961 * - encoding: Set by user.
1962 * - decoding: unused
1964 float border_masking;
1967 * minimum MB lagrange multipler
1968 * - encoding: Set by user.
1969 * - decoding: unused
1974 * maximum MB lagrange multipler
1975 * - encoding: Set by user.
1976 * - decoding: unused
1982 * - encoding: Set by user.
1983 * - decoding: unused
1985 int me_penalty_compensation;
1989 * - encoding: Set by user.
1990 * - decoding: unused
1996 * - encoding: Set by user.
1997 * - decoding: unused
2003 * - encoding: Set by user.
2004 * - decoding: unused
2009 * number of reference frames
2010 * - encoding: Set by user.
2011 * - decoding: Set by lavc.
2016 * chroma qp offset from luma
2017 * - encoding: Set by user.
2018 * - decoding: unused
2023 * Multiplied by qscale for each frame and added to scene_change_score.
2024 * - encoding: Set by user.
2025 * - decoding: unused
2027 int scenechange_factor;
2031 * Note: Value depends upon the compare function used for fullpel ME.
2032 * - encoding: Set by user.
2033 * - decoding: unused
2038 * Adjust sensitivity of b_frame_strategy 1.
2039 * - encoding: Set by user.
2040 * - decoding: unused
2045 * Chromaticity coordinates of the source primaries.
2046 * - encoding: Set by user
2047 * - decoding: Set by libavcodec
2049 enum AVColorPrimaries color_primaries;
2052 * Color Transfer Characteristic.
2053 * - encoding: Set by user
2054 * - decoding: Set by libavcodec
2056 enum AVColorTransferCharacteristic color_trc;
2059 * YUV colorspace type.
2060 * - encoding: Set by user
2061 * - decoding: Set by libavcodec
2063 enum AVColorSpace colorspace;
2066 * MPEG vs JPEG YUV range.
2067 * - encoding: Set by user
2068 * - decoding: Set by libavcodec
2070 enum AVColorRange color_range;
2073 * This defines the location of chroma samples.
2074 * - encoding: Set by user
2075 * - decoding: Set by libavcodec
2077 enum AVChromaLocation chroma_sample_location;
2081 * Indicates number of picture subdivisions. Used for parallelized
2083 * - encoding: Set by user
2084 * - decoding: unused
2089 * - encoding: set by libavcodec
2090 * - decoding: Set by libavcodec
2092 enum AVFieldOrder field_order;
2095 int sample_rate; ///< samples per second
2096 int channels; ///< number of audio channels
2099 * audio sample format
2100 * - encoding: Set by user.
2101 * - decoding: Set by libavcodec.
2103 enum AVSampleFormat sample_fmt; ///< sample format
2105 /* The following data should not be initialized. */
2107 * Number of samples per channel in an audio frame.
2109 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2110 * except the last must contain exactly frame_size samples per channel.
2111 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2112 * frame size is not restricted.
2113 * - decoding: may be set by some decoders to indicate constant frame size
2118 * Frame counter, set by libavcodec.
2120 * - decoding: total number of frames returned from the decoder so far.
2121 * - encoding: total number of frames passed to the encoder so far.
2123 * @note the counter is not incremented if encoding/decoding resulted in
2129 * number of bytes per packet if constant and known or 0
2130 * Used by some WAV based audio codecs.
2135 * Audio cutoff bandwidth (0 means "automatic")
2136 * - encoding: Set by user.
2137 * - decoding: unused
2141 #if FF_API_REQUEST_CHANNELS
2143 * Decoder should decode to this many channels if it can (0 for default)
2144 * - encoding: unused
2145 * - decoding: Set by user.
2146 * @deprecated Deprecated in favor of request_channel_layout.
2148 int request_channels;
2152 * Audio channel layout.
2153 * - encoding: set by user.
2154 * - decoding: set by libavcodec.
2156 uint64_t channel_layout;
2159 * Request decoder to use this channel layout if it can (0 for default)
2160 * - encoding: unused
2161 * - decoding: Set by user.
2163 uint64_t request_channel_layout;
2166 * Type of service that the audio stream conveys.
2167 * - encoding: Set by user.
2168 * - decoding: Set by libavcodec.
2170 enum AVAudioServiceType audio_service_type;
2173 * Used to request a sample format from the decoder.
2174 * - encoding: unused.
2175 * - decoding: Set by user.
2177 enum AVSampleFormat request_sample_fmt;
2180 * Called at the beginning of each frame to get a buffer for it.
2182 * The function will set AVFrame.data[], AVFrame.linesize[].
2183 * AVFrame.extended_data[] must also be set, but it should be the same as
2184 * AVFrame.data[] except for planar audio with more channels than can fit
2185 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2186 * many data pointers as it can hold.
2188 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2189 * avcodec_default_get_buffer() instead of providing buffers allocated by
2192 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2193 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2194 * but if get_buffer() is overridden then alignment considerations should
2195 * be taken into account.
2197 * @see avcodec_default_get_buffer()
2201 * If pic.reference is set then the frame will be read later by libavcodec.
2202 * avcodec_align_dimensions2() should be used to find the required width and
2203 * height, as they normally need to be rounded up to the next multiple of 16.
2205 * If frame multithreading is used and thread_safe_callbacks is set,
2206 * it may be called from a different thread, but not from more than one at
2207 * once. Does not need to be reentrant.
2209 * @see release_buffer(), reget_buffer()
2210 * @see avcodec_align_dimensions2()
2214 * Decoders request a buffer of a particular size by setting
2215 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2216 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2217 * to a smaller value in the output frame.
2219 * Decoders cannot use the buffer after returning from
2220 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2221 * is assumed to be released immediately upon return.
2223 * As a convenience, av_samples_get_buffer_size() and
2224 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2225 * functions to find the required data size and to fill data pointers and
2226 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2227 * since all planes must be the same size.
2229 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2231 * - encoding: unused
2232 * - decoding: Set by libavcodec, user can override.
2234 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2237 * Called to release buffers which were allocated with get_buffer.
2238 * A released buffer can be reused in get_buffer().
2239 * pic.data[*] must be set to NULL.
2240 * May be called from a different thread if frame multithreading is used,
2241 * but not by more than one thread at once, so does not need to be reentrant.
2242 * - encoding: unused
2243 * - decoding: Set by libavcodec, user can override.
2245 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2248 * Called at the beginning of a frame to get cr buffer for it.
2249 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2250 * libavcodec will pass previous buffer in pic, function should return
2251 * same buffer or new buffer with old frame "painted" into it.
2252 * If pic.data[0] == NULL must behave like get_buffer().
2253 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2254 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2256 * - encoding: unused
2257 * - decoding: Set by libavcodec, user can override.
2259 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2262 /* - encoding parameters */
2263 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2264 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2268 * - encoding: Set by user.
2269 * - decoding: unused
2275 * - encoding: Set by user.
2276 * - decoding: unused
2281 * maximum quantizer difference between frames
2282 * - encoding: Set by user.
2283 * - decoding: unused
2288 * ratecontrol qmin qmax limiting method
2289 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2290 * - encoding: Set by user.
2291 * - decoding: unused
2299 * decoder bitstream buffer size
2300 * - encoding: Set by user.
2301 * - decoding: unused
2306 * ratecontrol override, see RcOverride
2307 * - encoding: Allocated/set/freed by user.
2308 * - decoding: unused
2310 int rc_override_count;
2311 RcOverride *rc_override;
2314 * rate control equation
2315 * - encoding: Set by user
2316 * - decoding: unused
2322 * - encoding: Set by user.
2323 * - decoding: unused
2329 * - encoding: Set by user.
2330 * - decoding: unused
2334 float rc_buffer_aggressivity;
2337 * initial complexity for pass1 ratecontrol
2338 * - encoding: Set by user.
2339 * - decoding: unused
2341 float rc_initial_cplx;
2344 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2345 * - encoding: Set by user.
2346 * - decoding: unused.
2348 float rc_max_available_vbv_use;
2351 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2352 * - encoding: Set by user.
2353 * - decoding: unused.
2355 float rc_min_vbv_overflow_use;
2358 * Number of bits which should be loaded into the rc buffer before decoding starts.
2359 * - encoding: Set by user.
2360 * - decoding: unused
2362 int rc_initial_buffer_occupancy;
2364 #define FF_CODER_TYPE_VLC 0
2365 #define FF_CODER_TYPE_AC 1
2366 #define FF_CODER_TYPE_RAW 2
2367 #define FF_CODER_TYPE_RLE 3
2368 #define FF_CODER_TYPE_DEFLATE 4
2371 * - encoding: Set by user.
2372 * - decoding: unused
2378 * - encoding: Set by user.
2379 * - decoding: unused
2384 * minimum Lagrange multipler
2385 * - encoding: Set by user.
2386 * - decoding: unused
2391 * maximum Lagrange multipler
2392 * - encoding: Set by user.
2393 * - decoding: unused
2398 * frame skip threshold
2399 * - encoding: Set by user.
2400 * - decoding: unused
2402 int frame_skip_threshold;
2406 * - encoding: Set by user.
2407 * - decoding: unused
2409 int frame_skip_factor;
2412 * frame skip exponent
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * frame skip comparison function
2420 * - encoding: Set by user.
2421 * - decoding: unused
2426 * trellis RD quantization
2427 * - encoding: Set by user.
2428 * - decoding: unused
2433 * - encoding: Set by user.
2434 * - decoding: unused
2436 int min_prediction_order;
2439 * - encoding: Set by user.
2440 * - decoding: unused
2442 int max_prediction_order;
2445 * GOP timecode frame start number, in non drop frame format
2446 * - encoding: Set by user.
2447 * - decoding: unused
2449 int64_t timecode_frame_start;
2451 /* The RTP callback: This function is called */
2452 /* every time the encoder has a packet to send. */
2453 /* It depends on the encoder if the data starts */
2454 /* with a Start Code (it should). H.263 does. */
2455 /* mb_nb contains the number of macroblocks */
2456 /* encoded in the RTP payload. */
2457 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2459 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2460 /* do its best to deliver a chunk with size */
2461 /* below rtp_payload_size, the chunk will start */
2462 /* with a start code on some codecs like H.263. */
2463 /* This doesn't take account of any particular */
2464 /* headers inside the transmitted RTP payload. */
2466 /* statistics, used for 2-pass encoding */
2477 * number of bits used for the previously encoded frame
2478 * - encoding: Set by libavcodec.
2479 * - decoding: unused
2484 * pass1 encoding statistics output buffer
2485 * - encoding: Set by libavcodec.
2486 * - decoding: unused
2491 * pass2 encoding statistics input buffer
2492 * Concatenated stuff from stats_out of pass1 should be placed here.
2493 * - encoding: Allocated/set/freed by user.
2494 * - decoding: unused
2499 * Work around bugs in encoders which sometimes cannot be detected automatically.
2500 * - encoding: Set by user
2501 * - decoding: Set by user
2503 int workaround_bugs;
2504 #define FF_BUG_AUTODETECT 1 ///< autodetection
2505 #define FF_BUG_OLD_MSMPEG4 2
2506 #define FF_BUG_XVID_ILACE 4
2507 #define FF_BUG_UMP4 8
2508 #define FF_BUG_NO_PADDING 16
2509 #define FF_BUG_AMV 32
2510 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2511 #define FF_BUG_QPEL_CHROMA 64
2512 #define FF_BUG_STD_QPEL 128
2513 #define FF_BUG_QPEL_CHROMA2 256
2514 #define FF_BUG_DIRECT_BLOCKSIZE 512
2515 #define FF_BUG_EDGE 1024
2516 #define FF_BUG_HPEL_CHROMA 2048
2517 #define FF_BUG_DC_CLIP 4096
2518 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2519 #define FF_BUG_TRUNCATED 16384
2522 * strictly follow the standard (MPEG4, ...).
2523 * - encoding: Set by user.
2524 * - decoding: Set by user.
2525 * Setting this to STRICT or higher means the encoder and decoder will
2526 * generally do stupid things, whereas setting it to unofficial or lower
2527 * will mean the encoder might produce output that is not supported by all
2528 * spec-compliant decoders. Decoders don't differentiate between normal,
2529 * unofficial and experimental (that is, they always try to decode things
2530 * when they can) unless they are explicitly asked to behave stupidly
2531 * (=strictly conform to the specs)
2533 int strict_std_compliance;
2534 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2535 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2536 #define FF_COMPLIANCE_NORMAL 0
2537 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2538 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2541 * error concealment flags
2542 * - encoding: unused
2543 * - decoding: Set by user.
2545 int error_concealment;
2546 #define FF_EC_GUESS_MVS 1
2547 #define FF_EC_DEBLOCK 2
2551 * - encoding: Set by user.
2552 * - decoding: Set by user.
2555 #define FF_DEBUG_PICT_INFO 1
2556 #define FF_DEBUG_RC 2
2557 #define FF_DEBUG_BITSTREAM 4
2558 #define FF_DEBUG_MB_TYPE 8
2559 #define FF_DEBUG_QP 16
2560 #define FF_DEBUG_MV 32
2561 #define FF_DEBUG_DCT_COEFF 0x00000040
2562 #define FF_DEBUG_SKIP 0x00000080
2563 #define FF_DEBUG_STARTCODE 0x00000100
2564 #define FF_DEBUG_PTS 0x00000200
2565 #define FF_DEBUG_ER 0x00000400
2566 #define FF_DEBUG_MMCO 0x00000800
2567 #define FF_DEBUG_BUGS 0x00001000
2568 #define FF_DEBUG_VIS_QP 0x00002000
2569 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2570 #define FF_DEBUG_BUFFERS 0x00008000
2571 #define FF_DEBUG_THREADS 0x00010000
2575 * - encoding: Set by user.
2576 * - decoding: Set by user.
2579 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2580 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2581 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2584 * Error recognition; may misdetect some more or less valid parts as errors.
2585 * - encoding: unused
2586 * - decoding: Set by user.
2588 int err_recognition;
2589 #define AV_EF_CRCCHECK (1<<0)
2590 #define AV_EF_BITSTREAM (1<<1)
2591 #define AV_EF_BUFFER (1<<2)
2592 #define AV_EF_EXPLODE (1<<3)
2595 * opaque 64bit number (generally a PTS) that will be reordered and
2596 * output in AVFrame.reordered_opaque
2597 * @deprecated in favor of pkt_pts
2598 * - encoding: unused
2599 * - decoding: Set by user.
2601 int64_t reordered_opaque;
2604 * Hardware accelerator in use
2605 * - encoding: unused.
2606 * - decoding: Set by libavcodec
2608 struct AVHWAccel *hwaccel;
2611 * Hardware accelerator context.
2612 * For some hardware accelerators, a global context needs to be
2613 * provided by the user. In that case, this holds display-dependent
2614 * data Libav cannot instantiate itself. Please refer to the
2615 * Libav HW accelerator documentation to know how to fill this
2616 * is. e.g. for VA API, this is a struct vaapi_context.
2617 * - encoding: unused
2618 * - decoding: Set by user
2620 void *hwaccel_context;
2624 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2625 * - decoding: unused
2627 uint64_t error[AV_NUM_DATA_POINTERS];
2630 * DCT algorithm, see FF_DCT_* below
2631 * - encoding: Set by user.
2632 * - decoding: unused
2635 #define FF_DCT_AUTO 0
2636 #define FF_DCT_FASTINT 1
2637 #define FF_DCT_INT 2
2638 #define FF_DCT_MMX 3
2639 #define FF_DCT_ALTIVEC 5
2640 #define FF_DCT_FAAN 6
2643 * IDCT algorithm, see FF_IDCT_* below.
2644 * - encoding: Set by user.
2645 * - decoding: Set by user.
2648 #define FF_IDCT_AUTO 0
2649 #define FF_IDCT_INT 1
2650 #define FF_IDCT_SIMPLE 2
2651 #define FF_IDCT_SIMPLEMMX 3
2653 #define FF_IDCT_LIBMPEG2MMX 4
2656 #define FF_IDCT_MMI 5
2658 #define FF_IDCT_ARM 7
2659 #define FF_IDCT_ALTIVEC 8
2660 #define FF_IDCT_SH4 9
2661 #define FF_IDCT_SIMPLEARM 10
2662 #define FF_IDCT_H264 11
2663 #define FF_IDCT_VP3 12
2664 #define FF_IDCT_IPP 13
2665 #define FF_IDCT_XVIDMMX 14
2666 #define FF_IDCT_CAVS 15
2667 #define FF_IDCT_SIMPLEARMV5TE 16
2668 #define FF_IDCT_SIMPLEARMV6 17
2669 #define FF_IDCT_SIMPLEVIS 18
2670 #define FF_IDCT_WMV2 19
2671 #define FF_IDCT_FAAN 20
2672 #define FF_IDCT_EA 21
2673 #define FF_IDCT_SIMPLENEON 22
2674 #define FF_IDCT_SIMPLEALPHA 23
2675 #define FF_IDCT_BINK 24
2680 * @deprecated use av_set_cpu_flags_mask() instead.
2682 attribute_deprecated unsigned dsp_mask;
2686 * bits per sample/pixel from the demuxer (needed for huffyuv).
2687 * - encoding: Set by libavcodec.
2688 * - decoding: Set by user.
2690 int bits_per_coded_sample;
2693 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2694 * - encoding: set by user.
2695 * - decoding: set by libavcodec.
2697 int bits_per_raw_sample;
2700 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2701 * - encoding: unused
2702 * - decoding: Set by user.
2704 attribute_deprecated int lowres;
2707 * the picture in the bitstream
2708 * - encoding: Set by libavcodec.
2709 * - decoding: Set by libavcodec.
2711 AVFrame *coded_frame;
2715 * is used to decide how many independent tasks should be passed to execute()
2716 * - encoding: Set by user.
2717 * - decoding: Set by user.
2722 * Which multithreading methods to use.
2723 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2724 * so clients which cannot provide future frames should not use it.
2726 * - encoding: Set by user, otherwise the default is used.
2727 * - decoding: Set by user, otherwise the default is used.
2730 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2731 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2734 * Which multithreading methods are in use by the codec.
2735 * - encoding: Set by libavcodec.
2736 * - decoding: Set by libavcodec.
2738 int active_thread_type;
2741 * Set by the client if its custom get_buffer() callback can be called
2742 * synchronously from another thread, which allows faster multithreaded decoding.
2743 * draw_horiz_band() will be called from other threads regardless of this setting.
2744 * Ignored if the default get_buffer() is used.
2745 * - encoding: Set by user.
2746 * - decoding: Set by user.
2748 int thread_safe_callbacks;
2751 * The codec may call this to execute several independent things.
2752 * It will return only after finishing all tasks.
2753 * The user may replace this with some multithreaded implementation,
2754 * the default implementation will execute the parts serially.
2755 * @param count the number of things to execute
2756 * - encoding: Set by libavcodec, user can override.
2757 * - decoding: Set by libavcodec, user can override.
2759 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2762 * The codec may call this to execute several independent things.
2763 * It will return only after finishing all tasks.
2764 * The user may replace this with some multithreaded implementation,
2765 * the default implementation will execute the parts serially.
2766 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2767 * @param c context passed also to func
2768 * @param count the number of things to execute
2769 * @param arg2 argument passed unchanged to func
2770 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2771 * @param func function that will be called count times, with jobnr from 0 to count-1.
2772 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2773 * two instances of func executing at the same time will have the same threadnr.
2774 * @return always 0 currently, but code should handle a future improvement where when any call to func
2775 * returns < 0 no further calls to func may be done and < 0 is returned.
2776 * - encoding: Set by libavcodec, user can override.
2777 * - decoding: Set by libavcodec, user can override.
2779 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2783 * Can be used by execute() to store some per AVCodecContext stuff.
2784 * - encoding: set by execute()
2785 * - decoding: set by execute()
2787 void *thread_opaque;
2790 * noise vs. sse weight for the nsse comparsion function
2791 * - encoding: Set by user.
2792 * - decoding: unused
2798 * - encoding: Set by user.
2799 * - decoding: Set by libavcodec.
2802 #define FF_PROFILE_UNKNOWN -99
2803 #define FF_PROFILE_RESERVED -100
2805 #define FF_PROFILE_AAC_MAIN 0
2806 #define FF_PROFILE_AAC_LOW 1
2807 #define FF_PROFILE_AAC_SSR 2
2808 #define FF_PROFILE_AAC_LTP 3
2809 #define FF_PROFILE_AAC_HE 4
2810 #define FF_PROFILE_AAC_HE_V2 28
2811 #define FF_PROFILE_AAC_LD 22
2812 #define FF_PROFILE_AAC_ELD 38
2814 #define FF_PROFILE_DTS 20
2815 #define FF_PROFILE_DTS_ES 30
2816 #define FF_PROFILE_DTS_96_24 40
2817 #define FF_PROFILE_DTS_HD_HRA 50
2818 #define FF_PROFILE_DTS_HD_MA 60
2820 #define FF_PROFILE_MPEG2_422 0
2821 #define FF_PROFILE_MPEG2_HIGH 1
2822 #define FF_PROFILE_MPEG2_SS 2
2823 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2824 #define FF_PROFILE_MPEG2_MAIN 4
2825 #define FF_PROFILE_MPEG2_SIMPLE 5
2827 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2828 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2830 #define FF_PROFILE_H264_BASELINE 66
2831 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2832 #define FF_PROFILE_H264_MAIN 77
2833 #define FF_PROFILE_H264_EXTENDED 88
2834 #define FF_PROFILE_H264_HIGH 100
2835 #define FF_PROFILE_H264_HIGH_10 110
2836 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2837 #define FF_PROFILE_H264_HIGH_422 122
2838 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2839 #define FF_PROFILE_H264_HIGH_444 144
2840 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2841 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2842 #define FF_PROFILE_H264_CAVLC_444 44
2844 #define FF_PROFILE_VC1_SIMPLE 0
2845 #define FF_PROFILE_VC1_MAIN 1
2846 #define FF_PROFILE_VC1_COMPLEX 2
2847 #define FF_PROFILE_VC1_ADVANCED 3
2849 #define FF_PROFILE_MPEG4_SIMPLE 0
2850 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2851 #define FF_PROFILE_MPEG4_CORE 2
2852 #define FF_PROFILE_MPEG4_MAIN 3
2853 #define FF_PROFILE_MPEG4_N_BIT 4
2854 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2855 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2856 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2857 #define FF_PROFILE_MPEG4_HYBRID 8
2858 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2859 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2860 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2861 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2862 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2863 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2864 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2868 * - encoding: Set by user.
2869 * - decoding: Set by libavcodec.
2872 #define FF_LEVEL_UNKNOWN -99
2876 * - encoding: unused
2877 * - decoding: Set by user.
2879 enum AVDiscard skip_loop_filter;
2883 * - encoding: unused
2884 * - decoding: Set by user.
2886 enum AVDiscard skip_idct;
2890 * - encoding: unused
2891 * - decoding: Set by user.
2893 enum AVDiscard skip_frame;
2896 * Header containing style information for text subtitles.
2897 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2898 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2899 * the Format line following. It shouldn't include any Dialogue line.
2900 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2901 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2903 uint8_t *subtitle_header;
2904 int subtitle_header_size;
2907 * Simulates errors in the bitstream to test error concealment.
2908 * - encoding: Set by user.
2909 * - decoding: unused
2914 * Current packet as passed into the decoder, to avoid having
2915 * to pass the packet into every function. Currently only valid
2916 * inside lavc and get/release_buffer callbacks.
2917 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2918 * - encoding: unused
2923 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2924 * Used for compliant TS muxing.
2925 * - encoding: Set by libavcodec.
2926 * - decoding: unused.
2934 typedef struct AVProfile {
2936 const char *name; ///< short name for the profile
2939 typedef struct AVCodecDefault AVCodecDefault;
2946 typedef struct AVCodec {
2948 * Name of the codec implementation.
2949 * The name is globally unique among encoders and among decoders (but an
2950 * encoder and a decoder can share the same name).
2951 * This is the primary way to find a codec from the user perspective.
2955 * Descriptive name for the codec, meant to be more human readable than name.
2956 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2958 const char *long_name;
2959 enum AVMediaType type;
2962 * Codec capabilities.
2966 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2967 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2968 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2969 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2970 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2971 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2972 const AVClass *priv_class; ///< AVClass for the private context
2973 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2975 /*****************************************************************
2976 * No fields below this line are part of the public API. They
2977 * may not be used outside of libavcodec and can be changed and
2979 * New public fields should be added right above.
2980 *****************************************************************
2983 struct AVCodec *next;
2985 * @name Frame-level threading support functions
2989 * If defined, called on thread contexts when they are created.
2990 * If the codec allocates writable tables in init(), re-allocate them here.
2991 * priv_data will be set to a copy of the original.
2993 int (*init_thread_copy)(AVCodecContext *);
2995 * Copy necessary context variables from a previous thread context to the current one.
2996 * If not defined, the next thread will start automatically; otherwise, the codec
2997 * must call ff_thread_finish_setup().
2999 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3001 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3005 * Private codec-specific defaults.
3007 const AVCodecDefault *defaults;
3010 * Initialize codec static data, called from avcodec_register().
3012 void (*init_static_data)(struct AVCodec *codec);
3014 int (*init)(AVCodecContext *);
3015 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3016 const struct AVSubtitle *sub);
3018 * Encode data to an AVPacket.
3020 * @param avctx codec context
3021 * @param avpkt output AVPacket (may contain a user-provided buffer)
3022 * @param[in] frame AVFrame containing the raw data to be encoded
3023 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3024 * non-empty packet was returned in avpkt.
3025 * @return 0 on success, negative error code on failure
3027 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3028 int *got_packet_ptr);
3029 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3030 int (*close)(AVCodecContext *);
3033 * Will be called when seeking
3035 void (*flush)(AVCodecContext *);
3041 typedef struct AVHWAccel {
3043 * Name of the hardware accelerated codec.
3044 * The name is globally unique among encoders and among decoders (but an
3045 * encoder and a decoder can share the same name).
3050 * Type of codec implemented by the hardware accelerator.
3052 * See AVMEDIA_TYPE_xxx
3054 enum AVMediaType type;
3057 * Codec implemented by the hardware accelerator.
3059 * See AV_CODEC_ID_xxx
3064 * Supported pixel format.
3066 * Only hardware accelerated formats are supported here.
3068 enum AVPixelFormat pix_fmt;
3071 * Hardware accelerated codec capabilities.
3072 * see FF_HWACCEL_CODEC_CAP_*
3076 struct AVHWAccel *next;
3079 * Called at the beginning of each frame or field picture.
3081 * Meaningful frame information (codec specific) is guaranteed to
3082 * be parsed at this point. This function is mandatory.
3084 * Note that buf can be NULL along with buf_size set to 0.
3085 * Otherwise, this means the whole frame is available at this point.
3087 * @param avctx the codec context
3088 * @param buf the frame data buffer base
3089 * @param buf_size the size of the frame in bytes
3090 * @return zero if successful, a negative value otherwise
3092 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3095 * Callback for each slice.
3097 * Meaningful slice information (codec specific) is guaranteed to
3098 * be parsed at this point. This function is mandatory.
3100 * @param avctx the codec context
3101 * @param buf the slice data buffer base
3102 * @param buf_size the size of the slice in bytes
3103 * @return zero if successful, a negative value otherwise
3105 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3108 * Called at the end of each frame or field picture.
3110 * The whole picture is parsed at this point and can now be sent
3111 * to the hardware accelerator. This function is mandatory.
3113 * @param avctx the codec context
3114 * @return zero if successful, a negative value otherwise
3116 int (*end_frame)(AVCodecContext *avctx);
3119 * Size of HW accelerator private data.
3121 * Private data is allocated with av_mallocz() before
3122 * AVCodecContext.get_buffer() and deallocated after
3123 * AVCodecContext.release_buffer().
3129 * @defgroup lavc_picture AVPicture
3131 * Functions for working with AVPicture
3136 * four components are given, that's all.
3137 * the last component is alpha
3139 typedef struct AVPicture {
3140 uint8_t *data[AV_NUM_DATA_POINTERS];
3141 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3148 #define AVPALETTE_SIZE 1024
3149 #define AVPALETTE_COUNT 256
3151 enum AVSubtitleType {
3154 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3157 * Plain text, the text field must be set by the decoder and is
3158 * authoritative. ass and pict fields may contain approximations.
3163 * Formatted text, the ass field must be set by the decoder and is
3164 * authoritative. pict and text fields may contain approximations.
3169 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3171 typedef struct AVSubtitleRect {
3172 int x; ///< top left corner of pict, undefined when pict is not set
3173 int y; ///< top left corner of pict, undefined when pict is not set
3174 int w; ///< width of pict, undefined when pict is not set
3175 int h; ///< height of pict, undefined when pict is not set
3176 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3179 * data+linesize for the bitmap of this subtitle.
3180 * can be set for text/ass as well once they where rendered
3183 enum AVSubtitleType type;
3185 char *text; ///< 0 terminated plain UTF-8 text
3188 * 0 terminated ASS/SSA compatible event line.
3189 * The pressentation of this is unaffected by the other values in this
3196 typedef struct AVSubtitle {
3197 uint16_t format; /* 0 = graphics */
3198 uint32_t start_display_time; /* relative to packet pts, in ms */
3199 uint32_t end_display_time; /* relative to packet pts, in ms */
3201 AVSubtitleRect **rects;
3202 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3206 * If c is NULL, returns the first registered codec,
3207 * if c is non-NULL, returns the next registered codec after c,
3208 * or NULL if c is the last one.
3210 AVCodec *av_codec_next(const AVCodec *c);
3213 * Return the LIBAVCODEC_VERSION_INT constant.
3215 unsigned avcodec_version(void);
3218 * Return the libavcodec build-time configuration.
3220 const char *avcodec_configuration(void);
3223 * Return the libavcodec license.
3225 const char *avcodec_license(void);
3228 * Register the codec codec and initialize libavcodec.
3230 * @warning either this function or avcodec_register_all() must be called
3231 * before any other libavcodec functions.
3233 * @see avcodec_register_all()
3235 void avcodec_register(AVCodec *codec);
3238 * Register all the codecs, parsers and bitstream filters which were enabled at
3239 * configuration time. If you do not call this function you can select exactly
3240 * which formats you want to support, by using the individual registration
3243 * @see avcodec_register
3244 * @see av_register_codec_parser
3245 * @see av_register_bitstream_filter
3247 void avcodec_register_all(void);
3250 * Allocate an AVCodecContext and set its fields to default values. The
3251 * resulting struct can be deallocated by calling avcodec_close() on it followed
3254 * @param codec if non-NULL, allocate private data and initialize defaults
3255 * for the given codec. It is illegal to then call avcodec_open2()
3256 * with a different codec.
3257 * If NULL, then the codec-specific defaults won't be initialized,
3258 * which may result in suboptimal default settings (this is
3259 * important mainly for encoders, e.g. libx264).
3261 * @return An AVCodecContext filled with default values or NULL on failure.
3262 * @see avcodec_get_context_defaults
3264 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3267 * Set the fields of the given AVCodecContext to default values corresponding
3268 * to the given codec (defaults may be codec-dependent).
3270 * Do not call this function if a non-NULL codec has been passed
3271 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3272 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3273 * different codec on this AVCodecContext.
3275 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3278 * Get the AVClass for AVCodecContext. It can be used in combination with
3279 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3281 * @see av_opt_find().
3283 const AVClass *avcodec_get_class(void);
3286 * Copy the settings of the source AVCodecContext into the destination
3287 * AVCodecContext. The resulting destination codec context will be
3288 * unopened, i.e. you are required to call avcodec_open2() before you
3289 * can use this AVCodecContext to decode/encode video/audio data.
3291 * @param dest target codec context, should be initialized with
3292 * avcodec_alloc_context3(), but otherwise uninitialized
3293 * @param src source codec context
3294 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3296 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3299 * Allocate an AVFrame and set its fields to default values. The resulting
3300 * struct must be freed using avcodec_free_frame().
3302 * @return An AVFrame filled with default values or NULL on failure.
3303 * @see avcodec_get_frame_defaults
3305 AVFrame *avcodec_alloc_frame(void);
3308 * Set the fields of the given AVFrame to default values.
3310 * @param frame The AVFrame of which the fields should be set to default values.
3312 void avcodec_get_frame_defaults(AVFrame *frame);
3315 * Free the frame and any dynamically allocated objects in it,
3316 * e.g. extended_data.
3318 * @param frame frame to be freed. The pointer will be set to NULL.
3320 * @warning this function does NOT free the data buffers themselves
3321 * (it does not know how, since they might have been allocated with
3322 * a custom get_buffer()).
3324 void avcodec_free_frame(AVFrame **frame);
3327 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3328 * function the context has to be allocated with avcodec_alloc_context3().
3330 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3331 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3332 * retrieving a codec.
3334 * @warning This function is not thread safe!
3337 * avcodec_register_all();
3338 * av_dict_set(&opts, "b", "2.5M", 0);
3339 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3343 * context = avcodec_alloc_context3(codec);
3345 * if (avcodec_open2(context, codec, opts) < 0)
3349 * @param avctx The context to initialize.
3350 * @param codec The codec to open this context for. If a non-NULL codec has been
3351 * previously passed to avcodec_alloc_context3() or
3352 * avcodec_get_context_defaults3() for this context, then this
3353 * parameter MUST be either NULL or equal to the previously passed
3355 * @param options A dictionary filled with AVCodecContext and codec-private options.
3356 * On return this object will be filled with options that were not found.
3358 * @return zero on success, a negative value on error
3359 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3360 * av_dict_set(), av_opt_find().
3362 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3365 * Close a given AVCodecContext and free all the data associated with it
3366 * (but not the AVCodecContext itself).
3368 * Calling this function on an AVCodecContext that hasn't been opened will free
3369 * the codec-specific data allocated in avcodec_alloc_context3() /
3370 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3373 int avcodec_close(AVCodecContext *avctx);
3376 * Free all allocated data in the given subtitle struct.
3378 * @param sub AVSubtitle to free.
3380 void avsubtitle_free(AVSubtitle *sub);
3387 * @addtogroup lavc_packet
3392 * Default packet destructor.
3394 void av_destruct_packet(AVPacket *pkt);
3397 * Initialize optional fields of a packet with default values.
3399 * Note, this does not touch the data and size members, which have to be
3400 * initialized separately.
3404 void av_init_packet(AVPacket *pkt);
3407 * Allocate the payload of a packet and initialize its fields with
3411 * @param size wanted payload size
3412 * @return 0 if OK, AVERROR_xxx otherwise
3414 int av_new_packet(AVPacket *pkt, int size);
3417 * Reduce packet size, correctly zeroing padding
3420 * @param size new size
3422 void av_shrink_packet(AVPacket *pkt, int size);
3425 * Increase packet size, correctly zeroing padding
3428 * @param grow_by number of bytes by which to increase the size of the packet
3430 int av_grow_packet(AVPacket *pkt, int grow_by);
3433 * @warning This is a hack - the packet memory allocation stuff is broken. The
3434 * packet is allocated if it was not really allocated.
3436 int av_dup_packet(AVPacket *pkt);
3441 * @param pkt packet to free
3443 void av_free_packet(AVPacket *pkt);
3446 * Allocate new information of a packet.
3449 * @param type side information type
3450 * @param size side information size
3451 * @return pointer to fresh allocated data or NULL otherwise
3453 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3457 * Shrink the already allocated side data buffer
3460 * @param type side information type
3461 * @param size new side information size
3462 * @return 0 on success, < 0 on failure
3464 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3468 * Get side information from packet.
3471 * @param type desired side information type
3472 * @param size pointer for side information size to store (optional)
3473 * @return pointer to data if present or NULL otherwise
3475 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3483 * @addtogroup lavc_decoding
3488 * Find a registered decoder with a matching codec ID.
3490 * @param id AVCodecID of the requested decoder
3491 * @return A decoder if one was found, NULL otherwise.
3493 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3496 * Find a registered decoder with the specified name.
3498 * @param name name of the requested decoder
3499 * @return A decoder if one was found, NULL otherwise.
3501 AVCodec *avcodec_find_decoder_by_name(const char *name);
3503 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3504 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3505 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3508 * Return the amount of padding in pixels which the get_buffer callback must
3509 * provide around the edge of the image for codecs which do not have the
3510 * CODEC_FLAG_EMU_EDGE flag.
3512 * @return Required padding in pixels.
3514 unsigned avcodec_get_edge_width(void);
3517 * Modify width and height values so that they will result in a memory
3518 * buffer that is acceptable for the codec if you do not use any horizontal
3521 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3522 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3523 * according to avcodec_get_edge_width() before.
3525 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3528 * Modify width and height values so that they will result in a memory
3529 * buffer that is acceptable for the codec if you also ensure that all
3530 * line sizes are a multiple of the respective linesize_align[i].
3532 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3533 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3534 * according to avcodec_get_edge_width() before.
3536 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3537 int linesize_align[AV_NUM_DATA_POINTERS]);
3539 #if FF_API_OLD_DECODE_AUDIO
3541 * Wrapper function which calls avcodec_decode_audio4.
3543 * @deprecated Use avcodec_decode_audio4 instead.
3545 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3546 * Some decoders may support multiple frames in a single AVPacket, such
3547 * decoders would then just decode the first frame. In this case,
3548 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3549 * the remaining data in order to decode the second frame etc.
3551 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3552 * decompressed frame size in bytes.
3554 * @warning You must set frame_size_ptr to the allocated size of the
3555 * output buffer before calling avcodec_decode_audio3().
3557 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3558 * the actual read bytes because some optimized bitstream readers read 32 or 64
3559 * bits at once and could read over the end.
3561 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3562 * no overreading happens for damaged MPEG streams.
3564 * @warning You must not provide a custom get_buffer() when using
3565 * avcodec_decode_audio3(). Doing so will override it with
3566 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3567 * which does allow the application to provide a custom get_buffer().
3569 * @note You might have to align the input buffer avpkt->data and output buffer
3570 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3571 * necessary at all, on others it won't work at all if not aligned and on others
3572 * it will work but it will have an impact on performance.
3574 * In practice, avpkt->data should have 4 byte alignment at minimum and
3575 * samples should be 16 byte aligned unless the CPU doesn't need it
3576 * (AltiVec and SSE do).
3578 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3579 * between input and output, these need to be fed with avpkt->data=NULL,
3580 * avpkt->size=0 at the end to return the remaining frames.
3582 * @param avctx the codec context
3583 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3584 * If the sample format is planar, each channel plane will
3585 * be the same size, with no padding between channels.
3586 * @param[in,out] frame_size_ptr the output buffer size in bytes
3587 * @param[in] avpkt The input AVPacket containing the input buffer.
3588 * You can create such packet with av_init_packet() and by then setting
3589 * data and size, some decoders might in addition need other fields.
3590 * All decoders are designed to use the least fields possible though.
3591 * @return On error a negative value is returned, otherwise the number of bytes
3592 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3594 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3595 int *frame_size_ptr,
3600 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3602 * Some decoders may support multiple frames in a single AVPacket. Such
3603 * decoders would then just decode the first frame. In this case,
3604 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3605 * the remaining data in order to decode the second frame, etc...
3606 * Even if no frames are returned, the packet needs to be fed to the decoder
3607 * with remaining data until it is completely consumed or an error occurs.
3609 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3610 * larger than the actual read bytes because some optimized bitstream
3611 * readers read 32 or 64 bits at once and could read over the end.
3613 * @note You might have to align the input buffer. The alignment requirements
3614 * depend on the CPU and the decoder.
3616 * @param avctx the codec context
3617 * @param[out] frame The AVFrame in which to store decoded audio samples.
3618 * Decoders request a buffer of a particular size by setting
3619 * AVFrame.nb_samples prior to calling get_buffer(). The
3620 * decoder may, however, only utilize part of the buffer by
3621 * setting AVFrame.nb_samples to a smaller value in the
3623 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3625 * @param[in] avpkt The input AVPacket containing the input buffer.
3626 * At least avpkt->data and avpkt->size should be set. Some
3627 * decoders might also require additional fields to be set.
3628 * @return A negative error code is returned if an error occurred during
3629 * decoding, otherwise the number of bytes consumed from the input
3630 * AVPacket is returned.
3632 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3633 int *got_frame_ptr, AVPacket *avpkt);
3636 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3637 * Some decoders may support multiple frames in a single AVPacket, such
3638 * decoders would then just decode the first frame.
3640 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3641 * the actual read bytes because some optimized bitstream readers read 32 or 64
3642 * bits at once and could read over the end.
3644 * @warning The end of the input buffer buf should be set to 0 to ensure that
3645 * no overreading happens for damaged MPEG streams.
3647 * @note You might have to align the input buffer avpkt->data.
3648 * The alignment requirements depend on the CPU: on some CPUs it isn't
3649 * necessary at all, on others it won't work at all if not aligned and on others
3650 * it will work but it will have an impact on performance.
3652 * In practice, avpkt->data should have 4 byte alignment at minimum.
3654 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3655 * between input and output, these need to be fed with avpkt->data=NULL,
3656 * avpkt->size=0 at the end to return the remaining frames.
3658 * @param avctx the codec context
3659 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3660 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3661 * allocate memory for the actual bitmap.
3662 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3663 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3664 * decodes and the decoder tells the user once it does not need the data anymore,
3665 * the user app can at this point free/reuse/keep the memory as it sees fit.
3667 * @param[in] avpkt The input AVpacket containing the input buffer.
3668 * You can create such packet with av_init_packet() and by then setting
3669 * data and size, some decoders might in addition need other fields like
3670 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3672 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3673 * @return On error a negative value is returned, otherwise the number of bytes
3674 * used or zero if no frame could be decompressed.
3676 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3677 int *got_picture_ptr,
3681 * Decode a subtitle message.
3682 * Return a negative value on error, otherwise return the number of bytes used.
3683 * If no subtitle could be decompressed, got_sub_ptr is zero.
3684 * Otherwise, the subtitle is stored in *sub.
3685 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3686 * simplicity, because the performance difference is expect to be negligible
3687 * and reusing a get_buffer written for video codecs would probably perform badly
3688 * due to a potentially very different allocation pattern.
3690 * @param avctx the codec context
3691 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3692 freed with avsubtitle_free if *got_sub_ptr is set.
3693 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3694 * @param[in] avpkt The input AVPacket containing the input buffer.
3696 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3701 * @defgroup lavc_parsing Frame parsing
3705 typedef struct AVCodecParserContext {
3707 struct AVCodecParser *parser;
3708 int64_t frame_offset; /* offset of the current frame */
3709 int64_t cur_offset; /* current offset
3710 (incremented by each av_parser_parse()) */
3711 int64_t next_frame_offset; /* offset of the next frame */
3713 int pict_type; /* XXX: Put it back in AVCodecContext. */
3715 * This field is used for proper frame duration computation in lavf.
3716 * It signals, how much longer the frame duration of the current frame
3717 * is compared to normal frame duration.
3719 * frame_duration = (1 + repeat_pict) * time_base
3721 * It is used by codecs like H.264 to display telecined material.
3723 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3724 int64_t pts; /* pts of the current frame */
3725 int64_t dts; /* dts of the current frame */
3730 int fetch_timestamp;
3732 #define AV_PARSER_PTS_NB 4
3733 int cur_frame_start_index;
3734 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3735 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3736 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3739 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3740 #define PARSER_FLAG_ONCE 0x0002
3741 /// Set if the parser has a valid file offset
3742 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3744 int64_t offset; ///< byte offset from starting packet start
3745 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3748 * Set by parser to 1 for key frames and 0 for non-key frames.
3749 * It is initialized to -1, so if the parser doesn't set this flag,
3750 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3756 * Time difference in stream time base units from the pts of this
3757 * packet to the point at which the output from the decoder has converged
3758 * independent from the availability of previous frames. That is, the
3759 * frames are virtually identical no matter if decoding started from
3760 * the very first frame or from this keyframe.
3761 * Is AV_NOPTS_VALUE if unknown.
3762 * This field is not the display duration of the current frame.
3763 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3766 * The purpose of this field is to allow seeking in streams that have no
3767 * keyframes in the conventional sense. It corresponds to the
3768 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3769 * essential for some types of subtitle streams to ensure that all
3770 * subtitles are correctly displayed after seeking.
3772 int64_t convergence_duration;
3774 // Timestamp generation support:
3776 * Synchronization point for start of timestamp generation.
3778 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3781 * For example, this corresponds to presence of H.264 buffering period
3787 * Offset of the current timestamp against last timestamp sync point in
3788 * units of AVCodecContext.time_base.
3790 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3791 * contain a valid timestamp offset.
3793 * Note that the timestamp of sync point has usually a nonzero
3794 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3795 * the next frame after timestamp sync point will be usually 1.
3797 * For example, this corresponds to H.264 cpb_removal_delay.
3799 int dts_ref_dts_delta;
3802 * Presentation delay of current frame in units of AVCodecContext.time_base.
3804 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3805 * contain valid non-negative timestamp delta (presentation time of a frame
3806 * must not lie in the past).
3808 * This delay represents the difference between decoding and presentation
3809 * time of the frame.
3811 * For example, this corresponds to H.264 dpb_output_delay.
3816 * Position of the packet in file.
3818 * Analogous to cur_frame_pts/dts
3820 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3823 * Byte position of currently parsed frame in stream.
3828 * Previous frame byte position.
3833 * Duration of the current frame.
3834 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3835 * For all other types, this is in units of AVCodecContext.time_base.
3838 } AVCodecParserContext;
3840 typedef struct AVCodecParser {
3841 int codec_ids[5]; /* several codec IDs are permitted */
3843 int (*parser_init)(AVCodecParserContext *s);
3844 int (*parser_parse)(AVCodecParserContext *s,
3845 AVCodecContext *avctx,
3846 const uint8_t **poutbuf, int *poutbuf_size,
3847 const uint8_t *buf, int buf_size);
3848 void (*parser_close)(AVCodecParserContext *s);
3849 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3850 struct AVCodecParser *next;
3853 AVCodecParser *av_parser_next(AVCodecParser *c);
3855 void av_register_codec_parser(AVCodecParser *parser);
3856 AVCodecParserContext *av_parser_init(int codec_id);
3861 * @param s parser context.
3862 * @param avctx codec context.
3863 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3864 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3865 * @param buf input buffer.
3866 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3867 * @param pts input presentation timestamp.
3868 * @param dts input decoding timestamp.
3869 * @param pos input byte position in stream.
3870 * @return the number of bytes of the input bitstream used.
3875 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3882 * decode_frame(data, size);
3886 int av_parser_parse2(AVCodecParserContext *s,
3887 AVCodecContext *avctx,
3888 uint8_t **poutbuf, int *poutbuf_size,
3889 const uint8_t *buf, int buf_size,
3890 int64_t pts, int64_t dts,
3894 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3895 * @deprecated use AVBitstreamFilter
3897 int av_parser_change(AVCodecParserContext *s,
3898 AVCodecContext *avctx,
3899 uint8_t **poutbuf, int *poutbuf_size,
3900 const uint8_t *buf, int buf_size, int keyframe);
3901 void av_parser_close(AVCodecParserContext *s);
3909 * @addtogroup lavc_encoding
3914 * Find a registered encoder with a matching codec ID.
3916 * @param id AVCodecID of the requested encoder
3917 * @return An encoder if one was found, NULL otherwise.
3919 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3922 * Find a registered encoder with the specified name.
3924 * @param name name of the requested encoder
3925 * @return An encoder if one was found, NULL otherwise.
3927 AVCodec *avcodec_find_encoder_by_name(const char *name);
3929 #if FF_API_OLD_ENCODE_AUDIO
3931 * Encode an audio frame from samples into buf.
3933 * @deprecated Use avcodec_encode_audio2 instead.
3935 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3936 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3937 * will know how much space is needed because it depends on the value passed
3938 * in buf_size as described below. In that case a lower value can be used.
3940 * @param avctx the codec context
3941 * @param[out] buf the output buffer
3942 * @param[in] buf_size the output buffer size
3943 * @param[in] samples the input buffer containing the samples
3944 * The number of samples read from this buffer is frame_size*channels,
3945 * both of which are defined in avctx.
3946 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3947 * samples read from samples is equal to:
3948 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3949 * This also implies that av_get_bits_per_sample() must not return 0 for these
3951 * @return On error a negative value is returned, on success zero or the number
3952 * of bytes used to encode the data read from the input buffer.
3954 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3955 uint8_t *buf, int buf_size,
3956 const short *samples);
3960 * Encode a frame of audio.
3962 * Takes input samples from frame and writes the next output packet, if
3963 * available, to avpkt. The output packet does not necessarily contain data for
3964 * the most recent frame, as encoders can delay, split, and combine input frames
3965 * internally as needed.
3967 * @param avctx codec context
3968 * @param avpkt output AVPacket.
3969 * The user can supply an output buffer by setting
3970 * avpkt->data and avpkt->size prior to calling the
3971 * function, but if the size of the user-provided data is not
3972 * large enough, encoding will fail. All other AVPacket fields
3973 * will be reset by the encoder using av_init_packet(). If
3974 * avpkt->data is NULL, the encoder will allocate it.
3975 * The encoder will set avpkt->size to the size of the
3978 * If this function fails or produces no output, avpkt will be
3979 * freed using av_free_packet() (i.e. avpkt->destruct will be
3980 * called to free the user supplied buffer).
3981 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3982 * May be NULL when flushing an encoder that has the
3983 * CODEC_CAP_DELAY capability set.
3984 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3985 * can have any number of samples.
3986 * If it is not set, frame->nb_samples must be equal to
3987 * avctx->frame_size for all frames except the last.
3988 * The final frame may be smaller than avctx->frame_size.
3989 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3990 * output packet is non-empty, and to 0 if it is
3991 * empty. If the function returns an error, the
3992 * packet can be assumed to be invalid, and the
3993 * value of got_packet_ptr is undefined and should
3995 * @return 0 on success, negative error code on failure
3997 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3998 const AVFrame *frame, int *got_packet_ptr);
4000 #if FF_API_OLD_ENCODE_VIDEO
4002 * @deprecated use avcodec_encode_video2() instead.
4004 * Encode a video frame from pict into buf.
4005 * The input picture should be
4006 * stored using a specific format, namely avctx.pix_fmt.
4008 * @param avctx the codec context
4009 * @param[out] buf the output buffer for the bitstream of encoded frame
4010 * @param[in] buf_size the size of the output buffer in bytes
4011 * @param[in] pict the input picture to encode
4012 * @return On error a negative value is returned, on success zero or the number
4013 * of bytes used from the output buffer.
4015 attribute_deprecated
4016 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4017 const AVFrame *pict);
4021 * Encode a frame of video.
4023 * Takes input raw video data from frame and writes the next output packet, if
4024 * available, to avpkt. The output packet does not necessarily contain data for
4025 * the most recent frame, as encoders can delay and reorder input frames
4026 * internally as needed.
4028 * @param avctx codec context
4029 * @param avpkt output AVPacket.
4030 * The user can supply an output buffer by setting
4031 * avpkt->data and avpkt->size prior to calling the
4032 * function, but if the size of the user-provided data is not
4033 * large enough, encoding will fail. All other AVPacket fields
4034 * will be reset by the encoder using av_init_packet(). If
4035 * avpkt->data is NULL, the encoder will allocate it.
4036 * The encoder will set avpkt->size to the size of the
4037 * output packet. The returned data (if any) belongs to the
4038 * caller, he is responsible for freeing it.
4040 * If this function fails or produces no output, avpkt will be
4041 * freed using av_free_packet() (i.e. avpkt->destruct will be
4042 * called to free the user supplied buffer).
4043 * @param[in] frame AVFrame containing the raw video data to be encoded.
4044 * May be NULL when flushing an encoder that has the
4045 * CODEC_CAP_DELAY capability set.
4046 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4047 * output packet is non-empty, and to 0 if it is
4048 * empty. If the function returns an error, the
4049 * packet can be assumed to be invalid, and the
4050 * value of got_packet_ptr is undefined and should
4052 * @return 0 on success, negative error code on failure
4054 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4055 const AVFrame *frame, int *got_packet_ptr);
4057 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4058 const AVSubtitle *sub);
4065 #if FF_API_AVCODEC_RESAMPLE
4067 * @defgroup lavc_resample Audio resampling
4069 * @deprecated use libavresample instead
4073 struct ReSampleContext;
4074 struct AVResampleContext;
4076 typedef struct ReSampleContext ReSampleContext;
4079 * Initialize audio resampling context.
4081 * @param output_channels number of output channels
4082 * @param input_channels number of input channels
4083 * @param output_rate output sample rate
4084 * @param input_rate input sample rate
4085 * @param sample_fmt_out requested output sample format
4086 * @param sample_fmt_in input sample format
4087 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4088 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4089 * @param linear if 1 then the used FIR filter will be linearly interpolated
4090 between the 2 closest, if 0 the closest will be used
4091 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4092 * @return allocated ReSampleContext, NULL if error occurred
4094 attribute_deprecated
4095 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4096 int output_rate, int input_rate,
4097 enum AVSampleFormat sample_fmt_out,
4098 enum AVSampleFormat sample_fmt_in,
4099 int filter_length, int log2_phase_count,
4100 int linear, double cutoff);
4102 attribute_deprecated
4103 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4106 * Free resample context.
4108 * @param s a non-NULL pointer to a resample context previously
4109 * created with av_audio_resample_init()
4111 attribute_deprecated
4112 void audio_resample_close(ReSampleContext *s);
4116 * Initialize an audio resampler.
4117 * Note, if either rate is not an integer then simply scale both rates up so they are.
4118 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4119 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4120 * @param linear If 1 then the used FIR filter will be linearly interpolated
4121 between the 2 closest, if 0 the closest will be used
4122 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4124 attribute_deprecated
4125 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4128 * Resample an array of samples using a previously configured context.
4129 * @param src an array of unconsumed samples
4130 * @param consumed the number of samples of src which have been consumed are returned here
4131 * @param src_size the number of unconsumed samples available
4132 * @param dst_size the amount of space in samples available in dst
4133 * @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.
4134 * @return the number of samples written in dst or -1 if an error occurred
4136 attribute_deprecated
4137 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4141 * Compensate samplerate/timestamp drift. The compensation is done by changing
4142 * the resampler parameters, so no audible clicks or similar distortions occur
4143 * @param compensation_distance distance in output samples over which the compensation should be performed
4144 * @param sample_delta number of output samples which should be output less
4146 * example: av_resample_compensate(c, 10, 500)
4147 * here instead of 510 samples only 500 samples would be output
4149 * note, due to rounding the actual compensation might be slightly different,
4150 * especially if the compensation_distance is large and the in_rate used during init is small
4152 attribute_deprecated
4153 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4154 attribute_deprecated
4155 void av_resample_close(struct AVResampleContext *c);
4163 * @addtogroup lavc_picture
4168 * Allocate memory for a picture. Call avpicture_free() to free it.
4170 * @see avpicture_fill()
4172 * @param picture the picture to be filled in
4173 * @param pix_fmt the format of the picture
4174 * @param width the width of the picture
4175 * @param height the height of the picture
4176 * @return zero if successful, a negative value if not
4178 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4181 * Free a picture previously allocated by avpicture_alloc().
4182 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4185 * @param picture the AVPicture to be freed
4187 void avpicture_free(AVPicture *picture);
4190 * Fill in the AVPicture fields.
4191 * The fields of the given AVPicture are filled in by using the 'ptr' address
4192 * which points to the image data buffer. Depending on the specified picture
4193 * format, one or multiple image data pointers and line sizes will be set.
4194 * If a planar format is specified, several pointers will be set pointing to
4195 * the different picture planes and the line sizes of the different planes
4196 * will be stored in the lines_sizes array.
4197 * Call with ptr == NULL to get the required size for the ptr buffer.
4199 * To allocate the buffer and fill in the AVPicture fields in one call,
4200 * use avpicture_alloc().
4202 * @param picture AVPicture whose fields are to be filled in
4203 * @param ptr Buffer which will contain or contains the actual image data
4204 * @param pix_fmt The format in which the picture data is stored.
4205 * @param width the width of the image in pixels
4206 * @param height the height of the image in pixels
4207 * @return size of the image data in bytes
4209 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4210 enum AVPixelFormat pix_fmt, int width, int height);
4213 * Copy pixel data from an AVPicture into a buffer.
4214 * The data is stored compactly, without any gaps for alignment or padding
4215 * which may be applied by avpicture_fill().
4217 * @see avpicture_get_size()
4219 * @param[in] src AVPicture containing image data
4220 * @param[in] pix_fmt The format in which the picture data is stored.
4221 * @param[in] width the width of the image in pixels.
4222 * @param[in] height the height of the image in pixels.
4223 * @param[out] dest A buffer into which picture data will be copied.
4224 * @param[in] dest_size The size of 'dest'.
4225 * @return The number of bytes written to dest, or a negative value (error code) on error.
4227 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4228 int width, int height,
4229 unsigned char *dest, int dest_size);
4232 * Calculate the size in bytes that a picture of the given width and height
4233 * would occupy if stored in the given picture format.
4234 * Note that this returns the size of a compact representation as generated
4235 * by avpicture_layout(), which can be smaller than the size required for e.g.
4238 * @param pix_fmt the given picture format
4239 * @param width the width of the image
4240 * @param height the height of the image
4241 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4243 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4246 * deinterlace - if not supported return -1
4248 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4249 enum AVPixelFormat pix_fmt, int width, int height);
4251 * Copy image src to dst. Wraps av_picture_data_copy() above.
4253 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4254 enum AVPixelFormat pix_fmt, int width, int height);
4257 * Crop image top and left side.
4259 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4260 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4265 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4266 int padtop, int padbottom, int padleft, int padright, int *color);
4273 * @defgroup lavc_misc Utility functions
4276 * Miscellaneous utility functions related to both encoding and decoding
4282 * @defgroup lavc_misc_pixfmt Pixel formats
4284 * Functions for working with pixel formats.
4289 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4292 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4295 * Return a value representing the fourCC code associated to the
4296 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4299 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4301 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4302 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4303 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4304 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4305 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4306 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4309 * Compute what kind of losses will occur when converting from one specific
4310 * pixel format to another.
4311 * When converting from one pixel format to another, information loss may occur.
4312 * For example, when converting from RGB24 to GRAY, the color information will
4313 * be lost. Similarly, other losses occur when converting from some formats to
4314 * other formats. These losses can involve loss of chroma, but also loss of
4315 * resolution, loss of color depth, loss due to the color space conversion, loss
4316 * of the alpha bits or loss due to color quantization.
4317 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4318 * which will occur when converting from one pixel format to another.
4320 * @param[in] dst_pix_fmt destination pixel format
4321 * @param[in] src_pix_fmt source pixel format
4322 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4323 * @return Combination of flags informing you what kind of losses will occur.
4325 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4328 #if FF_API_FIND_BEST_PIX_FMT
4330 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4332 * Find the best pixel format to convert to given a certain source pixel
4333 * format. When converting from one pixel format to another, information loss
4334 * may occur. For example, when converting from RGB24 to GRAY, the color
4335 * information will be lost. Similarly, other losses occur when converting from
4336 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4337 * the given pixel formats should be used to suffer the least amount of loss.
4338 * The pixel formats from which it chooses one, are determined by the
4339 * pix_fmt_mask parameter.
4342 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4343 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) || (1 << AV_PIX_FMT_RGB24);
4344 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4347 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4348 * @param[in] src_pix_fmt source pixel format
4349 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4350 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4351 * @return The best pixel format to convert to or -1 if none was found.
4353 attribute_deprecated
4354 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4355 int has_alpha, int *loss_ptr);
4356 #endif /* FF_API_FIND_BEST_PIX_FMT */
4359 * Find the best pixel format to convert to given a certain source pixel
4360 * format. When converting from one pixel format to another, information loss
4361 * may occur. For example, when converting from RGB24 to GRAY, the color
4362 * information will be lost. Similarly, other losses occur when converting from
4363 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4364 * the given pixel formats should be used to suffer the least amount of loss.
4365 * The pixel formats from which it chooses one, are determined by the
4366 * pix_fmt_list parameter.
4369 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4370 * @param[in] src_pix_fmt source pixel format
4371 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4372 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4373 * @return The best pixel format to convert to or -1 if none was found.
4375 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4376 enum AVPixelFormat src_pix_fmt,
4377 int has_alpha, int *loss_ptr);
4379 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4385 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4388 * Put a string representing the codec tag codec_tag in buf.
4390 * @param buf_size size in bytes of buf
4391 * @return the length of the string that would have been generated if
4392 * enough space had been available, excluding the trailing null
4394 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4396 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4399 * Return a name for the specified profile, if available.
4401 * @param codec the codec that is searched for the given profile
4402 * @param profile the profile value for which a name is requested
4403 * @return A name for the profile if found, NULL otherwise.
4405 const char *av_get_profile_name(const AVCodec *codec, int profile);
4407 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4408 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4409 //FIXME func typedef
4412 * Fill audio frame data and linesize.
4413 * AVFrame extended_data channel pointers are allocated if necessary for
4416 * @param frame the AVFrame
4417 * frame->nb_samples must be set prior to calling the
4418 * function. This function fills in frame->data,
4419 * frame->extended_data, frame->linesize[0].
4420 * @param nb_channels channel count
4421 * @param sample_fmt sample format
4422 * @param buf buffer to use for frame data
4423 * @param buf_size size of buffer
4424 * @param align plane size sample alignment (0 = default)
4425 * @return 0 on success, negative error code on failure
4427 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4428 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4429 int buf_size, int align);
4432 * Flush buffers, should be called when seeking or when switching to a different stream.
4434 void avcodec_flush_buffers(AVCodecContext *avctx);
4436 void avcodec_default_free_buffers(AVCodecContext *s);
4439 * Return codec bits per sample.
4441 * @param[in] codec_id the codec
4442 * @return Number of bits per sample or zero if unknown for the given codec.
4444 int av_get_bits_per_sample(enum AVCodecID codec_id);
4447 * Return codec bits per sample.
4448 * Only return non-zero if the bits per sample is exactly correct, not an
4451 * @param[in] codec_id the codec
4452 * @return Number of bits per sample or zero if unknown for the given codec.
4454 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4457 * Return audio frame duration.
4459 * @param avctx codec context
4460 * @param frame_bytes size of the frame, or 0 if unknown
4461 * @return frame duration, in samples, if known. 0 if not able to
4464 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4467 typedef struct AVBitStreamFilterContext {
4469 struct AVBitStreamFilter *filter;
4470 AVCodecParserContext *parser;
4471 struct AVBitStreamFilterContext *next;
4472 } AVBitStreamFilterContext;
4475 typedef struct AVBitStreamFilter {
4478 int (*filter)(AVBitStreamFilterContext *bsfc,
4479 AVCodecContext *avctx, const char *args,
4480 uint8_t **poutbuf, int *poutbuf_size,
4481 const uint8_t *buf, int buf_size, int keyframe);
4482 void (*close)(AVBitStreamFilterContext *bsfc);
4483 struct AVBitStreamFilter *next;
4484 } AVBitStreamFilter;
4486 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4487 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4488 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4489 AVCodecContext *avctx, const char *args,
4490 uint8_t **poutbuf, int *poutbuf_size,
4491 const uint8_t *buf, int buf_size, int keyframe);
4492 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4494 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4499 * Reallocate the given block if it is not large enough, otherwise do nothing.
4503 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4506 * Allocate a buffer, reusing the given one if large enough.
4508 * Contrary to av_fast_realloc the current buffer contents might not be
4509 * preserved and on error the old buffer is freed, thus no special
4510 * handling to avoid memleaks is necessary.
4512 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4513 * @param size size of the buffer *ptr points to
4514 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4515 * *size 0 if an error occurred.
4517 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4520 * Allocate a buffer with padding, reusing the given one if large enough.
4522 * Same behaviour av_fast_malloc but the buffer has additional
4523 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4526 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4529 * Encode extradata length to a buffer. Used by xiph codecs.
4531 * @param s buffer to write to; must be at least (v/255+1) bytes long
4532 * @param v size of extradata in bytes
4533 * @return number of bytes written to the buffer.
4535 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4538 * Log a generic warning message about a missing feature. This function is
4539 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4540 * only, and would normally not be used by applications.
4541 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4542 * a pointer to an AVClass struct
4543 * @param[in] feature string containing the name of the missing feature
4544 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4545 * If want_sample is non-zero, additional verbage will be added to the log
4546 * message which tells the user how to report samples to the development
4549 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4552 * Log a generic warning message asking for a sample. This function is
4553 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4554 * only, and would normally not be used by applications.
4555 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4556 * a pointer to an AVClass struct
4557 * @param[in] msg string containing an optional message, or NULL if no message
4559 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4562 * Register the hardware accelerator hwaccel.
4564 void av_register_hwaccel(AVHWAccel *hwaccel);
4567 * If hwaccel is NULL, returns the first registered hardware accelerator,
4568 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4569 * after hwaccel, or NULL if hwaccel is the last one.
4571 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4575 * Lock operation used by lockmgr
4578 AV_LOCK_CREATE, ///< Create a mutex
4579 AV_LOCK_OBTAIN, ///< Lock the mutex
4580 AV_LOCK_RELEASE, ///< Unlock the mutex
4581 AV_LOCK_DESTROY, ///< Free mutex resources
4585 * Register a user provided lock manager supporting the operations
4586 * specified by AVLockOp. mutex points to a (void *) where the
4587 * lockmgr should store/get a pointer to a user allocated mutex. It's
4588 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4590 * @param cb User defined callback. Note: Libav may invoke calls to this
4591 * callback during the call to av_lockmgr_register().
4592 * Thus, the application must be prepared to handle that.
4593 * If cb is set to NULL the lockmgr will be unregistered.
4594 * Also note that during unregistration the previously registered
4595 * lockmgr callback may also be invoked.
4597 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4600 * Get the type of the given codec.
4602 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4605 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4606 * with no corresponding avcodec_close()), 0 otherwise.
4608 int avcodec_is_open(AVCodecContext *s);
4611 * @return a non-zero number if codec is an encoder, zero otherwise
4613 int av_codec_is_encoder(const AVCodec *codec);
4616 * @return a non-zero number if codec is a decoder, zero otherwise
4618 int av_codec_is_decoder(const AVCodec *codec);
4621 * @return descriptor for given codec ID or NULL if no descriptor exists.
4623 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4626 * Iterate over all codec descriptors known to libavcodec.
4628 * @param prev previous descriptor. NULL to get the first descriptor.
4630 * @return next descriptor or NULL after the last descriptor
4632 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4635 * @return codec descriptor with the given name or NULL if no such descriptor
4638 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4644 #endif /* AVCODEC_AVCODEC_H */