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,
875 typedef struct AVPacket {
877 * Presentation timestamp in AVStream->time_base units; the time at which
878 * the decompressed packet will be presented to the user.
879 * Can be AV_NOPTS_VALUE if it is not stored in the file.
880 * pts MUST be larger or equal to dts as presentation cannot happen before
881 * decompression, unless one wants to view hex dumps. Some formats misuse
882 * the terms dts and pts/cts to mean something different. Such timestamps
883 * must be converted to true pts/dts before they are stored in AVPacket.
887 * Decompression timestamp in AVStream->time_base units; the time at which
888 * the packet is decompressed.
889 * Can be AV_NOPTS_VALUE if it is not stored in the file.
896 * A combination of AV_PKT_FLAG values
900 * Additional packet data that can be provided by the container.
901 * Packet can contain several types of side information.
906 enum AVPacketSideDataType type;
911 * Duration of this packet in AVStream->time_base units, 0 if unknown.
912 * Equals next_pts - this_pts in presentation order.
915 void (*destruct)(struct AVPacket *);
917 int64_t pos; ///< byte position in stream, -1 if unknown
920 * Time difference in AVStream->time_base units from the pts of this
921 * packet to the point at which the output from the decoder has converged
922 * independent from the availability of previous frames. That is, the
923 * frames are virtually identical no matter if decoding started from
924 * the very first frame or from this keyframe.
925 * Is AV_NOPTS_VALUE if unknown.
926 * This field is not the display duration of the current packet.
927 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
930 * The purpose of this field is to allow seeking in streams that have no
931 * keyframes in the conventional sense. It corresponds to the
932 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
933 * essential for some types of subtitle streams to ensure that all
934 * subtitles are correctly displayed after seeking.
936 int64_t convergence_duration;
938 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
939 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
941 enum AVSideDataParamChangeFlags {
942 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
943 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
944 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
945 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
953 * New fields can be added to the end of AVFRAME with minor version
954 * bumps. Removal, reordering and changes to existing fields require
955 * a major version bump.
956 * sizeof(AVFrame) must not be used outside libav*.
958 typedef struct AVFrame {
959 #define AV_NUM_DATA_POINTERS 8
961 * pointer to the picture/channel planes.
962 * This might be different from the first allocated byte
963 * - encoding: Set by user
964 * - decoding: set by AVCodecContext.get_buffer()
966 uint8_t *data[AV_NUM_DATA_POINTERS];
969 * Size, in bytes, of the data for each picture/channel plane.
971 * For audio, only linesize[0] may be set. For planar audio, each channel
972 * plane must be the same size.
974 * - encoding: Set by user
975 * - decoding: set by AVCodecContext.get_buffer()
977 int linesize[AV_NUM_DATA_POINTERS];
980 * pointers to the data planes/channels.
982 * For video, this should simply point to data[].
984 * For planar audio, each channel has a separate data pointer, and
985 * linesize[0] contains the size of each channel buffer.
986 * For packed audio, there is just one data pointer, and linesize[0]
987 * contains the total size of the buffer for all channels.
989 * Note: Both data and extended_data will always be set by get_buffer(),
990 * but for planar audio with more channels that can fit in data,
991 * extended_data must be used by the decoder in order to access all
994 * encoding: set by user
995 * decoding: set by AVCodecContext.get_buffer()
997 uint8_t **extended_data;
1000 * width and height of the video frame
1001 * - encoding: unused
1002 * - decoding: Read by user.
1007 * number of audio samples (per channel) described by this frame
1008 * - encoding: Set by user
1009 * - decoding: Set by libavcodec
1014 * format of the frame, -1 if unknown or unset
1015 * Values correspond to enum AVPixelFormat for video frames,
1016 * enum AVSampleFormat for audio)
1017 * - encoding: unused
1018 * - decoding: Read by user.
1023 * 1 -> keyframe, 0-> not
1024 * - encoding: Set by libavcodec.
1025 * - decoding: Set by libavcodec.
1030 * Picture type of the frame, see ?_TYPE below.
1031 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1032 * - decoding: Set by libavcodec.
1034 enum AVPictureType pict_type;
1037 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1038 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1042 uint8_t *base[AV_NUM_DATA_POINTERS];
1045 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1046 * - encoding: unused
1047 * - decoding: Read by user.
1049 AVRational sample_aspect_ratio;
1052 * presentation timestamp in time_base units (time when frame should be shown to user)
1053 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1054 * - encoding: MUST be set by user.
1055 * - decoding: Set by libavcodec.
1060 * reordered pts from the last AVPacket that has been input into the decoder
1061 * - encoding: unused
1062 * - decoding: Read by user.
1067 * dts from the last AVPacket that has been input into the decoder
1068 * - encoding: unused
1069 * - decoding: Read by user.
1074 * picture number in bitstream order
1075 * - encoding: set by
1076 * - decoding: Set by libavcodec.
1078 int coded_picture_number;
1080 * picture number in display order
1081 * - encoding: set by
1082 * - decoding: Set by libavcodec.
1084 int display_picture_number;
1087 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1088 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1089 * - decoding: Set by libavcodec.
1094 * is this picture used as reference
1095 * The values for this are the same as the MpegEncContext.picture_structure
1096 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1097 * Set to 4 for delayed, non-reference frames.
1098 * - encoding: unused
1099 * - decoding: Set by libavcodec. (before get_buffer() call)).
1105 * - encoding: unused
1106 * - decoding: Set by libavcodec.
1108 int8_t *qscale_table;
1111 * - encoding: unused
1112 * - decoding: Set by libavcodec.
1122 * mbskip_table[mb]>=1 if MB didn't change
1123 * stride= mb_width = (width+15)>>4
1124 * - encoding: unused
1125 * - decoding: Set by libavcodec.
1127 uint8_t *mbskip_table;
1130 * motion vector table
1133 * int mv_sample_log2= 4 - motion_subsample_log2;
1134 * int mb_width= (width+15)>>4;
1135 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1136 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1138 * - encoding: Set by user.
1139 * - decoding: Set by libavcodec.
1141 int16_t (*motion_val[2])[2];
1144 * macroblock type table
1145 * mb_type_base + mb_width + 2
1146 * - encoding: Set by user.
1147 * - decoding: Set by libavcodec.
1153 * - encoding: unused
1154 * - decoding: Set by libavcodec.
1159 * motion reference frame index
1160 * the order in which these are stored can depend on the codec.
1161 * - encoding: Set by user.
1162 * - decoding: Set by libavcodec.
1164 int8_t *ref_index[2];
1167 * for some private data of the user
1168 * - encoding: unused
1169 * - decoding: Set by user.
1175 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1176 * - decoding: unused
1178 uint64_t error[AV_NUM_DATA_POINTERS];
1181 * type of the buffer (to keep track of who has to deallocate data[*])
1182 * - encoding: Set by the one who allocates it.
1183 * - decoding: Set by the one who allocates it.
1184 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1189 * When decoding, this signals how much the picture must be delayed.
1190 * extra_delay = repeat_pict / (2*fps)
1191 * - encoding: unused
1192 * - decoding: Set by libavcodec.
1197 * The content of the picture is interlaced.
1198 * - encoding: Set by user.
1199 * - decoding: Set by libavcodec. (default 0)
1201 int interlaced_frame;
1204 * If the content is interlaced, is top field displayed first.
1205 * - encoding: Set by user.
1206 * - decoding: Set by libavcodec.
1208 int top_field_first;
1211 * Tell user application that palette has changed from previous frame.
1212 * - encoding: ??? (no palette-enabled encoder yet)
1213 * - decoding: Set by libavcodec. (default 0).
1215 int palette_has_changed;
1218 * codec suggestion on buffer type if != 0
1219 * - encoding: unused
1220 * - decoding: Set by libavcodec. (before get_buffer() call)).
1226 * - encoding: Set by user.
1227 * - decoding: Set by libavcodec.
1229 AVPanScan *pan_scan;
1232 * reordered opaque 64bit (generally an integer or a double precision float
1233 * PTS but can be anything).
1234 * The user sets AVCodecContext.reordered_opaque to represent the input at
1236 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1237 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1238 * @deprecated in favor of pkt_pts
1239 * - encoding: unused
1240 * - decoding: Read by user.
1242 int64_t reordered_opaque;
1245 * hardware accelerator private data (Libav-allocated)
1246 * - encoding: unused
1247 * - decoding: Set by libavcodec
1249 void *hwaccel_picture_private;
1252 * the AVCodecContext which ff_thread_get_buffer() was last called on
1253 * - encoding: Set by libavcodec.
1254 * - decoding: Set by libavcodec.
1256 struct AVCodecContext *owner;
1259 * used by multithreading to store frame-specific info
1260 * - encoding: Set by libavcodec.
1261 * - decoding: Set by libavcodec.
1263 void *thread_opaque;
1266 * log2 of the size of the block which a single vector in motion_val represents:
1267 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1268 * - encoding: unused
1269 * - decoding: Set by libavcodec.
1271 uint8_t motion_subsample_log2;
1274 * Sample rate of the audio data.
1276 * - encoding: unused
1277 * - decoding: set by get_buffer()
1282 * Channel layout of the audio data.
1284 * - encoding: unused
1285 * - decoding: set by get_buffer()
1287 uint64_t channel_layout;
1290 struct AVCodecInternal;
1294 AV_FIELD_PROGRESSIVE,
1295 AV_FIELD_TT, //< Top coded_first, top displayed first
1296 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1297 AV_FIELD_TB, //< Top coded first, bottom displayed first
1298 AV_FIELD_BT, //< Bottom coded first, top displayed first
1302 * main external API structure.
1303 * New fields can be added to the end with minor version bumps.
1304 * Removal, reordering and changes to existing fields require a major
1306 * sizeof(AVCodecContext) must not be used outside libav*.
1308 typedef struct AVCodecContext {
1310 * information on struct for av_log
1311 * - set by avcodec_alloc_context3
1313 const AVClass *av_class;
1314 int log_level_offset;
1316 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1317 const struct AVCodec *codec;
1318 char codec_name[32];
1319 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1322 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1323 * This is used to work around some encoder bugs.
1324 * A demuxer should set this to what is stored in the field used to identify the codec.
1325 * If there are multiple such fields in a container then the demuxer should choose the one
1326 * which maximizes the information about the used codec.
1327 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1328 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1329 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1331 * - encoding: Set by user, if not then the default based on codec_id will be used.
1332 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1334 unsigned int codec_tag;
1337 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1338 * This is used to work around some encoder bugs.
1339 * - encoding: unused
1340 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1342 unsigned int stream_codec_tag;
1346 * @deprecated this field is unused
1348 attribute_deprecated int sub_id;
1354 * Private context used for internal data.
1356 * Unlike priv_data, this is not codec-specific. It is used in general
1357 * libavcodec functions.
1359 struct AVCodecInternal *internal;
1362 * Private data of the user, can be used to carry app specific stuff.
1363 * - encoding: Set by user.
1364 * - decoding: Set by user.
1369 * the average bitrate
1370 * - encoding: Set by user; unused for constant quantizer encoding.
1371 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1376 * number of bits the bitstream is allowed to diverge from the reference.
1377 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1378 * - encoding: Set by user; unused for constant quantizer encoding.
1379 * - decoding: unused
1381 int bit_rate_tolerance;
1384 * Global quality for codecs which cannot change it per frame.
1385 * This should be proportional to MPEG-1/2/4 qscale.
1386 * - encoding: Set by user.
1387 * - decoding: unused
1392 * - encoding: Set by user.
1393 * - decoding: unused
1395 int compression_level;
1396 #define FF_COMPRESSION_DEFAULT -1
1400 * - encoding: Set by user.
1401 * - decoding: Set by user.
1407 * - encoding: Set by user.
1408 * - decoding: Set by user.
1413 * some codecs need / can use extradata like Huffman tables.
1414 * mjpeg: Huffman tables
1415 * rv10: additional flags
1416 * mpeg4: global headers (they can be in the bitstream or here)
1417 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1418 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1419 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1420 * - encoding: Set/allocated/freed by libavcodec.
1421 * - decoding: Set/allocated/freed by user.
1427 * This is the fundamental unit of time (in seconds) in terms
1428 * of which frame timestamps are represented. For fixed-fps content,
1429 * timebase should be 1/framerate and timestamp increments should be
1431 * - encoding: MUST be set by user.
1432 * - decoding: Set by libavcodec.
1434 AVRational time_base;
1437 * For some codecs, the time base is closer to the field rate than the frame rate.
1438 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1439 * if no telecine is used ...
1441 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1443 int ticks_per_frame;
1449 * Number of frames the decoded output will be delayed relative to the
1453 * For encoding, this is the number of "priming" samples added to the
1454 * beginning of the stream. The decoded output will be delayed by this
1455 * many samples relative to the input to the encoder. Note that this
1456 * field is purely informational and does not directly affect the pts
1457 * output by the encoder, which should always be based on the actual
1458 * presentation time, including any delay.
1459 * For decoding, this is the number of samples the decoder needs to
1460 * output before the decoder's output is valid. When seeking, you should
1461 * start decoding this many samples prior to your desired seek point.
1463 * - encoding: Set by libavcodec.
1464 * - decoding: Set by libavcodec.
1471 * picture width / height.
1472 * - encoding: MUST be set by user.
1473 * - decoding: Set by libavcodec.
1474 * Note: For compatibility it is possible to set this instead of
1475 * coded_width/height before decoding.
1480 * Bitstream width / height, may be different from width/height.
1481 * - encoding: unused
1482 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1484 int coded_width, coded_height;
1486 #define FF_ASPECT_EXTENDED 15
1489 * the number of pictures in a group of pictures, or 0 for intra_only
1490 * - encoding: Set by user.
1491 * - decoding: unused
1496 * Pixel format, see AV_PIX_FMT_xxx.
1497 * May be set by the demuxer if known from headers.
1498 * May be overriden by the decoder if it knows better.
1499 * - encoding: Set by user.
1500 * - decoding: Set by user if known, overridden by libavcodec if known
1502 enum AVPixelFormat pix_fmt;
1505 * Motion estimation algorithm used for video coding.
1506 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1507 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1508 * - encoding: MUST be set by user.
1509 * - decoding: unused
1514 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1515 * decoder to draw a horizontal band. It improves cache usage. Not
1516 * all codecs can do that. You must check the codec capabilities
1518 * When multithreading is used, it may be called from multiple threads
1519 * at the same time; threads might draw different parts of the same AVFrame,
1520 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1522 * The function is also used by hardware acceleration APIs.
1523 * It is called at least once during frame decoding to pass
1524 * the data needed for hardware render.
1525 * In that mode instead of pixel data, AVFrame points to
1526 * a structure specific to the acceleration API. The application
1527 * reads the structure and can change some fields to indicate progress
1529 * - encoding: unused
1530 * - decoding: Set by user.
1531 * @param height the height of the slice
1532 * @param y the y position of the slice
1533 * @param type 1->top field, 2->bottom field, 3->frame
1534 * @param offset offset into the AVFrame.data from which the slice should be read
1536 void (*draw_horiz_band)(struct AVCodecContext *s,
1537 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1538 int y, int type, int height);
1541 * callback to negotiate the pixelFormat
1542 * @param fmt is the list of formats which are supported by the codec,
1543 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1544 * The first is always the native one.
1545 * @return the chosen format
1546 * - encoding: unused
1547 * - decoding: Set by user, if not set the native format will be chosen.
1549 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1552 * maximum number of B-frames between non-B-frames
1553 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1554 * - encoding: Set by user.
1555 * - decoding: unused
1560 * qscale factor between IP and B-frames
1561 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1562 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1563 * - encoding: Set by user.
1564 * - decoding: unused
1566 float b_quant_factor;
1568 /** obsolete FIXME remove */
1570 #define FF_RC_STRATEGY_XVID 1
1572 int b_frame_strategy;
1574 #if FF_API_MPV_GLOBAL_OPTS
1576 * luma single coefficient elimination threshold
1577 * - encoding: Set by user.
1578 * - decoding: unused
1580 attribute_deprecated int luma_elim_threshold;
1583 * chroma single coeff elimination threshold
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 attribute_deprecated int chroma_elim_threshold;
1591 * qscale offset between IP and B-frames
1592 * - encoding: Set by user.
1593 * - decoding: unused
1595 float b_quant_offset;
1598 * Size of the frame reordering buffer in the decoder.
1599 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1600 * - encoding: Set by libavcodec.
1601 * - decoding: Set by libavcodec.
1606 * 0-> h263 quant 1-> mpeg quant
1607 * - encoding: Set by user.
1608 * - decoding: unused
1613 * qscale factor between P and I-frames
1614 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1615 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1616 * - encoding: Set by user.
1617 * - decoding: unused
1619 float i_quant_factor;
1622 * qscale offset between P and I-frames
1623 * - encoding: Set by user.
1624 * - decoding: unused
1626 float i_quant_offset;
1629 * luminance masking (0-> disabled)
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * temporary complexity masking (0-> disabled)
1637 * - encoding: Set by user.
1638 * - decoding: unused
1640 float temporal_cplx_masking;
1643 * spatial complexity masking (0-> disabled)
1644 * - encoding: Set by user.
1645 * - decoding: unused
1647 float spatial_cplx_masking;
1650 * p block masking (0-> disabled)
1651 * - encoding: Set by user.
1652 * - decoding: unused
1657 * darkness masking (0-> disabled)
1658 * - encoding: Set by user.
1659 * - decoding: unused
1665 * - encoding: Set by libavcodec.
1666 * - decoding: Set by user (or 0).
1670 * prediction method (needed for huffyuv)
1671 * - encoding: Set by user.
1672 * - decoding: unused
1674 int prediction_method;
1675 #define FF_PRED_LEFT 0
1676 #define FF_PRED_PLANE 1
1677 #define FF_PRED_MEDIAN 2
1680 * slice offsets in the frame in bytes
1681 * - encoding: Set/allocated by libavcodec.
1682 * - decoding: Set/allocated by user (or NULL).
1687 * sample aspect ratio (0 if unknown)
1688 * That is the width of a pixel divided by the height of the pixel.
1689 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1690 * - encoding: Set by user.
1691 * - decoding: Set by libavcodec.
1693 AVRational sample_aspect_ratio;
1696 * motion estimation comparison function
1697 * - encoding: Set by user.
1698 * - decoding: unused
1702 * subpixel motion estimation comparison function
1703 * - encoding: Set by user.
1704 * - decoding: unused
1708 * macroblock comparison function (not supported yet)
1709 * - encoding: Set by user.
1710 * - decoding: unused
1714 * interlaced DCT comparison function
1715 * - encoding: Set by user.
1716 * - decoding: unused
1719 #define FF_CMP_SAD 0
1720 #define FF_CMP_SSE 1
1721 #define FF_CMP_SATD 2
1722 #define FF_CMP_DCT 3
1723 #define FF_CMP_PSNR 4
1724 #define FF_CMP_BIT 5
1726 #define FF_CMP_ZERO 7
1727 #define FF_CMP_VSAD 8
1728 #define FF_CMP_VSSE 9
1729 #define FF_CMP_NSSE 10
1730 #define FF_CMP_W53 11
1731 #define FF_CMP_W97 12
1732 #define FF_CMP_DCTMAX 13
1733 #define FF_CMP_DCT264 14
1734 #define FF_CMP_CHROMA 256
1737 * ME diamond size & shape
1738 * - encoding: Set by user.
1739 * - decoding: unused
1744 * amount of previous MV predictors (2a+1 x 2a+1 square)
1745 * - encoding: Set by user.
1746 * - decoding: unused
1748 int last_predictor_count;
1751 * prepass for motion estimation
1752 * - encoding: Set by user.
1753 * - decoding: unused
1758 * motion estimation prepass comparison function
1759 * - encoding: Set by user.
1760 * - decoding: unused
1765 * ME prepass diamond size & shape
1766 * - encoding: Set by user.
1767 * - decoding: unused
1773 * - encoding: Set by user.
1774 * - decoding: unused
1776 int me_subpel_quality;
1779 * DTG active format information (additional aspect ratio
1780 * information only used in DVB MPEG-2 transport streams)
1783 * - encoding: unused
1784 * - decoding: Set by decoder.
1786 int dtg_active_format;
1787 #define FF_DTG_AFD_SAME 8
1788 #define FF_DTG_AFD_4_3 9
1789 #define FF_DTG_AFD_16_9 10
1790 #define FF_DTG_AFD_14_9 11
1791 #define FF_DTG_AFD_4_3_SP_14_9 13
1792 #define FF_DTG_AFD_16_9_SP_14_9 14
1793 #define FF_DTG_AFD_SP_4_3 15
1796 * maximum motion estimation search range in subpel units
1797 * If 0 then no limit.
1799 * - encoding: Set by user.
1800 * - decoding: unused
1805 * intra quantizer bias
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 int intra_quant_bias;
1810 #define FF_DEFAULT_QUANT_BIAS 999999
1813 * inter quantizer bias
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 int inter_quant_bias;
1819 #if FF_API_COLOR_TABLE_ID
1822 * - encoding: unused
1823 * - decoding: Which clrtable should be used for 8bit RGB images.
1824 * Tables have to be stored somewhere. FIXME
1826 attribute_deprecated int color_table_id;
1831 * - encoding: unused
1832 * - decoding: Set by user.
1835 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1836 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1837 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1840 * XVideo Motion Acceleration
1841 * - encoding: forbidden
1842 * - decoding: set by decoder
1844 int xvmc_acceleration;
1847 * macroblock decision mode
1848 * - encoding: Set by user.
1849 * - decoding: unused
1852 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1853 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1854 #define FF_MB_DECISION_RD 2 ///< rate distortion
1857 * custom intra quantization matrix
1858 * - encoding: Set by user, can be NULL.
1859 * - decoding: Set by libavcodec.
1861 uint16_t *intra_matrix;
1864 * custom inter quantization matrix
1865 * - encoding: Set by user, can be NULL.
1866 * - decoding: Set by libavcodec.
1868 uint16_t *inter_matrix;
1871 * scene change detection threshold
1872 * 0 is default, larger means fewer detected scene changes.
1873 * - encoding: Set by user.
1874 * - decoding: unused
1876 int scenechange_threshold;
1879 * noise reduction strength
1880 * - encoding: Set by user.
1881 * - decoding: unused
1883 int noise_reduction;
1885 #if FF_API_INTER_THRESHOLD
1887 * @deprecated this field is unused
1889 attribute_deprecated int inter_threshold;
1892 #if FF_API_MPV_GLOBAL_OPTS
1894 * @deprecated use mpegvideo private options instead
1896 attribute_deprecated int quantizer_noise_shaping;
1900 * Motion estimation threshold below which no motion estimation is
1901 * performed, but instead the user specified motion vectors are used.
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * Macroblock threshold below which the user specified macroblock types will be used.
1910 * - encoding: Set by user.
1911 * - decoding: unused
1916 * precision of the intra DC coefficient - 8
1917 * - encoding: Set by user.
1918 * - decoding: unused
1920 int intra_dc_precision;
1923 * Number of macroblock rows at the top which are skipped.
1924 * - encoding: unused
1925 * - decoding: Set by user.
1930 * Number of macroblock rows at the bottom which are skipped.
1931 * - encoding: unused
1932 * - decoding: Set by user.
1937 * Border processing masking, raises the quantizer for mbs on the borders
1939 * - encoding: Set by user.
1940 * - decoding: unused
1942 float border_masking;
1945 * minimum MB lagrange multipler
1946 * - encoding: Set by user.
1947 * - decoding: unused
1952 * maximum MB lagrange multipler
1953 * - encoding: Set by user.
1954 * - decoding: unused
1960 * - encoding: Set by user.
1961 * - decoding: unused
1963 int me_penalty_compensation;
1967 * - encoding: Set by user.
1968 * - decoding: unused
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1987 * number of reference frames
1988 * - encoding: Set by user.
1989 * - decoding: Set by lavc.
1994 * chroma qp offset from luma
1995 * - encoding: Set by user.
1996 * - decoding: unused
2001 * Multiplied by qscale for each frame and added to scene_change_score.
2002 * - encoding: Set by user.
2003 * - decoding: unused
2005 int scenechange_factor;
2009 * Note: Value depends upon the compare function used for fullpel ME.
2010 * - encoding: Set by user.
2011 * - decoding: unused
2016 * Adjust sensitivity of b_frame_strategy 1.
2017 * - encoding: Set by user.
2018 * - decoding: unused
2023 * Chromaticity coordinates of the source primaries.
2024 * - encoding: Set by user
2025 * - decoding: Set by libavcodec
2027 enum AVColorPrimaries color_primaries;
2030 * Color Transfer Characteristic.
2031 * - encoding: Set by user
2032 * - decoding: Set by libavcodec
2034 enum AVColorTransferCharacteristic color_trc;
2037 * YUV colorspace type.
2038 * - encoding: Set by user
2039 * - decoding: Set by libavcodec
2041 enum AVColorSpace colorspace;
2044 * MPEG vs JPEG YUV range.
2045 * - encoding: Set by user
2046 * - decoding: Set by libavcodec
2048 enum AVColorRange color_range;
2051 * This defines the location of chroma samples.
2052 * - encoding: Set by user
2053 * - decoding: Set by libavcodec
2055 enum AVChromaLocation chroma_sample_location;
2059 * Indicates number of picture subdivisions. Used for parallelized
2061 * - encoding: Set by user
2062 * - decoding: unused
2067 * - encoding: set by libavcodec
2068 * - decoding: Set by libavcodec
2070 enum AVFieldOrder field_order;
2073 int sample_rate; ///< samples per second
2074 int channels; ///< number of audio channels
2077 * audio sample format
2078 * - encoding: Set by user.
2079 * - decoding: Set by libavcodec.
2081 enum AVSampleFormat sample_fmt; ///< sample format
2083 /* The following data should not be initialized. */
2085 * Number of samples per channel in an audio frame.
2087 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2088 * except the last must contain exactly frame_size samples per channel.
2089 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2090 * frame size is not restricted.
2091 * - decoding: may be set by some decoders to indicate constant frame size
2096 * Frame counter, set by libavcodec.
2098 * - decoding: total number of frames returned from the decoder so far.
2099 * - encoding: total number of frames passed to the encoder so far.
2101 * @note the counter is not incremented if encoding/decoding resulted in
2107 * number of bytes per packet if constant and known or 0
2108 * Used by some WAV based audio codecs.
2113 * Audio cutoff bandwidth (0 means "automatic")
2114 * - encoding: Set by user.
2115 * - decoding: unused
2119 #if FF_API_REQUEST_CHANNELS
2121 * Decoder should decode to this many channels if it can (0 for default)
2122 * - encoding: unused
2123 * - decoding: Set by user.
2124 * @deprecated Deprecated in favor of request_channel_layout.
2126 int request_channels;
2130 * Audio channel layout.
2131 * - encoding: set by user.
2132 * - decoding: set by libavcodec.
2134 uint64_t channel_layout;
2137 * Request decoder to use this channel layout if it can (0 for default)
2138 * - encoding: unused
2139 * - decoding: Set by user.
2141 uint64_t request_channel_layout;
2144 * Type of service that the audio stream conveys.
2145 * - encoding: Set by user.
2146 * - decoding: Set by libavcodec.
2148 enum AVAudioServiceType audio_service_type;
2151 * Used to request a sample format from the decoder.
2152 * - encoding: unused.
2153 * - decoding: Set by user.
2155 enum AVSampleFormat request_sample_fmt;
2158 * Called at the beginning of each frame to get a buffer for it.
2160 * The function will set AVFrame.data[], AVFrame.linesize[].
2161 * AVFrame.extended_data[] must also be set, but it should be the same as
2162 * AVFrame.data[] except for planar audio with more channels than can fit
2163 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2164 * many data pointers as it can hold.
2166 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2167 * avcodec_default_get_buffer() instead of providing buffers allocated by
2170 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2171 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2172 * but if get_buffer() is overridden then alignment considerations should
2173 * be taken into account.
2175 * @see avcodec_default_get_buffer()
2179 * If pic.reference is set then the frame will be read later by libavcodec.
2180 * avcodec_align_dimensions2() should be used to find the required width and
2181 * height, as they normally need to be rounded up to the next multiple of 16.
2183 * If frame multithreading is used and thread_safe_callbacks is set,
2184 * it may be called from a different thread, but not from more than one at
2185 * once. Does not need to be reentrant.
2187 * @see release_buffer(), reget_buffer()
2188 * @see avcodec_align_dimensions2()
2192 * Decoders request a buffer of a particular size by setting
2193 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2194 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2195 * to a smaller value in the output frame.
2197 * Decoders cannot use the buffer after returning from
2198 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2199 * is assumed to be released immediately upon return.
2201 * As a convenience, av_samples_get_buffer_size() and
2202 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2203 * functions to find the required data size and to fill data pointers and
2204 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2205 * since all planes must be the same size.
2207 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2209 * - encoding: unused
2210 * - decoding: Set by libavcodec, user can override.
2212 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2215 * Called to release buffers which were allocated with get_buffer.
2216 * A released buffer can be reused in get_buffer().
2217 * pic.data[*] must be set to NULL.
2218 * May be called from a different thread if frame multithreading is used,
2219 * but not by more than one thread at once, so does not need to be reentrant.
2220 * - encoding: unused
2221 * - decoding: Set by libavcodec, user can override.
2223 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2226 * Called at the beginning of a frame to get cr buffer for it.
2227 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2228 * libavcodec will pass previous buffer in pic, function should return
2229 * same buffer or new buffer with old frame "painted" into it.
2230 * If pic.data[0] == NULL must behave like get_buffer().
2231 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2232 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2234 * - encoding: unused
2235 * - decoding: Set by libavcodec, user can override.
2237 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2240 /* - encoding parameters */
2241 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2242 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2246 * - encoding: Set by user.
2247 * - decoding: unused
2253 * - encoding: Set by user.
2254 * - decoding: unused
2259 * maximum quantizer difference between frames
2260 * - encoding: Set by user.
2261 * - decoding: unused
2266 * ratecontrol qmin qmax limiting method
2267 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2268 * - encoding: Set by user.
2269 * - decoding: unused
2277 * decoder bitstream buffer size
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * ratecontrol override, see RcOverride
2285 * - encoding: Allocated/set/freed by user.
2286 * - decoding: unused
2288 int rc_override_count;
2289 RcOverride *rc_override;
2292 * rate control equation
2293 * - encoding: Set by user
2294 * - decoding: unused
2300 * - encoding: Set by user.
2301 * - decoding: unused
2307 * - encoding: Set by user.
2308 * - decoding: unused
2312 float rc_buffer_aggressivity;
2315 * initial complexity for pass1 ratecontrol
2316 * - encoding: Set by user.
2317 * - decoding: unused
2319 float rc_initial_cplx;
2322 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2323 * - encoding: Set by user.
2324 * - decoding: unused.
2326 float rc_max_available_vbv_use;
2329 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2330 * - encoding: Set by user.
2331 * - decoding: unused.
2333 float rc_min_vbv_overflow_use;
2336 * Number of bits which should be loaded into the rc buffer before decoding starts.
2337 * - encoding: Set by user.
2338 * - decoding: unused
2340 int rc_initial_buffer_occupancy;
2342 #define FF_CODER_TYPE_VLC 0
2343 #define FF_CODER_TYPE_AC 1
2344 #define FF_CODER_TYPE_RAW 2
2345 #define FF_CODER_TYPE_RLE 3
2346 #define FF_CODER_TYPE_DEFLATE 4
2349 * - encoding: Set by user.
2350 * - decoding: unused
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * minimum Lagrange multipler
2363 * - encoding: Set by user.
2364 * - decoding: unused
2369 * maximum Lagrange multipler
2370 * - encoding: Set by user.
2371 * - decoding: unused
2376 * frame skip threshold
2377 * - encoding: Set by user.
2378 * - decoding: unused
2380 int frame_skip_threshold;
2384 * - encoding: Set by user.
2385 * - decoding: unused
2387 int frame_skip_factor;
2390 * frame skip exponent
2391 * - encoding: Set by user.
2392 * - decoding: unused
2397 * frame skip comparison function
2398 * - encoding: Set by user.
2399 * - decoding: unused
2404 * trellis RD quantization
2405 * - encoding: Set by user.
2406 * - decoding: unused
2411 * - encoding: Set by user.
2412 * - decoding: unused
2414 int min_prediction_order;
2417 * - encoding: Set by user.
2418 * - decoding: unused
2420 int max_prediction_order;
2423 * GOP timecode frame start number, in non drop frame format
2424 * - encoding: Set by user.
2425 * - decoding: unused
2427 int64_t timecode_frame_start;
2429 /* The RTP callback: This function is called */
2430 /* every time the encoder has a packet to send. */
2431 /* It depends on the encoder if the data starts */
2432 /* with a Start Code (it should). H.263 does. */
2433 /* mb_nb contains the number of macroblocks */
2434 /* encoded in the RTP payload. */
2435 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2437 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2438 /* do its best to deliver a chunk with size */
2439 /* below rtp_payload_size, the chunk will start */
2440 /* with a start code on some codecs like H.263. */
2441 /* This doesn't take account of any particular */
2442 /* headers inside the transmitted RTP payload. */
2444 /* statistics, used for 2-pass encoding */
2455 * number of bits used for the previously encoded frame
2456 * - encoding: Set by libavcodec.
2457 * - decoding: unused
2462 * pass1 encoding statistics output buffer
2463 * - encoding: Set by libavcodec.
2464 * - decoding: unused
2469 * pass2 encoding statistics input buffer
2470 * Concatenated stuff from stats_out of pass1 should be placed here.
2471 * - encoding: Allocated/set/freed by user.
2472 * - decoding: unused
2477 * Work around bugs in encoders which sometimes cannot be detected automatically.
2478 * - encoding: Set by user
2479 * - decoding: Set by user
2481 int workaround_bugs;
2482 #define FF_BUG_AUTODETECT 1 ///< autodetection
2483 #define FF_BUG_OLD_MSMPEG4 2
2484 #define FF_BUG_XVID_ILACE 4
2485 #define FF_BUG_UMP4 8
2486 #define FF_BUG_NO_PADDING 16
2487 #define FF_BUG_AMV 32
2488 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2489 #define FF_BUG_QPEL_CHROMA 64
2490 #define FF_BUG_STD_QPEL 128
2491 #define FF_BUG_QPEL_CHROMA2 256
2492 #define FF_BUG_DIRECT_BLOCKSIZE 512
2493 #define FF_BUG_EDGE 1024
2494 #define FF_BUG_HPEL_CHROMA 2048
2495 #define FF_BUG_DC_CLIP 4096
2496 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2497 #define FF_BUG_TRUNCATED 16384
2500 * strictly follow the standard (MPEG4, ...).
2501 * - encoding: Set by user.
2502 * - decoding: Set by user.
2503 * Setting this to STRICT or higher means the encoder and decoder will
2504 * generally do stupid things, whereas setting it to unofficial or lower
2505 * will mean the encoder might produce output that is not supported by all
2506 * spec-compliant decoders. Decoders don't differentiate between normal,
2507 * unofficial and experimental (that is, they always try to decode things
2508 * when they can) unless they are explicitly asked to behave stupidly
2509 * (=strictly conform to the specs)
2511 int strict_std_compliance;
2512 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2513 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2514 #define FF_COMPLIANCE_NORMAL 0
2515 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2516 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2519 * error concealment flags
2520 * - encoding: unused
2521 * - decoding: Set by user.
2523 int error_concealment;
2524 #define FF_EC_GUESS_MVS 1
2525 #define FF_EC_DEBLOCK 2
2529 * - encoding: Set by user.
2530 * - decoding: Set by user.
2533 #define FF_DEBUG_PICT_INFO 1
2534 #define FF_DEBUG_RC 2
2535 #define FF_DEBUG_BITSTREAM 4
2536 #define FF_DEBUG_MB_TYPE 8
2537 #define FF_DEBUG_QP 16
2538 #define FF_DEBUG_MV 32
2539 #define FF_DEBUG_DCT_COEFF 0x00000040
2540 #define FF_DEBUG_SKIP 0x00000080
2541 #define FF_DEBUG_STARTCODE 0x00000100
2542 #define FF_DEBUG_PTS 0x00000200
2543 #define FF_DEBUG_ER 0x00000400
2544 #define FF_DEBUG_MMCO 0x00000800
2545 #define FF_DEBUG_BUGS 0x00001000
2546 #define FF_DEBUG_VIS_QP 0x00002000
2547 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2548 #define FF_DEBUG_BUFFERS 0x00008000
2549 #define FF_DEBUG_THREADS 0x00010000
2553 * - encoding: Set by user.
2554 * - decoding: Set by user.
2557 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2558 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2559 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2562 * Error recognition; may misdetect some more or less valid parts as errors.
2563 * - encoding: unused
2564 * - decoding: Set by user.
2566 int err_recognition;
2567 #define AV_EF_CRCCHECK (1<<0)
2568 #define AV_EF_BITSTREAM (1<<1)
2569 #define AV_EF_BUFFER (1<<2)
2570 #define AV_EF_EXPLODE (1<<3)
2573 * opaque 64bit number (generally a PTS) that will be reordered and
2574 * output in AVFrame.reordered_opaque
2575 * @deprecated in favor of pkt_pts
2576 * - encoding: unused
2577 * - decoding: Set by user.
2579 int64_t reordered_opaque;
2582 * Hardware accelerator in use
2583 * - encoding: unused.
2584 * - decoding: Set by libavcodec
2586 struct AVHWAccel *hwaccel;
2589 * Hardware accelerator context.
2590 * For some hardware accelerators, a global context needs to be
2591 * provided by the user. In that case, this holds display-dependent
2592 * data Libav cannot instantiate itself. Please refer to the
2593 * Libav HW accelerator documentation to know how to fill this
2594 * is. e.g. for VA API, this is a struct vaapi_context.
2595 * - encoding: unused
2596 * - decoding: Set by user
2598 void *hwaccel_context;
2602 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2603 * - decoding: unused
2605 uint64_t error[AV_NUM_DATA_POINTERS];
2608 * DCT algorithm, see FF_DCT_* below
2609 * - encoding: Set by user.
2610 * - decoding: unused
2613 #define FF_DCT_AUTO 0
2614 #define FF_DCT_FASTINT 1
2615 #define FF_DCT_INT 2
2616 #define FF_DCT_MMX 3
2617 #define FF_DCT_ALTIVEC 5
2618 #define FF_DCT_FAAN 6
2621 * IDCT algorithm, see FF_IDCT_* below.
2622 * - encoding: Set by user.
2623 * - decoding: Set by user.
2626 #define FF_IDCT_AUTO 0
2627 #define FF_IDCT_INT 1
2628 #define FF_IDCT_SIMPLE 2
2629 #define FF_IDCT_SIMPLEMMX 3
2631 #define FF_IDCT_LIBMPEG2MMX 4
2634 #define FF_IDCT_MMI 5
2636 #define FF_IDCT_ARM 7
2637 #define FF_IDCT_ALTIVEC 8
2638 #define FF_IDCT_SH4 9
2639 #define FF_IDCT_SIMPLEARM 10
2640 #define FF_IDCT_H264 11
2641 #define FF_IDCT_VP3 12
2642 #define FF_IDCT_IPP 13
2643 #define FF_IDCT_XVIDMMX 14
2644 #define FF_IDCT_CAVS 15
2645 #define FF_IDCT_SIMPLEARMV5TE 16
2646 #define FF_IDCT_SIMPLEARMV6 17
2647 #define FF_IDCT_SIMPLEVIS 18
2648 #define FF_IDCT_WMV2 19
2649 #define FF_IDCT_FAAN 20
2650 #define FF_IDCT_EA 21
2651 #define FF_IDCT_SIMPLENEON 22
2652 #define FF_IDCT_SIMPLEALPHA 23
2653 #define FF_IDCT_BINK 24
2658 * @deprecated use av_set_cpu_flags_mask() instead.
2660 attribute_deprecated unsigned dsp_mask;
2664 * bits per sample/pixel from the demuxer (needed for huffyuv).
2665 * - encoding: Set by libavcodec.
2666 * - decoding: Set by user.
2668 int bits_per_coded_sample;
2671 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2672 * - encoding: set by user.
2673 * - decoding: set by libavcodec.
2675 int bits_per_raw_sample;
2678 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2679 * - encoding: unused
2680 * - decoding: Set by user.
2682 attribute_deprecated int lowres;
2685 * the picture in the bitstream
2686 * - encoding: Set by libavcodec.
2687 * - decoding: Set by libavcodec.
2689 AVFrame *coded_frame;
2693 * is used to decide how many independent tasks should be passed to execute()
2694 * - encoding: Set by user.
2695 * - decoding: Set by user.
2700 * Which multithreading methods to use.
2701 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2702 * so clients which cannot provide future frames should not use it.
2704 * - encoding: Set by user, otherwise the default is used.
2705 * - decoding: Set by user, otherwise the default is used.
2708 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2709 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2712 * Which multithreading methods are in use by the codec.
2713 * - encoding: Set by libavcodec.
2714 * - decoding: Set by libavcodec.
2716 int active_thread_type;
2719 * Set by the client if its custom get_buffer() callback can be called
2720 * synchronously from another thread, which allows faster multithreaded decoding.
2721 * draw_horiz_band() will be called from other threads regardless of this setting.
2722 * Ignored if the default get_buffer() is used.
2723 * - encoding: Set by user.
2724 * - decoding: Set by user.
2726 int thread_safe_callbacks;
2729 * The codec may call this to execute several independent things.
2730 * It will return only after finishing all tasks.
2731 * The user may replace this with some multithreaded implementation,
2732 * the default implementation will execute the parts serially.
2733 * @param count the number of things to execute
2734 * - encoding: Set by libavcodec, user can override.
2735 * - decoding: Set by libavcodec, user can override.
2737 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2740 * The codec may call this to execute several independent things.
2741 * It will return only after finishing all tasks.
2742 * The user may replace this with some multithreaded implementation,
2743 * the default implementation will execute the parts serially.
2744 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2745 * @param c context passed also to func
2746 * @param count the number of things to execute
2747 * @param arg2 argument passed unchanged to func
2748 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2749 * @param func function that will be called count times, with jobnr from 0 to count-1.
2750 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2751 * two instances of func executing at the same time will have the same threadnr.
2752 * @return always 0 currently, but code should handle a future improvement where when any call to func
2753 * returns < 0 no further calls to func may be done and < 0 is returned.
2754 * - encoding: Set by libavcodec, user can override.
2755 * - decoding: Set by libavcodec, user can override.
2757 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2761 * Can be used by execute() to store some per AVCodecContext stuff.
2762 * - encoding: set by execute()
2763 * - decoding: set by execute()
2765 void *thread_opaque;
2768 * noise vs. sse weight for the nsse comparsion function
2769 * - encoding: Set by user.
2770 * - decoding: unused
2776 * - encoding: Set by user.
2777 * - decoding: Set by libavcodec.
2780 #define FF_PROFILE_UNKNOWN -99
2781 #define FF_PROFILE_RESERVED -100
2783 #define FF_PROFILE_AAC_MAIN 0
2784 #define FF_PROFILE_AAC_LOW 1
2785 #define FF_PROFILE_AAC_SSR 2
2786 #define FF_PROFILE_AAC_LTP 3
2787 #define FF_PROFILE_AAC_HE 4
2788 #define FF_PROFILE_AAC_HE_V2 28
2789 #define FF_PROFILE_AAC_LD 22
2790 #define FF_PROFILE_AAC_ELD 38
2792 #define FF_PROFILE_DTS 20
2793 #define FF_PROFILE_DTS_ES 30
2794 #define FF_PROFILE_DTS_96_24 40
2795 #define FF_PROFILE_DTS_HD_HRA 50
2796 #define FF_PROFILE_DTS_HD_MA 60
2798 #define FF_PROFILE_MPEG2_422 0
2799 #define FF_PROFILE_MPEG2_HIGH 1
2800 #define FF_PROFILE_MPEG2_SS 2
2801 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2802 #define FF_PROFILE_MPEG2_MAIN 4
2803 #define FF_PROFILE_MPEG2_SIMPLE 5
2805 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2806 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2808 #define FF_PROFILE_H264_BASELINE 66
2809 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2810 #define FF_PROFILE_H264_MAIN 77
2811 #define FF_PROFILE_H264_EXTENDED 88
2812 #define FF_PROFILE_H264_HIGH 100
2813 #define FF_PROFILE_H264_HIGH_10 110
2814 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2815 #define FF_PROFILE_H264_HIGH_422 122
2816 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2817 #define FF_PROFILE_H264_HIGH_444 144
2818 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2819 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2820 #define FF_PROFILE_H264_CAVLC_444 44
2822 #define FF_PROFILE_VC1_SIMPLE 0
2823 #define FF_PROFILE_VC1_MAIN 1
2824 #define FF_PROFILE_VC1_COMPLEX 2
2825 #define FF_PROFILE_VC1_ADVANCED 3
2827 #define FF_PROFILE_MPEG4_SIMPLE 0
2828 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2829 #define FF_PROFILE_MPEG4_CORE 2
2830 #define FF_PROFILE_MPEG4_MAIN 3
2831 #define FF_PROFILE_MPEG4_N_BIT 4
2832 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2833 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2834 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2835 #define FF_PROFILE_MPEG4_HYBRID 8
2836 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2837 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2838 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2839 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2840 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2841 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2842 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2846 * - encoding: Set by user.
2847 * - decoding: Set by libavcodec.
2850 #define FF_LEVEL_UNKNOWN -99
2854 * - encoding: unused
2855 * - decoding: Set by user.
2857 enum AVDiscard skip_loop_filter;
2861 * - encoding: unused
2862 * - decoding: Set by user.
2864 enum AVDiscard skip_idct;
2868 * - encoding: unused
2869 * - decoding: Set by user.
2871 enum AVDiscard skip_frame;
2874 * Header containing style information for text subtitles.
2875 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2876 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2877 * the Format line following. It shouldn't include any Dialogue line.
2878 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2879 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2881 uint8_t *subtitle_header;
2882 int subtitle_header_size;
2885 * Simulates errors in the bitstream to test error concealment.
2886 * - encoding: Set by user.
2887 * - decoding: unused
2892 * Current packet as passed into the decoder, to avoid having
2893 * to pass the packet into every function. Currently only valid
2894 * inside lavc and get/release_buffer callbacks.
2895 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2896 * - encoding: unused
2901 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2902 * Used for compliant TS muxing.
2903 * - encoding: Set by libavcodec.
2904 * - decoding: unused.
2912 typedef struct AVProfile {
2914 const char *name; ///< short name for the profile
2917 typedef struct AVCodecDefault AVCodecDefault;
2924 typedef struct AVCodec {
2926 * Name of the codec implementation.
2927 * The name is globally unique among encoders and among decoders (but an
2928 * encoder and a decoder can share the same name).
2929 * This is the primary way to find a codec from the user perspective.
2933 * Descriptive name for the codec, meant to be more human readable than name.
2934 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2936 const char *long_name;
2937 enum AVMediaType type;
2940 * Codec capabilities.
2944 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2945 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2946 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2947 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2948 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2949 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2950 const AVClass *priv_class; ///< AVClass for the private context
2951 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2953 /*****************************************************************
2954 * No fields below this line are part of the public API. They
2955 * may not be used outside of libavcodec and can be changed and
2957 * New public fields should be added right above.
2958 *****************************************************************
2961 struct AVCodec *next;
2963 * @name Frame-level threading support functions
2967 * If defined, called on thread contexts when they are created.
2968 * If the codec allocates writable tables in init(), re-allocate them here.
2969 * priv_data will be set to a copy of the original.
2971 int (*init_thread_copy)(AVCodecContext *);
2973 * Copy necessary context variables from a previous thread context to the current one.
2974 * If not defined, the next thread will start automatically; otherwise, the codec
2975 * must call ff_thread_finish_setup().
2977 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2979 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2983 * Private codec-specific defaults.
2985 const AVCodecDefault *defaults;
2988 * Initialize codec static data, called from avcodec_register().
2990 void (*init_static_data)(struct AVCodec *codec);
2992 int (*init)(AVCodecContext *);
2993 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2994 const struct AVSubtitle *sub);
2996 * Encode data to an AVPacket.
2998 * @param avctx codec context
2999 * @param avpkt output AVPacket (may contain a user-provided buffer)
3000 * @param[in] frame AVFrame containing the raw data to be encoded
3001 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3002 * non-empty packet was returned in avpkt.
3003 * @return 0 on success, negative error code on failure
3005 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3006 int *got_packet_ptr);
3007 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3008 int (*close)(AVCodecContext *);
3011 * Will be called when seeking
3013 void (*flush)(AVCodecContext *);
3019 typedef struct AVHWAccel {
3021 * Name of the hardware accelerated codec.
3022 * The name is globally unique among encoders and among decoders (but an
3023 * encoder and a decoder can share the same name).
3028 * Type of codec implemented by the hardware accelerator.
3030 * See AVMEDIA_TYPE_xxx
3032 enum AVMediaType type;
3035 * Codec implemented by the hardware accelerator.
3037 * See AV_CODEC_ID_xxx
3042 * Supported pixel format.
3044 * Only hardware accelerated formats are supported here.
3046 enum AVPixelFormat pix_fmt;
3049 * Hardware accelerated codec capabilities.
3050 * see FF_HWACCEL_CODEC_CAP_*
3054 struct AVHWAccel *next;
3057 * Called at the beginning of each frame or field picture.
3059 * Meaningful frame information (codec specific) is guaranteed to
3060 * be parsed at this point. This function is mandatory.
3062 * Note that buf can be NULL along with buf_size set to 0.
3063 * Otherwise, this means the whole frame is available at this point.
3065 * @param avctx the codec context
3066 * @param buf the frame data buffer base
3067 * @param buf_size the size of the frame in bytes
3068 * @return zero if successful, a negative value otherwise
3070 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3073 * Callback for each slice.
3075 * Meaningful slice information (codec specific) is guaranteed to
3076 * be parsed at this point. This function is mandatory.
3078 * @param avctx the codec context
3079 * @param buf the slice data buffer base
3080 * @param buf_size the size of the slice in bytes
3081 * @return zero if successful, a negative value otherwise
3083 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3086 * Called at the end of each frame or field picture.
3088 * The whole picture is parsed at this point and can now be sent
3089 * to the hardware accelerator. This function is mandatory.
3091 * @param avctx the codec context
3092 * @return zero if successful, a negative value otherwise
3094 int (*end_frame)(AVCodecContext *avctx);
3097 * Size of HW accelerator private data.
3099 * Private data is allocated with av_mallocz() before
3100 * AVCodecContext.get_buffer() and deallocated after
3101 * AVCodecContext.release_buffer().
3107 * @defgroup lavc_picture AVPicture
3109 * Functions for working with AVPicture
3114 * four components are given, that's all.
3115 * the last component is alpha
3117 typedef struct AVPicture {
3118 uint8_t *data[AV_NUM_DATA_POINTERS];
3119 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3126 #define AVPALETTE_SIZE 1024
3127 #define AVPALETTE_COUNT 256
3129 enum AVSubtitleType {
3132 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3135 * Plain text, the text field must be set by the decoder and is
3136 * authoritative. ass and pict fields may contain approximations.
3141 * Formatted text, the ass field must be set by the decoder and is
3142 * authoritative. pict and text fields may contain approximations.
3147 typedef struct AVSubtitleRect {
3148 int x; ///< top left corner of pict, undefined when pict is not set
3149 int y; ///< top left corner of pict, undefined when pict is not set
3150 int w; ///< width of pict, undefined when pict is not set
3151 int h; ///< height of pict, undefined when pict is not set
3152 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3155 * data+linesize for the bitmap of this subtitle.
3156 * can be set for text/ass as well once they where rendered
3159 enum AVSubtitleType type;
3161 char *text; ///< 0 terminated plain UTF-8 text
3164 * 0 terminated ASS/SSA compatible event line.
3165 * The pressentation of this is unaffected by the other values in this
3171 typedef struct AVSubtitle {
3172 uint16_t format; /* 0 = graphics */
3173 uint32_t start_display_time; /* relative to packet pts, in ms */
3174 uint32_t end_display_time; /* relative to packet pts, in ms */
3176 AVSubtitleRect **rects;
3177 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3181 * If c is NULL, returns the first registered codec,
3182 * if c is non-NULL, returns the next registered codec after c,
3183 * or NULL if c is the last one.
3185 AVCodec *av_codec_next(const AVCodec *c);
3188 * Return the LIBAVCODEC_VERSION_INT constant.
3190 unsigned avcodec_version(void);
3193 * Return the libavcodec build-time configuration.
3195 const char *avcodec_configuration(void);
3198 * Return the libavcodec license.
3200 const char *avcodec_license(void);
3203 * Register the codec codec and initialize libavcodec.
3205 * @warning either this function or avcodec_register_all() must be called
3206 * before any other libavcodec functions.
3208 * @see avcodec_register_all()
3210 void avcodec_register(AVCodec *codec);
3213 * Register all the codecs, parsers and bitstream filters which were enabled at
3214 * configuration time. If you do not call this function you can select exactly
3215 * which formats you want to support, by using the individual registration
3218 * @see avcodec_register
3219 * @see av_register_codec_parser
3220 * @see av_register_bitstream_filter
3222 void avcodec_register_all(void);
3225 * Allocate an AVCodecContext and set its fields to default values. The
3226 * resulting struct can be deallocated by calling avcodec_close() on it followed
3229 * @param codec if non-NULL, allocate private data and initialize defaults
3230 * for the given codec. It is illegal to then call avcodec_open2()
3231 * with a different codec.
3232 * If NULL, then the codec-specific defaults won't be initialized,
3233 * which may result in suboptimal default settings (this is
3234 * important mainly for encoders, e.g. libx264).
3236 * @return An AVCodecContext filled with default values or NULL on failure.
3237 * @see avcodec_get_context_defaults
3239 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3242 * Set the fields of the given AVCodecContext to default values corresponding
3243 * to the given codec (defaults may be codec-dependent).
3245 * Do not call this function if a non-NULL codec has been passed
3246 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3247 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3248 * different codec on this AVCodecContext.
3250 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3253 * Get the AVClass for AVCodecContext. It can be used in combination with
3254 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3256 * @see av_opt_find().
3258 const AVClass *avcodec_get_class(void);
3261 * Copy the settings of the source AVCodecContext into the destination
3262 * AVCodecContext. The resulting destination codec context will be
3263 * unopened, i.e. you are required to call avcodec_open2() before you
3264 * can use this AVCodecContext to decode/encode video/audio data.
3266 * @param dest target codec context, should be initialized with
3267 * avcodec_alloc_context3(), but otherwise uninitialized
3268 * @param src source codec context
3269 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3271 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3274 * Allocate an AVFrame and set its fields to default values. The resulting
3275 * struct must be freed using avcodec_free_frame().
3277 * @return An AVFrame filled with default values or NULL on failure.
3278 * @see avcodec_get_frame_defaults
3280 AVFrame *avcodec_alloc_frame(void);
3283 * Set the fields of the given AVFrame to default values.
3285 * @param frame The AVFrame of which the fields should be set to default values.
3287 void avcodec_get_frame_defaults(AVFrame *frame);
3290 * Free the frame and any dynamically allocated objects in it,
3291 * e.g. extended_data.
3293 * @param frame frame to be freed. The pointer will be set to NULL.
3295 * @warning this function does NOT free the data buffers themselves
3296 * (it does not know how, since they might have been allocated with
3297 * a custom get_buffer()).
3299 void avcodec_free_frame(AVFrame **frame);
3302 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3303 * function the context has to be allocated with avcodec_alloc_context3().
3305 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3306 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3307 * retrieving a codec.
3309 * @warning This function is not thread safe!
3312 * avcodec_register_all();
3313 * av_dict_set(&opts, "b", "2.5M", 0);
3314 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3318 * context = avcodec_alloc_context3(codec);
3320 * if (avcodec_open2(context, codec, opts) < 0)
3324 * @param avctx The context to initialize.
3325 * @param codec The codec to open this context for. If a non-NULL codec has been
3326 * previously passed to avcodec_alloc_context3() or
3327 * avcodec_get_context_defaults3() for this context, then this
3328 * parameter MUST be either NULL or equal to the previously passed
3330 * @param options A dictionary filled with AVCodecContext and codec-private options.
3331 * On return this object will be filled with options that were not found.
3333 * @return zero on success, a negative value on error
3334 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3335 * av_dict_set(), av_opt_find().
3337 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3340 * Close a given AVCodecContext and free all the data associated with it
3341 * (but not the AVCodecContext itself).
3343 * Calling this function on an AVCodecContext that hasn't been opened will free
3344 * the codec-specific data allocated in avcodec_alloc_context3() /
3345 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3348 int avcodec_close(AVCodecContext *avctx);
3351 * Free all allocated data in the given subtitle struct.
3353 * @param sub AVSubtitle to free.
3355 void avsubtitle_free(AVSubtitle *sub);
3362 * @addtogroup lavc_packet
3367 * Default packet destructor.
3369 void av_destruct_packet(AVPacket *pkt);
3372 * Initialize optional fields of a packet with default values.
3374 * Note, this does not touch the data and size members, which have to be
3375 * initialized separately.
3379 void av_init_packet(AVPacket *pkt);
3382 * Allocate the payload of a packet and initialize its fields with
3386 * @param size wanted payload size
3387 * @return 0 if OK, AVERROR_xxx otherwise
3389 int av_new_packet(AVPacket *pkt, int size);
3392 * Reduce packet size, correctly zeroing padding
3395 * @param size new size
3397 void av_shrink_packet(AVPacket *pkt, int size);
3400 * Increase packet size, correctly zeroing padding
3403 * @param grow_by number of bytes by which to increase the size of the packet
3405 int av_grow_packet(AVPacket *pkt, int grow_by);
3408 * @warning This is a hack - the packet memory allocation stuff is broken. The
3409 * packet is allocated if it was not really allocated.
3411 int av_dup_packet(AVPacket *pkt);
3416 * @param pkt packet to free
3418 void av_free_packet(AVPacket *pkt);
3421 * Allocate new information of a packet.
3424 * @param type side information type
3425 * @param size side information size
3426 * @return pointer to fresh allocated data or NULL otherwise
3428 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3432 * Shrink the already allocated side data buffer
3435 * @param type side information type
3436 * @param size new side information size
3437 * @return 0 on success, < 0 on failure
3439 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3443 * Get side information from packet.
3446 * @param type desired side information type
3447 * @param size pointer for side information size to store (optional)
3448 * @return pointer to data if present or NULL otherwise
3450 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3458 * @addtogroup lavc_decoding
3463 * Find a registered decoder with a matching codec ID.
3465 * @param id AVCodecID of the requested decoder
3466 * @return A decoder if one was found, NULL otherwise.
3468 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3471 * Find a registered decoder with the specified name.
3473 * @param name name of the requested decoder
3474 * @return A decoder if one was found, NULL otherwise.
3476 AVCodec *avcodec_find_decoder_by_name(const char *name);
3478 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3479 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3480 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3483 * Return the amount of padding in pixels which the get_buffer callback must
3484 * provide around the edge of the image for codecs which do not have the
3485 * CODEC_FLAG_EMU_EDGE flag.
3487 * @return Required padding in pixels.
3489 unsigned avcodec_get_edge_width(void);
3492 * Modify width and height values so that they will result in a memory
3493 * buffer that is acceptable for the codec if you do not use any horizontal
3496 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3497 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3498 * according to avcodec_get_edge_width() before.
3500 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3503 * Modify width and height values so that they will result in a memory
3504 * buffer that is acceptable for the codec if you also ensure that all
3505 * line sizes are a multiple of the respective linesize_align[i].
3507 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3508 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3509 * according to avcodec_get_edge_width() before.
3511 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3512 int linesize_align[AV_NUM_DATA_POINTERS]);
3514 #if FF_API_OLD_DECODE_AUDIO
3516 * Wrapper function which calls avcodec_decode_audio4.
3518 * @deprecated Use avcodec_decode_audio4 instead.
3520 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3521 * Some decoders may support multiple frames in a single AVPacket, such
3522 * decoders would then just decode the first frame. In this case,
3523 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3524 * the remaining data in order to decode the second frame etc.
3526 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3527 * decompressed frame size in bytes.
3529 * @warning You must set frame_size_ptr to the allocated size of the
3530 * output buffer before calling avcodec_decode_audio3().
3532 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3533 * the actual read bytes because some optimized bitstream readers read 32 or 64
3534 * bits at once and could read over the end.
3536 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3537 * no overreading happens for damaged MPEG streams.
3539 * @warning You must not provide a custom get_buffer() when using
3540 * avcodec_decode_audio3(). Doing so will override it with
3541 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3542 * which does allow the application to provide a custom get_buffer().
3544 * @note You might have to align the input buffer avpkt->data and output buffer
3545 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3546 * necessary at all, on others it won't work at all if not aligned and on others
3547 * it will work but it will have an impact on performance.
3549 * In practice, avpkt->data should have 4 byte alignment at minimum and
3550 * samples should be 16 byte aligned unless the CPU doesn't need it
3551 * (AltiVec and SSE do).
3553 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3554 * between input and output, these need to be fed with avpkt->data=NULL,
3555 * avpkt->size=0 at the end to return the remaining frames.
3557 * @param avctx the codec context
3558 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3559 * If the sample format is planar, each channel plane will
3560 * be the same size, with no padding between channels.
3561 * @param[in,out] frame_size_ptr the output buffer size in bytes
3562 * @param[in] avpkt The input AVPacket containing the input buffer.
3563 * You can create such packet with av_init_packet() and by then setting
3564 * data and size, some decoders might in addition need other fields.
3565 * All decoders are designed to use the least fields possible though.
3566 * @return On error a negative value is returned, otherwise the number of bytes
3567 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3569 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3570 int *frame_size_ptr,
3575 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3577 * Some decoders may support multiple frames in a single AVPacket. Such
3578 * decoders would then just decode the first frame. In this case,
3579 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3580 * the remaining data in order to decode the second frame, etc...
3581 * Even if no frames are returned, the packet needs to be fed to the decoder
3582 * with remaining data until it is completely consumed or an error occurs.
3584 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3585 * larger than the actual read bytes because some optimized bitstream
3586 * readers read 32 or 64 bits at once and could read over the end.
3588 * @note You might have to align the input buffer. The alignment requirements
3589 * depend on the CPU and the decoder.
3591 * @param avctx the codec context
3592 * @param[out] frame The AVFrame in which to store decoded audio samples.
3593 * Decoders request a buffer of a particular size by setting
3594 * AVFrame.nb_samples prior to calling get_buffer(). The
3595 * decoder may, however, only utilize part of the buffer by
3596 * setting AVFrame.nb_samples to a smaller value in the
3598 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3600 * @param[in] avpkt The input AVPacket containing the input buffer.
3601 * At least avpkt->data and avpkt->size should be set. Some
3602 * decoders might also require additional fields to be set.
3603 * @return A negative error code is returned if an error occurred during
3604 * decoding, otherwise the number of bytes consumed from the input
3605 * AVPacket is returned.
3607 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3608 int *got_frame_ptr, AVPacket *avpkt);
3611 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3612 * Some decoders may support multiple frames in a single AVPacket, such
3613 * decoders would then just decode the first frame.
3615 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3616 * the actual read bytes because some optimized bitstream readers read 32 or 64
3617 * bits at once and could read over the end.
3619 * @warning The end of the input buffer buf should be set to 0 to ensure that
3620 * no overreading happens for damaged MPEG streams.
3622 * @note You might have to align the input buffer avpkt->data.
3623 * The alignment requirements depend on the CPU: on some CPUs it isn't
3624 * necessary at all, on others it won't work at all if not aligned and on others
3625 * it will work but it will have an impact on performance.
3627 * In practice, avpkt->data should have 4 byte alignment at minimum.
3629 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3630 * between input and output, these need to be fed with avpkt->data=NULL,
3631 * avpkt->size=0 at the end to return the remaining frames.
3633 * @param avctx the codec context
3634 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3635 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3636 * allocate memory for the actual bitmap.
3637 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3638 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3639 * decodes and the decoder tells the user once it does not need the data anymore,
3640 * the user app can at this point free/reuse/keep the memory as it sees fit.
3642 * @param[in] avpkt The input AVpacket containing the input buffer.
3643 * You can create such packet with av_init_packet() and by then setting
3644 * data and size, some decoders might in addition need other fields like
3645 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3647 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3648 * @return On error a negative value is returned, otherwise the number of bytes
3649 * used or zero if no frame could be decompressed.
3651 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3652 int *got_picture_ptr,
3656 * Decode a subtitle message.
3657 * Return a negative value on error, otherwise return the number of bytes used.
3658 * If no subtitle could be decompressed, got_sub_ptr is zero.
3659 * Otherwise, the subtitle is stored in *sub.
3660 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3661 * simplicity, because the performance difference is expect to be negligible
3662 * and reusing a get_buffer written for video codecs would probably perform badly
3663 * due to a potentially very different allocation pattern.
3665 * @param avctx the codec context
3666 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3667 freed with avsubtitle_free if *got_sub_ptr is set.
3668 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3669 * @param[in] avpkt The input AVPacket containing the input buffer.
3671 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3676 * @defgroup lavc_parsing Frame parsing
3680 typedef struct AVCodecParserContext {
3682 struct AVCodecParser *parser;
3683 int64_t frame_offset; /* offset of the current frame */
3684 int64_t cur_offset; /* current offset
3685 (incremented by each av_parser_parse()) */
3686 int64_t next_frame_offset; /* offset of the next frame */
3688 int pict_type; /* XXX: Put it back in AVCodecContext. */
3690 * This field is used for proper frame duration computation in lavf.
3691 * It signals, how much longer the frame duration of the current frame
3692 * is compared to normal frame duration.
3694 * frame_duration = (1 + repeat_pict) * time_base
3696 * It is used by codecs like H.264 to display telecined material.
3698 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3699 int64_t pts; /* pts of the current frame */
3700 int64_t dts; /* dts of the current frame */
3705 int fetch_timestamp;
3707 #define AV_PARSER_PTS_NB 4
3708 int cur_frame_start_index;
3709 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3710 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3711 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3714 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3715 #define PARSER_FLAG_ONCE 0x0002
3716 /// Set if the parser has a valid file offset
3717 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3719 int64_t offset; ///< byte offset from starting packet start
3720 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3723 * Set by parser to 1 for key frames and 0 for non-key frames.
3724 * It is initialized to -1, so if the parser doesn't set this flag,
3725 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3731 * Time difference in stream time base units from the pts of this
3732 * packet to the point at which the output from the decoder has converged
3733 * independent from the availability of previous frames. That is, the
3734 * frames are virtually identical no matter if decoding started from
3735 * the very first frame or from this keyframe.
3736 * Is AV_NOPTS_VALUE if unknown.
3737 * This field is not the display duration of the current frame.
3738 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3741 * The purpose of this field is to allow seeking in streams that have no
3742 * keyframes in the conventional sense. It corresponds to the
3743 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3744 * essential for some types of subtitle streams to ensure that all
3745 * subtitles are correctly displayed after seeking.
3747 int64_t convergence_duration;
3749 // Timestamp generation support:
3751 * Synchronization point for start of timestamp generation.
3753 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3756 * For example, this corresponds to presence of H.264 buffering period
3762 * Offset of the current timestamp against last timestamp sync point in
3763 * units of AVCodecContext.time_base.
3765 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3766 * contain a valid timestamp offset.
3768 * Note that the timestamp of sync point has usually a nonzero
3769 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3770 * the next frame after timestamp sync point will be usually 1.
3772 * For example, this corresponds to H.264 cpb_removal_delay.
3774 int dts_ref_dts_delta;
3777 * Presentation delay of current frame in units of AVCodecContext.time_base.
3779 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3780 * contain valid non-negative timestamp delta (presentation time of a frame
3781 * must not lie in the past).
3783 * This delay represents the difference between decoding and presentation
3784 * time of the frame.
3786 * For example, this corresponds to H.264 dpb_output_delay.
3791 * Position of the packet in file.
3793 * Analogous to cur_frame_pts/dts
3795 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3798 * Byte position of currently parsed frame in stream.
3803 * Previous frame byte position.
3808 * Duration of the current frame.
3809 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3810 * For all other types, this is in units of AVCodecContext.time_base.
3813 } AVCodecParserContext;
3815 typedef struct AVCodecParser {
3816 int codec_ids[5]; /* several codec IDs are permitted */
3818 int (*parser_init)(AVCodecParserContext *s);
3819 int (*parser_parse)(AVCodecParserContext *s,
3820 AVCodecContext *avctx,
3821 const uint8_t **poutbuf, int *poutbuf_size,
3822 const uint8_t *buf, int buf_size);
3823 void (*parser_close)(AVCodecParserContext *s);
3824 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3825 struct AVCodecParser *next;
3828 AVCodecParser *av_parser_next(AVCodecParser *c);
3830 void av_register_codec_parser(AVCodecParser *parser);
3831 AVCodecParserContext *av_parser_init(int codec_id);
3836 * @param s parser context.
3837 * @param avctx codec context.
3838 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3839 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3840 * @param buf input buffer.
3841 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3842 * @param pts input presentation timestamp.
3843 * @param dts input decoding timestamp.
3844 * @param pos input byte position in stream.
3845 * @return the number of bytes of the input bitstream used.
3850 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3857 * decode_frame(data, size);
3861 int av_parser_parse2(AVCodecParserContext *s,
3862 AVCodecContext *avctx,
3863 uint8_t **poutbuf, int *poutbuf_size,
3864 const uint8_t *buf, int buf_size,
3865 int64_t pts, int64_t dts,
3868 int av_parser_change(AVCodecParserContext *s,
3869 AVCodecContext *avctx,
3870 uint8_t **poutbuf, int *poutbuf_size,
3871 const uint8_t *buf, int buf_size, int keyframe);
3872 void av_parser_close(AVCodecParserContext *s);
3880 * @addtogroup lavc_encoding
3885 * Find a registered encoder with a matching codec ID.
3887 * @param id AVCodecID of the requested encoder
3888 * @return An encoder if one was found, NULL otherwise.
3890 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3893 * Find a registered encoder with the specified name.
3895 * @param name name of the requested encoder
3896 * @return An encoder if one was found, NULL otherwise.
3898 AVCodec *avcodec_find_encoder_by_name(const char *name);
3900 #if FF_API_OLD_ENCODE_AUDIO
3902 * Encode an audio frame from samples into buf.
3904 * @deprecated Use avcodec_encode_audio2 instead.
3906 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3907 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3908 * will know how much space is needed because it depends on the value passed
3909 * in buf_size as described below. In that case a lower value can be used.
3911 * @param avctx the codec context
3912 * @param[out] buf the output buffer
3913 * @param[in] buf_size the output buffer size
3914 * @param[in] samples the input buffer containing the samples
3915 * The number of samples read from this buffer is frame_size*channels,
3916 * both of which are defined in avctx.
3917 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3918 * samples read from samples is equal to:
3919 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3920 * This also implies that av_get_bits_per_sample() must not return 0 for these
3922 * @return On error a negative value is returned, on success zero or the number
3923 * of bytes used to encode the data read from the input buffer.
3925 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3926 uint8_t *buf, int buf_size,
3927 const short *samples);
3931 * Encode a frame of audio.
3933 * Takes input samples from frame and writes the next output packet, if
3934 * available, to avpkt. The output packet does not necessarily contain data for
3935 * the most recent frame, as encoders can delay, split, and combine input frames
3936 * internally as needed.
3938 * @param avctx codec context
3939 * @param avpkt output AVPacket.
3940 * The user can supply an output buffer by setting
3941 * avpkt->data and avpkt->size prior to calling the
3942 * function, but if the size of the user-provided data is not
3943 * large enough, encoding will fail. All other AVPacket fields
3944 * will be reset by the encoder using av_init_packet(). If
3945 * avpkt->data is NULL, the encoder will allocate it.
3946 * The encoder will set avpkt->size to the size of the
3949 * If this function fails or produces no output, avpkt will be
3950 * freed using av_free_packet() (i.e. avpkt->destruct will be
3951 * called to free the user supplied buffer).
3952 * @param[in] frame AVFrame containing the raw audio data to be encoded.
3953 * May be NULL when flushing an encoder that has the
3954 * CODEC_CAP_DELAY capability set.
3955 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3956 * can have any number of samples.
3957 * If it is not set, frame->nb_samples must be equal to
3958 * avctx->frame_size for all frames except the last.
3959 * The final frame may be smaller than avctx->frame_size.
3960 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3961 * output packet is non-empty, and to 0 if it is
3962 * empty. If the function returns an error, the
3963 * packet can be assumed to be invalid, and the
3964 * value of got_packet_ptr is undefined and should
3966 * @return 0 on success, negative error code on failure
3968 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3969 const AVFrame *frame, int *got_packet_ptr);
3971 #if FF_API_OLD_ENCODE_VIDEO
3973 * @deprecated use avcodec_encode_video2() instead.
3975 * Encode a video frame from pict into buf.
3976 * The input picture should be
3977 * stored using a specific format, namely avctx.pix_fmt.
3979 * @param avctx the codec context
3980 * @param[out] buf the output buffer for the bitstream of encoded frame
3981 * @param[in] buf_size the size of the output buffer in bytes
3982 * @param[in] pict the input picture to encode
3983 * @return On error a negative value is returned, on success zero or the number
3984 * of bytes used from the output buffer.
3986 attribute_deprecated
3987 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3988 const AVFrame *pict);
3992 * Encode a frame of video.
3994 * Takes input raw video data from frame and writes the next output packet, if
3995 * available, to avpkt. The output packet does not necessarily contain data for
3996 * the most recent frame, as encoders can delay and reorder input frames
3997 * internally as needed.
3999 * @param avctx codec context
4000 * @param avpkt output AVPacket.
4001 * The user can supply an output buffer by setting
4002 * avpkt->data and avpkt->size prior to calling the
4003 * function, but if the size of the user-provided data is not
4004 * large enough, encoding will fail. All other AVPacket fields
4005 * will be reset by the encoder using av_init_packet(). If
4006 * avpkt->data is NULL, the encoder will allocate it.
4007 * The encoder will set avpkt->size to the size of the
4008 * output packet. The returned data (if any) belongs to the
4009 * caller, he is responsible for freeing it.
4011 * If this function fails or produces no output, avpkt will be
4012 * freed using av_free_packet() (i.e. avpkt->destruct will be
4013 * called to free the user supplied buffer).
4014 * @param[in] frame AVFrame containing the raw video data to be encoded.
4015 * May be NULL when flushing an encoder that has the
4016 * CODEC_CAP_DELAY capability set.
4017 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4018 * output packet is non-empty, and to 0 if it is
4019 * empty. If the function returns an error, the
4020 * packet can be assumed to be invalid, and the
4021 * value of got_packet_ptr is undefined and should
4023 * @return 0 on success, negative error code on failure
4025 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4026 const AVFrame *frame, int *got_packet_ptr);
4028 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4029 const AVSubtitle *sub);
4036 #if FF_API_AVCODEC_RESAMPLE
4038 * @defgroup lavc_resample Audio resampling
4040 * @deprecated use libavresample instead
4044 struct ReSampleContext;
4045 struct AVResampleContext;
4047 typedef struct ReSampleContext ReSampleContext;
4050 * Initialize audio resampling context.
4052 * @param output_channels number of output channels
4053 * @param input_channels number of input channels
4054 * @param output_rate output sample rate
4055 * @param input_rate input sample rate
4056 * @param sample_fmt_out requested output sample format
4057 * @param sample_fmt_in input sample format
4058 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4059 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4060 * @param linear if 1 then the used FIR filter will be linearly interpolated
4061 between the 2 closest, if 0 the closest will be used
4062 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4063 * @return allocated ReSampleContext, NULL if error occurred
4065 attribute_deprecated
4066 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4067 int output_rate, int input_rate,
4068 enum AVSampleFormat sample_fmt_out,
4069 enum AVSampleFormat sample_fmt_in,
4070 int filter_length, int log2_phase_count,
4071 int linear, double cutoff);
4073 attribute_deprecated
4074 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4077 * Free resample context.
4079 * @param s a non-NULL pointer to a resample context previously
4080 * created with av_audio_resample_init()
4082 attribute_deprecated
4083 void audio_resample_close(ReSampleContext *s);
4087 * Initialize an audio resampler.
4088 * Note, if either rate is not an integer then simply scale both rates up so they are.
4089 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4090 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4091 * @param linear If 1 then the used FIR filter will be linearly interpolated
4092 between the 2 closest, if 0 the closest will be used
4093 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4095 attribute_deprecated
4096 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4099 * Resample an array of samples using a previously configured context.
4100 * @param src an array of unconsumed samples
4101 * @param consumed the number of samples of src which have been consumed are returned here
4102 * @param src_size the number of unconsumed samples available
4103 * @param dst_size the amount of space in samples available in dst
4104 * @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.
4105 * @return the number of samples written in dst or -1 if an error occurred
4107 attribute_deprecated
4108 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4112 * Compensate samplerate/timestamp drift. The compensation is done by changing
4113 * the resampler parameters, so no audible clicks or similar distortions occur
4114 * @param compensation_distance distance in output samples over which the compensation should be performed
4115 * @param sample_delta number of output samples which should be output less
4117 * example: av_resample_compensate(c, 10, 500)
4118 * here instead of 510 samples only 500 samples would be output
4120 * note, due to rounding the actual compensation might be slightly different,
4121 * especially if the compensation_distance is large and the in_rate used during init is small
4123 attribute_deprecated
4124 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4125 attribute_deprecated
4126 void av_resample_close(struct AVResampleContext *c);
4134 * @addtogroup lavc_picture
4139 * Allocate memory for a picture. Call avpicture_free() to free it.
4141 * @see avpicture_fill()
4143 * @param picture the picture to be filled in
4144 * @param pix_fmt the format of the picture
4145 * @param width the width of the picture
4146 * @param height the height of the picture
4147 * @return zero if successful, a negative value if not
4149 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4152 * Free a picture previously allocated by avpicture_alloc().
4153 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4156 * @param picture the AVPicture to be freed
4158 void avpicture_free(AVPicture *picture);
4161 * Fill in the AVPicture fields.
4162 * The fields of the given AVPicture are filled in by using the 'ptr' address
4163 * which points to the image data buffer. Depending on the specified picture
4164 * format, one or multiple image data pointers and line sizes will be set.
4165 * If a planar format is specified, several pointers will be set pointing to
4166 * the different picture planes and the line sizes of the different planes
4167 * will be stored in the lines_sizes array.
4168 * Call with ptr == NULL to get the required size for the ptr buffer.
4170 * To allocate the buffer and fill in the AVPicture fields in one call,
4171 * use avpicture_alloc().
4173 * @param picture AVPicture whose fields are to be filled in
4174 * @param ptr Buffer which will contain or contains the actual image data
4175 * @param pix_fmt The format in which the picture data is stored.
4176 * @param width the width of the image in pixels
4177 * @param height the height of the image in pixels
4178 * @return size of the image data in bytes
4180 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4181 enum AVPixelFormat pix_fmt, int width, int height);
4184 * Copy pixel data from an AVPicture into a buffer.
4185 * The data is stored compactly, without any gaps for alignment or padding
4186 * which may be applied by avpicture_fill().
4188 * @see avpicture_get_size()
4190 * @param[in] src AVPicture containing image data
4191 * @param[in] pix_fmt The format in which the picture data is stored.
4192 * @param[in] width the width of the image in pixels.
4193 * @param[in] height the height of the image in pixels.
4194 * @param[out] dest A buffer into which picture data will be copied.
4195 * @param[in] dest_size The size of 'dest'.
4196 * @return The number of bytes written to dest, or a negative value (error code) on error.
4198 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4199 int width, int height,
4200 unsigned char *dest, int dest_size);
4203 * Calculate the size in bytes that a picture of the given width and height
4204 * would occupy if stored in the given picture format.
4205 * Note that this returns the size of a compact representation as generated
4206 * by avpicture_layout(), which can be smaller than the size required for e.g.
4209 * @param pix_fmt the given picture format
4210 * @param width the width of the image
4211 * @param height the height of the image
4212 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4214 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4217 * deinterlace - if not supported return -1
4219 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4220 enum AVPixelFormat pix_fmt, int width, int height);
4222 * Copy image src to dst. Wraps av_picture_data_copy() above.
4224 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4225 enum AVPixelFormat pix_fmt, int width, int height);
4228 * Crop image top and left side.
4230 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4231 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4236 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4237 int padtop, int padbottom, int padleft, int padright, int *color);
4244 * @defgroup lavc_misc Utility functions
4247 * Miscellaneous utility functions related to both encoding and decoding
4253 * @defgroup lavc_misc_pixfmt Pixel formats
4255 * Functions for working with pixel formats.
4259 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4262 * Return a value representing the fourCC code associated to the
4263 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4266 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4268 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4269 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4270 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4271 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4272 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4273 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4276 * Compute what kind of losses will occur when converting from one specific
4277 * pixel format to another.
4278 * When converting from one pixel format to another, information loss may occur.
4279 * For example, when converting from RGB24 to GRAY, the color information will
4280 * be lost. Similarly, other losses occur when converting from some formats to
4281 * other formats. These losses can involve loss of chroma, but also loss of
4282 * resolution, loss of color depth, loss due to the color space conversion, loss
4283 * of the alpha bits or loss due to color quantization.
4284 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4285 * which will occur when converting from one pixel format to another.
4287 * @param[in] dst_pix_fmt destination pixel format
4288 * @param[in] src_pix_fmt source pixel format
4289 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4290 * @return Combination of flags informing you what kind of losses will occur.
4292 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4295 #if FF_API_FIND_BEST_PIX_FMT
4297 * @deprecated use avcodec_find_best_pix_fmt2() instead.
4299 * Find the best pixel format to convert to given a certain source pixel
4300 * format. When converting from one pixel format to another, information loss
4301 * may occur. For example, when converting from RGB24 to GRAY, the color
4302 * information will be lost. Similarly, other losses occur when converting from
4303 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4304 * the given pixel formats should be used to suffer the least amount of loss.
4305 * The pixel formats from which it chooses one, are determined by the
4306 * pix_fmt_mask parameter.
4309 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4310 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) || (1 << AV_PIX_FMT_RGB24);
4311 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4314 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4315 * @param[in] src_pix_fmt source pixel format
4316 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4317 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4318 * @return The best pixel format to convert to or -1 if none was found.
4320 attribute_deprecated
4321 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4322 int has_alpha, int *loss_ptr);
4323 #endif /* FF_API_FIND_BEST_PIX_FMT */
4326 * Find the best pixel format to convert to given a certain source pixel
4327 * format. When converting from one pixel format to another, information loss
4328 * may occur. For example, when converting from RGB24 to GRAY, the color
4329 * information will be lost. Similarly, other losses occur when converting from
4330 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4331 * the given pixel formats should be used to suffer the least amount of loss.
4332 * The pixel formats from which it chooses one, are determined by the
4333 * pix_fmt_list parameter.
4336 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4337 * @param[in] src_pix_fmt source pixel format
4338 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4339 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4340 * @return The best pixel format to convert to or -1 if none was found.
4342 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4343 enum AVPixelFormat src_pix_fmt,
4344 int has_alpha, int *loss_ptr);
4346 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4352 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4355 * Put a string representing the codec tag codec_tag in buf.
4357 * @param buf_size size in bytes of buf
4358 * @return the length of the string that would have been generated if
4359 * enough space had been available, excluding the trailing null
4361 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4363 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4366 * Return a name for the specified profile, if available.
4368 * @param codec the codec that is searched for the given profile
4369 * @param profile the profile value for which a name is requested
4370 * @return A name for the profile if found, NULL otherwise.
4372 const char *av_get_profile_name(const AVCodec *codec, int profile);
4374 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4375 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4376 //FIXME func typedef
4379 * Fill audio frame data and linesize.
4380 * AVFrame extended_data channel pointers are allocated if necessary for
4383 * @param frame the AVFrame
4384 * frame->nb_samples must be set prior to calling the
4385 * function. This function fills in frame->data,
4386 * frame->extended_data, frame->linesize[0].
4387 * @param nb_channels channel count
4388 * @param sample_fmt sample format
4389 * @param buf buffer to use for frame data
4390 * @param buf_size size of buffer
4391 * @param align plane size sample alignment (0 = default)
4392 * @return 0 on success, negative error code on failure
4394 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4395 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4396 int buf_size, int align);
4399 * Flush buffers, should be called when seeking or when switching to a different stream.
4401 void avcodec_flush_buffers(AVCodecContext *avctx);
4403 void avcodec_default_free_buffers(AVCodecContext *s);
4406 * Return codec bits per sample.
4408 * @param[in] codec_id the codec
4409 * @return Number of bits per sample or zero if unknown for the given codec.
4411 int av_get_bits_per_sample(enum AVCodecID codec_id);
4414 * Return codec bits per sample.
4415 * Only return non-zero if the bits per sample is exactly correct, not an
4418 * @param[in] codec_id the codec
4419 * @return Number of bits per sample or zero if unknown for the given codec.
4421 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4424 * Return audio frame duration.
4426 * @param avctx codec context
4427 * @param frame_bytes size of the frame, or 0 if unknown
4428 * @return frame duration, in samples, if known. 0 if not able to
4431 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4434 typedef struct AVBitStreamFilterContext {
4436 struct AVBitStreamFilter *filter;
4437 AVCodecParserContext *parser;
4438 struct AVBitStreamFilterContext *next;
4439 } AVBitStreamFilterContext;
4442 typedef struct AVBitStreamFilter {
4445 int (*filter)(AVBitStreamFilterContext *bsfc,
4446 AVCodecContext *avctx, const char *args,
4447 uint8_t **poutbuf, int *poutbuf_size,
4448 const uint8_t *buf, int buf_size, int keyframe);
4449 void (*close)(AVBitStreamFilterContext *bsfc);
4450 struct AVBitStreamFilter *next;
4451 } AVBitStreamFilter;
4453 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4454 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4455 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4456 AVCodecContext *avctx, const char *args,
4457 uint8_t **poutbuf, int *poutbuf_size,
4458 const uint8_t *buf, int buf_size, int keyframe);
4459 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4461 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4466 * Reallocate the given block if it is not large enough, otherwise do nothing.
4470 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4473 * Allocate a buffer, reusing the given one if large enough.
4475 * Contrary to av_fast_realloc the current buffer contents might not be
4476 * preserved and on error the old buffer is freed, thus no special
4477 * handling to avoid memleaks is necessary.
4479 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4480 * @param size size of the buffer *ptr points to
4481 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4482 * *size 0 if an error occurred.
4484 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4487 * Allocate a buffer with padding, reusing the given one if large enough.
4489 * Same behaviour av_fast_malloc but the buffer has additional
4490 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4493 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4496 * Encode extradata length to a buffer. Used by xiph codecs.
4498 * @param s buffer to write to; must be at least (v/255+1) bytes long
4499 * @param v size of extradata in bytes
4500 * @return number of bytes written to the buffer.
4502 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4505 * Log a generic warning message about a missing feature. This function is
4506 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4507 * only, and would normally not be used by applications.
4508 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4509 * a pointer to an AVClass struct
4510 * @param[in] feature string containing the name of the missing feature
4511 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4512 * If want_sample is non-zero, additional verbage will be added to the log
4513 * message which tells the user how to report samples to the development
4516 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4519 * Log a generic warning message asking for a sample. This function is
4520 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4521 * only, and would normally not be used by applications.
4522 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4523 * a pointer to an AVClass struct
4524 * @param[in] msg string containing an optional message, or NULL if no message
4526 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4529 * Register the hardware accelerator hwaccel.
4531 void av_register_hwaccel(AVHWAccel *hwaccel);
4534 * If hwaccel is NULL, returns the first registered hardware accelerator,
4535 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4536 * after hwaccel, or NULL if hwaccel is the last one.
4538 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4542 * Lock operation used by lockmgr
4545 AV_LOCK_CREATE, ///< Create a mutex
4546 AV_LOCK_OBTAIN, ///< Lock the mutex
4547 AV_LOCK_RELEASE, ///< Unlock the mutex
4548 AV_LOCK_DESTROY, ///< Free mutex resources
4552 * Register a user provided lock manager supporting the operations
4553 * specified by AVLockOp. mutex points to a (void *) where the
4554 * lockmgr should store/get a pointer to a user allocated mutex. It's
4555 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4557 * @param cb User defined callback. Note: Libav may invoke calls to this
4558 * callback during the call to av_lockmgr_register().
4559 * Thus, the application must be prepared to handle that.
4560 * If cb is set to NULL the lockmgr will be unregistered.
4561 * Also note that during unregistration the previously registered
4562 * lockmgr callback may also be invoked.
4564 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4567 * Get the type of the given codec.
4569 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4572 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4573 * with no corresponding avcodec_close()), 0 otherwise.
4575 int avcodec_is_open(AVCodecContext *s);
4578 * @return a non-zero number if codec is an encoder, zero otherwise
4580 int av_codec_is_encoder(const AVCodec *codec);
4583 * @return a non-zero number if codec is a decoder, zero otherwise
4585 int av_codec_is_decoder(const AVCodec *codec);
4588 * @return descriptor for given codec ID or NULL if no descriptor exists.
4590 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4593 * Iterate over all codec descriptors known to libavcodec.
4595 * @param prev previous descriptor. NULL to get the first descriptor.
4597 * @return next descriptor or NULL after the last descriptor
4599 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4602 * @return codec descriptor with the given name or NULL if no such descriptor
4605 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4611 #endif /* AVCODEC_AVCODEC_H */