2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/channel_layout.h"
34 #include "libavutil/dict.h"
35 #include "libavutil/log.h"
36 #include "libavutil/pixfmt.h"
37 #include "libavutil/rational.h"
39 #include "libavcodec/version.h"
41 * @defgroup libavc Encoding/Decoding Library
44 * @defgroup lavc_decoding Decoding
48 * @defgroup lavc_encoding Encoding
52 * @defgroup lavc_codec Codecs
54 * @defgroup lavc_codec_native Native Codecs
57 * @defgroup lavc_codec_wrappers External library wrappers
60 * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
64 * @defgroup lavc_internal Internal
72 * @defgroup lavc_core Core functions/structures.
75 * Basic definitions, functions for querying libavcodec capabilities,
76 * allocating core structures, etc.
82 * Identify the syntax and semantics of the bitstream.
83 * The principle is roughly:
84 * Two decoders with the same ID can decode the same streams.
85 * Two encoders with the same ID can encode compatible streams.
86 * There may be slight deviations from the principle due to implementation
89 * If you add a codec ID to this list, add it so that
90 * 1. no value of a existing codec ID changes (that would break ABI),
91 * 2. Give it a value which when taken as ASCII is recognized uniquely by a human as this specific codec.
92 * This ensures that 2 forks can independently add AVCodecIDs without producing conflicts.
94 * After adding new codec IDs, do not forget to add an entry to the codec
95 * descriptor list and bump libavcodec minor version.
101 AV_CODEC_ID_MPEG1VIDEO,
102 AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
103 AV_CODEC_ID_MPEG2VIDEO_XVMC,
114 AV_CODEC_ID_RAWVIDEO,
115 AV_CODEC_ID_MSMPEG4V1,
116 AV_CODEC_ID_MSMPEG4V2,
117 AV_CODEC_ID_MSMPEG4V3,
140 AV_CODEC_ID_INTERPLAY_VIDEO,
147 AV_CODEC_ID_MSVIDEO1,
152 AV_CODEC_ID_TRUEMOTION1,
153 AV_CODEC_ID_VMDVIDEO,
179 AV_CODEC_ID_TRUEMOTION2,
185 AV_CODEC_ID_SMACKVIDEO,
190 AV_CODEC_ID_JPEG2000,
196 AV_CODEC_ID_DSICINVIDEO,
197 AV_CODEC_ID_TIERTEXSEQVIDEO,
205 AV_CODEC_ID_BETHSOFTVID,
217 AV_CODEC_ID_ESCAPE124,
221 AV_CODEC_ID_MOTIONPIXELS,
233 AV_CODEC_ID_FLASHSV2,
234 AV_CODEC_ID_CDGRAPHICS,
237 AV_CODEC_ID_BINKVIDEO,
238 AV_CODEC_ID_IFF_ILBM,
239 AV_CODEC_ID_IFF_BYTERUN1,
245 AV_CODEC_ID_A64_MULTI,
246 AV_CODEC_ID_A64_MULTI5,
249 AV_CODEC_ID_LAGARITH,
253 AV_CODEC_ID_WMV3IMAGE,
254 AV_CODEC_ID_VC1IMAGE,
256 AV_CODEC_ID_BMV_VIDEO,
263 AV_CODEC_ID_ZEROCODEC,
270 AV_CODEC_ID_Y41P = MKBETAG('Y','4','1','P'),
271 AV_CODEC_ID_ESCAPE130 = MKBETAG('E','1','3','0'),
272 AV_CODEC_ID_EXR = MKBETAG('0','E','X','R'),
273 AV_CODEC_ID_AVRP = MKBETAG('A','V','R','P'),
275 AV_CODEC_ID_G2M = MKBETAG( 0 ,'G','2','M'),
276 AV_CODEC_ID_AVUI = MKBETAG('A','V','U','I'),
277 AV_CODEC_ID_AYUV = MKBETAG('A','Y','U','V'),
278 AV_CODEC_ID_TARGA_Y216 = MKBETAG('T','2','1','6'),
279 AV_CODEC_ID_V308 = MKBETAG('V','3','0','8'),
280 AV_CODEC_ID_V408 = MKBETAG('V','4','0','8'),
281 AV_CODEC_ID_YUV4 = MKBETAG('Y','U','V','4'),
282 AV_CODEC_ID_SANM = MKBETAG('S','A','N','M'),
283 AV_CODEC_ID_PAF_VIDEO = MKBETAG('P','A','F','V'),
284 AV_CODEC_ID_AVRN = MKBETAG('A','V','R','n'),
285 AV_CODEC_ID_CPIA = MKBETAG('C','P','I','A'),
286 AV_CODEC_ID_XFACE = MKBETAG('X','F','A','C'),
288 /* various PCM "codecs" */
289 AV_CODEC_ID_FIRST_AUDIO = 0x10000, ///< A dummy id pointing at the start of audio codecs
290 AV_CODEC_ID_PCM_S16LE = 0x10000,
291 AV_CODEC_ID_PCM_S16BE,
292 AV_CODEC_ID_PCM_U16LE,
293 AV_CODEC_ID_PCM_U16BE,
296 AV_CODEC_ID_PCM_MULAW,
297 AV_CODEC_ID_PCM_ALAW,
298 AV_CODEC_ID_PCM_S32LE,
299 AV_CODEC_ID_PCM_S32BE,
300 AV_CODEC_ID_PCM_U32LE,
301 AV_CODEC_ID_PCM_U32BE,
302 AV_CODEC_ID_PCM_S24LE,
303 AV_CODEC_ID_PCM_S24BE,
304 AV_CODEC_ID_PCM_U24LE,
305 AV_CODEC_ID_PCM_U24BE,
306 AV_CODEC_ID_PCM_S24DAUD,
307 AV_CODEC_ID_PCM_ZORK,
308 AV_CODEC_ID_PCM_S16LE_PLANAR,
310 AV_CODEC_ID_PCM_F32BE,
311 AV_CODEC_ID_PCM_F32LE,
312 AV_CODEC_ID_PCM_F64BE,
313 AV_CODEC_ID_PCM_F64LE,
314 AV_CODEC_ID_PCM_BLURAY,
317 AV_CODEC_ID_PCM_S8_PLANAR,
319 /* various ADPCM codecs */
320 AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
321 AV_CODEC_ID_ADPCM_IMA_WAV,
322 AV_CODEC_ID_ADPCM_IMA_DK3,
323 AV_CODEC_ID_ADPCM_IMA_DK4,
324 AV_CODEC_ID_ADPCM_IMA_WS,
325 AV_CODEC_ID_ADPCM_IMA_SMJPEG,
326 AV_CODEC_ID_ADPCM_MS,
327 AV_CODEC_ID_ADPCM_4XM,
328 AV_CODEC_ID_ADPCM_XA,
329 AV_CODEC_ID_ADPCM_ADX,
330 AV_CODEC_ID_ADPCM_EA,
331 AV_CODEC_ID_ADPCM_G726,
332 AV_CODEC_ID_ADPCM_CT,
333 AV_CODEC_ID_ADPCM_SWF,
334 AV_CODEC_ID_ADPCM_YAMAHA,
335 AV_CODEC_ID_ADPCM_SBPRO_4,
336 AV_CODEC_ID_ADPCM_SBPRO_3,
337 AV_CODEC_ID_ADPCM_SBPRO_2,
338 AV_CODEC_ID_ADPCM_THP,
339 AV_CODEC_ID_ADPCM_IMA_AMV,
340 AV_CODEC_ID_ADPCM_EA_R1,
341 AV_CODEC_ID_ADPCM_EA_R3,
342 AV_CODEC_ID_ADPCM_EA_R2,
343 AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
344 AV_CODEC_ID_ADPCM_IMA_EA_EACS,
345 AV_CODEC_ID_ADPCM_EA_XAS,
346 AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
347 AV_CODEC_ID_ADPCM_IMA_ISS,
348 AV_CODEC_ID_ADPCM_G722,
349 AV_CODEC_ID_ADPCM_IMA_APC,
350 AV_CODEC_ID_VIMA = MKBETAG('V','I','M','A'),
353 AV_CODEC_ID_AMR_NB = 0x12000,
356 /* RealAudio codecs*/
357 AV_CODEC_ID_RA_144 = 0x13000,
360 /* various DPCM codecs */
361 AV_CODEC_ID_ROQ_DPCM = 0x14000,
362 AV_CODEC_ID_INTERPLAY_DPCM,
363 AV_CODEC_ID_XAN_DPCM,
364 AV_CODEC_ID_SOL_DPCM,
367 AV_CODEC_ID_MP2 = 0x15000,
368 AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
378 AV_CODEC_ID_VMDAUDIO,
384 AV_CODEC_ID_WESTWOOD_SND1,
385 AV_CODEC_ID_GSM, ///< as in Berlin toast format
388 AV_CODEC_ID_TRUESPEECH,
390 AV_CODEC_ID_SMACKAUDIO,
393 AV_CODEC_ID_DSICINAUDIO,
395 AV_CODEC_ID_MUSEPACK7,
397 AV_CODEC_ID_GSM_MS, /* as found in WAV */
401 AV_CODEC_ID_NELLYMOSER,
402 AV_CODEC_ID_MUSEPACK8,
404 AV_CODEC_ID_WMAVOICE,
406 AV_CODEC_ID_WMALOSSLESS,
415 AV_CODEC_ID_BINKAUDIO_RDFT,
416 AV_CODEC_ID_BINKAUDIO_DCT,
417 AV_CODEC_ID_AAC_LATM,
422 AV_CODEC_ID_8SVX_EXP,
423 AV_CODEC_ID_8SVX_FIB,
424 AV_CODEC_ID_BMV_AUDIO,
428 AV_CODEC_ID_OPUS_DEPRECATED,
429 AV_CODEC_ID_COMFORT_NOISE,
430 AV_CODEC_ID_FFWAVESYNTH = MKBETAG('F','F','W','S'),
431 AV_CODEC_ID_8SVX_RAW = MKBETAG('8','S','V','X'),
432 AV_CODEC_ID_SONIC = MKBETAG('S','O','N','C'),
433 AV_CODEC_ID_SONIC_LS = MKBETAG('S','O','N','L'),
434 AV_CODEC_ID_PAF_AUDIO = MKBETAG('P','A','F','A'),
435 AV_CODEC_ID_OPUS = MKBETAG('O','P','U','S'),
436 AV_CODEC_ID_TAK = MKBETAG('t','B','a','K'),
438 /* subtitle codecs */
439 AV_CODEC_ID_FIRST_SUBTITLE = 0x17000, ///< A dummy ID pointing at the start of subtitle codecs.
440 AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
441 AV_CODEC_ID_DVB_SUBTITLE,
442 AV_CODEC_ID_TEXT, ///< raw UTF-8 text
445 AV_CODEC_ID_MOV_TEXT,
446 AV_CODEC_ID_HDMV_PGS_SUBTITLE,
447 AV_CODEC_ID_DVB_TELETEXT,
449 AV_CODEC_ID_MICRODVD = MKBETAG('m','D','V','D'),
450 AV_CODEC_ID_EIA_608 = MKBETAG('c','6','0','8'),
451 AV_CODEC_ID_JACOSUB = MKBETAG('J','S','U','B'),
452 AV_CODEC_ID_SAMI = MKBETAG('S','A','M','I'),
453 AV_CODEC_ID_REALTEXT = MKBETAG('R','T','X','T'),
454 AV_CODEC_ID_SUBVIEWER = MKBETAG('S','u','b','V'),
455 AV_CODEC_ID_SUBRIP = MKBETAG('S','R','i','p'),
456 AV_CODEC_ID_WEBVTT = MKBETAG('W','V','T','T'),
458 /* other specific kind of codecs (generally used for attachments) */
459 AV_CODEC_ID_FIRST_UNKNOWN = 0x18000, ///< A dummy ID pointing at the start of various fake codecs.
460 AV_CODEC_ID_TTF = 0x18000,
461 AV_CODEC_ID_BINTEXT = MKBETAG('B','T','X','T'),
462 AV_CODEC_ID_XBIN = MKBETAG('X','B','I','N'),
463 AV_CODEC_ID_IDF = MKBETAG( 0 ,'I','D','F'),
464 AV_CODEC_ID_OTF = MKBETAG( 0 ,'O','T','F'),
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.
475 #include "old_codec_ids.h"
480 #define CodecID AVCodecID
484 * This struct describes the properties of a single codec described by an
486 * @see avcodec_get_descriptor()
488 typedef struct AVCodecDescriptor {
490 enum AVMediaType type;
492 * Name of the codec described by this descriptor. It is non-empty and
493 * unique for each codec descriptor. It should contain alphanumeric
494 * characters and '_' only.
498 * A more descriptive name for this codec. May be NULL.
500 const char *long_name;
502 * Codec properties, a combination of AV_CODEC_PROP_* flags.
508 * Codec uses only intra compression.
511 #define AV_CODEC_PROP_INTRA_ONLY (1 << 0)
513 * Codec supports lossy compression. Audio and video codecs only.
514 * @note a codec may support both lossy and lossless
517 #define AV_CODEC_PROP_LOSSY (1 << 1)
519 * Codec supports lossless compression. Audio and video codecs only.
521 #define AV_CODEC_PROP_LOSSLESS (1 << 2)
523 #if FF_API_OLD_DECODE_AUDIO
525 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
529 * @ingroup lavc_decoding
530 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
531 * This is mainly needed because some optimized bitstream readers read
532 * 32 or 64 bit at once and could read over the end.<br>
533 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
534 * MPEG bitstreams could cause overread and segfault.
536 #define FF_INPUT_BUFFER_PADDING_SIZE 16
539 * @ingroup lavc_encoding
540 * minimum encoding buffer size
541 * Used to avoid some checks during header writing.
543 #define FF_MIN_BUFFER_SIZE 16384
547 * @ingroup lavc_encoding
548 * motion estimation type.
551 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
555 ME_EPZS, ///< enhanced predictive zonal search
556 ME_X1, ///< reserved for experiments
557 ME_HEX, ///< hexagon based search
558 ME_UMH, ///< uneven multi-hexagon search
559 ME_ITER, ///< iterative search
560 ME_TESA, ///< transformed exhaustive search algorithm
564 * @ingroup lavc_decoding
567 /* We leave some space between them for extensions (drop some
568 * keyframes for intra-only or drop just some bidir frames). */
569 AVDISCARD_NONE =-16, ///< discard nothing
570 AVDISCARD_DEFAULT = 0, ///< discard useless packets like 0 size packets in avi
571 AVDISCARD_NONREF = 8, ///< discard all non reference
572 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
573 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
574 AVDISCARD_ALL = 48, ///< discard all
577 enum AVColorPrimaries{
578 AVCOL_PRI_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
579 AVCOL_PRI_UNSPECIFIED = 2,
580 AVCOL_PRI_BT470M = 4,
581 AVCOL_PRI_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
582 AVCOL_PRI_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
583 AVCOL_PRI_SMPTE240M = 7, ///< functionally identical to above
585 AVCOL_PRI_NB , ///< Not part of ABI
588 enum AVColorTransferCharacteristic{
589 AVCOL_TRC_BT709 = 1, ///< also ITU-R BT1361
590 AVCOL_TRC_UNSPECIFIED = 2,
591 AVCOL_TRC_GAMMA22 = 4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
592 AVCOL_TRC_GAMMA28 = 5, ///< also ITU-R BT470BG
593 AVCOL_TRC_SMPTE240M = 7,
594 AVCOL_TRC_NB , ///< Not part of ABI
599 AVCOL_SPC_BT709 = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
600 AVCOL_SPC_UNSPECIFIED = 2,
602 AVCOL_SPC_BT470BG = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
603 AVCOL_SPC_SMPTE170M = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
604 AVCOL_SPC_SMPTE240M = 7,
605 AVCOL_SPC_YCOCG = 8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
606 AVCOL_SPC_NB , ///< Not part of ABI
608 #define AVCOL_SPC_YCGCO AVCOL_SPC_YCOCG
611 AVCOL_RANGE_UNSPECIFIED = 0,
612 AVCOL_RANGE_MPEG = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
613 AVCOL_RANGE_JPEG = 2, ///< the normal 2^n-1 "JPEG" YUV ranges
614 AVCOL_RANGE_NB , ///< Not part of ABI
618 * X X 3 4 X X are luma samples,
619 * 1 2 1-6 are possible chroma positions
620 * X X 5 6 X 0 is undefined/unknown position
622 enum AVChromaLocation{
623 AVCHROMA_LOC_UNSPECIFIED = 0,
624 AVCHROMA_LOC_LEFT = 1, ///< mpeg2/4, h264 default
625 AVCHROMA_LOC_CENTER = 2, ///< mpeg1, jpeg, h263
626 AVCHROMA_LOC_TOPLEFT = 3, ///< DV
627 AVCHROMA_LOC_TOP = 4,
628 AVCHROMA_LOC_BOTTOMLEFT = 5,
629 AVCHROMA_LOC_BOTTOM = 6,
630 AVCHROMA_LOC_NB , ///< Not part of ABI
633 enum AVAudioServiceType {
634 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
635 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
636 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
637 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
638 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
639 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
640 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
641 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
642 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
643 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
647 * @ingroup lavc_encoding
649 typedef struct RcOverride{
652 int qscale; // If this is 0 then quality_factor will be used instead.
653 float quality_factor;
656 #define FF_MAX_B_FRAMES 16
659 These flags can be passed in AVCodecContext.flags before initialization.
660 Note: Not everything is supported yet.
663 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
664 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
665 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
666 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
667 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
669 * The parent program guarantees that the input for B-frames containing
670 * streams is not written to for at least s->max_b_frames+1 frames, if
671 * this is not set the input will be copied.
673 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
674 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
675 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
676 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
677 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
678 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
679 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
680 location instead of only at frame boundaries. */
681 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
682 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
683 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
684 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
685 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
686 /* Fx : Flag for h263+ extra options */
687 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
688 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
689 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
690 #define CODEC_FLAG_CLOSED_GOP 0x80000000
691 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
692 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
693 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
694 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format. DEPRECATED!!!!
695 #if FF_API_MPV_GLOBAL_OPTS
696 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
697 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
698 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
699 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
701 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
702 #define CODEC_FLAG2_SHOW_ALL 0x00400000 ///< Show all frames before the first keyframe
704 /* Unsupported options :
705 * Syntax Arithmetic coding (SAC)
706 * Reference Picture Selection
707 * Independent Segment Decoding */
709 /* codec capabilities */
711 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
713 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
714 * If not set, it might not use get_buffer() at all or use operations that
715 * assume the buffer was allocated by avcodec_default_get_buffer.
717 #define CODEC_CAP_DR1 0x0002
718 #define CODEC_CAP_TRUNCATED 0x0008
719 /* Codec can export data for HW decoding (XvMC). */
720 #define CODEC_CAP_HWACCEL 0x0010
722 * Encoder or decoder requires flushing with NULL input at the end in order to
723 * give the complete and correct output.
725 * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
726 * with NULL data. The user can still send NULL data to the public encode
727 * or decode function, but libavcodec will not pass it along to the codec
728 * unless this flag is set.
731 * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
732 * avpkt->size=0 at the end to get the delayed data until the decoder no longer
736 * The encoder needs to be fed with NULL data at the end of encoding until the
737 * encoder no longer returns data.
739 * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
740 * flag also means that the encoder must set the pts and duration for
741 * each output packet. If this flag is not set, the pts and duration will
742 * be determined by libavcodec from the input frame.
744 #define CODEC_CAP_DELAY 0x0020
746 * Codec can be fed a final frame with a smaller size.
747 * This can be used to prevent truncation of the last audio samples.
749 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
751 * Codec can export data for HW decoding (VDPAU).
753 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
755 * Codec can output multiple frames per AVPacket
756 * Normally demuxers return one frame at a time, demuxers which do not do
757 * are connected to a parser to split what they return into proper frames.
758 * This flag is reserved to the very rare category of codecs which have a
759 * bitstream that cannot be split into frames without timeconsuming
760 * operations like full decoding. Demuxers carring such bitstreams thus
761 * may return multiple frames in a packet. This has many disadvantages like
762 * prohibiting stream copy in many cases thus it should only be considered
765 #define CODEC_CAP_SUBFRAMES 0x0100
767 * Codec is experimental and is thus avoided in favor of non experimental
770 #define CODEC_CAP_EXPERIMENTAL 0x0200
772 * Codec should fill in channel configuration and samplerate instead of container
774 #define CODEC_CAP_CHANNEL_CONF 0x0400
777 * Codec is able to deal with negative linesizes
779 #define CODEC_CAP_NEG_LINESIZES 0x0800
782 * Codec supports frame-level multithreading.
784 #define CODEC_CAP_FRAME_THREADS 0x1000
786 * Codec supports slice-based (or partition-based) multithreading.
788 #define CODEC_CAP_SLICE_THREADS 0x2000
790 * Codec supports changed parameters at any point.
792 #define CODEC_CAP_PARAM_CHANGE 0x4000
794 * Codec supports avctx->thread_count == 0 (auto).
796 #define CODEC_CAP_AUTO_THREADS 0x8000
798 * Audio encoder supports receiving a different number of samples in each call.
800 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
802 * Codec is intra only.
804 #define CODEC_CAP_INTRA_ONLY 0x40000000
808 #define CODEC_CAP_LOSSLESS 0x80000000
810 //The following defines may change, don't expect compatibility if you use them.
811 #define MB_TYPE_INTRA4x4 0x0001
812 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
813 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
814 #define MB_TYPE_16x16 0x0008
815 #define MB_TYPE_16x8 0x0010
816 #define MB_TYPE_8x16 0x0020
817 #define MB_TYPE_8x8 0x0040
818 #define MB_TYPE_INTERLACED 0x0080
819 #define MB_TYPE_DIRECT2 0x0100 //FIXME
820 #define MB_TYPE_ACPRED 0x0200
821 #define MB_TYPE_GMC 0x0400
822 #define MB_TYPE_SKIP 0x0800
823 #define MB_TYPE_P0L0 0x1000
824 #define MB_TYPE_P1L0 0x2000
825 #define MB_TYPE_P0L1 0x4000
826 #define MB_TYPE_P1L1 0x8000
827 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
828 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
829 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
830 #define MB_TYPE_QUANT 0x00010000
831 #define MB_TYPE_CBP 0x00020000
832 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
836 * This specifies the area which should be displayed.
837 * Note there may be multiple such areas for one frame.
839 typedef struct AVPanScan{
842 * - encoding: Set by user.
843 * - decoding: Set by libavcodec.
848 * width and height in 1/16 pel
849 * - encoding: Set by user.
850 * - decoding: Set by libavcodec.
856 * position of the top left corner in 1/16 pel for up to 3 fields/frames
857 * - encoding: Set by user.
858 * - decoding: Set by libavcodec.
860 int16_t position[3][2];
863 #define FF_QSCALE_TYPE_MPEG1 0
864 #define FF_QSCALE_TYPE_MPEG2 1
865 #define FF_QSCALE_TYPE_H264 2
866 #define FF_QSCALE_TYPE_VP56 3
868 #define FF_BUFFER_TYPE_INTERNAL 1
869 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
870 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
871 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
873 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
874 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
875 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
876 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
879 * @defgroup lavc_packet AVPacket
881 * Types and functions for working with AVPacket.
884 enum AVPacketSideDataType {
886 AV_PKT_DATA_NEW_EXTRADATA,
889 * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
892 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
893 * s32le channel_count
894 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
895 * u64le channel_layout
896 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
898 * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
903 AV_PKT_DATA_PARAM_CHANGE,
906 * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
907 * structures with info about macroblocks relevant to splitting the
908 * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
909 * That is, it does not necessarily contain info about all macroblocks,
910 * as long as the distance between macroblocks in the info is smaller
911 * than the target payload size.
912 * Each MB info structure is 12 bytes, and is laid out as follows:
914 * u32le bit offset from the start of the packet
915 * u8 current quantizer at the start of the macroblock
917 * u16le macroblock address within the GOB
918 * u8 horizontal MV predictor
919 * u8 vertical MV predictor
920 * u8 horizontal MV predictor for block number 3
921 * u8 vertical MV predictor for block number 3
924 AV_PKT_DATA_H263_MB_INFO,
927 * Recommmends skipping the specified number of samples
929 * u32le number of samples to skip from start of this packet
930 * u32le number of samples to skip from end of this packet
931 * u8 reason for start skip
932 * u8 reason for end skip (0=padding silence, 1=convergence)
935 AV_PKT_DATA_SKIP_SAMPLES=70,
938 * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
939 * the packet may contain "dual mono" audio specific to Japanese DTV
940 * and if it is true, recommends only the selected channel to be used.
942 * u8 selected channels (0=mail/left, 1=sub/right, 2=both)
945 AV_PKT_DATA_JP_DUALMONO,
948 * A list of zero terminated key/value strings. There is no end marker for
949 * the list, so it is required to rely on the side data size to stop.
951 AV_PKT_DATA_STRINGS_METADATA,
954 * Subtitle event position
962 AV_PKT_DATA_SUBTITLE_POSITION,
966 * This structure stores compressed data. It is typically exported by demuxers
967 * and then passed as input to decoders, or received as output from encoders and
968 * then passed to muxers.
970 * For video, it should typically contain one compressed frame. For audio it may
971 * contain several compressed frames.
973 * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
974 * ABI. Thus it may be allocated on stack and no new fields can be added to it
975 * without libavcodec and libavformat major bump.
977 * The semantics of data ownership depends on the destruct field.
978 * If it is set, the packet data is dynamically allocated and is valid
979 * indefinitely until av_free_packet() is called (which in turn calls the
980 * destruct callback to free the data). If destruct is not set, the packet data
981 * is typically backed by some static buffer somewhere and is only valid for a
982 * limited time (e.g. until the next read call when demuxing).
984 * The side data is always allocated with av_malloc() and is freed in
987 typedef struct AVPacket {
989 * Presentation timestamp in AVStream->time_base units; the time at which
990 * the decompressed packet will be presented to the user.
991 * Can be AV_NOPTS_VALUE if it is not stored in the file.
992 * pts MUST be larger or equal to dts as presentation cannot happen before
993 * decompression, unless one wants to view hex dumps. Some formats misuse
994 * the terms dts and pts/cts to mean something different. Such timestamps
995 * must be converted to true pts/dts before they are stored in AVPacket.
999 * Decompression timestamp in AVStream->time_base units; the time at which
1000 * the packet is decompressed.
1001 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1008 * A combination of AV_PKT_FLAG values
1012 * Additional packet data that can be provided by the container.
1013 * Packet can contain several types of side information.
1018 enum AVPacketSideDataType type;
1020 int side_data_elems;
1023 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1024 * Equals next_pts - this_pts in presentation order.
1027 void (*destruct)(struct AVPacket *);
1029 int64_t pos; ///< byte position in stream, -1 if unknown
1032 * Time difference in AVStream->time_base units from the pts of this
1033 * packet to the point at which the output from the decoder has converged
1034 * independent from the availability of previous frames. That is, the
1035 * frames are virtually identical no matter if decoding started from
1036 * the very first frame or from this keyframe.
1037 * Is AV_NOPTS_VALUE if unknown.
1038 * This field is not the display duration of the current packet.
1039 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1042 * The purpose of this field is to allow seeking in streams that have no
1043 * keyframes in the conventional sense. It corresponds to the
1044 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1045 * essential for some types of subtitle streams to ensure that all
1046 * subtitles are correctly displayed after seeking.
1048 int64_t convergence_duration;
1050 #define AV_PKT_FLAG_KEY 0x0001 ///< The packet contains a keyframe
1051 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1053 enum AVSideDataParamChangeFlags {
1054 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT = 0x0001,
1055 AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1056 AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE = 0x0004,
1057 AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS = 0x0008,
1064 * Audio Video Frame.
1065 * New fields can be added to the end of AVFRAME with minor version
1066 * bumps. Similarly fields that are marked as to be only accessed by
1067 * av_opt_ptr() can be reordered. This allows 2 forks to add fields
1068 * without breaking compatibility with each other.
1069 * Removal, reordering and changes in the remaining cases require
1070 * a major version bump.
1071 * sizeof(AVFrame) must not be used outside libavcodec.
1073 typedef struct AVFrame {
1074 #define AV_NUM_DATA_POINTERS 8
1076 * pointer to the picture/channel planes.
1077 * This might be different from the first allocated byte
1078 * - encoding: Set by user
1079 * - decoding: set by AVCodecContext.get_buffer()
1081 uint8_t *data[AV_NUM_DATA_POINTERS];
1084 * Size, in bytes, of the data for each picture/channel plane.
1086 * For audio, only linesize[0] may be set. For planar audio, each channel
1087 * plane must be the same size.
1089 * - encoding: Set by user
1090 * - decoding: set by AVCodecContext.get_buffer()
1092 int linesize[AV_NUM_DATA_POINTERS];
1095 * pointers to the data planes/channels.
1097 * For video, this should simply point to data[].
1099 * For planar audio, each channel has a separate data pointer, and
1100 * linesize[0] contains the size of each channel buffer.
1101 * For packed audio, there is just one data pointer, and linesize[0]
1102 * contains the total size of the buffer for all channels.
1104 * Note: Both data and extended_data will always be set by get_buffer(),
1105 * but for planar audio with more channels that can fit in data,
1106 * extended_data must be used by the decoder in order to access all
1109 * encoding: set by user
1110 * decoding: set by AVCodecContext.get_buffer()
1112 uint8_t **extended_data;
1115 * width and height of the video frame
1116 * - encoding: unused
1117 * - decoding: Read by user.
1122 * number of audio samples (per channel) described by this frame
1123 * - encoding: Set by user
1124 * - decoding: Set by libavcodec
1129 * format of the frame, -1 if unknown or unset
1130 * Values correspond to enum AVPixelFormat for video frames,
1131 * enum AVSampleFormat for audio)
1132 * - encoding: unused
1133 * - decoding: Read by user.
1138 * 1 -> keyframe, 0-> not
1139 * - encoding: Set by libavcodec.
1140 * - decoding: Set by libavcodec.
1145 * Picture type of the frame, see ?_TYPE below.
1146 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1147 * - decoding: Set by libavcodec.
1149 enum AVPictureType pict_type;
1152 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
1153 * This isn't used by libavcodec unless the default get/release_buffer() is used.
1157 uint8_t *base[AV_NUM_DATA_POINTERS];
1160 * sample aspect ratio for the video frame, 0/1 if unknown/unspecified
1161 * - encoding: unused
1162 * - decoding: Read by user.
1164 AVRational sample_aspect_ratio;
1167 * presentation timestamp in time_base units (time when frame should be shown to user)
1168 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
1169 * - encoding: MUST be set by user.
1170 * - decoding: Set by libavcodec.
1175 * reordered pts from the last AVPacket that has been input into the decoder
1176 * - encoding: unused
1177 * - decoding: Read by user.
1182 * dts from the last AVPacket that has been input into the decoder
1183 * - encoding: unused
1184 * - decoding: Read by user.
1189 * picture number in bitstream order
1190 * - encoding: set by
1191 * - decoding: Set by libavcodec.
1193 int coded_picture_number;
1195 * picture number in display order
1196 * - encoding: set by
1197 * - decoding: Set by libavcodec.
1199 int display_picture_number;
1202 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
1203 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
1204 * - decoding: Set by libavcodec.
1209 * is this picture used as reference
1210 * The values for this are the same as the MpegEncContext.picture_structure
1211 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
1212 * Set to 4 for delayed, non-reference frames.
1213 * - encoding: unused
1214 * - decoding: Set by libavcodec. (before get_buffer() call)).
1220 * - encoding: unused
1221 * - decoding: Set by libavcodec.
1223 int8_t *qscale_table;
1226 * - encoding: unused
1227 * - decoding: Set by libavcodec.
1237 * mbskip_table[mb]>=1 if MB didn't change
1238 * stride= mb_width = (width+15)>>4
1239 * - encoding: unused
1240 * - decoding: Set by libavcodec.
1242 uint8_t *mbskip_table;
1245 * motion vector table
1248 * int mv_sample_log2= 4 - motion_subsample_log2;
1249 * int mb_width= (width+15)>>4;
1250 * int mv_stride= (mb_width << mv_sample_log2) + 1;
1251 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
1253 * - encoding: Set by user.
1254 * - decoding: Set by libavcodec.
1256 int16_t (*motion_val[2])[2];
1259 * macroblock type table
1260 * mb_type_base + mb_width + 2
1261 * - encoding: Set by user.
1262 * - decoding: Set by libavcodec.
1268 * - encoding: unused
1269 * - decoding: Set by libavcodec.
1274 * motion reference frame index
1275 * the order in which these are stored can depend on the codec.
1276 * - encoding: Set by user.
1277 * - decoding: Set by libavcodec.
1279 int8_t *ref_index[2];
1282 * for some private data of the user
1283 * - encoding: unused
1284 * - decoding: Set by user.
1290 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1291 * - decoding: unused
1293 uint64_t error[AV_NUM_DATA_POINTERS];
1296 * type of the buffer (to keep track of who has to deallocate data[*])
1297 * - encoding: Set by the one who allocates it.
1298 * - decoding: Set by the one who allocates it.
1299 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1304 * When decoding, this signals how much the picture must be delayed.
1305 * extra_delay = repeat_pict / (2*fps)
1306 * - encoding: unused
1307 * - decoding: Set by libavcodec.
1312 * The content of the picture is interlaced.
1313 * - encoding: Set by user.
1314 * - decoding: Set by libavcodec. (default 0)
1316 int interlaced_frame;
1319 * If the content is interlaced, is top field displayed first.
1320 * - encoding: Set by user.
1321 * - decoding: Set by libavcodec.
1323 int top_field_first;
1326 * Tell user application that palette has changed from previous frame.
1327 * - encoding: ??? (no palette-enabled encoder yet)
1328 * - decoding: Set by libavcodec. (default 0).
1330 int palette_has_changed;
1333 * codec suggestion on buffer type if != 0
1334 * - encoding: unused
1335 * - decoding: Set by libavcodec. (before get_buffer() call)).
1341 * - encoding: Set by user.
1342 * - decoding: Set by libavcodec.
1344 AVPanScan *pan_scan;
1347 * reordered opaque 64bit (generally an integer or a double precision float
1348 * PTS but can be anything).
1349 * The user sets AVCodecContext.reordered_opaque to represent the input at
1351 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1352 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1353 * @deprecated in favor of pkt_pts
1354 * - encoding: unused
1355 * - decoding: Read by user.
1357 int64_t reordered_opaque;
1360 * hardware accelerator private data (FFmpeg-allocated)
1361 * - encoding: unused
1362 * - decoding: Set by libavcodec
1364 void *hwaccel_picture_private;
1367 * the AVCodecContext which ff_thread_get_buffer() was last called on
1368 * - encoding: Set by libavcodec.
1369 * - decoding: Set by libavcodec.
1371 struct AVCodecContext *owner;
1374 * used by multithreading to store frame-specific info
1375 * - encoding: Set by libavcodec.
1376 * - decoding: Set by libavcodec.
1378 void *thread_opaque;
1381 * log2 of the size of the block which a single vector in motion_val represents:
1382 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1383 * - encoding: unused
1384 * - decoding: Set by libavcodec.
1386 uint8_t motion_subsample_log2;
1389 * Sample rate of the audio data.
1391 * - encoding: unused
1392 * - decoding: read by user
1397 * Channel layout of the audio data.
1399 * - encoding: unused
1400 * - decoding: read by user.
1402 uint64_t channel_layout;
1405 * frame timestamp estimated using various heuristics, in stream time base
1406 * Code outside libavcodec should access this field using:
1407 * av_frame_get_best_effort_timestamp(frame)
1408 * - encoding: unused
1409 * - decoding: set by libavcodec, read by user.
1411 int64_t best_effort_timestamp;
1414 * reordered pos from the last AVPacket that has been input into the decoder
1415 * Code outside libavcodec should access this field using:
1416 * av_frame_get_pkt_pos(frame)
1417 * - encoding: unused
1418 * - decoding: Read by user.
1423 * duration of the corresponding packet, expressed in
1424 * AVStream->time_base units, 0 if unknown.
1425 * Code outside libavcodec should access this field using:
1426 * av_frame_get_pkt_duration(frame)
1427 * - encoding: unused
1428 * - decoding: Read by user.
1430 int64_t pkt_duration;
1434 * Code outside libavcodec should access this field using:
1435 * av_frame_get_metadata(frame)
1436 * - encoding: Set by user.
1437 * - decoding: Set by libavcodec.
1439 AVDictionary *metadata;
1442 * decode error flags of the frame, set to a combination of
1443 * FF_DECODE_ERROR_xxx flags if the decoder produced a frame, but there
1444 * were errors during the decoding.
1445 * Code outside libavcodec should access this field using:
1446 * av_frame_get_decode_error_flags(frame)
1447 * - encoding: unused
1448 * - decoding: set by libavcodec, read by user.
1450 int decode_error_flags;
1451 #define FF_DECODE_ERROR_INVALID_BITSTREAM 1
1452 #define FF_DECODE_ERROR_MISSING_REFERENCE 2
1455 * number of audio channels, only used for audio.
1456 * Code outside libavcodec should access this field using:
1457 * av_frame_get_channels(frame)
1458 * - encoding: unused
1459 * - decoding: Read by user.
1465 * Accessors for some AVFrame fields.
1466 * The position of these field in the structure is not part of the ABI,
1467 * they should not be accessed directly outside libavcodec.
1469 int64_t av_frame_get_best_effort_timestamp(const AVFrame *frame);
1470 void av_frame_set_best_effort_timestamp(AVFrame *frame, int64_t val);
1471 int64_t av_frame_get_pkt_duration (const AVFrame *frame);
1472 void av_frame_set_pkt_duration (AVFrame *frame, int64_t val);
1473 int64_t av_frame_get_pkt_pos (const AVFrame *frame);
1474 void av_frame_set_pkt_pos (AVFrame *frame, int64_t val);
1475 int64_t av_frame_get_channel_layout (const AVFrame *frame);
1476 void av_frame_set_channel_layout (AVFrame *frame, int64_t val);
1477 int av_frame_get_channels (const AVFrame *frame);
1478 void av_frame_set_channels (AVFrame *frame, int val);
1479 int av_frame_get_sample_rate (const AVFrame *frame);
1480 void av_frame_set_sample_rate (AVFrame *frame, int val);
1481 AVDictionary *av_frame_get_metadata (const AVFrame *frame);
1482 void av_frame_set_metadata (AVFrame *frame, AVDictionary *val);
1483 int av_frame_get_decode_error_flags (const AVFrame *frame);
1484 void av_frame_set_decode_error_flags (AVFrame *frame, int val);
1486 struct AVCodecInternal;
1490 AV_FIELD_PROGRESSIVE,
1491 AV_FIELD_TT, //< Top coded_first, top displayed first
1492 AV_FIELD_BB, //< Bottom coded first, bottom displayed first
1493 AV_FIELD_TB, //< Top coded first, bottom displayed first
1494 AV_FIELD_BT, //< Bottom coded first, top displayed first
1498 * main external API structure.
1499 * New fields can be added to the end with minor version bumps.
1500 * Removal, reordering and changes to existing fields require a major
1502 * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1504 * sizeof(AVCodecContext) must not be used outside libav*.
1506 typedef struct AVCodecContext {
1508 * information on struct for av_log
1509 * - set by avcodec_alloc_context3
1511 const AVClass *av_class;
1512 int log_level_offset;
1514 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1515 const struct AVCodec *codec;
1516 char codec_name[32];
1517 enum AVCodecID codec_id; /* see AV_CODEC_ID_xxx */
1520 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1521 * This is used to work around some encoder bugs.
1522 * A demuxer should set this to what is stored in the field used to identify the codec.
1523 * If there are multiple such fields in a container then the demuxer should choose the one
1524 * which maximizes the information about the used codec.
1525 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1526 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1527 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1529 * - encoding: Set by user, if not then the default based on codec_id will be used.
1530 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1532 unsigned int codec_tag;
1535 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1536 * This is used to work around some encoder bugs.
1537 * - encoding: unused
1538 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1540 unsigned int stream_codec_tag;
1544 * @deprecated this field is unused
1546 attribute_deprecated int sub_id;
1552 * Private context used for internal data.
1554 * Unlike priv_data, this is not codec-specific. It is used in general
1555 * libavcodec functions.
1557 struct AVCodecInternal *internal;
1560 * Private data of the user, can be used to carry app specific stuff.
1561 * - encoding: Set by user.
1562 * - decoding: Set by user.
1567 * the average bitrate
1568 * - encoding: Set by user; unused for constant quantizer encoding.
1569 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1574 * number of bits the bitstream is allowed to diverge from the reference.
1575 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1576 * - encoding: Set by user; unused for constant quantizer encoding.
1577 * - decoding: unused
1579 int bit_rate_tolerance;
1582 * Global quality for codecs which cannot change it per frame.
1583 * This should be proportional to MPEG-1/2/4 qscale.
1584 * - encoding: Set by user.
1585 * - decoding: unused
1590 * - encoding: Set by user.
1591 * - decoding: unused
1593 int compression_level;
1594 #define FF_COMPRESSION_DEFAULT -1
1598 * - encoding: Set by user.
1599 * - decoding: Set by user.
1605 * - encoding: Set by user.
1606 * - decoding: Set by user.
1611 * some codecs need / can use extradata like Huffman tables.
1612 * mjpeg: Huffman tables
1613 * rv10: additional flags
1614 * mpeg4: global headers (they can be in the bitstream or here)
1615 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1616 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1617 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1618 * - encoding: Set/allocated/freed by libavcodec.
1619 * - decoding: Set/allocated/freed by user.
1625 * This is the fundamental unit of time (in seconds) in terms
1626 * of which frame timestamps are represented. For fixed-fps content,
1627 * timebase should be 1/framerate and timestamp increments should be
1629 * - encoding: MUST be set by user.
1630 * - decoding: Set by libavcodec.
1632 AVRational time_base;
1635 * For some codecs, the time base is closer to the field rate than the frame rate.
1636 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1637 * if no telecine is used ...
1639 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1641 int ticks_per_frame;
1646 * Encoding: Number of frames delay there will be from the encoder input to
1647 * the decoder output. (we assume the decoder matches the spec)
1648 * Decoding: Number of frames delay in addition to what a standard decoder
1649 * as specified in the spec would produce.
1652 * Number of frames the decoded output will be delayed relative to the
1656 * For encoding, this is the number of "priming" samples added to the
1657 * beginning of the stream. The decoded output will be delayed by this
1658 * many samples relative to the input to the encoder. Note that this
1659 * field is purely informational and does not directly affect the pts
1660 * output by the encoder, which should always be based on the actual
1661 * presentation time, including any delay.
1662 * For decoding, this is the number of samples the decoder needs to
1663 * output before the decoder's output is valid. When seeking, you should
1664 * start decoding this many samples prior to your desired seek point.
1666 * - encoding: Set by libavcodec.
1667 * - decoding: Set by libavcodec.
1674 * picture width / height.
1675 * - encoding: MUST be set by user.
1676 * - decoding: Set by libavcodec.
1677 * Note: For compatibility it is possible to set this instead of
1678 * coded_width/height before decoding.
1683 * Bitstream width / height, may be different from width/height if lowres enabled.
1684 * - encoding: unused
1685 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1687 int coded_width, coded_height;
1689 #define FF_ASPECT_EXTENDED 15
1692 * the number of pictures in a group of pictures, or 0 for intra_only
1693 * - encoding: Set by user.
1694 * - decoding: unused
1699 * Pixel format, see AV_PIX_FMT_xxx.
1700 * May be set by the demuxer if known from headers.
1701 * May be overridden by the decoder if it knows better.
1702 * - encoding: Set by user.
1703 * - decoding: Set by user if known, overridden by libavcodec if known
1705 enum AVPixelFormat pix_fmt;
1708 * Motion estimation algorithm used for video coding.
1709 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1710 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1711 * - encoding: MUST be set by user.
1712 * - decoding: unused
1717 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1718 * decoder to draw a horizontal band. It improves cache usage. Not
1719 * all codecs can do that. You must check the codec capabilities
1721 * When multithreading is used, it may be called from multiple threads
1722 * at the same time; threads might draw different parts of the same AVFrame,
1723 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1725 * The function is also used by hardware acceleration APIs.
1726 * It is called at least once during frame decoding to pass
1727 * the data needed for hardware render.
1728 * In that mode instead of pixel data, AVFrame points to
1729 * a structure specific to the acceleration API. The application
1730 * reads the structure and can change some fields to indicate progress
1732 * - encoding: unused
1733 * - decoding: Set by user.
1734 * @param height the height of the slice
1735 * @param y the y position of the slice
1736 * @param type 1->top field, 2->bottom field, 3->frame
1737 * @param offset offset into the AVFrame.data from which the slice should be read
1739 void (*draw_horiz_band)(struct AVCodecContext *s,
1740 const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1741 int y, int type, int height);
1744 * callback to negotiate the pixelFormat
1745 * @param fmt is the list of formats which are supported by the codec,
1746 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1747 * The first is always the native one.
1748 * @return the chosen format
1749 * - encoding: unused
1750 * - decoding: Set by user, if not set the native format will be chosen.
1752 enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1755 * maximum number of B-frames between non-B-frames
1756 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1757 * - encoding: Set by user.
1758 * - decoding: unused
1763 * qscale factor between IP and B-frames
1764 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1765 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1766 * - encoding: Set by user.
1767 * - decoding: unused
1769 float b_quant_factor;
1771 /** obsolete FIXME remove */
1773 #define FF_RC_STRATEGY_XVID 1
1775 int b_frame_strategy;
1777 #if FF_API_MPV_GLOBAL_OPTS
1779 * luma single coefficient elimination threshold
1780 * - encoding: Set by user.
1781 * - decoding: unused
1783 attribute_deprecated int luma_elim_threshold;
1786 * chroma single coeff elimination threshold
1787 * - encoding: Set by user.
1788 * - decoding: unused
1790 attribute_deprecated int chroma_elim_threshold;
1794 * qscale offset between IP and B-frames
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 float b_quant_offset;
1801 * Size of the frame reordering buffer in the decoder.
1802 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1803 * - encoding: Set by libavcodec.
1804 * - decoding: Set by libavcodec.
1809 * 0-> h263 quant 1-> mpeg quant
1810 * - encoding: Set by user.
1811 * - decoding: unused
1816 * qscale factor between P and I-frames
1817 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1818 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 float i_quant_factor;
1825 * qscale offset between P and I-frames
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 float i_quant_offset;
1832 * luminance masking (0-> disabled)
1833 * - encoding: Set by user.
1834 * - decoding: unused
1839 * temporary complexity masking (0-> disabled)
1840 * - encoding: Set by user.
1841 * - decoding: unused
1843 float temporal_cplx_masking;
1846 * spatial complexity masking (0-> disabled)
1847 * - encoding: Set by user.
1848 * - decoding: unused
1850 float spatial_cplx_masking;
1853 * p block masking (0-> disabled)
1854 * - encoding: Set by user.
1855 * - decoding: unused
1860 * darkness masking (0-> disabled)
1861 * - encoding: Set by user.
1862 * - decoding: unused
1868 * - encoding: Set by libavcodec.
1869 * - decoding: Set by user (or 0).
1873 * prediction method (needed for huffyuv)
1874 * - encoding: Set by user.
1875 * - decoding: unused
1877 int prediction_method;
1878 #define FF_PRED_LEFT 0
1879 #define FF_PRED_PLANE 1
1880 #define FF_PRED_MEDIAN 2
1883 * slice offsets in the frame in bytes
1884 * - encoding: Set/allocated by libavcodec.
1885 * - decoding: Set/allocated by user (or NULL).
1890 * sample aspect ratio (0 if unknown)
1891 * That is the width of a pixel divided by the height of the pixel.
1892 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1893 * - encoding: Set by user.
1894 * - decoding: Set by libavcodec.
1896 AVRational sample_aspect_ratio;
1899 * motion estimation comparison function
1900 * - encoding: Set by user.
1901 * - decoding: unused
1905 * subpixel motion estimation comparison function
1906 * - encoding: Set by user.
1907 * - decoding: unused
1911 * macroblock comparison function (not supported yet)
1912 * - encoding: Set by user.
1913 * - decoding: unused
1917 * interlaced DCT comparison function
1918 * - encoding: Set by user.
1919 * - decoding: unused
1922 #define FF_CMP_SAD 0
1923 #define FF_CMP_SSE 1
1924 #define FF_CMP_SATD 2
1925 #define FF_CMP_DCT 3
1926 #define FF_CMP_PSNR 4
1927 #define FF_CMP_BIT 5
1929 #define FF_CMP_ZERO 7
1930 #define FF_CMP_VSAD 8
1931 #define FF_CMP_VSSE 9
1932 #define FF_CMP_NSSE 10
1933 #define FF_CMP_W53 11
1934 #define FF_CMP_W97 12
1935 #define FF_CMP_DCTMAX 13
1936 #define FF_CMP_DCT264 14
1937 #define FF_CMP_CHROMA 256
1940 * ME diamond size & shape
1941 * - encoding: Set by user.
1942 * - decoding: unused
1947 * amount of previous MV predictors (2a+1 x 2a+1 square)
1948 * - encoding: Set by user.
1949 * - decoding: unused
1951 int last_predictor_count;
1954 * prepass for motion estimation
1955 * - encoding: Set by user.
1956 * - decoding: unused
1961 * motion estimation prepass comparison function
1962 * - encoding: Set by user.
1963 * - decoding: unused
1968 * ME prepass diamond size & shape
1969 * - encoding: Set by user.
1970 * - decoding: unused
1976 * - encoding: Set by user.
1977 * - decoding: unused
1979 int me_subpel_quality;
1982 * DTG active format information (additional aspect ratio
1983 * information only used in DVB MPEG-2 transport streams)
1986 * - encoding: unused
1987 * - decoding: Set by decoder.
1989 int dtg_active_format;
1990 #define FF_DTG_AFD_SAME 8
1991 #define FF_DTG_AFD_4_3 9
1992 #define FF_DTG_AFD_16_9 10
1993 #define FF_DTG_AFD_14_9 11
1994 #define FF_DTG_AFD_4_3_SP_14_9 13
1995 #define FF_DTG_AFD_16_9_SP_14_9 14
1996 #define FF_DTG_AFD_SP_4_3 15
1999 * maximum motion estimation search range in subpel units
2000 * If 0 then no limit.
2002 * - encoding: Set by user.
2003 * - decoding: unused
2008 * intra quantizer bias
2009 * - encoding: Set by user.
2010 * - decoding: unused
2012 int intra_quant_bias;
2013 #define FF_DEFAULT_QUANT_BIAS 999999
2016 * inter quantizer bias
2017 * - encoding: Set by user.
2018 * - decoding: unused
2020 int inter_quant_bias;
2022 #if FF_API_COLOR_TABLE_ID
2025 * - encoding: unused
2026 * - decoding: Which clrtable should be used for 8bit RGB images.
2027 * Tables have to be stored somewhere. FIXME
2029 attribute_deprecated int color_table_id;
2034 * - encoding: unused
2035 * - decoding: Set by user.
2038 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2039 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2040 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2043 * XVideo Motion Acceleration
2044 * - encoding: forbidden
2045 * - decoding: set by decoder
2047 int xvmc_acceleration;
2050 * macroblock decision mode
2051 * - encoding: Set by user.
2052 * - decoding: unused
2055 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2056 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2057 #define FF_MB_DECISION_RD 2 ///< rate distortion
2060 * custom intra quantization matrix
2061 * - encoding: Set by user, can be NULL.
2062 * - decoding: Set by libavcodec.
2064 uint16_t *intra_matrix;
2067 * custom inter quantization matrix
2068 * - encoding: Set by user, can be NULL.
2069 * - decoding: Set by libavcodec.
2071 uint16_t *inter_matrix;
2074 * scene change detection threshold
2075 * 0 is default, larger means fewer detected scene changes.
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 int scenechange_threshold;
2082 * noise reduction strength
2083 * - encoding: Set by user.
2084 * - decoding: unused
2086 int noise_reduction;
2088 #if FF_API_INTER_THRESHOLD
2090 * @deprecated this field is unused
2092 attribute_deprecated int inter_threshold;
2095 #if FF_API_MPV_GLOBAL_OPTS
2097 * @deprecated use mpegvideo private options instead
2099 attribute_deprecated int quantizer_noise_shaping;
2103 * Motion estimation threshold below which no motion estimation is
2104 * performed, but instead the user specified motion vectors are used.
2106 * - encoding: Set by user.
2107 * - decoding: unused
2112 * Macroblock threshold below which the user specified macroblock types will be used.
2113 * - encoding: Set by user.
2114 * - decoding: unused
2119 * precision of the intra DC coefficient - 8
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int intra_dc_precision;
2126 * Number of macroblock rows at the top which are skipped.
2127 * - encoding: unused
2128 * - decoding: Set by user.
2133 * Number of macroblock rows at the bottom which are skipped.
2134 * - encoding: unused
2135 * - decoding: Set by user.
2140 * Border processing masking, raises the quantizer for mbs on the borders
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 float border_masking;
2148 * minimum MB lagrange multipler
2149 * - encoding: Set by user.
2150 * - decoding: unused
2155 * maximum MB lagrange multipler
2156 * - encoding: Set by user.
2157 * - decoding: unused
2163 * - encoding: Set by user.
2164 * - decoding: unused
2166 int me_penalty_compensation;
2170 * - encoding: Set by user.
2171 * - decoding: unused
2177 * - encoding: Set by user.
2178 * - decoding: unused
2184 * - encoding: Set by user.
2185 * - decoding: unused
2190 * number of reference frames
2191 * - encoding: Set by user.
2192 * - decoding: Set by lavc.
2197 * chroma qp offset from luma
2198 * - encoding: Set by user.
2199 * - decoding: unused
2204 * Multiplied by qscale for each frame and added to scene_change_score.
2205 * - encoding: Set by user.
2206 * - decoding: unused
2208 int scenechange_factor;
2212 * Note: Value depends upon the compare function used for fullpel ME.
2213 * - encoding: Set by user.
2214 * - decoding: unused
2219 * Adjust sensitivity of b_frame_strategy 1.
2220 * - encoding: Set by user.
2221 * - decoding: unused
2226 * Chromaticity coordinates of the source primaries.
2227 * - encoding: Set by user
2228 * - decoding: Set by libavcodec
2230 enum AVColorPrimaries color_primaries;
2233 * Color Transfer Characteristic.
2234 * - encoding: Set by user
2235 * - decoding: Set by libavcodec
2237 enum AVColorTransferCharacteristic color_trc;
2240 * YUV colorspace type.
2241 * - encoding: Set by user
2242 * - decoding: Set by libavcodec
2244 enum AVColorSpace colorspace;
2247 * MPEG vs JPEG YUV range.
2248 * - encoding: Set by user
2249 * - decoding: Set by libavcodec
2251 enum AVColorRange color_range;
2254 * This defines the location of chroma samples.
2255 * - encoding: Set by user
2256 * - decoding: Set by libavcodec
2258 enum AVChromaLocation chroma_sample_location;
2262 * Indicates number of picture subdivisions. Used for parallelized
2264 * - encoding: Set by user
2265 * - decoding: unused
2270 * - encoding: set by libavcodec
2271 * - decoding: Set by user.
2273 enum AVFieldOrder field_order;
2276 int sample_rate; ///< samples per second
2277 int channels; ///< number of audio channels
2280 * audio sample format
2281 * - encoding: Set by user.
2282 * - decoding: Set by libavcodec.
2284 enum AVSampleFormat sample_fmt; ///< sample format
2286 /* The following data should not be initialized. */
2288 * Number of samples per channel in an audio frame.
2290 * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2291 * except the last must contain exactly frame_size samples per channel.
2292 * May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2293 * frame size is not restricted.
2294 * - decoding: may be set by some decoders to indicate constant frame size
2299 * Frame counter, set by libavcodec.
2301 * - decoding: total number of frames returned from the decoder so far.
2302 * - encoding: total number of frames passed to the encoder so far.
2304 * @note the counter is not incremented if encoding/decoding resulted in
2310 * number of bytes per packet if constant and known or 0
2311 * Used by some WAV based audio codecs.
2316 * Audio cutoff bandwidth (0 means "automatic")
2317 * - encoding: Set by user.
2318 * - decoding: unused
2322 #if FF_API_REQUEST_CHANNELS
2324 * Decoder should decode to this many channels if it can (0 for default)
2325 * - encoding: unused
2326 * - decoding: Set by user.
2327 * @deprecated Deprecated in favor of request_channel_layout.
2329 int request_channels;
2333 * Audio channel layout.
2334 * - encoding: set by user.
2335 * - decoding: set by user, may be overwritten by libavcodec.
2337 uint64_t channel_layout;
2340 * Request decoder to use this channel layout if it can (0 for default)
2341 * - encoding: unused
2342 * - decoding: Set by user.
2344 uint64_t request_channel_layout;
2347 * Type of service that the audio stream conveys.
2348 * - encoding: Set by user.
2349 * - decoding: Set by libavcodec.
2351 enum AVAudioServiceType audio_service_type;
2354 * desired sample format
2355 * - encoding: Not used.
2356 * - decoding: Set by user.
2357 * Decoder will decode to this format if it can.
2359 enum AVSampleFormat request_sample_fmt;
2362 * Called at the beginning of each frame to get a buffer for it.
2364 * The function will set AVFrame.data[], AVFrame.linesize[].
2365 * AVFrame.extended_data[] must also be set, but it should be the same as
2366 * AVFrame.data[] except for planar audio with more channels than can fit
2367 * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2368 * many data pointers as it can hold.
2370 * if CODEC_CAP_DR1 is not set then get_buffer() must call
2371 * avcodec_default_get_buffer() instead of providing buffers allocated by
2374 * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2375 * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2376 * but if get_buffer() is overridden then alignment considerations should
2377 * be taken into account.
2379 * @see avcodec_default_get_buffer()
2383 * If pic.reference is set then the frame will be read later by libavcodec.
2384 * avcodec_align_dimensions2() should be used to find the required width and
2385 * height, as they normally need to be rounded up to the next multiple of 16.
2387 * If frame multithreading is used and thread_safe_callbacks is set,
2388 * it may be called from a different thread, but not from more than one at
2389 * once. Does not need to be reentrant.
2391 * @see release_buffer(), reget_buffer()
2392 * @see avcodec_align_dimensions2()
2396 * Decoders request a buffer of a particular size by setting
2397 * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2398 * however, utilize only part of the buffer by setting AVFrame.nb_samples
2399 * to a smaller value in the output frame.
2401 * Decoders cannot use the buffer after returning from
2402 * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2403 * is assumed to be released immediately upon return.
2405 * As a convenience, av_samples_get_buffer_size() and
2406 * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2407 * functions to find the required data size and to fill data pointers and
2408 * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2409 * since all planes must be the same size.
2411 * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2413 * - encoding: unused
2414 * - decoding: Set by libavcodec, user can override.
2416 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2419 * Called to release buffers which were allocated with get_buffer.
2420 * A released buffer can be reused in get_buffer().
2421 * pic.data[*] must be set to NULL.
2422 * May be called from a different thread if frame multithreading is used,
2423 * but not by more than one thread at once, so does not need to be reentrant.
2424 * - encoding: unused
2425 * - decoding: Set by libavcodec, user can override.
2427 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2430 * Called at the beginning of a frame to get cr buffer for it.
2431 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2432 * libavcodec will pass previous buffer in pic, function should return
2433 * same buffer or new buffer with old frame "painted" into it.
2434 * If pic.data[0] == NULL must behave like get_buffer().
2435 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2436 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2438 * - encoding: unused
2439 * - decoding: Set by libavcodec, user can override.
2441 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2444 /* - encoding parameters */
2445 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2446 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
2450 * - encoding: Set by user.
2451 * - decoding: unused
2457 * - encoding: Set by user.
2458 * - decoding: unused
2463 * maximum quantizer difference between frames
2464 * - encoding: Set by user.
2465 * - decoding: unused
2470 * ratecontrol qmin qmax limiting method
2471 * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2472 * - encoding: Set by user.
2473 * - decoding: unused
2481 * decoder bitstream buffer size
2482 * - encoding: Set by user.
2483 * - decoding: unused
2488 * ratecontrol override, see RcOverride
2489 * - encoding: Allocated/set/freed by user.
2490 * - decoding: unused
2492 int rc_override_count;
2493 RcOverride *rc_override;
2496 * rate control equation
2497 * - encoding: Set by user
2498 * - decoding: unused
2504 * - encoding: Set by user.
2505 * - decoding: unused
2511 * - encoding: Set by user.
2512 * - decoding: unused
2516 float rc_buffer_aggressivity;
2519 * initial complexity for pass1 ratecontrol
2520 * - encoding: Set by user.
2521 * - decoding: unused
2523 float rc_initial_cplx;
2526 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2527 * - encoding: Set by user.
2528 * - decoding: unused.
2530 float rc_max_available_vbv_use;
2533 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2534 * - encoding: Set by user.
2535 * - decoding: unused.
2537 float rc_min_vbv_overflow_use;
2540 * Number of bits which should be loaded into the rc buffer before decoding starts.
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 int rc_initial_buffer_occupancy;
2546 #define FF_CODER_TYPE_VLC 0
2547 #define FF_CODER_TYPE_AC 1
2548 #define FF_CODER_TYPE_RAW 2
2549 #define FF_CODER_TYPE_RLE 3
2550 #define FF_CODER_TYPE_DEFLATE 4
2553 * - encoding: Set by user.
2554 * - decoding: unused
2560 * - encoding: Set by user.
2561 * - decoding: unused
2566 * minimum Lagrange multipler
2567 * - encoding: Set by user.
2568 * - decoding: unused
2573 * maximum Lagrange multipler
2574 * - encoding: Set by user.
2575 * - decoding: unused
2580 * frame skip threshold
2581 * - encoding: Set by user.
2582 * - decoding: unused
2584 int frame_skip_threshold;
2588 * - encoding: Set by user.
2589 * - decoding: unused
2591 int frame_skip_factor;
2594 * frame skip exponent
2595 * - encoding: Set by user.
2596 * - decoding: unused
2601 * frame skip comparison function
2602 * - encoding: Set by user.
2603 * - decoding: unused
2608 * trellis RD quantization
2609 * - encoding: Set by user.
2610 * - decoding: unused
2615 * - encoding: Set by user.
2616 * - decoding: unused
2618 int min_prediction_order;
2621 * - encoding: Set by user.
2622 * - decoding: unused
2624 int max_prediction_order;
2627 * GOP timecode frame start number
2628 * - encoding: Set by user, in non drop frame format
2629 * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2631 int64_t timecode_frame_start;
2633 /* The RTP callback: This function is called */
2634 /* every time the encoder has a packet to send. */
2635 /* It depends on the encoder if the data starts */
2636 /* with a Start Code (it should). H.263 does. */
2637 /* mb_nb contains the number of macroblocks */
2638 /* encoded in the RTP payload. */
2639 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2641 int rtp_payload_size; /* The size of the RTP payload: the coder will */
2642 /* do its best to deliver a chunk with size */
2643 /* below rtp_payload_size, the chunk will start */
2644 /* with a start code on some codecs like H.263. */
2645 /* This doesn't take account of any particular */
2646 /* headers inside the transmitted RTP payload. */
2648 /* statistics, used for 2-pass encoding */
2659 * number of bits used for the previously encoded frame
2660 * - encoding: Set by libavcodec.
2661 * - decoding: unused
2666 * pass1 encoding statistics output buffer
2667 * - encoding: Set by libavcodec.
2668 * - decoding: unused
2673 * pass2 encoding statistics input buffer
2674 * Concatenated stuff from stats_out of pass1 should be placed here.
2675 * - encoding: Allocated/set/freed by user.
2676 * - decoding: unused
2681 * Work around bugs in encoders which sometimes cannot be detected automatically.
2682 * - encoding: Set by user
2683 * - decoding: Set by user
2685 int workaround_bugs;
2686 #define FF_BUG_AUTODETECT 1 ///< autodetection
2687 #define FF_BUG_OLD_MSMPEG4 2
2688 #define FF_BUG_XVID_ILACE 4
2689 #define FF_BUG_UMP4 8
2690 #define FF_BUG_NO_PADDING 16
2691 #define FF_BUG_AMV 32
2692 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2693 #define FF_BUG_QPEL_CHROMA 64
2694 #define FF_BUG_STD_QPEL 128
2695 #define FF_BUG_QPEL_CHROMA2 256
2696 #define FF_BUG_DIRECT_BLOCKSIZE 512
2697 #define FF_BUG_EDGE 1024
2698 #define FF_BUG_HPEL_CHROMA 2048
2699 #define FF_BUG_DC_CLIP 4096
2700 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
2701 #define FF_BUG_TRUNCATED 16384
2704 * strictly follow the standard (MPEG4, ...).
2705 * - encoding: Set by user.
2706 * - decoding: Set by user.
2707 * Setting this to STRICT or higher means the encoder and decoder will
2708 * generally do stupid things, whereas setting it to unofficial or lower
2709 * will mean the encoder might produce output that is not supported by all
2710 * spec-compliant decoders. Decoders don't differentiate between normal,
2711 * unofficial and experimental (that is, they always try to decode things
2712 * when they can) unless they are explicitly asked to behave stupidly
2713 * (=strictly conform to the specs)
2715 int strict_std_compliance;
2716 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
2717 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
2718 #define FF_COMPLIANCE_NORMAL 0
2719 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
2720 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2723 * error concealment flags
2724 * - encoding: unused
2725 * - decoding: Set by user.
2727 int error_concealment;
2728 #define FF_EC_GUESS_MVS 1
2729 #define FF_EC_DEBLOCK 2
2733 * - encoding: Set by user.
2734 * - decoding: Set by user.
2737 #define FF_DEBUG_PICT_INFO 1
2738 #define FF_DEBUG_RC 2
2739 #define FF_DEBUG_BITSTREAM 4
2740 #define FF_DEBUG_MB_TYPE 8
2741 #define FF_DEBUG_QP 16
2742 #define FF_DEBUG_MV 32
2743 #define FF_DEBUG_DCT_COEFF 0x00000040
2744 #define FF_DEBUG_SKIP 0x00000080
2745 #define FF_DEBUG_STARTCODE 0x00000100
2746 #define FF_DEBUG_PTS 0x00000200
2747 #define FF_DEBUG_ER 0x00000400
2748 #define FF_DEBUG_MMCO 0x00000800
2749 #define FF_DEBUG_BUGS 0x00001000
2750 #define FF_DEBUG_VIS_QP 0x00002000
2751 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2752 #define FF_DEBUG_BUFFERS 0x00008000
2753 #define FF_DEBUG_THREADS 0x00010000
2757 * - encoding: Set by user.
2758 * - decoding: Set by user.
2761 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
2762 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
2763 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2766 * Error recognition; may misdetect some more or less valid parts as errors.
2767 * - encoding: unused
2768 * - decoding: Set by user.
2770 int err_recognition;
2771 #define AV_EF_CRCCHECK (1<<0)
2772 #define AV_EF_BITSTREAM (1<<1)
2773 #define AV_EF_BUFFER (1<<2)
2774 #define AV_EF_EXPLODE (1<<3)
2776 #define AV_EF_CAREFUL (1<<16)
2777 #define AV_EF_COMPLIANT (1<<17)
2778 #define AV_EF_AGGRESSIVE (1<<18)
2782 * opaque 64bit number (generally a PTS) that will be reordered and
2783 * output in AVFrame.reordered_opaque
2784 * @deprecated in favor of pkt_pts
2785 * - encoding: unused
2786 * - decoding: Set by user.
2788 int64_t reordered_opaque;
2791 * Hardware accelerator in use
2792 * - encoding: unused.
2793 * - decoding: Set by libavcodec
2795 struct AVHWAccel *hwaccel;
2798 * Hardware accelerator context.
2799 * For some hardware accelerators, a global context needs to be
2800 * provided by the user. In that case, this holds display-dependent
2801 * data FFmpeg cannot instantiate itself. Please refer to the
2802 * FFmpeg HW accelerator documentation to know how to fill this
2803 * is. e.g. for VA API, this is a struct vaapi_context.
2804 * - encoding: unused
2805 * - decoding: Set by user
2807 void *hwaccel_context;
2811 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2812 * - decoding: unused
2814 uint64_t error[AV_NUM_DATA_POINTERS];
2817 * DCT algorithm, see FF_DCT_* below
2818 * - encoding: Set by user.
2819 * - decoding: unused
2822 #define FF_DCT_AUTO 0
2823 #define FF_DCT_FASTINT 1
2824 #define FF_DCT_INT 2
2825 #define FF_DCT_MMX 3
2826 #define FF_DCT_ALTIVEC 5
2827 #define FF_DCT_FAAN 6
2830 * IDCT algorithm, see FF_IDCT_* below.
2831 * - encoding: Set by user.
2832 * - decoding: Set by user.
2835 #define FF_IDCT_AUTO 0
2836 #define FF_IDCT_INT 1
2837 #define FF_IDCT_SIMPLE 2
2838 #define FF_IDCT_SIMPLEMMX 3
2839 #define FF_IDCT_LIBMPEG2MMX 4
2841 #define FF_IDCT_MMI 5
2843 #define FF_IDCT_ARM 7
2844 #define FF_IDCT_ALTIVEC 8
2845 #define FF_IDCT_SH4 9
2846 #define FF_IDCT_SIMPLEARM 10
2847 #define FF_IDCT_H264 11
2848 #define FF_IDCT_VP3 12
2849 #define FF_IDCT_IPP 13
2850 #define FF_IDCT_XVIDMMX 14
2851 #define FF_IDCT_CAVS 15
2852 #define FF_IDCT_SIMPLEARMV5TE 16
2853 #define FF_IDCT_SIMPLEARMV6 17
2854 #define FF_IDCT_SIMPLEVIS 18
2855 #define FF_IDCT_WMV2 19
2856 #define FF_IDCT_FAAN 20
2857 #define FF_IDCT_EA 21
2858 #define FF_IDCT_SIMPLENEON 22
2859 #define FF_IDCT_SIMPLEALPHA 23
2860 #define FF_IDCT_BINK 24
2865 * @deprecated use av_set_cpu_flags_mask() instead.
2867 attribute_deprecated unsigned dsp_mask;
2871 * bits per sample/pixel from the demuxer (needed for huffyuv).
2872 * - encoding: Set by libavcodec.
2873 * - decoding: Set by user.
2875 int bits_per_coded_sample;
2878 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2879 * - encoding: set by user.
2880 * - decoding: set by libavcodec.
2882 int bits_per_raw_sample;
2885 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2886 * - encoding: unused
2887 * - decoding: Set by user.
2892 * the picture in the bitstream
2893 * - encoding: Set by libavcodec.
2894 * - decoding: Set by libavcodec.
2896 AVFrame *coded_frame;
2900 * is used to decide how many independent tasks should be passed to execute()
2901 * - encoding: Set by user.
2902 * - decoding: Set by user.
2907 * Which multithreading methods to use.
2908 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2909 * so clients which cannot provide future frames should not use it.
2911 * - encoding: Set by user, otherwise the default is used.
2912 * - decoding: Set by user, otherwise the default is used.
2915 #define FF_THREAD_FRAME 1 ///< Decode more than one frame at once
2916 #define FF_THREAD_SLICE 2 ///< Decode more than one part of a single frame at once
2919 * Which multithreading methods are in use by the codec.
2920 * - encoding: Set by libavcodec.
2921 * - decoding: Set by libavcodec.
2923 int active_thread_type;
2926 * Set by the client if its custom get_buffer() callback can be called
2927 * synchronously from another thread, which allows faster multithreaded decoding.
2928 * draw_horiz_band() will be called from other threads regardless of this setting.
2929 * Ignored if the default get_buffer() is used.
2930 * - encoding: Set by user.
2931 * - decoding: Set by user.
2933 int thread_safe_callbacks;
2936 * The codec may call this to execute several independent things.
2937 * It will return only after finishing all tasks.
2938 * The user may replace this with some multithreaded implementation,
2939 * the default implementation will execute the parts serially.
2940 * @param count the number of things to execute
2941 * - encoding: Set by libavcodec, user can override.
2942 * - decoding: Set by libavcodec, user can override.
2944 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2947 * The codec may call this to execute several independent things.
2948 * It will return only after finishing all tasks.
2949 * The user may replace this with some multithreaded implementation,
2950 * the default implementation will execute the parts serially.
2951 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2952 * @param c context passed also to func
2953 * @param count the number of things to execute
2954 * @param arg2 argument passed unchanged to func
2955 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2956 * @param func function that will be called count times, with jobnr from 0 to count-1.
2957 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2958 * two instances of func executing at the same time will have the same threadnr.
2959 * @return always 0 currently, but code should handle a future improvement where when any call to func
2960 * returns < 0 no further calls to func may be done and < 0 is returned.
2961 * - encoding: Set by libavcodec, user can override.
2962 * - decoding: Set by libavcodec, user can override.
2964 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2968 * Can be used by execute() to store some per AVCodecContext stuff.
2969 * - encoding: set by execute()
2970 * - decoding: set by execute()
2972 void *thread_opaque;
2975 * noise vs. sse weight for the nsse comparsion function
2976 * - encoding: Set by user.
2977 * - decoding: unused
2983 * - encoding: Set by user.
2984 * - decoding: Set by libavcodec.
2987 #define FF_PROFILE_UNKNOWN -99
2988 #define FF_PROFILE_RESERVED -100
2990 #define FF_PROFILE_AAC_MAIN 0
2991 #define FF_PROFILE_AAC_LOW 1
2992 #define FF_PROFILE_AAC_SSR 2
2993 #define FF_PROFILE_AAC_LTP 3
2994 #define FF_PROFILE_AAC_HE 4
2995 #define FF_PROFILE_AAC_HE_V2 28
2996 #define FF_PROFILE_AAC_LD 22
2997 #define FF_PROFILE_AAC_ELD 38
2999 #define FF_PROFILE_DTS 20
3000 #define FF_PROFILE_DTS_ES 30
3001 #define FF_PROFILE_DTS_96_24 40
3002 #define FF_PROFILE_DTS_HD_HRA 50
3003 #define FF_PROFILE_DTS_HD_MA 60
3005 #define FF_PROFILE_MPEG2_422 0
3006 #define FF_PROFILE_MPEG2_HIGH 1
3007 #define FF_PROFILE_MPEG2_SS 2
3008 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
3009 #define FF_PROFILE_MPEG2_MAIN 4
3010 #define FF_PROFILE_MPEG2_SIMPLE 5
3012 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
3013 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
3015 #define FF_PROFILE_H264_BASELINE 66
3016 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3017 #define FF_PROFILE_H264_MAIN 77
3018 #define FF_PROFILE_H264_EXTENDED 88
3019 #define FF_PROFILE_H264_HIGH 100
3020 #define FF_PROFILE_H264_HIGH_10 110
3021 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
3022 #define FF_PROFILE_H264_HIGH_422 122
3023 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
3024 #define FF_PROFILE_H264_HIGH_444 144
3025 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
3026 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
3027 #define FF_PROFILE_H264_CAVLC_444 44
3029 #define FF_PROFILE_VC1_SIMPLE 0
3030 #define FF_PROFILE_VC1_MAIN 1
3031 #define FF_PROFILE_VC1_COMPLEX 2
3032 #define FF_PROFILE_VC1_ADVANCED 3
3034 #define FF_PROFILE_MPEG4_SIMPLE 0
3035 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
3036 #define FF_PROFILE_MPEG4_CORE 2
3037 #define FF_PROFILE_MPEG4_MAIN 3
3038 #define FF_PROFILE_MPEG4_N_BIT 4
3039 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
3040 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
3041 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
3042 #define FF_PROFILE_MPEG4_HYBRID 8
3043 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
3044 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
3045 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
3046 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
3047 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3048 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
3049 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
3053 * - encoding: Set by user.
3054 * - decoding: Set by libavcodec.
3057 #define FF_LEVEL_UNKNOWN -99
3061 * - encoding: unused
3062 * - decoding: Set by user.
3064 enum AVDiscard skip_loop_filter;
3068 * - encoding: unused
3069 * - decoding: Set by user.
3071 enum AVDiscard skip_idct;
3075 * - encoding: unused
3076 * - decoding: Set by user.
3078 enum AVDiscard skip_frame;
3081 * Header containing style information for text subtitles.
3082 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3083 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3084 * the Format line following. It shouldn't include any Dialogue line.
3085 * - encoding: Set/allocated/freed by user (before avcodec_open2())
3086 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3088 uint8_t *subtitle_header;
3089 int subtitle_header_size;
3092 * Simulates errors in the bitstream to test error concealment.
3093 * - encoding: Set by user.
3094 * - decoding: unused
3099 * Current packet as passed into the decoder, to avoid having
3100 * to pass the packet into every function. Currently only valid
3101 * inside lavc and get/release_buffer callbacks.
3102 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
3103 * - encoding: unused
3108 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3109 * Used for compliant TS muxing.
3110 * - encoding: Set by libavcodec.
3111 * - decoding: unused.
3116 * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3117 * Code outside libavcodec should access this field using:
3118 * avcodec_set_pkt_timebase(avctx)
3119 * - encoding unused.
3120 * - decodimg set by user
3122 AVRational pkt_timebase;
3126 * Code outside libavcodec should access this field using:
3127 * avcodec_get_codec_descriptior(avctx)
3128 * - encoding: unused.
3129 * - decoding: set by libavcodec.
3131 const AVCodecDescriptor *codec_descriptor;
3134 * Current statistics for PTS correction.
3135 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3136 * - encoding: unused
3138 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3139 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3140 int64_t pts_correction_last_pts; /// PTS of the last frame
3141 int64_t pts_correction_last_dts; /// DTS of the last frame
3144 * Current frame metadata.
3145 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3146 * - encoding: unused
3148 AVDictionary *metadata;
3151 AVRational av_codec_get_pkt_timebase (const AVCodecContext *avctx);
3152 void av_codec_set_pkt_timebase (AVCodecContext *avctx, AVRational val);
3154 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3155 void av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3160 typedef struct AVProfile {
3162 const char *name; ///< short name for the profile
3165 typedef struct AVCodecDefault AVCodecDefault;
3172 typedef struct AVCodec {
3174 * Name of the codec implementation.
3175 * The name is globally unique among encoders and among decoders (but an
3176 * encoder and a decoder can share the same name).
3177 * This is the primary way to find a codec from the user perspective.
3181 * Descriptive name for the codec, meant to be more human readable than name.
3182 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3184 const char *long_name;
3185 enum AVMediaType type;
3188 * Codec capabilities.
3192 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3193 const enum AVPixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3194 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3195 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3196 const uint64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3197 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
3198 const AVClass *priv_class; ///< AVClass for the private context
3199 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3201 /*****************************************************************
3202 * No fields below this line are part of the public API. They
3203 * may not be used outside of libavcodec and can be changed and
3205 * New public fields should be added right above.
3206 *****************************************************************
3209 struct AVCodec *next;
3211 * @name Frame-level threading support functions
3215 * If defined, called on thread contexts when they are created.
3216 * If the codec allocates writable tables in init(), re-allocate them here.
3217 * priv_data will be set to a copy of the original.
3219 int (*init_thread_copy)(AVCodecContext *);
3221 * Copy necessary context variables from a previous thread context to the current one.
3222 * If not defined, the next thread will start automatically; otherwise, the codec
3223 * must call ff_thread_finish_setup().
3225 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3227 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3231 * Private codec-specific defaults.
3233 const AVCodecDefault *defaults;
3236 * Initialize codec static data, called from avcodec_register().
3238 void (*init_static_data)(struct AVCodec *codec);
3240 int (*init)(AVCodecContext *);
3241 int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3242 const struct AVSubtitle *sub);
3244 * Encode data to an AVPacket.
3246 * @param avctx codec context
3247 * @param avpkt output AVPacket (may contain a user-provided buffer)
3248 * @param[in] frame AVFrame containing the raw data to be encoded
3249 * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3250 * non-empty packet was returned in avpkt.
3251 * @return 0 on success, negative error code on failure
3253 int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3254 int *got_packet_ptr);
3255 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3256 int (*close)(AVCodecContext *);
3259 * Will be called when seeking
3261 void (*flush)(AVCodecContext *);
3267 typedef struct AVHWAccel {
3269 * Name of the hardware accelerated codec.
3270 * The name is globally unique among encoders and among decoders (but an
3271 * encoder and a decoder can share the same name).
3276 * Type of codec implemented by the hardware accelerator.
3278 * See AVMEDIA_TYPE_xxx
3280 enum AVMediaType type;
3283 * Codec implemented by the hardware accelerator.
3285 * See AV_CODEC_ID_xxx
3290 * Supported pixel format.
3292 * Only hardware accelerated formats are supported here.
3294 enum AVPixelFormat pix_fmt;
3297 * Hardware accelerated codec capabilities.
3298 * see FF_HWACCEL_CODEC_CAP_*
3302 struct AVHWAccel *next;
3305 * Called at the beginning of each frame or field picture.
3307 * Meaningful frame information (codec specific) is guaranteed to
3308 * be parsed at this point. This function is mandatory.
3310 * Note that buf can be NULL along with buf_size set to 0.
3311 * Otherwise, this means the whole frame is available at this point.
3313 * @param avctx the codec context
3314 * @param buf the frame data buffer base
3315 * @param buf_size the size of the frame in bytes
3316 * @return zero if successful, a negative value otherwise
3318 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3321 * Callback for each slice.
3323 * Meaningful slice information (codec specific) is guaranteed to
3324 * be parsed at this point. This function is mandatory.
3326 * @param avctx the codec context
3327 * @param buf the slice data buffer base
3328 * @param buf_size the size of the slice in bytes
3329 * @return zero if successful, a negative value otherwise
3331 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3334 * Called at the end of each frame or field picture.
3336 * The whole picture is parsed at this point and can now be sent
3337 * to the hardware accelerator. This function is mandatory.
3339 * @param avctx the codec context
3340 * @return zero if successful, a negative value otherwise
3342 int (*end_frame)(AVCodecContext *avctx);
3345 * Size of HW accelerator private data.
3347 * Private data is allocated with av_mallocz() before
3348 * AVCodecContext.get_buffer() and deallocated after
3349 * AVCodecContext.release_buffer().
3355 * @defgroup lavc_picture AVPicture
3357 * Functions for working with AVPicture
3362 * four components are given, that's all.
3363 * the last component is alpha
3365 typedef struct AVPicture {
3366 uint8_t *data[AV_NUM_DATA_POINTERS];
3367 int linesize[AV_NUM_DATA_POINTERS]; ///< number of bytes per line
3374 enum AVSubtitleType {
3377 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3380 * Plain text, the text field must be set by the decoder and is
3381 * authoritative. ass and pict fields may contain approximations.
3386 * Formatted text, the ass field must be set by the decoder and is
3387 * authoritative. pict and text fields may contain approximations.
3392 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3394 typedef struct AVSubtitleRect {
3395 int x; ///< top left corner of pict, undefined when pict is not set
3396 int y; ///< top left corner of pict, undefined when pict is not set
3397 int w; ///< width of pict, undefined when pict is not set
3398 int h; ///< height of pict, undefined when pict is not set
3399 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3402 * data+linesize for the bitmap of this subtitle.
3403 * can be set for text/ass as well once they where rendered
3406 enum AVSubtitleType type;
3408 char *text; ///< 0 terminated plain UTF-8 text
3411 * 0 terminated ASS/SSA compatible event line.
3412 * The presentation of this is unaffected by the other values in this
3420 typedef struct AVSubtitle {
3421 uint16_t format; /* 0 = graphics */
3422 uint32_t start_display_time; /* relative to packet pts, in ms */
3423 uint32_t end_display_time; /* relative to packet pts, in ms */
3425 AVSubtitleRect **rects;
3426 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3430 * If c is NULL, returns the first registered codec,
3431 * if c is non-NULL, returns the next registered codec after c,
3432 * or NULL if c is the last one.
3434 AVCodec *av_codec_next(const AVCodec *c);
3437 * Return the LIBAVCODEC_VERSION_INT constant.
3439 unsigned avcodec_version(void);
3442 * Return the libavcodec build-time configuration.
3444 const char *avcodec_configuration(void);
3447 * Return the libavcodec license.
3449 const char *avcodec_license(void);
3452 * Register the codec codec and initialize libavcodec.
3454 * @warning either this function or avcodec_register_all() must be called
3455 * before any other libavcodec functions.
3457 * @see avcodec_register_all()
3459 void avcodec_register(AVCodec *codec);
3462 * Register all the codecs, parsers and bitstream filters which were enabled at
3463 * configuration time. If you do not call this function you can select exactly
3464 * which formats you want to support, by using the individual registration
3467 * @see avcodec_register
3468 * @see av_register_codec_parser
3469 * @see av_register_bitstream_filter
3471 void avcodec_register_all(void);
3474 #if FF_API_ALLOC_CONTEXT
3476 * Allocate an AVCodecContext and set its fields to default values. The
3477 * resulting struct can be deallocated by simply calling av_free().
3479 * @return An AVCodecContext filled with default values or NULL on failure.
3480 * @see avcodec_get_context_defaults
3482 * @deprecated use avcodec_alloc_context3()
3484 attribute_deprecated
3485 AVCodecContext *avcodec_alloc_context(void);
3487 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3488 * we WILL change its arguments and name a few times! */
3489 attribute_deprecated
3490 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3493 * Set the fields of the given AVCodecContext to default values.
3495 * @param s The AVCodecContext of which the fields should be set to default values.
3496 * @deprecated use avcodec_get_context_defaults3
3498 attribute_deprecated
3499 void avcodec_get_context_defaults(AVCodecContext *s);
3501 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3502 * we WILL change its arguments and name a few times! */
3503 attribute_deprecated
3504 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3508 * Allocate an AVCodecContext and set its fields to default values. The
3509 * resulting struct can be deallocated by calling avcodec_close() on it followed
3512 * @param codec if non-NULL, allocate private data and initialize defaults
3513 * for the given codec. It is illegal to then call avcodec_open2()
3514 * with a different codec.
3515 * If NULL, then the codec-specific defaults won't be initialized,
3516 * which may result in suboptimal default settings (this is
3517 * important mainly for encoders, e.g. libx264).
3519 * @return An AVCodecContext filled with default values or NULL on failure.
3520 * @see avcodec_get_context_defaults
3522 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3525 * Set the fields of the given AVCodecContext to default values corresponding
3526 * to the given codec (defaults may be codec-dependent).
3528 * Do not call this function if a non-NULL codec has been passed
3529 * to avcodec_alloc_context3() that allocated this AVCodecContext.
3530 * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3531 * different codec on this AVCodecContext.
3533 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3536 * Get the AVClass for AVCodecContext. It can be used in combination with
3537 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3539 * @see av_opt_find().
3541 const AVClass *avcodec_get_class(void);
3544 * Get the AVClass for AVFrame. It can be used in combination with
3545 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3547 * @see av_opt_find().
3549 const AVClass *avcodec_get_frame_class(void);
3552 * Get the AVClass for AVSubtitleRect. It can be used in combination with
3553 * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3555 * @see av_opt_find().
3557 const AVClass *avcodec_get_subtitle_rect_class(void);
3560 * Copy the settings of the source AVCodecContext into the destination
3561 * AVCodecContext. The resulting destination codec context will be
3562 * unopened, i.e. you are required to call avcodec_open2() before you
3563 * can use this AVCodecContext to decode/encode video/audio data.
3565 * @param dest target codec context, should be initialized with
3566 * avcodec_alloc_context3(), but otherwise uninitialized
3567 * @param src source codec context
3568 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3570 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3573 * Allocate an AVFrame and set its fields to default values. The resulting
3574 * struct must be freed using avcodec_free_frame().
3576 * @return An AVFrame filled with default values or NULL on failure.
3577 * @see avcodec_get_frame_defaults
3579 AVFrame *avcodec_alloc_frame(void);
3582 * Set the fields of the given AVFrame to default values.
3584 * @param frame The AVFrame of which the fields should be set to default values.
3586 void avcodec_get_frame_defaults(AVFrame *frame);
3589 * Free the frame and any dynamically allocated objects in it,
3590 * e.g. extended_data.
3592 * @param frame frame to be freed. The pointer will be set to NULL.
3594 * @warning this function does NOT free the data buffers themselves
3595 * (it does not know how, since they might have been allocated with
3596 * a custom get_buffer()).
3598 void avcodec_free_frame(AVFrame **frame);
3600 #if FF_API_AVCODEC_OPEN
3602 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3603 * function the context has to be allocated.
3605 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3606 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3607 * retrieving a codec.
3609 * @warning This function is not thread safe!
3612 * avcodec_register_all();
3613 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3617 * context = avcodec_alloc_context3(codec);
3619 * if (avcodec_open(context, codec) < 0)
3623 * @param avctx The context which will be set up to use the given codec.
3624 * @param codec The codec to use within the context.
3625 * @return zero on success, a negative value on error
3626 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3628 * @deprecated use avcodec_open2
3630 attribute_deprecated
3631 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3635 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3636 * function the context has to be allocated with avcodec_alloc_context3().
3638 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3639 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3640 * retrieving a codec.
3642 * @warning This function is not thread safe!
3645 * avcodec_register_all();
3646 * av_dict_set(&opts, "b", "2.5M", 0);
3647 * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3651 * context = avcodec_alloc_context3(codec);
3653 * if (avcodec_open2(context, codec, opts) < 0)
3657 * @param avctx The context to initialize.
3658 * @param codec The codec to open this context for. If a non-NULL codec has been
3659 * previously passed to avcodec_alloc_context3() or
3660 * avcodec_get_context_defaults3() for this context, then this
3661 * parameter MUST be either NULL or equal to the previously passed
3663 * @param options A dictionary filled with AVCodecContext and codec-private options.
3664 * On return this object will be filled with options that were not found.
3666 * @return zero on success, a negative value on error
3667 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3668 * av_dict_set(), av_opt_find().
3670 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3673 * Close a given AVCodecContext and free all the data associated with it
3674 * (but not the AVCodecContext itself).
3676 * Calling this function on an AVCodecContext that hasn't been opened will free
3677 * the codec-specific data allocated in avcodec_alloc_context3() /
3678 * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3681 int avcodec_close(AVCodecContext *avctx);
3684 * Free all allocated data in the given subtitle struct.
3686 * @param sub AVSubtitle to free.
3688 void avsubtitle_free(AVSubtitle *sub);
3695 * @addtogroup lavc_packet
3700 * Default packet destructor.
3702 void av_destruct_packet(AVPacket *pkt);
3705 * Initialize optional fields of a packet with default values.
3707 * Note, this does not touch the data and size members, which have to be
3708 * initialized separately.
3712 void av_init_packet(AVPacket *pkt);
3715 * Allocate the payload of a packet and initialize its fields with
3719 * @param size wanted payload size
3720 * @return 0 if OK, AVERROR_xxx otherwise
3722 int av_new_packet(AVPacket *pkt, int size);
3725 * Reduce packet size, correctly zeroing padding
3728 * @param size new size
3730 void av_shrink_packet(AVPacket *pkt, int size);
3733 * Increase packet size, correctly zeroing padding
3736 * @param grow_by number of bytes by which to increase the size of the packet
3738 int av_grow_packet(AVPacket *pkt, int grow_by);
3741 * @warning This is a hack - the packet memory allocation stuff is broken. The
3742 * packet is allocated if it was not really allocated.
3744 int av_dup_packet(AVPacket *pkt);
3747 * Copy packet, including contents
3749 * @return 0 on success, negative AVERROR on fail
3751 int av_copy_packet(AVPacket *dst, AVPacket *src);
3756 * @param pkt packet to free
3758 void av_free_packet(AVPacket *pkt);
3761 * Allocate new information of a packet.
3764 * @param type side information type
3765 * @param size side information size
3766 * @return pointer to fresh allocated data or NULL otherwise
3768 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3772 * Shrink the already allocated side data buffer
3775 * @param type side information type
3776 * @param size new side information size
3777 * @return 0 on success, < 0 on failure
3779 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3783 * Get side information from packet.
3786 * @param type desired side information type
3787 * @param size pointer for side information size to store (optional)
3788 * @return pointer to data if present or NULL otherwise
3790 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3793 int av_packet_merge_side_data(AVPacket *pkt);
3795 int av_packet_split_side_data(AVPacket *pkt);
3803 * @addtogroup lavc_decoding
3808 * Find a registered decoder with a matching codec ID.
3810 * @param id AVCodecID of the requested decoder
3811 * @return A decoder if one was found, NULL otherwise.
3813 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3816 * Find a registered decoder with the specified name.
3818 * @param name name of the requested decoder
3819 * @return A decoder if one was found, NULL otherwise.
3821 AVCodec *avcodec_find_decoder_by_name(const char *name);
3823 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3824 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3825 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3828 * Return the amount of padding in pixels which the get_buffer callback must
3829 * provide around the edge of the image for codecs which do not have the
3830 * CODEC_FLAG_EMU_EDGE flag.
3832 * @return Required padding in pixels.
3834 unsigned avcodec_get_edge_width(void);
3837 * Modify width and height values so that they will result in a memory
3838 * buffer that is acceptable for the codec if you do not use any horizontal
3841 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3842 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3843 * according to avcodec_get_edge_width() before.
3845 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3848 * Modify width and height values so that they will result in a memory
3849 * buffer that is acceptable for the codec if you also ensure that all
3850 * line sizes are a multiple of the respective linesize_align[i].
3852 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3853 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3854 * according to avcodec_get_edge_width() before.
3856 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3857 int linesize_align[AV_NUM_DATA_POINTERS]);
3859 #if FF_API_OLD_DECODE_AUDIO
3861 * Wrapper function which calls avcodec_decode_audio4.
3863 * @deprecated Use avcodec_decode_audio4 instead.
3865 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3866 * Some decoders may support multiple frames in a single AVPacket, such
3867 * decoders would then just decode the first frame. In this case,
3868 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3869 * the remaining data in order to decode the second frame etc.
3871 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3872 * decompressed frame size in bytes.
3874 * @warning You must set frame_size_ptr to the allocated size of the
3875 * output buffer before calling avcodec_decode_audio3().
3877 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3878 * the actual read bytes because some optimized bitstream readers read 32 or 64
3879 * bits at once and could read over the end.
3881 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3882 * no overreading happens for damaged MPEG streams.
3884 * @warning You must not provide a custom get_buffer() when using
3885 * avcodec_decode_audio3(). Doing so will override it with
3886 * avcodec_default_get_buffer. Use avcodec_decode_audio4() instead,
3887 * which does allow the application to provide a custom get_buffer().
3889 * @note You might have to align the input buffer avpkt->data and output buffer
3890 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3891 * necessary at all, on others it won't work at all if not aligned and on others
3892 * it will work but it will have an impact on performance.
3894 * In practice, avpkt->data should have 4 byte alignment at minimum and
3895 * samples should be 16 byte aligned unless the CPU doesn't need it
3896 * (AltiVec and SSE do).
3898 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3899 * between input and output, these need to be fed with avpkt->data=NULL,
3900 * avpkt->size=0 at the end to return the remaining frames.
3902 * @param avctx the codec context
3903 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3904 * If the sample format is planar, each channel plane will
3905 * be the same size, with no padding between channels.
3906 * @param[in,out] frame_size_ptr the output buffer size in bytes
3907 * @param[in] avpkt The input AVPacket containing the input buffer.
3908 * You can create such packet with av_init_packet() and by then setting
3909 * data and size, some decoders might in addition need other fields.
3910 * All decoders are designed to use the least fields possible though.
3911 * @return On error a negative value is returned, otherwise the number of bytes
3912 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3914 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3915 int *frame_size_ptr,
3920 * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3922 * Some decoders may support multiple frames in a single AVPacket. Such
3923 * decoders would then just decode the first frame. In this case,
3924 * avcodec_decode_audio4 has to be called again with an AVPacket containing
3925 * the remaining data in order to decode the second frame, etc...
3926 * Even if no frames are returned, the packet needs to be fed to the decoder
3927 * with remaining data until it is completely consumed or an error occurs.
3929 * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3930 * larger than the actual read bytes because some optimized bitstream
3931 * readers read 32 or 64 bits at once and could read over the end.
3933 * @note You might have to align the input buffer. The alignment requirements
3934 * depend on the CPU and the decoder.
3936 * @param avctx the codec context
3937 * @param[out] frame The AVFrame in which to store decoded audio samples.
3938 * Decoders request a buffer of a particular size by setting
3939 * AVFrame.nb_samples prior to calling get_buffer(). The
3940 * decoder may, however, only utilize part of the buffer by
3941 * setting AVFrame.nb_samples to a smaller value in the
3943 * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3945 * @param[in] avpkt The input AVPacket containing the input buffer.
3946 * At least avpkt->data and avpkt->size should be set. Some
3947 * decoders might also require additional fields to be set.
3948 * @return A negative error code is returned if an error occurred during
3949 * decoding, otherwise the number of bytes consumed from the input
3950 * AVPacket is returned.
3952 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3953 int *got_frame_ptr, const AVPacket *avpkt);
3956 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3957 * Some decoders may support multiple frames in a single AVPacket, such
3958 * decoders would then just decode the first frame.
3960 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3961 * the actual read bytes because some optimized bitstream readers read 32 or 64
3962 * bits at once and could read over the end.
3964 * @warning The end of the input buffer buf should be set to 0 to ensure that
3965 * no overreading happens for damaged MPEG streams.
3967 * @note You might have to align the input buffer avpkt->data.
3968 * The alignment requirements depend on the CPU: on some CPUs it isn't
3969 * necessary at all, on others it won't work at all if not aligned and on others
3970 * it will work but it will have an impact on performance.
3972 * In practice, avpkt->data should have 4 byte alignment at minimum.
3974 * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3975 * between input and output, these need to be fed with avpkt->data=NULL,
3976 * avpkt->size=0 at the end to return the remaining frames.
3978 * @param avctx the codec context
3979 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3980 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3981 * allocate memory for the actual bitmap.
3982 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3983 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3984 * decodes and the decoder tells the user once it does not need the data anymore,
3985 * the user app can at this point free/reuse/keep the memory as it sees fit.
3987 * @param[in] avpkt The input AVpacket containing the input buffer.
3988 * You can create such packet with av_init_packet() and by then setting
3989 * data and size, some decoders might in addition need other fields like
3990 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3992 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3993 * @return On error a negative value is returned, otherwise the number of bytes
3994 * used or zero if no frame could be decompressed.
3996 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3997 int *got_picture_ptr,
3998 const AVPacket *avpkt);
4001 * Decode a subtitle message.
4002 * Return a negative value on error, otherwise return the number of bytes used.
4003 * If no subtitle could be decompressed, got_sub_ptr is zero.
4004 * Otherwise, the subtitle is stored in *sub.
4005 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4006 * simplicity, because the performance difference is expect to be negligible
4007 * and reusing a get_buffer written for video codecs would probably perform badly
4008 * due to a potentially very different allocation pattern.
4010 * @param avctx the codec context
4011 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4012 freed with avsubtitle_free if *got_sub_ptr is set.
4013 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4014 * @param[in] avpkt The input AVPacket containing the input buffer.
4016 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4021 * @defgroup lavc_parsing Frame parsing
4025 typedef struct AVCodecParserContext {
4027 struct AVCodecParser *parser;
4028 int64_t frame_offset; /* offset of the current frame */
4029 int64_t cur_offset; /* current offset
4030 (incremented by each av_parser_parse()) */
4031 int64_t next_frame_offset; /* offset of the next frame */
4033 int pict_type; /* XXX: Put it back in AVCodecContext. */
4035 * This field is used for proper frame duration computation in lavf.
4036 * It signals, how much longer the frame duration of the current frame
4037 * is compared to normal frame duration.
4039 * frame_duration = (1 + repeat_pict) * time_base
4041 * It is used by codecs like H.264 to display telecined material.
4043 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4044 int64_t pts; /* pts of the current frame */
4045 int64_t dts; /* dts of the current frame */
4050 int fetch_timestamp;
4052 #define AV_PARSER_PTS_NB 4
4053 int cur_frame_start_index;
4054 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4055 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4056 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4059 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
4060 #define PARSER_FLAG_ONCE 0x0002
4061 /// Set if the parser has a valid file offset
4062 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
4063 #define PARSER_FLAG_USE_CODEC_TS 0x1000
4065 int64_t offset; ///< byte offset from starting packet start
4066 int64_t cur_frame_end[AV_PARSER_PTS_NB];
4069 * Set by parser to 1 for key frames and 0 for non-key frames.
4070 * It is initialized to -1, so if the parser doesn't set this flag,
4071 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4077 * Time difference in stream time base units from the pts of this
4078 * packet to the point at which the output from the decoder has converged
4079 * independent from the availability of previous frames. That is, the
4080 * frames are virtually identical no matter if decoding started from
4081 * the very first frame or from this keyframe.
4082 * Is AV_NOPTS_VALUE if unknown.
4083 * This field is not the display duration of the current frame.
4084 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4087 * The purpose of this field is to allow seeking in streams that have no
4088 * keyframes in the conventional sense. It corresponds to the
4089 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4090 * essential for some types of subtitle streams to ensure that all
4091 * subtitles are correctly displayed after seeking.
4093 int64_t convergence_duration;
4095 // Timestamp generation support:
4097 * Synchronization point for start of timestamp generation.
4099 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4102 * For example, this corresponds to presence of H.264 buffering period
4108 * Offset of the current timestamp against last timestamp sync point in
4109 * units of AVCodecContext.time_base.
4111 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4112 * contain a valid timestamp offset.
4114 * Note that the timestamp of sync point has usually a nonzero
4115 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4116 * the next frame after timestamp sync point will be usually 1.
4118 * For example, this corresponds to H.264 cpb_removal_delay.
4120 int dts_ref_dts_delta;
4123 * Presentation delay of current frame in units of AVCodecContext.time_base.
4125 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4126 * contain valid non-negative timestamp delta (presentation time of a frame
4127 * must not lie in the past).
4129 * This delay represents the difference between decoding and presentation
4130 * time of the frame.
4132 * For example, this corresponds to H.264 dpb_output_delay.
4137 * Position of the packet in file.
4139 * Analogous to cur_frame_pts/dts
4141 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4144 * Byte position of currently parsed frame in stream.
4149 * Previous frame byte position.
4154 * Duration of the current frame.
4155 * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4156 * For all other types, this is in units of AVCodecContext.time_base.
4159 } AVCodecParserContext;
4161 typedef struct AVCodecParser {
4162 int codec_ids[5]; /* several codec IDs are permitted */
4164 int (*parser_init)(AVCodecParserContext *s);
4165 int (*parser_parse)(AVCodecParserContext *s,
4166 AVCodecContext *avctx,
4167 const uint8_t **poutbuf, int *poutbuf_size,
4168 const uint8_t *buf, int buf_size);
4169 void (*parser_close)(AVCodecParserContext *s);
4170 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4171 struct AVCodecParser *next;
4174 AVCodecParser *av_parser_next(AVCodecParser *c);
4176 void av_register_codec_parser(AVCodecParser *parser);
4177 AVCodecParserContext *av_parser_init(int codec_id);
4182 * @param s parser context.
4183 * @param avctx codec context.
4184 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4185 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4186 * @param buf input buffer.
4187 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4188 * @param pts input presentation timestamp.
4189 * @param dts input decoding timestamp.
4190 * @param pos input byte position in stream.
4191 * @return the number of bytes of the input bitstream used.
4196 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4203 * decode_frame(data, size);
4207 int av_parser_parse2(AVCodecParserContext *s,
4208 AVCodecContext *avctx,
4209 uint8_t **poutbuf, int *poutbuf_size,
4210 const uint8_t *buf, int buf_size,
4211 int64_t pts, int64_t dts,
4215 * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4216 * @deprecated use AVBitstreamFilter
4218 int av_parser_change(AVCodecParserContext *s,
4219 AVCodecContext *avctx,
4220 uint8_t **poutbuf, int *poutbuf_size,
4221 const uint8_t *buf, int buf_size, int keyframe);
4222 void av_parser_close(AVCodecParserContext *s);
4230 * @addtogroup lavc_encoding
4235 * Find a registered encoder with a matching codec ID.
4237 * @param id AVCodecID of the requested encoder
4238 * @return An encoder if one was found, NULL otherwise.
4240 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4243 * Find a registered encoder with the specified name.
4245 * @param name name of the requested encoder
4246 * @return An encoder if one was found, NULL otherwise.
4248 AVCodec *avcodec_find_encoder_by_name(const char *name);
4250 #if FF_API_OLD_ENCODE_AUDIO
4252 * Encode an audio frame from samples into buf.
4254 * @deprecated Use avcodec_encode_audio2 instead.
4256 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4257 * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
4258 * will know how much space is needed because it depends on the value passed
4259 * in buf_size as described below. In that case a lower value can be used.
4261 * @param avctx the codec context
4262 * @param[out] buf the output buffer
4263 * @param[in] buf_size the output buffer size
4264 * @param[in] samples the input buffer containing the samples
4265 * The number of samples read from this buffer is frame_size*channels,
4266 * both of which are defined in avctx.
4267 * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
4268 * samples read from samples is equal to:
4269 * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
4270 * This also implies that av_get_bits_per_sample() must not return 0 for these
4272 * @return On error a negative value is returned, on success zero or the number
4273 * of bytes used to encode the data read from the input buffer.
4275 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
4276 uint8_t *buf, int buf_size,
4277 const short *samples);
4281 * Encode a frame of audio.
4283 * Takes input samples from frame and writes the next output packet, if
4284 * available, to avpkt. The output packet does not necessarily contain data for
4285 * the most recent frame, as encoders can delay, split, and combine input frames
4286 * internally as needed.
4288 * @param avctx codec context
4289 * @param avpkt output AVPacket.
4290 * The user can supply an output buffer by setting
4291 * avpkt->data and avpkt->size prior to calling the
4292 * function, but if the size of the user-provided data is not
4293 * large enough, encoding will fail. If avpkt->data and
4294 * avpkt->size are set, avpkt->destruct must also be set. All
4295 * other AVPacket fields will be reset by the encoder using
4296 * av_init_packet(). If avpkt->data is NULL, the encoder will
4297 * allocate it. The encoder will set avpkt->size to the size
4298 * of the output packet.
4300 * If this function fails or produces no output, avpkt will be
4301 * freed using av_free_packet() (i.e. avpkt->destruct will be
4302 * called to free the user supplied buffer).
4303 * @param[in] frame AVFrame containing the raw audio data to be encoded.
4304 * May be NULL when flushing an encoder that has the
4305 * CODEC_CAP_DELAY capability set.
4306 * If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4307 * can have any number of samples.
4308 * If it is not set, frame->nb_samples must be equal to
4309 * avctx->frame_size for all frames except the last.
4310 * The final frame may be smaller than avctx->frame_size.
4311 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4312 * output packet is non-empty, and to 0 if it is
4313 * empty. If the function returns an error, the
4314 * packet can be assumed to be invalid, and the
4315 * value of got_packet_ptr is undefined and should
4317 * @return 0 on success, negative error code on failure
4319 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4320 const AVFrame *frame, int *got_packet_ptr);
4322 #if FF_API_OLD_ENCODE_VIDEO
4324 * @deprecated use avcodec_encode_video2() instead.
4326 * Encode a video frame from pict into buf.
4327 * The input picture should be
4328 * stored using a specific format, namely avctx.pix_fmt.
4330 * @param avctx the codec context
4331 * @param[out] buf the output buffer for the bitstream of encoded frame
4332 * @param[in] buf_size the size of the output buffer in bytes
4333 * @param[in] pict the input picture to encode
4334 * @return On error a negative value is returned, on success zero or the number
4335 * of bytes used from the output buffer.
4337 attribute_deprecated
4338 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4339 const AVFrame *pict);
4343 * Encode a frame of video.
4345 * Takes input raw video data from frame and writes the next output packet, if
4346 * available, to avpkt. The output packet does not necessarily contain data for
4347 * the most recent frame, as encoders can delay and reorder input frames
4348 * internally as needed.
4350 * @param avctx codec context
4351 * @param avpkt output AVPacket.
4352 * The user can supply an output buffer by setting
4353 * avpkt->data and avpkt->size prior to calling the
4354 * function, but if the size of the user-provided data is not
4355 * large enough, encoding will fail. All other AVPacket fields
4356 * will be reset by the encoder using av_init_packet(). If
4357 * avpkt->data is NULL, the encoder will allocate it.
4358 * The encoder will set avpkt->size to the size of the
4359 * output packet. The returned data (if any) belongs to the
4360 * caller, he is responsible for freeing it.
4362 * If this function fails or produces no output, avpkt will be
4363 * freed using av_free_packet() (i.e. avpkt->destruct will be
4364 * called to free the user supplied buffer).
4365 * @param[in] frame AVFrame containing the raw video data to be encoded.
4366 * May be NULL when flushing an encoder that has the
4367 * CODEC_CAP_DELAY capability set.
4368 * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4369 * output packet is non-empty, and to 0 if it is
4370 * empty. If the function returns an error, the
4371 * packet can be assumed to be invalid, and the
4372 * value of got_packet_ptr is undefined and should
4374 * @return 0 on success, negative error code on failure
4376 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4377 const AVFrame *frame, int *got_packet_ptr);
4379 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4380 const AVSubtitle *sub);
4387 #if FF_API_AVCODEC_RESAMPLE
4389 * @defgroup lavc_resample Audio resampling
4391 * @deprecated use libswresample instead
4395 struct ReSampleContext;
4396 struct AVResampleContext;
4398 typedef struct ReSampleContext ReSampleContext;
4401 * Initialize audio resampling context.
4403 * @param output_channels number of output channels
4404 * @param input_channels number of input channels
4405 * @param output_rate output sample rate
4406 * @param input_rate input sample rate
4407 * @param sample_fmt_out requested output sample format
4408 * @param sample_fmt_in input sample format
4409 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
4410 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4411 * @param linear if 1 then the used FIR filter will be linearly interpolated
4412 between the 2 closest, if 0 the closest will be used
4413 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4414 * @return allocated ReSampleContext, NULL if error occurred
4416 attribute_deprecated
4417 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4418 int output_rate, int input_rate,
4419 enum AVSampleFormat sample_fmt_out,
4420 enum AVSampleFormat sample_fmt_in,
4421 int filter_length, int log2_phase_count,
4422 int linear, double cutoff);
4424 attribute_deprecated
4425 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4428 * Free resample context.
4430 * @param s a non-NULL pointer to a resample context previously
4431 * created with av_audio_resample_init()
4433 attribute_deprecated
4434 void audio_resample_close(ReSampleContext *s);
4438 * Initialize an audio resampler.
4439 * Note, if either rate is not an integer then simply scale both rates up so they are.
4440 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4441 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4442 * @param linear If 1 then the used FIR filter will be linearly interpolated
4443 between the 2 closest, if 0 the closest will be used
4444 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4446 attribute_deprecated
4447 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4450 * Resample an array of samples using a previously configured context.
4451 * @param src an array of unconsumed samples
4452 * @param consumed the number of samples of src which have been consumed are returned here
4453 * @param src_size the number of unconsumed samples available
4454 * @param dst_size the amount of space in samples available in dst
4455 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
4456 * @return the number of samples written in dst or -1 if an error occurred
4458 attribute_deprecated
4459 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4463 * Compensate samplerate/timestamp drift. The compensation is done by changing
4464 * the resampler parameters, so no audible clicks or similar distortions occur
4465 * @param compensation_distance distance in output samples over which the compensation should be performed
4466 * @param sample_delta number of output samples which should be output less
4468 * example: av_resample_compensate(c, 10, 500)
4469 * here instead of 510 samples only 500 samples would be output
4471 * note, due to rounding the actual compensation might be slightly different,
4472 * especially if the compensation_distance is large and the in_rate used during init is small
4474 attribute_deprecated
4475 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4476 attribute_deprecated
4477 void av_resample_close(struct AVResampleContext *c);
4485 * @addtogroup lavc_picture
4490 * Allocate memory for a picture. Call avpicture_free() to free it.
4492 * @see avpicture_fill()
4494 * @param picture the picture to be filled in
4495 * @param pix_fmt the format of the picture
4496 * @param width the width of the picture
4497 * @param height the height of the picture
4498 * @return zero if successful, a negative value if not
4500 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4503 * Free a picture previously allocated by avpicture_alloc().
4504 * The data buffer used by the AVPicture is freed, but the AVPicture structure
4507 * @param picture the AVPicture to be freed
4509 void avpicture_free(AVPicture *picture);
4512 * Fill in the AVPicture fields, always assume a linesize alignment of
4515 * @see av_image_fill_arrays()
4517 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4518 enum AVPixelFormat pix_fmt, int width, int height);
4521 * Copy pixel data from an AVPicture into a buffer, always assume a
4522 * linesize alignment of 1.
4524 * @see av_image_copy_to_buffer()
4526 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4527 int width, int height,
4528 unsigned char *dest, int dest_size);
4531 * Calculate the size in bytes that a picture of the given width and height
4532 * would occupy if stored in the given picture format.
4533 * Always assume a linesize alignment of 1.
4535 * @see av_image_get_buffer_size().
4537 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4540 * deinterlace - if not supported return -1
4542 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4543 enum AVPixelFormat pix_fmt, int width, int height);
4545 * Copy image src to dst. Wraps av_image_copy().
4547 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4548 enum AVPixelFormat pix_fmt, int width, int height);
4551 * Crop image top and left side.
4553 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4554 enum AVPixelFormat pix_fmt, int top_band, int left_band);
4559 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4560 int padtop, int padbottom, int padleft, int padright, int *color);
4567 * @defgroup lavc_misc Utility functions
4570 * Miscellaneous utility functions related to both encoding and decoding
4576 * @defgroup lavc_misc_pixfmt Pixel formats
4578 * Functions for working with pixel formats.
4583 * Utility function to access log2_chroma_w log2_chroma_h from
4584 * the pixel format AVPixFmtDescriptor.
4586 * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4587 * for one that returns a failure code and continues in case of invalid
4590 * @param[in] pix_fmt the pixel format
4591 * @param[out] h_shift store log2_chroma_h
4592 * @param[out] v_shift store log2_chroma_w
4594 * @see av_pix_fmt_get_chroma_sub_sample
4597 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4600 * Return a value representing the fourCC code associated to the
4601 * pixel format pix_fmt, or 0 if no associated fourCC code can be
4604 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4606 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
4607 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
4608 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
4609 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
4610 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
4611 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4614 * Compute what kind of losses will occur when converting from one specific
4615 * pixel format to another.
4616 * When converting from one pixel format to another, information loss may occur.
4617 * For example, when converting from RGB24 to GRAY, the color information will
4618 * be lost. Similarly, other losses occur when converting from some formats to
4619 * other formats. These losses can involve loss of chroma, but also loss of
4620 * resolution, loss of color depth, loss due to the color space conversion, loss
4621 * of the alpha bits or loss due to color quantization.
4622 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4623 * which will occur when converting from one pixel format to another.
4625 * @param[in] dst_pix_fmt destination pixel format
4626 * @param[in] src_pix_fmt source pixel format
4627 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4628 * @return Combination of flags informing you what kind of losses will occur
4629 * (maximum loss for an invalid dst_pix_fmt).
4631 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4634 #if FF_API_FIND_BEST_PIX_FMT
4636 * @deprecated use avcodec_find_best_pix_fmt_of_2() instead.
4638 * Find the best pixel format to convert to given a certain source pixel
4639 * format. When converting from one pixel format to another, information loss
4640 * may occur. For example, when converting from RGB24 to GRAY, the color
4641 * information will be lost. Similarly, other losses occur when converting from
4642 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
4643 * the given pixel formats should be used to suffer the least amount of loss.
4644 * The pixel formats from which it chooses one, are determined by the
4645 * pix_fmt_mask parameter.
4647 * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
4650 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4651 * pix_fmt_mask = (1 << AV_PIX_FMT_YUV422P) | (1 << AV_PIX_FMT_RGB24);
4652 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
4655 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
4656 * @param[in] src_pix_fmt source pixel format
4657 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4658 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4659 * @return The best pixel format to convert to or -1 if none was found.
4661 attribute_deprecated
4662 enum AVPixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum AVPixelFormat src_pix_fmt,
4663 int has_alpha, int *loss_ptr);
4664 #endif /* FF_API_FIND_BEST_PIX_FMT */
4667 * Find the best pixel format to convert to given a certain source pixel
4668 * format. When converting from one pixel format to another, information loss
4669 * may occur. For example, when converting from RGB24 to GRAY, the color
4670 * information will be lost. Similarly, other losses occur when converting from
4671 * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4672 * the given pixel formats should be used to suffer the least amount of loss.
4673 * The pixel formats from which it chooses one, are determined by the
4674 * pix_fmt_list parameter.
4677 * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4678 * @param[in] src_pix_fmt source pixel format
4679 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4680 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4681 * @return The best pixel format to convert to or -1 if none was found.
4683 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(enum AVPixelFormat *pix_fmt_list,
4684 enum AVPixelFormat src_pix_fmt,
4685 int has_alpha, int *loss_ptr);
4688 * Find the best pixel format to convert to given a certain source pixel
4689 * format and a selection of two destination pixel formats. When converting from
4690 * one pixel format to another, information loss may occur. For example, when converting
4691 * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
4692 * converting from some formats to other formats. avcodec_find_best_pix_fmt_of_2() selects which of
4693 * the given pixel formats should be used to suffer the least amount of loss.
4695 * If one of the destination formats is AV_PIX_FMT_NONE the other pixel format (if valid) will be
4699 * src_pix_fmt = AV_PIX_FMT_YUV420P;
4700 * dst_pix_fmt1= AV_PIX_FMT_RGB24;
4701 * dst_pix_fmt2= AV_PIX_FMT_GRAY8;
4702 * dst_pix_fmt3= AV_PIX_FMT_RGB8;
4703 * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
4704 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
4705 * dst_pix_fmt = avcodec_find_best_pix_fmt_of_2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
4708 * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
4709 * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
4710 * @param[in] src_pix_fmt Source pixel format
4711 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4712 * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
4713 * NULL or value of zero means we care about all losses. Out: the loss
4714 * that occurs when converting from src to selected dst pixel format.
4715 * @return The best pixel format to convert to or -1 if none was found.
4717 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4718 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4720 attribute_deprecated
4721 #if AV_HAVE_INCOMPATIBLE_FORK_ABI
4722 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4723 enum AVPixelFormat src_pix_fmt,
4724 int has_alpha, int *loss_ptr);
4726 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
4727 enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
4731 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4737 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4740 * Put a string representing the codec tag codec_tag in buf.
4742 * @param buf_size size in bytes of buf
4743 * @return the length of the string that would have been generated if
4744 * enough space had been available, excluding the trailing null
4746 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4748 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4751 * Return a name for the specified profile, if available.
4753 * @param codec the codec that is searched for the given profile
4754 * @param profile the profile value for which a name is requested
4755 * @return A name for the profile if found, NULL otherwise.
4757 const char *av_get_profile_name(const AVCodec *codec, int profile);
4759 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4760 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4761 //FIXME func typedef
4764 * Fill audio frame data and linesize.
4765 * AVFrame extended_data channel pointers are allocated if necessary for
4768 * @param frame the AVFrame
4769 * frame->nb_samples must be set prior to calling the
4770 * function. This function fills in frame->data,
4771 * frame->extended_data, frame->linesize[0].
4772 * @param nb_channels channel count
4773 * @param sample_fmt sample format
4774 * @param buf buffer to use for frame data
4775 * @param buf_size size of buffer
4776 * @param align plane size sample alignment (0 = default)
4777 * @return 0 on success, negative error code on failure
4779 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4780 enum AVSampleFormat sample_fmt, const uint8_t *buf,
4781 int buf_size, int align);
4784 * Flush buffers, should be called when seeking or when switching to a different stream.
4786 void avcodec_flush_buffers(AVCodecContext *avctx);
4788 void avcodec_default_free_buffers(AVCodecContext *s);
4791 * Return codec bits per sample.
4793 * @param[in] codec_id the codec
4794 * @return Number of bits per sample or zero if unknown for the given codec.
4796 int av_get_bits_per_sample(enum AVCodecID codec_id);
4799 * Return the PCM codec associated with a sample format.
4800 * @param be endianness, 0 for little, 1 for big,
4801 * -1 (or anything else) for native
4802 * @return AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
4804 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4807 * Return codec bits per sample.
4808 * Only return non-zero if the bits per sample is exactly correct, not an
4811 * @param[in] codec_id the codec
4812 * @return Number of bits per sample or zero if unknown for the given codec.
4814 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4817 * Return audio frame duration.
4819 * @param avctx codec context
4820 * @param frame_bytes size of the frame, or 0 if unknown
4821 * @return frame duration, in samples, if known. 0 if not able to
4824 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4827 typedef struct AVBitStreamFilterContext {
4829 struct AVBitStreamFilter *filter;
4830 AVCodecParserContext *parser;
4831 struct AVBitStreamFilterContext *next;
4832 } AVBitStreamFilterContext;
4835 typedef struct AVBitStreamFilter {
4838 int (*filter)(AVBitStreamFilterContext *bsfc,
4839 AVCodecContext *avctx, const char *args,
4840 uint8_t **poutbuf, int *poutbuf_size,
4841 const uint8_t *buf, int buf_size, int keyframe);
4842 void (*close)(AVBitStreamFilterContext *bsfc);
4843 struct AVBitStreamFilter *next;
4844 } AVBitStreamFilter;
4846 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4847 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4848 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4849 AVCodecContext *avctx, const char *args,
4850 uint8_t **poutbuf, int *poutbuf_size,
4851 const uint8_t *buf, int buf_size, int keyframe);
4852 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4854 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4859 * Reallocate the given block if it is not large enough, otherwise do nothing.
4863 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4866 * Allocate a buffer, reusing the given one if large enough.
4868 * Contrary to av_fast_realloc the current buffer contents might not be
4869 * preserved and on error the old buffer is freed, thus no special
4870 * handling to avoid memleaks is necessary.
4872 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4873 * @param size size of the buffer *ptr points to
4874 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4875 * *size 0 if an error occurred.
4877 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4880 * Same behaviour av_fast_malloc but the buffer has additional
4881 * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4883 * In addition the whole buffer will initially and after resizes
4884 * be 0-initialized so that no uninitialized data will ever appear.
4886 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4889 * Same behaviour av_fast_padded_malloc except that buffer will always
4890 * be 0-initialized after call.
4892 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
4895 * Encode extradata length to a buffer. Used by xiph codecs.
4897 * @param s buffer to write to; must be at least (v/255+1) bytes long
4898 * @param v size of extradata in bytes
4899 * @return number of bytes written to the buffer.
4901 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4904 * Log a generic warning message about a missing feature. This function is
4905 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4906 * only, and would normally not be used by applications.
4907 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4908 * a pointer to an AVClass struct
4909 * @param[in] feature string containing the name of the missing feature
4910 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4911 * If want_sample is non-zero, additional verbage will be added to the log
4912 * message which tells the user how to report samples to the development
4915 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4918 * Log a generic warning message asking for a sample. This function is
4919 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4920 * only, and would normally not be used by applications.
4921 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4922 * a pointer to an AVClass struct
4923 * @param[in] msg string containing an optional message, or NULL if no message
4925 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4928 * Register the hardware accelerator hwaccel.
4930 void av_register_hwaccel(AVHWAccel *hwaccel);
4933 * If hwaccel is NULL, returns the first registered hardware accelerator,
4934 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4935 * after hwaccel, or NULL if hwaccel is the last one.
4937 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4941 * Lock operation used by lockmgr
4944 AV_LOCK_CREATE, ///< Create a mutex
4945 AV_LOCK_OBTAIN, ///< Lock the mutex
4946 AV_LOCK_RELEASE, ///< Unlock the mutex
4947 AV_LOCK_DESTROY, ///< Free mutex resources
4951 * Register a user provided lock manager supporting the operations
4952 * specified by AVLockOp. mutex points to a (void *) where the
4953 * lockmgr should store/get a pointer to a user allocated mutex. It's
4954 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4956 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4957 * callback during the call to av_lockmgr_register().
4958 * Thus, the application must be prepared to handle that.
4959 * If cb is set to NULL the lockmgr will be unregistered.
4960 * Also note that during unregistration the previously registered
4961 * lockmgr callback may also be invoked.
4963 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4966 * Get the type of the given codec.
4968 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4971 * Get the name of a codec.
4972 * @return a static string identifying the codec; never NULL
4974 const char *avcodec_get_name(enum AVCodecID id);
4977 * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4978 * with no corresponding avcodec_close()), 0 otherwise.
4980 int avcodec_is_open(AVCodecContext *s);
4983 * @return a non-zero number if codec is an encoder, zero otherwise
4985 int av_codec_is_encoder(const AVCodec *codec);
4988 * @return a non-zero number if codec is a decoder, zero otherwise
4990 int av_codec_is_decoder(const AVCodec *codec);
4993 * @return descriptor for given codec ID or NULL if no descriptor exists.
4995 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4998 * Iterate over all codec descriptors known to libavcodec.
5000 * @param prev previous descriptor. NULL to get the first descriptor.
5002 * @return next descriptor or NULL after the last descriptor
5004 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5007 * @return codec descriptor with the given name or NULL if no such descriptor
5010 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5016 #endif /* AVCODEC_AVCODEC_H */