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
27 * Libavcodec external API header
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/dict.h"
37 #include "libavutil/frame.h"
38 #include "libavutil/log.h"
39 #include "libavutil/pixfmt.h"
40 #include "libavutil/rational.h"
44 #if FF_API_FAST_MALLOC
45 // to provide fast_*alloc
46 #include "libavutil/mem.h"
50 * @defgroup libavc Encoding/Decoding Library
53 * @defgroup lavc_decoding Decoding
57 * @defgroup lavc_encoding Encoding
61 * @defgroup lavc_codec Codecs
63 * @defgroup lavc_codec_native Native Codecs
66 * @defgroup lavc_codec_wrappers External library wrappers
69 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
73 * @defgroup lavc_internal Internal
81 * @defgroup lavc_core Core functions/structures.
84 * Basic definitions, functions for querying libavcodec capabilities,
85 * allocating core structures, etc.
91 * Identify the syntax and semantics of the bitstream.
92 * The principle is roughly:
93 * Two decoders with the same ID can decode the same streams.
94 * Two encoders with the same ID can encode compatible streams.
95 * There may be slight deviations from the principle due to implementation
98 * If you add a codec ID to this list, add it so that
99 * 1. no value of a existing codec ID changes (that would break ABI),
100 * 2. it is as close as possible to similar codecs.
102 * After adding new codec IDs, do not forget to add an entry to the codec
103 * descriptor list and bump libavcodec minor version.
109 AV_CODEC_ID_MPEG1VIDEO,
110 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
112 AV_CODEC_ID_MPEG2VIDEO_XVMC,
113 #endif /* FF_API_XVMC */
124 AV_CODEC_ID_RAWVIDEO,
125 AV_CODEC_ID_MSMPEG4V1,
126 AV_CODEC_ID_MSMPEG4V2,
127 AV_CODEC_ID_MSMPEG4V3,
150 AV_CODEC_ID_INTERPLAY_VIDEO,
157 AV_CODEC_ID_MSVIDEO1,
162 AV_CODEC_ID_TRUEMOTION1,
163 AV_CODEC_ID_VMDVIDEO,
188 AV_CODEC_ID_TRUEMOTION2,
194 AV_CODEC_ID_SMACKVIDEO,
199 AV_CODEC_ID_JPEG2000,
205 AV_CODEC_ID_DSICINVIDEO,
206 AV_CODEC_ID_TIERTEXSEQVIDEO,
214 AV_CODEC_ID_BETHSOFTVID,
226 AV_CODEC_ID_ESCAPE124,
230 AV_CODEC_ID_MOTIONPIXELS,
242 AV_CODEC_ID_FLASHSV2,
243 AV_CODEC_ID_CDGRAPHICS,
246 AV_CODEC_ID_BINKVIDEO,
247 AV_CODEC_ID_IFF_ILBM,
248 AV_CODEC_ID_IFF_BYTERUN1,
254 AV_CODEC_ID_A64_MULTI,
255 AV_CODEC_ID_A64_MULTI5,
258 AV_CODEC_ID_LAGARITH,
262 AV_CODEC_ID_WMV3IMAGE,
263 AV_CODEC_ID_VC1IMAGE,
265 AV_CODEC_ID_BMV_VIDEO,
272 AV_CODEC_ID_ZEROCODEC,
281 AV_CODEC_ID_ESCAPE130,
284 AV_CODEC_ID_HNM4_VIDEO,
287 AV_CODEC_ID_ALIAS_PIX,
288 AV_CODEC_ID_BRENDER_PIX,
289 AV_CODEC_ID_PAF_VIDEO,
298 /* various PCM "codecs" */
299 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
300 AV_CODEC_ID_PCM_S16LE = 0x10000,
301 AV_CODEC_ID_PCM_S16BE,
302 AV_CODEC_ID_PCM_U16LE,
303 AV_CODEC_ID_PCM_U16BE,
306 AV_CODEC_ID_PCM_MULAW,
307 AV_CODEC_ID_PCM_ALAW,
308 AV_CODEC_ID_PCM_S32LE,
309 AV_CODEC_ID_PCM_S32BE,
310 AV_CODEC_ID_PCM_U32LE,
311 AV_CODEC_ID_PCM_U32BE,
312 AV_CODEC_ID_PCM_S24LE,
313 AV_CODEC_ID_PCM_S24BE,
314 AV_CODEC_ID_PCM_U24LE,
315 AV_CODEC_ID_PCM_U24BE,
316 AV_CODEC_ID_PCM_S24DAUD,
317 AV_CODEC_ID_PCM_ZORK,
318 AV_CODEC_ID_PCM_S16LE_PLANAR,
320 AV_CODEC_ID_PCM_F32BE,
321 AV_CODEC_ID_PCM_F32LE,
322 AV_CODEC_ID_PCM_F64BE,
323 AV_CODEC_ID_PCM_F64LE,
324 AV_CODEC_ID_PCM_BLURAY,
327 AV_CODEC_ID_PCM_S8_PLANAR,
328 AV_CODEC_ID_PCM_S24LE_PLANAR,
329 AV_CODEC_ID_PCM_S32LE_PLANAR,
331 /* various ADPCM codecs */
332 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
333 AV_CODEC_ID_ADPCM_IMA_WAV,
334 AV_CODEC_ID_ADPCM_IMA_DK3,
335 AV_CODEC_ID_ADPCM_IMA_DK4,
336 AV_CODEC_ID_ADPCM_IMA_WS,
337 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
338 AV_CODEC_ID_ADPCM_MS,
339 AV_CODEC_ID_ADPCM_4XM,
340 AV_CODEC_ID_ADPCM_XA,
341 AV_CODEC_ID_ADPCM_ADX,
342 AV_CODEC_ID_ADPCM_EA,
343 AV_CODEC_ID_ADPCM_G726,
344 AV_CODEC_ID_ADPCM_CT,
345 AV_CODEC_ID_ADPCM_SWF,
346 AV_CODEC_ID_ADPCM_YAMAHA,
347 AV_CODEC_ID_ADPCM_SBPRO_4,
348 AV_CODEC_ID_ADPCM_SBPRO_3,
349 AV_CODEC_ID_ADPCM_SBPRO_2,
350 AV_CODEC_ID_ADPCM_THP,
351 AV_CODEC_ID_ADPCM_IMA_AMV,
352 AV_CODEC_ID_ADPCM_EA_R1,
353 AV_CODEC_ID_ADPCM_EA_R3,
354 AV_CODEC_ID_ADPCM_EA_R2,
355 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
356 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
357 AV_CODEC_ID_ADPCM_EA_XAS,
358 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
359 AV_CODEC_ID_ADPCM_IMA_ISS,
360 AV_CODEC_ID_ADPCM_G722,
361 AV_CODEC_ID_ADPCM_IMA_APC,
362 AV_CODEC_ID_ADPCM_VIMA,
365 AV_CODEC_ID_AMR_NB = 0x12000,
368 /* RealAudio codecs*/
369 AV_CODEC_ID_RA_144 = 0x13000,
372 /* various DPCM codecs */
373 AV_CODEC_ID_ROQ_DPCM = 0x14000,
374 AV_CODEC_ID_INTERPLAY_DPCM,
375 AV_CODEC_ID_XAN_DPCM,
376 AV_CODEC_ID_SOL_DPCM,
379 AV_CODEC_ID_MP2 = 0x15000,
380 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
390 AV_CODEC_ID_VMDAUDIO,
396 AV_CODEC_ID_WESTWOOD_SND1,
397 AV_CODEC_ID_GSM, ///< as in Berlin toast format
400 AV_CODEC_ID_TRUESPEECH,
402 AV_CODEC_ID_SMACKAUDIO,
405 AV_CODEC_ID_DSICINAUDIO,
407 AV_CODEC_ID_MUSEPACK7,
409 AV_CODEC_ID_GSM_MS, /* as found in WAV */
415 AV_CODEC_ID_NELLYMOSER,
416 AV_CODEC_ID_MUSEPACK8,
418 AV_CODEC_ID_WMAVOICE,
420 AV_CODEC_ID_WMALOSSLESS,
429 AV_CODEC_ID_BINKAUDIO_RDFT,
430 AV_CODEC_ID_BINKAUDIO_DCT,
431 AV_CODEC_ID_AAC_LATM,
436 AV_CODEC_ID_8SVX_EXP,
437 AV_CODEC_ID_8SVX_FIB,
438 AV_CODEC_ID_BMV_AUDIO,
443 AV_CODEC_ID_COMFORT_NOISE,
445 AV_CODEC_ID_METASOUND,
446 AV_CODEC_ID_PAF_AUDIO,
450 /* subtitle codecs */
451 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
452 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
453 AV_CODEC_ID_DVB_SUBTITLE,
454 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
457 AV_CODEC_ID_MOV_TEXT,
458 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
459 AV_CODEC_ID_DVB_TELETEXT,
462 /* other specific kind of codecs (generally used for attachments) */
463 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
464 AV_CODEC_ID_TTF = 0x18000,
466 AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
468 AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
469 * stream (only used by libavformat) */
470 AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
471 * stream (only used by libavformat) */
472 AV_CODEC_ID_FFMETADATA = 0x21000, ///< Dummy codec for streams containing only metadata information.
476 * This struct describes the properties of a single codec described by an
478 * @see avcodec_descriptor_get()
480 typedef struct AVCodecDescriptor {
482 enum AVMediaType type;
484 * Name of the codec described by this descriptor. It is non-empty and
485 * unique for each codec descriptor. It should contain alphanumeric
486 * characters and '_' only.
490 * A more descriptive name for this codec. May be NULL.
492 const char *long_name;
494 * Codec properties, a combination of AV_CODEC_PROP_* flags.
500 * Codec uses only intra compression.
503 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
505 * Codec supports lossy compression. Audio and video codecs only.
506 * @note a codec may support both lossy and lossless
509 #define AV_CODEC_PROP_LOSSY (1 << 1)
511 * Codec supports lossless compression. Audio and video codecs only.
513 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
515 * Codec supports frame reordering. That is, the coded order (the order in which
516 * the encoded packets are output by the encoders / stored / input to the
517 * decoders) may be different from the presentation order of the corresponding
520 * For codecs that do not have this property set, PTS and DTS should always be
523 #define AV_CODEC_PROP_REORDER (1 << 3)
526 * @ingroup lavc_decoding
527 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
528 * This is mainly needed because some optimized bitstream readers read
529 * 32 or 64 bit at once and could read over the end.<br>
530 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
531 * MPEG bitstreams could cause overread and segfault.
533 #define FF_INPUT_BUFFER_PADDING_SIZE 8
536 * @ingroup lavc_encoding
537 * minimum encoding buffer size
538 * Used to avoid some checks during header writing.
540 #define FF_MIN_BUFFER_SIZE 16384
544 * @ingroup lavc_encoding
545 * motion estimation type.
548 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
552 ME_EPZS, ///< enhanced predictive zonal search
553 ME_X1, ///< reserved for experiments
554 ME_HEX, ///< hexagon based search
555 ME_UMH, ///< uneven multi-hexagon search
556 ME_TESA, ///< transformed exhaustive search algorithm
560 * @ingroup lavc_decoding
563 /* We leave some space between them for extensions (drop some
564 * keyframes for intra-only or drop just some bidir frames). */
565 AVDISCARD_NONE =-16, ///< discard nothing
566 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
567 AVDISCARD_NONREF = 8, ///< discard all non reference
568 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
569 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
570 AVDISCARD_ALL = 48, ///< discard all
573 enum AVAudioServiceType {
574 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
575 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
576 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
577 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
578 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
579 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
580 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
581 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
582 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
583 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
587 * @ingroup lavc_encoding
589 typedef struct RcOverride{
592 int qscale; // If this is 0 then quality_factor will be used instead.
593 float quality_factor;
596 #if FF_API_MAX_BFRAMES
598 * @deprecated there is no libavcodec-wide limit on the number of B-frames
600 #define FF_MAX_B_FRAMES 16
604 These flags can be passed in AVCodecContext.flags before initialization.
605 Note: Not everything is supported yet.
609 * Allow decoders to produce frames with data planes that are not aligned
610 * to CPU requirements (e.g. due to cropping).
612 #define CODEC_FLAG_UNALIGNED 0x0001
613 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
614 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
615 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
616 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
619 * @deprecated use the "gmc" private option of the libxvid encoder
621 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
625 * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
628 #define CODEC_FLAG_MV0 0x0040
630 #if FF_API_INPUT_PRESERVED
632 * @deprecated passing reference-counted frames to the encoders replaces this
635 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
637 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
638 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
639 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
642 * @deprecated edges are not used/required anymore. I.e. this flag is now always
645 #define CODEC_FLAG_EMU_EDGE 0x4000
647 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
648 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
649 location instead of only at frame boundaries. */
650 #if FF_API_NORMALIZE_AQP
652 * @deprecated use the flag "naq" in the "mpv_flags" private option of the
655 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000
657 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
658 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
659 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
660 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
661 /* Fx : Flag for h263+ extra options */
662 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
663 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
664 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
665 #define CODEC_FLAG_CLOSED_GOP 0x80000000
666 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
667 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
668 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
669 #define CODEC_FLAG2_IGNORE_CROP 0x00010000 ///< Discard cropping information from SPS.
671 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
673 /* Unsupported options :
674 * Syntax Arithmetic coding (SAC)
675 * Reference Picture Selection
676 * Independent Segment Decoding */
678 /* codec capabilities */
680 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
682 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
683 * If not set, it might not use get_buffer() at all or use operations that
684 * assume the buffer was allocated by avcodec_default_get_buffer.
686 #define CODEC_CAP_DR1 0x0002
687 #define CODEC_CAP_TRUNCATED 0x0008
689 /* Codec can export data for HW decoding (XvMC). */
690 #define CODEC_CAP_HWACCEL 0x0010
691 #endif /* FF_API_XVMC */
693 * Encoder or decoder requires flushing with NULL input at the end in order to
694 * give the complete and correct output.
696 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
697 * with NULL data. The user can still send NULL data to the public encode
698 * or decode function, but libavcodec will not pass it along to the codec
699 * unless this flag is set.
702 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
703 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
707 * The encoder needs to be fed with NULL data at the end of encoding until the
708 * encoder no longer returns data.
710 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
711 * flag also means that the encoder must set the pts and duration for
712 * each output packet. If this flag is not set, the pts and duration will
713 * be determined by libavcodec from the input frame.
715 #define CODEC_CAP_DELAY 0x0020
717 * Codec can be fed a final frame with a smaller size.
718 * This can be used to prevent truncation of the last audio samples.
720 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
723 * Codec can export data for HW decoding (VDPAU).
725 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
728 * Codec can output multiple frames per AVPacket
729 * Normally demuxers return one frame at a time, demuxers which do not do
730 * are connected to a parser to split what they return into proper frames.
731 * This flag is reserved to the very rare category of codecs which have a
732 * bitstream that cannot be split into frames without timeconsuming
733 * operations like full decoding. Demuxers carring such bitstreams thus
734 * may return multiple frames in a packet. This has many disadvantages like
735 * prohibiting stream copy in many cases thus it should only be considered
738 #define CODEC_CAP_SUBFRAMES 0x0100
740 * Codec is experimental and is thus avoided in favor of non experimental
743 #define CODEC_CAP_EXPERIMENTAL 0x0200
745 * Codec should fill in channel configuration and samplerate instead of container
747 #define CODEC_CAP_CHANNEL_CONF 0x0400
748 #if FF_API_NEG_LINESIZES
750 * @deprecated no codecs use this capability
752 #define CODEC_CAP_NEG_LINESIZES 0x0800
755 * Codec supports frame-level multithreading.
757 #define CODEC_CAP_FRAME_THREADS 0x1000
759 * Codec supports slice-based (or partition-based) multithreading.
761 #define CODEC_CAP_SLICE_THREADS 0x2000
763 * Codec supports changed parameters at any point.
765 #define CODEC_CAP_PARAM_CHANGE 0x4000
767 * Codec supports avctx->thread_count == 0 (auto).
769 #define CODEC_CAP_AUTO_THREADS 0x8000
771 * Audio encoder supports receiving a different number of samples in each call.
773 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
776 //The following defines may change, don't expect compatibility if you use them.
777 #define MB_TYPE_INTRA4x4 0x0001
778 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
779 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
780 #define MB_TYPE_16x16 0x0008
781 #define MB_TYPE_16x8 0x0010
782 #define MB_TYPE_8x16 0x0020
783 #define MB_TYPE_8x8 0x0040
784 #define MB_TYPE_INTERLACED 0x0080
785 #define MB_TYPE_DIRECT2 0x0100 //FIXME
786 #define MB_TYPE_ACPRED 0x0200
787 #define MB_TYPE_GMC 0x0400
788 #define MB_TYPE_SKIP 0x0800
789 #define MB_TYPE_P0L0 0x1000
790 #define MB_TYPE_P1L0 0x2000
791 #define MB_TYPE_P0L1 0x4000
792 #define MB_TYPE_P1L1 0x8000
793 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
794 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
795 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
796 #define MB_TYPE_QUANT 0x00010000
797 #define MB_TYPE_CBP 0x00020000
798 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
803 * This specifies the area which should be displayed.
804 * Note there may be multiple such areas for one frame.
806 typedef struct AVPanScan{
809 * - encoding: Set by user.
810 * - decoding: Set by libavcodec.
815 * width and height in 1/16 pel
816 * - encoding: Set by user.
817 * - decoding: Set by libavcodec.
823 * position of the top left corner in 1/16 pel for up to 3 fields/frames
824 * - encoding: Set by user.
825 * - decoding: Set by libavcodec.
827 int16_t position[3][2];
830 #if FF_API_QSCALE_TYPE
831 #define FF_QSCALE_TYPE_MPEG1 0
832 #define FF_QSCALE_TYPE_MPEG2 1
833 #define FF_QSCALE_TYPE_H264 2
834 #define FF_QSCALE_TYPE_VP56 3
837 #if FF_API_GET_BUFFER
838 #define FF_BUFFER_TYPE_INTERNAL 1
839 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
840 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
841 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
843 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
844 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
845 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
846 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
850 * The decoder will keep a reference to the frame and may reuse it later.
852 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
855 * @defgroup lavc_packet AVPacket
857 * Types and functions for working with AVPacket.
860 enum AVPacketSideDataType {
862 AV_PKT_DATA_NEW_EXTRADATA,
865 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
868 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
869 * s32le channel_count
870 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
871 * u64le channel_layout
872 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
874 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
879 AV_PKT_DATA_PARAM_CHANGE,
882 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
883 * structures with info about macroblocks relevant to splitting the
884 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
885 * That is, it does not necessarily contain info about all macroblocks,
886 * as long as the distance between macroblocks in the info is smaller
887 * than the target payload size.
888 * Each MB info structure is 12 bytes, and is laid out as follows:
890 * u32le bit offset from the start of the packet
891 * u8 current quantizer at the start of the macroblock
893 * u16le macroblock address within the GOB
894 * u8 horizontal MV predictor
895 * u8 vertical MV predictor
896 * u8 horizontal MV predictor for block number 3
897 * u8 vertical MV predictor for block number 3
900 AV_PKT_DATA_H263_MB_INFO,
903 * This side data should be associated with an audio stream and contains
904 * ReplayGain information in form of the AVReplayGain struct.
906 AV_PKT_DATA_REPLAYGAIN,
909 * This side data contains a 3x3 transformation matrix describing an affine
910 * transformation that needs to be applied to the decoded video frames for
911 * correct presentation.
913 * See libavutil/display.h for a detailed description of the data.
915 AV_PKT_DATA_DISPLAYMATRIX,
918 * This side data should be associated with a video stream and contains
919 * Stereoscopic 3D information in form of the AVStereo3D struct.
921 AV_PKT_DATA_STEREO3D,
924 * This side data should be associated with an audio stream and corresponds
925 * to enum AVAudioServiceType.
927 AV_PKT_DATA_AUDIO_SERVICE_TYPE,
930 typedef struct AVPacketSideData {
933 enum AVPacketSideDataType type;
937 * This structure stores compressed data. It is typically exported by demuxers
938 * and then passed as input to decoders, or received as output from encoders and
939 * then passed to muxers.
941 * For video, it should typically contain one compressed frame. For audio it may
942 * contain several compressed frames.
944 * AVPacket is one of the few structs in Libav, whose size is a part of public
945 * ABI. Thus it may be allocated on stack and no new fields can be added to it
946 * without libavcodec and libavformat major bump.
948 * The semantics of data ownership depends on the buf or destruct (deprecated)
949 * fields. If either is set, the packet data is dynamically allocated and is
950 * valid indefinitely until av_free_packet() is called (which in turn calls
951 * av_buffer_unref()/the destruct callback to free the data). If neither is set,
952 * the packet data is typically backed by some static buffer somewhere and is
953 * only valid for a limited time (e.g. until the next read call when demuxing).
955 * The side data is always allocated with av_malloc() and is freed in
958 typedef struct AVPacket {
960 * A reference to the reference-counted buffer where the packet data is
962 * May be NULL, then the packet data is not reference-counted.
966 * Presentation timestamp in AVStream->time_base units; the time at which
967 * the decompressed packet will be presented to the user.
968 * Can be AV_NOPTS_VALUE if it is not stored in the file.
969 * pts MUST be larger or equal to dts as presentation cannot happen before
970 * decompression, unless one wants to view hex dumps. Some formats misuse
971 * the terms dts and pts/cts to mean something different. Such timestamps
972 * must be converted to true pts/dts before they are stored in AVPacket.
976 * Decompression timestamp in AVStream->time_base units; the time at which
977 * the packet is decompressed.
978 * Can be AV_NOPTS_VALUE if it is not stored in the file.
985 * A combination of AV_PKT_FLAG values
989 * Additional packet data that can be provided by the container.
990 * Packet can contain several types of side information.
992 AVPacketSideData *side_data;
996 * Duration of this packet in AVStream->time_base units, 0 if unknown.
997 * Equals next_pts - this_pts in presentation order.
1000 #if FF_API_DESTRUCT_PACKET
1001 attribute_deprecated
1002 void (*destruct)(struct AVPacket *);
1003 attribute_deprecated
1006 int64_t pos; ///< byte position in stream, -1 if unknown
1009 * Time difference in AVStream->time_base units from the pts of this
1010 * packet to the point at which the output from the decoder has converged
1011 * independent from the availability of previous frames. That is, the
1012 * frames are virtually identical no matter if decoding started from
1013 * the very first frame or from this keyframe.
1014 * Is AV_NOPTS_VALUE if unknown.
1015 * This field is not the display duration of the current packet.
1016 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1019 * The purpose of this field is to allow seeking in streams that have no
1020 * keyframes in the conventional sense. It corresponds to the
1021 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1022 * essential for some types of subtitle streams to ensure that all
1023 * subtitles are correctly displayed after seeking.
1025 int64_t convergence_duration;
1027 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1028 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1030 enum AVSideDataParamChangeFlags {
1031 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1032 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1033 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1034 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1040 struct AVCodecInternal;
1044 AV_FIELD_PROGRESSIVE,
1045 AV_FIELD_TT, //< Top coded_first, top displayed first
1046 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1047 AV_FIELD_TB, //< Top coded first, bottom displayed first
1048 AV_FIELD_BT, //< Bottom coded first, top displayed first
1052 * main external API structure.
1053 * New fields can be added to the end with minor version bumps.
1054 * Removal, reordering and changes to existing fields require a major
1056 * sizeof(AVCodecContext) must not be used outside libav*.
1058 typedef struct AVCodecContext {
1060 * information on struct for av_log
1061 * - set by avcodec_alloc_context3
1063 const AVClass *av_class;
1064 int log_level_offset;
1066 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1067 const struct AVCodec *codec;
1068 #if FF_API_CODEC_NAME
1070 * @deprecated this field is not used for anything in libavcodec
1072 attribute_deprecated
1073 char codec_name[32];
1075 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1078 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1079 * This is used to work around some encoder bugs.
1080 * A demuxer should set this to what is stored in the field used to identify the codec.
1081 * If there are multiple such fields in a container then the demuxer should choose the one
1082 * which maximizes the information about the used codec.
1083 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1084 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1085 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1087 * - encoding: Set by user, if not then the default based on codec_id will be used.
1088 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1090 unsigned int codec_tag;
1092 #if FF_API_STREAM_CODEC_TAG
1094 * @deprecated this field is unused
1096 attribute_deprecated
1097 unsigned int stream_codec_tag;
1103 * Private context used for internal data.
1105 * Unlike priv_data, this is not codec-specific. It is used in general
1106 * libavcodec functions.
1108 struct AVCodecInternal *internal;
1111 * Private data of the user, can be used to carry app specific stuff.
1112 * - encoding: Set by user.
1113 * - decoding: Set by user.
1118 * the average bitrate
1119 * - encoding: Set by user; unused for constant quantizer encoding.
1120 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1125 * number of bits the bitstream is allowed to diverge from the reference.
1126 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1127 * - encoding: Set by user; unused for constant quantizer encoding.
1128 * - decoding: unused
1130 int bit_rate_tolerance;
1133 * Global quality for codecs which cannot change it per frame.
1134 * This should be proportional to MPEG-1/2/4 qscale.
1135 * - encoding: Set by user.
1136 * - decoding: unused
1141 * - encoding: Set by user.
1142 * - decoding: unused
1144 int compression_level;
1145 #define FF_COMPRESSION_DEFAULT -1
1149 * - encoding: Set by user.
1150 * - decoding: Set by user.
1156 * - encoding: Set by user.
1157 * - decoding: Set by user.
1162 * some codecs need / can use extradata like Huffman tables.
1163 * mjpeg: Huffman tables
1164 * rv10: additional flags
1165 * mpeg4: global headers (they can be in the bitstream or here)
1166 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1167 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1168 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1169 * - encoding: Set/allocated/freed by libavcodec.
1170 * - decoding: Set/allocated/freed by user.
1176 * This is the fundamental unit of time (in seconds) in terms
1177 * of which frame timestamps are represented. For fixed-fps content,
1178 * timebase should be 1/framerate and timestamp increments should be
1180 * - encoding: MUST be set by user.
1181 * - decoding: the use of this field for decoding is deprecated.
1182 * Use framerate instead.
1184 AVRational time_base;
1187 * For some codecs, the time base is closer to the field rate than the frame rate.
1188 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1189 * if no telecine is used ...
1191 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1193 int ticks_per_frame;
1199 * Number of frames the decoded output will be delayed relative to the
1203 * For encoding, this field is unused (see initial_padding).
1205 * For decoding, this is the number of samples the decoder needs to
1206 * output before the decoder's output is valid. When seeking, you should
1207 * start decoding this many samples prior to your desired seek point.
1209 * - encoding: Set by libavcodec.
1210 * - decoding: Set by libavcodec.
1217 * picture width / height.
1218 * - encoding: MUST be set by user.
1219 * - decoding: May be set by the user before opening the decoder if known e.g.
1220 * from the container. Some decoders will require the dimensions
1221 * to be set by the caller. During decoding, the decoder may
1222 * overwrite those values as required.
1227 * Bitstream width / height, may be different from width/height e.g. when
1228 * the decoded frame is cropped before being output.
1229 * - encoding: unused
1230 * - decoding: May be set by the user before opening the decoder if known
1231 * e.g. from the container. During decoding, the decoder may
1232 * overwrite those values as required.
1234 int coded_width, coded_height;
1236 #if FF_API_ASPECT_EXTENDED
1237 #define FF_ASPECT_EXTENDED 15
1241 * the number of pictures in a group of pictures, or 0 for intra_only
1242 * - encoding: Set by user.
1243 * - decoding: unused
1248 * Pixel format, see AV_PIX_FMT_xxx.
1249 * May be set by the demuxer if known from headers.
1250 * May be overriden by the decoder if it knows better.
1251 * - encoding: Set by user.
1252 * - decoding: Set by user if known, overridden by libavcodec if known
1254 enum AVPixelFormat pix_fmt;
1257 * Motion estimation algorithm used for video coding.
1258 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1259 * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1260 * - encoding: MUST be set by user.
1261 * - decoding: unused
1266 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1267 * decoder to draw a horizontal band. It improves cache usage. Not
1268 * all codecs can do that. You must check the codec capabilities
1270 * When multithreading is used, it may be called from multiple threads
1271 * at the same time; threads might draw different parts of the same AVFrame,
1272 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1274 * The function is also used by hardware acceleration APIs.
1275 * It is called at least once during frame decoding to pass
1276 * the data needed for hardware render.
1277 * In that mode instead of pixel data, AVFrame points to
1278 * a structure specific to the acceleration API. The application
1279 * reads the structure and can change some fields to indicate progress
1281 * - encoding: unused
1282 * - decoding: Set by user.
1283 * @param height the height of the slice
1284 * @param y the y position of the slice
1285 * @param type 1->top field, 2->bottom field, 3->frame
1286 * @param offset offset into the AVFrame.data from which the slice should be read
1288 void (*draw_horiz_band)(struct AVCodecContext *s,
1289 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1290 int y, int type, int height);
1293 * callback to negotiate the pixelFormat
1294 * @param fmt is the list of formats which are supported by the codec,
1295 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1296 * The first is always the native one.
1297 * @note The callback may be called again immediately if initialization for
1298 * the selected (hardware-accelerated) pixel format failed.
1299 * @warning Behavior is undefined if the callback returns a value not
1300 * in the fmt list of formats.
1301 * @return the chosen format
1302 * - encoding: unused
1303 * - decoding: Set by user, if not set the native format will be chosen.
1305 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1308 * maximum number of B-frames between non-B-frames
1309 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1310 * - encoding: Set by user.
1311 * - decoding: unused
1316 * qscale factor between IP and B-frames
1317 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1318 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1319 * - encoding: Set by user.
1320 * - decoding: unused
1322 float b_quant_factor;
1324 /** obsolete FIXME remove */
1326 #define FF_RC_STRATEGY_XVID 1
1328 int b_frame_strategy;
1331 * qscale offset between IP and B-frames
1332 * - encoding: Set by user.
1333 * - decoding: unused
1335 float b_quant_offset;
1338 * Size of the frame reordering buffer in the decoder.
1339 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1340 * - encoding: Set by libavcodec.
1341 * - decoding: Set by libavcodec.
1346 * 0-> h263 quant 1-> mpeg quant
1347 * - encoding: Set by user.
1348 * - decoding: unused
1353 * qscale factor between P and I-frames
1354 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1355 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1356 * - encoding: Set by user.
1357 * - decoding: unused
1359 float i_quant_factor;
1362 * qscale offset between P and I-frames
1363 * - encoding: Set by user.
1364 * - decoding: unused
1366 float i_quant_offset;
1369 * luminance masking (0-> disabled)
1370 * - encoding: Set by user.
1371 * - decoding: unused
1376 * temporary complexity masking (0-> disabled)
1377 * - encoding: Set by user.
1378 * - decoding: unused
1380 float temporal_cplx_masking;
1383 * spatial complexity masking (0-> disabled)
1384 * - encoding: Set by user.
1385 * - decoding: unused
1387 float spatial_cplx_masking;
1390 * p block masking (0-> disabled)
1391 * - encoding: Set by user.
1392 * - decoding: unused
1397 * darkness masking (0-> disabled)
1398 * - encoding: Set by user.
1399 * - decoding: unused
1405 * - encoding: Set by libavcodec.
1406 * - decoding: Set by user (or 0).
1410 * prediction method (needed for huffyuv)
1411 * - encoding: Set by user.
1412 * - decoding: unused
1414 int prediction_method;
1415 #define FF_PRED_LEFT 0
1416 #define FF_PRED_PLANE 1
1417 #define FF_PRED_MEDIAN 2
1420 * slice offsets in the frame in bytes
1421 * - encoding: Set/allocated by libavcodec.
1422 * - decoding: Set/allocated by user (or NULL).
1427 * sample aspect ratio (0 if unknown)
1428 * That is the width of a pixel divided by the height of the pixel.
1429 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1430 * - encoding: Set by user.
1431 * - decoding: Set by libavcodec.
1433 AVRational sample_aspect_ratio;
1436 * motion estimation comparison function
1437 * - encoding: Set by user.
1438 * - decoding: unused
1442 * subpixel motion estimation comparison function
1443 * - encoding: Set by user.
1444 * - decoding: unused
1448 * macroblock comparison function (not supported yet)
1449 * - encoding: Set by user.
1450 * - decoding: unused
1454 * interlaced DCT comparison function
1455 * - encoding: Set by user.
1456 * - decoding: unused
1459 #define FF_CMP_SAD 0
1460 #define FF_CMP_SSE 1
1461 #define FF_CMP_SATD 2
1462 #define FF_CMP_DCT 3
1463 #define FF_CMP_PSNR 4
1464 #define FF_CMP_BIT 5
1466 #define FF_CMP_ZERO 7
1467 #define FF_CMP_VSAD 8
1468 #define FF_CMP_VSSE 9
1469 #define FF_CMP_NSSE 10
1470 #define FF_CMP_DCTMAX 13
1471 #define FF_CMP_DCT264 14
1472 #define FF_CMP_CHROMA 256
1475 * ME diamond size & shape
1476 * - encoding: Set by user.
1477 * - decoding: unused
1482 * amount of previous MV predictors (2a+1 x 2a+1 square)
1483 * - encoding: Set by user.
1484 * - decoding: unused
1486 int last_predictor_count;
1489 * prepass for motion estimation
1490 * - encoding: Set by user.
1491 * - decoding: unused
1496 * motion estimation prepass comparison function
1497 * - encoding: Set by user.
1498 * - decoding: unused
1503 * ME prepass diamond size & shape
1504 * - encoding: Set by user.
1505 * - decoding: unused
1511 * - encoding: Set by user.
1512 * - decoding: unused
1514 int me_subpel_quality;
1518 * DTG active format information (additional aspect ratio
1519 * information only used in DVB MPEG-2 transport streams)
1522 * - encoding: unused
1523 * - decoding: Set by decoder.
1524 * @deprecated Deprecated in favor of AVSideData
1526 attribute_deprecated int dtg_active_format;
1527 #define FF_DTG_AFD_SAME 8
1528 #define FF_DTG_AFD_4_3 9
1529 #define FF_DTG_AFD_16_9 10
1530 #define FF_DTG_AFD_14_9 11
1531 #define FF_DTG_AFD_4_3_SP_14_9 13
1532 #define FF_DTG_AFD_16_9_SP_14_9 14
1533 #define FF_DTG_AFD_SP_4_3 15
1534 #endif /* FF_API_AFD */
1537 * maximum motion estimation search range in subpel units
1538 * If 0 then no limit.
1540 * - encoding: Set by user.
1541 * - decoding: unused
1546 * intra quantizer bias
1547 * - encoding: Set by user.
1548 * - decoding: unused
1550 int intra_quant_bias;
1551 #define FF_DEFAULT_QUANT_BIAS 999999
1554 * inter quantizer bias
1555 * - encoding: Set by user.
1556 * - decoding: unused
1558 int inter_quant_bias;
1562 * - encoding: unused
1563 * - decoding: Set by user.
1566 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1567 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1568 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1572 * XVideo Motion Acceleration
1573 * - encoding: forbidden
1574 * - decoding: set by decoder
1575 * @deprecated XvMC support is slated for removal.
1577 attribute_deprecated int xvmc_acceleration;
1578 #endif /* FF_API_XVMC */
1581 * macroblock decision mode
1582 * - encoding: Set by user.
1583 * - decoding: unused
1586 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1587 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1588 #define FF_MB_DECISION_RD 2 ///< rate distortion
1591 * custom intra quantization matrix
1592 * - encoding: Set by user, can be NULL.
1593 * - decoding: Set by libavcodec.
1595 uint16_t *intra_matrix;
1598 * custom inter quantization matrix
1599 * - encoding: Set by user, can be NULL.
1600 * - decoding: Set by libavcodec.
1602 uint16_t *inter_matrix;
1605 * scene change detection threshold
1606 * 0 is default, larger means fewer detected scene changes.
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 int scenechange_threshold;
1613 * noise reduction strength
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 int noise_reduction;
1621 * @deprecated this field is unused
1623 attribute_deprecated
1627 * @deprecated this field is unused
1629 attribute_deprecated
1634 * precision of the intra DC coefficient - 8
1635 * - encoding: Set by user.
1636 * - decoding: unused
1638 int intra_dc_precision;
1641 * Number of macroblock rows at the top which are skipped.
1642 * - encoding: unused
1643 * - decoding: Set by user.
1648 * Number of macroblock rows at the bottom which are skipped.
1649 * - encoding: unused
1650 * - decoding: Set by user.
1656 * @deprecated use encoder private options instead
1658 attribute_deprecated
1659 float border_masking;
1663 * minimum MB lagrange multipler
1664 * - encoding: Set by user.
1665 * - decoding: unused
1670 * maximum MB lagrange multipler
1671 * - encoding: Set by user.
1672 * - decoding: unused
1678 * - encoding: Set by user.
1679 * - decoding: unused
1681 int me_penalty_compensation;
1685 * - encoding: Set by user.
1686 * - decoding: unused
1692 * - encoding: Set by user.
1693 * - decoding: unused
1699 * - encoding: Set by user.
1700 * - decoding: unused
1705 * number of reference frames
1706 * - encoding: Set by user.
1707 * - decoding: Set by lavc.
1712 * chroma qp offset from luma
1713 * - encoding: Set by user.
1714 * - decoding: unused
1718 #if FF_API_UNUSED_MEMBERS
1720 * Multiplied by qscale for each frame and added to scene_change_score.
1721 * - encoding: Set by user.
1722 * - decoding: unused
1724 attribute_deprecated int scenechange_factor;
1729 * Note: Value depends upon the compare function used for fullpel ME.
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * Adjust sensitivity of b_frame_strategy 1.
1737 * - encoding: Set by user.
1738 * - decoding: unused
1743 * Chromaticity coordinates of the source primaries.
1744 * - encoding: Set by user
1745 * - decoding: Set by libavcodec
1747 enum AVColorPrimaries color_primaries;
1750 * Color Transfer Characteristic.
1751 * - encoding: Set by user
1752 * - decoding: Set by libavcodec
1754 enum AVColorTransferCharacteristic color_trc;
1757 * YUV colorspace type.
1758 * - encoding: Set by user
1759 * - decoding: Set by libavcodec
1761 enum AVColorSpace colorspace;
1764 * MPEG vs JPEG YUV range.
1765 * - encoding: Set by user
1766 * - decoding: Set by libavcodec
1768 enum AVColorRange color_range;
1771 * This defines the location of chroma samples.
1772 * - encoding: Set by user
1773 * - decoding: Set by libavcodec
1775 enum AVChromaLocation chroma_sample_location;
1779 * Indicates number of picture subdivisions. Used for parallelized
1781 * - encoding: Set by user
1782 * - decoding: unused
1787 * - encoding: set by libavcodec
1788 * - decoding: Set by libavcodec
1790 enum AVFieldOrder field_order;
1793 int sample_rate; ///< samples per second
1794 int channels; ///< number of audio channels
1797 * audio sample format
1798 * - encoding: Set by user.
1799 * - decoding: Set by libavcodec.
1801 enum AVSampleFormat sample_fmt; ///< sample format
1803 /* The following data should not be initialized. */
1805 * Number of samples per channel in an audio frame.
1807 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1808 * except the last must contain exactly frame_size samples per channel.
1809 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1810 * frame size is not restricted.
1811 * - decoding: may be set by some decoders to indicate constant frame size
1816 * Frame counter, set by libavcodec.
1818 * - decoding: total number of frames returned from the decoder so far.
1819 * - encoding: total number of frames passed to the encoder so far.
1821 * @note the counter is not incremented if encoding/decoding resulted in
1827 * number of bytes per packet if constant and known or 0
1828 * Used by some WAV based audio codecs.
1833 * Audio cutoff bandwidth (0 means "automatic")
1834 * - encoding: Set by user.
1835 * - decoding: unused
1839 #if FF_API_REQUEST_CHANNELS
1841 * Decoder should decode to this many channels if it can (0 for default)
1842 * - encoding: unused
1843 * - decoding: Set by user.
1844 * @deprecated Deprecated in favor of request_channel_layout.
1846 attribute_deprecated int request_channels;
1850 * Audio channel layout.
1851 * - encoding: set by user.
1852 * - decoding: set by libavcodec.
1854 uint64_t channel_layout;
1857 * Request decoder to use this channel layout if it can (0 for default)
1858 * - encoding: unused
1859 * - decoding: Set by user.
1861 uint64_t request_channel_layout;
1864 * Type of service that the audio stream conveys.
1865 * - encoding: Set by user.
1866 * - decoding: Set by libavcodec.
1868 enum AVAudioServiceType audio_service_type;
1871 * Used to request a sample format from the decoder.
1872 * - encoding: unused.
1873 * - decoding: Set by user.
1875 enum AVSampleFormat request_sample_fmt;
1877 #if FF_API_GET_BUFFER
1879 * Called at the beginning of each frame to get a buffer for it.
1881 * The function will set AVFrame.data[], AVFrame.linesize[].
1882 * AVFrame.extended_data[] must also be set, but it should be the same as
1883 * AVFrame.data[] except for planar audio with more channels than can fit
1884 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1885 * many data pointers as it can hold.
1887 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1888 * avcodec_default_get_buffer() instead of providing buffers allocated by
1891 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1892 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1893 * but if get_buffer() is overridden then alignment considerations should
1894 * be taken into account.
1896 * @see avcodec_default_get_buffer()
1900 * If pic.reference is set then the frame will be read later by libavcodec.
1901 * avcodec_align_dimensions2() should be used to find the required width and
1902 * height, as they normally need to be rounded up to the next multiple of 16.
1904 * If frame multithreading is used and thread_safe_callbacks is set,
1905 * it may be called from a different thread, but not from more than one at
1906 * once. Does not need to be reentrant.
1908 * @see release_buffer(), reget_buffer()
1909 * @see avcodec_align_dimensions2()
1913 * Decoders request a buffer of a particular size by setting
1914 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1915 * however, utilize only part of the buffer by setting AVFrame.nb_samples
1916 * to a smaller value in the output frame.
1918 * Decoders cannot use the buffer after returning from
1919 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1920 * is assumed to be released immediately upon return. In some rare cases,
1921 * a decoder may need to call get_buffer() more than once in a single
1922 * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1923 * called again after it has already been called once, the previously
1924 * acquired buffer is assumed to be released at that time and may not be
1925 * reused by the decoder.
1927 * As a convenience, av_samples_get_buffer_size() and
1928 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1929 * functions to find the required data size and to fill data pointers and
1930 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1931 * since all planes must be the same size.
1933 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1935 * - encoding: unused
1936 * - decoding: Set by libavcodec, user can override.
1938 * @deprecated use get_buffer2()
1940 attribute_deprecated
1941 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1944 * Called to release buffers which were allocated with get_buffer.
1945 * A released buffer can be reused in get_buffer().
1946 * pic.data[*] must be set to NULL.
1947 * May be called from a different thread if frame multithreading is used,
1948 * but not by more than one thread at once, so does not need to be reentrant.
1949 * - encoding: unused
1950 * - decoding: Set by libavcodec, user can override.
1952 * @deprecated custom freeing callbacks should be set from get_buffer2()
1954 attribute_deprecated
1955 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1958 * Called at the beginning of a frame to get cr buffer for it.
1959 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1960 * libavcodec will pass previous buffer in pic, function should return
1961 * same buffer or new buffer with old frame "painted" into it.
1962 * If pic.data[0] == NULL must behave like get_buffer().
1963 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1964 * avcodec_default_reget_buffer() instead of providing buffers allocated by
1966 * - encoding: unused
1967 * - decoding: Set by libavcodec, user can override.
1969 attribute_deprecated
1970 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1974 * This callback is called at the beginning of each frame to get data
1975 * buffer(s) for it. There may be one contiguous buffer for all the data or
1976 * there may be a buffer per each data plane or anything in between. What
1977 * this means is, you may set however many entries in buf[] you feel necessary.
1978 * Each buffer must be reference-counted using the AVBuffer API (see description
1981 * The following fields will be set in the frame before this callback is
1984 * - width, height (video only)
1985 * - sample_rate, channel_layout, nb_samples (audio only)
1986 * Their values may differ from the corresponding values in
1987 * AVCodecContext. This callback must use the frame values, not the codec
1988 * context values, to calculate the required buffer size.
1990 * This callback must fill the following fields in the frame:
1994 * * if the data is planar audio with more than 8 channels, then this
1995 * callback must allocate and fill extended_data to contain all pointers
1996 * to all data planes. data[] must hold as many pointers as it can.
1997 * extended_data must be allocated with av_malloc() and will be freed in
1999 * * otherwise exended_data must point to data
2000 * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2001 * the frame's data and extended_data pointers must be contained in these. That
2002 * is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2003 * AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2004 * and av_buffer_ref().
2005 * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2006 * this callback and filled with the extra buffers if there are more
2007 * buffers than buf[] can hold. extended_buf will be freed in
2010 * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2011 * avcodec_default_get_buffer2() instead of providing buffers allocated by
2014 * Each data plane must be aligned to the maximum required by the target
2017 * @see avcodec_default_get_buffer2()
2021 * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2022 * (read and/or written to if it is writable) later by libavcodec.
2024 * avcodec_align_dimensions2() should be used to find the required width and
2025 * height, as they normally need to be rounded up to the next multiple of 16.
2027 * If frame multithreading is used and thread_safe_callbacks is set,
2028 * this callback may be called from a different thread, but not from more
2029 * than one at once. Does not need to be reentrant.
2031 * @see avcodec_align_dimensions2()
2035 * Decoders request a buffer of a particular size by setting
2036 * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2037 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2038 * to a smaller value in the output frame.
2040 * As a convenience, av_samples_get_buffer_size() and
2041 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2042 * functions to find the required data size and to fill data pointers and
2043 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2044 * since all planes must be the same size.
2046 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2048 * - encoding: unused
2049 * - decoding: Set by libavcodec, user can override.
2051 int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2054 * If non-zero, the decoded audio and video frames returned from
2055 * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2056 * and are valid indefinitely. The caller must free them with
2057 * av_frame_unref() when they are not needed anymore.
2058 * Otherwise, the decoded frames must not be freed by the caller and are
2059 * only valid until the next decode call.
2061 * - encoding: unused
2062 * - decoding: set by the caller before avcodec_open2().
2064 int refcounted_frames;
2066 /* - encoding parameters */
2067 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2068 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2072 * - encoding: Set by user.
2073 * - decoding: unused
2079 * - encoding: Set by user.
2080 * - decoding: unused
2085 * maximum quantizer difference between frames
2086 * - encoding: Set by user.
2087 * - decoding: unused
2093 * @deprecated use encoder private options instead
2095 attribute_deprecated
2098 attribute_deprecated
2100 attribute_deprecated
2105 * decoder bitstream buffer size
2106 * - encoding: Set by user.
2107 * - decoding: unused
2112 * ratecontrol override, see RcOverride
2113 * - encoding: Allocated/set/freed by user.
2114 * - decoding: unused
2116 int rc_override_count;
2117 RcOverride *rc_override;
2121 * @deprecated use encoder private options instead
2123 attribute_deprecated
2129 * - encoding: Set by user.
2130 * - decoding: unused
2136 * - encoding: Set by user.
2137 * - decoding: unused
2143 * @deprecated use encoder private options instead
2145 attribute_deprecated
2146 float rc_buffer_aggressivity;
2148 attribute_deprecated
2149 float rc_initial_cplx;
2153 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2154 * - encoding: Set by user.
2155 * - decoding: unused.
2157 float rc_max_available_vbv_use;
2160 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2161 * - encoding: Set by user.
2162 * - decoding: unused.
2164 float rc_min_vbv_overflow_use;
2167 * Number of bits which should be loaded into the rc buffer before decoding starts.
2168 * - encoding: Set by user.
2169 * - decoding: unused
2171 int rc_initial_buffer_occupancy;
2173 #define FF_CODER_TYPE_VLC 0
2174 #define FF_CODER_TYPE_AC 1
2175 #define FF_CODER_TYPE_RAW 2
2176 #define FF_CODER_TYPE_RLE 3
2177 #if FF_API_UNUSED_MEMBERS
2178 #define FF_CODER_TYPE_DEFLATE 4
2179 #endif /* FF_API_UNUSED_MEMBERS */
2182 * - encoding: Set by user.
2183 * - decoding: unused
2189 * - encoding: Set by user.
2190 * - decoding: unused
2196 * @deprecated use encoder private options instead
2198 attribute_deprecated
2202 * @deprecated use encoder private options instead
2204 attribute_deprecated
2209 * frame skip threshold
2210 * - encoding: Set by user.
2211 * - decoding: unused
2213 int frame_skip_threshold;
2217 * - encoding: Set by user.
2218 * - decoding: unused
2220 int frame_skip_factor;
2223 * frame skip exponent
2224 * - encoding: Set by user.
2225 * - decoding: unused
2230 * frame skip comparison function
2231 * - encoding: Set by user.
2232 * - decoding: unused
2237 * trellis RD quantization
2238 * - encoding: Set by user.
2239 * - decoding: unused
2244 * - encoding: Set by user.
2245 * - decoding: unused
2247 int min_prediction_order;
2250 * - encoding: Set by user.
2251 * - decoding: unused
2253 int max_prediction_order;
2256 * GOP timecode frame start number, in non drop frame format
2257 * - encoding: Set by user.
2258 * - decoding: unused
2260 int64_t timecode_frame_start;
2262 /* The RTP callback: This function is called */
2263 /* every time the encoder has a packet to send. */
2264 /* It depends on the encoder if the data starts */
2265 /* with a Start Code (it should). H.263 does. */
2266 /* mb_nb contains the number of macroblocks */
2267 /* encoded in the RTP payload. */
2268 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2270 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2271 /* do its best to deliver a chunk with size */
2272 /* below rtp_payload_size, the chunk will start */
2273 /* with a start code on some codecs like H.263. */
2274 /* This doesn't take account of any particular */
2275 /* headers inside the transmitted RTP payload. */
2277 /* statistics, used for 2-pass encoding */
2288 * number of bits used for the previously encoded frame
2289 * - encoding: Set by libavcodec.
2290 * - decoding: unused
2295 * pass1 encoding statistics output buffer
2296 * - encoding: Set by libavcodec.
2297 * - decoding: unused
2302 * pass2 encoding statistics input buffer
2303 * Concatenated stuff from stats_out of pass1 should be placed here.
2304 * - encoding: Allocated/set/freed by user.
2305 * - decoding: unused
2310 * Work around bugs in encoders which sometimes cannot be detected automatically.
2311 * - encoding: Set by user
2312 * - decoding: Set by user
2314 int workaround_bugs;
2315 #define FF_BUG_AUTODETECT 1 ///< autodetection
2316 #if FF_API_OLD_MSMPEG4
2317 #define FF_BUG_OLD_MSMPEG4 2
2319 #define FF_BUG_XVID_ILACE 4
2320 #define FF_BUG_UMP4 8
2321 #define FF_BUG_NO_PADDING 16
2322 #define FF_BUG_AMV 32
2324 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2326 #define FF_BUG_QPEL_CHROMA 64
2327 #define FF_BUG_STD_QPEL 128
2328 #define FF_BUG_QPEL_CHROMA2 256
2329 #define FF_BUG_DIRECT_BLOCKSIZE 512
2330 #define FF_BUG_EDGE 1024
2331 #define FF_BUG_HPEL_CHROMA 2048
2332 #define FF_BUG_DC_CLIP 4096
2333 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2334 #define FF_BUG_TRUNCATED 16384
2337 * strictly follow the standard (MPEG4, ...).
2338 * - encoding: Set by user.
2339 * - decoding: Set by user.
2340 * Setting this to STRICT or higher means the encoder and decoder will
2341 * generally do stupid things, whereas setting it to unofficial or lower
2342 * will mean the encoder might produce output that is not supported by all
2343 * spec-compliant decoders. Decoders don't differentiate between normal,
2344 * unofficial and experimental (that is, they always try to decode things
2345 * when they can) unless they are explicitly asked to behave stupidly
2346 * (=strictly conform to the specs)
2348 int strict_std_compliance;
2349 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2350 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2351 #define FF_COMPLIANCE_NORMAL 0
2352 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2353 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2356 * error concealment flags
2357 * - encoding: unused
2358 * - decoding: Set by user.
2360 int error_concealment;
2361 #define FF_EC_GUESS_MVS 1
2362 #define FF_EC_DEBLOCK 2
2366 * - encoding: Set by user.
2367 * - decoding: Set by user.
2370 #define FF_DEBUG_PICT_INFO 1
2371 #define FF_DEBUG_RC 2
2372 #define FF_DEBUG_BITSTREAM 4
2373 #define FF_DEBUG_MB_TYPE 8
2374 #define FF_DEBUG_QP 16
2377 * @deprecated this option does nothing
2379 #define FF_DEBUG_MV 32
2381 #define FF_DEBUG_DCT_COEFF 0x00000040
2382 #define FF_DEBUG_SKIP 0x00000080
2383 #define FF_DEBUG_STARTCODE 0x00000100
2384 #if FF_API_UNUSED_MEMBERS
2385 #define FF_DEBUG_PTS 0x00000200
2386 #endif /* FF_API_UNUSED_MEMBERS */
2387 #define FF_DEBUG_ER 0x00000400
2388 #define FF_DEBUG_MMCO 0x00000800
2389 #define FF_DEBUG_BUGS 0x00001000
2391 #define FF_DEBUG_VIS_QP 0x00002000
2392 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2394 #define FF_DEBUG_BUFFERS 0x00008000
2395 #define FF_DEBUG_THREADS 0x00010000
2399 * @deprecated this option does not have any effect
2401 attribute_deprecated
2403 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2404 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2405 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2409 * Error recognition; may misdetect some more or less valid parts as errors.
2410 * - encoding: unused
2411 * - decoding: Set by user.
2413 int err_recognition;
2416 * Verify checksums embedded in the bitstream (could be of either encoded or
2417 * decoded data, depending on the codec) and print an error message on mismatch.
2418 * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2419 * decoder returning an error.
2421 #define AV_EF_CRCCHECK (1<<0)
2422 #define AV_EF_BITSTREAM (1<<1)
2423 #define AV_EF_BUFFER (1<<2)
2424 #define AV_EF_EXPLODE (1<<3)
2427 * opaque 64bit number (generally a PTS) that will be reordered and
2428 * output in AVFrame.reordered_opaque
2429 * - encoding: unused
2430 * - decoding: Set by user.
2432 int64_t reordered_opaque;
2435 * Hardware accelerator in use
2436 * - encoding: unused.
2437 * - decoding: Set by libavcodec
2439 struct AVHWAccel *hwaccel;
2442 * Hardware accelerator context.
2443 * For some hardware accelerators, a global context needs to be
2444 * provided by the user. In that case, this holds display-dependent
2445 * data Libav cannot instantiate itself. Please refer to the
2446 * Libav HW accelerator documentation to know how to fill this
2447 * is. e.g. for VA API, this is a struct vaapi_context.
2448 * - encoding: unused
2449 * - decoding: Set by user
2451 void *hwaccel_context;
2455 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2456 * - decoding: unused
2458 uint64_t error[AV_NUM_DATA_POINTERS];
2461 * DCT algorithm, see FF_DCT_* below
2462 * - encoding: Set by user.
2463 * - decoding: unused
2466 #define FF_DCT_AUTO 0
2467 #define FF_DCT_FASTINT 1
2468 #if FF_API_UNUSED_MEMBERS
2469 #define FF_DCT_INT 2
2470 #endif /* FF_API_UNUSED_MEMBERS */
2471 #define FF_DCT_MMX 3
2472 #define FF_DCT_ALTIVEC 5
2473 #define FF_DCT_FAAN 6
2476 * IDCT algorithm, see FF_IDCT_* below.
2477 * - encoding: Set by user.
2478 * - decoding: Set by user.
2481 #define FF_IDCT_AUTO 0
2482 #define FF_IDCT_INT 1
2483 #define FF_IDCT_SIMPLE 2
2484 #define FF_IDCT_SIMPLEMMX 3
2485 #define FF_IDCT_ARM 7
2486 #define FF_IDCT_ALTIVEC 8
2488 #define FF_IDCT_SH4 9
2490 #define FF_IDCT_SIMPLEARM 10
2491 #if FF_API_UNUSED_MEMBERS
2492 #define FF_IDCT_IPP 13
2493 #endif /* FF_API_UNUSED_MEMBERS */
2494 #define FF_IDCT_XVID 14
2495 #if FF_API_IDCT_XVIDMMX
2496 #define FF_IDCT_XVIDMMX 14
2497 #endif /* FF_API_IDCT_XVIDMMX */
2498 #define FF_IDCT_SIMPLEARMV5TE 16
2499 #define FF_IDCT_SIMPLEARMV6 17
2500 #if FF_API_ARCH_SPARC
2501 #define FF_IDCT_SIMPLEVIS 18
2503 #define FF_IDCT_FAAN 20
2504 #define FF_IDCT_SIMPLENEON 22
2505 #if FF_API_ARCH_ALPHA
2506 #define FF_IDCT_SIMPLEALPHA 23
2510 * bits per sample/pixel from the demuxer (needed for huffyuv).
2511 * - encoding: Set by libavcodec.
2512 * - decoding: Set by user.
2514 int bits_per_coded_sample;
2517 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2518 * - encoding: set by user.
2519 * - decoding: set by libavcodec.
2521 int bits_per_raw_sample;
2525 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2526 * - encoding: unused
2527 * - decoding: Set by user.
2529 * @deprecated use decoder private options instead
2531 attribute_deprecated int lowres;
2535 * the picture in the bitstream
2536 * - encoding: Set by libavcodec.
2537 * - decoding: unused
2539 AVFrame *coded_frame;
2543 * is used to decide how many independent tasks should be passed to execute()
2544 * - encoding: Set by user.
2545 * - decoding: Set by user.
2550 * Which multithreading methods to use.
2551 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2552 * so clients which cannot provide future frames should not use it.
2554 * - encoding: Set by user, otherwise the default is used.
2555 * - decoding: Set by user, otherwise the default is used.
2558 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2559 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2562 * Which multithreading methods are in use by the codec.
2563 * - encoding: Set by libavcodec.
2564 * - decoding: Set by libavcodec.
2566 int active_thread_type;
2569 * Set by the client if its custom get_buffer() callback can be called
2570 * synchronously from another thread, which allows faster multithreaded decoding.
2571 * draw_horiz_band() will be called from other threads regardless of this setting.
2572 * Ignored if the default get_buffer() is used.
2573 * - encoding: Set by user.
2574 * - decoding: Set by user.
2576 int thread_safe_callbacks;
2579 * The codec may call this to execute several independent things.
2580 * It will return only after finishing all tasks.
2581 * The user may replace this with some multithreaded implementation,
2582 * the default implementation will execute the parts serially.
2583 * @param count the number of things to execute
2584 * - encoding: Set by libavcodec, user can override.
2585 * - decoding: Set by libavcodec, user can override.
2587 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2590 * The codec may call this to execute several independent things.
2591 * It will return only after finishing all tasks.
2592 * The user may replace this with some multithreaded implementation,
2593 * the default implementation will execute the parts serially.
2594 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2595 * @param c context passed also to func
2596 * @param count the number of things to execute
2597 * @param arg2 argument passed unchanged to func
2598 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2599 * @param func function that will be called count times, with jobnr from 0 to count-1.
2600 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2601 * two instances of func executing at the same time will have the same threadnr.
2602 * @return always 0 currently, but code should handle a future improvement where when any call to func
2603 * returns < 0 no further calls to func may be done and < 0 is returned.
2604 * - encoding: Set by libavcodec, user can override.
2605 * - decoding: Set by libavcodec, user can override.
2607 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2609 #if FF_API_THREAD_OPAQUE
2611 * @deprecated this field should not be used from outside of lavc
2613 attribute_deprecated
2614 void *thread_opaque;
2618 * noise vs. sse weight for the nsse comparsion function
2619 * - encoding: Set by user.
2620 * - decoding: unused
2626 * - encoding: Set by user.
2627 * - decoding: Set by libavcodec.
2630 #define FF_PROFILE_UNKNOWN -99
2631 #define FF_PROFILE_RESERVED -100
2633 #define FF_PROFILE_AAC_MAIN 0
2634 #define FF_PROFILE_AAC_LOW 1
2635 #define FF_PROFILE_AAC_SSR 2
2636 #define FF_PROFILE_AAC_LTP 3
2637 #define FF_PROFILE_AAC_HE 4
2638 #define FF_PROFILE_AAC_HE_V2 28
2639 #define FF_PROFILE_AAC_LD 22
2640 #define FF_PROFILE_AAC_ELD 38
2641 #define FF_PROFILE_MPEG2_AAC_LOW 128
2642 #define FF_PROFILE_MPEG2_AAC_HE 131
2644 #define FF_PROFILE_DTS 20
2645 #define FF_PROFILE_DTS_ES 30
2646 #define FF_PROFILE_DTS_96_24 40
2647 #define FF_PROFILE_DTS_HD_HRA 50
2648 #define FF_PROFILE_DTS_HD_MA 60
2650 #define FF_PROFILE_MPEG2_422 0
2651 #define FF_PROFILE_MPEG2_HIGH 1
2652 #define FF_PROFILE_MPEG2_SS 2
2653 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2654 #define FF_PROFILE_MPEG2_MAIN 4
2655 #define FF_PROFILE_MPEG2_SIMPLE 5
2657 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2658 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2660 #define FF_PROFILE_H264_BASELINE 66
2661 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2662 #define FF_PROFILE_H264_MAIN 77
2663 #define FF_PROFILE_H264_EXTENDED 88
2664 #define FF_PROFILE_H264_HIGH 100
2665 #define FF_PROFILE_H264_HIGH_10 110
2666 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2667 #define FF_PROFILE_H264_HIGH_422 122
2668 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2669 #define FF_PROFILE_H264_HIGH_444 144
2670 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2671 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2672 #define FF_PROFILE_H264_CAVLC_444 44
2674 #define FF_PROFILE_VC1_SIMPLE 0
2675 #define FF_PROFILE_VC1_MAIN 1
2676 #define FF_PROFILE_VC1_COMPLEX 2
2677 #define FF_PROFILE_VC1_ADVANCED 3
2679 #define FF_PROFILE_MPEG4_SIMPLE 0
2680 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2681 #define FF_PROFILE_MPEG4_CORE 2
2682 #define FF_PROFILE_MPEG4_MAIN 3
2683 #define FF_PROFILE_MPEG4_N_BIT 4
2684 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2685 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2686 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2687 #define FF_PROFILE_MPEG4_HYBRID 8
2688 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2689 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2690 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2691 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2692 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2693 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2694 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2696 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0 0
2697 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1 1
2698 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION 2
2699 #define FF_PROFILE_JPEG2000_DCINEMA_2K 3
2700 #define FF_PROFILE_JPEG2000_DCINEMA_4K 4
2703 #define FF_PROFILE_HEVC_MAIN 1
2704 #define FF_PROFILE_HEVC_MAIN_10 2
2705 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE 3
2709 * - encoding: Set by user.
2710 * - decoding: Set by libavcodec.
2713 #define FF_LEVEL_UNKNOWN -99
2717 * - encoding: unused
2718 * - decoding: Set by user.
2720 enum AVDiscard skip_loop_filter;
2724 * - encoding: unused
2725 * - decoding: Set by user.
2727 enum AVDiscard skip_idct;
2731 * - encoding: unused
2732 * - decoding: Set by user.
2734 enum AVDiscard skip_frame;
2737 * Header containing style information for text subtitles.
2738 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2739 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2740 * the Format line following. It shouldn't include any Dialogue line.
2741 * - encoding: Set/allocated/freed by user (before avcodec_open2())
2742 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2744 uint8_t *subtitle_header;
2745 int subtitle_header_size;
2747 #if FF_API_ERROR_RATE
2749 * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2752 attribute_deprecated
2756 #if FF_API_CODEC_PKT
2758 * @deprecated this field is not supposed to be accessed from outside lavc
2760 attribute_deprecated
2765 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2766 * Used for compliant TS muxing.
2767 * - encoding: Set by libavcodec.
2768 * - decoding: unused.
2773 * Encoding only. Allow encoders to output packets that do not contain any
2774 * encoded data, only side data.
2776 * Some encoders need to output such packets, e.g. to update some stream
2777 * parameters at the end of encoding.
2779 * All callers are strongly recommended to set this option to 1 and update
2780 * their code to deal with such packets, since this behaviour may become
2781 * always enabled in the future (then this option will be deprecated and
2782 * later removed). To avoid ABI issues when this happens, the callers should
2783 * use AVOptions to set this field.
2785 int side_data_only_packets;
2788 * Audio only. The number of "priming" samples (padding) inserted by the
2789 * encoder at the beginning of the audio. I.e. this number of leading
2790 * decoded samples must be discarded by the caller to get the original audio
2791 * without leading padding.
2793 * - decoding: unused
2794 * - encoding: Set by libavcodec. The timestamps on the output packets are
2795 * adjusted by the encoder so that they always refer to the
2796 * first sample of the data actually contained in the packet,
2797 * including any added padding. E.g. if the timebase is
2798 * 1/samplerate and the timestamp of the first input sample is
2799 * 0, the timestamp of the first output packet will be
2802 int initial_padding;
2805 * - decoding: For codecs that store a framerate value in the compressed
2806 * bitstream, the decoder may export it here. { 0, 1} when
2808 * - encoding: unused
2810 AVRational framerate;
2813 * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
2814 * - encoding: unused.
2815 * - decoding: Set by libavcodec before calling get_format()
2817 enum AVPixelFormat sw_pix_fmt;
2823 typedef struct AVProfile {
2825 const char *name; ///< short name for the profile
2828 typedef struct AVCodecDefault AVCodecDefault;
2835 typedef struct AVCodec {
2837 * Name of the codec implementation.
2838 * The name is globally unique among encoders and among decoders (but an
2839 * encoder and a decoder can share the same name).
2840 * This is the primary way to find a codec from the user perspective.
2844 * Descriptive name for the codec, meant to be more human readable than name.
2845 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2847 const char *long_name;
2848 enum AVMediaType type;
2851 * Codec capabilities.
2855 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2856 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2857 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2858 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2859 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2861 attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2863 const AVClass *priv_class; ///< AVClass for the private context
2864 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2866 /*****************************************************************
2867 * No fields below this line are part of the public API. They
2868 * may not be used outside of libavcodec and can be changed and
2870 * New public fields should be added right above.
2871 *****************************************************************
2874 struct AVCodec *next;
2876 * @name Frame-level threading support functions
2880 * If defined, called on thread contexts when they are created.
2881 * If the codec allocates writable tables in init(), re-allocate them here.
2882 * priv_data will be set to a copy of the original.
2884 int (*init_thread_copy)(AVCodecContext *);
2886 * Copy necessary context variables from a previous thread context to the current one.
2887 * If not defined, the next thread will start automatically; otherwise, the codec
2888 * must call ff_thread_finish_setup().
2890 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2892 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2896 * Private codec-specific defaults.
2898 const AVCodecDefault *defaults;
2901 * Initialize codec static data, called from avcodec_register().
2903 void (*init_static_data)(struct AVCodec *codec);
2905 int (*init)(AVCodecContext *);
2906 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2907 const struct AVSubtitle *sub);
2909 * Encode data to an AVPacket.
2911 * @param avctx codec context
2912 * @param avpkt output AVPacket (may contain a user-provided buffer)
2913 * @param[in] frame AVFrame containing the raw data to be encoded
2914 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2915 * non-empty packet was returned in avpkt.
2916 * @return 0 on success, negative error code on failure
2918 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2919 int *got_packet_ptr);
2920 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2921 int (*close)(AVCodecContext *);
2924 * Will be called when seeking
2926 void (*flush)(AVCodecContext *);
2930 * @defgroup lavc_hwaccel AVHWAccel
2933 typedef struct AVHWAccel {
2935 * Name of the hardware accelerated codec.
2936 * The name is globally unique among encoders and among decoders (but an
2937 * encoder and a decoder can share the same name).
2942 * Type of codec implemented by the hardware accelerator.
2944 * See AVMEDIA_TYPE_xxx
2946 enum AVMediaType type;
2949 * Codec implemented by the hardware accelerator.
2951 * See AV_CODEC_ID_xxx
2956 * Supported pixel format.
2958 * Only hardware accelerated formats are supported here.
2960 enum AVPixelFormat pix_fmt;
2963 * Hardware accelerated codec capabilities.
2964 * see FF_HWACCEL_CODEC_CAP_*
2968 /*****************************************************************
2969 * No fields below this line are part of the public API. They
2970 * may not be used outside of libavcodec and can be changed and
2972 * New public fields should be added right above.
2973 *****************************************************************
2975 struct AVHWAccel *next;
2978 * Allocate a custom buffer
2980 int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
2983 * Called at the beginning of each frame or field picture.
2985 * Meaningful frame information (codec specific) is guaranteed to
2986 * be parsed at this point. This function is mandatory.
2988 * Note that buf can be NULL along with buf_size set to 0.
2989 * Otherwise, this means the whole frame is available at this point.
2991 * @param avctx the codec context
2992 * @param buf the frame data buffer base
2993 * @param buf_size the size of the frame in bytes
2994 * @return zero if successful, a negative value otherwise
2996 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2999 * Callback for each slice.
3001 * Meaningful slice information (codec specific) is guaranteed to
3002 * be parsed at this point. This function is mandatory.
3004 * @param avctx the codec context
3005 * @param buf the slice data buffer base
3006 * @param buf_size the size of the slice in bytes
3007 * @return zero if successful, a negative value otherwise
3009 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3012 * Called at the end of each frame or field picture.
3014 * The whole picture is parsed at this point and can now be sent
3015 * to the hardware accelerator. This function is mandatory.
3017 * @param avctx the codec context
3018 * @return zero if successful, a negative value otherwise
3020 int (*end_frame)(AVCodecContext *avctx);
3023 * Size of per-frame hardware accelerator private data.
3025 * Private data is allocated with av_mallocz() before
3026 * AVCodecContext.get_buffer() and deallocated after
3027 * AVCodecContext.release_buffer().
3029 int frame_priv_data_size;
3032 * Initialize the hwaccel private data.
3034 * This will be called from ff_get_format(), after hwaccel and
3035 * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3038 int (*init)(AVCodecContext *avctx);
3041 * Uninitialize the hwaccel private data.
3043 * This will be called from get_format() or avcodec_close(), after hwaccel
3044 * and hwaccel_context are already uninitialized.
3046 int (*uninit)(AVCodecContext *avctx);
3049 * Size of the private data to allocate in
3050 * AVCodecInternal.hwaccel_priv_data.
3056 * Hardware acceleration should be used for decoding even if the codec level
3057 * used is unknown or higher than the maximum supported level reported by the
3060 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3063 * Hardware acceleration can output YUV pixel formats with a different chroma
3064 * sampling than 4:2:0 and/or other than 8 bits per component.
3066 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3073 * @defgroup lavc_picture AVPicture
3075 * Functions for working with AVPicture
3080 * four components are given, that's all.
3081 * the last component is alpha
3083 typedef struct AVPicture {
3084 uint8_t *data[AV_NUM_DATA_POINTERS];
3085 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3092 #define AVPALETTE_SIZE 1024
3093 #define AVPALETTE_COUNT 256
3095 enum AVSubtitleType {
3098 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3101 * Plain text, the text field must be set by the decoder and is
3102 * authoritative. ass and pict fields may contain approximations.
3107 * Formatted text, the ass field must be set by the decoder and is
3108 * authoritative. pict and text fields may contain approximations.
3113 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3115 typedef struct AVSubtitleRect {
3116 int x; ///< top left corner of pict, undefined when pict is not set
3117 int y; ///< top left corner of pict, undefined when pict is not set
3118 int w; ///< width of pict, undefined when pict is not set
3119 int h; ///< height of pict, undefined when pict is not set
3120 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3123 * data+linesize for the bitmap of this subtitle.
3124 * can be set for text/ass as well once they where rendered
3127 enum AVSubtitleType type;
3129 char *text; ///< 0 terminated plain UTF-8 text
3132 * 0 terminated ASS/SSA compatible event line.
3133 * The pressentation of this is unaffected by the other values in this
3140 typedef struct AVSubtitle {
3141 uint16_t format; /* 0 = graphics */
3142 uint32_t start_display_time; /* relative to packet pts, in ms */
3143 uint32_t end_display_time; /* relative to packet pts, in ms */
3145 AVSubtitleRect **rects;
3146 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3150 * If c is NULL, returns the first registered codec,
3151 * if c is non-NULL, returns the next registered codec after c,
3152 * or NULL if c is the last one.
3154 AVCodec *av_codec_next(const AVCodec *c);
3157 * Return the LIBAVCODEC_VERSION_INT constant.
3159 unsigned avcodec_version(void);
3162 * Return the libavcodec build-time configuration.
3164 const char *avcodec_configuration(void);
3167 * Return the libavcodec license.
3169 const char *avcodec_license(void);
3172 * Register the codec codec and initialize libavcodec.
3174 * @warning either this function or avcodec_register_all() must be called
3175 * before any other libavcodec functions.
3177 * @see avcodec_register_all()
3179 void avcodec_register(AVCodec *codec);
3182 * Register all the codecs, parsers and bitstream filters which were enabled at
3183 * configuration time. If you do not call this function you can select exactly
3184 * which formats you want to support, by using the individual registration
3187 * @see avcodec_register
3188 * @see av_register_codec_parser
3189 * @see av_register_bitstream_filter
3191 void avcodec_register_all(void);
3194 * Allocate an AVCodecContext and set its fields to default values. The
3195 * resulting struct should be freed with avcodec_free_context().
3197 * @param codec if non-NULL, allocate private data and initialize defaults
3198 * for the given codec. It is illegal to then call avcodec_open2()
3199 * with a different codec.
3200 * If NULL, then the codec-specific defaults won't be initialized,
3201 * which may result in suboptimal default settings (this is
3202 * important mainly for encoders, e.g. libx264).
3204 * @return An AVCodecContext filled with default values or NULL on failure.
3205 * @see avcodec_get_context_defaults
3207 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3210 * Free the codec context and everything associated with it and write NULL to
3211 * the provided pointer.
3213 void avcodec_free_context(AVCodecContext **avctx);
3216 * Set the fields of the given AVCodecContext to default values corresponding
3217 * to the given codec (defaults may be codec-dependent).
3219 * Do not call this function if a non-NULL codec has been passed
3220 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3221 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3222 * different codec on this AVCodecContext.
3224 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3227 * Get the AVClass for AVCodecContext. It can be used in combination with
3228 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3230 * @see av_opt_find().
3232 const AVClass *avcodec_get_class(void);
3235 * Copy the settings of the source AVCodecContext into the destination
3236 * AVCodecContext. The resulting destination codec context will be
3237 * unopened, i.e. you are required to call avcodec_open2() before you
3238 * can use this AVCodecContext to decode/encode video/audio data.
3240 * @param dest target codec context, should be initialized with
3241 * avcodec_alloc_context3(), but otherwise uninitialized
3242 * @param src source codec context
3243 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3245 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3247 #if FF_API_AVFRAME_LAVC
3249 * @deprecated use av_frame_alloc()
3251 attribute_deprecated
3252 AVFrame *avcodec_alloc_frame(void);
3255 * Set the fields of the given AVFrame to default values.
3257 * @param frame The AVFrame of which the fields should be set to default values.
3259 * @deprecated use av_frame_unref()
3261 attribute_deprecated
3262 void avcodec_get_frame_defaults(AVFrame *frame);
3265 * Free the frame and any dynamically allocated objects in it,
3266 * e.g. extended_data.
3268 * @param frame frame to be freed. The pointer will be set to NULL.
3270 * @warning this function does NOT free the data buffers themselves
3271 * (it does not know how, since they might have been allocated with
3272 * a custom get_buffer()).
3274 * @deprecated use av_frame_free()
3276 attribute_deprecated
3277 void avcodec_free_frame(AVFrame **frame);
3281 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3282 * function the context has to be allocated with avcodec_alloc_context3().
3284 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3285 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3286 * retrieving a codec.
3288 * @warning This function is not thread safe!
3290 * @note Always call this function before using decoding routines (such as
3291 * @ref avcodec_decode_video2()).
3294 * avcodec_register_all();
3295 * av_dict_set(&opts, "b", "2.5M", 0);
3296 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3300 * context = avcodec_alloc_context3(codec);
3302 * if (avcodec_open2(context, codec, opts) < 0)
3306 * @param avctx The context to initialize.
3307 * @param codec The codec to open this context for. If a non-NULL codec has been
3308 * previously passed to avcodec_alloc_context3() or
3309 * avcodec_get_context_defaults3() for this context, then this
3310 * parameter MUST be either NULL or equal to the previously passed
3312 * @param options A dictionary filled with AVCodecContext and codec-private options.
3313 * On return this object will be filled with options that were not found.
3315 * @return zero on success, a negative value on error
3316 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3317 * av_dict_set(), av_opt_find().
3319 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3322 * Close a given AVCodecContext and free all the data associated with it
3323 * (but not the AVCodecContext itself).
3325 * Calling this function on an AVCodecContext that hasn't been opened will free
3326 * the codec-specific data allocated in avcodec_alloc_context3() /
3327 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3330 int avcodec_close(AVCodecContext *avctx);
3333 * Free all allocated data in the given subtitle struct.
3335 * @param sub AVSubtitle to free.
3337 void avsubtitle_free(AVSubtitle *sub);
3344 * @addtogroup lavc_packet
3348 #if FF_API_DESTRUCT_PACKET
3350 * Default packet destructor.
3351 * @deprecated use the AVBuffer API instead
3353 attribute_deprecated
3354 void av_destruct_packet(AVPacket *pkt);
3358 * Initialize optional fields of a packet with default values.
3360 * Note, this does not touch the data and size members, which have to be
3361 * initialized separately.
3365 void av_init_packet(AVPacket *pkt);
3368 * Allocate the payload of a packet and initialize its fields with
3372 * @param size wanted payload size
3373 * @return 0 if OK, AVERROR_xxx otherwise
3375 int av_new_packet(AVPacket *pkt, int size);
3378 * Reduce packet size, correctly zeroing padding
3381 * @param size new size
3383 void av_shrink_packet(AVPacket *pkt, int size);
3386 * Increase packet size, correctly zeroing padding
3389 * @param grow_by number of bytes by which to increase the size of the packet
3391 int av_grow_packet(AVPacket *pkt, int grow_by);
3394 * Initialize a reference-counted packet from av_malloc()ed data.
3396 * @param pkt packet to be initialized. This function will set the data, size,
3397 * buf and destruct fields, all others are left untouched.
3398 * @param data Data allocated by av_malloc() to be used as packet data. If this
3399 * function returns successfully, the data is owned by the underlying AVBuffer.
3400 * The caller may not access the data through other means.
3401 * @param size size of data in bytes, without the padding. I.e. the full buffer
3402 * size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3404 * @return 0 on success, a negative AVERROR on error
3406 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3409 * @warning This is a hack - the packet memory allocation stuff is broken. The
3410 * packet is allocated if it was not really allocated.
3412 int av_dup_packet(AVPacket *pkt);
3417 * @param pkt packet to free
3419 void av_free_packet(AVPacket *pkt);
3422 * Allocate new information of a packet.
3425 * @param type side information type
3426 * @param size side information size
3427 * @return pointer to fresh allocated data or NULL otherwise
3429 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3433 * Shrink the already allocated side data buffer
3436 * @param type side information type
3437 * @param size new side information size
3438 * @return 0 on success, < 0 on failure
3440 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3444 * Get side information from packet.
3447 * @param type desired side information type
3448 * @param size pointer for side information size to store (optional)
3449 * @return pointer to data if present or NULL otherwise
3451 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3455 * Convenience function to free all the side data stored.
3456 * All the other fields stay untouched.
3460 void av_packet_free_side_data(AVPacket *pkt);
3463 * Setup a new reference to the data described by a given packet
3465 * If src is reference-counted, setup dst as a new reference to the
3466 * buffer in src. Otherwise allocate a new buffer in dst and copy the
3467 * data from src into it.
3469 * All the other fields are copied from src.
3471 * @see av_packet_unref
3473 * @param dst Destination packet
3474 * @param src Source packet
3476 * @return 0 on success, a negative AVERROR on error.
3478 int av_packet_ref(AVPacket *dst, AVPacket *src);
3483 * Unreference the buffer referenced by the packet and reset the
3484 * remaining packet fields to their default values.
3486 * @param pkt The packet to be unreferenced.
3488 void av_packet_unref(AVPacket *pkt);
3491 * Move every field in src to dst and reset src.
3493 * @see av_packet_unref
3495 * @param src Source packet, will be reset
3496 * @param dst Destination packet
3498 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3501 * Copy only "properties" fields from src to dst.
3503 * Properties for the purpose of this function are all the fields
3504 * beside those related to the packet data (buf, data, size)
3506 * @param dst Destination packet
3507 * @param src Source packet
3509 * @return 0 on success AVERROR on failure.
3512 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3515 * Convert valid timing fields (timestamps / durations) in a packet from one
3516 * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
3519 * @param pkt packet on which the conversion will be performed
3520 * @param tb_src source timebase, in which the timing fields in pkt are
3522 * @param tb_dst destination timebase, to which the timing fields will be
3525 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
3532 * @addtogroup lavc_decoding
3537 * Find a registered decoder with a matching codec ID.
3539 * @param id AVCodecID of the requested decoder
3540 * @return A decoder if one was found, NULL otherwise.
3542 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3545 * Find a registered decoder with the specified name.
3547 * @param name name of the requested decoder
3548 * @return A decoder if one was found, NULL otherwise.
3550 AVCodec *avcodec_find_decoder_by_name(const char *name);
3552 #if FF_API_GET_BUFFER
3553 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3554 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3555 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3559 * The default callback for AVCodecContext.get_buffer2(). It is made public so
3560 * it can be called by custom get_buffer2() implementations for decoders without
3561 * CODEC_CAP_DR1 set.
3563 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3567 * Return the amount of padding in pixels which the get_buffer callback must
3568 * provide around the edge of the image for codecs which do not have the
3569 * CODEC_FLAG_EMU_EDGE flag.
3571 * @return Required padding in pixels.
3573 * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3576 attribute_deprecated
3577 unsigned avcodec_get_edge_width(void);
3581 * Modify width and height values so that they will result in a memory
3582 * buffer that is acceptable for the codec if you do not use any horizontal
3585 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3587 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3590 * Modify width and height values so that they will result in a memory
3591 * buffer that is acceptable for the codec if you also ensure that all
3592 * line sizes are a multiple of the respective linesize_align[i].
3594 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3596 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3597 int linesize_align[AV_NUM_DATA_POINTERS]);
3600 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3602 * Some decoders may support multiple frames in a single AVPacket. Such
3603 * decoders would then just decode the first frame and the return value would be
3604 * less than the packet size. In this case, avcodec_decode_audio4 has to be
3605 * called again with an AVPacket containing the remaining data in order to
3606 * decode the second frame, etc... Even if no frames are returned, the packet
3607 * needs to be fed to the decoder with remaining data until it is completely
3608 * consumed or an error occurs.
3610 * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3611 * and output. This means that for some packets they will not immediately
3612 * produce decoded output and need to be flushed at the end of decoding to get
3613 * all the decoded data. Flushing is done by calling this function with packets
3614 * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3615 * returning samples. It is safe to flush even those decoders that are not
3616 * marked with CODEC_CAP_DELAY, then no samples will be returned.
3618 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3619 * larger than the actual read bytes because some optimized bitstream
3620 * readers read 32 or 64 bits at once and could read over the end.
3622 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3623 * before packets may be fed to the decoder.
3625 * @param avctx the codec context
3626 * @param[out] frame The AVFrame in which to store decoded audio samples.
3627 * The decoder will allocate a buffer for the decoded frame by
3628 * calling the AVCodecContext.get_buffer2() callback.
3629 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3630 * reference counted and the returned reference belongs to the
3631 * caller. The caller must release the frame using av_frame_unref()
3632 * when the frame is no longer needed. The caller may safely write
3633 * to the frame if av_frame_is_writable() returns 1.
3634 * When AVCodecContext.refcounted_frames is set to 0, the returned
3635 * reference belongs to the decoder and is valid only until the
3636 * next call to this function or until closing or flushing the
3637 * decoder. The caller may not write to it.
3638 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3639 * non-zero. Note that this field being set to zero
3640 * does not mean that an error has occurred. For
3641 * decoders with CODEC_CAP_DELAY set, no given decode
3642 * call is guaranteed to produce a frame.
3643 * @param[in] avpkt The input AVPacket containing the input buffer.
3644 * At least avpkt->data and avpkt->size should be set. Some
3645 * decoders might also require additional fields to be set.
3646 * @return A negative error code is returned if an error occurred during
3647 * decoding, otherwise the number of bytes consumed from the input
3648 * AVPacket is returned.
3650 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3651 int *got_frame_ptr, AVPacket *avpkt);
3654 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3655 * Some decoders may support multiple frames in a single AVPacket, such
3656 * decoders would then just decode the first frame.
3658 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3659 * the actual read bytes because some optimized bitstream readers read 32 or 64
3660 * bits at once and could read over the end.
3662 * @warning The end of the input buffer buf should be set to 0 to ensure that
3663 * no overreading happens for damaged MPEG streams.
3665 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3666 * between input and output, these need to be fed with avpkt->data=NULL,
3667 * avpkt->size=0 at the end to return the remaining frames.
3669 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3670 * before packets may be fed to the decoder.
3672 * @param avctx the codec context
3673 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3674 * Use av_frame_alloc() to get an AVFrame. The codec will
3675 * allocate memory for the actual bitmap by calling the
3676 * AVCodecContext.get_buffer2() callback.
3677 * When AVCodecContext.refcounted_frames is set to 1, the frame is
3678 * reference counted and the returned reference belongs to the
3679 * caller. The caller must release the frame using av_frame_unref()
3680 * when the frame is no longer needed. The caller may safely write
3681 * to the frame if av_frame_is_writable() returns 1.
3682 * When AVCodecContext.refcounted_frames is set to 0, the returned
3683 * reference belongs to the decoder and is valid only until the
3684 * next call to this function or until closing or flushing the
3685 * decoder. The caller may not write to it.
3687 * @param[in] avpkt The input AVpacket containing the input buffer.
3688 * You can create such packet with av_init_packet() and by then setting
3689 * data and size, some decoders might in addition need other fields like
3690 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3692 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3693 * @return On error a negative value is returned, otherwise the number of bytes
3694 * used or zero if no frame could be decompressed.
3696 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3697 int *got_picture_ptr,
3701 * Decode a subtitle message.
3702 * Return a negative value on error, otherwise return the number of bytes used.
3703 * If no subtitle could be decompressed, got_sub_ptr is zero.
3704 * Otherwise, the subtitle is stored in *sub.
3705 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3706 * simplicity, because the performance difference is expect to be negligible
3707 * and reusing a get_buffer written for video codecs would probably perform badly
3708 * due to a potentially very different allocation pattern.
3710 * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
3711 * before packets may be fed to the decoder.
3713 * @param avctx the codec context
3714 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3715 freed with avsubtitle_free if *got_sub_ptr is set.
3716 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3717 * @param[in] avpkt The input AVPacket containing the input buffer.
3719 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3724 * @defgroup lavc_parsing Frame parsing
3728 enum AVPictureStructure {
3729 AV_PICTURE_STRUCTURE_UNKNOWN, //< unknown
3730 AV_PICTURE_STRUCTURE_TOP_FIELD, //< coded as top field
3731 AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3732 AV_PICTURE_STRUCTURE_FRAME, //< coded as frame
3735 typedef struct AVCodecParserContext {
3737 struct AVCodecParser *parser;
3738 int64_t frame_offset; /* offset of the current frame */
3739 int64_t cur_offset; /* current offset
3740 (incremented by each av_parser_parse()) */
3741 int64_t next_frame_offset; /* offset of the next frame */
3743 int pict_type; /* XXX: Put it back in AVCodecContext. */
3745 * This field is used for proper frame duration computation in lavf.
3746 * It signals, how much longer the frame duration of the current frame
3747 * is compared to normal frame duration.
3749 * frame_duration = (1 + repeat_pict) * time_base
3751 * It is used by codecs like H.264 to display telecined material.
3753 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3754 int64_t pts; /* pts of the current frame */
3755 int64_t dts; /* dts of the current frame */
3760 int fetch_timestamp;
3762 #define AV_PARSER_PTS_NB 4
3763 int cur_frame_start_index;
3764 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3765 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3766 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3769 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3770 #define PARSER_FLAG_ONCE 0x0002
3771 /// Set if the parser has a valid file offset
3772 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3774 int64_t offset; ///< byte offset from starting packet start
3775 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3778 * Set by parser to 1 for key frames and 0 for non-key frames.
3779 * It is initialized to -1, so if the parser doesn't set this flag,
3780 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3786 * Time difference in stream time base units from the pts of this
3787 * packet to the point at which the output from the decoder has converged
3788 * independent from the availability of previous frames. That is, the
3789 * frames are virtually identical no matter if decoding started from
3790 * the very first frame or from this keyframe.
3791 * Is AV_NOPTS_VALUE if unknown.
3792 * This field is not the display duration of the current frame.
3793 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3796 * The purpose of this field is to allow seeking in streams that have no
3797 * keyframes in the conventional sense. It corresponds to the
3798 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3799 * essential for some types of subtitle streams to ensure that all
3800 * subtitles are correctly displayed after seeking.
3802 int64_t convergence_duration;
3804 // Timestamp generation support:
3806 * Synchronization point for start of timestamp generation.
3808 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3811 * For example, this corresponds to presence of H.264 buffering period
3817 * Offset of the current timestamp against last timestamp sync point in
3818 * units of AVCodecContext.time_base.
3820 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3821 * contain a valid timestamp offset.
3823 * Note that the timestamp of sync point has usually a nonzero
3824 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3825 * the next frame after timestamp sync point will be usually 1.
3827 * For example, this corresponds to H.264 cpb_removal_delay.
3829 int dts_ref_dts_delta;
3832 * Presentation delay of current frame in units of AVCodecContext.time_base.
3834 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3835 * contain valid non-negative timestamp delta (presentation time of a frame
3836 * must not lie in the past).
3838 * This delay represents the difference between decoding and presentation
3839 * time of the frame.
3841 * For example, this corresponds to H.264 dpb_output_delay.
3846 * Position of the packet in file.
3848 * Analogous to cur_frame_pts/dts
3850 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3853 * Byte position of currently parsed frame in stream.
3858 * Previous frame byte position.
3863 * Duration of the current frame.
3864 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3865 * For all other types, this is in units of AVCodecContext.time_base.
3869 enum AVFieldOrder field_order;
3872 * Indicate whether a picture is coded as a frame, top field or bottom field.
3874 * For example, H.264 field_pic_flag equal to 0 corresponds to
3875 * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3876 * equal to 1 and bottom_field_flag equal to 0 corresponds to
3877 * AV_PICTURE_STRUCTURE_TOP_FIELD.
3879 enum AVPictureStructure picture_structure;
3882 * Picture number incremented in presentation or output order.
3883 * This field may be reinitialized at the first picture of a new sequence.
3885 * For example, this corresponds to H.264 PicOrderCnt.
3887 int output_picture_number;
3890 * Dimensions of the decoded video intended for presentation.
3896 * Dimensions of the coded video.
3902 * The format of the coded data, corresponds to enum AVPixelFormat for video
3903 * and for enum AVSampleFormat for audio.
3905 * Note that a decoder can have considerable freedom in how exactly it
3906 * decodes the data, so the format reported here might be different from the
3907 * one returned by a decoder.
3910 } AVCodecParserContext;
3912 typedef struct AVCodecParser {
3913 int codec_ids[5]; /* several codec IDs are permitted */
3915 int (*parser_init)(AVCodecParserContext *s);
3916 /* This callback never returns an error, a negative value means that
3917 * the frame start was in a previous packet. */
3918 int (*parser_parse)(AVCodecParserContext *s,
3919 AVCodecContext *avctx,
3920 const uint8_t **poutbuf, int *poutbuf_size,
3921 const uint8_t *buf, int buf_size);
3922 void (*parser_close)(AVCodecParserContext *s);
3923 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3924 struct AVCodecParser *next;
3927 AVCodecParser *av_parser_next(const AVCodecParser *c);
3929 void av_register_codec_parser(AVCodecParser *parser);
3930 AVCodecParserContext *av_parser_init(int codec_id);
3935 * @param s parser context.
3936 * @param avctx codec context.
3937 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3938 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3939 * @param buf input buffer.
3940 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3941 * @param pts input presentation timestamp.
3942 * @param dts input decoding timestamp.
3943 * @param pos input byte position in stream.
3944 * @return the number of bytes of the input bitstream used.
3949 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3956 * decode_frame(data, size);
3960 int av_parser_parse2(AVCodecParserContext *s,
3961 AVCodecContext *avctx,
3962 uint8_t **poutbuf, int *poutbuf_size,
3963 const uint8_t *buf, int buf_size,
3964 int64_t pts, int64_t dts,
3968 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3969 * @deprecated use AVBitstreamFilter
3971 int av_parser_change(AVCodecParserContext *s,
3972 AVCodecContext *avctx,
3973 uint8_t **poutbuf, int *poutbuf_size,
3974 const uint8_t *buf, int buf_size, int keyframe);
3975 void av_parser_close(AVCodecParserContext *s);
3983 * @addtogroup lavc_encoding
3988 * Find a registered encoder with a matching codec ID.
3990 * @param id AVCodecID of the requested encoder
3991 * @return An encoder if one was found, NULL otherwise.
3993 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3996 * Find a registered encoder with the specified name.
3998 * @param name name of the requested encoder
3999 * @return An encoder if one was found, NULL otherwise.
4001 AVCodec *avcodec_find_encoder_by_name(const char *name);
4004 * Encode a frame of audio.
4006 * Takes input samples from frame and writes the next output packet, if
4007 * available, to avpkt. The output packet does not necessarily contain data for
4008 * the most recent frame, as encoders can delay, split, and combine input frames
4009 * internally as needed.
4011 * @param avctx codec context
4012 * @param avpkt output AVPacket.
4013 * The user can supply an output buffer by setting
4014 * avpkt->data and avpkt->size prior to calling the
4015 * function, but if the size of the user-provided data is not
4016 * large enough, encoding will fail. All other AVPacket fields
4017 * will be reset by the encoder using av_init_packet(). If
4018 * avpkt->data is NULL, the encoder will allocate it.
4019 * The encoder will set avpkt->size to the size of the
4022 * If this function fails or produces no output, avpkt will be
4023 * freed using av_free_packet() (i.e. avpkt->destruct will be
4024 * called to free the user supplied buffer).
4025 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4026 * May be NULL when flushing an encoder that has the
4027 * CODEC_CAP_DELAY capability set.
4028 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4029 * can have any number of samples.
4030 * If it is not set, frame->nb_samples must be equal to
4031 * avctx->frame_size for all frames except the last.
4032 * The final frame may be smaller than avctx->frame_size.
4033 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4034 * output packet is non-empty, and to 0 if it is
4035 * empty. If the function returns an error, the
4036 * packet can be assumed to be invalid, and the
4037 * value of got_packet_ptr is undefined and should
4039 * @return 0 on success, negative error code on failure
4041 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4042 const AVFrame *frame, int *got_packet_ptr);
4045 * Encode a frame of video.
4047 * Takes input raw video data from frame and writes the next output packet, if
4048 * available, to avpkt. The output packet does not necessarily contain data for
4049 * the most recent frame, as encoders can delay and reorder input frames
4050 * internally as needed.
4052 * @param avctx codec context
4053 * @param avpkt output AVPacket.
4054 * The user can supply an output buffer by setting
4055 * avpkt->data and avpkt->size prior to calling the
4056 * function, but if the size of the user-provided data is not
4057 * large enough, encoding will fail. All other AVPacket fields
4058 * will be reset by the encoder using av_init_packet(). If
4059 * avpkt->data is NULL, the encoder will allocate it.
4060 * The encoder will set avpkt->size to the size of the
4061 * output packet. The returned data (if any) belongs to the
4062 * caller, he is responsible for freeing it.
4064 * If this function fails or produces no output, avpkt will be
4065 * freed using av_free_packet() (i.e. avpkt->destruct will be
4066 * called to free the user supplied buffer).
4067 * @param[in] frame AVFrame containing the raw video data to be encoded.
4068 * May be NULL when flushing an encoder that has the
4069 * CODEC_CAP_DELAY capability set.
4070 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4071 * output packet is non-empty, and to 0 if it is
4072 * empty. If the function returns an error, the
4073 * packet can be assumed to be invalid, and the
4074 * value of got_packet_ptr is undefined and should
4076 * @return 0 on success, negative error code on failure
4078 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4079 const AVFrame *frame, int *got_packet_ptr);
4081 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4082 const AVSubtitle *sub);
4090 * @addtogroup lavc_picture
4095 * Allocate memory for a picture. Call avpicture_free() to free it.
4097 * @see avpicture_fill()
4099 * @param picture the picture to be filled in
4100 * @param pix_fmt the format of the picture
4101 * @param width the width of the picture
4102 * @param height the height of the picture
4103 * @return zero if successful, a negative value if not
4105 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4108 * Free a picture previously allocated by avpicture_alloc().
4109 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4112 * @param picture the AVPicture to be freed
4114 void avpicture_free(AVPicture *picture);
4117 * Fill in the AVPicture fields, always assume a linesize alignment of 1.
4119 * @see av_image_fill_arrays().
4121 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4122 enum AVPixelFormat pix_fmt, int width, int height);
4125 * Copy pixel data from an AVPicture into a buffer, always assume a
4126 * linesize alignment of 1.
4128 * @see av_image_copy_to_buffer().
4130 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4131 int width, int height,
4132 unsigned char *dest, int dest_size);
4135 * Calculate the size in bytes that a picture of the given width and height
4136 * would occupy if stored in the given picture format.
4137 * Always assume a linesize alignment of 1.
4139 * @see av_image_get_buffer_size().
4141 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4143 #if FF_API_DEINTERLACE
4145 * deinterlace - if not supported return -1
4147 * @deprecated - use yadif (in libavfilter) instead
4149 attribute_deprecated
4150 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4151 enum AVPixelFormat pix_fmt, int width, int height);
4154 * Copy image src to dst. Wraps av_picture_data_copy() above.
4156 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4157 enum AVPixelFormat pix_fmt, int width, int height);
4160 * Crop image top and left side.
4162 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4163 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4168 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4169 int padtop, int padbottom, int padleft, int padright, int *color);
4176 * @defgroup lavc_misc Utility functions
4179 * Miscellaneous utility functions related to both encoding and decoding
4185 * @defgroup lavc_misc_pixfmt Pixel formats
4187 * Functions for working with pixel formats.
4192 * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4195 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4198 * Return a value representing the fourCC code associated to the
4199 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4202 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4204 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4205 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4206 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4207 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4208 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4209 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4212 * Compute what kind of losses will occur when converting from one specific
4213 * pixel format to another.
4214 * When converting from one pixel format to another, information loss may occur.
4215 * For example, when converting from RGB24 to GRAY, the color information will
4216 * be lost. Similarly, other losses occur when converting from some formats to
4217 * other formats. These losses can involve loss of chroma, but also loss of
4218 * resolution, loss of color depth, loss due to the color space conversion, loss
4219 * of the alpha bits or loss due to color quantization.
4220 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4221 * which will occur when converting from one pixel format to another.
4223 * @param[in] dst_pix_fmt destination pixel format
4224 * @param[in] src_pix_fmt source pixel format
4225 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4226 * @return Combination of flags informing you what kind of losses will occur.
4228 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4232 * Find the best pixel format to convert to given a certain source pixel
4233 * format. When converting from one pixel format to another, information loss
4234 * may occur. For example, when converting from RGB24 to GRAY, the color
4235 * information will be lost. Similarly, other losses occur when converting from
4236 * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4237 * the given pixel formats should be used to suffer the least amount of loss.
4238 * The pixel formats from which it chooses one, are determined by the
4239 * pix_fmt_list parameter.
4242 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4243 * @param[in] src_pix_fmt source pixel format
4244 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4245 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4246 * @return The best pixel format to convert to or -1 if none was found.
4248 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4249 enum AVPixelFormat src_pix_fmt,
4250 int has_alpha, int *loss_ptr);
4252 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4258 #if FF_API_SET_DIMENSIONS
4260 * @deprecated this function is not supposed to be used from outside of lavc
4262 attribute_deprecated
4263 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4267 * Put a string representing the codec tag codec_tag in buf.
4269 * @param buf buffer to place codec tag in
4270 * @param buf_size size in bytes of buf
4271 * @param codec_tag codec tag to assign
4272 * @return the length of the string that would have been generated if
4273 * enough space had been available, excluding the trailing null
4275 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4277 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4280 * Return a name for the specified profile, if available.
4282 * @param codec the codec that is searched for the given profile
4283 * @param profile the profile value for which a name is requested
4284 * @return A name for the profile if found, NULL otherwise.
4286 const char *av_get_profile_name(const AVCodec *codec, int profile);
4288 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4289 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4290 //FIXME func typedef
4293 * Fill audio frame data and linesize.
4294 * AVFrame extended_data channel pointers are allocated if necessary for
4297 * @param frame the AVFrame
4298 * frame->nb_samples must be set prior to calling the
4299 * function. This function fills in frame->data,
4300 * frame->extended_data, frame->linesize[0].
4301 * @param nb_channels channel count
4302 * @param sample_fmt sample format
4303 * @param buf buffer to use for frame data
4304 * @param buf_size size of buffer
4305 * @param align plane size sample alignment (0 = default)
4306 * @return 0 on success, negative error code on failure
4308 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4309 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4310 int buf_size, int align);
4313 * Reset the internal decoder state / flush internal buffers. Should be called
4314 * e.g. when seeking or when switching to a different stream.
4316 * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4317 * this invalidates the frames previously returned from the decoder. When
4318 * refcounted frames are used, the decoder just releases any references it might
4319 * keep internally, but the caller's reference remains valid.
4321 void avcodec_flush_buffers(AVCodecContext *avctx);
4324 * Return codec bits per sample.
4326 * @param[in] codec_id the codec
4327 * @return Number of bits per sample or zero if unknown for the given codec.
4329 int av_get_bits_per_sample(enum AVCodecID codec_id);
4332 * Return codec bits per sample.
4333 * Only return non-zero if the bits per sample is exactly correct, not an
4336 * @param[in] codec_id the codec
4337 * @return Number of bits per sample or zero if unknown for the given codec.
4339 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4342 * Return audio frame duration.
4344 * @param avctx codec context
4345 * @param frame_bytes size of the frame, or 0 if unknown
4346 * @return frame duration, in samples, if known. 0 if not able to
4349 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4352 typedef struct AVBitStreamFilterContext {
4354 struct AVBitStreamFilter *filter;
4355 AVCodecParserContext *parser;
4356 struct AVBitStreamFilterContext *next;
4357 } AVBitStreamFilterContext;
4360 typedef struct AVBitStreamFilter {
4363 int (*filter)(AVBitStreamFilterContext *bsfc,
4364 AVCodecContext *avctx, const char *args,
4365 uint8_t **poutbuf, int *poutbuf_size,
4366 const uint8_t *buf, int buf_size, int keyframe);
4367 void (*close)(AVBitStreamFilterContext *bsfc);
4368 struct AVBitStreamFilter *next;
4369 } AVBitStreamFilter;
4371 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4372 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4373 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4374 AVCodecContext *avctx, const char *args,
4375 uint8_t **poutbuf, int *poutbuf_size,
4376 const uint8_t *buf, int buf_size, int keyframe);
4377 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4379 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
4384 * Allocate a buffer with padding, reusing the given one if large enough.
4386 * Same behaviour av_fast_malloc but the buffer has additional
4387 * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4390 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4393 * Encode extradata length to a buffer. Used by xiph codecs.
4395 * @param s buffer to write to; must be at least (v/255+1) bytes long
4396 * @param v size of extradata in bytes
4397 * @return number of bytes written to the buffer.
4399 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4401 #if FF_API_MISSING_SAMPLE
4403 * Log a generic warning message about a missing feature. This function is
4404 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4405 * only, and would normally not be used by applications.
4406 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4407 * a pointer to an AVClass struct
4408 * @param[in] feature string containing the name of the missing feature
4409 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4410 * If want_sample is non-zero, additional verbage will be added to the log
4411 * message which tells the user how to report samples to the development
4413 * @deprecated Use avpriv_report_missing_feature() instead.
4415 attribute_deprecated
4416 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4419 * Log a generic warning message asking for a sample. This function is
4420 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4421 * only, and would normally not be used by applications.
4422 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4423 * a pointer to an AVClass struct
4424 * @param[in] msg string containing an optional message, or NULL if no message
4425 * @deprecated Use avpriv_request_sample() instead.
4427 attribute_deprecated
4428 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4429 #endif /* FF_API_MISSING_SAMPLE */
4432 * Register the hardware accelerator hwaccel.
4434 void av_register_hwaccel(AVHWAccel *hwaccel);
4437 * If hwaccel is NULL, returns the first registered hardware accelerator,
4438 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4439 * after hwaccel, or NULL if hwaccel is the last one.
4441 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
4445 * Lock operation used by lockmgr
4448 AV_LOCK_CREATE, ///< Create a mutex
4449 AV_LOCK_OBTAIN, ///< Lock the mutex
4450 AV_LOCK_RELEASE, ///< Unlock the mutex
4451 AV_LOCK_DESTROY, ///< Free mutex resources
4455 * Register a user provided lock manager supporting the operations
4456 * specified by AVLockOp. The "mutex" argument to the function points
4457 * to a (void *) where the lockmgr should store/get a pointer to a user
4458 * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
4459 * value left by the last call for all other ops. If the lock manager is
4460 * unable to perform the op then it should leave the mutex in the same
4461 * state as when it was called and return a non-zero value. However,
4462 * when called with AV_LOCK_DESTROY the mutex will always be assumed to
4463 * have been successfully destroyed. If av_lockmgr_register succeeds
4464 * it will return a non-negative value, if it fails it will return a
4465 * negative value and destroy all mutex and unregister all callbacks.
4466 * av_lockmgr_register is not thread-safe, it must be called from a
4467 * single thread before any calls which make use of locking are used.
4469 * @param cb User defined callback. av_lockmgr_register invokes calls
4470 * to this callback and the previously registered callback.
4471 * The callback will be used to create more than one mutex
4472 * each of which must be backed by its own underlying locking
4473 * mechanism (i.e. do not use a single static object to
4474 * implement your lock manager). If cb is set to NULL the
4475 * lockmgr will be unregistered.
4477 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4480 * Get the type of the given codec.
4482 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4485 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4486 * with no corresponding avcodec_close()), 0 otherwise.
4488 int avcodec_is_open(AVCodecContext *s);
4491 * @return a non-zero number if codec is an encoder, zero otherwise
4493 int av_codec_is_encoder(const AVCodec *codec);
4496 * @return a non-zero number if codec is a decoder, zero otherwise
4498 int av_codec_is_decoder(const AVCodec *codec);
4501 * @return descriptor for given codec ID or NULL if no descriptor exists.
4503 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4506 * Iterate over all codec descriptors known to libavcodec.
4508 * @param prev previous descriptor. NULL to get the first descriptor.
4510 * @return next descriptor or NULL after the last descriptor
4512 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4515 * @return codec descriptor with the given name or NULL if no such descriptor
4518 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4524 #endif /* AVCODEC_AVCODEC_H */