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_QSCALE_TYPE_MPEG1 0
745 #define FF_QSCALE_TYPE_MPEG2 1
746 #define FF_QSCALE_TYPE_H264 2
747 #define FF_QSCALE_TYPE_VP56 3
749 #define FF_BUFFER_TYPE_INTERNAL 1
750 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
751 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
752 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
754 #if FF_API_OLD_FF_PICT_TYPES
755 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
756 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
757 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
758 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
759 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
760 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
761 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
762 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
765 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
766 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
767 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
768 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
770 enum AVPacketSideDataType {
774 typedef struct AVPacket {
776 * Presentation timestamp in AVStream->time_base units; the time at which
777 * the decompressed packet will be presented to the user.
778 * Can be AV_NOPTS_VALUE if it is not stored in the file.
779 * pts MUST be larger or equal to dts as presentation cannot happen before
780 * decompression, unless one wants to view hex dumps. Some formats misuse
781 * the terms dts and pts/cts to mean something different. Such timestamps
782 * must be converted to true pts/dts before they are stored in AVPacket.
786 * Decompression timestamp in AVStream->time_base units; the time at which
787 * the packet is decompressed.
788 * Can be AV_NOPTS_VALUE if it is not stored in the file.
796 * Additional packet data that can be provided by the container.
797 * Packet can contain several types of side information.
802 enum AVPacketSideDataType type;
807 * Duration of this packet in AVStream->time_base units, 0 if unknown.
808 * Equals next_pts - this_pts in presentation order.
811 void (*destruct)(struct AVPacket *);
813 int64_t pos; ///< byte position in stream, -1 if unknown
816 * Time difference in AVStream->time_base units from the pts of this
817 * packet to the point at which the output from the decoder has converged
818 * independent from the availability of previous frames. That is, the
819 * frames are virtually identical no matter if decoding started from
820 * the very first frame or from this keyframe.
821 * Is AV_NOPTS_VALUE if unknown.
822 * This field is not the display duration of the current packet.
823 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
826 * The purpose of this field is to allow seeking in streams that have no
827 * keyframes in the conventional sense. It corresponds to the
828 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
829 * essential for some types of subtitle streams to ensure that all
830 * subtitles are correctly displayed after seeking.
832 int64_t convergence_duration;
834 #define AV_PKT_FLAG_KEY 0x0001
838 * New fields can be added to the end of AVFRAME with minor version
839 * bumps. Removal, reordering and changes to existing fields require
840 * a major version bump.
841 * sizeof(AVFrame) must not be used outside libav*.
843 typedef struct AVFrame {
845 * pointer to the picture planes.
846 * This might be different from the first allocated byte
853 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
854 * This isn't used by libavcodec unless the default get/release_buffer() is used.
860 * 1 -> keyframe, 0-> not
861 * - encoding: Set by libavcodec.
862 * - decoding: Set by libavcodec.
867 * Picture type of the frame, see ?_TYPE below.
868 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
869 * - decoding: Set by libavcodec.
871 enum AVPictureType pict_type;
874 * presentation timestamp in time_base units (time when frame should be shown to user)
875 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
876 * - encoding: MUST be set by user.
877 * - decoding: Set by libavcodec.
882 * picture number in bitstream order
884 * - decoding: Set by libavcodec.
886 int coded_picture_number;
888 * picture number in display order
890 * - decoding: Set by libavcodec.
892 int display_picture_number;
895 * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
896 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
897 * - decoding: Set by libavcodec.
902 * buffer age (1->was last buffer and dint change, 2->..., ...).
903 * Set to INT_MAX if the buffer has not been used yet.
905 * - decoding: MUST be set by get_buffer().
910 * is this picture used as reference
911 * The values for this are the same as the MpegEncContext.picture_structure
912 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
913 * Set to 4 for delayed, non-reference frames.
915 * - decoding: Set by libavcodec. (before get_buffer() call)).
922 * - decoding: Set by libavcodec.
924 int8_t *qscale_table;
928 * - decoding: Set by libavcodec.
933 * mbskip_table[mb]>=1 if MB didn't change
934 * stride= mb_width = (width+15)>>4
936 * - decoding: Set by libavcodec.
938 uint8_t *mbskip_table;
941 * motion vector table
944 * int mv_sample_log2= 4 - motion_subsample_log2;
945 * int mb_width= (width+15)>>4;
946 * int mv_stride= (mb_width << mv_sample_log2) + 1;
947 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
949 * - encoding: Set by user.
950 * - decoding: Set by libavcodec.
952 int16_t (*motion_val[2])[2];
955 * macroblock type table
956 * mb_type_base + mb_width + 2
957 * - encoding: Set by user.
958 * - decoding: Set by libavcodec.
963 * log2 of the size of the block which a single vector in motion_val represents:
964 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
966 * - decoding: Set by libavcodec.
968 uint8_t motion_subsample_log2;
971 * for some private data of the user
973 * - decoding: Set by user.
979 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
985 * type of the buffer (to keep track of who has to deallocate data[*])
986 * - encoding: Set by the one who allocates it.
987 * - decoding: Set by the one who allocates it.
988 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
993 * When decoding, this signals how much the picture must be delayed.
994 * extra_delay = repeat_pict / (2*fps)
996 * - decoding: Set by libavcodec.
1006 * The content of the picture is interlaced.
1007 * - encoding: Set by user.
1008 * - decoding: Set by libavcodec. (default 0)
1010 int interlaced_frame;
1013 * If the content is interlaced, is top field displayed first.
1014 * - encoding: Set by user.
1015 * - decoding: Set by libavcodec.
1017 int top_field_first;
1021 * - encoding: Set by user.
1022 * - decoding: Set by libavcodec.
1024 AVPanScan *pan_scan;
1027 * Tell user application that palette has changed from previous frame.
1028 * - encoding: ??? (no palette-enabled encoder yet)
1029 * - decoding: Set by libavcodec. (default 0).
1031 int palette_has_changed;
1034 * codec suggestion on buffer type if != 0
1035 * - encoding: unused
1036 * - decoding: Set by libavcodec. (before get_buffer() call)).
1042 * - encoding: unused
1043 * - decoding: Set by libavcodec.
1048 * motion reference frame index
1049 * the order in which these are stored can depend on the codec.
1050 * - encoding: Set by user.
1051 * - decoding: Set by libavcodec.
1053 int8_t *ref_index[2];
1056 * reordered opaque 64bit (generally an integer or a double precision float
1057 * PTS but can be anything).
1058 * The user sets AVCodecContext.reordered_opaque to represent the input at
1060 * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1061 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1062 * @deprecated in favor of pkt_pts
1063 * - encoding: unused
1064 * - decoding: Read by user.
1066 int64_t reordered_opaque;
1069 * hardware accelerator private data (Libav-allocated)
1070 * - encoding: unused
1071 * - decoding: Set by libavcodec
1073 void *hwaccel_picture_private;
1076 * reordered pts from the last AVPacket that has been input into the decoder
1077 * - encoding: unused
1078 * - decoding: Read by user.
1083 * dts from the last AVPacket that has been input into the decoder
1084 * - encoding: unused
1085 * - decoding: Read by user.
1090 * the AVCodecContext which ff_thread_get_buffer() was last called on
1091 * - encoding: Set by libavcodec.
1092 * - decoding: Set by libavcodec.
1094 struct AVCodecContext *owner;
1097 * used by multithreading to store frame-specific info
1098 * - encoding: Set by libavcodec.
1099 * - decoding: Set by libavcodec.
1101 void *thread_opaque;
1105 * main external API structure.
1106 * New fields can be added to the end with minor version bumps.
1107 * Removal, reordering and changes to existing fields require a major
1109 * sizeof(AVCodecContext) must not be used outside libav*.
1111 typedef struct AVCodecContext {
1113 * information on struct for av_log
1114 * - set by avcodec_alloc_context
1116 const AVClass *av_class;
1118 * the average bitrate
1119 * - encoding: Set by user; unused for constant quantizer encoding.
1120 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1125 * number of bits the bitstream is allowed to diverge from the reference.
1126 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1127 * - encoding: Set by user; unused for constant quantizer encoding.
1128 * - decoding: unused
1130 int bit_rate_tolerance;
1134 * - encoding: Set by user.
1135 * - decoding: Set by user.
1140 * Some codecs need additional format info. It is stored here.
1141 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1142 * specific codec MUST set it correctly otherwise stream copy breaks.
1143 * In general use of this field by muxers is not recommanded.
1144 * - encoding: Set by libavcodec.
1145 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1150 * Motion estimation algorithm used for video coding.
1151 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1152 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1153 * - encoding: MUST be set by user.
1154 * - decoding: unused
1159 * some codecs need / can use extradata like Huffman tables.
1160 * mjpeg: Huffman tables
1161 * rv10: additional flags
1162 * mpeg4: global headers (they can be in the bitstream or here)
1163 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1164 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1165 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1166 * - encoding: Set/allocated/freed by libavcodec.
1167 * - decoding: Set/allocated/freed by user.
1173 * This is the fundamental unit of time (in seconds) in terms
1174 * of which frame timestamps are represented. For fixed-fps content,
1175 * timebase should be 1/framerate and timestamp increments should be
1177 * - encoding: MUST be set by user.
1178 * - decoding: Set by libavcodec.
1180 AVRational time_base;
1184 * picture width / height.
1185 * - encoding: MUST be set by user.
1186 * - decoding: Set by libavcodec.
1187 * Note: For compatibility it is possible to set this instead of
1188 * coded_width/height before decoding.
1192 #define FF_ASPECT_EXTENDED 15
1195 * the number of pictures in a group of pictures, or 0 for intra_only
1196 * - encoding: Set by user.
1197 * - decoding: unused
1202 * Pixel format, see PIX_FMT_xxx.
1203 * May be set by the demuxer if known from headers.
1204 * May be overriden by the decoder if it knows better.
1205 * - encoding: Set by user.
1206 * - decoding: Set by user if known, overridden by libavcodec if known
1208 enum PixelFormat pix_fmt;
1211 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1212 * decoder to draw a horizontal band. It improves cache usage. Not
1213 * all codecs can do that. You must check the codec capabilities
1215 * When multithreading is used, it may be called from multiple threads
1216 * at the same time; threads might draw different parts of the same AVFrame,
1217 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1219 * The function is also used by hardware acceleration APIs.
1220 * It is called at least once during frame decoding to pass
1221 * the data needed for hardware render.
1222 * In that mode instead of pixel data, AVFrame points to
1223 * a structure specific to the acceleration API. The application
1224 * reads the structure and can change some fields to indicate progress
1226 * - encoding: unused
1227 * - decoding: Set by user.
1228 * @param height the height of the slice
1229 * @param y the y position of the slice
1230 * @param type 1->top field, 2->bottom field, 3->frame
1231 * @param offset offset into the AVFrame.data from which the slice should be read
1233 void (*draw_horiz_band)(struct AVCodecContext *s,
1234 const AVFrame *src, int offset[4],
1235 int y, int type, int height);
1238 int sample_rate; ///< samples per second
1239 int channels; ///< number of audio channels
1242 * audio sample format
1243 * - encoding: Set by user.
1244 * - decoding: Set by libavcodec.
1246 enum AVSampleFormat sample_fmt; ///< sample format
1248 /* The following data should not be initialized. */
1250 * Samples per packet, initialized when calling 'init'.
1253 int frame_number; ///< audio or video frame number
1256 * Number of frames the decoded output will be delayed relative to
1257 * the encoded input.
1258 * - encoding: Set by libavcodec.
1259 * - decoding: unused
1263 /* - encoding parameters */
1264 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1265 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1269 * - encoding: Set by user.
1270 * - decoding: unused
1276 * - encoding: Set by user.
1277 * - decoding: unused
1282 * maximum quantizer difference between frames
1283 * - encoding: Set by user.
1284 * - decoding: unused
1289 * maximum number of B-frames between non-B-frames
1290 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1291 * - encoding: Set by user.
1292 * - decoding: unused
1297 * qscale factor between IP and B-frames
1298 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1299 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1300 * - encoding: Set by user.
1301 * - decoding: unused
1303 float b_quant_factor;
1305 /** obsolete FIXME remove */
1307 #define FF_RC_STRATEGY_XVID 1
1309 int b_frame_strategy;
1311 struct AVCodec *codec;
1315 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1316 /* do its best to deliver a chunk with size */
1317 /* below rtp_payload_size, the chunk will start */
1318 /* with a start code on some codecs like H.263. */
1319 /* This doesn't take account of any particular */
1320 /* headers inside the transmitted RTP payload. */
1323 /* The RTP callback: This function is called */
1324 /* every time the encoder has a packet to send. */
1325 /* It depends on the encoder if the data starts */
1326 /* with a Start Code (it should). H.263 does. */
1327 /* mb_nb contains the number of macroblocks */
1328 /* encoded in the RTP payload. */
1329 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1331 /* statistics, used for 2-pass encoding */
1342 * number of bits used for the previously encoded frame
1343 * - encoding: Set by libavcodec.
1344 * - decoding: unused
1349 * Private data of the user, can be used to carry app specific stuff.
1350 * - encoding: Set by user.
1351 * - decoding: Set by user.
1355 char codec_name[32];
1356 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1357 enum CodecID codec_id; /* see CODEC_ID_xxx */
1360 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1361 * This is used to work around some encoder bugs.
1362 * A demuxer should set this to what is stored in the field used to identify the codec.
1363 * If there are multiple such fields in a container then the demuxer should choose the one
1364 * which maximizes the information about the used codec.
1365 * If the codec tag field in a container is larger than 32 bits then the demuxer should
1366 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1367 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1369 * - encoding: Set by user, if not then the default based on codec_id will be used.
1370 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1372 unsigned int codec_tag;
1375 * Work around bugs in encoders which sometimes cannot be detected automatically.
1376 * - encoding: Set by user
1377 * - decoding: Set by user
1379 int workaround_bugs;
1380 #define FF_BUG_AUTODETECT 1 ///< autodetection
1381 #define FF_BUG_OLD_MSMPEG4 2
1382 #define FF_BUG_XVID_ILACE 4
1383 #define FF_BUG_UMP4 8
1384 #define FF_BUG_NO_PADDING 16
1385 #define FF_BUG_AMV 32
1386 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1387 #define FF_BUG_QPEL_CHROMA 64
1388 #define FF_BUG_STD_QPEL 128
1389 #define FF_BUG_QPEL_CHROMA2 256
1390 #define FF_BUG_DIRECT_BLOCKSIZE 512
1391 #define FF_BUG_EDGE 1024
1392 #define FF_BUG_HPEL_CHROMA 2048
1393 #define FF_BUG_DC_CLIP 4096
1394 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1395 #define FF_BUG_TRUNCATED 16384
1396 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1399 * luma single coefficient elimination threshold
1400 * - encoding: Set by user.
1401 * - decoding: unused
1403 int luma_elim_threshold;
1406 * chroma single coeff elimination threshold
1407 * - encoding: Set by user.
1408 * - decoding: unused
1410 int chroma_elim_threshold;
1413 * strictly follow the standard (MPEG4, ...).
1414 * - encoding: Set by user.
1415 * - decoding: Set by user.
1416 * Setting this to STRICT or higher means the encoder and decoder will
1417 * generally do stupid things, whereas setting it to unofficial or lower
1418 * will mean the encoder might produce output that is not supported by all
1419 * spec-compliant decoders. Decoders don't differentiate between normal,
1420 * unofficial and experimental (that is, they always try to decode things
1421 * when they can) unless they are explicitly asked to behave stupidly
1422 * (=strictly conform to the specs)
1424 int strict_std_compliance;
1425 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1426 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1427 #define FF_COMPLIANCE_NORMAL 0
1428 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1429 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1432 * qscale offset between IP and B-frames
1433 * - encoding: Set by user.
1434 * - decoding: unused
1436 float b_quant_offset;
1439 * Error recognization; higher values will detect more errors but may
1440 * misdetect some more or less valid parts as errors.
1441 * - encoding: unused
1442 * - decoding: Set by user.
1444 int error_recognition;
1445 #define FF_ER_CAREFUL 1
1446 #define FF_ER_COMPLIANT 2
1447 #define FF_ER_AGGRESSIVE 3
1448 #define FF_ER_VERY_AGGRESSIVE 4
1449 #define FF_ER_EXPLODE 5
1452 * Called at the beginning of each frame to get a buffer for it.
1453 * If pic.reference is set then the frame will be read later by libavcodec.
1454 * avcodec_align_dimensions2() should be used to find the required width and
1455 * height, as they normally need to be rounded up to the next multiple of 16.
1456 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1457 * avcodec_default_get_buffer() instead of providing buffers allocated by
1459 * If frame multithreading is used and thread_safe_callbacks is set,
1460 * it may be called from a different thread, but not from more than one at once.
1461 * Does not need to be reentrant.
1462 * - encoding: unused
1463 * - decoding: Set by libavcodec, user can override.
1465 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1468 * Called to release buffers which were allocated with get_buffer.
1469 * A released buffer can be reused in get_buffer().
1470 * pic.data[*] must be set to NULL.
1471 * May be called from a different thread if frame multithreading is used,
1472 * but not by more than one thread at once, so does not need to be reentrant.
1473 * - encoding: unused
1474 * - decoding: Set by libavcodec, user can override.
1476 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1479 * Size of the frame reordering buffer in the decoder.
1480 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1481 * - encoding: Set by libavcodec.
1482 * - decoding: Set by libavcodec.
1487 * number of bytes per packet if constant and known or 0
1488 * Used by some WAV based audio codecs.
1492 int parse_only; /* - decoding only: If true, only parsing is done
1493 (function avcodec_parse_frame()). The frame
1494 data is returned. Only MPEG codecs support this now. */
1497 * 0-> h263 quant 1-> mpeg quant
1498 * - encoding: Set by user.
1499 * - decoding: unused
1504 * pass1 encoding statistics output buffer
1505 * - encoding: Set by libavcodec.
1506 * - decoding: unused
1511 * pass2 encoding statistics input buffer
1512 * Concatenated stuff from stats_out of pass1 should be placed here.
1513 * - encoding: Allocated/set/freed by user.
1514 * - decoding: unused
1519 * ratecontrol qmin qmax limiting method
1520 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1521 * - encoding: Set by user.
1522 * - decoding: unused
1530 * ratecontrol override, see RcOverride
1531 * - encoding: Allocated/set/freed by user.
1532 * - decoding: unused
1534 RcOverride *rc_override;
1535 int rc_override_count;
1538 * rate control equation
1539 * - encoding: Set by user
1540 * - decoding: unused
1546 * - encoding: Set by user.
1547 * - decoding: unused
1553 * - encoding: Set by user.
1554 * - decoding: unused
1559 * decoder bitstream buffer size
1560 * - encoding: Set by user.
1561 * - decoding: unused
1564 float rc_buffer_aggressivity;
1567 * qscale factor between P and I-frames
1568 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1569 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1570 * - encoding: Set by user.
1571 * - decoding: unused
1573 float i_quant_factor;
1576 * qscale offset between P and I-frames
1577 * - encoding: Set by user.
1578 * - decoding: unused
1580 float i_quant_offset;
1583 * initial complexity for pass1 ratecontrol
1584 * - encoding: Set by user.
1585 * - decoding: unused
1587 float rc_initial_cplx;
1590 * DCT algorithm, see FF_DCT_* below
1591 * - encoding: Set by user.
1592 * - decoding: unused
1595 #define FF_DCT_AUTO 0
1596 #define FF_DCT_FASTINT 1
1597 #define FF_DCT_INT 2
1598 #define FF_DCT_MMX 3
1599 #define FF_DCT_MLIB 4
1600 #define FF_DCT_ALTIVEC 5
1601 #define FF_DCT_FAAN 6
1604 * luminance masking (0-> disabled)
1605 * - encoding: Set by user.
1606 * - decoding: unused
1611 * temporary complexity masking (0-> disabled)
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 float temporal_cplx_masking;
1618 * spatial complexity masking (0-> disabled)
1619 * - encoding: Set by user.
1620 * - decoding: unused
1622 float spatial_cplx_masking;
1625 * p block masking (0-> disabled)
1626 * - encoding: Set by user.
1627 * - decoding: unused
1632 * darkness masking (0-> disabled)
1633 * - encoding: Set by user.
1634 * - decoding: unused
1639 * IDCT algorithm, see FF_IDCT_* below.
1640 * - encoding: Set by user.
1641 * - decoding: Set by user.
1644 #define FF_IDCT_AUTO 0
1645 #define FF_IDCT_INT 1
1646 #define FF_IDCT_SIMPLE 2
1647 #define FF_IDCT_SIMPLEMMX 3
1648 #define FF_IDCT_LIBMPEG2MMX 4
1649 #define FF_IDCT_PS2 5
1650 #define FF_IDCT_MLIB 6
1651 #define FF_IDCT_ARM 7
1652 #define FF_IDCT_ALTIVEC 8
1653 #define FF_IDCT_SH4 9
1654 #define FF_IDCT_SIMPLEARM 10
1655 #define FF_IDCT_H264 11
1656 #define FF_IDCT_VP3 12
1657 #define FF_IDCT_IPP 13
1658 #define FF_IDCT_XVIDMMX 14
1659 #define FF_IDCT_CAVS 15
1660 #define FF_IDCT_SIMPLEARMV5TE 16
1661 #define FF_IDCT_SIMPLEARMV6 17
1662 #define FF_IDCT_SIMPLEVIS 18
1663 #define FF_IDCT_WMV2 19
1664 #define FF_IDCT_FAAN 20
1665 #define FF_IDCT_EA 21
1666 #define FF_IDCT_SIMPLENEON 22
1667 #define FF_IDCT_SIMPLEALPHA 23
1668 #define FF_IDCT_BINK 24
1672 * - encoding: Set by libavcodec.
1673 * - decoding: Set by user (or 0).
1677 * slice offsets in the frame in bytes
1678 * - encoding: Set/allocated by libavcodec.
1679 * - decoding: Set/allocated by user (or NULL).
1684 * error concealment flags
1685 * - encoding: unused
1686 * - decoding: Set by user.
1688 int error_concealment;
1689 #define FF_EC_GUESS_MVS 1
1690 #define FF_EC_DEBLOCK 2
1693 * dsp_mask could be add used to disable unwanted CPU features
1694 * CPU features (i.e. MMX, SSE. ...)
1696 * With the FORCE flag you may instead enable given CPU features.
1697 * (Dangerous: Usable in case of misdetection, improper usage however will
1698 * result into program crash.)
1703 * bits per sample/pixel from the demuxer (needed for huffyuv).
1704 * - encoding: Set by libavcodec.
1705 * - decoding: Set by user.
1707 int bits_per_coded_sample;
1710 * prediction method (needed for huffyuv)
1711 * - encoding: Set by user.
1712 * - decoding: unused
1714 int prediction_method;
1715 #define FF_PRED_LEFT 0
1716 #define FF_PRED_PLANE 1
1717 #define FF_PRED_MEDIAN 2
1720 * sample aspect ratio (0 if unknown)
1721 * That is the width of a pixel divided by the height of the pixel.
1722 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1723 * - encoding: Set by user.
1724 * - decoding: Set by libavcodec.
1726 AVRational sample_aspect_ratio;
1729 * the picture in the bitstream
1730 * - encoding: Set by libavcodec.
1731 * - decoding: Set by libavcodec.
1733 AVFrame *coded_frame;
1737 * - encoding: Set by user.
1738 * - decoding: Set by user.
1741 #define FF_DEBUG_PICT_INFO 1
1742 #define FF_DEBUG_RC 2
1743 #define FF_DEBUG_BITSTREAM 4
1744 #define FF_DEBUG_MB_TYPE 8
1745 #define FF_DEBUG_QP 16
1746 #define FF_DEBUG_MV 32
1747 #define FF_DEBUG_DCT_COEFF 0x00000040
1748 #define FF_DEBUG_SKIP 0x00000080
1749 #define FF_DEBUG_STARTCODE 0x00000100
1750 #define FF_DEBUG_PTS 0x00000200
1751 #define FF_DEBUG_ER 0x00000400
1752 #define FF_DEBUG_MMCO 0x00000800
1753 #define FF_DEBUG_BUGS 0x00001000
1754 #define FF_DEBUG_VIS_QP 0x00002000
1755 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1756 #define FF_DEBUG_BUFFERS 0x00008000
1757 #define FF_DEBUG_THREADS 0x00010000
1761 * - encoding: Set by user.
1762 * - decoding: Set by user.
1765 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1766 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1767 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1771 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1772 * - decoding: unused
1777 * motion estimation comparison function
1778 * - encoding: Set by user.
1779 * - decoding: unused
1783 * subpixel motion estimation comparison function
1784 * - encoding: Set by user.
1785 * - decoding: unused
1789 * macroblock comparison function (not supported yet)
1790 * - encoding: Set by user.
1791 * - decoding: unused
1795 * interlaced DCT comparison function
1796 * - encoding: Set by user.
1797 * - decoding: unused
1800 #define FF_CMP_SAD 0
1801 #define FF_CMP_SSE 1
1802 #define FF_CMP_SATD 2
1803 #define FF_CMP_DCT 3
1804 #define FF_CMP_PSNR 4
1805 #define FF_CMP_BIT 5
1807 #define FF_CMP_ZERO 7
1808 #define FF_CMP_VSAD 8
1809 #define FF_CMP_VSSE 9
1810 #define FF_CMP_NSSE 10
1811 #define FF_CMP_W53 11
1812 #define FF_CMP_W97 12
1813 #define FF_CMP_DCTMAX 13
1814 #define FF_CMP_DCT264 14
1815 #define FF_CMP_CHROMA 256
1818 * ME diamond size & shape
1819 * - encoding: Set by user.
1820 * - decoding: unused
1825 * amount of previous MV predictors (2a+1 x 2a+1 square)
1826 * - encoding: Set by user.
1827 * - decoding: unused
1829 int last_predictor_count;
1832 * prepass for motion estimation
1833 * - encoding: Set by user.
1834 * - decoding: unused
1839 * motion estimation prepass comparison function
1840 * - encoding: Set by user.
1841 * - decoding: unused
1846 * ME prepass diamond size & shape
1847 * - encoding: Set by user.
1848 * - decoding: unused
1854 * - encoding: Set by user.
1855 * - decoding: unused
1857 int me_subpel_quality;
1860 * callback to negotiate the pixelFormat
1861 * @param fmt is the list of formats which are supported by the codec,
1862 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1863 * The first is always the native one.
1864 * @return the chosen format
1865 * - encoding: unused
1866 * - decoding: Set by user, if not set the native format will be chosen.
1868 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1871 * DTG active format information (additional aspect ratio
1872 * information only used in DVB MPEG-2 transport streams)
1875 * - encoding: unused
1876 * - decoding: Set by decoder.
1878 int dtg_active_format;
1879 #define FF_DTG_AFD_SAME 8
1880 #define FF_DTG_AFD_4_3 9
1881 #define FF_DTG_AFD_16_9 10
1882 #define FF_DTG_AFD_14_9 11
1883 #define FF_DTG_AFD_4_3_SP_14_9 13
1884 #define FF_DTG_AFD_16_9_SP_14_9 14
1885 #define FF_DTG_AFD_SP_4_3 15
1888 * maximum motion estimation search range in subpel units
1889 * If 0 then no limit.
1891 * - encoding: Set by user.
1892 * - decoding: unused
1897 * intra quantizer bias
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 int intra_quant_bias;
1902 #define FF_DEFAULT_QUANT_BIAS 999999
1905 * inter quantizer bias
1906 * - encoding: Set by user.
1907 * - decoding: unused
1909 int inter_quant_bias;
1913 * - encoding: unused
1914 * - decoding: Which clrtable should be used for 8bit RGB images.
1915 * Tables have to be stored somewhere. FIXME
1920 * internal_buffer count
1921 * Don't touch, used by libavcodec default_get_buffer().
1923 int internal_buffer_count;
1927 * Don't touch, used by libavcodec default_get_buffer().
1929 void *internal_buffer;
1932 * Global quality for codecs which cannot change it per frame.
1933 * This should be proportional to MPEG-1/2/4 qscale.
1934 * - encoding: Set by user.
1935 * - decoding: unused
1939 #define FF_CODER_TYPE_VLC 0
1940 #define FF_CODER_TYPE_AC 1
1941 #define FF_CODER_TYPE_RAW 2
1942 #define FF_CODER_TYPE_RLE 3
1943 #define FF_CODER_TYPE_DEFLATE 4
1946 * - encoding: Set by user.
1947 * - decoding: unused
1953 * - encoding: Set by user.
1954 * - decoding: unused
1960 * - encoding: unused
1961 * - decoding: Set by user.
1963 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1968 * - encoding: unused
1969 * - decoding: Set by user.
1972 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1973 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1974 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1977 * XVideo Motion Acceleration
1978 * - encoding: forbidden
1979 * - decoding: set by decoder
1981 int xvmc_acceleration;
1984 * macroblock decision mode
1985 * - encoding: Set by user.
1986 * - decoding: unused
1989 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1990 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1991 #define FF_MB_DECISION_RD 2 ///< rate distortion
1994 * custom intra quantization matrix
1995 * - encoding: Set by user, can be NULL.
1996 * - decoding: Set by libavcodec.
1998 uint16_t *intra_matrix;
2001 * custom inter quantization matrix
2002 * - encoding: Set by user, can be NULL.
2003 * - decoding: Set by libavcodec.
2005 uint16_t *inter_matrix;
2008 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2009 * This is used to work around some encoder bugs.
2010 * - encoding: unused
2011 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2013 unsigned int stream_codec_tag;
2016 * scene change detection threshold
2017 * 0 is default, larger means fewer detected scene changes.
2018 * - encoding: Set by user.
2019 * - decoding: unused
2021 int scenechange_threshold;
2024 * minimum Lagrange multipler
2025 * - encoding: Set by user.
2026 * - decoding: unused
2031 * maximum Lagrange multipler
2032 * - encoding: Set by user.
2033 * - decoding: unused
2037 #if FF_API_PALETTE_CONTROL
2039 * palette control structure
2040 * - encoding: ??? (no palette-enabled encoder yet)
2041 * - decoding: Set by user.
2043 struct AVPaletteControl *palctrl;
2047 * noise reduction strength
2048 * - encoding: Set by user.
2049 * - decoding: unused
2051 int noise_reduction;
2054 * Called at the beginning of a frame to get cr buffer for it.
2055 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2056 * libavcodec will pass previous buffer in pic, function should return
2057 * same buffer or new buffer with old frame "painted" into it.
2058 * If pic.data[0] == NULL must behave like get_buffer().
2059 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2060 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2062 * - encoding: unused
2063 * - decoding: Set by libavcodec, user can override.
2065 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2068 * Number of bits which should be loaded into the rc buffer before decoding starts.
2069 * - encoding: Set by user.
2070 * - decoding: unused
2072 int rc_initial_buffer_occupancy;
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 int inter_threshold;
2083 * - encoding: Set by user.
2084 * - decoding: Set by user.
2089 * Simulates errors in the bitstream to test error concealment.
2090 * - encoding: Set by user.
2091 * - decoding: unused
2095 #if FF_API_ANTIALIAS_ALGO
2097 * MP3 antialias algorithm, see FF_AA_* below.
2098 * - encoding: unused
2099 * - decoding: Set by user.
2101 attribute_deprecated int antialias_algo;
2102 #define FF_AA_AUTO 0
2103 #define FF_AA_FASTINT 1 //not implemented yet
2105 #define FF_AA_FLOAT 3
2109 * quantizer noise shaping
2110 * - encoding: Set by user.
2111 * - decoding: unused
2113 int quantizer_noise_shaping;
2117 * is used to decide how many independent tasks should be passed to execute()
2118 * - encoding: Set by user.
2119 * - decoding: Set by user.
2124 * The codec may call this to execute several independent things.
2125 * It will return only after finishing all tasks.
2126 * The user may replace this with some multithreaded implementation,
2127 * the default implementation will execute the parts serially.
2128 * @param count the number of things to execute
2129 * - encoding: Set by libavcodec, user can override.
2130 * - decoding: Set by libavcodec, user can override.
2132 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2136 * Can be used by execute() to store some per AVCodecContext stuff.
2137 * - encoding: set by execute()
2138 * - decoding: set by execute()
2140 void *thread_opaque;
2143 * Motion estimation threshold below which no motion estimation is
2144 * performed, but instead the user specified motion vectors are used.
2146 * - encoding: Set by user.
2147 * - decoding: unused
2152 * Macroblock threshold below which the user specified macroblock types will be used.
2153 * - encoding: Set by user.
2154 * - decoding: unused
2159 * precision of the intra DC coefficient - 8
2160 * - encoding: Set by user.
2161 * - decoding: unused
2163 int intra_dc_precision;
2166 * noise vs. sse weight for the nsse comparsion function
2167 * - encoding: Set by user.
2168 * - decoding: unused
2173 * Number of macroblock rows at the top which are skipped.
2174 * - encoding: unused
2175 * - decoding: Set by user.
2180 * Number of macroblock rows at the bottom which are skipped.
2181 * - encoding: unused
2182 * - decoding: Set by user.
2188 * - encoding: Set by user.
2189 * - decoding: Set by libavcodec.
2192 #define FF_PROFILE_UNKNOWN -99
2193 #define FF_PROFILE_RESERVED -100
2195 #define FF_PROFILE_AAC_MAIN 0
2196 #define FF_PROFILE_AAC_LOW 1
2197 #define FF_PROFILE_AAC_SSR 2
2198 #define FF_PROFILE_AAC_LTP 3
2200 #define FF_PROFILE_DTS 20
2201 #define FF_PROFILE_DTS_ES 30
2202 #define FF_PROFILE_DTS_96_24 40
2203 #define FF_PROFILE_DTS_HD_HRA 50
2204 #define FF_PROFILE_DTS_HD_MA 60
2206 #define FF_PROFILE_MPEG2_422 0
2207 #define FF_PROFILE_MPEG2_HIGH 1
2208 #define FF_PROFILE_MPEG2_SS 2
2209 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2210 #define FF_PROFILE_MPEG2_MAIN 4
2211 #define FF_PROFILE_MPEG2_SIMPLE 5
2213 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2214 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2216 #define FF_PROFILE_H264_BASELINE 66
2217 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2218 #define FF_PROFILE_H264_MAIN 77
2219 #define FF_PROFILE_H264_EXTENDED 88
2220 #define FF_PROFILE_H264_HIGH 100
2221 #define FF_PROFILE_H264_HIGH_10 110
2222 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2223 #define FF_PROFILE_H264_HIGH_422 122
2224 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2225 #define FF_PROFILE_H264_HIGH_444 144
2226 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2227 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2228 #define FF_PROFILE_H264_CAVLC_444 44
2230 #define FF_PROFILE_VC1_SIMPLE 0
2231 #define FF_PROFILE_VC1_MAIN 1
2232 #define FF_PROFILE_VC1_COMPLEX 2
2233 #define FF_PROFILE_VC1_ADVANCED 3
2235 #define FF_PROFILE_MPEG4_SIMPLE 0
2236 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE 1
2237 #define FF_PROFILE_MPEG4_CORE 2
2238 #define FF_PROFILE_MPEG4_MAIN 3
2239 #define FF_PROFILE_MPEG4_N_BIT 4
2240 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE 5
2241 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION 6
2242 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE 7
2243 #define FF_PROFILE_MPEG4_HYBRID 8
2244 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME 9
2245 #define FF_PROFILE_MPEG4_CORE_SCALABLE 10
2246 #define FF_PROFILE_MPEG4_ADVANCED_CODING 11
2247 #define FF_PROFILE_MPEG4_ADVANCED_CORE 12
2248 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2249 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO 14
2250 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE 15
2254 * - encoding: Set by user.
2255 * - decoding: Set by libavcodec.
2258 #define FF_LEVEL_UNKNOWN -99
2261 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2262 * - encoding: unused
2263 * - decoding: Set by user.
2268 * Bitstream width / height, may be different from width/height if lowres
2269 * or other things are used.
2270 * - encoding: unused
2271 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2273 int coded_width, coded_height;
2276 * frame skip threshold
2277 * - encoding: Set by user.
2278 * - decoding: unused
2280 int frame_skip_threshold;
2284 * - encoding: Set by user.
2285 * - decoding: unused
2287 int frame_skip_factor;
2290 * frame skip exponent
2291 * - encoding: Set by user.
2292 * - decoding: unused
2297 * frame skip comparison function
2298 * - encoding: Set by user.
2299 * - decoding: unused
2304 * Border processing masking, raises the quantizer for mbs on the borders
2306 * - encoding: Set by user.
2307 * - decoding: unused
2309 float border_masking;
2312 * minimum MB lagrange multipler
2313 * - encoding: Set by user.
2314 * - decoding: unused
2319 * maximum MB lagrange multipler
2320 * - encoding: Set by user.
2321 * - decoding: unused
2327 * - encoding: Set by user.
2328 * - decoding: unused
2330 int me_penalty_compensation;
2334 * - encoding: unused
2335 * - decoding: Set by user.
2337 enum AVDiscard skip_loop_filter;
2341 * - encoding: unused
2342 * - decoding: Set by user.
2344 enum AVDiscard skip_idct;
2348 * - encoding: unused
2349 * - decoding: Set by user.
2351 enum AVDiscard skip_frame;
2355 * - encoding: Set by user.
2356 * - decoding: unused
2362 * - encoding: Set by user.
2363 * - decoding: unused
2368 * constant rate factor - quality-based VBR - values ~correspond to qps
2369 * - encoding: Set by user.
2370 * - decoding: unused
2375 * constant quantization parameter rate control method
2376 * - encoding: Set by user.
2377 * - decoding: unused
2383 * - encoding: Set by user.
2384 * - decoding: unused
2389 * number of reference frames
2390 * - encoding: Set by user.
2391 * - decoding: Set by lavc.
2396 * chroma qp offset from luma
2397 * - encoding: Set by user.
2398 * - decoding: unused
2403 * Influences how often B-frames are used.
2404 * - encoding: Set by user.
2405 * - decoding: unused
2410 * trellis RD quantization
2411 * - encoding: Set by user.
2412 * - decoding: unused
2417 * Reduce fluctuations in qp (before curve compression).
2418 * - encoding: Set by user.
2419 * - decoding: unused
2421 float complexityblur;
2424 * in-loop deblocking filter alphac0 parameter
2425 * alpha is in the range -6...6
2426 * - encoding: Set by user.
2427 * - decoding: unused
2432 * in-loop deblocking filter beta parameter
2433 * beta is in the range -6...6
2434 * - encoding: Set by user.
2435 * - decoding: unused
2440 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2441 * - encoding: Set by user.
2442 * - decoding: unused
2445 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2446 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2447 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2448 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2449 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2452 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2453 * - encoding: Set by user.
2454 * - decoding: unused
2459 * Audio cutoff bandwidth (0 means "automatic")
2460 * - encoding: Set by user.
2461 * - decoding: unused
2466 * Multiplied by qscale for each frame and added to scene_change_score.
2467 * - encoding: Set by user.
2468 * - decoding: unused
2470 int scenechange_factor;
2474 * Note: Value depends upon the compare function used for fullpel ME.
2475 * - encoding: Set by user.
2476 * - decoding: unused
2481 * Adjusts sensitivity of b_frame_strategy 1.
2482 * - encoding: Set by user.
2483 * - decoding: unused
2488 * - encoding: Set by user.
2489 * - decoding: unused
2491 int compression_level;
2492 #define FF_COMPRESSION_DEFAULT -1
2495 * - encoding: Set by user.
2496 * - decoding: unused
2498 int min_prediction_order;
2501 * - encoding: Set by user.
2502 * - decoding: unused
2504 int max_prediction_order;
2506 #if FF_API_FLAC_GLOBAL_OPTS
2508 * @name FLAC options
2509 * @deprecated Use FLAC encoder private options instead.
2514 * LPC coefficient precision - used by FLAC encoder
2515 * - encoding: Set by user.
2516 * - decoding: unused
2518 attribute_deprecated int lpc_coeff_precision;
2521 * search method for selecting prediction order
2522 * - encoding: Set by user.
2523 * - decoding: unused
2525 attribute_deprecated int prediction_order_method;
2528 * - encoding: Set by user.
2529 * - decoding: unused
2531 attribute_deprecated int min_partition_order;
2534 * - encoding: Set by user.
2535 * - decoding: unused
2537 attribute_deprecated int max_partition_order;
2544 * GOP timecode frame start number, in non drop frame format
2545 * - encoding: Set by user.
2546 * - decoding: unused
2548 int64_t timecode_frame_start;
2550 #if FF_API_REQUEST_CHANNELS
2552 * Decoder should decode to this many channels if it can (0 for default)
2553 * - encoding: unused
2554 * - decoding: Set by user.
2555 * @deprecated Deprecated in favor of request_channel_layout.
2557 int request_channels;
2560 #if FF_API_DRC_SCALE
2562 * Percentage of dynamic range compression to be applied by the decoder.
2563 * The default value is 1.0, corresponding to full compression.
2564 * - encoding: unused
2565 * - decoding: Set by user.
2566 * @deprecated use AC3 decoder private option instead.
2568 attribute_deprecated float drc_scale;
2572 * opaque 64bit number (generally a PTS) that will be reordered and
2573 * output in AVFrame.reordered_opaque
2574 * @deprecated in favor of pkt_pts
2575 * - encoding: unused
2576 * - decoding: Set by user.
2578 int64_t reordered_opaque;
2581 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2582 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2583 * - encoding: set by user.
2584 * - decoding: set by libavcodec.
2586 int bits_per_raw_sample;
2589 * Audio channel layout.
2590 * - encoding: set by user.
2591 * - decoding: set by libavcodec.
2593 int64_t channel_layout;
2596 * Request decoder to use this channel layout if it can (0 for default)
2597 * - encoding: unused
2598 * - decoding: Set by user.
2600 int64_t request_channel_layout;
2603 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2604 * - encoding: Set by user.
2605 * - decoding: unused.
2607 float rc_max_available_vbv_use;
2610 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2611 * - encoding: Set by user.
2612 * - decoding: unused.
2614 float rc_min_vbv_overflow_use;
2617 * Hardware accelerator in use
2618 * - encoding: unused.
2619 * - decoding: Set by libavcodec
2621 struct AVHWAccel *hwaccel;
2624 * For some codecs, the time base is closer to the field rate than the frame rate.
2625 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2626 * if no telecine is used ...
2628 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2630 int ticks_per_frame;
2633 * Hardware accelerator context.
2634 * For some hardware accelerators, a global context needs to be
2635 * provided by the user. In that case, this holds display-dependent
2636 * data Libav cannot instantiate itself. Please refer to the
2637 * Libav HW accelerator documentation to know how to fill this
2638 * is. e.g. for VA API, this is a struct vaapi_context.
2639 * - encoding: unused
2640 * - decoding: Set by user
2642 void *hwaccel_context;
2645 * Chromaticity coordinates of the source primaries.
2646 * - encoding: Set by user
2647 * - decoding: Set by libavcodec
2649 enum AVColorPrimaries color_primaries;
2652 * Color Transfer Characteristic.
2653 * - encoding: Set by user
2654 * - decoding: Set by libavcodec
2656 enum AVColorTransferCharacteristic color_trc;
2659 * YUV colorspace type.
2660 * - encoding: Set by user
2661 * - decoding: Set by libavcodec
2663 enum AVColorSpace colorspace;
2666 * MPEG vs JPEG YUV range.
2667 * - encoding: Set by user
2668 * - decoding: Set by libavcodec
2670 enum AVColorRange color_range;
2673 * This defines the location of chroma samples.
2674 * - encoding: Set by user
2675 * - decoding: Set by libavcodec
2677 enum AVChromaLocation chroma_sample_location;
2680 * The codec may call this to execute several independent things.
2681 * It will return only after finishing all tasks.
2682 * The user may replace this with some multithreaded implementation,
2683 * the default implementation will execute the parts serially.
2684 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2685 * @param c context passed also to func
2686 * @param count the number of things to execute
2687 * @param arg2 argument passed unchanged to func
2688 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2689 * @param func function that will be called count times, with jobnr from 0 to count-1.
2690 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2691 * two instances of func executing at the same time will have the same threadnr.
2692 * @return always 0 currently, but code should handle a future improvement where when any call to func
2693 * returns < 0 no further calls to func may be done and < 0 is returned.
2694 * - encoding: Set by libavcodec, user can override.
2695 * - decoding: Set by libavcodec, user can override.
2697 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2700 * explicit P-frame weighted prediction analysis method
2702 * 1: fast blind weighting (one reference duplicate with -1 offset)
2703 * 2: smart weighting (full fade detection analysis)
2704 * - encoding: Set by user.
2705 * - decoding: unused
2707 int weighted_p_pred;
2712 * 1: Variance AQ (complexity mask)
2713 * 2: Auto-variance AQ (experimental)
2714 * - encoding: Set by user
2715 * - decoding: unused
2721 * Reduces blocking and blurring in flat and textured areas.
2722 * - encoding: Set by user
2723 * - decoding: unused
2729 * Strength of psychovisual optimization
2730 * - encoding: Set by user
2731 * - decoding: unused
2737 * Strength of psychovisual optimization
2738 * - encoding: Set by user
2739 * - decoding: unused
2745 * Number of frames for frametype and ratecontrol lookahead
2746 * - encoding: Set by user
2747 * - decoding: unused
2752 * Constant rate factor maximum
2753 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2754 * than crf_max, even if doing so would violate VBV restrictions.
2755 * - encoding: Set by user.
2756 * - decoding: unused
2760 int log_level_offset;
2762 #if FF_API_FLAC_GLOBAL_OPTS
2764 * Determines which LPC analysis algorithm to use.
2765 * - encoding: Set by user
2766 * - decoding: unused
2768 attribute_deprecated enum AVLPCType lpc_type;
2771 * Number of passes to use for Cholesky factorization during LPC analysis
2772 * - encoding: Set by user
2773 * - decoding: unused
2775 attribute_deprecated int lpc_passes;
2780 * Indicates number of picture subdivisions. Used for parallelized
2782 * - encoding: Set by user
2783 * - decoding: unused
2788 * Header containing style information for text subtitles.
2789 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2790 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2791 * the Format line following. It shouldn't include any Dialogue line.
2792 * - encoding: Set/allocated/freed by user (before avcodec_open())
2793 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2795 uint8_t *subtitle_header;
2796 int subtitle_header_size;
2799 * Current packet as passed into the decoder, to avoid having
2800 * to pass the packet into every function. Currently only valid
2801 * inside lavc and get/release_buffer callbacks.
2802 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2803 * - encoding: unused
2808 * Whether this is a copy of the context which had init() called on it.
2809 * This is used by multithreading - shared tables and picture pointers
2810 * should be freed from the original context only.
2811 * - encoding: Set by libavcodec.
2812 * - decoding: Set by libavcodec.
2817 * Which multithreading methods to use.
2818 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2819 * so clients which cannot provide future frames should not use it.
2821 * - encoding: Set by user, otherwise the default is used.
2822 * - decoding: Set by user, otherwise the default is used.
2825 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2826 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2829 * Which multithreading methods are in use by the codec.
2830 * - encoding: Set by libavcodec.
2831 * - decoding: Set by libavcodec.
2833 int active_thread_type;
2836 * Set by the client if its custom get_buffer() callback can be called
2837 * from another thread, which allows faster multithreaded decoding.
2838 * draw_horiz_band() will be called from other threads regardless of this setting.
2839 * Ignored if the default get_buffer() is used.
2840 * - encoding: Set by user.
2841 * - decoding: Set by user.
2843 int thread_safe_callbacks;
2846 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2847 * Used for compliant TS muxing.
2848 * - encoding: Set by libavcodec.
2849 * - decoding: unused.
2854 * Type of service that the audio stream conveys.
2855 * - encoding: Set by user.
2856 * - decoding: Set by libavcodec.
2858 enum AVAudioServiceType audio_service_type;
2861 * Used to request a sample format from the decoder.
2862 * - encoding: unused.
2863 * - decoding: Set by user.
2865 enum AVSampleFormat request_sample_fmt;
2871 typedef struct AVProfile {
2873 const char *name; ///< short name for the profile
2876 typedef struct AVCodecDefault AVCodecDefault;
2881 typedef struct AVCodec {
2883 * Name of the codec implementation.
2884 * The name is globally unique among encoders and among decoders (but an
2885 * encoder and a decoder can share the same name).
2886 * This is the primary way to find a codec from the user perspective.
2889 enum AVMediaType type;
2892 int (*init)(AVCodecContext *);
2893 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2894 int (*close)(AVCodecContext *);
2895 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2897 * Codec capabilities.
2901 struct AVCodec *next;
2904 * Will be called when seeking
2906 void (*flush)(AVCodecContext *);
2907 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2908 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2910 * Descriptive name for the codec, meant to be more human readable than name.
2911 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2913 const char *long_name;
2914 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2915 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2916 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2917 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2918 const AVClass *priv_class; ///< AVClass for the private context
2919 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2922 * @name Frame-level threading support functions
2926 * If defined, called on thread contexts when they are created.
2927 * If the codec allocates writable tables in init(), re-allocate them here.
2928 * priv_data will be set to a copy of the original.
2930 int (*init_thread_copy)(AVCodecContext *);
2932 * Copy necessary context variables from a previous thread context to the current one.
2933 * If not defined, the next thread will start automatically; otherwise, the codec
2934 * must call ff_thread_finish_setup().
2936 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2938 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2942 * Private codec-specific defaults.
2944 const AVCodecDefault *defaults;
2950 typedef struct AVHWAccel {
2952 * Name of the hardware accelerated codec.
2953 * The name is globally unique among encoders and among decoders (but an
2954 * encoder and a decoder can share the same name).
2959 * Type of codec implemented by the hardware accelerator.
2961 * See AVMEDIA_TYPE_xxx
2963 enum AVMediaType type;
2966 * Codec implemented by the hardware accelerator.
2973 * Supported pixel format.
2975 * Only hardware accelerated formats are supported here.
2977 enum PixelFormat pix_fmt;
2980 * Hardware accelerated codec capabilities.
2981 * see FF_HWACCEL_CODEC_CAP_*
2985 struct AVHWAccel *next;
2988 * Called at the beginning of each frame or field picture.
2990 * Meaningful frame information (codec specific) is guaranteed to
2991 * be parsed at this point. This function is mandatory.
2993 * Note that buf can be NULL along with buf_size set to 0.
2994 * Otherwise, this means the whole frame is available at this point.
2996 * @param avctx the codec context
2997 * @param buf the frame data buffer base
2998 * @param buf_size the size of the frame in bytes
2999 * @return zero if successful, a negative value otherwise
3001 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3004 * Callback for each slice.
3006 * Meaningful slice information (codec specific) is guaranteed to
3007 * be parsed at this point. This function is mandatory.
3009 * @param avctx the codec context
3010 * @param buf the slice data buffer base
3011 * @param buf_size the size of the slice in bytes
3012 * @return zero if successful, a negative value otherwise
3014 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3017 * Called at the end of each frame or field picture.
3019 * The whole picture is parsed at this point and can now be sent
3020 * to the hardware accelerator. This function is mandatory.
3022 * @param avctx the codec context
3023 * @return zero if successful, a negative value otherwise
3025 int (*end_frame)(AVCodecContext *avctx);
3028 * Size of HW accelerator private data.
3030 * Private data is allocated with av_mallocz() before
3031 * AVCodecContext.get_buffer() and deallocated after
3032 * AVCodecContext.release_buffer().
3038 * four components are given, that's all.
3039 * the last component is alpha
3041 typedef struct AVPicture {
3043 int linesize[4]; ///< number of bytes per line
3046 #if FF_API_PALETTE_CONTROL
3049 * This structure defines a method for communicating palette changes
3050 * between and demuxer and a decoder.
3052 * @deprecated Use AVPacket to send palette changes instead.
3053 * This is totally broken.
3055 #define AVPALETTE_SIZE 1024
3056 #define AVPALETTE_COUNT 256
3057 typedef struct AVPaletteControl {
3059 /* Demuxer sets this to 1 to indicate the palette has changed;
3060 * decoder resets to 0. */
3061 int palette_changed;
3063 /* 4-byte ARGB palette entries, stored in native byte order; note that
3064 * the individual palette components should be on a 8-bit scale; if
3065 * the palette data comes from an IBM VGA native format, the component
3066 * data is probably 6 bits in size and needs to be scaled. */
3067 unsigned int palette[AVPALETTE_COUNT];
3069 } AVPaletteControl attribute_deprecated;
3072 enum AVSubtitleType {
3075 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3078 * Plain text, the text field must be set by the decoder and is
3079 * authoritative. ass and pict fields may contain approximations.
3084 * Formatted text, the ass field must be set by the decoder and is
3085 * authoritative. pict and text fields may contain approximations.
3090 typedef struct AVSubtitleRect {
3091 int x; ///< top left corner of pict, undefined when pict is not set
3092 int y; ///< top left corner of pict, undefined when pict is not set
3093 int w; ///< width of pict, undefined when pict is not set
3094 int h; ///< height of pict, undefined when pict is not set
3095 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3098 * data+linesize for the bitmap of this subtitle.
3099 * can be set for text/ass as well once they where rendered
3102 enum AVSubtitleType type;
3104 char *text; ///< 0 terminated plain UTF-8 text
3107 * 0 terminated ASS/SSA compatible event line.
3108 * The pressentation of this is unaffected by the other values in this
3114 typedef struct AVSubtitle {
3115 uint16_t format; /* 0 = graphics */
3116 uint32_t start_display_time; /* relative to packet pts, in ms */
3117 uint32_t end_display_time; /* relative to packet pts, in ms */
3119 AVSubtitleRect **rects;
3120 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3123 /* packet functions */
3126 * @deprecated use NULL instead
3128 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3131 * Default packet destructor.
3133 void av_destruct_packet(AVPacket *pkt);
3136 * Initialize optional fields of a packet with default values.
3140 void av_init_packet(AVPacket *pkt);
3143 * Allocate the payload of a packet and initialize its fields with
3147 * @param size wanted payload size
3148 * @return 0 if OK, AVERROR_xxx otherwise
3150 int av_new_packet(AVPacket *pkt, int size);
3153 * Reduce packet size, correctly zeroing padding
3156 * @param size new size
3158 void av_shrink_packet(AVPacket *pkt, int size);
3161 * Increase packet size, correctly zeroing padding
3164 * @param grow_by number of bytes by which to increase the size of the packet
3166 int av_grow_packet(AVPacket *pkt, int grow_by);
3169 * @warning This is a hack - the packet memory allocation stuff is broken. The
3170 * packet is allocated if it was not really allocated.
3172 int av_dup_packet(AVPacket *pkt);
3177 * @param pkt packet to free
3179 void av_free_packet(AVPacket *pkt);
3182 * Allocate new information of a packet.
3185 * @param type side information type
3186 * @param size side information size
3187 * @return pointer to fresh allocated data or NULL otherwise
3189 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3193 * Get side information from packet.
3196 * @param type desired side information type
3197 * @param size pointer for side information size to store (optional)
3198 * @return pointer to data if present or NULL otherwise
3200 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3205 struct ReSampleContext;
3206 struct AVResampleContext;
3208 typedef struct ReSampleContext ReSampleContext;
3211 * Initialize audio resampling context.
3213 * @param output_channels number of output channels
3214 * @param input_channels number of input channels
3215 * @param output_rate output sample rate
3216 * @param input_rate input sample rate
3217 * @param sample_fmt_out requested output sample format
3218 * @param sample_fmt_in input sample format
3219 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3220 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3221 * @param linear if 1 then the used FIR filter will be linearly interpolated
3222 between the 2 closest, if 0 the closest will be used
3223 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3224 * @return allocated ReSampleContext, NULL if error occured
3226 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3227 int output_rate, int input_rate,
3228 enum AVSampleFormat sample_fmt_out,
3229 enum AVSampleFormat sample_fmt_in,
3230 int filter_length, int log2_phase_count,
3231 int linear, double cutoff);
3233 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3236 * Free resample context.
3238 * @param s a non-NULL pointer to a resample context previously
3239 * created with av_audio_resample_init()
3241 void audio_resample_close(ReSampleContext *s);
3245 * Initialize an audio resampler.
3246 * Note, if either rate is not an integer then simply scale both rates up so they are.
3247 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3248 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3249 * @param linear If 1 then the used FIR filter will be linearly interpolated
3250 between the 2 closest, if 0 the closest will be used
3251 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3253 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3256 * Resample an array of samples using a previously configured context.
3257 * @param src an array of unconsumed samples
3258 * @param consumed the number of samples of src which have been consumed are returned here
3259 * @param src_size the number of unconsumed samples available
3260 * @param dst_size the amount of space in samples available in dst
3261 * @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.
3262 * @return the number of samples written in dst or -1 if an error occurred
3264 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3268 * Compensate samplerate/timestamp drift. The compensation is done by changing
3269 * the resampler parameters, so no audible clicks or similar distortions occur
3270 * @param compensation_distance distance in output samples over which the compensation should be performed
3271 * @param sample_delta number of output samples which should be output less
3273 * example: av_resample_compensate(c, 10, 500)
3274 * here instead of 510 samples only 500 samples would be output
3276 * note, due to rounding the actual compensation might be slightly different,
3277 * especially if the compensation_distance is large and the in_rate used during init is small
3279 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3280 void av_resample_close(struct AVResampleContext *c);
3283 * Allocate memory for a picture. Call avpicture_free() to free it.
3285 * @see avpicture_fill()
3287 * @param picture the picture to be filled in
3288 * @param pix_fmt the format of the picture
3289 * @param width the width of the picture
3290 * @param height the height of the picture
3291 * @return zero if successful, a negative value if not
3293 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3296 * Free a picture previously allocated by avpicture_alloc().
3297 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3300 * @param picture the AVPicture to be freed
3302 void avpicture_free(AVPicture *picture);
3305 * Fill in the AVPicture fields.
3306 * The fields of the given AVPicture are filled in by using the 'ptr' address
3307 * which points to the image data buffer. Depending on the specified picture
3308 * format, one or multiple image data pointers and line sizes will be set.
3309 * If a planar format is specified, several pointers will be set pointing to
3310 * the different picture planes and the line sizes of the different planes
3311 * will be stored in the lines_sizes array.
3312 * Call with ptr == NULL to get the required size for the ptr buffer.
3314 * To allocate the buffer and fill in the AVPicture fields in one call,
3315 * use avpicture_alloc().
3317 * @param picture AVPicture whose fields are to be filled in
3318 * @param ptr Buffer which will contain or contains the actual image data
3319 * @param pix_fmt The format in which the picture data is stored.
3320 * @param width the width of the image in pixels
3321 * @param height the height of the image in pixels
3322 * @return size of the image data in bytes
3324 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3325 enum PixelFormat pix_fmt, int width, int height);
3328 * Copy pixel data from an AVPicture into a buffer.
3329 * The data is stored compactly, without any gaps for alignment or padding
3330 * which may be applied by avpicture_fill().
3332 * @see avpicture_get_size()
3334 * @param[in] src AVPicture containing image data
3335 * @param[in] pix_fmt The format in which the picture data is stored.
3336 * @param[in] width the width of the image in pixels.
3337 * @param[in] height the height of the image in pixels.
3338 * @param[out] dest A buffer into which picture data will be copied.
3339 * @param[in] dest_size The size of 'dest'.
3340 * @return The number of bytes written to dest, or a negative value (error code) on error.
3342 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3343 unsigned char *dest, int dest_size);
3346 * Calculate the size in bytes that a picture of the given width and height
3347 * would occupy if stored in the given picture format.
3348 * Note that this returns the size of a compact representation as generated
3349 * by avpicture_layout(), which can be smaller than the size required for e.g.
3352 * @param pix_fmt the given picture format
3353 * @param width the width of the image
3354 * @param height the height of the image
3355 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3357 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3358 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3360 #if FF_API_GET_PIX_FMT_NAME
3362 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3364 attribute_deprecated
3365 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3368 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3371 * Return a value representing the fourCC code associated to the
3372 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3375 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3378 * Put a string representing the codec tag codec_tag in buf.
3380 * @param buf_size size in bytes of buf
3381 * @return the length of the string that would have been generated if
3382 * enough space had been available, excluding the trailing null
3384 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3386 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3387 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3388 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3389 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3390 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3391 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3394 * Compute what kind of losses will occur when converting from one specific
3395 * pixel format to another.
3396 * When converting from one pixel format to another, information loss may occur.
3397 * For example, when converting from RGB24 to GRAY, the color information will
3398 * be lost. Similarly, other losses occur when converting from some formats to
3399 * other formats. These losses can involve loss of chroma, but also loss of
3400 * resolution, loss of color depth, loss due to the color space conversion, loss
3401 * of the alpha bits or loss due to color quantization.
3402 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3403 * which will occur when converting from one pixel format to another.
3405 * @param[in] dst_pix_fmt destination pixel format
3406 * @param[in] src_pix_fmt source pixel format
3407 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3408 * @return Combination of flags informing you what kind of losses will occur.
3410 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3414 * Find the best pixel format to convert to given a certain source pixel
3415 * format. When converting from one pixel format to another, information loss
3416 * may occur. For example, when converting from RGB24 to GRAY, the color
3417 * information will be lost. Similarly, other losses occur when converting from
3418 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3419 * the given pixel formats should be used to suffer the least amount of loss.
3420 * The pixel formats from which it chooses one, are determined by the
3421 * pix_fmt_mask parameter.
3424 * src_pix_fmt = PIX_FMT_YUV420P;
3425 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3426 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3429 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3430 * @param[in] src_pix_fmt source pixel format
3431 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3432 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3433 * @return The best pixel format to convert to or -1 if none was found.
3435 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3436 int has_alpha, int *loss_ptr);
3438 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3439 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3442 * Tell if an image really has transparent alpha values.
3443 * @return ored mask of FF_ALPHA_xxx constants
3445 int img_get_alpha_info(const AVPicture *src,
3446 enum PixelFormat pix_fmt, int width, int height);
3448 /* deinterlace a picture */
3449 /* deinterlace - if not supported return -1 */
3450 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3451 enum PixelFormat pix_fmt, int width, int height);
3453 /* external high level API */
3456 * If c is NULL, returns the first registered codec,
3457 * if c is non-NULL, returns the next registered codec after c,
3458 * or NULL if c is the last one.
3460 AVCodec *av_codec_next(AVCodec *c);
3463 * Return the LIBAVCODEC_VERSION_INT constant.
3465 unsigned avcodec_version(void);
3468 * Return the libavcodec build-time configuration.
3470 const char *avcodec_configuration(void);
3473 * Return the libavcodec license.
3475 const char *avcodec_license(void);
3478 * Initialize libavcodec.
3479 * If called more than once, does nothing.
3481 * @warning This function must be called before any other libavcodec
3484 * @warning This function is not thread-safe.
3486 void avcodec_init(void);
3489 * Register the codec codec and initialize libavcodec.
3491 * @see avcodec_init(), avcodec_register_all()
3493 void avcodec_register(AVCodec *codec);
3496 * Find a registered encoder with a matching codec ID.
3498 * @param id CodecID of the requested encoder
3499 * @return An encoder if one was found, NULL otherwise.
3501 AVCodec *avcodec_find_encoder(enum CodecID id);
3504 * Find a registered encoder with the specified name.
3506 * @param name name of the requested encoder
3507 * @return An encoder if one was found, NULL otherwise.
3509 AVCodec *avcodec_find_encoder_by_name(const char *name);
3512 * Find a registered decoder with a matching codec ID.
3514 * @param id CodecID of the requested decoder
3515 * @return A decoder if one was found, NULL otherwise.
3517 AVCodec *avcodec_find_decoder(enum CodecID id);
3520 * Find a registered decoder with the specified name.
3522 * @param name name of the requested decoder
3523 * @return A decoder if one was found, NULL otherwise.
3525 AVCodec *avcodec_find_decoder_by_name(const char *name);
3526 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3529 * Return a name for the specified profile, if available.
3531 * @param codec the codec that is searched for the given profile
3532 * @param profile the profile value for which a name is requested
3533 * @return A name for the profile if found, NULL otherwise.
3535 const char *av_get_profile_name(const AVCodec *codec, int profile);
3538 * Set the fields of the given AVCodecContext to default values.
3540 * @param s The AVCodecContext of which the fields should be set to default values.
3542 void avcodec_get_context_defaults(AVCodecContext *s);
3544 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3545 * we WILL change its arguments and name a few times! */
3546 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3548 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3549 * we WILL change its arguments and name a few times! */
3550 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3552 #if FF_API_ALLOC_CONTEXT
3554 * Allocate an AVCodecContext and set its fields to default values. The
3555 * resulting struct can be deallocated by simply calling av_free().
3557 * @return An AVCodecContext filled with default values or NULL on failure.
3558 * @see avcodec_get_context_defaults
3560 * @deprecated use avcodec_alloc_context3()
3562 attribute_deprecated
3563 AVCodecContext *avcodec_alloc_context(void);
3565 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3566 * we WILL change its arguments and name a few times! */
3567 attribute_deprecated
3568 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3572 * Allocate an AVCodecContext and set its fields to default values. The
3573 * resulting struct can be deallocated by simply calling av_free().
3575 * @param codec if non-NULL, allocate private data and initialize defaults
3576 * for the given codec. It is illegal to then call avcodec_open()
3577 * with a different codec.
3579 * @return An AVCodecContext filled with default values or NULL on failure.
3580 * @see avcodec_get_context_defaults
3582 * @deprecated use avcodec_alloc_context3()
3584 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3587 * Copy the settings of the source AVCodecContext into the destination
3588 * AVCodecContext. The resulting destination codec context will be
3589 * unopened, i.e. you are required to call avcodec_open() before you
3590 * can use this AVCodecContext to decode/encode video/audio data.
3592 * @param dest target codec context, should be initialized with
3593 * avcodec_alloc_context3(), but otherwise uninitialized
3594 * @param src source codec context
3595 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3597 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3600 * Set the fields of the given AVFrame to default values.
3602 * @param pic The AVFrame of which the fields should be set to default values.
3604 void avcodec_get_frame_defaults(AVFrame *pic);
3607 * Allocate an AVFrame and set its fields to default values. The resulting
3608 * struct can be deallocated by simply calling av_free().
3610 * @return An AVFrame filled with default values or NULL on failure.
3611 * @see avcodec_get_frame_defaults
3613 AVFrame *avcodec_alloc_frame(void);
3615 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3616 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3617 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3620 * Return the amount of padding in pixels which the get_buffer callback must
3621 * provide around the edge of the image for codecs which do not have the
3622 * CODEC_FLAG_EMU_EDGE flag.
3624 * @return Required padding in pixels.
3626 unsigned avcodec_get_edge_width(void);
3628 * Modify width and height values so that they will result in a memory
3629 * buffer that is acceptable for the codec if you do not use any horizontal
3632 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3633 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3634 * according to avcodec_get_edge_width() before.
3636 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3638 * Modify width and height values so that they will result in a memory
3639 * buffer that is acceptable for the codec if you also ensure that all
3640 * line sizes are a multiple of the respective linesize_align[i].
3642 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3643 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3644 * according to avcodec_get_edge_width() before.
3646 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3647 int linesize_align[4]);
3649 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3651 #if FF_API_THREAD_INIT
3653 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3655 attribute_deprecated
3656 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3659 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3660 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3661 //FIXME func typedef
3663 #if FF_API_AVCODEC_OPEN
3665 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3666 * function the context has to be allocated.
3668 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3669 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3670 * retrieving a codec.
3672 * @warning This function is not thread safe!
3675 * avcodec_register_all();
3676 * codec = avcodec_find_decoder(CODEC_ID_H264);
3680 * context = avcodec_alloc_context3(codec);
3682 * if (avcodec_open(context, codec) < 0)
3686 * @param avctx The context which will be set up to use the given codec.
3687 * @param codec The codec to use within the context.
3688 * @return zero on success, a negative value on error
3689 * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3691 * @deprecated use avcodec_open2
3693 attribute_deprecated
3694 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3698 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3699 * function the context has to be allocated with avcodec_alloc_context().
3701 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3702 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3703 * retrieving a codec.
3705 * @warning This function is not thread safe!
3708 * avcodec_register_all();
3709 * av_dict_set(&opts, "b", "2.5M", 0);
3710 * codec = avcodec_find_decoder(CODEC_ID_H264);
3714 * context = avcodec_alloc_context();
3716 * if (avcodec_open(context, codec, opts) < 0)
3720 * @param avctx The context to initialize.
3721 * @param options A dictionary filled with AVCodecContext and codec-private options.
3722 * On return this object will be filled with options that were not found.
3724 * @return zero on success, a negative value on error
3725 * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3726 * av_dict_set(), av_opt_find().
3728 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3731 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3732 * Some decoders may support multiple frames in a single AVPacket, such
3733 * decoders would then just decode the first frame. In this case,
3734 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3735 * the remaining data in order to decode the second frame etc.
3737 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3738 * decompressed frame size in bytes.
3740 * @warning You must set frame_size_ptr to the allocated size of the
3741 * output buffer before calling avcodec_decode_audio3().
3743 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3744 * the actual read bytes because some optimized bitstream readers read 32 or 64
3745 * bits at once and could read over the end.
3747 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3748 * no overreading happens for damaged MPEG streams.
3750 * @note You might have to align the input buffer avpkt->data and output buffer
3751 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3752 * necessary at all, on others it won't work at all if not aligned and on others
3753 * it will work but it will have an impact on performance.
3755 * In practice, avpkt->data should have 4 byte alignment at minimum and
3756 * samples should be 16 byte aligned unless the CPU doesn't need it
3757 * (AltiVec and SSE do).
3759 * @param avctx the codec context
3760 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3761 * @param[in,out] frame_size_ptr the output buffer size in bytes
3762 * @param[in] avpkt The input AVPacket containing the input buffer.
3763 * You can create such packet with av_init_packet() and by then setting
3764 * data and size, some decoders might in addition need other fields.
3765 * All decoders are designed to use the least fields possible though.
3766 * @return On error a negative value is returned, otherwise the number of bytes
3767 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3769 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3770 int *frame_size_ptr,
3774 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3775 * Some decoders may support multiple frames in a single AVPacket, such
3776 * decoders would then just decode the first frame.
3778 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3779 * the actual read bytes because some optimized bitstream readers read 32 or 64
3780 * bits at once and could read over the end.
3782 * @warning The end of the input buffer buf should be set to 0 to ensure that
3783 * no overreading happens for damaged MPEG streams.
3785 * @note You might have to align the input buffer avpkt->data.
3786 * The alignment requirements depend on the CPU: on some CPUs it isn't
3787 * necessary at all, on others it won't work at all if not aligned and on others
3788 * it will work but it will have an impact on performance.
3790 * In practice, avpkt->data should have 4 byte alignment at minimum.
3792 * @note Some codecs have a delay between input and output, these need to be
3793 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3795 * @param avctx the codec context
3796 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3797 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3798 * allocate memory for the actual bitmap.
3799 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3800 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3801 * decodes and the decoder tells the user once it does not need the data anymore,
3802 * the user app can at this point free/reuse/keep the memory as it sees fit.
3804 * @param[in] avpkt The input AVpacket containing the input buffer.
3805 * You can create such packet with av_init_packet() and by then setting
3806 * data and size, some decoders might in addition need other fields like
3807 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3809 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3810 * @return On error a negative value is returned, otherwise the number of bytes
3811 * used or zero if no frame could be decompressed.
3813 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3814 int *got_picture_ptr,
3818 * Decode a subtitle message.
3819 * Return a negative value on error, otherwise return the number of bytes used.
3820 * If no subtitle could be decompressed, got_sub_ptr is zero.
3821 * Otherwise, the subtitle is stored in *sub.
3822 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3823 * simplicity, because the performance difference is expect to be negligible
3824 * and reusing a get_buffer written for video codecs would probably perform badly
3825 * due to a potentially very different allocation pattern.
3827 * @param avctx the codec context
3828 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3829 freed with avsubtitle_free if *got_sub_ptr is set.
3830 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3831 * @param[in] avpkt The input AVPacket containing the input buffer.
3833 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3838 * Frees all allocated data in the given subtitle struct.
3840 * @param sub AVSubtitle to free.
3842 void avsubtitle_free(AVSubtitle *sub);
3844 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3846 uint8_t *buf, int buf_size);
3849 * Encode an audio frame from samples into buf.
3851 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3852 * However, for PCM audio the user will know how much space is needed
3853 * because it depends on the value passed in buf_size as described
3854 * below. In that case a lower value can be used.
3856 * @param avctx the codec context
3857 * @param[out] buf the output buffer
3858 * @param[in] buf_size the output buffer size
3859 * @param[in] samples the input buffer containing the samples
3860 * The number of samples read from this buffer is frame_size*channels,
3861 * both of which are defined in avctx.
3862 * For PCM audio the number of samples read from samples is equal to
3863 * buf_size * input_sample_size / output_sample_size.
3864 * @return On error a negative value is returned, on success zero or the number
3865 * of bytes used to encode the data read from the input buffer.
3867 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3868 const short *samples);
3871 * Encode a video frame from pict into buf.
3872 * The input picture should be
3873 * stored using a specific format, namely avctx.pix_fmt.
3875 * @param avctx the codec context
3876 * @param[out] buf the output buffer for the bitstream of encoded frame
3877 * @param[in] buf_size the size of the output buffer in bytes
3878 * @param[in] pict the input picture to encode
3879 * @return On error a negative value is returned, on success zero or the number
3880 * of bytes used from the output buffer.
3882 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3883 const AVFrame *pict);
3884 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3885 const AVSubtitle *sub);
3887 int avcodec_close(AVCodecContext *avctx);
3890 * Register all the codecs, parsers and bitstream filters which were enabled at
3891 * configuration time. If you do not call this function you can select exactly
3892 * which formats you want to support, by using the individual registration
3895 * @see avcodec_register
3896 * @see av_register_codec_parser
3897 * @see av_register_bitstream_filter
3899 void avcodec_register_all(void);
3902 * Flush buffers, should be called when seeking or when switching to a different stream.
3904 void avcodec_flush_buffers(AVCodecContext *avctx);
3906 void avcodec_default_free_buffers(AVCodecContext *s);
3908 /* misc useful functions */
3910 #if FF_API_OLD_FF_PICT_TYPES
3912 * Return a single letter to describe the given picture type pict_type.
3914 * @param[in] pict_type the picture type
3915 * @return A single character representing the picture type.
3916 * @deprecated Use av_get_picture_type_char() instead.
3918 attribute_deprecated
3919 char av_get_pict_type_char(int pict_type);
3923 * Return codec bits per sample.
3925 * @param[in] codec_id the codec
3926 * @return Number of bits per sample or zero if unknown for the given codec.
3928 int av_get_bits_per_sample(enum CodecID codec_id);
3930 #if FF_API_OLD_SAMPLE_FMT
3932 * @deprecated Use av_get_bytes_per_sample() instead.
3934 attribute_deprecated
3935 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3939 typedef struct AVCodecParserContext {
3941 struct AVCodecParser *parser;
3942 int64_t frame_offset; /* offset of the current frame */
3943 int64_t cur_offset; /* current offset
3944 (incremented by each av_parser_parse()) */
3945 int64_t next_frame_offset; /* offset of the next frame */
3947 int pict_type; /* XXX: Put it back in AVCodecContext. */
3949 * This field is used for proper frame duration computation in lavf.
3950 * It signals, how much longer the frame duration of the current frame
3951 * is compared to normal frame duration.
3953 * frame_duration = (1 + repeat_pict) * time_base
3955 * It is used by codecs like H.264 to display telecined material.
3957 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3958 int64_t pts; /* pts of the current frame */
3959 int64_t dts; /* dts of the current frame */
3964 int fetch_timestamp;
3966 #define AV_PARSER_PTS_NB 4
3967 int cur_frame_start_index;
3968 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3969 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3970 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3973 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3974 #define PARSER_FLAG_ONCE 0x0002
3975 /// Set if the parser has a valid file offset
3976 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3978 int64_t offset; ///< byte offset from starting packet start
3979 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3982 * Set by parser to 1 for key frames and 0 for non-key frames.
3983 * It is initialized to -1, so if the parser doesn't set this flag,
3984 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3990 * Time difference in stream time base units from the pts of this
3991 * packet to the point at which the output from the decoder has converged
3992 * independent from the availability of previous frames. That is, the
3993 * frames are virtually identical no matter if decoding started from
3994 * the very first frame or from this keyframe.
3995 * Is AV_NOPTS_VALUE if unknown.
3996 * This field is not the display duration of the current frame.
3997 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4000 * The purpose of this field is to allow seeking in streams that have no
4001 * keyframes in the conventional sense. It corresponds to the
4002 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4003 * essential for some types of subtitle streams to ensure that all
4004 * subtitles are correctly displayed after seeking.
4006 int64_t convergence_duration;
4008 // Timestamp generation support:
4010 * Synchronization point for start of timestamp generation.
4012 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4015 * For example, this corresponds to presence of H.264 buffering period
4021 * Offset of the current timestamp against last timestamp sync point in
4022 * units of AVCodecContext.time_base.
4024 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4025 * contain a valid timestamp offset.
4027 * Note that the timestamp of sync point has usually a nonzero
4028 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4029 * the next frame after timestamp sync point will be usually 1.
4031 * For example, this corresponds to H.264 cpb_removal_delay.
4033 int dts_ref_dts_delta;
4036 * Presentation delay of current frame in units of AVCodecContext.time_base.
4038 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4039 * contain valid non-negative timestamp delta (presentation time of a frame
4040 * must not lie in the past).
4042 * This delay represents the difference between decoding and presentation
4043 * time of the frame.
4045 * For example, this corresponds to H.264 dpb_output_delay.
4050 * Position of the packet in file.
4052 * Analogous to cur_frame_pts/dts
4054 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4057 * Byte position of currently parsed frame in stream.
4062 * Previous frame byte position.
4065 } AVCodecParserContext;
4067 typedef struct AVCodecParser {
4068 int codec_ids[5]; /* several codec IDs are permitted */
4070 int (*parser_init)(AVCodecParserContext *s);
4071 int (*parser_parse)(AVCodecParserContext *s,
4072 AVCodecContext *avctx,
4073 const uint8_t **poutbuf, int *poutbuf_size,
4074 const uint8_t *buf, int buf_size);
4075 void (*parser_close)(AVCodecParserContext *s);
4076 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4077 struct AVCodecParser *next;
4080 AVCodecParser *av_parser_next(AVCodecParser *c);
4082 void av_register_codec_parser(AVCodecParser *parser);
4083 AVCodecParserContext *av_parser_init(int codec_id);
4088 * @param s parser context.
4089 * @param avctx codec context.
4090 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4091 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4092 * @param buf input buffer.
4093 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4094 * @param pts input presentation timestamp.
4095 * @param dts input decoding timestamp.
4096 * @param pos input byte position in stream.
4097 * @return the number of bytes of the input bitstream used.
4102 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4109 * decode_frame(data, size);
4113 int av_parser_parse2(AVCodecParserContext *s,
4114 AVCodecContext *avctx,
4115 uint8_t **poutbuf, int *poutbuf_size,
4116 const uint8_t *buf, int buf_size,
4117 int64_t pts, int64_t dts,
4120 int av_parser_change(AVCodecParserContext *s,
4121 AVCodecContext *avctx,
4122 uint8_t **poutbuf, int *poutbuf_size,
4123 const uint8_t *buf, int buf_size, int keyframe);
4124 void av_parser_close(AVCodecParserContext *s);
4127 typedef struct AVBitStreamFilterContext {
4129 struct AVBitStreamFilter *filter;
4130 AVCodecParserContext *parser;
4131 struct AVBitStreamFilterContext *next;
4132 } AVBitStreamFilterContext;
4135 typedef struct AVBitStreamFilter {
4138 int (*filter)(AVBitStreamFilterContext *bsfc,
4139 AVCodecContext *avctx, const char *args,
4140 uint8_t **poutbuf, int *poutbuf_size,
4141 const uint8_t *buf, int buf_size, int keyframe);
4142 void (*close)(AVBitStreamFilterContext *bsfc);
4143 struct AVBitStreamFilter *next;
4144 } AVBitStreamFilter;
4146 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4147 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4148 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4149 AVCodecContext *avctx, const char *args,
4150 uint8_t **poutbuf, int *poutbuf_size,
4151 const uint8_t *buf, int buf_size, int keyframe);
4152 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4154 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4159 * Reallocate the given block if it is not large enough, otherwise do nothing.
4163 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4166 * Allocate a buffer, reusing the given one if large enough.
4168 * Contrary to av_fast_realloc the current buffer contents might not be
4169 * preserved and on error the old buffer is freed, thus no special
4170 * handling to avoid memleaks is necessary.
4172 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4173 * @param size size of the buffer *ptr points to
4174 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4175 * *size 0 if an error occurred.
4177 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4180 * Copy image src to dst. Wraps av_picture_data_copy() above.
4182 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4183 enum PixelFormat pix_fmt, int width, int height);
4186 * Crop image top and left side.
4188 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4189 enum PixelFormat pix_fmt, int top_band, int left_band);
4194 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4195 int padtop, int padbottom, int padleft, int padright, int *color);
4198 * Encode extradata length to a buffer. Used by xiph codecs.
4200 * @param s buffer to write to; must be at least (v/255+1) bytes long
4201 * @param v size of extradata in bytes
4202 * @return number of bytes written to the buffer.
4204 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4207 * Logs a generic warning message about a missing feature. This function is
4208 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4209 * only, and would normally not be used by applications.
4210 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4211 * a pointer to an AVClass struct
4212 * @param[in] feature string containing the name of the missing feature
4213 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4214 * If want_sample is non-zero, additional verbage will be added to the log
4215 * message which tells the user how to report samples to the development
4218 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4221 * Log a generic warning message asking for a sample. This function is
4222 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4223 * only, and would normally not be used by applications.
4224 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4225 * a pointer to an AVClass struct
4226 * @param[in] msg string containing an optional message, or NULL if no message
4228 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4231 * Register the hardware accelerator hwaccel.
4233 void av_register_hwaccel(AVHWAccel *hwaccel);
4236 * If hwaccel is NULL, returns the first registered hardware accelerator,
4237 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4238 * after hwaccel, or NULL if hwaccel is the last one.
4240 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4244 * Lock operation used by lockmgr
4247 AV_LOCK_CREATE, ///< Create a mutex
4248 AV_LOCK_OBTAIN, ///< Lock the mutex
4249 AV_LOCK_RELEASE, ///< Unlock the mutex
4250 AV_LOCK_DESTROY, ///< Free mutex resources
4254 * Register a user provided lock manager supporting the operations
4255 * specified by AVLockOp. mutex points to a (void *) where the
4256 * lockmgr should store/get a pointer to a user allocated mutex. It's
4257 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4259 * @param cb User defined callback. Note: Libav may invoke calls to this
4260 * callback during the call to av_lockmgr_register().
4261 * Thus, the application must be prepared to handle that.
4262 * If cb is set to NULL the lockmgr will be unregistered.
4263 * Also note that during unregistration the previously registered
4264 * lockmgr callback may also be invoked.
4266 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4268 #endif /* AVCODEC_AVCODEC_H */