2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/log.h"
34 #include "libavutil/pixfmt.h"
35 #include "libavutil/rational.h"
37 #include "libavcodec/version.h"
40 * Identify the syntax and semantics of the bitstream.
41 * The principle is roughly:
42 * Two decoders with the same ID can decode the same streams.
43 * Two encoders with the same ID can encode compatible streams.
44 * There may be slight deviations from the principle due to implementation
47 * If you add a codec ID to this list, add it so that
48 * 1. no value of a existing codec ID changes (that would break ABI),
49 * 2. it is as close as possible to similar codecs.
56 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
57 CODEC_ID_MPEG2VIDEO_XVMC,
94 CODEC_ID_INTERPLAY_VIDEO,
106 CODEC_ID_TRUEMOTION1,
133 CODEC_ID_TRUEMOTION2,
150 CODEC_ID_DSICINVIDEO,
151 CODEC_ID_TIERTEXSEQVIDEO,
160 CODEC_ID_BETHSOFTVID,
178 CODEC_ID_MOTIONPIXELS,
196 CODEC_ID_IFF_BYTERUN1,
211 /* various PCM "codecs" */
212 CODEC_ID_PCM_S16LE= 0x10000,
228 CODEC_ID_PCM_S24DAUD,
230 CODEC_ID_PCM_S16LE_PLANAR,
240 /* various ADPCM codecs */
241 CODEC_ID_ADPCM_IMA_QT= 0x11000,
242 CODEC_ID_ADPCM_IMA_WAV,
243 CODEC_ID_ADPCM_IMA_DK3,
244 CODEC_ID_ADPCM_IMA_DK4,
245 CODEC_ID_ADPCM_IMA_WS,
246 CODEC_ID_ADPCM_IMA_SMJPEG,
255 CODEC_ID_ADPCM_YAMAHA,
256 CODEC_ID_ADPCM_SBPRO_4,
257 CODEC_ID_ADPCM_SBPRO_3,
258 CODEC_ID_ADPCM_SBPRO_2,
260 CODEC_ID_ADPCM_IMA_AMV,
261 CODEC_ID_ADPCM_EA_R1,
262 CODEC_ID_ADPCM_EA_R3,
263 CODEC_ID_ADPCM_EA_R2,
264 CODEC_ID_ADPCM_IMA_EA_SEAD,
265 CODEC_ID_ADPCM_IMA_EA_EACS,
266 CODEC_ID_ADPCM_EA_XAS,
267 CODEC_ID_ADPCM_EA_MAXIS_XA,
268 CODEC_ID_ADPCM_IMA_ISS,
272 CODEC_ID_AMR_NB= 0x12000,
275 /* RealAudio codecs*/
276 CODEC_ID_RA_144= 0x13000,
279 /* various DPCM codecs */
280 CODEC_ID_ROQ_DPCM= 0x14000,
281 CODEC_ID_INTERPLAY_DPCM,
286 CODEC_ID_MP2= 0x15000,
287 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
305 CODEC_ID_WESTWOOD_SND1,
306 CODEC_ID_GSM, ///< as in Berlin toast format
314 CODEC_ID_DSICINAUDIO,
318 CODEC_ID_GSM_MS, /* as found in WAV */
327 CODEC_ID_WMALOSSLESS,
336 CODEC_ID_BINKAUDIO_RDFT,
337 CODEC_ID_BINKAUDIO_DCT,
341 /* subtitle codecs */
342 CODEC_ID_DVD_SUBTITLE= 0x17000,
343 CODEC_ID_DVB_SUBTITLE,
344 CODEC_ID_TEXT, ///< raw UTF-8 text
348 CODEC_ID_HDMV_PGS_SUBTITLE,
349 CODEC_ID_DVB_TELETEXT,
352 /* other specific kind of codecs (generally used for attachments) */
353 CODEC_ID_TTF= 0x18000,
355 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
357 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
358 * stream (only used by libavformat) */
359 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
362 #if FF_API_OLD_SAMPLE_FMT
363 #define SampleFormat AVSampleFormat
365 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
366 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
367 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
368 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
369 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
370 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
371 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
374 #if FF_API_OLD_AUDIOCONVERT
375 #include "libavutil/audioconvert.h"
377 /* Audio channel masks */
378 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
379 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
380 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
381 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
382 #define CH_BACK_LEFT AV_CH_BACK_LEFT
383 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
384 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
385 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
386 #define CH_BACK_CENTER AV_CH_BACK_CENTER
387 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
388 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
389 #define CH_TOP_CENTER AV_CH_TOP_CENTER
390 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
391 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
392 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
393 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
394 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
395 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
396 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
397 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
399 /** Channel mask value used for AVCodecContext.request_channel_layout
400 to indicate that the user requests the channel order of the decoder output
401 to be the native codec channel order. */
402 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
404 /* Audio channel convenience macros */
405 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
406 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
407 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
408 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
409 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
410 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
411 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
412 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
413 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
414 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
415 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
416 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
417 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
418 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
419 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
423 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
426 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
427 * This is mainly needed because some optimized bitstream readers read
428 * 32 or 64 bit at once and could read over the end.<br>
429 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
430 * MPEG bitstreams could cause overread and segfault.
432 #define FF_INPUT_BUFFER_PADDING_SIZE 8
435 * minimum encoding buffer size
436 * Used to avoid some checks during header writing.
438 #define FF_MIN_BUFFER_SIZE 16384
442 * motion estimation type.
445 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
449 ME_EPZS, ///< enhanced predictive zonal search
450 ME_X1, ///< reserved for experiments
451 ME_HEX, ///< hexagon based search
452 ME_UMH, ///< uneven multi-hexagon search
453 ME_ITER, ///< iterative search
454 ME_TESA, ///< transformed exhaustive search algorithm
458 /* We leave some space between them for extensions (drop some
459 * keyframes for intra-only or drop just some bidir frames). */
460 AVDISCARD_NONE =-16, ///< discard nothing
461 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
462 AVDISCARD_NONREF = 8, ///< discard all non reference
463 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
464 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
465 AVDISCARD_ALL = 48, ///< discard all
468 enum AVColorPrimaries{
469 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
470 AVCOL_PRI_UNSPECIFIED=2,
472 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
473 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
474 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
476 AVCOL_PRI_NB , ///< Not part of ABI
479 enum AVColorTransferCharacteristic{
480 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
481 AVCOL_TRC_UNSPECIFIED=2,
482 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
483 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
484 AVCOL_TRC_NB , ///< Not part of ABI
489 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
490 AVCOL_SPC_UNSPECIFIED=2,
492 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
493 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
494 AVCOL_SPC_SMPTE240M =7,
495 AVCOL_SPC_NB , ///< Not part of ABI
499 AVCOL_RANGE_UNSPECIFIED=0,
500 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
501 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
502 AVCOL_RANGE_NB , ///< Not part of ABI
506 * X X 3 4 X X are luma samples,
507 * 1 2 1-6 are possible chroma positions
508 * X X 5 6 X 0 is undefined/unknown position
510 enum AVChromaLocation{
511 AVCHROMA_LOC_UNSPECIFIED=0,
512 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
513 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
514 AVCHROMA_LOC_TOPLEFT =3, ///< DV
516 AVCHROMA_LOC_BOTTOMLEFT =5,
517 AVCHROMA_LOC_BOTTOM =6,
518 AVCHROMA_LOC_NB , ///< Not part of ABI
521 #if FF_API_FLAC_GLOBAL_OPTS
525 attribute_deprecated enum AVLPCType {
526 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
527 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
528 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
529 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
530 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
531 AV_LPC_TYPE_NB , ///< Not part of ABI
535 enum AVAudioServiceType {
536 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
537 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
538 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
539 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
540 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
541 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
542 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
543 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
544 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
545 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
548 typedef struct RcOverride{
551 int qscale; // If this is 0 then quality_factor will be used instead.
552 float quality_factor;
555 #define FF_MAX_B_FRAMES 16
558 These flags can be passed in AVCodecContext.flags before initialization.
559 Note: Not everything is supported yet.
562 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
563 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
564 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
565 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
566 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
567 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
569 * The parent program guarantees that the input for B-frames containing
570 * streams is not written to for at least s->max_b_frames+1 frames, if
571 * this is not set the input will be copied.
573 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
574 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
575 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
576 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
577 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
578 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
579 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
580 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
581 location instead of only at frame boundaries. */
582 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
583 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
584 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
585 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
586 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
587 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
588 /* Fx : Flag for h263+ extra options */
589 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
590 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
591 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
592 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
593 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
594 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
595 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
596 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
597 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
598 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
599 #define CODEC_FLAG_CLOSED_GOP 0x80000000
600 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
601 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
602 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
603 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
604 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
605 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
606 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
607 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
608 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
609 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
610 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
611 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
612 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
613 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
614 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
615 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
616 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
617 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
618 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
619 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
620 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
621 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
623 /* Unsupported options :
624 * Syntax Arithmetic coding (SAC)
625 * Reference Picture Selection
626 * Independent Segment Decoding */
628 /* codec capabilities */
630 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
632 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
633 * If not set, it might not use get_buffer() at all or use operations that
634 * assume the buffer was allocated by avcodec_default_get_buffer.
636 #define CODEC_CAP_DR1 0x0002
637 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
638 #define CODEC_CAP_PARSE_ONLY 0x0004
639 #define CODEC_CAP_TRUNCATED 0x0008
640 /* Codec can export data for HW decoding (XvMC). */
641 #define CODEC_CAP_HWACCEL 0x0010
643 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
644 * If this is not set, the codec is guaranteed to never be fed with NULL data.
646 #define CODEC_CAP_DELAY 0x0020
648 * Codec can be fed a final frame with a smaller size.
649 * This can be used to prevent truncation of the last audio samples.
651 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
653 * Codec can export data for HW decoding (VDPAU).
655 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
657 * Codec can output multiple frames per AVPacket
658 * Normally demuxers return one frame at a time, demuxers which do not do
659 * are connected to a parser to split what they return into proper frames.
660 * This flag is reserved to the very rare category of codecs which have a
661 * bitstream that cannot be split into frames without timeconsuming
662 * operations like full decoding. Demuxers carring such bitstreams thus
663 * may return multiple frames in a packet. This has many disadvantages like
664 * prohibiting stream copy in many cases thus it should only be considered
667 #define CODEC_CAP_SUBFRAMES 0x0100
669 * Codec is experimental and is thus avoided in favor of non experimental
672 #define CODEC_CAP_EXPERIMENTAL 0x0200
674 * Codec should fill in channel configuration and samplerate instead of container
676 #define CODEC_CAP_CHANNEL_CONF 0x0400
678 * Codec is able to deal with negative linesizes
680 #define CODEC_CAP_NEG_LINESIZES 0x0800
682 * Codec supports frame-level multithreading.
684 #define CODEC_CAP_FRAME_THREADS 0x1000
686 * Codec supports slice-based (or partition-based) multithreading.
688 #define CODEC_CAP_SLICE_THREADS 0x2000
690 //The following defines may change, don't expect compatibility if you use them.
691 #define MB_TYPE_INTRA4x4 0x0001
692 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
693 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
694 #define MB_TYPE_16x16 0x0008
695 #define MB_TYPE_16x8 0x0010
696 #define MB_TYPE_8x16 0x0020
697 #define MB_TYPE_8x8 0x0040
698 #define MB_TYPE_INTERLACED 0x0080
699 #define MB_TYPE_DIRECT2 0x0100 //FIXME
700 #define MB_TYPE_ACPRED 0x0200
701 #define MB_TYPE_GMC 0x0400
702 #define MB_TYPE_SKIP 0x0800
703 #define MB_TYPE_P0L0 0x1000
704 #define MB_TYPE_P1L0 0x2000
705 #define MB_TYPE_P0L1 0x4000
706 #define MB_TYPE_P1L1 0x8000
707 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
708 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
709 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
710 #define MB_TYPE_QUANT 0x00010000
711 #define MB_TYPE_CBP 0x00020000
712 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
716 * This specifies the area which should be displayed.
717 * Note there may be multiple such areas for one frame.
719 typedef struct AVPanScan{
722 * - encoding: Set by user.
723 * - decoding: Set by libavcodec.
728 * width and height in 1/16 pel
729 * - encoding: Set by user.
730 * - decoding: Set by libavcodec.
736 * position of the top left corner in 1/16 pel for up to 3 fields/frames
737 * - encoding: Set by user.
738 * - decoding: Set by libavcodec.
740 int16_t position[3][2];
743 #define FF_COMMON_FRAME \
745 * pointer to the picture planes.\
746 * This might be different from the first allocated byte\
753 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
754 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
760 * 1 -> keyframe, 0-> not\
761 * - encoding: Set by libavcodec.\
762 * - decoding: Set by libavcodec.\
767 * Picture type of the frame, see ?_TYPE below.\
768 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
769 * - decoding: Set by libavcodec.\
771 enum AVPictureType pict_type;\
774 * presentation timestamp in time_base units (time when frame should be shown to user)\
775 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
776 * - encoding: MUST be set by user.\
777 * - decoding: Set by libavcodec.\
782 * picture number in bitstream order\
783 * - encoding: set by\
784 * - decoding: Set by libavcodec.\
786 int coded_picture_number;\
788 * picture number in display order\
789 * - encoding: set by\
790 * - decoding: Set by libavcodec.\
792 int display_picture_number;\
795 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
796 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
797 * - decoding: Set by libavcodec.\
802 * buffer age (1->was last buffer and dint change, 2->..., ...).\
803 * Set to INT_MAX if the buffer has not been used yet.\
804 * - encoding: unused\
805 * - decoding: MUST be set by get_buffer().\
810 * is this picture used as reference\
811 * The values for this are the same as the MpegEncContext.picture_structure\
812 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
813 * Set to 4 for delayed, non-reference frames.\
814 * - encoding: unused\
815 * - decoding: Set by libavcodec. (before get_buffer() call)).\
821 * - encoding: unused\
822 * - decoding: Set by libavcodec.\
824 int8_t *qscale_table;\
827 * - encoding: unused\
828 * - decoding: Set by libavcodec.\
833 * mbskip_table[mb]>=1 if MB didn't change\
834 * stride= mb_width = (width+15)>>4\
835 * - encoding: unused\
836 * - decoding: Set by libavcodec.\
838 uint8_t *mbskip_table;\
841 * motion vector table\
844 * int mv_sample_log2= 4 - motion_subsample_log2;\
845 * int mb_width= (width+15)>>4;\
846 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
847 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
849 * - encoding: Set by user.\
850 * - decoding: Set by libavcodec.\
852 int16_t (*motion_val[2])[2];\
855 * macroblock type table\
856 * mb_type_base + mb_width + 2\
857 * - encoding: Set by user.\
858 * - decoding: Set by libavcodec.\
863 * log2 of the size of the block which a single vector in motion_val represents: \
864 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
865 * - encoding: unused\
866 * - decoding: Set by libavcodec.\
868 uint8_t motion_subsample_log2;\
871 * for some private data of the user\
872 * - encoding: unused\
873 * - decoding: Set by user.\
879 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
880 * - decoding: unused\
885 * type of the buffer (to keep track of who has to deallocate data[*])\
886 * - encoding: Set by the one who allocates it.\
887 * - decoding: Set by the one who allocates it.\
888 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
893 * When decoding, this signals how much the picture must be delayed.\
894 * extra_delay = repeat_pict / (2*fps)\
895 * - encoding: unused\
896 * - decoding: Set by libavcodec.\
906 * The content of the picture is interlaced.\
907 * - encoding: Set by user.\
908 * - decoding: Set by libavcodec. (default 0)\
910 int interlaced_frame;\
913 * If the content is interlaced, is top field displayed first.\
914 * - encoding: Set by user.\
915 * - decoding: Set by libavcodec.\
917 int top_field_first;\
921 * - encoding: Set by user.\
922 * - decoding: Set by libavcodec.\
924 AVPanScan *pan_scan;\
927 * Tell user application that palette has changed from previous frame.\
928 * - encoding: ??? (no palette-enabled encoder yet)\
929 * - decoding: Set by libavcodec. (default 0).\
931 int palette_has_changed;\
934 * codec suggestion on buffer type if != 0\
935 * - encoding: unused\
936 * - decoding: Set by libavcodec. (before get_buffer() call)).\
942 * - encoding: unused\
943 * - decoding: Set by libavcodec.\
948 * motion reference frame index\
949 * the order in which these are stored can depend on the codec.\
950 * - encoding: Set by user.\
951 * - decoding: Set by libavcodec.\
953 int8_t *ref_index[2];\
956 * reordered opaque 64bit (generally an integer or a double precision float\
957 * PTS but can be anything). \
958 * The user sets AVCodecContext.reordered_opaque to represent the input at\
960 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
961 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
962 * @deprecated in favor of pkt_pts\
963 * - encoding: unused\
964 * - decoding: Read by user.\
966 int64_t reordered_opaque;\
969 * hardware accelerator private data (Libav-allocated)\
970 * - encoding: unused\
971 * - decoding: Set by libavcodec\
973 void *hwaccel_picture_private;\
976 * reordered pts from the last AVPacket that has been input into the decoder\
977 * - encoding: unused\
978 * - decoding: Read by user.\
983 * dts from the last AVPacket that has been input into the decoder\
984 * - encoding: unused\
985 * - decoding: Read by user.\
990 * the AVCodecContext which ff_thread_get_buffer() was last called on\
991 * - encoding: Set by libavcodec.\
992 * - decoding: Set by libavcodec.\
994 struct AVCodecContext *owner;\
997 * used by multithreading to store frame-specific info\
998 * - encoding: Set by libavcodec.\
999 * - decoding: Set by libavcodec.\
1001 void *thread_opaque;\
1003 #define FF_QSCALE_TYPE_MPEG1 0
1004 #define FF_QSCALE_TYPE_MPEG2 1
1005 #define FF_QSCALE_TYPE_H264 2
1006 #define FF_QSCALE_TYPE_VP56 3
1008 #define FF_BUFFER_TYPE_INTERNAL 1
1009 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1010 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1011 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1013 #if FF_API_OLD_FF_PICT_TYPES
1014 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
1015 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
1016 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
1017 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
1018 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
1019 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
1020 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
1021 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
1024 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1025 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1026 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1027 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1029 enum AVPacketSideDataType {
1030 AV_PKT_DATA_PALETTE,
1033 typedef struct AVPacket {
1035 * Presentation timestamp in AVStream->time_base units; the time at which
1036 * the decompressed packet will be presented to the user.
1037 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1038 * pts MUST be larger or equal to dts as presentation cannot happen before
1039 * decompression, unless one wants to view hex dumps. Some formats misuse
1040 * the terms dts and pts/cts to mean something different. Such timestamps
1041 * must be converted to true pts/dts before they are stored in AVPacket.
1045 * Decompression timestamp in AVStream->time_base units; the time at which
1046 * the packet is decompressed.
1047 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1055 * Additional packet data that can be provided by the container.
1056 * Packet can contain several types of side information.
1061 enum AVPacketSideDataType type;
1063 int side_data_elems;
1066 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1067 * Equals next_pts - this_pts in presentation order.
1070 void (*destruct)(struct AVPacket *);
1072 int64_t pos; ///< byte position in stream, -1 if unknown
1075 * Time difference in AVStream->time_base units from the pts of this
1076 * packet to the point at which the output from the decoder has converged
1077 * independent from the availability of previous frames. That is, the
1078 * frames are virtually identical no matter if decoding started from
1079 * the very first frame or from this keyframe.
1080 * Is AV_NOPTS_VALUE if unknown.
1081 * This field is not the display duration of the current packet.
1082 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1085 * The purpose of this field is to allow seeking in streams that have no
1086 * keyframes in the conventional sense. It corresponds to the
1087 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1088 * essential for some types of subtitle streams to ensure that all
1089 * subtitles are correctly displayed after seeking.
1091 int64_t convergence_duration;
1093 #define AV_PKT_FLAG_KEY 0x0001
1096 * Audio Video Frame.
1097 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1099 * Removal, reordering and changes to existing fields require a major
1100 * version bump. No fields should be added into AVFrame before or after
1102 * sizeof(AVFrame) must not be used outside libav*.
1104 typedef struct AVFrame {
1109 * main external API structure.
1110 * New fields can be added to the end with minor version bumps.
1111 * Removal, reordering and changes to existing fields require a major
1113 * sizeof(AVCodecContext) must not be used outside libav*.
1115 typedef struct AVCodecContext {
1117 * information on struct for av_log
1118 * - set by avcodec_alloc_context
1120 const AVClass *av_class;
1122 * the average bitrate
1123 * - encoding: Set by user; unused for constant quantizer encoding.
1124 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1129 * number of bits the bitstream is allowed to diverge from the reference.
1130 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1131 * - encoding: Set by user; unused for constant quantizer encoding.
1132 * - decoding: unused
1134 int bit_rate_tolerance;
1138 * - encoding: Set by user.
1139 * - decoding: Set by user.
1144 * Some codecs need additional format info. It is stored here.
1145 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1146 * specific codec MUST set it correctly otherwise stream copy breaks.
1147 * In general use of this field by muxers is not recommanded.
1148 * - encoding: Set by libavcodec.
1149 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1154 * Motion estimation algorithm used for video coding.
1155 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1156 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1157 * - encoding: MUST be set by user.
1158 * - decoding: unused
1163 * some codecs need / can use extradata like Huffman tables.
1164 * mjpeg: Huffman tables
1165 * rv10: additional flags
1166 * mpeg4: global headers (they can be in the bitstream or here)
1167 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1168 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1169 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1170 * - encoding: Set/allocated/freed by libavcodec.
1171 * - decoding: Set/allocated/freed by user.
1177 * This is the fundamental unit of time (in seconds) in terms
1178 * of which frame timestamps are represented. For fixed-fps content,
1179 * timebase should be 1/framerate and timestamp increments should be
1181 * - encoding: MUST be set by user.
1182 * - decoding: Set by libavcodec.
1184 AVRational time_base;
1188 * picture width / height.
1189 * - encoding: MUST be set by user.
1190 * - decoding: Set by libavcodec.
1191 * Note: For compatibility it is possible to set this instead of
1192 * coded_width/height before decoding.
1196 #define FF_ASPECT_EXTENDED 15
1199 * the number of pictures in a group of pictures, or 0 for intra_only
1200 * - encoding: Set by user.
1201 * - decoding: unused
1206 * Pixel format, see PIX_FMT_xxx.
1207 * May be set by the demuxer if known from headers.
1208 * May be overriden by the decoder if it knows better.
1209 * - encoding: Set by user.
1210 * - decoding: Set by user if known, overridden by libavcodec if known
1212 enum PixelFormat pix_fmt;
1215 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1216 * decoder to draw a horizontal band. It improves cache usage. Not
1217 * all codecs can do that. You must check the codec capabilities
1219 * When multithreading is used, it may be called from multiple threads
1220 * at the same time; threads might draw different parts of the same AVFrame,
1221 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1223 * The function is also used by hardware acceleration APIs.
1224 * It is called at least once during frame decoding to pass
1225 * the data needed for hardware render.
1226 * In that mode instead of pixel data, AVFrame points to
1227 * a structure specific to the acceleration API. The application
1228 * reads the structure and can change some fields to indicate progress
1230 * - encoding: unused
1231 * - decoding: Set by user.
1232 * @param height the height of the slice
1233 * @param y the y position of the slice
1234 * @param type 1->top field, 2->bottom field, 3->frame
1235 * @param offset offset into the AVFrame.data from which the slice should be read
1237 void (*draw_horiz_band)(struct AVCodecContext *s,
1238 const AVFrame *src, int offset[4],
1239 int y, int type, int height);
1242 int sample_rate; ///< samples per second
1243 int channels; ///< number of audio channels
1246 * audio sample format
1247 * - encoding: Set by user.
1248 * - decoding: Set by libavcodec.
1250 enum AVSampleFormat sample_fmt; ///< sample format
1252 /* The following data should not be initialized. */
1254 * Samples per packet, initialized when calling 'init'.
1257 int frame_number; ///< audio or video frame number
1260 * Number of frames the decoded output will be delayed relative to
1261 * the encoded input.
1262 * - encoding: Set by libavcodec.
1263 * - decoding: unused
1267 /* - encoding parameters */
1268 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1269 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1273 * - encoding: Set by user.
1274 * - decoding: unused
1280 * - encoding: Set by user.
1281 * - decoding: unused
1286 * maximum quantizer difference between frames
1287 * - encoding: Set by user.
1288 * - decoding: unused
1293 * maximum number of B-frames between non-B-frames
1294 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1295 * - encoding: Set by user.
1296 * - decoding: unused
1301 * qscale factor between IP and B-frames
1302 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1303 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1304 * - encoding: Set by user.
1305 * - decoding: unused
1307 float b_quant_factor;
1309 /** obsolete FIXME remove */
1311 #define FF_RC_STRATEGY_XVID 1
1313 int b_frame_strategy;
1315 struct AVCodec *codec;
1319 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1320 /* do its best to deliver a chunk with size */
1321 /* below rtp_payload_size, the chunk will start */
1322 /* with a start code on some codecs like H.263. */
1323 /* This doesn't take account of any particular */
1324 /* headers inside the transmitted RTP payload. */
1327 /* The RTP callback: This function is called */
1328 /* every time the encoder has a packet to send. */
1329 /* It depends on the encoder if the data starts */
1330 /* with a Start Code (it should). H.263 does. */
1331 /* mb_nb contains the number of macroblocks */
1332 /* encoded in the RTP payload. */
1333 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1335 /* statistics, used for 2-pass encoding */
1346 * number of bits used for the previously encoded frame
1347 * - encoding: Set by libavcodec.
1348 * - decoding: unused
1353 * Private data of the user, can be used to carry app specific stuff.
1354 * - encoding: Set by user.
1355 * - decoding: Set by user.
1359 char codec_name[32];
1360 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1361 enum CodecID codec_id; /* see CODEC_ID_xxx */
1364 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1365 * This is used to work around some encoder bugs.
1366 * A demuxer should set this to what is stored in the field used to identify the codec.
1367 * If there are multiple such fields in a container then the demuxer should choose the one
1368 * which maximizes the information about the used codec.
1369 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1370 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1371 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1373 * - encoding: Set by user, if not then the default based on codec_id will be used.
1374 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1376 unsigned int codec_tag;
1379 * Work around bugs in encoders which sometimes cannot be detected automatically.
1380 * - encoding: Set by user
1381 * - decoding: Set by user
1383 int workaround_bugs;
1384 #define FF_BUG_AUTODETECT 1 ///< autodetection
1385 #define FF_BUG_OLD_MSMPEG4 2
1386 #define FF_BUG_XVID_ILACE 4
1387 #define FF_BUG_UMP4 8
1388 #define FF_BUG_NO_PADDING 16
1389 #define FF_BUG_AMV 32
1390 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1391 #define FF_BUG_QPEL_CHROMA 64
1392 #define FF_BUG_STD_QPEL 128
1393 #define FF_BUG_QPEL_CHROMA2 256
1394 #define FF_BUG_DIRECT_BLOCKSIZE 512
1395 #define FF_BUG_EDGE 1024
1396 #define FF_BUG_HPEL_CHROMA 2048
1397 #define FF_BUG_DC_CLIP 4096
1398 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1399 #define FF_BUG_TRUNCATED 16384
1400 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1403 * luma single coefficient elimination threshold
1404 * - encoding: Set by user.
1405 * - decoding: unused
1407 int luma_elim_threshold;
1410 * chroma single coeff elimination threshold
1411 * - encoding: Set by user.
1412 * - decoding: unused
1414 int chroma_elim_threshold;
1417 * strictly follow the standard (MPEG4, ...).
1418 * - encoding: Set by user.
1419 * - decoding: Set by user.
1420 * Setting this to STRICT or higher means the encoder and decoder will
1421 * generally do stupid things, whereas setting it to unofficial or lower
1422 * will mean the encoder might produce output that is not supported by all
1423 * spec-compliant decoders. Decoders don't differentiate between normal,
1424 * unofficial and experimental (that is, they always try to decode things
1425 * when they can) unless they are explicitly asked to behave stupidly
1426 * (=strictly conform to the specs)
1428 int strict_std_compliance;
1429 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1430 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1431 #define FF_COMPLIANCE_NORMAL 0
1432 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1433 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1436 * qscale offset between IP and B-frames
1437 * - encoding: Set by user.
1438 * - decoding: unused
1440 float b_quant_offset;
1443 * Error recognization; higher values will detect more errors but may
1444 * misdetect some more or less valid parts as errors.
1445 * - encoding: unused
1446 * - decoding: Set by user.
1448 int error_recognition;
1449 #define FF_ER_CAREFUL 1
1450 #define FF_ER_COMPLIANT 2
1451 #define FF_ER_AGGRESSIVE 3
1452 #define FF_ER_VERY_AGGRESSIVE 4
1455 * Called at the beginning of each frame to get a buffer for it.
1456 * If pic.reference is set then the frame will be read later by libavcodec.
1457 * avcodec_align_dimensions2() should be used to find the required width and
1458 * height, as they normally need to be rounded up to the next multiple of 16.
1459 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1460 * avcodec_default_get_buffer() instead of providing buffers allocated by
1462 * If frame multithreading is used and thread_safe_callbacks is set,
1463 * it may be called from a different thread, but not from more than one at once.
1464 * Does not need to be reentrant.
1465 * - encoding: unused
1466 * - decoding: Set by libavcodec, user can override.
1468 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1471 * Called to release buffers which were allocated with get_buffer.
1472 * A released buffer can be reused in get_buffer().
1473 * pic.data[*] must be set to NULL.
1474 * May be called from a different thread if frame multithreading is used,
1475 * but not by more than one thread at once, so does not need to be reentrant.
1476 * - encoding: unused
1477 * - decoding: Set by libavcodec, user can override.
1479 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1482 * Size of the frame reordering buffer in the decoder.
1483 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1484 * - encoding: Set by libavcodec.
1485 * - decoding: Set by libavcodec.
1490 * number of bytes per packet if constant and known or 0
1491 * Used by some WAV based audio codecs.
1495 int parse_only; /* - decoding only: If true, only parsing is done
1496 (function avcodec_parse_frame()). The frame
1497 data is returned. Only MPEG codecs support this now. */
1500 * 0-> h263 quant 1-> mpeg quant
1501 * - encoding: Set by user.
1502 * - decoding: unused
1507 * pass1 encoding statistics output buffer
1508 * - encoding: Set by libavcodec.
1509 * - decoding: unused
1514 * pass2 encoding statistics input buffer
1515 * Concatenated stuff from stats_out of pass1 should be placed here.
1516 * - encoding: Allocated/set/freed by user.
1517 * - decoding: unused
1522 * ratecontrol qmin qmax limiting method
1523 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1524 * - encoding: Set by user.
1525 * - decoding: unused
1533 * ratecontrol override, see RcOverride
1534 * - encoding: Allocated/set/freed by user.
1535 * - decoding: unused
1537 RcOverride *rc_override;
1538 int rc_override_count;
1541 * rate control equation
1542 * - encoding: Set by user
1543 * - decoding: unused
1549 * - encoding: Set by user.
1550 * - decoding: unused
1556 * - encoding: Set by user.
1557 * - decoding: unused
1562 * decoder bitstream buffer size
1563 * - encoding: Set by user.
1564 * - decoding: unused
1567 float rc_buffer_aggressivity;
1570 * qscale factor between P and I-frames
1571 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1572 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1573 * - encoding: Set by user.
1574 * - decoding: unused
1576 float i_quant_factor;
1579 * qscale offset between P and I-frames
1580 * - encoding: Set by user.
1581 * - decoding: unused
1583 float i_quant_offset;
1586 * initial complexity for pass1 ratecontrol
1587 * - encoding: Set by user.
1588 * - decoding: unused
1590 float rc_initial_cplx;
1593 * DCT algorithm, see FF_DCT_* below
1594 * - encoding: Set by user.
1595 * - decoding: unused
1598 #define FF_DCT_AUTO 0
1599 #define FF_DCT_FASTINT 1
1600 #define FF_DCT_INT 2
1601 #define FF_DCT_MMX 3
1602 #define FF_DCT_MLIB 4
1603 #define FF_DCT_ALTIVEC 5
1604 #define FF_DCT_FAAN 6
1607 * luminance masking (0-> disabled)
1608 * - encoding: Set by user.
1609 * - decoding: unused
1614 * temporary complexity masking (0-> disabled)
1615 * - encoding: Set by user.
1616 * - decoding: unused
1618 float temporal_cplx_masking;
1621 * spatial complexity masking (0-> disabled)
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 float spatial_cplx_masking;
1628 * p block masking (0-> disabled)
1629 * - encoding: Set by user.
1630 * - decoding: unused
1635 * darkness masking (0-> disabled)
1636 * - encoding: Set by user.
1637 * - decoding: unused
1642 * IDCT algorithm, see FF_IDCT_* below.
1643 * - encoding: Set by user.
1644 * - decoding: Set by user.
1647 #define FF_IDCT_AUTO 0
1648 #define FF_IDCT_INT 1
1649 #define FF_IDCT_SIMPLE 2
1650 #define FF_IDCT_SIMPLEMMX 3
1651 #define FF_IDCT_LIBMPEG2MMX 4
1652 #define FF_IDCT_PS2 5
1653 #define FF_IDCT_MLIB 6
1654 #define FF_IDCT_ARM 7
1655 #define FF_IDCT_ALTIVEC 8
1656 #define FF_IDCT_SH4 9
1657 #define FF_IDCT_SIMPLEARM 10
1658 #define FF_IDCT_H264 11
1659 #define FF_IDCT_VP3 12
1660 #define FF_IDCT_IPP 13
1661 #define FF_IDCT_XVIDMMX 14
1662 #define FF_IDCT_CAVS 15
1663 #define FF_IDCT_SIMPLEARMV5TE 16
1664 #define FF_IDCT_SIMPLEARMV6 17
1665 #define FF_IDCT_SIMPLEVIS 18
1666 #define FF_IDCT_WMV2 19
1667 #define FF_IDCT_FAAN 20
1668 #define FF_IDCT_EA 21
1669 #define FF_IDCT_SIMPLENEON 22
1670 #define FF_IDCT_SIMPLEALPHA 23
1671 #define FF_IDCT_BINK 24
1675 * - encoding: Set by libavcodec.
1676 * - decoding: Set by user (or 0).
1680 * slice offsets in the frame in bytes
1681 * - encoding: Set/allocated by libavcodec.
1682 * - decoding: Set/allocated by user (or NULL).
1687 * error concealment flags
1688 * - encoding: unused
1689 * - decoding: Set by user.
1691 int error_concealment;
1692 #define FF_EC_GUESS_MVS 1
1693 #define FF_EC_DEBLOCK 2
1696 * dsp_mask could be add used to disable unwanted CPU features
1697 * CPU features (i.e. MMX, SSE. ...)
1699 * With the FORCE flag you may instead enable given CPU features.
1700 * (Dangerous: Usable in case of misdetection, improper usage however will
1701 * result into program crash.)
1706 * bits per sample/pixel from the demuxer (needed for huffyuv).
1707 * - encoding: Set by libavcodec.
1708 * - decoding: Set by user.
1710 int bits_per_coded_sample;
1713 * prediction method (needed for huffyuv)
1714 * - encoding: Set by user.
1715 * - decoding: unused
1717 int prediction_method;
1718 #define FF_PRED_LEFT 0
1719 #define FF_PRED_PLANE 1
1720 #define FF_PRED_MEDIAN 2
1723 * sample aspect ratio (0 if unknown)
1724 * That is the width of a pixel divided by the height of the pixel.
1725 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1726 * - encoding: Set by user.
1727 * - decoding: Set by libavcodec.
1729 AVRational sample_aspect_ratio;
1732 * the picture in the bitstream
1733 * - encoding: Set by libavcodec.
1734 * - decoding: Set by libavcodec.
1736 AVFrame *coded_frame;
1740 * - encoding: Set by user.
1741 * - decoding: Set by user.
1744 #define FF_DEBUG_PICT_INFO 1
1745 #define FF_DEBUG_RC 2
1746 #define FF_DEBUG_BITSTREAM 4
1747 #define FF_DEBUG_MB_TYPE 8
1748 #define FF_DEBUG_QP 16
1749 #define FF_DEBUG_MV 32
1750 #define FF_DEBUG_DCT_COEFF 0x00000040
1751 #define FF_DEBUG_SKIP 0x00000080
1752 #define FF_DEBUG_STARTCODE 0x00000100
1753 #define FF_DEBUG_PTS 0x00000200
1754 #define FF_DEBUG_ER 0x00000400
1755 #define FF_DEBUG_MMCO 0x00000800
1756 #define FF_DEBUG_BUGS 0x00001000
1757 #define FF_DEBUG_VIS_QP 0x00002000
1758 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1759 #define FF_DEBUG_BUFFERS 0x00008000
1760 #define FF_DEBUG_THREADS 0x00010000
1764 * - encoding: Set by user.
1765 * - decoding: Set by user.
1768 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1769 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1770 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1774 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1775 * - decoding: unused
1780 * motion estimation comparison function
1781 * - encoding: Set by user.
1782 * - decoding: unused
1786 * subpixel motion estimation comparison function
1787 * - encoding: Set by user.
1788 * - decoding: unused
1792 * macroblock comparison function (not supported yet)
1793 * - encoding: Set by user.
1794 * - decoding: unused
1798 * interlaced DCT comparison function
1799 * - encoding: Set by user.
1800 * - decoding: unused
1803 #define FF_CMP_SAD 0
1804 #define FF_CMP_SSE 1
1805 #define FF_CMP_SATD 2
1806 #define FF_CMP_DCT 3
1807 #define FF_CMP_PSNR 4
1808 #define FF_CMP_BIT 5
1810 #define FF_CMP_ZERO 7
1811 #define FF_CMP_VSAD 8
1812 #define FF_CMP_VSSE 9
1813 #define FF_CMP_NSSE 10
1814 #define FF_CMP_W53 11
1815 #define FF_CMP_W97 12
1816 #define FF_CMP_DCTMAX 13
1817 #define FF_CMP_DCT264 14
1818 #define FF_CMP_CHROMA 256
1821 * ME diamond size & shape
1822 * - encoding: Set by user.
1823 * - decoding: unused
1828 * amount of previous MV predictors (2a+1 x 2a+1 square)
1829 * - encoding: Set by user.
1830 * - decoding: unused
1832 int last_predictor_count;
1835 * prepass for motion estimation
1836 * - encoding: Set by user.
1837 * - decoding: unused
1842 * motion estimation prepass comparison function
1843 * - encoding: Set by user.
1844 * - decoding: unused
1849 * ME prepass diamond size & shape
1850 * - encoding: Set by user.
1851 * - decoding: unused
1857 * - encoding: Set by user.
1858 * - decoding: unused
1860 int me_subpel_quality;
1863 * callback to negotiate the pixelFormat
1864 * @param fmt is the list of formats which are supported by the codec,
1865 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1866 * The first is always the native one.
1867 * @return the chosen format
1868 * - encoding: unused
1869 * - decoding: Set by user, if not set the native format will be chosen.
1871 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1874 * DTG active format information (additional aspect ratio
1875 * information only used in DVB MPEG-2 transport streams)
1878 * - encoding: unused
1879 * - decoding: Set by decoder.
1881 int dtg_active_format;
1882 #define FF_DTG_AFD_SAME 8
1883 #define FF_DTG_AFD_4_3 9
1884 #define FF_DTG_AFD_16_9 10
1885 #define FF_DTG_AFD_14_9 11
1886 #define FF_DTG_AFD_4_3_SP_14_9 13
1887 #define FF_DTG_AFD_16_9_SP_14_9 14
1888 #define FF_DTG_AFD_SP_4_3 15
1891 * maximum motion estimation search range in subpel units
1892 * If 0 then no limit.
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * intra quantizer bias
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int intra_quant_bias;
1905 #define FF_DEFAULT_QUANT_BIAS 999999
1908 * inter quantizer bias
1909 * - encoding: Set by user.
1910 * - decoding: unused
1912 int inter_quant_bias;
1916 * - encoding: unused
1917 * - decoding: Which clrtable should be used for 8bit RGB images.
1918 * Tables have to be stored somewhere. FIXME
1923 * internal_buffer count
1924 * Don't touch, used by libavcodec default_get_buffer().
1926 int internal_buffer_count;
1930 * Don't touch, used by libavcodec default_get_buffer().
1932 void *internal_buffer;
1935 * Global quality for codecs which cannot change it per frame.
1936 * This should be proportional to MPEG-1/2/4 qscale.
1937 * - encoding: Set by user.
1938 * - decoding: unused
1942 #define FF_CODER_TYPE_VLC 0
1943 #define FF_CODER_TYPE_AC 1
1944 #define FF_CODER_TYPE_RAW 2
1945 #define FF_CODER_TYPE_RLE 3
1946 #define FF_CODER_TYPE_DEFLATE 4
1949 * - encoding: Set by user.
1950 * - decoding: unused
1956 * - encoding: Set by user.
1957 * - decoding: unused
1963 * - encoding: unused
1964 * - decoding: Set by user.
1966 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1971 * - encoding: unused
1972 * - decoding: Set by user.
1975 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1976 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1977 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1980 * XVideo Motion Acceleration
1981 * - encoding: forbidden
1982 * - decoding: set by decoder
1984 int xvmc_acceleration;
1987 * macroblock decision mode
1988 * - encoding: Set by user.
1989 * - decoding: unused
1992 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1993 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1994 #define FF_MB_DECISION_RD 2 ///< rate distortion
1997 * custom intra quantization matrix
1998 * - encoding: Set by user, can be NULL.
1999 * - decoding: Set by libavcodec.
2001 uint16_t *intra_matrix;
2004 * custom inter quantization matrix
2005 * - encoding: Set by user, can be NULL.
2006 * - decoding: Set by libavcodec.
2008 uint16_t *inter_matrix;
2011 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2012 * This is used to work around some encoder bugs.
2013 * - encoding: unused
2014 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2016 unsigned int stream_codec_tag;
2019 * scene change detection threshold
2020 * 0 is default, larger means fewer detected scene changes.
2021 * - encoding: Set by user.
2022 * - decoding: unused
2024 int scenechange_threshold;
2027 * minimum Lagrange multipler
2028 * - encoding: Set by user.
2029 * - decoding: unused
2034 * maximum Lagrange multipler
2035 * - encoding: Set by user.
2036 * - decoding: unused
2040 #if FF_API_PALETTE_CONTROL
2042 * palette control structure
2043 * - encoding: ??? (no palette-enabled encoder yet)
2044 * - decoding: Set by user.
2046 struct AVPaletteControl *palctrl;
2050 * noise reduction strength
2051 * - encoding: Set by user.
2052 * - decoding: unused
2054 int noise_reduction;
2057 * Called at the beginning of a frame to get cr buffer for it.
2058 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2059 * libavcodec will pass previous buffer in pic, function should return
2060 * same buffer or new buffer with old frame "painted" into it.
2061 * If pic.data[0] == NULL must behave like get_buffer().
2062 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2063 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2065 * - encoding: unused
2066 * - decoding: Set by libavcodec, user can override.
2068 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2071 * Number of bits which should be loaded into the rc buffer before decoding starts.
2072 * - encoding: Set by user.
2073 * - decoding: unused
2075 int rc_initial_buffer_occupancy;
2079 * - encoding: Set by user.
2080 * - decoding: unused
2082 int inter_threshold;
2086 * - encoding: Set by user.
2087 * - decoding: Set by user.
2092 * Simulates errors in the bitstream to test error concealment.
2093 * - encoding: Set by user.
2094 * - decoding: unused
2098 #if FF_API_ANTIALIAS_ALGO
2100 * MP3 antialias algorithm, see FF_AA_* below.
2101 * - encoding: unused
2102 * - decoding: Set by user.
2104 attribute_deprecated int antialias_algo;
2105 #define FF_AA_AUTO 0
2106 #define FF_AA_FASTINT 1 //not implemented yet
2108 #define FF_AA_FLOAT 3
2112 * quantizer noise shaping
2113 * - encoding: Set by user.
2114 * - decoding: unused
2116 int quantizer_noise_shaping;
2120 * is used to decide how many independent tasks should be passed to execute()
2121 * - encoding: Set by user.
2122 * - decoding: Set by user.
2127 * The codec may call this to execute several independent things.
2128 * It will return only after finishing all tasks.
2129 * The user may replace this with some multithreaded implementation,
2130 * the default implementation will execute the parts serially.
2131 * @param count the number of things to execute
2132 * - encoding: Set by libavcodec, user can override.
2133 * - decoding: Set by libavcodec, user can override.
2135 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2139 * Can be used by execute() to store some per AVCodecContext stuff.
2140 * - encoding: set by execute()
2141 * - decoding: set by execute()
2143 void *thread_opaque;
2146 * Motion estimation threshold below which no motion estimation is
2147 * performed, but instead the user specified motion vectors are used.
2149 * - encoding: Set by user.
2150 * - decoding: unused
2155 * Macroblock threshold below which the user specified macroblock types will be used.
2156 * - encoding: Set by user.
2157 * - decoding: unused
2162 * precision of the intra DC coefficient - 8
2163 * - encoding: Set by user.
2164 * - decoding: unused
2166 int intra_dc_precision;
2169 * noise vs. sse weight for the nsse comparsion function
2170 * - encoding: Set by user.
2171 * - decoding: unused
2176 * Number of macroblock rows at the top which are skipped.
2177 * - encoding: unused
2178 * - decoding: Set by user.
2183 * Number of macroblock rows at the bottom which are skipped.
2184 * - encoding: unused
2185 * - decoding: Set by user.
2191 * - encoding: Set by user.
2192 * - decoding: Set by libavcodec.
2195 #define FF_PROFILE_UNKNOWN -99
2196 #define FF_PROFILE_RESERVED -100
2198 #define FF_PROFILE_AAC_MAIN 0
2199 #define FF_PROFILE_AAC_LOW 1
2200 #define FF_PROFILE_AAC_SSR 2
2201 #define FF_PROFILE_AAC_LTP 3
2203 #define FF_PROFILE_DTS 20
2204 #define FF_PROFILE_DTS_ES 30
2205 #define FF_PROFILE_DTS_96_24 40
2206 #define FF_PROFILE_DTS_HD_HRA 50
2207 #define FF_PROFILE_DTS_HD_MA 60
2209 #define FF_PROFILE_MPEG2_422 0
2210 #define FF_PROFILE_MPEG2_HIGH 1
2211 #define FF_PROFILE_MPEG2_SS 2
2212 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2213 #define FF_PROFILE_MPEG2_MAIN 4
2214 #define FF_PROFILE_MPEG2_SIMPLE 5
2216 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2217 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2219 #define FF_PROFILE_H264_BASELINE 66
2220 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2221 #define FF_PROFILE_H264_MAIN 77
2222 #define FF_PROFILE_H264_EXTENDED 88
2223 #define FF_PROFILE_H264_HIGH 100
2224 #define FF_PROFILE_H264_HIGH_10 110
2225 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2226 #define FF_PROFILE_H264_HIGH_422 122
2227 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2228 #define FF_PROFILE_H264_HIGH_444 144
2229 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2230 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2231 #define FF_PROFILE_H264_CAVLC_444 44
2233 #define FF_PROFILE_VC1_SIMPLE 0
2234 #define FF_PROFILE_VC1_MAIN 1
2235 #define FF_PROFILE_VC1_COMPLEX 2
2236 #define FF_PROFILE_VC1_ADVANCED 3
2240 * - encoding: Set by user.
2241 * - decoding: Set by libavcodec.
2244 #define FF_LEVEL_UNKNOWN -99
2247 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2248 * - encoding: unused
2249 * - decoding: Set by user.
2254 * Bitstream width / height, may be different from width/height if lowres
2255 * or other things are used.
2256 * - encoding: unused
2257 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2259 int coded_width, coded_height;
2262 * frame skip threshold
2263 * - encoding: Set by user.
2264 * - decoding: unused
2266 int frame_skip_threshold;
2270 * - encoding: Set by user.
2271 * - decoding: unused
2273 int frame_skip_factor;
2276 * frame skip exponent
2277 * - encoding: Set by user.
2278 * - decoding: unused
2283 * frame skip comparison function
2284 * - encoding: Set by user.
2285 * - decoding: unused
2290 * Border processing masking, raises the quantizer for mbs on the borders
2292 * - encoding: Set by user.
2293 * - decoding: unused
2295 float border_masking;
2298 * minimum MB lagrange multipler
2299 * - encoding: Set by user.
2300 * - decoding: unused
2305 * maximum MB lagrange multipler
2306 * - encoding: Set by user.
2307 * - decoding: unused
2313 * - encoding: Set by user.
2314 * - decoding: unused
2316 int me_penalty_compensation;
2320 * - encoding: unused
2321 * - decoding: Set by user.
2323 enum AVDiscard skip_loop_filter;
2327 * - encoding: unused
2328 * - decoding: Set by user.
2330 enum AVDiscard skip_idct;
2334 * - encoding: unused
2335 * - decoding: Set by user.
2337 enum AVDiscard skip_frame;
2341 * - encoding: Set by user.
2342 * - decoding: unused
2348 * - encoding: Set by user.
2349 * - decoding: unused
2354 * constant rate factor - quality-based VBR - values ~correspond to qps
2355 * - encoding: Set by user.
2356 * - decoding: unused
2361 * constant quantization parameter rate control method
2362 * - encoding: Set by user.
2363 * - decoding: unused
2369 * - encoding: Set by user.
2370 * - decoding: unused
2375 * number of reference frames
2376 * - encoding: Set by user.
2377 * - decoding: Set by lavc.
2382 * chroma qp offset from luma
2383 * - encoding: Set by user.
2384 * - decoding: unused
2389 * Influences how often B-frames are used.
2390 * - encoding: Set by user.
2391 * - decoding: unused
2396 * trellis RD quantization
2397 * - encoding: Set by user.
2398 * - decoding: unused
2403 * Reduce fluctuations in qp (before curve compression).
2404 * - encoding: Set by user.
2405 * - decoding: unused
2407 float complexityblur;
2410 * in-loop deblocking filter alphac0 parameter
2411 * alpha is in the range -6...6
2412 * - encoding: Set by user.
2413 * - decoding: unused
2418 * in-loop deblocking filter beta parameter
2419 * beta is in the range -6...6
2420 * - encoding: Set by user.
2421 * - decoding: unused
2426 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2427 * - encoding: Set by user.
2428 * - decoding: unused
2431 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2432 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2433 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2434 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2435 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2438 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2439 * - encoding: Set by user.
2440 * - decoding: unused
2445 * Audio cutoff bandwidth (0 means "automatic")
2446 * - encoding: Set by user.
2447 * - decoding: unused
2452 * Multiplied by qscale for each frame and added to scene_change_score.
2453 * - encoding: Set by user.
2454 * - decoding: unused
2456 int scenechange_factor;
2460 * Note: Value depends upon the compare function used for fullpel ME.
2461 * - encoding: Set by user.
2462 * - decoding: unused
2467 * Adjusts sensitivity of b_frame_strategy 1.
2468 * - encoding: Set by user.
2469 * - decoding: unused
2474 * - encoding: Set by user.
2475 * - decoding: unused
2477 int compression_level;
2478 #define FF_COMPRESSION_DEFAULT -1
2481 * - encoding: Set by user.
2482 * - decoding: unused
2484 int min_prediction_order;
2487 * - encoding: Set by user.
2488 * - decoding: unused
2490 int max_prediction_order;
2492 #if FF_API_FLAC_GLOBAL_OPTS
2494 * @name FLAC options
2495 * @deprecated Use FLAC encoder private options instead.
2500 * LPC coefficient precision - used by FLAC encoder
2501 * - encoding: Set by user.
2502 * - decoding: unused
2504 attribute_deprecated int lpc_coeff_precision;
2507 * search method for selecting prediction order
2508 * - encoding: Set by user.
2509 * - decoding: unused
2511 attribute_deprecated int prediction_order_method;
2514 * - encoding: Set by user.
2515 * - decoding: unused
2517 attribute_deprecated int min_partition_order;
2520 * - encoding: Set by user.
2521 * - decoding: unused
2523 attribute_deprecated int max_partition_order;
2530 * GOP timecode frame start number, in non drop frame format
2531 * - encoding: Set by user.
2532 * - decoding: unused
2534 int64_t timecode_frame_start;
2536 #if FF_API_REQUEST_CHANNELS
2538 * Decoder should decode to this many channels if it can (0 for default)
2539 * - encoding: unused
2540 * - decoding: Set by user.
2541 * @deprecated Deprecated in favor of request_channel_layout.
2543 int request_channels;
2547 * Percentage of dynamic range compression to be applied by the decoder.
2548 * The default value is 1.0, corresponding to full compression.
2549 * - encoding: unused
2550 * - decoding: Set by user.
2555 * opaque 64bit number (generally a PTS) that will be reordered and
2556 * output in AVFrame.reordered_opaque
2557 * @deprecated in favor of pkt_pts
2558 * - encoding: unused
2559 * - decoding: Set by user.
2561 int64_t reordered_opaque;
2564 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2565 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2566 * - encoding: set by user.
2567 * - decoding: set by libavcodec.
2569 int bits_per_raw_sample;
2572 * Audio channel layout.
2573 * - encoding: set by user.
2574 * - decoding: set by libavcodec.
2576 int64_t channel_layout;
2579 * Request decoder to use this channel layout if it can (0 for default)
2580 * - encoding: unused
2581 * - decoding: Set by user.
2583 int64_t request_channel_layout;
2586 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2587 * - encoding: Set by user.
2588 * - decoding: unused.
2590 float rc_max_available_vbv_use;
2593 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2594 * - encoding: Set by user.
2595 * - decoding: unused.
2597 float rc_min_vbv_overflow_use;
2600 * Hardware accelerator in use
2601 * - encoding: unused.
2602 * - decoding: Set by libavcodec
2604 struct AVHWAccel *hwaccel;
2607 * For some codecs, the time base is closer to the field rate than the frame rate.
2608 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2609 * if no telecine is used ...
2611 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2613 int ticks_per_frame;
2616 * Hardware accelerator context.
2617 * For some hardware accelerators, a global context needs to be
2618 * provided by the user. In that case, this holds display-dependent
2619 * data Libav cannot instantiate itself. Please refer to the
2620 * Libav HW accelerator documentation to know how to fill this
2621 * is. e.g. for VA API, this is a struct vaapi_context.
2622 * - encoding: unused
2623 * - decoding: Set by user
2625 void *hwaccel_context;
2628 * Chromaticity coordinates of the source primaries.
2629 * - encoding: Set by user
2630 * - decoding: Set by libavcodec
2632 enum AVColorPrimaries color_primaries;
2635 * Color Transfer Characteristic.
2636 * - encoding: Set by user
2637 * - decoding: Set by libavcodec
2639 enum AVColorTransferCharacteristic color_trc;
2642 * YUV colorspace type.
2643 * - encoding: Set by user
2644 * - decoding: Set by libavcodec
2646 enum AVColorSpace colorspace;
2649 * MPEG vs JPEG YUV range.
2650 * - encoding: Set by user
2651 * - decoding: Set by libavcodec
2653 enum AVColorRange color_range;
2656 * This defines the location of chroma samples.
2657 * - encoding: Set by user
2658 * - decoding: Set by libavcodec
2660 enum AVChromaLocation chroma_sample_location;
2663 * The codec may call this to execute several independent things.
2664 * It will return only after finishing all tasks.
2665 * The user may replace this with some multithreaded implementation,
2666 * the default implementation will execute the parts serially.
2667 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2668 * @param c context passed also to func
2669 * @param count the number of things to execute
2670 * @param arg2 argument passed unchanged to func
2671 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2672 * @param func function that will be called count times, with jobnr from 0 to count-1.
2673 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2674 * two instances of func executing at the same time will have the same threadnr.
2675 * @return always 0 currently, but code should handle a future improvement where when any call to func
2676 * returns < 0 no further calls to func may be done and < 0 is returned.
2677 * - encoding: Set by libavcodec, user can override.
2678 * - decoding: Set by libavcodec, user can override.
2680 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2683 * explicit P-frame weighted prediction analysis method
2685 * 1: fast blind weighting (one reference duplicate with -1 offset)
2686 * 2: smart weighting (full fade detection analysis)
2687 * - encoding: Set by user.
2688 * - decoding: unused
2690 int weighted_p_pred;
2695 * 1: Variance AQ (complexity mask)
2696 * 2: Auto-variance AQ (experimental)
2697 * - encoding: Set by user
2698 * - decoding: unused
2704 * Reduces blocking and blurring in flat and textured areas.
2705 * - encoding: Set by user
2706 * - decoding: unused
2712 * Strength of psychovisual optimization
2713 * - encoding: Set by user
2714 * - decoding: unused
2720 * Strength of psychovisual optimization
2721 * - encoding: Set by user
2722 * - decoding: unused
2728 * Number of frames for frametype and ratecontrol lookahead
2729 * - encoding: Set by user
2730 * - decoding: unused
2735 * Constant rate factor maximum
2736 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2737 * than crf_max, even if doing so would violate VBV restrictions.
2738 * - encoding: Set by user.
2739 * - decoding: unused
2743 int log_level_offset;
2745 #if FF_API_FLAC_GLOBAL_OPTS
2747 * Determines which LPC analysis algorithm to use.
2748 * - encoding: Set by user
2749 * - decoding: unused
2751 attribute_deprecated enum AVLPCType lpc_type;
2754 * Number of passes to use for Cholesky factorization during LPC analysis
2755 * - encoding: Set by user
2756 * - decoding: unused
2758 attribute_deprecated int lpc_passes;
2763 * Indicates number of picture subdivisions. Used for parallelized
2765 * - encoding: Set by user
2766 * - decoding: unused
2771 * Header containing style information for text subtitles.
2772 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2773 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2774 * the Format line following. It shouldn't include any Dialogue line.
2775 * - encoding: Set/allocated/freed by user (before avcodec_open())
2776 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2778 uint8_t *subtitle_header;
2779 int subtitle_header_size;
2782 * Current packet as passed into the decoder, to avoid having
2783 * to pass the packet into every function. Currently only valid
2784 * inside lavc and get/release_buffer callbacks.
2785 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2786 * - encoding: unused
2791 * Whether this is a copy of the context which had init() called on it.
2792 * This is used by multithreading - shared tables and picture pointers
2793 * should be freed from the original context only.
2794 * - encoding: Set by libavcodec.
2795 * - decoding: Set by libavcodec.
2800 * Which multithreading methods to use.
2801 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2802 * so clients which cannot provide future frames should not use it.
2804 * - encoding: Set by user, otherwise the default is used.
2805 * - decoding: Set by user, otherwise the default is used.
2808 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2809 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2812 * Which multithreading methods are in use by the codec.
2813 * - encoding: Set by libavcodec.
2814 * - decoding: Set by libavcodec.
2816 int active_thread_type;
2819 * Set by the client if its custom get_buffer() callback can be called
2820 * from another thread, which allows faster multithreaded decoding.
2821 * draw_horiz_band() will be called from other threads regardless of this setting.
2822 * Ignored if the default get_buffer() is used.
2823 * - encoding: Set by user.
2824 * - decoding: Set by user.
2826 int thread_safe_callbacks;
2829 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2830 * Used for compliant TS muxing.
2831 * - encoding: Set by libavcodec.
2832 * - decoding: unused.
2837 * Type of service that the audio stream conveys.
2838 * - encoding: Set by user.
2839 * - decoding: Set by libavcodec.
2841 enum AVAudioServiceType audio_service_type;
2844 * Used to request a sample format from the decoder.
2845 * - encoding: unused.
2846 * - decoding: Set by user.
2848 enum AVSampleFormat request_sample_fmt;
2854 typedef struct AVProfile {
2856 const char *name; ///< short name for the profile
2862 typedef struct AVCodec {
2864 * Name of the codec implementation.
2865 * The name is globally unique among encoders and among decoders (but an
2866 * encoder and a decoder can share the same name).
2867 * This is the primary way to find a codec from the user perspective.
2870 enum AVMediaType type;
2873 int (*init)(AVCodecContext *);
2874 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2875 int (*close)(AVCodecContext *);
2876 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2878 * Codec capabilities.
2882 struct AVCodec *next;
2885 * Will be called when seeking
2887 void (*flush)(AVCodecContext *);
2888 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2889 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2891 * Descriptive name for the codec, meant to be more human readable than name.
2892 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2894 const char *long_name;
2895 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2896 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2897 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2898 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2899 const AVClass *priv_class; ///< AVClass for the private context
2900 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2903 * @name Frame-level threading support functions
2907 * If defined, called on thread contexts when they are created.
2908 * If the codec allocates writable tables in init(), re-allocate them here.
2909 * priv_data will be set to a copy of the original.
2911 int (*init_thread_copy)(AVCodecContext *);
2913 * Copy necessary context variables from a previous thread context to the current one.
2914 * If not defined, the next thread will start automatically; otherwise, the codec
2915 * must call ff_thread_finish_setup().
2917 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2919 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2926 typedef struct AVHWAccel {
2928 * Name of the hardware accelerated codec.
2929 * The name is globally unique among encoders and among decoders (but an
2930 * encoder and a decoder can share the same name).
2935 * Type of codec implemented by the hardware accelerator.
2937 * See AVMEDIA_TYPE_xxx
2939 enum AVMediaType type;
2942 * Codec implemented by the hardware accelerator.
2949 * Supported pixel format.
2951 * Only hardware accelerated formats are supported here.
2953 enum PixelFormat pix_fmt;
2956 * Hardware accelerated codec capabilities.
2957 * see FF_HWACCEL_CODEC_CAP_*
2961 struct AVHWAccel *next;
2964 * Called at the beginning of each frame or field picture.
2966 * Meaningful frame information (codec specific) is guaranteed to
2967 * be parsed at this point. This function is mandatory.
2969 * Note that buf can be NULL along with buf_size set to 0.
2970 * Otherwise, this means the whole frame is available at this point.
2972 * @param avctx the codec context
2973 * @param buf the frame data buffer base
2974 * @param buf_size the size of the frame in bytes
2975 * @return zero if successful, a negative value otherwise
2977 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2980 * Callback for each slice.
2982 * Meaningful slice information (codec specific) is guaranteed to
2983 * be parsed at this point. This function is mandatory.
2985 * @param avctx the codec context
2986 * @param buf the slice data buffer base
2987 * @param buf_size the size of the slice in bytes
2988 * @return zero if successful, a negative value otherwise
2990 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2993 * Called at the end of each frame or field picture.
2995 * The whole picture is parsed at this point and can now be sent
2996 * to the hardware accelerator. This function is mandatory.
2998 * @param avctx the codec context
2999 * @return zero if successful, a negative value otherwise
3001 int (*end_frame)(AVCodecContext *avctx);
3004 * Size of HW accelerator private data.
3006 * Private data is allocated with av_mallocz() before
3007 * AVCodecContext.get_buffer() and deallocated after
3008 * AVCodecContext.release_buffer().
3014 * four components are given, that's all.
3015 * the last component is alpha
3017 typedef struct AVPicture {
3019 int linesize[4]; ///< number of bytes per line
3022 #if FF_API_PALETTE_CONTROL
3025 * This structure defines a method for communicating palette changes
3026 * between and demuxer and a decoder.
3028 * @deprecated Use AVPacket to send palette changes instead.
3029 * This is totally broken.
3031 #define AVPALETTE_SIZE 1024
3032 #define AVPALETTE_COUNT 256
3033 typedef struct AVPaletteControl {
3035 /* Demuxer sets this to 1 to indicate the palette has changed;
3036 * decoder resets to 0. */
3037 int palette_changed;
3039 /* 4-byte ARGB palette entries, stored in native byte order; note that
3040 * the individual palette components should be on a 8-bit scale; if
3041 * the palette data comes from an IBM VGA native format, the component
3042 * data is probably 6 bits in size and needs to be scaled. */
3043 unsigned int palette[AVPALETTE_COUNT];
3045 } AVPaletteControl attribute_deprecated;
3048 enum AVSubtitleType {
3051 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3054 * Plain text, the text field must be set by the decoder and is
3055 * authoritative. ass and pict fields may contain approximations.
3060 * Formatted text, the ass field must be set by the decoder and is
3061 * authoritative. pict and text fields may contain approximations.
3066 typedef struct AVSubtitleRect {
3067 int x; ///< top left corner of pict, undefined when pict is not set
3068 int y; ///< top left corner of pict, undefined when pict is not set
3069 int w; ///< width of pict, undefined when pict is not set
3070 int h; ///< height of pict, undefined when pict is not set
3071 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3074 * data+linesize for the bitmap of this subtitle.
3075 * can be set for text/ass as well once they where rendered
3078 enum AVSubtitleType type;
3080 char *text; ///< 0 terminated plain UTF-8 text
3083 * 0 terminated ASS/SSA compatible event line.
3084 * The pressentation of this is unaffected by the other values in this
3090 typedef struct AVSubtitle {
3091 uint16_t format; /* 0 = graphics */
3092 uint32_t start_display_time; /* relative to packet pts, in ms */
3093 uint32_t end_display_time; /* relative to packet pts, in ms */
3095 AVSubtitleRect **rects;
3096 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3099 /* packet functions */
3102 * @deprecated use NULL instead
3104 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3107 * Default packet destructor.
3109 void av_destruct_packet(AVPacket *pkt);
3112 * Initialize optional fields of a packet with default values.
3116 void av_init_packet(AVPacket *pkt);
3119 * Allocate the payload of a packet and initialize its fields with
3123 * @param size wanted payload size
3124 * @return 0 if OK, AVERROR_xxx otherwise
3126 int av_new_packet(AVPacket *pkt, int size);
3129 * Reduce packet size, correctly zeroing padding
3132 * @param size new size
3134 void av_shrink_packet(AVPacket *pkt, int size);
3137 * Increase packet size, correctly zeroing padding
3140 * @param grow_by number of bytes by which to increase the size of the packet
3142 int av_grow_packet(AVPacket *pkt, int grow_by);
3145 * @warning This is a hack - the packet memory allocation stuff is broken. The
3146 * packet is allocated if it was not really allocated.
3148 int av_dup_packet(AVPacket *pkt);
3153 * @param pkt packet to free
3155 void av_free_packet(AVPacket *pkt);
3158 * Allocate new information of a packet.
3161 * @param type side information type
3162 * @param size side information size
3163 * @return pointer to fresh allocated data or NULL otherwise
3165 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3169 * Get side information from packet.
3172 * @param type desired side information type
3173 * @param size pointer for side information size to store (optional)
3174 * @return pointer to data if present or NULL otherwise
3176 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3181 struct ReSampleContext;
3182 struct AVResampleContext;
3184 typedef struct ReSampleContext ReSampleContext;
3187 * Initialize audio resampling context.
3189 * @param output_channels number of output channels
3190 * @param input_channels number of input channels
3191 * @param output_rate output sample rate
3192 * @param input_rate input sample rate
3193 * @param sample_fmt_out requested output sample format
3194 * @param sample_fmt_in input sample format
3195 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3196 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3197 * @param linear if 1 then the used FIR filter will be linearly interpolated
3198 between the 2 closest, if 0 the closest will be used
3199 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3200 * @return allocated ReSampleContext, NULL if error occured
3202 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3203 int output_rate, int input_rate,
3204 enum AVSampleFormat sample_fmt_out,
3205 enum AVSampleFormat sample_fmt_in,
3206 int filter_length, int log2_phase_count,
3207 int linear, double cutoff);
3209 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3212 * Free resample context.
3214 * @param s a non-NULL pointer to a resample context previously
3215 * created with av_audio_resample_init()
3217 void audio_resample_close(ReSampleContext *s);
3221 * Initialize an audio resampler.
3222 * Note, if either rate is not an integer then simply scale both rates up so they are.
3223 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3224 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3225 * @param linear If 1 then the used FIR filter will be linearly interpolated
3226 between the 2 closest, if 0 the closest will be used
3227 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3229 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3232 * Resample an array of samples using a previously configured context.
3233 * @param src an array of unconsumed samples
3234 * @param consumed the number of samples of src which have been consumed are returned here
3235 * @param src_size the number of unconsumed samples available
3236 * @param dst_size the amount of space in samples available in dst
3237 * @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.
3238 * @return the number of samples written in dst or -1 if an error occurred
3240 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3244 * Compensate samplerate/timestamp drift. The compensation is done by changing
3245 * the resampler parameters, so no audible clicks or similar distortions occur
3246 * @param compensation_distance distance in output samples over which the compensation should be performed
3247 * @param sample_delta number of output samples which should be output less
3249 * example: av_resample_compensate(c, 10, 500)
3250 * here instead of 510 samples only 500 samples would be output
3252 * note, due to rounding the actual compensation might be slightly different,
3253 * especially if the compensation_distance is large and the in_rate used during init is small
3255 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3256 void av_resample_close(struct AVResampleContext *c);
3259 * Allocate memory for a picture. Call avpicture_free() to free it.
3261 * @see avpicture_fill()
3263 * @param picture the picture to be filled in
3264 * @param pix_fmt the format of the picture
3265 * @param width the width of the picture
3266 * @param height the height of the picture
3267 * @return zero if successful, a negative value if not
3269 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3272 * Free a picture previously allocated by avpicture_alloc().
3273 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3276 * @param picture the AVPicture to be freed
3278 void avpicture_free(AVPicture *picture);
3281 * Fill in the AVPicture fields.
3282 * The fields of the given AVPicture are filled in by using the 'ptr' address
3283 * which points to the image data buffer. Depending on the specified picture
3284 * format, one or multiple image data pointers and line sizes will be set.
3285 * If a planar format is specified, several pointers will be set pointing to
3286 * the different picture planes and the line sizes of the different planes
3287 * will be stored in the lines_sizes array.
3288 * Call with ptr == NULL to get the required size for the ptr buffer.
3290 * To allocate the buffer and fill in the AVPicture fields in one call,
3291 * use avpicture_alloc().
3293 * @param picture AVPicture whose fields are to be filled in
3294 * @param ptr Buffer which will contain or contains the actual image data
3295 * @param pix_fmt The format in which the picture data is stored.
3296 * @param width the width of the image in pixels
3297 * @param height the height of the image in pixels
3298 * @return size of the image data in bytes
3300 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3301 enum PixelFormat pix_fmt, int width, int height);
3304 * Copy pixel data from an AVPicture into a buffer.
3305 * The data is stored compactly, without any gaps for alignment or padding
3306 * which may be applied by avpicture_fill().
3308 * @see avpicture_get_size()
3310 * @param[in] src AVPicture containing image data
3311 * @param[in] pix_fmt The format in which the picture data is stored.
3312 * @param[in] width the width of the image in pixels.
3313 * @param[in] height the height of the image in pixels.
3314 * @param[out] dest A buffer into which picture data will be copied.
3315 * @param[in] dest_size The size of 'dest'.
3316 * @return The number of bytes written to dest, or a negative value (error code) on error.
3318 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3319 unsigned char *dest, int dest_size);
3322 * Calculate the size in bytes that a picture of the given width and height
3323 * would occupy if stored in the given picture format.
3324 * Note that this returns the size of a compact representation as generated
3325 * by avpicture_layout(), which can be smaller than the size required for e.g.
3328 * @param pix_fmt the given picture format
3329 * @param width the width of the image
3330 * @param height the height of the image
3331 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3333 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3334 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3336 #if FF_API_GET_PIX_FMT_NAME
3338 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3340 attribute_deprecated
3341 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3344 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3347 * Return a value representing the fourCC code associated to the
3348 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3351 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3354 * Put a string representing the codec tag codec_tag in buf.
3356 * @param buf_size size in bytes of buf
3357 * @return the length of the string that would have been generated if
3358 * enough space had been available, excluding the trailing null
3360 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3362 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3363 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3364 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3365 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3366 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3367 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3370 * Compute what kind of losses will occur when converting from one specific
3371 * pixel format to another.
3372 * When converting from one pixel format to another, information loss may occur.
3373 * For example, when converting from RGB24 to GRAY, the color information will
3374 * be lost. Similarly, other losses occur when converting from some formats to
3375 * other formats. These losses can involve loss of chroma, but also loss of
3376 * resolution, loss of color depth, loss due to the color space conversion, loss
3377 * of the alpha bits or loss due to color quantization.
3378 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3379 * which will occur when converting from one pixel format to another.
3381 * @param[in] dst_pix_fmt destination pixel format
3382 * @param[in] src_pix_fmt source pixel format
3383 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3384 * @return Combination of flags informing you what kind of losses will occur.
3386 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3390 * Find the best pixel format to convert to given a certain source pixel
3391 * format. When converting from one pixel format to another, information loss
3392 * may occur. For example, when converting from RGB24 to GRAY, the color
3393 * information will be lost. Similarly, other losses occur when converting from
3394 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3395 * the given pixel formats should be used to suffer the least amount of loss.
3396 * The pixel formats from which it chooses one, are determined by the
3397 * pix_fmt_mask parameter.
3400 * src_pix_fmt = PIX_FMT_YUV420P;
3401 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3402 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3405 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3406 * @param[in] src_pix_fmt source pixel format
3407 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3408 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3409 * @return The best pixel format to convert to or -1 if none was found.
3411 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3412 int has_alpha, int *loss_ptr);
3414 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3415 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3418 * Tell if an image really has transparent alpha values.
3419 * @return ored mask of FF_ALPHA_xxx constants
3421 int img_get_alpha_info(const AVPicture *src,
3422 enum PixelFormat pix_fmt, int width, int height);
3424 /* deinterlace a picture */
3425 /* deinterlace - if not supported return -1 */
3426 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3427 enum PixelFormat pix_fmt, int width, int height);
3429 /* external high level API */
3432 * If c is NULL, returns the first registered codec,
3433 * if c is non-NULL, returns the next registered codec after c,
3434 * or NULL if c is the last one.
3436 AVCodec *av_codec_next(AVCodec *c);
3439 * Return the LIBAVCODEC_VERSION_INT constant.
3441 unsigned avcodec_version(void);
3444 * Return the libavcodec build-time configuration.
3446 const char *avcodec_configuration(void);
3449 * Return the libavcodec license.
3451 const char *avcodec_license(void);
3454 * Initialize libavcodec.
3455 * If called more than once, does nothing.
3457 * @warning This function must be called before any other libavcodec
3460 * @warning This function is not thread-safe.
3462 void avcodec_init(void);
3465 * Register the codec codec and initialize libavcodec.
3467 * @see avcodec_init(), avcodec_register_all()
3469 void avcodec_register(AVCodec *codec);
3472 * Find a registered encoder with a matching codec ID.
3474 * @param id CodecID of the requested encoder
3475 * @return An encoder if one was found, NULL otherwise.
3477 AVCodec *avcodec_find_encoder(enum CodecID id);
3480 * Find a registered encoder with the specified name.
3482 * @param name name of the requested encoder
3483 * @return An encoder if one was found, NULL otherwise.
3485 AVCodec *avcodec_find_encoder_by_name(const char *name);
3488 * Find a registered decoder with a matching codec ID.
3490 * @param id CodecID of the requested decoder
3491 * @return A decoder if one was found, NULL otherwise.
3493 AVCodec *avcodec_find_decoder(enum CodecID id);
3496 * Find a registered decoder with the specified name.
3498 * @param name name of the requested decoder
3499 * @return A decoder if one was found, NULL otherwise.
3501 AVCodec *avcodec_find_decoder_by_name(const char *name);
3502 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3505 * Return a name for the specified profile, if available.
3507 * @param codec the codec that is searched for the given profile
3508 * @param profile the profile value for which a name is requested
3509 * @return A name for the profile if found, NULL otherwise.
3511 const char *av_get_profile_name(const AVCodec *codec, int profile);
3514 * Set the fields of the given AVCodecContext to default values.
3516 * @param s The AVCodecContext of which the fields should be set to default values.
3518 void avcodec_get_context_defaults(AVCodecContext *s);
3520 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3521 * we WILL change its arguments and name a few times! */
3522 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3524 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3525 * we WILL change its arguments and name a few times! */
3526 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3529 * Allocate an AVCodecContext and set its fields to default values. The
3530 * resulting struct can be deallocated by simply calling av_free().
3532 * @return An AVCodecContext filled with default values or NULL on failure.
3533 * @see avcodec_get_context_defaults
3535 AVCodecContext *avcodec_alloc_context(void);
3537 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3538 * we WILL change its arguments and name a few times! */
3539 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3541 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3542 * we WILL change its arguments and name a few times! */
3543 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3546 * Copy the settings of the source AVCodecContext into the destination
3547 * AVCodecContext. The resulting destination codec context will be
3548 * unopened, i.e. you are required to call avcodec_open() before you
3549 * can use this AVCodecContext to decode/encode video/audio data.
3551 * @param dest target codec context, should be initialized with
3552 * avcodec_alloc_context(), but otherwise uninitialized
3553 * @param src source codec context
3554 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3556 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3559 * Set the fields of the given AVFrame to default values.
3561 * @param pic The AVFrame of which the fields should be set to default values.
3563 void avcodec_get_frame_defaults(AVFrame *pic);
3566 * Allocate an AVFrame and set its fields to default values. The resulting
3567 * struct can be deallocated by simply calling av_free().
3569 * @return An AVFrame filled with default values or NULL on failure.
3570 * @see avcodec_get_frame_defaults
3572 AVFrame *avcodec_alloc_frame(void);
3574 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3575 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3576 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3579 * Return the amount of padding in pixels which the get_buffer callback must
3580 * provide around the edge of the image for codecs which do not have the
3581 * CODEC_FLAG_EMU_EDGE flag.
3583 * @return Required padding in pixels.
3585 unsigned avcodec_get_edge_width(void);
3587 * Modify width and height values so that they will result in a memory
3588 * buffer that is acceptable for the codec if you do not use any horizontal
3591 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3592 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3593 * according to avcodec_get_edge_width() before.
3595 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3597 * Modify width and height values so that they will result in a memory
3598 * buffer that is acceptable for the codec if you also ensure that all
3599 * line sizes are a multiple of the respective linesize_align[i].
3601 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3602 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3603 * according to avcodec_get_edge_width() before.
3605 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3606 int linesize_align[4]);
3608 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3610 #if FF_API_THREAD_INIT
3612 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3614 attribute_deprecated
3615 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3618 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3619 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3620 //FIXME func typedef
3623 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3624 * function the context has to be allocated.
3626 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3627 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3628 * retrieving a codec.
3630 * @warning This function is not thread safe!
3633 * avcodec_register_all();
3634 * codec = avcodec_find_decoder(CODEC_ID_H264);
3638 * context = avcodec_alloc_context();
3640 * if (avcodec_open(context, codec) < 0)
3644 * @param avctx The context which will be set up to use the given codec.
3645 * @param codec The codec to use within the context.
3646 * @return zero on success, a negative value on error
3647 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3649 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3652 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3653 * Some decoders may support multiple frames in a single AVPacket, such
3654 * decoders would then just decode the first frame. In this case,
3655 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3656 * the remaining data in order to decode the second frame etc.
3658 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3659 * decompressed frame size in bytes.
3661 * @warning You must set frame_size_ptr to the allocated size of the
3662 * output buffer before calling avcodec_decode_audio3().
3664 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3665 * the actual read bytes because some optimized bitstream readers read 32 or 64
3666 * bits at once and could read over the end.
3668 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3669 * no overreading happens for damaged MPEG streams.
3671 * @note You might have to align the input buffer avpkt->data and output buffer
3672 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3673 * necessary at all, on others it won't work at all if not aligned and on others
3674 * it will work but it will have an impact on performance.
3676 * In practice, avpkt->data should have 4 byte alignment at minimum and
3677 * samples should be 16 byte aligned unless the CPU doesn't need it
3678 * (AltiVec and SSE do).
3680 * @param avctx the codec context
3681 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3682 * @param[in,out] frame_size_ptr the output buffer size in bytes
3683 * @param[in] avpkt The input AVPacket containing the input buffer.
3684 * You can create such packet with av_init_packet() and by then setting
3685 * data and size, some decoders might in addition need other fields.
3686 * All decoders are designed to use the least fields possible though.
3687 * @return On error a negative value is returned, otherwise the number of bytes
3688 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3690 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3691 int *frame_size_ptr,
3695 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3696 * Some decoders may support multiple frames in a single AVPacket, such
3697 * decoders would then just decode the first frame.
3699 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3700 * the actual read bytes because some optimized bitstream readers read 32 or 64
3701 * bits at once and could read over the end.
3703 * @warning The end of the input buffer buf should be set to 0 to ensure that
3704 * no overreading happens for damaged MPEG streams.
3706 * @note You might have to align the input buffer avpkt->data.
3707 * The alignment requirements depend on the CPU: on some CPUs it isn't
3708 * necessary at all, on others it won't work at all if not aligned and on others
3709 * it will work but it will have an impact on performance.
3711 * In practice, avpkt->data should have 4 byte alignment at minimum.
3713 * @note Some codecs have a delay between input and output, these need to be
3714 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3716 * @param avctx the codec context
3717 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3718 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3719 * allocate memory for the actual bitmap.
3720 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3721 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3722 * decodes and the decoder tells the user once it does not need the data anymore,
3723 * the user app can at this point free/reuse/keep the memory as it sees fit.
3725 * @param[in] avpkt The input AVpacket containing the input buffer.
3726 * You can create such packet with av_init_packet() and by then setting
3727 * data and size, some decoders might in addition need other fields like
3728 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3730 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3731 * @return On error a negative value is returned, otherwise the number of bytes
3732 * used or zero if no frame could be decompressed.
3734 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3735 int *got_picture_ptr,
3739 * Decode a subtitle message.
3740 * Return a negative value on error, otherwise return the number of bytes used.
3741 * If no subtitle could be decompressed, got_sub_ptr is zero.
3742 * Otherwise, the subtitle is stored in *sub.
3743 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3744 * simplicity, because the performance difference is expect to be negligible
3745 * and reusing a get_buffer written for video codecs would probably perform badly
3746 * due to a potentially very different allocation pattern.
3748 * @param avctx the codec context
3749 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3750 freed with avsubtitle_free if *got_sub_ptr is set.
3751 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3752 * @param[in] avpkt The input AVPacket containing the input buffer.
3754 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3759 * Frees all allocated data in the given subtitle struct.
3761 * @param sub AVSubtitle to free.
3763 void avsubtitle_free(AVSubtitle *sub);
3765 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3767 uint8_t *buf, int buf_size);
3770 * Encode an audio frame from samples into buf.
3772 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3773 * However, for PCM audio the user will know how much space is needed
3774 * because it depends on the value passed in buf_size as described
3775 * below. In that case a lower value can be used.
3777 * @param avctx the codec context
3778 * @param[out] buf the output buffer
3779 * @param[in] buf_size the output buffer size
3780 * @param[in] samples the input buffer containing the samples
3781 * The number of samples read from this buffer is frame_size*channels,
3782 * both of which are defined in avctx.
3783 * For PCM audio the number of samples read from samples is equal to
3784 * buf_size * input_sample_size / output_sample_size.
3785 * @return On error a negative value is returned, on success zero or the number
3786 * of bytes used to encode the data read from the input buffer.
3788 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3789 const short *samples);
3792 * Encode a video frame from pict into buf.
3793 * The input picture should be
3794 * stored using a specific format, namely avctx.pix_fmt.
3796 * @param avctx the codec context
3797 * @param[out] buf the output buffer for the bitstream of encoded frame
3798 * @param[in] buf_size the size of the output buffer in bytes
3799 * @param[in] pict the input picture to encode
3800 * @return On error a negative value is returned, on success zero or the number
3801 * of bytes used from the output buffer.
3803 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3804 const AVFrame *pict);
3805 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3806 const AVSubtitle *sub);
3808 int avcodec_close(AVCodecContext *avctx);
3811 * Register all the codecs, parsers and bitstream filters which were enabled at
3812 * configuration time. If you do not call this function you can select exactly
3813 * which formats you want to support, by using the individual registration
3816 * @see avcodec_register
3817 * @see av_register_codec_parser
3818 * @see av_register_bitstream_filter
3820 void avcodec_register_all(void);
3823 * Flush buffers, should be called when seeking or when switching to a different stream.
3825 void avcodec_flush_buffers(AVCodecContext *avctx);
3827 void avcodec_default_free_buffers(AVCodecContext *s);
3829 /* misc useful functions */
3831 #if FF_API_OLD_FF_PICT_TYPES
3833 * Return a single letter to describe the given picture type pict_type.
3835 * @param[in] pict_type the picture type
3836 * @return A single character representing the picture type.
3837 * @deprecated Use av_get_picture_type_char() instead.
3839 attribute_deprecated
3840 char av_get_pict_type_char(int pict_type);
3844 * Return codec bits per sample.
3846 * @param[in] codec_id the codec
3847 * @return Number of bits per sample or zero if unknown for the given codec.
3849 int av_get_bits_per_sample(enum CodecID codec_id);
3851 #if FF_API_OLD_SAMPLE_FMT
3853 * @deprecated Use av_get_bytes_per_sample() instead.
3855 attribute_deprecated
3856 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3860 typedef struct AVCodecParserContext {
3862 struct AVCodecParser *parser;
3863 int64_t frame_offset; /* offset of the current frame */
3864 int64_t cur_offset; /* current offset
3865 (incremented by each av_parser_parse()) */
3866 int64_t next_frame_offset; /* offset of the next frame */
3868 int pict_type; /* XXX: Put it back in AVCodecContext. */
3870 * This field is used for proper frame duration computation in lavf.
3871 * It signals, how much longer the frame duration of the current frame
3872 * is compared to normal frame duration.
3874 * frame_duration = (1 + repeat_pict) * time_base
3876 * It is used by codecs like H.264 to display telecined material.
3878 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3879 int64_t pts; /* pts of the current frame */
3880 int64_t dts; /* dts of the current frame */
3885 int fetch_timestamp;
3887 #define AV_PARSER_PTS_NB 4
3888 int cur_frame_start_index;
3889 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3890 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3891 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3894 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3895 #define PARSER_FLAG_ONCE 0x0002
3896 /// Set if the parser has a valid file offset
3897 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3899 int64_t offset; ///< byte offset from starting packet start
3900 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3903 * Set by parser to 1 for key frames and 0 for non-key frames.
3904 * It is initialized to -1, so if the parser doesn't set this flag,
3905 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3911 * Time difference in stream time base units from the pts of this
3912 * packet to the point at which the output from the decoder has converged
3913 * independent from the availability of previous frames. That is, the
3914 * frames are virtually identical no matter if decoding started from
3915 * the very first frame or from this keyframe.
3916 * Is AV_NOPTS_VALUE if unknown.
3917 * This field is not the display duration of the current frame.
3918 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3921 * The purpose of this field is to allow seeking in streams that have no
3922 * keyframes in the conventional sense. It corresponds to the
3923 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3924 * essential for some types of subtitle streams to ensure that all
3925 * subtitles are correctly displayed after seeking.
3927 int64_t convergence_duration;
3929 // Timestamp generation support:
3931 * Synchronization point for start of timestamp generation.
3933 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3936 * For example, this corresponds to presence of H.264 buffering period
3942 * Offset of the current timestamp against last timestamp sync point in
3943 * units of AVCodecContext.time_base.
3945 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3946 * contain a valid timestamp offset.
3948 * Note that the timestamp of sync point has usually a nonzero
3949 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3950 * the next frame after timestamp sync point will be usually 1.
3952 * For example, this corresponds to H.264 cpb_removal_delay.
3954 int dts_ref_dts_delta;
3957 * Presentation delay of current frame in units of AVCodecContext.time_base.
3959 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3960 * contain valid non-negative timestamp delta (presentation time of a frame
3961 * must not lie in the past).
3963 * This delay represents the difference between decoding and presentation
3964 * time of the frame.
3966 * For example, this corresponds to H.264 dpb_output_delay.
3971 * Position of the packet in file.
3973 * Analogous to cur_frame_pts/dts
3975 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3978 * Byte position of currently parsed frame in stream.
3983 * Previous frame byte position.
3986 } AVCodecParserContext;
3988 typedef struct AVCodecParser {
3989 int codec_ids[5]; /* several codec IDs are permitted */
3991 int (*parser_init)(AVCodecParserContext *s);
3992 int (*parser_parse)(AVCodecParserContext *s,
3993 AVCodecContext *avctx,
3994 const uint8_t **poutbuf, int *poutbuf_size,
3995 const uint8_t *buf, int buf_size);
3996 void (*parser_close)(AVCodecParserContext *s);
3997 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3998 struct AVCodecParser *next;
4001 AVCodecParser *av_parser_next(AVCodecParser *c);
4003 void av_register_codec_parser(AVCodecParser *parser);
4004 AVCodecParserContext *av_parser_init(int codec_id);
4009 * @param s parser context.
4010 * @param avctx codec context.
4011 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4012 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4013 * @param buf input buffer.
4014 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4015 * @param pts input presentation timestamp.
4016 * @param dts input decoding timestamp.
4017 * @param pos input byte position in stream.
4018 * @return the number of bytes of the input bitstream used.
4023 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4030 * decode_frame(data, size);
4034 int av_parser_parse2(AVCodecParserContext *s,
4035 AVCodecContext *avctx,
4036 uint8_t **poutbuf, int *poutbuf_size,
4037 const uint8_t *buf, int buf_size,
4038 int64_t pts, int64_t dts,
4041 int av_parser_change(AVCodecParserContext *s,
4042 AVCodecContext *avctx,
4043 uint8_t **poutbuf, int *poutbuf_size,
4044 const uint8_t *buf, int buf_size, int keyframe);
4045 void av_parser_close(AVCodecParserContext *s);
4048 typedef struct AVBitStreamFilterContext {
4050 struct AVBitStreamFilter *filter;
4051 AVCodecParserContext *parser;
4052 struct AVBitStreamFilterContext *next;
4053 } AVBitStreamFilterContext;
4056 typedef struct AVBitStreamFilter {
4059 int (*filter)(AVBitStreamFilterContext *bsfc,
4060 AVCodecContext *avctx, const char *args,
4061 uint8_t **poutbuf, int *poutbuf_size,
4062 const uint8_t *buf, int buf_size, int keyframe);
4063 void (*close)(AVBitStreamFilterContext *bsfc);
4064 struct AVBitStreamFilter *next;
4065 } AVBitStreamFilter;
4067 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4068 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4069 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4070 AVCodecContext *avctx, const char *args,
4071 uint8_t **poutbuf, int *poutbuf_size,
4072 const uint8_t *buf, int buf_size, int keyframe);
4073 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4075 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4080 * Reallocate the given block if it is not large enough, otherwise do nothing.
4084 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4087 * Allocate a buffer, reusing the given one if large enough.
4089 * Contrary to av_fast_realloc the current buffer contents might not be
4090 * preserved and on error the old buffer is freed, thus no special
4091 * handling to avoid memleaks is necessary.
4093 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4094 * @param size size of the buffer *ptr points to
4095 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4096 * *size 0 if an error occurred.
4098 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4101 * Copy image src to dst. Wraps av_picture_data_copy() above.
4103 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4104 enum PixelFormat pix_fmt, int width, int height);
4107 * Crop image top and left side.
4109 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4110 enum PixelFormat pix_fmt, int top_band, int left_band);
4115 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4116 int padtop, int padbottom, int padleft, int padright, int *color);
4119 * Encode extradata length to a buffer. Used by xiph codecs.
4121 * @param s buffer to write to; must be at least (v/255+1) bytes long
4122 * @param v size of extradata in bytes
4123 * @return number of bytes written to the buffer.
4125 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4128 * Logs a generic warning message about a missing feature. This function is
4129 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4130 * only, and would normally not be used by applications.
4131 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4132 * a pointer to an AVClass struct
4133 * @param[in] feature string containing the name of the missing feature
4134 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4135 * If want_sample is non-zero, additional verbage will be added to the log
4136 * message which tells the user how to report samples to the development
4139 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4142 * Log a generic warning message asking for a sample. This function is
4143 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4144 * only, and would normally not be used by applications.
4145 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4146 * a pointer to an AVClass struct
4147 * @param[in] msg string containing an optional message, or NULL if no message
4149 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4152 * Register the hardware accelerator hwaccel.
4154 void av_register_hwaccel(AVHWAccel *hwaccel);
4157 * If hwaccel is NULL, returns the first registered hardware accelerator,
4158 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4159 * after hwaccel, or NULL if hwaccel is the last one.
4161 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4165 * Lock operation used by lockmgr
4168 AV_LOCK_CREATE, ///< Create a mutex
4169 AV_LOCK_OBTAIN, ///< Lock the mutex
4170 AV_LOCK_RELEASE, ///< Unlock the mutex
4171 AV_LOCK_DESTROY, ///< Free mutex resources
4175 * Register a user provided lock manager supporting the operations
4176 * specified by AVLockOp. mutex points to a (void *) where the
4177 * lockmgr should store/get a pointer to a user allocated mutex. It's
4178 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4180 * @param cb User defined callback. Note: Libav may invoke calls to this
4181 * callback during the call to av_lockmgr_register().
4182 * Thus, the application must be prepared to handle that.
4183 * If cb is set to NULL the lockmgr will be unregistered.
4184 * Also note that during unregistration the previously registered
4185 * lockmgr callback may also be invoked.
4187 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4189 #endif /* AVCODEC_AVCODEC_H */