2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of Libav.
6 * Libav is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * Libav is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with Libav; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
33 #include "libavutil/dict.h"
34 #include "libavutil/log.h"
35 #include "libavutil/pixfmt.h"
36 #include "libavutil/rational.h"
38 #include "libavcodec/version.h"
41 * Identify the syntax and semantics of the bitstream.
42 * The principle is roughly:
43 * Two decoders with the same ID can decode the same streams.
44 * Two encoders with the same ID can encode compatible streams.
45 * There may be slight deviations from the principle due to implementation
48 * If you add a codec ID to this list, add it so that
49 * 1. no value of a existing codec ID changes (that would break ABI),
50 * 2. it is as close as possible to similar codecs.
57 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
58 CODEC_ID_MPEG2VIDEO_XVMC,
95 CODEC_ID_INTERPLAY_VIDEO,
107 CODEC_ID_TRUEMOTION1,
134 CODEC_ID_TRUEMOTION2,
151 CODEC_ID_DSICINVIDEO,
152 CODEC_ID_TIERTEXSEQVIDEO,
161 CODEC_ID_BETHSOFTVID,
179 CODEC_ID_MOTIONPIXELS,
197 CODEC_ID_IFF_BYTERUN1,
212 /* various PCM "codecs" */
213 CODEC_ID_PCM_S16LE= 0x10000,
229 CODEC_ID_PCM_S24DAUD,
231 CODEC_ID_PCM_S16LE_PLANAR,
241 /* various ADPCM codecs */
242 CODEC_ID_ADPCM_IMA_QT= 0x11000,
243 CODEC_ID_ADPCM_IMA_WAV,
244 CODEC_ID_ADPCM_IMA_DK3,
245 CODEC_ID_ADPCM_IMA_DK4,
246 CODEC_ID_ADPCM_IMA_WS,
247 CODEC_ID_ADPCM_IMA_SMJPEG,
256 CODEC_ID_ADPCM_YAMAHA,
257 CODEC_ID_ADPCM_SBPRO_4,
258 CODEC_ID_ADPCM_SBPRO_3,
259 CODEC_ID_ADPCM_SBPRO_2,
261 CODEC_ID_ADPCM_IMA_AMV,
262 CODEC_ID_ADPCM_EA_R1,
263 CODEC_ID_ADPCM_EA_R3,
264 CODEC_ID_ADPCM_EA_R2,
265 CODEC_ID_ADPCM_IMA_EA_SEAD,
266 CODEC_ID_ADPCM_IMA_EA_EACS,
267 CODEC_ID_ADPCM_EA_XAS,
268 CODEC_ID_ADPCM_EA_MAXIS_XA,
269 CODEC_ID_ADPCM_IMA_ISS,
273 CODEC_ID_AMR_NB= 0x12000,
276 /* RealAudio codecs*/
277 CODEC_ID_RA_144= 0x13000,
280 /* various DPCM codecs */
281 CODEC_ID_ROQ_DPCM= 0x14000,
282 CODEC_ID_INTERPLAY_DPCM,
287 CODEC_ID_MP2= 0x15000,
288 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
306 CODEC_ID_WESTWOOD_SND1,
307 CODEC_ID_GSM, ///< as in Berlin toast format
315 CODEC_ID_DSICINAUDIO,
319 CODEC_ID_GSM_MS, /* as found in WAV */
328 CODEC_ID_WMALOSSLESS,
337 CODEC_ID_BINKAUDIO_RDFT,
338 CODEC_ID_BINKAUDIO_DCT,
342 /* subtitle codecs */
343 CODEC_ID_DVD_SUBTITLE= 0x17000,
344 CODEC_ID_DVB_SUBTITLE,
345 CODEC_ID_TEXT, ///< raw UTF-8 text
349 CODEC_ID_HDMV_PGS_SUBTITLE,
350 CODEC_ID_DVB_TELETEXT,
353 /* other specific kind of codecs (generally used for attachments) */
354 CODEC_ID_TTF= 0x18000,
356 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
358 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
359 * stream (only used by libavformat) */
360 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
363 #if FF_API_OLD_SAMPLE_FMT
364 #define SampleFormat AVSampleFormat
366 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
367 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
368 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
369 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
370 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
371 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
372 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
375 #if FF_API_OLD_AUDIOCONVERT
376 #include "libavutil/audioconvert.h"
378 /* Audio channel masks */
379 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
380 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
381 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
382 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
383 #define CH_BACK_LEFT AV_CH_BACK_LEFT
384 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
385 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
386 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
387 #define CH_BACK_CENTER AV_CH_BACK_CENTER
388 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
389 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
390 #define CH_TOP_CENTER AV_CH_TOP_CENTER
391 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
392 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
393 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
394 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
395 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
396 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
397 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
398 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
400 /** Channel mask value used for AVCodecContext.request_channel_layout
401 to indicate that the user requests the channel order of the decoder output
402 to be the native codec channel order. */
403 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
405 /* Audio channel convenience macros */
406 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
407 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
408 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
409 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
410 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
411 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
412 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
413 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
414 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
415 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
416 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
417 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
418 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
419 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
420 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
424 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
427 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
428 * This is mainly needed because some optimized bitstream readers read
429 * 32 or 64 bit at once and could read over the end.<br>
430 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
431 * MPEG bitstreams could cause overread and segfault.
433 #define FF_INPUT_BUFFER_PADDING_SIZE 8
436 * minimum encoding buffer size
437 * Used to avoid some checks during header writing.
439 #define FF_MIN_BUFFER_SIZE 16384
443 * motion estimation type.
446 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
450 ME_EPZS, ///< enhanced predictive zonal search
451 ME_X1, ///< reserved for experiments
452 ME_HEX, ///< hexagon based search
453 ME_UMH, ///< uneven multi-hexagon search
454 ME_ITER, ///< iterative search
455 ME_TESA, ///< transformed exhaustive search algorithm
459 /* We leave some space between them for extensions (drop some
460 * keyframes for intra-only or drop just some bidir frames). */
461 AVDISCARD_NONE =-16, ///< discard nothing
462 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
463 AVDISCARD_NONREF = 8, ///< discard all non reference
464 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
465 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
466 AVDISCARD_ALL = 48, ///< discard all
469 enum AVColorPrimaries{
470 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
471 AVCOL_PRI_UNSPECIFIED=2,
473 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
474 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
475 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
477 AVCOL_PRI_NB , ///< Not part of ABI
480 enum AVColorTransferCharacteristic{
481 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
482 AVCOL_TRC_UNSPECIFIED=2,
483 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
484 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
485 AVCOL_TRC_NB , ///< Not part of ABI
490 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
491 AVCOL_SPC_UNSPECIFIED=2,
493 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
494 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
495 AVCOL_SPC_SMPTE240M =7,
496 AVCOL_SPC_NB , ///< Not part of ABI
500 AVCOL_RANGE_UNSPECIFIED=0,
501 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
502 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
503 AVCOL_RANGE_NB , ///< Not part of ABI
507 * X X 3 4 X X are luma samples,
508 * 1 2 1-6 are possible chroma positions
509 * X X 5 6 X 0 is undefined/unknown position
511 enum AVChromaLocation{
512 AVCHROMA_LOC_UNSPECIFIED=0,
513 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
514 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
515 AVCHROMA_LOC_TOPLEFT =3, ///< DV
517 AVCHROMA_LOC_BOTTOMLEFT =5,
518 AVCHROMA_LOC_BOTTOM =6,
519 AVCHROMA_LOC_NB , ///< Not part of ABI
522 #if FF_API_FLAC_GLOBAL_OPTS
526 attribute_deprecated enum AVLPCType {
527 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
528 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
529 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
530 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
531 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
532 AV_LPC_TYPE_NB , ///< Not part of ABI
536 enum AVAudioServiceType {
537 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
538 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
539 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
540 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
541 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
542 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
543 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
544 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
545 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
546 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
549 typedef struct RcOverride{
552 int qscale; // If this is 0 then quality_factor will be used instead.
553 float quality_factor;
556 #define FF_MAX_B_FRAMES 16
559 These flags can be passed in AVCodecContext.flags before initialization.
560 Note: Not everything is supported yet.
563 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
564 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
565 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
566 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
567 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
568 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
570 * The parent program guarantees that the input for B-frames containing
571 * streams is not written to for at least s->max_b_frames+1 frames, if
572 * this is not set the input will be copied.
574 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
575 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
576 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
577 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
578 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
579 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
580 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
581 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
582 location instead of only at frame boundaries. */
583 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
584 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
585 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
586 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
587 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
588 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
589 /* Fx : Flag for h263+ extra options */
590 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
591 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
592 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
593 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
594 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
595 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
596 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
597 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
598 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
599 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
600 #define CODEC_FLAG_CLOSED_GOP 0x80000000
601 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
602 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
603 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
604 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
605 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
606 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
607 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
608 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
609 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
610 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
611 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
612 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
613 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
614 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
615 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
616 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
617 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
618 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
619 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
620 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
621 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
622 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
624 /* Unsupported options :
625 * Syntax Arithmetic coding (SAC)
626 * Reference Picture Selection
627 * Independent Segment Decoding */
629 /* codec capabilities */
631 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
633 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
634 * If not set, it might not use get_buffer() at all or use operations that
635 * assume the buffer was allocated by avcodec_default_get_buffer.
637 #define CODEC_CAP_DR1 0x0002
638 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
639 #define CODEC_CAP_PARSE_ONLY 0x0004
640 #define CODEC_CAP_TRUNCATED 0x0008
641 /* Codec can export data for HW decoding (XvMC). */
642 #define CODEC_CAP_HWACCEL 0x0010
644 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
645 * If this is not set, the codec is guaranteed to never be fed with NULL data.
647 #define CODEC_CAP_DELAY 0x0020
649 * Codec can be fed a final frame with a smaller size.
650 * This can be used to prevent truncation of the last audio samples.
652 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
654 * Codec can export data for HW decoding (VDPAU).
656 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
658 * Codec can output multiple frames per AVPacket
659 * Normally demuxers return one frame at a time, demuxers which do not do
660 * are connected to a parser to split what they return into proper frames.
661 * This flag is reserved to the very rare category of codecs which have a
662 * bitstream that cannot be split into frames without timeconsuming
663 * operations like full decoding. Demuxers carring such bitstreams thus
664 * may return multiple frames in a packet. This has many disadvantages like
665 * prohibiting stream copy in many cases thus it should only be considered
668 #define CODEC_CAP_SUBFRAMES 0x0100
670 * Codec is experimental and is thus avoided in favor of non experimental
673 #define CODEC_CAP_EXPERIMENTAL 0x0200
675 * Codec should fill in channel configuration and samplerate instead of container
677 #define CODEC_CAP_CHANNEL_CONF 0x0400
679 * Codec is able to deal with negative linesizes
681 #define CODEC_CAP_NEG_LINESIZES 0x0800
683 * Codec supports frame-level multithreading.
685 #define CODEC_CAP_FRAME_THREADS 0x1000
687 * Codec supports slice-based (or partition-based) multithreading.
689 #define CODEC_CAP_SLICE_THREADS 0x2000
691 //The following defines may change, don't expect compatibility if you use them.
692 #define MB_TYPE_INTRA4x4 0x0001
693 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
694 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
695 #define MB_TYPE_16x16 0x0008
696 #define MB_TYPE_16x8 0x0010
697 #define MB_TYPE_8x16 0x0020
698 #define MB_TYPE_8x8 0x0040
699 #define MB_TYPE_INTERLACED 0x0080
700 #define MB_TYPE_DIRECT2 0x0100 //FIXME
701 #define MB_TYPE_ACPRED 0x0200
702 #define MB_TYPE_GMC 0x0400
703 #define MB_TYPE_SKIP 0x0800
704 #define MB_TYPE_P0L0 0x1000
705 #define MB_TYPE_P1L0 0x2000
706 #define MB_TYPE_P0L1 0x4000
707 #define MB_TYPE_P1L1 0x8000
708 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
709 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
710 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
711 #define MB_TYPE_QUANT 0x00010000
712 #define MB_TYPE_CBP 0x00020000
713 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
717 * This specifies the area which should be displayed.
718 * Note there may be multiple such areas for one frame.
720 typedef struct AVPanScan{
723 * - encoding: Set by user.
724 * - decoding: Set by libavcodec.
729 * width and height in 1/16 pel
730 * - encoding: Set by user.
731 * - decoding: Set by libavcodec.
737 * position of the top left corner in 1/16 pel for up to 3 fields/frames
738 * - encoding: Set by user.
739 * - decoding: Set by libavcodec.
741 int16_t position[3][2];
744 #define FF_COMMON_FRAME \
746 * pointer to the picture planes.\
747 * This might be different from the first allocated byte\
754 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
755 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
761 * 1 -> keyframe, 0-> not\
762 * - encoding: Set by libavcodec.\
763 * - decoding: Set by libavcodec.\
768 * Picture type of the frame, see ?_TYPE below.\
769 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
770 * - decoding: Set by libavcodec.\
772 enum AVPictureType pict_type;\
775 * presentation timestamp in time_base units (time when frame should be shown to user)\
776 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
777 * - encoding: MUST be set by user.\
778 * - decoding: Set by libavcodec.\
783 * picture number in bitstream order\
784 * - encoding: set by\
785 * - decoding: Set by libavcodec.\
787 int coded_picture_number;\
789 * picture number in display order\
790 * - encoding: set by\
791 * - decoding: Set by libavcodec.\
793 int display_picture_number;\
796 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
797 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
798 * - decoding: Set by libavcodec.\
803 * buffer age (1->was last buffer and dint change, 2->..., ...).\
804 * Set to INT_MAX if the buffer has not been used yet.\
805 * - encoding: unused\
806 * - decoding: MUST be set by get_buffer().\
811 * is this picture used as reference\
812 * The values for this are the same as the MpegEncContext.picture_structure\
813 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
814 * Set to 4 for delayed, non-reference frames.\
815 * - encoding: unused\
816 * - decoding: Set by libavcodec. (before get_buffer() call)).\
822 * - encoding: unused\
823 * - decoding: Set by libavcodec.\
825 int8_t *qscale_table;\
828 * - encoding: unused\
829 * - decoding: Set by libavcodec.\
834 * mbskip_table[mb]>=1 if MB didn't change\
835 * stride= mb_width = (width+15)>>4\
836 * - encoding: unused\
837 * - decoding: Set by libavcodec.\
839 uint8_t *mbskip_table;\
842 * motion vector table\
845 * int mv_sample_log2= 4 - motion_subsample_log2;\
846 * int mb_width= (width+15)>>4;\
847 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
848 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
850 * - encoding: Set by user.\
851 * - decoding: Set by libavcodec.\
853 int16_t (*motion_val[2])[2];\
856 * macroblock type table\
857 * mb_type_base + mb_width + 2\
858 * - encoding: Set by user.\
859 * - decoding: Set by libavcodec.\
864 * log2 of the size of the block which a single vector in motion_val represents: \
865 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
866 * - encoding: unused\
867 * - decoding: Set by libavcodec.\
869 uint8_t motion_subsample_log2;\
872 * for some private data of the user\
873 * - encoding: unused\
874 * - decoding: Set by user.\
880 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
881 * - decoding: unused\
886 * type of the buffer (to keep track of who has to deallocate data[*])\
887 * - encoding: Set by the one who allocates it.\
888 * - decoding: Set by the one who allocates it.\
889 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
894 * When decoding, this signals how much the picture must be delayed.\
895 * extra_delay = repeat_pict / (2*fps)\
896 * - encoding: unused\
897 * - decoding: Set by libavcodec.\
907 * The content of the picture is interlaced.\
908 * - encoding: Set by user.\
909 * - decoding: Set by libavcodec. (default 0)\
911 int interlaced_frame;\
914 * If the content is interlaced, is top field displayed first.\
915 * - encoding: Set by user.\
916 * - decoding: Set by libavcodec.\
918 int top_field_first;\
922 * - encoding: Set by user.\
923 * - decoding: Set by libavcodec.\
925 AVPanScan *pan_scan;\
928 * Tell user application that palette has changed from previous frame.\
929 * - encoding: ??? (no palette-enabled encoder yet)\
930 * - decoding: Set by libavcodec. (default 0).\
932 int palette_has_changed;\
935 * codec suggestion on buffer type if != 0\
936 * - encoding: unused\
937 * - decoding: Set by libavcodec. (before get_buffer() call)).\
943 * - encoding: unused\
944 * - decoding: Set by libavcodec.\
949 * motion reference frame index\
950 * the order in which these are stored can depend on the codec.\
951 * - encoding: Set by user.\
952 * - decoding: Set by libavcodec.\
954 int8_t *ref_index[2];\
957 * reordered opaque 64bit (generally an integer or a double precision float\
958 * PTS but can be anything). \
959 * The user sets AVCodecContext.reordered_opaque to represent the input at\
961 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
962 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
963 * @deprecated in favor of pkt_pts\
964 * - encoding: unused\
965 * - decoding: Read by user.\
967 int64_t reordered_opaque;\
970 * hardware accelerator private data (Libav-allocated)\
971 * - encoding: unused\
972 * - decoding: Set by libavcodec\
974 void *hwaccel_picture_private;\
977 * reordered pts from the last AVPacket that has been input into the decoder\
978 * - encoding: unused\
979 * - decoding: Read by user.\
984 * dts from the last AVPacket that has been input into the decoder\
985 * - encoding: unused\
986 * - decoding: Read by user.\
991 * the AVCodecContext which ff_thread_get_buffer() was last called on\
992 * - encoding: Set by libavcodec.\
993 * - decoding: Set by libavcodec.\
995 struct AVCodecContext *owner;\
998 * used by multithreading to store frame-specific info\
999 * - encoding: Set by libavcodec.\
1000 * - decoding: Set by libavcodec.\
1002 void *thread_opaque;\
1004 #define FF_QSCALE_TYPE_MPEG1 0
1005 #define FF_QSCALE_TYPE_MPEG2 1
1006 #define FF_QSCALE_TYPE_H264 2
1007 #define FF_QSCALE_TYPE_VP56 3
1009 #define FF_BUFFER_TYPE_INTERNAL 1
1010 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1011 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1012 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1014 #if FF_API_OLD_FF_PICT_TYPES
1015 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
1016 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
1017 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
1018 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
1019 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
1020 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
1021 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
1022 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
1025 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1026 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1027 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1028 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1030 enum AVPacketSideDataType {
1031 AV_PKT_DATA_PALETTE,
1034 typedef struct AVPacket {
1036 * Presentation timestamp in AVStream->time_base units; the time at which
1037 * the decompressed packet will be presented to the user.
1038 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1039 * pts MUST be larger or equal to dts as presentation cannot happen before
1040 * decompression, unless one wants to view hex dumps. Some formats misuse
1041 * the terms dts and pts/cts to mean something different. Such timestamps
1042 * must be converted to true pts/dts before they are stored in AVPacket.
1046 * Decompression timestamp in AVStream->time_base units; the time at which
1047 * the packet is decompressed.
1048 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1056 * Additional packet data that can be provided by the container.
1057 * Packet can contain several types of side information.
1062 enum AVPacketSideDataType type;
1064 int side_data_elems;
1067 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1068 * Equals next_pts - this_pts in presentation order.
1071 void (*destruct)(struct AVPacket *);
1073 int64_t pos; ///< byte position in stream, -1 if unknown
1076 * Time difference in AVStream->time_base units from the pts of this
1077 * packet to the point at which the output from the decoder has converged
1078 * independent from the availability of previous frames. That is, the
1079 * frames are virtually identical no matter if decoding started from
1080 * the very first frame or from this keyframe.
1081 * Is AV_NOPTS_VALUE if unknown.
1082 * This field is not the display duration of the current packet.
1083 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1086 * The purpose of this field is to allow seeking in streams that have no
1087 * keyframes in the conventional sense. It corresponds to the
1088 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1089 * essential for some types of subtitle streams to ensure that all
1090 * subtitles are correctly displayed after seeking.
1092 int64_t convergence_duration;
1094 #define AV_PKT_FLAG_KEY 0x0001
1097 * Audio Video Frame.
1098 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1100 * Removal, reordering and changes to existing fields require a major
1101 * version bump. No fields should be added into AVFrame before or after
1103 * sizeof(AVFrame) must not be used outside libav*.
1105 typedef struct AVFrame {
1110 * main external API structure.
1111 * New fields can be added to the end with minor version bumps.
1112 * Removal, reordering and changes to existing fields require a major
1114 * sizeof(AVCodecContext) must not be used outside libav*.
1116 typedef struct AVCodecContext {
1118 * information on struct for av_log
1119 * - set by avcodec_alloc_context
1121 const AVClass *av_class;
1123 * the average bitrate
1124 * - encoding: Set by user; unused for constant quantizer encoding.
1125 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1130 * number of bits the bitstream is allowed to diverge from the reference.
1131 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1132 * - encoding: Set by user; unused for constant quantizer encoding.
1133 * - decoding: unused
1135 int bit_rate_tolerance;
1139 * - encoding: Set by user.
1140 * - decoding: Set by user.
1145 * Some codecs need additional format info. It is stored here.
1146 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1147 * specific codec MUST set it correctly otherwise stream copy breaks.
1148 * In general use of this field by muxers is not recommanded.
1149 * - encoding: Set by libavcodec.
1150 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1155 * Motion estimation algorithm used for video coding.
1156 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1157 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1158 * - encoding: MUST be set by user.
1159 * - decoding: unused
1164 * some codecs need / can use extradata like Huffman tables.
1165 * mjpeg: Huffman tables
1166 * rv10: additional flags
1167 * mpeg4: global headers (they can be in the bitstream or here)
1168 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1169 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1170 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1171 * - encoding: Set/allocated/freed by libavcodec.
1172 * - decoding: Set/allocated/freed by user.
1178 * This is the fundamental unit of time (in seconds) in terms
1179 * of which frame timestamps are represented. For fixed-fps content,
1180 * timebase should be 1/framerate and timestamp increments should be
1182 * - encoding: MUST be set by user.
1183 * - decoding: Set by libavcodec.
1185 AVRational time_base;
1189 * picture width / height.
1190 * - encoding: MUST be set by user.
1191 * - decoding: Set by libavcodec.
1192 * Note: For compatibility it is possible to set this instead of
1193 * coded_width/height before decoding.
1197 #define FF_ASPECT_EXTENDED 15
1200 * the number of pictures in a group of pictures, or 0 for intra_only
1201 * - encoding: Set by user.
1202 * - decoding: unused
1207 * Pixel format, see PIX_FMT_xxx.
1208 * May be set by the demuxer if known from headers.
1209 * May be overriden by the decoder if it knows better.
1210 * - encoding: Set by user.
1211 * - decoding: Set by user if known, overridden by libavcodec if known
1213 enum PixelFormat pix_fmt;
1216 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1217 * decoder to draw a horizontal band. It improves cache usage. Not
1218 * all codecs can do that. You must check the codec capabilities
1220 * When multithreading is used, it may be called from multiple threads
1221 * at the same time; threads might draw different parts of the same AVFrame,
1222 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1224 * The function is also used by hardware acceleration APIs.
1225 * It is called at least once during frame decoding to pass
1226 * the data needed for hardware render.
1227 * In that mode instead of pixel data, AVFrame points to
1228 * a structure specific to the acceleration API. The application
1229 * reads the structure and can change some fields to indicate progress
1231 * - encoding: unused
1232 * - decoding: Set by user.
1233 * @param height the height of the slice
1234 * @param y the y position of the slice
1235 * @param type 1->top field, 2->bottom field, 3->frame
1236 * @param offset offset into the AVFrame.data from which the slice should be read
1238 void (*draw_horiz_band)(struct AVCodecContext *s,
1239 const AVFrame *src, int offset[4],
1240 int y, int type, int height);
1243 int sample_rate; ///< samples per second
1244 int channels; ///< number of audio channels
1247 * audio sample format
1248 * - encoding: Set by user.
1249 * - decoding: Set by libavcodec.
1251 enum AVSampleFormat sample_fmt; ///< sample format
1253 /* The following data should not be initialized. */
1255 * Samples per packet, initialized when calling 'init'.
1258 int frame_number; ///< audio or video frame number
1261 * Number of frames the decoded output will be delayed relative to
1262 * the encoded input.
1263 * - encoding: Set by libavcodec.
1264 * - decoding: unused
1268 /* - encoding parameters */
1269 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1270 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1274 * - encoding: Set by user.
1275 * - decoding: unused
1281 * - encoding: Set by user.
1282 * - decoding: unused
1287 * maximum quantizer difference between frames
1288 * - encoding: Set by user.
1289 * - decoding: unused
1294 * maximum number of B-frames between non-B-frames
1295 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1296 * - encoding: Set by user.
1297 * - decoding: unused
1302 * qscale factor between IP and B-frames
1303 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1304 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1305 * - encoding: Set by user.
1306 * - decoding: unused
1308 float b_quant_factor;
1310 /** obsolete FIXME remove */
1312 #define FF_RC_STRATEGY_XVID 1
1314 int b_frame_strategy;
1316 struct AVCodec *codec;
1320 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1321 /* do its best to deliver a chunk with size */
1322 /* below rtp_payload_size, the chunk will start */
1323 /* with a start code on some codecs like H.263. */
1324 /* This doesn't take account of any particular */
1325 /* headers inside the transmitted RTP payload. */
1328 /* The RTP callback: This function is called */
1329 /* every time the encoder has a packet to send. */
1330 /* It depends on the encoder if the data starts */
1331 /* with a Start Code (it should). H.263 does. */
1332 /* mb_nb contains the number of macroblocks */
1333 /* encoded in the RTP payload. */
1334 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1336 /* statistics, used for 2-pass encoding */
1347 * number of bits used for the previously encoded frame
1348 * - encoding: Set by libavcodec.
1349 * - decoding: unused
1354 * Private data of the user, can be used to carry app specific stuff.
1355 * - encoding: Set by user.
1356 * - decoding: Set by user.
1360 char codec_name[32];
1361 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1362 enum CodecID codec_id; /* see CODEC_ID_xxx */
1365 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1366 * This is used to work around some encoder bugs.
1367 * A demuxer should set this to what is stored in the field used to identify the codec.
1368 * If there are multiple such fields in a container then the demuxer should choose the one
1369 * which maximizes the information about the used codec.
1370 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1371 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1372 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1374 * - encoding: Set by user, if not then the default based on codec_id will be used.
1375 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1377 unsigned int codec_tag;
1380 * Work around bugs in encoders which sometimes cannot be detected automatically.
1381 * - encoding: Set by user
1382 * - decoding: Set by user
1384 int workaround_bugs;
1385 #define FF_BUG_AUTODETECT 1 ///< autodetection
1386 #define FF_BUG_OLD_MSMPEG4 2
1387 #define FF_BUG_XVID_ILACE 4
1388 #define FF_BUG_UMP4 8
1389 #define FF_BUG_NO_PADDING 16
1390 #define FF_BUG_AMV 32
1391 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1392 #define FF_BUG_QPEL_CHROMA 64
1393 #define FF_BUG_STD_QPEL 128
1394 #define FF_BUG_QPEL_CHROMA2 256
1395 #define FF_BUG_DIRECT_BLOCKSIZE 512
1396 #define FF_BUG_EDGE 1024
1397 #define FF_BUG_HPEL_CHROMA 2048
1398 #define FF_BUG_DC_CLIP 4096
1399 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1400 #define FF_BUG_TRUNCATED 16384
1401 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1404 * luma single coefficient elimination threshold
1405 * - encoding: Set by user.
1406 * - decoding: unused
1408 int luma_elim_threshold;
1411 * chroma single coeff elimination threshold
1412 * - encoding: Set by user.
1413 * - decoding: unused
1415 int chroma_elim_threshold;
1418 * strictly follow the standard (MPEG4, ...).
1419 * - encoding: Set by user.
1420 * - decoding: Set by user.
1421 * Setting this to STRICT or higher means the encoder and decoder will
1422 * generally do stupid things, whereas setting it to unofficial or lower
1423 * will mean the encoder might produce output that is not supported by all
1424 * spec-compliant decoders. Decoders don't differentiate between normal,
1425 * unofficial and experimental (that is, they always try to decode things
1426 * when they can) unless they are explicitly asked to behave stupidly
1427 * (=strictly conform to the specs)
1429 int strict_std_compliance;
1430 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1431 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1432 #define FF_COMPLIANCE_NORMAL 0
1433 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1434 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1437 * qscale offset between IP and B-frames
1438 * - encoding: Set by user.
1439 * - decoding: unused
1441 float b_quant_offset;
1444 * Error recognization; higher values will detect more errors but may
1445 * misdetect some more or less valid parts as errors.
1446 * - encoding: unused
1447 * - decoding: Set by user.
1449 int error_recognition;
1450 #define FF_ER_CAREFUL 1
1451 #define FF_ER_COMPLIANT 2
1452 #define FF_ER_AGGRESSIVE 3
1453 #define FF_ER_VERY_AGGRESSIVE 4
1456 * Called at the beginning of each frame to get a buffer for it.
1457 * If pic.reference is set then the frame will be read later by libavcodec.
1458 * avcodec_align_dimensions2() should be used to find the required width and
1459 * height, as they normally need to be rounded up to the next multiple of 16.
1460 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1461 * avcodec_default_get_buffer() instead of providing buffers allocated by
1463 * If frame multithreading is used and thread_safe_callbacks is set,
1464 * it may be called from a different thread, but not from more than one at once.
1465 * Does not need to be reentrant.
1466 * - encoding: unused
1467 * - decoding: Set by libavcodec, user can override.
1469 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1472 * Called to release buffers which were allocated with get_buffer.
1473 * A released buffer can be reused in get_buffer().
1474 * pic.data[*] must be set to NULL.
1475 * May be called from a different thread if frame multithreading is used,
1476 * but not by more than one thread at once, so does not need to be reentrant.
1477 * - encoding: unused
1478 * - decoding: Set by libavcodec, user can override.
1480 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1483 * Size of the frame reordering buffer in the decoder.
1484 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1485 * - encoding: Set by libavcodec.
1486 * - decoding: Set by libavcodec.
1491 * number of bytes per packet if constant and known or 0
1492 * Used by some WAV based audio codecs.
1496 int parse_only; /* - decoding only: If true, only parsing is done
1497 (function avcodec_parse_frame()). The frame
1498 data is returned. Only MPEG codecs support this now. */
1501 * 0-> h263 quant 1-> mpeg quant
1502 * - encoding: Set by user.
1503 * - decoding: unused
1508 * pass1 encoding statistics output buffer
1509 * - encoding: Set by libavcodec.
1510 * - decoding: unused
1515 * pass2 encoding statistics input buffer
1516 * Concatenated stuff from stats_out of pass1 should be placed here.
1517 * - encoding: Allocated/set/freed by user.
1518 * - decoding: unused
1523 * ratecontrol qmin qmax limiting method
1524 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1525 * - encoding: Set by user.
1526 * - decoding: unused
1534 * ratecontrol override, see RcOverride
1535 * - encoding: Allocated/set/freed by user.
1536 * - decoding: unused
1538 RcOverride *rc_override;
1539 int rc_override_count;
1542 * rate control equation
1543 * - encoding: Set by user
1544 * - decoding: unused
1550 * - encoding: Set by user.
1551 * - decoding: unused
1557 * - encoding: Set by user.
1558 * - decoding: unused
1563 * decoder bitstream buffer size
1564 * - encoding: Set by user.
1565 * - decoding: unused
1568 float rc_buffer_aggressivity;
1571 * qscale factor between P and I-frames
1572 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1573 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1574 * - encoding: Set by user.
1575 * - decoding: unused
1577 float i_quant_factor;
1580 * qscale offset between P and I-frames
1581 * - encoding: Set by user.
1582 * - decoding: unused
1584 float i_quant_offset;
1587 * initial complexity for pass1 ratecontrol
1588 * - encoding: Set by user.
1589 * - decoding: unused
1591 float rc_initial_cplx;
1594 * DCT algorithm, see FF_DCT_* below
1595 * - encoding: Set by user.
1596 * - decoding: unused
1599 #define FF_DCT_AUTO 0
1600 #define FF_DCT_FASTINT 1
1601 #define FF_DCT_INT 2
1602 #define FF_DCT_MMX 3
1603 #define FF_DCT_MLIB 4
1604 #define FF_DCT_ALTIVEC 5
1605 #define FF_DCT_FAAN 6
1608 * luminance masking (0-> disabled)
1609 * - encoding: Set by user.
1610 * - decoding: unused
1615 * temporary complexity masking (0-> disabled)
1616 * - encoding: Set by user.
1617 * - decoding: unused
1619 float temporal_cplx_masking;
1622 * spatial complexity masking (0-> disabled)
1623 * - encoding: Set by user.
1624 * - decoding: unused
1626 float spatial_cplx_masking;
1629 * p block masking (0-> disabled)
1630 * - encoding: Set by user.
1631 * - decoding: unused
1636 * darkness masking (0-> disabled)
1637 * - encoding: Set by user.
1638 * - decoding: unused
1643 * IDCT algorithm, see FF_IDCT_* below.
1644 * - encoding: Set by user.
1645 * - decoding: Set by user.
1648 #define FF_IDCT_AUTO 0
1649 #define FF_IDCT_INT 1
1650 #define FF_IDCT_SIMPLE 2
1651 #define FF_IDCT_SIMPLEMMX 3
1652 #define FF_IDCT_LIBMPEG2MMX 4
1653 #define FF_IDCT_PS2 5
1654 #define FF_IDCT_MLIB 6
1655 #define FF_IDCT_ARM 7
1656 #define FF_IDCT_ALTIVEC 8
1657 #define FF_IDCT_SH4 9
1658 #define FF_IDCT_SIMPLEARM 10
1659 #define FF_IDCT_H264 11
1660 #define FF_IDCT_VP3 12
1661 #define FF_IDCT_IPP 13
1662 #define FF_IDCT_XVIDMMX 14
1663 #define FF_IDCT_CAVS 15
1664 #define FF_IDCT_SIMPLEARMV5TE 16
1665 #define FF_IDCT_SIMPLEARMV6 17
1666 #define FF_IDCT_SIMPLEVIS 18
1667 #define FF_IDCT_WMV2 19
1668 #define FF_IDCT_FAAN 20
1669 #define FF_IDCT_EA 21
1670 #define FF_IDCT_SIMPLENEON 22
1671 #define FF_IDCT_SIMPLEALPHA 23
1672 #define FF_IDCT_BINK 24
1676 * - encoding: Set by libavcodec.
1677 * - decoding: Set by user (or 0).
1681 * slice offsets in the frame in bytes
1682 * - encoding: Set/allocated by libavcodec.
1683 * - decoding: Set/allocated by user (or NULL).
1688 * error concealment flags
1689 * - encoding: unused
1690 * - decoding: Set by user.
1692 int error_concealment;
1693 #define FF_EC_GUESS_MVS 1
1694 #define FF_EC_DEBLOCK 2
1697 * dsp_mask could be add used to disable unwanted CPU features
1698 * CPU features (i.e. MMX, SSE. ...)
1700 * With the FORCE flag you may instead enable given CPU features.
1701 * (Dangerous: Usable in case of misdetection, improper usage however will
1702 * result into program crash.)
1707 * bits per sample/pixel from the demuxer (needed for huffyuv).
1708 * - encoding: Set by libavcodec.
1709 * - decoding: Set by user.
1711 int bits_per_coded_sample;
1714 * prediction method (needed for huffyuv)
1715 * - encoding: Set by user.
1716 * - decoding: unused
1718 int prediction_method;
1719 #define FF_PRED_LEFT 0
1720 #define FF_PRED_PLANE 1
1721 #define FF_PRED_MEDIAN 2
1724 * sample aspect ratio (0 if unknown)
1725 * That is the width of a pixel divided by the height of the pixel.
1726 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1727 * - encoding: Set by user.
1728 * - decoding: Set by libavcodec.
1730 AVRational sample_aspect_ratio;
1733 * the picture in the bitstream
1734 * - encoding: Set by libavcodec.
1735 * - decoding: Set by libavcodec.
1737 AVFrame *coded_frame;
1741 * - encoding: Set by user.
1742 * - decoding: Set by user.
1745 #define FF_DEBUG_PICT_INFO 1
1746 #define FF_DEBUG_RC 2
1747 #define FF_DEBUG_BITSTREAM 4
1748 #define FF_DEBUG_MB_TYPE 8
1749 #define FF_DEBUG_QP 16
1750 #define FF_DEBUG_MV 32
1751 #define FF_DEBUG_DCT_COEFF 0x00000040
1752 #define FF_DEBUG_SKIP 0x00000080
1753 #define FF_DEBUG_STARTCODE 0x00000100
1754 #define FF_DEBUG_PTS 0x00000200
1755 #define FF_DEBUG_ER 0x00000400
1756 #define FF_DEBUG_MMCO 0x00000800
1757 #define FF_DEBUG_BUGS 0x00001000
1758 #define FF_DEBUG_VIS_QP 0x00002000
1759 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1760 #define FF_DEBUG_BUFFERS 0x00008000
1761 #define FF_DEBUG_THREADS 0x00010000
1765 * - encoding: Set by user.
1766 * - decoding: Set by user.
1769 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1770 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1771 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1775 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1776 * - decoding: unused
1781 * motion estimation comparison function
1782 * - encoding: Set by user.
1783 * - decoding: unused
1787 * subpixel motion estimation comparison function
1788 * - encoding: Set by user.
1789 * - decoding: unused
1793 * macroblock comparison function (not supported yet)
1794 * - encoding: Set by user.
1795 * - decoding: unused
1799 * interlaced DCT comparison function
1800 * - encoding: Set by user.
1801 * - decoding: unused
1804 #define FF_CMP_SAD 0
1805 #define FF_CMP_SSE 1
1806 #define FF_CMP_SATD 2
1807 #define FF_CMP_DCT 3
1808 #define FF_CMP_PSNR 4
1809 #define FF_CMP_BIT 5
1811 #define FF_CMP_ZERO 7
1812 #define FF_CMP_VSAD 8
1813 #define FF_CMP_VSSE 9
1814 #define FF_CMP_NSSE 10
1815 #define FF_CMP_W53 11
1816 #define FF_CMP_W97 12
1817 #define FF_CMP_DCTMAX 13
1818 #define FF_CMP_DCT264 14
1819 #define FF_CMP_CHROMA 256
1822 * ME diamond size & shape
1823 * - encoding: Set by user.
1824 * - decoding: unused
1829 * amount of previous MV predictors (2a+1 x 2a+1 square)
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 int last_predictor_count;
1836 * prepass for motion estimation
1837 * - encoding: Set by user.
1838 * - decoding: unused
1843 * motion estimation prepass comparison function
1844 * - encoding: Set by user.
1845 * - decoding: unused
1850 * ME prepass diamond size & shape
1851 * - encoding: Set by user.
1852 * - decoding: unused
1858 * - encoding: Set by user.
1859 * - decoding: unused
1861 int me_subpel_quality;
1864 * callback to negotiate the pixelFormat
1865 * @param fmt is the list of formats which are supported by the codec,
1866 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1867 * The first is always the native one.
1868 * @return the chosen format
1869 * - encoding: unused
1870 * - decoding: Set by user, if not set the native format will be chosen.
1872 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1875 * DTG active format information (additional aspect ratio
1876 * information only used in DVB MPEG-2 transport streams)
1879 * - encoding: unused
1880 * - decoding: Set by decoder.
1882 int dtg_active_format;
1883 #define FF_DTG_AFD_SAME 8
1884 #define FF_DTG_AFD_4_3 9
1885 #define FF_DTG_AFD_16_9 10
1886 #define FF_DTG_AFD_14_9 11
1887 #define FF_DTG_AFD_4_3_SP_14_9 13
1888 #define FF_DTG_AFD_16_9_SP_14_9 14
1889 #define FF_DTG_AFD_SP_4_3 15
1892 * maximum motion estimation search range in subpel units
1893 * If 0 then no limit.
1895 * - encoding: Set by user.
1896 * - decoding: unused
1901 * intra quantizer bias
1902 * - encoding: Set by user.
1903 * - decoding: unused
1905 int intra_quant_bias;
1906 #define FF_DEFAULT_QUANT_BIAS 999999
1909 * inter quantizer bias
1910 * - encoding: Set by user.
1911 * - decoding: unused
1913 int inter_quant_bias;
1917 * - encoding: unused
1918 * - decoding: Which clrtable should be used for 8bit RGB images.
1919 * Tables have to be stored somewhere. FIXME
1924 * internal_buffer count
1925 * Don't touch, used by libavcodec default_get_buffer().
1927 int internal_buffer_count;
1931 * Don't touch, used by libavcodec default_get_buffer().
1933 void *internal_buffer;
1936 * Global quality for codecs which cannot change it per frame.
1937 * This should be proportional to MPEG-1/2/4 qscale.
1938 * - encoding: Set by user.
1939 * - decoding: unused
1943 #define FF_CODER_TYPE_VLC 0
1944 #define FF_CODER_TYPE_AC 1
1945 #define FF_CODER_TYPE_RAW 2
1946 #define FF_CODER_TYPE_RLE 3
1947 #define FF_CODER_TYPE_DEFLATE 4
1950 * - encoding: Set by user.
1951 * - decoding: unused
1957 * - encoding: Set by user.
1958 * - decoding: unused
1964 * - encoding: unused
1965 * - decoding: Set by user.
1967 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1972 * - encoding: unused
1973 * - decoding: Set by user.
1976 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1977 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1978 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1981 * XVideo Motion Acceleration
1982 * - encoding: forbidden
1983 * - decoding: set by decoder
1985 int xvmc_acceleration;
1988 * macroblock decision mode
1989 * - encoding: Set by user.
1990 * - decoding: unused
1993 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1994 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1995 #define FF_MB_DECISION_RD 2 ///< rate distortion
1998 * custom intra quantization matrix
1999 * - encoding: Set by user, can be NULL.
2000 * - decoding: Set by libavcodec.
2002 uint16_t *intra_matrix;
2005 * custom inter quantization matrix
2006 * - encoding: Set by user, can be NULL.
2007 * - decoding: Set by libavcodec.
2009 uint16_t *inter_matrix;
2012 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2013 * This is used to work around some encoder bugs.
2014 * - encoding: unused
2015 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2017 unsigned int stream_codec_tag;
2020 * scene change detection threshold
2021 * 0 is default, larger means fewer detected scene changes.
2022 * - encoding: Set by user.
2023 * - decoding: unused
2025 int scenechange_threshold;
2028 * minimum Lagrange multipler
2029 * - encoding: Set by user.
2030 * - decoding: unused
2035 * maximum Lagrange multipler
2036 * - encoding: Set by user.
2037 * - decoding: unused
2041 #if FF_API_PALETTE_CONTROL
2043 * palette control structure
2044 * - encoding: ??? (no palette-enabled encoder yet)
2045 * - decoding: Set by user.
2047 struct AVPaletteControl *palctrl;
2051 * noise reduction strength
2052 * - encoding: Set by user.
2053 * - decoding: unused
2055 int noise_reduction;
2058 * Called at the beginning of a frame to get cr buffer for it.
2059 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2060 * libavcodec will pass previous buffer in pic, function should return
2061 * same buffer or new buffer with old frame "painted" into it.
2062 * If pic.data[0] == NULL must behave like get_buffer().
2063 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2064 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2066 * - encoding: unused
2067 * - decoding: Set by libavcodec, user can override.
2069 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2072 * Number of bits which should be loaded into the rc buffer before decoding starts.
2073 * - encoding: Set by user.
2074 * - decoding: unused
2076 int rc_initial_buffer_occupancy;
2080 * - encoding: Set by user.
2081 * - decoding: unused
2083 int inter_threshold;
2087 * - encoding: Set by user.
2088 * - decoding: Set by user.
2093 * Simulates errors in the bitstream to test error concealment.
2094 * - encoding: Set by user.
2095 * - decoding: unused
2099 #if FF_API_ANTIALIAS_ALGO
2101 * MP3 antialias algorithm, see FF_AA_* below.
2102 * - encoding: unused
2103 * - decoding: Set by user.
2105 attribute_deprecated int antialias_algo;
2106 #define FF_AA_AUTO 0
2107 #define FF_AA_FASTINT 1 //not implemented yet
2109 #define FF_AA_FLOAT 3
2113 * quantizer noise shaping
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int quantizer_noise_shaping;
2121 * is used to decide how many independent tasks should be passed to execute()
2122 * - encoding: Set by user.
2123 * - decoding: Set by user.
2128 * The codec may call this to execute several independent things.
2129 * It will return only after finishing all tasks.
2130 * The user may replace this with some multithreaded implementation,
2131 * the default implementation will execute the parts serially.
2132 * @param count the number of things to execute
2133 * - encoding: Set by libavcodec, user can override.
2134 * - decoding: Set by libavcodec, user can override.
2136 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2140 * Can be used by execute() to store some per AVCodecContext stuff.
2141 * - encoding: set by execute()
2142 * - decoding: set by execute()
2144 void *thread_opaque;
2147 * Motion estimation threshold below which no motion estimation is
2148 * performed, but instead the user specified motion vectors are used.
2150 * - encoding: Set by user.
2151 * - decoding: unused
2156 * Macroblock threshold below which the user specified macroblock types will be used.
2157 * - encoding: Set by user.
2158 * - decoding: unused
2163 * precision of the intra DC coefficient - 8
2164 * - encoding: Set by user.
2165 * - decoding: unused
2167 int intra_dc_precision;
2170 * noise vs. sse weight for the nsse comparsion function
2171 * - encoding: Set by user.
2172 * - decoding: unused
2177 * Number of macroblock rows at the top which are skipped.
2178 * - encoding: unused
2179 * - decoding: Set by user.
2184 * Number of macroblock rows at the bottom which are skipped.
2185 * - encoding: unused
2186 * - decoding: Set by user.
2192 * - encoding: Set by user.
2193 * - decoding: Set by libavcodec.
2196 #define FF_PROFILE_UNKNOWN -99
2197 #define FF_PROFILE_RESERVED -100
2199 #define FF_PROFILE_AAC_MAIN 0
2200 #define FF_PROFILE_AAC_LOW 1
2201 #define FF_PROFILE_AAC_SSR 2
2202 #define FF_PROFILE_AAC_LTP 3
2204 #define FF_PROFILE_DTS 20
2205 #define FF_PROFILE_DTS_ES 30
2206 #define FF_PROFILE_DTS_96_24 40
2207 #define FF_PROFILE_DTS_HD_HRA 50
2208 #define FF_PROFILE_DTS_HD_MA 60
2210 #define FF_PROFILE_MPEG2_422 0
2211 #define FF_PROFILE_MPEG2_HIGH 1
2212 #define FF_PROFILE_MPEG2_SS 2
2213 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2214 #define FF_PROFILE_MPEG2_MAIN 4
2215 #define FF_PROFILE_MPEG2_SIMPLE 5
2217 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2218 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2220 #define FF_PROFILE_H264_BASELINE 66
2221 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2222 #define FF_PROFILE_H264_MAIN 77
2223 #define FF_PROFILE_H264_EXTENDED 88
2224 #define FF_PROFILE_H264_HIGH 100
2225 #define FF_PROFILE_H264_HIGH_10 110
2226 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2227 #define FF_PROFILE_H264_HIGH_422 122
2228 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2229 #define FF_PROFILE_H264_HIGH_444 144
2230 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2231 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2232 #define FF_PROFILE_H264_CAVLC_444 44
2234 #define FF_PROFILE_VC1_SIMPLE 0
2235 #define FF_PROFILE_VC1_MAIN 1
2236 #define FF_PROFILE_VC1_COMPLEX 2
2237 #define FF_PROFILE_VC1_ADVANCED 3
2241 * - encoding: Set by user.
2242 * - decoding: Set by libavcodec.
2245 #define FF_LEVEL_UNKNOWN -99
2248 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2249 * - encoding: unused
2250 * - decoding: Set by user.
2255 * Bitstream width / height, may be different from width/height if lowres
2256 * or other things are used.
2257 * - encoding: unused
2258 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2260 int coded_width, coded_height;
2263 * frame skip threshold
2264 * - encoding: Set by user.
2265 * - decoding: unused
2267 int frame_skip_threshold;
2271 * - encoding: Set by user.
2272 * - decoding: unused
2274 int frame_skip_factor;
2277 * frame skip exponent
2278 * - encoding: Set by user.
2279 * - decoding: unused
2284 * frame skip comparison function
2285 * - encoding: Set by user.
2286 * - decoding: unused
2291 * Border processing masking, raises the quantizer for mbs on the borders
2293 * - encoding: Set by user.
2294 * - decoding: unused
2296 float border_masking;
2299 * minimum MB lagrange multipler
2300 * - encoding: Set by user.
2301 * - decoding: unused
2306 * maximum MB lagrange multipler
2307 * - encoding: Set by user.
2308 * - decoding: unused
2314 * - encoding: Set by user.
2315 * - decoding: unused
2317 int me_penalty_compensation;
2321 * - encoding: unused
2322 * - decoding: Set by user.
2324 enum AVDiscard skip_loop_filter;
2328 * - encoding: unused
2329 * - decoding: Set by user.
2331 enum AVDiscard skip_idct;
2335 * - encoding: unused
2336 * - decoding: Set by user.
2338 enum AVDiscard skip_frame;
2342 * - encoding: Set by user.
2343 * - decoding: unused
2349 * - encoding: Set by user.
2350 * - decoding: unused
2355 * constant rate factor - quality-based VBR - values ~correspond to qps
2356 * - encoding: Set by user.
2357 * - decoding: unused
2362 * constant quantization parameter rate control method
2363 * - encoding: Set by user.
2364 * - decoding: unused
2370 * - encoding: Set by user.
2371 * - decoding: unused
2376 * number of reference frames
2377 * - encoding: Set by user.
2378 * - decoding: Set by lavc.
2383 * chroma qp offset from luma
2384 * - encoding: Set by user.
2385 * - decoding: unused
2390 * Influences how often B-frames are used.
2391 * - encoding: Set by user.
2392 * - decoding: unused
2397 * trellis RD quantization
2398 * - encoding: Set by user.
2399 * - decoding: unused
2404 * Reduce fluctuations in qp (before curve compression).
2405 * - encoding: Set by user.
2406 * - decoding: unused
2408 float complexityblur;
2411 * in-loop deblocking filter alphac0 parameter
2412 * alpha is in the range -6...6
2413 * - encoding: Set by user.
2414 * - decoding: unused
2419 * in-loop deblocking filter beta parameter
2420 * beta is in the range -6...6
2421 * - encoding: Set by user.
2422 * - decoding: unused
2427 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2428 * - encoding: Set by user.
2429 * - decoding: unused
2432 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2433 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2434 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2435 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2436 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2439 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2440 * - encoding: Set by user.
2441 * - decoding: unused
2446 * Audio cutoff bandwidth (0 means "automatic")
2447 * - encoding: Set by user.
2448 * - decoding: unused
2453 * Multiplied by qscale for each frame and added to scene_change_score.
2454 * - encoding: Set by user.
2455 * - decoding: unused
2457 int scenechange_factor;
2461 * Note: Value depends upon the compare function used for fullpel ME.
2462 * - encoding: Set by user.
2463 * - decoding: unused
2468 * Adjusts sensitivity of b_frame_strategy 1.
2469 * - encoding: Set by user.
2470 * - decoding: unused
2475 * - encoding: Set by user.
2476 * - decoding: unused
2478 int compression_level;
2479 #define FF_COMPRESSION_DEFAULT -1
2482 * - encoding: Set by user.
2483 * - decoding: unused
2485 int min_prediction_order;
2488 * - encoding: Set by user.
2489 * - decoding: unused
2491 int max_prediction_order;
2493 #if FF_API_FLAC_GLOBAL_OPTS
2495 * @name FLAC options
2496 * @deprecated Use FLAC encoder private options instead.
2501 * LPC coefficient precision - used by FLAC encoder
2502 * - encoding: Set by user.
2503 * - decoding: unused
2505 attribute_deprecated int lpc_coeff_precision;
2508 * search method for selecting prediction order
2509 * - encoding: Set by user.
2510 * - decoding: unused
2512 attribute_deprecated int prediction_order_method;
2515 * - encoding: Set by user.
2516 * - decoding: unused
2518 attribute_deprecated int min_partition_order;
2521 * - encoding: Set by user.
2522 * - decoding: unused
2524 attribute_deprecated int max_partition_order;
2531 * GOP timecode frame start number, in non drop frame format
2532 * - encoding: Set by user.
2533 * - decoding: unused
2535 int64_t timecode_frame_start;
2537 #if FF_API_REQUEST_CHANNELS
2539 * Decoder should decode to this many channels if it can (0 for default)
2540 * - encoding: unused
2541 * - decoding: Set by user.
2542 * @deprecated Deprecated in favor of request_channel_layout.
2544 int request_channels;
2547 #if FF_API_DRC_SCALE
2549 * Percentage of dynamic range compression to be applied by the decoder.
2550 * The default value is 1.0, corresponding to full compression.
2551 * - encoding: unused
2552 * - decoding: Set by user.
2553 * @deprecated use AC3 decoder private option instead.
2555 attribute_deprecated float drc_scale;
2559 * opaque 64bit number (generally a PTS) that will be reordered and
2560 * output in AVFrame.reordered_opaque
2561 * @deprecated in favor of pkt_pts
2562 * - encoding: unused
2563 * - decoding: Set by user.
2565 int64_t reordered_opaque;
2568 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2569 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2570 * - encoding: set by user.
2571 * - decoding: set by libavcodec.
2573 int bits_per_raw_sample;
2576 * Audio channel layout.
2577 * - encoding: set by user.
2578 * - decoding: set by libavcodec.
2580 int64_t channel_layout;
2583 * Request decoder to use this channel layout if it can (0 for default)
2584 * - encoding: unused
2585 * - decoding: Set by user.
2587 int64_t request_channel_layout;
2590 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2591 * - encoding: Set by user.
2592 * - decoding: unused.
2594 float rc_max_available_vbv_use;
2597 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2598 * - encoding: Set by user.
2599 * - decoding: unused.
2601 float rc_min_vbv_overflow_use;
2604 * Hardware accelerator in use
2605 * - encoding: unused.
2606 * - decoding: Set by libavcodec
2608 struct AVHWAccel *hwaccel;
2611 * For some codecs, the time base is closer to the field rate than the frame rate.
2612 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2613 * if no telecine is used ...
2615 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2617 int ticks_per_frame;
2620 * Hardware accelerator context.
2621 * For some hardware accelerators, a global context needs to be
2622 * provided by the user. In that case, this holds display-dependent
2623 * data Libav cannot instantiate itself. Please refer to the
2624 * Libav HW accelerator documentation to know how to fill this
2625 * is. e.g. for VA API, this is a struct vaapi_context.
2626 * - encoding: unused
2627 * - decoding: Set by user
2629 void *hwaccel_context;
2632 * Chromaticity coordinates of the source primaries.
2633 * - encoding: Set by user
2634 * - decoding: Set by libavcodec
2636 enum AVColorPrimaries color_primaries;
2639 * Color Transfer Characteristic.
2640 * - encoding: Set by user
2641 * - decoding: Set by libavcodec
2643 enum AVColorTransferCharacteristic color_trc;
2646 * YUV colorspace type.
2647 * - encoding: Set by user
2648 * - decoding: Set by libavcodec
2650 enum AVColorSpace colorspace;
2653 * MPEG vs JPEG YUV range.
2654 * - encoding: Set by user
2655 * - decoding: Set by libavcodec
2657 enum AVColorRange color_range;
2660 * This defines the location of chroma samples.
2661 * - encoding: Set by user
2662 * - decoding: Set by libavcodec
2664 enum AVChromaLocation chroma_sample_location;
2667 * The codec may call this to execute several independent things.
2668 * It will return only after finishing all tasks.
2669 * The user may replace this with some multithreaded implementation,
2670 * the default implementation will execute the parts serially.
2671 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2672 * @param c context passed also to func
2673 * @param count the number of things to execute
2674 * @param arg2 argument passed unchanged to func
2675 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2676 * @param func function that will be called count times, with jobnr from 0 to count-1.
2677 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2678 * two instances of func executing at the same time will have the same threadnr.
2679 * @return always 0 currently, but code should handle a future improvement where when any call to func
2680 * returns < 0 no further calls to func may be done and < 0 is returned.
2681 * - encoding: Set by libavcodec, user can override.
2682 * - decoding: Set by libavcodec, user can override.
2684 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2687 * explicit P-frame weighted prediction analysis method
2689 * 1: fast blind weighting (one reference duplicate with -1 offset)
2690 * 2: smart weighting (full fade detection analysis)
2691 * - encoding: Set by user.
2692 * - decoding: unused
2694 int weighted_p_pred;
2699 * 1: Variance AQ (complexity mask)
2700 * 2: Auto-variance AQ (experimental)
2701 * - encoding: Set by user
2702 * - decoding: unused
2708 * Reduces blocking and blurring in flat and textured areas.
2709 * - encoding: Set by user
2710 * - decoding: unused
2716 * Strength of psychovisual optimization
2717 * - encoding: Set by user
2718 * - decoding: unused
2724 * Strength of psychovisual optimization
2725 * - encoding: Set by user
2726 * - decoding: unused
2732 * Number of frames for frametype and ratecontrol lookahead
2733 * - encoding: Set by user
2734 * - decoding: unused
2739 * Constant rate factor maximum
2740 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2741 * than crf_max, even if doing so would violate VBV restrictions.
2742 * - encoding: Set by user.
2743 * - decoding: unused
2747 int log_level_offset;
2749 #if FF_API_FLAC_GLOBAL_OPTS
2751 * Determines which LPC analysis algorithm to use.
2752 * - encoding: Set by user
2753 * - decoding: unused
2755 attribute_deprecated enum AVLPCType lpc_type;
2758 * Number of passes to use for Cholesky factorization during LPC analysis
2759 * - encoding: Set by user
2760 * - decoding: unused
2762 attribute_deprecated int lpc_passes;
2767 * Indicates number of picture subdivisions. Used for parallelized
2769 * - encoding: Set by user
2770 * - decoding: unused
2775 * Header containing style information for text subtitles.
2776 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2777 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2778 * the Format line following. It shouldn't include any Dialogue line.
2779 * - encoding: Set/allocated/freed by user (before avcodec_open())
2780 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2782 uint8_t *subtitle_header;
2783 int subtitle_header_size;
2786 * Current packet as passed into the decoder, to avoid having
2787 * to pass the packet into every function. Currently only valid
2788 * inside lavc and get/release_buffer callbacks.
2789 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2790 * - encoding: unused
2795 * Whether this is a copy of the context which had init() called on it.
2796 * This is used by multithreading - shared tables and picture pointers
2797 * should be freed from the original context only.
2798 * - encoding: Set by libavcodec.
2799 * - decoding: Set by libavcodec.
2804 * Which multithreading methods to use.
2805 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2806 * so clients which cannot provide future frames should not use it.
2808 * - encoding: Set by user, otherwise the default is used.
2809 * - decoding: Set by user, otherwise the default is used.
2812 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2813 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2816 * Which multithreading methods are in use by the codec.
2817 * - encoding: Set by libavcodec.
2818 * - decoding: Set by libavcodec.
2820 int active_thread_type;
2823 * Set by the client if its custom get_buffer() callback can be called
2824 * from another thread, which allows faster multithreaded decoding.
2825 * draw_horiz_band() will be called from other threads regardless of this setting.
2826 * Ignored if the default get_buffer() is used.
2827 * - encoding: Set by user.
2828 * - decoding: Set by user.
2830 int thread_safe_callbacks;
2833 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2834 * Used for compliant TS muxing.
2835 * - encoding: Set by libavcodec.
2836 * - decoding: unused.
2841 * Type of service that the audio stream conveys.
2842 * - encoding: Set by user.
2843 * - decoding: Set by libavcodec.
2845 enum AVAudioServiceType audio_service_type;
2848 * Used to request a sample format from the decoder.
2849 * - encoding: unused.
2850 * - decoding: Set by user.
2852 enum AVSampleFormat request_sample_fmt;
2858 typedef struct AVProfile {
2860 const char *name; ///< short name for the profile
2863 typedef struct AVCodecDefault AVCodecDefault;
2868 typedef struct AVCodec {
2870 * Name of the codec implementation.
2871 * The name is globally unique among encoders and among decoders (but an
2872 * encoder and a decoder can share the same name).
2873 * This is the primary way to find a codec from the user perspective.
2876 enum AVMediaType type;
2879 int (*init)(AVCodecContext *);
2880 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2881 int (*close)(AVCodecContext *);
2882 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2884 * Codec capabilities.
2888 struct AVCodec *next;
2891 * Will be called when seeking
2893 void (*flush)(AVCodecContext *);
2894 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2895 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2897 * Descriptive name for the codec, meant to be more human readable than name.
2898 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2900 const char *long_name;
2901 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2902 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2903 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2904 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2905 const AVClass *priv_class; ///< AVClass for the private context
2906 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2909 * @name Frame-level threading support functions
2913 * If defined, called on thread contexts when they are created.
2914 * If the codec allocates writable tables in init(), re-allocate them here.
2915 * priv_data will be set to a copy of the original.
2917 int (*init_thread_copy)(AVCodecContext *);
2919 * Copy necessary context variables from a previous thread context to the current one.
2920 * If not defined, the next thread will start automatically; otherwise, the codec
2921 * must call ff_thread_finish_setup().
2923 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2925 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2929 * Private codec-specific defaults.
2931 const AVCodecDefault *defaults;
2937 typedef struct AVHWAccel {
2939 * Name of the hardware accelerated codec.
2940 * The name is globally unique among encoders and among decoders (but an
2941 * encoder and a decoder can share the same name).
2946 * Type of codec implemented by the hardware accelerator.
2948 * See AVMEDIA_TYPE_xxx
2950 enum AVMediaType type;
2953 * Codec implemented by the hardware accelerator.
2960 * Supported pixel format.
2962 * Only hardware accelerated formats are supported here.
2964 enum PixelFormat pix_fmt;
2967 * Hardware accelerated codec capabilities.
2968 * see FF_HWACCEL_CODEC_CAP_*
2972 struct AVHWAccel *next;
2975 * Called at the beginning of each frame or field picture.
2977 * Meaningful frame information (codec specific) is guaranteed to
2978 * be parsed at this point. This function is mandatory.
2980 * Note that buf can be NULL along with buf_size set to 0.
2981 * Otherwise, this means the whole frame is available at this point.
2983 * @param avctx the codec context
2984 * @param buf the frame data buffer base
2985 * @param buf_size the size of the frame in bytes
2986 * @return zero if successful, a negative value otherwise
2988 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2991 * Callback for each slice.
2993 * Meaningful slice information (codec specific) is guaranteed to
2994 * be parsed at this point. This function is mandatory.
2996 * @param avctx the codec context
2997 * @param buf the slice data buffer base
2998 * @param buf_size the size of the slice in bytes
2999 * @return zero if successful, a negative value otherwise
3001 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3004 * Called at the end of each frame or field picture.
3006 * The whole picture is parsed at this point and can now be sent
3007 * to the hardware accelerator. This function is mandatory.
3009 * @param avctx the codec context
3010 * @return zero if successful, a negative value otherwise
3012 int (*end_frame)(AVCodecContext *avctx);
3015 * Size of HW accelerator private data.
3017 * Private data is allocated with av_mallocz() before
3018 * AVCodecContext.get_buffer() and deallocated after
3019 * AVCodecContext.release_buffer().
3025 * four components are given, that's all.
3026 * the last component is alpha
3028 typedef struct AVPicture {
3030 int linesize[4]; ///< number of bytes per line
3033 #if FF_API_PALETTE_CONTROL
3036 * This structure defines a method for communicating palette changes
3037 * between and demuxer and a decoder.
3039 * @deprecated Use AVPacket to send palette changes instead.
3040 * This is totally broken.
3042 #define AVPALETTE_SIZE 1024
3043 #define AVPALETTE_COUNT 256
3044 typedef struct AVPaletteControl {
3046 /* Demuxer sets this to 1 to indicate the palette has changed;
3047 * decoder resets to 0. */
3048 int palette_changed;
3050 /* 4-byte ARGB palette entries, stored in native byte order; note that
3051 * the individual palette components should be on a 8-bit scale; if
3052 * the palette data comes from an IBM VGA native format, the component
3053 * data is probably 6 bits in size and needs to be scaled. */
3054 unsigned int palette[AVPALETTE_COUNT];
3056 } AVPaletteControl attribute_deprecated;
3059 enum AVSubtitleType {
3062 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3065 * Plain text, the text field must be set by the decoder and is
3066 * authoritative. ass and pict fields may contain approximations.
3071 * Formatted text, the ass field must be set by the decoder and is
3072 * authoritative. pict and text fields may contain approximations.
3077 typedef struct AVSubtitleRect {
3078 int x; ///< top left corner of pict, undefined when pict is not set
3079 int y; ///< top left corner of pict, undefined when pict is not set
3080 int w; ///< width of pict, undefined when pict is not set
3081 int h; ///< height of pict, undefined when pict is not set
3082 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3085 * data+linesize for the bitmap of this subtitle.
3086 * can be set for text/ass as well once they where rendered
3089 enum AVSubtitleType type;
3091 char *text; ///< 0 terminated plain UTF-8 text
3094 * 0 terminated ASS/SSA compatible event line.
3095 * The pressentation of this is unaffected by the other values in this
3101 typedef struct AVSubtitle {
3102 uint16_t format; /* 0 = graphics */
3103 uint32_t start_display_time; /* relative to packet pts, in ms */
3104 uint32_t end_display_time; /* relative to packet pts, in ms */
3106 AVSubtitleRect **rects;
3107 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3110 /* packet functions */
3113 * @deprecated use NULL instead
3115 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3118 * Default packet destructor.
3120 void av_destruct_packet(AVPacket *pkt);
3123 * Initialize optional fields of a packet with default values.
3127 void av_init_packet(AVPacket *pkt);
3130 * Allocate the payload of a packet and initialize its fields with
3134 * @param size wanted payload size
3135 * @return 0 if OK, AVERROR_xxx otherwise
3137 int av_new_packet(AVPacket *pkt, int size);
3140 * Reduce packet size, correctly zeroing padding
3143 * @param size new size
3145 void av_shrink_packet(AVPacket *pkt, int size);
3148 * Increase packet size, correctly zeroing padding
3151 * @param grow_by number of bytes by which to increase the size of the packet
3153 int av_grow_packet(AVPacket *pkt, int grow_by);
3156 * @warning This is a hack - the packet memory allocation stuff is broken. The
3157 * packet is allocated if it was not really allocated.
3159 int av_dup_packet(AVPacket *pkt);
3164 * @param pkt packet to free
3166 void av_free_packet(AVPacket *pkt);
3169 * Allocate new information of a packet.
3172 * @param type side information type
3173 * @param size side information size
3174 * @return pointer to fresh allocated data or NULL otherwise
3176 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3180 * Get side information from packet.
3183 * @param type desired side information type
3184 * @param size pointer for side information size to store (optional)
3185 * @return pointer to data if present or NULL otherwise
3187 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3192 struct ReSampleContext;
3193 struct AVResampleContext;
3195 typedef struct ReSampleContext ReSampleContext;
3198 * Initialize audio resampling context.
3200 * @param output_channels number of output channels
3201 * @param input_channels number of input channels
3202 * @param output_rate output sample rate
3203 * @param input_rate input sample rate
3204 * @param sample_fmt_out requested output sample format
3205 * @param sample_fmt_in input sample format
3206 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3207 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3208 * @param linear if 1 then the used FIR filter will be linearly interpolated
3209 between the 2 closest, if 0 the closest will be used
3210 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3211 * @return allocated ReSampleContext, NULL if error occured
3213 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3214 int output_rate, int input_rate,
3215 enum AVSampleFormat sample_fmt_out,
3216 enum AVSampleFormat sample_fmt_in,
3217 int filter_length, int log2_phase_count,
3218 int linear, double cutoff);
3220 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3223 * Free resample context.
3225 * @param s a non-NULL pointer to a resample context previously
3226 * created with av_audio_resample_init()
3228 void audio_resample_close(ReSampleContext *s);
3232 * Initialize an audio resampler.
3233 * Note, if either rate is not an integer then simply scale both rates up so they are.
3234 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3235 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3236 * @param linear If 1 then the used FIR filter will be linearly interpolated
3237 between the 2 closest, if 0 the closest will be used
3238 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3240 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3243 * Resample an array of samples using a previously configured context.
3244 * @param src an array of unconsumed samples
3245 * @param consumed the number of samples of src which have been consumed are returned here
3246 * @param src_size the number of unconsumed samples available
3247 * @param dst_size the amount of space in samples available in dst
3248 * @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.
3249 * @return the number of samples written in dst or -1 if an error occurred
3251 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3255 * Compensate samplerate/timestamp drift. The compensation is done by changing
3256 * the resampler parameters, so no audible clicks or similar distortions occur
3257 * @param compensation_distance distance in output samples over which the compensation should be performed
3258 * @param sample_delta number of output samples which should be output less
3260 * example: av_resample_compensate(c, 10, 500)
3261 * here instead of 510 samples only 500 samples would be output
3263 * note, due to rounding the actual compensation might be slightly different,
3264 * especially if the compensation_distance is large and the in_rate used during init is small
3266 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3267 void av_resample_close(struct AVResampleContext *c);
3270 * Allocate memory for a picture. Call avpicture_free() to free it.
3272 * @see avpicture_fill()
3274 * @param picture the picture to be filled in
3275 * @param pix_fmt the format of the picture
3276 * @param width the width of the picture
3277 * @param height the height of the picture
3278 * @return zero if successful, a negative value if not
3280 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3283 * Free a picture previously allocated by avpicture_alloc().
3284 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3287 * @param picture the AVPicture to be freed
3289 void avpicture_free(AVPicture *picture);
3292 * Fill in the AVPicture fields.
3293 * The fields of the given AVPicture are filled in by using the 'ptr' address
3294 * which points to the image data buffer. Depending on the specified picture
3295 * format, one or multiple image data pointers and line sizes will be set.
3296 * If a planar format is specified, several pointers will be set pointing to
3297 * the different picture planes and the line sizes of the different planes
3298 * will be stored in the lines_sizes array.
3299 * Call with ptr == NULL to get the required size for the ptr buffer.
3301 * To allocate the buffer and fill in the AVPicture fields in one call,
3302 * use avpicture_alloc().
3304 * @param picture AVPicture whose fields are to be filled in
3305 * @param ptr Buffer which will contain or contains the actual image data
3306 * @param pix_fmt The format in which the picture data is stored.
3307 * @param width the width of the image in pixels
3308 * @param height the height of the image in pixels
3309 * @return size of the image data in bytes
3311 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3312 enum PixelFormat pix_fmt, int width, int height);
3315 * Copy pixel data from an AVPicture into a buffer.
3316 * The data is stored compactly, without any gaps for alignment or padding
3317 * which may be applied by avpicture_fill().
3319 * @see avpicture_get_size()
3321 * @param[in] src AVPicture containing image data
3322 * @param[in] pix_fmt The format in which the picture data is stored.
3323 * @param[in] width the width of the image in pixels.
3324 * @param[in] height the height of the image in pixels.
3325 * @param[out] dest A buffer into which picture data will be copied.
3326 * @param[in] dest_size The size of 'dest'.
3327 * @return The number of bytes written to dest, or a negative value (error code) on error.
3329 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3330 unsigned char *dest, int dest_size);
3333 * Calculate the size in bytes that a picture of the given width and height
3334 * would occupy if stored in the given picture format.
3335 * Note that this returns the size of a compact representation as generated
3336 * by avpicture_layout(), which can be smaller than the size required for e.g.
3339 * @param pix_fmt the given picture format
3340 * @param width the width of the image
3341 * @param height the height of the image
3342 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3344 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3345 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3347 #if FF_API_GET_PIX_FMT_NAME
3349 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3351 attribute_deprecated
3352 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3355 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3358 * Return a value representing the fourCC code associated to the
3359 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3362 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3365 * Put a string representing the codec tag codec_tag in buf.
3367 * @param buf_size size in bytes of buf
3368 * @return the length of the string that would have been generated if
3369 * enough space had been available, excluding the trailing null
3371 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3373 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3374 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3375 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3376 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3377 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3378 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3381 * Compute what kind of losses will occur when converting from one specific
3382 * pixel format to another.
3383 * When converting from one pixel format to another, information loss may occur.
3384 * For example, when converting from RGB24 to GRAY, the color information will
3385 * be lost. Similarly, other losses occur when converting from some formats to
3386 * other formats. These losses can involve loss of chroma, but also loss of
3387 * resolution, loss of color depth, loss due to the color space conversion, loss
3388 * of the alpha bits or loss due to color quantization.
3389 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3390 * which will occur when converting from one pixel format to another.
3392 * @param[in] dst_pix_fmt destination pixel format
3393 * @param[in] src_pix_fmt source pixel format
3394 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3395 * @return Combination of flags informing you what kind of losses will occur.
3397 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3401 * Find the best pixel format to convert to given a certain source pixel
3402 * format. When converting from one pixel format to another, information loss
3403 * may occur. For example, when converting from RGB24 to GRAY, the color
3404 * information will be lost. Similarly, other losses occur when converting from
3405 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3406 * the given pixel formats should be used to suffer the least amount of loss.
3407 * The pixel formats from which it chooses one, are determined by the
3408 * pix_fmt_mask parameter.
3411 * src_pix_fmt = PIX_FMT_YUV420P;
3412 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3413 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3416 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3417 * @param[in] src_pix_fmt source pixel format
3418 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3419 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3420 * @return The best pixel format to convert to or -1 if none was found.
3422 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3423 int has_alpha, int *loss_ptr);
3425 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3426 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3429 * Tell if an image really has transparent alpha values.
3430 * @return ored mask of FF_ALPHA_xxx constants
3432 int img_get_alpha_info(const AVPicture *src,
3433 enum PixelFormat pix_fmt, int width, int height);
3435 /* deinterlace a picture */
3436 /* deinterlace - if not supported return -1 */
3437 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3438 enum PixelFormat pix_fmt, int width, int height);
3440 /* external high level API */
3443 * If c is NULL, returns the first registered codec,
3444 * if c is non-NULL, returns the next registered codec after c,
3445 * or NULL if c is the last one.
3447 AVCodec *av_codec_next(AVCodec *c);
3450 * Return the LIBAVCODEC_VERSION_INT constant.
3452 unsigned avcodec_version(void);
3455 * Return the libavcodec build-time configuration.
3457 const char *avcodec_configuration(void);
3460 * Return the libavcodec license.
3462 const char *avcodec_license(void);
3465 * Initialize libavcodec.
3466 * If called more than once, does nothing.
3468 * @warning This function must be called before any other libavcodec
3471 * @warning This function is not thread-safe.
3473 void avcodec_init(void);
3476 * Register the codec codec and initialize libavcodec.
3478 * @see avcodec_init(), avcodec_register_all()
3480 void avcodec_register(AVCodec *codec);
3483 * Find a registered encoder with a matching codec ID.
3485 * @param id CodecID of the requested encoder
3486 * @return An encoder if one was found, NULL otherwise.
3488 AVCodec *avcodec_find_encoder(enum CodecID id);
3491 * Find a registered encoder with the specified name.
3493 * @param name name of the requested encoder
3494 * @return An encoder if one was found, NULL otherwise.
3496 AVCodec *avcodec_find_encoder_by_name(const char *name);
3499 * Find a registered decoder with a matching codec ID.
3501 * @param id CodecID of the requested decoder
3502 * @return A decoder if one was found, NULL otherwise.
3504 AVCodec *avcodec_find_decoder(enum CodecID id);
3507 * Find a registered decoder with the specified name.
3509 * @param name name of the requested decoder
3510 * @return A decoder if one was found, NULL otherwise.
3512 AVCodec *avcodec_find_decoder_by_name(const char *name);
3513 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3516 * Return a name for the specified profile, if available.
3518 * @param codec the codec that is searched for the given profile
3519 * @param profile the profile value for which a name is requested
3520 * @return A name for the profile if found, NULL otherwise.
3522 const char *av_get_profile_name(const AVCodec *codec, int profile);
3525 * Set the fields of the given AVCodecContext to default values.
3527 * @param s The AVCodecContext of which the fields should be set to default values.
3529 void avcodec_get_context_defaults(AVCodecContext *s);
3531 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3532 * we WILL change its arguments and name a few times! */
3533 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3535 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3536 * we WILL change its arguments and name a few times! */
3537 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3539 #if FF_API_ALLOC_CONTEXT
3541 * Allocate an AVCodecContext and set its fields to default values. The
3542 * resulting struct can be deallocated by simply calling av_free().
3544 * @return An AVCodecContext filled with default values or NULL on failure.
3545 * @see avcodec_get_context_defaults
3547 * @deprecated use avcodec_alloc_context3()
3549 attribute_deprecated
3550 AVCodecContext *avcodec_alloc_context(void);
3552 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3553 * we WILL change its arguments and name a few times! */
3554 attribute_deprecated
3555 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3559 * Allocate an AVCodecContext and set its fields to default values. The
3560 * resulting struct can be deallocated by simply calling av_free().
3562 * @param codec if non-NULL, allocate private data and initialize defaults
3563 * for the given codec. It is illegal to then call avcodec_open()
3564 * with a different codec.
3566 * @return An AVCodecContext filled with default values or NULL on failure.
3567 * @see avcodec_get_context_defaults
3569 * @deprecated use avcodec_alloc_context3()
3571 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3574 * Copy the settings of the source AVCodecContext into the destination
3575 * AVCodecContext. The resulting destination codec context will be
3576 * unopened, i.e. you are required to call avcodec_open() before you
3577 * can use this AVCodecContext to decode/encode video/audio data.
3579 * @param dest target codec context, should be initialized with
3580 * avcodec_alloc_context3(), but otherwise uninitialized
3581 * @param src source codec context
3582 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3584 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3587 * Set the fields of the given AVFrame to default values.
3589 * @param pic The AVFrame of which the fields should be set to default values.
3591 void avcodec_get_frame_defaults(AVFrame *pic);
3594 * Allocate an AVFrame and set its fields to default values. The resulting
3595 * struct can be deallocated by simply calling av_free().
3597 * @return An AVFrame filled with default values or NULL on failure.
3598 * @see avcodec_get_frame_defaults
3600 AVFrame *avcodec_alloc_frame(void);
3602 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3603 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3604 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3607 * Return the amount of padding in pixels which the get_buffer callback must
3608 * provide around the edge of the image for codecs which do not have the
3609 * CODEC_FLAG_EMU_EDGE flag.
3611 * @return Required padding in pixels.
3613 unsigned avcodec_get_edge_width(void);
3615 * Modify width and height values so that they will result in a memory
3616 * buffer that is acceptable for the codec if you do not use any horizontal
3619 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3620 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3621 * according to avcodec_get_edge_width() before.
3623 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3625 * Modify width and height values so that they will result in a memory
3626 * buffer that is acceptable for the codec if you also ensure that all
3627 * line sizes are a multiple of the respective linesize_align[i].
3629 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3630 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3631 * according to avcodec_get_edge_width() before.
3633 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3634 int linesize_align[4]);
3636 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3638 #if FF_API_THREAD_INIT
3640 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3642 attribute_deprecated
3643 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3646 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3647 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3648 //FIXME func typedef
3650 #if FF_API_AVCODEC_OPEN
3652 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3653 * function the context has to be allocated.
3655 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3656 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3657 * retrieving a codec.
3659 * @warning This function is not thread safe!
3662 * avcodec_register_all();
3663 * codec = avcodec_find_decoder(CODEC_ID_H264);
3667 * context = avcodec_alloc_context3(codec);
3669 * if (avcodec_open(context, codec) < 0)
3673 * @param avctx The context which will be set up to use the given codec.
3674 * @param codec The codec to use within the context.
3675 * @return zero on success, a negative value on error
3676 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3678 * @deprecated use avcodec_open2
3680 attribute_deprecated
3681 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3685 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3686 * function the context has to be allocated with avcodec_alloc_context().
3688 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3689 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3690 * retrieving a codec.
3692 * @warning This function is not thread safe!
3695 * avcodec_register_all();
3696 * av_dict_set(&opts, "b", "2.5M", 0);
3697 * codec = avcodec_find_decoder(CODEC_ID_H264);
3701 * context = avcodec_alloc_context();
3703 * if (avcodec_open(context, codec, opts) < 0)
3707 * @param avctx The context to initialize.
3708 * @param options A dictionary filled with AVCodecContext and codec-private options.
3709 * On return this object will be filled with options that were not found.
3711 * @return zero on success, a negative value on error
3712 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3713 * av_dict_set(), av_opt_find().
3715 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3718 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3719 * Some decoders may support multiple frames in a single AVPacket, such
3720 * decoders would then just decode the first frame. In this case,
3721 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3722 * the remaining data in order to decode the second frame etc.
3724 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3725 * decompressed frame size in bytes.
3727 * @warning You must set frame_size_ptr to the allocated size of the
3728 * output buffer before calling avcodec_decode_audio3().
3730 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3731 * the actual read bytes because some optimized bitstream readers read 32 or 64
3732 * bits at once and could read over the end.
3734 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3735 * no overreading happens for damaged MPEG streams.
3737 * @note You might have to align the input buffer avpkt->data and output buffer
3738 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3739 * necessary at all, on others it won't work at all if not aligned and on others
3740 * it will work but it will have an impact on performance.
3742 * In practice, avpkt->data should have 4 byte alignment at minimum and
3743 * samples should be 16 byte aligned unless the CPU doesn't need it
3744 * (AltiVec and SSE do).
3746 * @param avctx the codec context
3747 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3748 * @param[in,out] frame_size_ptr the output buffer size in bytes
3749 * @param[in] avpkt The input AVPacket containing the input buffer.
3750 * You can create such packet with av_init_packet() and by then setting
3751 * data and size, some decoders might in addition need other fields.
3752 * All decoders are designed to use the least fields possible though.
3753 * @return On error a negative value is returned, otherwise the number of bytes
3754 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3756 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3757 int *frame_size_ptr,
3761 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3762 * Some decoders may support multiple frames in a single AVPacket, such
3763 * decoders would then just decode the first frame.
3765 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3766 * the actual read bytes because some optimized bitstream readers read 32 or 64
3767 * bits at once and could read over the end.
3769 * @warning The end of the input buffer buf should be set to 0 to ensure that
3770 * no overreading happens for damaged MPEG streams.
3772 * @note You might have to align the input buffer avpkt->data.
3773 * The alignment requirements depend on the CPU: on some CPUs it isn't
3774 * necessary at all, on others it won't work at all if not aligned and on others
3775 * it will work but it will have an impact on performance.
3777 * In practice, avpkt->data should have 4 byte alignment at minimum.
3779 * @note Some codecs have a delay between input and output, these need to be
3780 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3782 * @param avctx the codec context
3783 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3784 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3785 * allocate memory for the actual bitmap.
3786 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3787 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3788 * decodes and the decoder tells the user once it does not need the data anymore,
3789 * the user app can at this point free/reuse/keep the memory as it sees fit.
3791 * @param[in] avpkt The input AVpacket containing the input buffer.
3792 * You can create such packet with av_init_packet() and by then setting
3793 * data and size, some decoders might in addition need other fields like
3794 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3796 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3797 * @return On error a negative value is returned, otherwise the number of bytes
3798 * used or zero if no frame could be decompressed.
3800 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3801 int *got_picture_ptr,
3805 * Decode a subtitle message.
3806 * Return a negative value on error, otherwise return the number of bytes used.
3807 * If no subtitle could be decompressed, got_sub_ptr is zero.
3808 * Otherwise, the subtitle is stored in *sub.
3809 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3810 * simplicity, because the performance difference is expect to be negligible
3811 * and reusing a get_buffer written for video codecs would probably perform badly
3812 * due to a potentially very different allocation pattern.
3814 * @param avctx the codec context
3815 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3816 freed with avsubtitle_free if *got_sub_ptr is set.
3817 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3818 * @param[in] avpkt The input AVPacket containing the input buffer.
3820 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3825 * Frees all allocated data in the given subtitle struct.
3827 * @param sub AVSubtitle to free.
3829 void avsubtitle_free(AVSubtitle *sub);
3831 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3833 uint8_t *buf, int buf_size);
3836 * Encode an audio frame from samples into buf.
3838 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3839 * However, for PCM audio the user will know how much space is needed
3840 * because it depends on the value passed in buf_size as described
3841 * below. In that case a lower value can be used.
3843 * @param avctx the codec context
3844 * @param[out] buf the output buffer
3845 * @param[in] buf_size the output buffer size
3846 * @param[in] samples the input buffer containing the samples
3847 * The number of samples read from this buffer is frame_size*channels,
3848 * both of which are defined in avctx.
3849 * For PCM audio the number of samples read from samples is equal to
3850 * buf_size * input_sample_size / output_sample_size.
3851 * @return On error a negative value is returned, on success zero or the number
3852 * of bytes used to encode the data read from the input buffer.
3854 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3855 const short *samples);
3858 * Encode a video frame from pict into buf.
3859 * The input picture should be
3860 * stored using a specific format, namely avctx.pix_fmt.
3862 * @param avctx the codec context
3863 * @param[out] buf the output buffer for the bitstream of encoded frame
3864 * @param[in] buf_size the size of the output buffer in bytes
3865 * @param[in] pict the input picture to encode
3866 * @return On error a negative value is returned, on success zero or the number
3867 * of bytes used from the output buffer.
3869 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3870 const AVFrame *pict);
3871 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3872 const AVSubtitle *sub);
3874 int avcodec_close(AVCodecContext *avctx);
3877 * Register all the codecs, parsers and bitstream filters which were enabled at
3878 * configuration time. If you do not call this function you can select exactly
3879 * which formats you want to support, by using the individual registration
3882 * @see avcodec_register
3883 * @see av_register_codec_parser
3884 * @see av_register_bitstream_filter
3886 void avcodec_register_all(void);
3889 * Flush buffers, should be called when seeking or when switching to a different stream.
3891 void avcodec_flush_buffers(AVCodecContext *avctx);
3893 void avcodec_default_free_buffers(AVCodecContext *s);
3895 /* misc useful functions */
3897 #if FF_API_OLD_FF_PICT_TYPES
3899 * Return a single letter to describe the given picture type pict_type.
3901 * @param[in] pict_type the picture type
3902 * @return A single character representing the picture type.
3903 * @deprecated Use av_get_picture_type_char() instead.
3905 attribute_deprecated
3906 char av_get_pict_type_char(int pict_type);
3910 * Return codec bits per sample.
3912 * @param[in] codec_id the codec
3913 * @return Number of bits per sample or zero if unknown for the given codec.
3915 int av_get_bits_per_sample(enum CodecID codec_id);
3917 #if FF_API_OLD_SAMPLE_FMT
3919 * @deprecated Use av_get_bytes_per_sample() instead.
3921 attribute_deprecated
3922 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3926 typedef struct AVCodecParserContext {
3928 struct AVCodecParser *parser;
3929 int64_t frame_offset; /* offset of the current frame */
3930 int64_t cur_offset; /* current offset
3931 (incremented by each av_parser_parse()) */
3932 int64_t next_frame_offset; /* offset of the next frame */
3934 int pict_type; /* XXX: Put it back in AVCodecContext. */
3936 * This field is used for proper frame duration computation in lavf.
3937 * It signals, how much longer the frame duration of the current frame
3938 * is compared to normal frame duration.
3940 * frame_duration = (1 + repeat_pict) * time_base
3942 * It is used by codecs like H.264 to display telecined material.
3944 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3945 int64_t pts; /* pts of the current frame */
3946 int64_t dts; /* dts of the current frame */
3951 int fetch_timestamp;
3953 #define AV_PARSER_PTS_NB 4
3954 int cur_frame_start_index;
3955 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3956 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3957 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3960 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3961 #define PARSER_FLAG_ONCE 0x0002
3962 /// Set if the parser has a valid file offset
3963 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3965 int64_t offset; ///< byte offset from starting packet start
3966 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3969 * Set by parser to 1 for key frames and 0 for non-key frames.
3970 * It is initialized to -1, so if the parser doesn't set this flag,
3971 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3977 * Time difference in stream time base units from the pts of this
3978 * packet to the point at which the output from the decoder has converged
3979 * independent from the availability of previous frames. That is, the
3980 * frames are virtually identical no matter if decoding started from
3981 * the very first frame or from this keyframe.
3982 * Is AV_NOPTS_VALUE if unknown.
3983 * This field is not the display duration of the current frame.
3984 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3987 * The purpose of this field is to allow seeking in streams that have no
3988 * keyframes in the conventional sense. It corresponds to the
3989 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3990 * essential for some types of subtitle streams to ensure that all
3991 * subtitles are correctly displayed after seeking.
3993 int64_t convergence_duration;
3995 // Timestamp generation support:
3997 * Synchronization point for start of timestamp generation.
3999 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4002 * For example, this corresponds to presence of H.264 buffering period
4008 * Offset of the current timestamp against last timestamp sync point in
4009 * units of AVCodecContext.time_base.
4011 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4012 * contain a valid timestamp offset.
4014 * Note that the timestamp of sync point has usually a nonzero
4015 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4016 * the next frame after timestamp sync point will be usually 1.
4018 * For example, this corresponds to H.264 cpb_removal_delay.
4020 int dts_ref_dts_delta;
4023 * Presentation delay of current frame in units of AVCodecContext.time_base.
4025 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4026 * contain valid non-negative timestamp delta (presentation time of a frame
4027 * must not lie in the past).
4029 * This delay represents the difference between decoding and presentation
4030 * time of the frame.
4032 * For example, this corresponds to H.264 dpb_output_delay.
4037 * Position of the packet in file.
4039 * Analogous to cur_frame_pts/dts
4041 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4044 * Byte position of currently parsed frame in stream.
4049 * Previous frame byte position.
4052 } AVCodecParserContext;
4054 typedef struct AVCodecParser {
4055 int codec_ids[5]; /* several codec IDs are permitted */
4057 int (*parser_init)(AVCodecParserContext *s);
4058 int (*parser_parse)(AVCodecParserContext *s,
4059 AVCodecContext *avctx,
4060 const uint8_t **poutbuf, int *poutbuf_size,
4061 const uint8_t *buf, int buf_size);
4062 void (*parser_close)(AVCodecParserContext *s);
4063 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4064 struct AVCodecParser *next;
4067 AVCodecParser *av_parser_next(AVCodecParser *c);
4069 void av_register_codec_parser(AVCodecParser *parser);
4070 AVCodecParserContext *av_parser_init(int codec_id);
4075 * @param s parser context.
4076 * @param avctx codec context.
4077 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4078 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4079 * @param buf input buffer.
4080 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4081 * @param pts input presentation timestamp.
4082 * @param dts input decoding timestamp.
4083 * @param pos input byte position in stream.
4084 * @return the number of bytes of the input bitstream used.
4089 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4096 * decode_frame(data, size);
4100 int av_parser_parse2(AVCodecParserContext *s,
4101 AVCodecContext *avctx,
4102 uint8_t **poutbuf, int *poutbuf_size,
4103 const uint8_t *buf, int buf_size,
4104 int64_t pts, int64_t dts,
4107 int av_parser_change(AVCodecParserContext *s,
4108 AVCodecContext *avctx,
4109 uint8_t **poutbuf, int *poutbuf_size,
4110 const uint8_t *buf, int buf_size, int keyframe);
4111 void av_parser_close(AVCodecParserContext *s);
4114 typedef struct AVBitStreamFilterContext {
4116 struct AVBitStreamFilter *filter;
4117 AVCodecParserContext *parser;
4118 struct AVBitStreamFilterContext *next;
4119 } AVBitStreamFilterContext;
4122 typedef struct AVBitStreamFilter {
4125 int (*filter)(AVBitStreamFilterContext *bsfc,
4126 AVCodecContext *avctx, const char *args,
4127 uint8_t **poutbuf, int *poutbuf_size,
4128 const uint8_t *buf, int buf_size, int keyframe);
4129 void (*close)(AVBitStreamFilterContext *bsfc);
4130 struct AVBitStreamFilter *next;
4131 } AVBitStreamFilter;
4133 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4134 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4135 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4136 AVCodecContext *avctx, const char *args,
4137 uint8_t **poutbuf, int *poutbuf_size,
4138 const uint8_t *buf, int buf_size, int keyframe);
4139 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4141 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4146 * Reallocate the given block if it is not large enough, otherwise do nothing.
4150 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4153 * Allocate a buffer, reusing the given one if large enough.
4155 * Contrary to av_fast_realloc the current buffer contents might not be
4156 * preserved and on error the old buffer is freed, thus no special
4157 * handling to avoid memleaks is necessary.
4159 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4160 * @param size size of the buffer *ptr points to
4161 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4162 * *size 0 if an error occurred.
4164 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4167 * Copy image src to dst. Wraps av_picture_data_copy() above.
4169 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4170 enum PixelFormat pix_fmt, int width, int height);
4173 * Crop image top and left side.
4175 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4176 enum PixelFormat pix_fmt, int top_band, int left_band);
4181 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4182 int padtop, int padbottom, int padleft, int padright, int *color);
4185 * Encode extradata length to a buffer. Used by xiph codecs.
4187 * @param s buffer to write to; must be at least (v/255+1) bytes long
4188 * @param v size of extradata in bytes
4189 * @return number of bytes written to the buffer.
4191 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4194 * Logs a generic warning message about a missing feature. This function is
4195 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4196 * only, and would normally not be used by applications.
4197 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4198 * a pointer to an AVClass struct
4199 * @param[in] feature string containing the name of the missing feature
4200 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4201 * If want_sample is non-zero, additional verbage will be added to the log
4202 * message which tells the user how to report samples to the development
4205 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4208 * Log a generic warning message asking for a sample. This function is
4209 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4210 * only, and would normally not be used by applications.
4211 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4212 * a pointer to an AVClass struct
4213 * @param[in] msg string containing an optional message, or NULL if no message
4215 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4218 * Register the hardware accelerator hwaccel.
4220 void av_register_hwaccel(AVHWAccel *hwaccel);
4223 * If hwaccel is NULL, returns the first registered hardware accelerator,
4224 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4225 * after hwaccel, or NULL if hwaccel is the last one.
4227 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4231 * Lock operation used by lockmgr
4234 AV_LOCK_CREATE, ///< Create a mutex
4235 AV_LOCK_OBTAIN, ///< Lock the mutex
4236 AV_LOCK_RELEASE, ///< Unlock the mutex
4237 AV_LOCK_DESTROY, ///< Free mutex resources
4241 * Register a user provided lock manager supporting the operations
4242 * specified by AVLockOp. mutex points to a (void *) where the
4243 * lockmgr should store/get a pointer to a user allocated mutex. It's
4244 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4246 * @param cb User defined callback. Note: Libav may invoke calls to this
4247 * callback during the call to av_lockmgr_register().
4248 * Thus, the application must be prepared to handle that.
4249 * If cb is set to NULL the lockmgr will be unregistered.
4250 * Also note that during unregistration the previously registered
4251 * lockmgr callback may also be invoked.
4253 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4255 #endif /* AVCODEC_AVCODEC_H */