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"
34 #include "libavcodec/version.h"
37 * Identify the syntax and semantics of the bitstream.
38 * The principle is roughly:
39 * Two decoders with the same ID can decode the same streams.
40 * Two encoders with the same ID can encode compatible streams.
41 * There may be slight deviations from the principle due to implementation
44 * If you add a codec ID to this list, add it so that
45 * 1. no value of a existing codec ID changes (that would break ABI),
46 * 2. it is as close as possible to similar codecs.
53 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
54 CODEC_ID_MPEG2VIDEO_XVMC,
91 CODEC_ID_INTERPLAY_VIDEO,
103 CODEC_ID_TRUEMOTION1,
130 CODEC_ID_TRUEMOTION2,
147 CODEC_ID_DSICINVIDEO,
148 CODEC_ID_TIERTEXSEQVIDEO,
157 CODEC_ID_BETHSOFTVID,
175 CODEC_ID_MOTIONPIXELS,
193 CODEC_ID_IFF_BYTERUN1,
208 /* various PCM "codecs" */
209 CODEC_ID_PCM_S16LE= 0x10000,
225 CODEC_ID_PCM_S24DAUD,
227 CODEC_ID_PCM_S16LE_PLANAR,
236 /* various ADPCM codecs */
237 CODEC_ID_ADPCM_IMA_QT= 0x11000,
238 CODEC_ID_ADPCM_IMA_WAV,
239 CODEC_ID_ADPCM_IMA_DK3,
240 CODEC_ID_ADPCM_IMA_DK4,
241 CODEC_ID_ADPCM_IMA_WS,
242 CODEC_ID_ADPCM_IMA_SMJPEG,
251 CODEC_ID_ADPCM_YAMAHA,
252 CODEC_ID_ADPCM_SBPRO_4,
253 CODEC_ID_ADPCM_SBPRO_3,
254 CODEC_ID_ADPCM_SBPRO_2,
256 CODEC_ID_ADPCM_IMA_AMV,
257 CODEC_ID_ADPCM_EA_R1,
258 CODEC_ID_ADPCM_EA_R3,
259 CODEC_ID_ADPCM_EA_R2,
260 CODEC_ID_ADPCM_IMA_EA_SEAD,
261 CODEC_ID_ADPCM_IMA_EA_EACS,
262 CODEC_ID_ADPCM_EA_XAS,
263 CODEC_ID_ADPCM_EA_MAXIS_XA,
264 CODEC_ID_ADPCM_IMA_ISS,
268 CODEC_ID_AMR_NB= 0x12000,
271 /* RealAudio codecs*/
272 CODEC_ID_RA_144= 0x13000,
275 /* various DPCM codecs */
276 CODEC_ID_ROQ_DPCM= 0x14000,
277 CODEC_ID_INTERPLAY_DPCM,
282 CODEC_ID_MP2= 0x15000,
283 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
301 CODEC_ID_WESTWOOD_SND1,
302 CODEC_ID_GSM, ///< as in Berlin toast format
310 CODEC_ID_DSICINAUDIO,
314 CODEC_ID_GSM_MS, /* as found in WAV */
323 CODEC_ID_WMALOSSLESS,
332 CODEC_ID_BINKAUDIO_RDFT,
333 CODEC_ID_BINKAUDIO_DCT,
337 /* subtitle codecs */
338 CODEC_ID_DVD_SUBTITLE= 0x17000,
339 CODEC_ID_DVB_SUBTITLE,
340 CODEC_ID_TEXT, ///< raw UTF-8 text
344 CODEC_ID_HDMV_PGS_SUBTITLE,
345 CODEC_ID_DVB_TELETEXT,
348 /* other specific kind of codecs (generally used for attachments) */
349 CODEC_ID_TTF= 0x18000,
351 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
353 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
354 * stream (only used by libavformat) */
355 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
358 #if FF_API_OLD_SAMPLE_FMT
359 #define SampleFormat AVSampleFormat
361 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
362 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
363 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
364 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
365 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
366 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
367 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
370 #if FF_API_OLD_AUDIOCONVERT
371 #include "libavutil/audioconvert.h"
373 /* Audio channel masks */
374 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
375 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
376 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
377 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
378 #define CH_BACK_LEFT AV_CH_BACK_LEFT
379 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
380 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
381 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
382 #define CH_BACK_CENTER AV_CH_BACK_CENTER
383 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
384 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
385 #define CH_TOP_CENTER AV_CH_TOP_CENTER
386 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
387 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
388 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
389 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
390 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
391 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
392 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
393 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
395 /** Channel mask value used for AVCodecContext.request_channel_layout
396 to indicate that the user requests the channel order of the decoder output
397 to be the native codec channel order. */
398 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
400 /* Audio channel convenience macros */
401 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
402 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
403 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
404 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
405 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
406 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
407 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
408 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
409 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
410 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
411 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
412 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
413 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
414 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
415 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
419 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
422 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
423 * This is mainly needed because some optimized bitstream readers read
424 * 32 or 64 bit at once and could read over the end.<br>
425 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
426 * MPEG bitstreams could cause overread and segfault.
428 #define FF_INPUT_BUFFER_PADDING_SIZE 8
431 * minimum encoding buffer size
432 * Used to avoid some checks during header writing.
434 #define FF_MIN_BUFFER_SIZE 16384
438 * motion estimation type.
441 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
445 ME_EPZS, ///< enhanced predictive zonal search
446 ME_X1, ///< reserved for experiments
447 ME_HEX, ///< hexagon based search
448 ME_UMH, ///< uneven multi-hexagon search
449 ME_ITER, ///< iterative search
450 ME_TESA, ///< transformed exhaustive search algorithm
454 /* We leave some space between them for extensions (drop some
455 * keyframes for intra-only or drop just some bidir frames). */
456 AVDISCARD_NONE =-16, ///< discard nothing
457 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
458 AVDISCARD_NONREF = 8, ///< discard all non reference
459 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
460 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
461 AVDISCARD_ALL = 48, ///< discard all
464 enum AVColorPrimaries{
465 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
466 AVCOL_PRI_UNSPECIFIED=2,
468 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
469 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
470 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
472 AVCOL_PRI_NB , ///< Not part of ABI
475 enum AVColorTransferCharacteristic{
476 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
477 AVCOL_TRC_UNSPECIFIED=2,
478 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
479 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
480 AVCOL_TRC_NB , ///< Not part of ABI
485 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
486 AVCOL_SPC_UNSPECIFIED=2,
488 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
489 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
490 AVCOL_SPC_SMPTE240M =7,
491 AVCOL_SPC_NB , ///< Not part of ABI
495 AVCOL_RANGE_UNSPECIFIED=0,
496 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
497 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
498 AVCOL_RANGE_NB , ///< Not part of ABI
502 * X X 3 4 X X are luma samples,
503 * 1 2 1-6 are possible chroma positions
504 * X X 5 6 X 0 is undefined/unknown position
506 enum AVChromaLocation{
507 AVCHROMA_LOC_UNSPECIFIED=0,
508 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
509 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
510 AVCHROMA_LOC_TOPLEFT =3, ///< DV
512 AVCHROMA_LOC_BOTTOMLEFT =5,
513 AVCHROMA_LOC_BOTTOM =6,
514 AVCHROMA_LOC_NB , ///< Not part of ABI
521 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
522 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
523 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
524 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
525 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
526 AV_LPC_TYPE_NB , ///< Not part of ABI
529 enum AVAudioServiceType {
530 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
531 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
532 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
533 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
534 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
535 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
536 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
537 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
538 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
539 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
542 typedef struct RcOverride{
545 int qscale; // If this is 0 then quality_factor will be used instead.
546 float quality_factor;
549 #define FF_MAX_B_FRAMES 16
552 These flags can be passed in AVCodecContext.flags before initialization.
553 Note: Not everything is supported yet.
556 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
557 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
558 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
559 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
560 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
561 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
563 * The parent program guarantees that the input for B-frames containing
564 * streams is not written to for at least s->max_b_frames+1 frames, if
565 * this is not set the input will be copied.
567 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
568 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
569 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
570 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
571 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
572 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
573 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
574 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
575 location instead of only at frame boundaries. */
576 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
577 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
578 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
579 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
580 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
581 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
582 /* Fx : Flag for h263+ extra options */
583 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
584 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
585 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
586 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
587 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
588 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
589 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
590 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
591 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
592 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
593 #define CODEC_FLAG_CLOSED_GOP 0x80000000
594 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
595 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
596 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
597 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
598 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
599 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
600 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
601 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
602 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
603 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
604 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
605 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
606 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
607 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
608 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
609 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
610 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
611 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
612 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
613 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
614 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
615 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
617 /* Unsupported options :
618 * Syntax Arithmetic coding (SAC)
619 * Reference Picture Selection
620 * Independent Segment Decoding */
622 /* codec capabilities */
624 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
626 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
627 * If not set, it might not use get_buffer() at all or use operations that
628 * assume the buffer was allocated by avcodec_default_get_buffer.
630 #define CODEC_CAP_DR1 0x0002
631 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
632 #define CODEC_CAP_PARSE_ONLY 0x0004
633 #define CODEC_CAP_TRUNCATED 0x0008
634 /* Codec can export data for HW decoding (XvMC). */
635 #define CODEC_CAP_HWACCEL 0x0010
637 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
638 * If this is not set, the codec is guaranteed to never be fed with NULL data.
640 #define CODEC_CAP_DELAY 0x0020
642 * Codec can be fed a final frame with a smaller size.
643 * This can be used to prevent truncation of the last audio samples.
645 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
647 * Codec can export data for HW decoding (VDPAU).
649 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
651 * Codec can output multiple frames per AVPacket
652 * Normally demuxers return one frame at a time, demuxers which do not do
653 * are connected to a parser to split what they return into proper frames.
654 * This flag is reserved to the very rare category of codecs which have a
655 * bitstream that cannot be split into frames without timeconsuming
656 * operations like full decoding. Demuxers carring such bitstreams thus
657 * may return multiple frames in a packet. This has many disadvantages like
658 * prohibiting stream copy in many cases thus it should only be considered
661 #define CODEC_CAP_SUBFRAMES 0x0100
663 * Codec is experimental and is thus avoided in favor of non experimental
666 #define CODEC_CAP_EXPERIMENTAL 0x0200
668 * Codec should fill in channel configuration and samplerate instead of container
670 #define CODEC_CAP_CHANNEL_CONF 0x0400
672 * Codec is able to deal with negative linesizes
674 #define CODEC_CAP_NEG_LINESIZES 0x0800
676 * Codec supports frame-level multithreading.
678 #define CODEC_CAP_FRAME_THREADS 0x1000
680 * Codec supports slice-based (or partition-based) multithreading.
682 #define CODEC_CAP_SLICE_THREADS 0x2000
684 //The following defines may change, don't expect compatibility if you use them.
685 #define MB_TYPE_INTRA4x4 0x0001
686 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
687 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
688 #define MB_TYPE_16x16 0x0008
689 #define MB_TYPE_16x8 0x0010
690 #define MB_TYPE_8x16 0x0020
691 #define MB_TYPE_8x8 0x0040
692 #define MB_TYPE_INTERLACED 0x0080
693 #define MB_TYPE_DIRECT2 0x0100 //FIXME
694 #define MB_TYPE_ACPRED 0x0200
695 #define MB_TYPE_GMC 0x0400
696 #define MB_TYPE_SKIP 0x0800
697 #define MB_TYPE_P0L0 0x1000
698 #define MB_TYPE_P1L0 0x2000
699 #define MB_TYPE_P0L1 0x4000
700 #define MB_TYPE_P1L1 0x8000
701 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
702 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
703 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
704 #define MB_TYPE_QUANT 0x00010000
705 #define MB_TYPE_CBP 0x00020000
706 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
710 * This specifies the area which should be displayed.
711 * Note there may be multiple such areas for one frame.
713 typedef struct AVPanScan{
716 * - encoding: Set by user.
717 * - decoding: Set by libavcodec.
722 * width and height in 1/16 pel
723 * - encoding: Set by user.
724 * - decoding: Set by libavcodec.
730 * position of the top left corner in 1/16 pel for up to 3 fields/frames
731 * - encoding: Set by user.
732 * - decoding: Set by libavcodec.
734 int16_t position[3][2];
737 #define FF_COMMON_FRAME \
739 * pointer to the picture planes.\
740 * This might be different from the first allocated byte\
747 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
748 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
754 * 1 -> keyframe, 0-> not\
755 * - encoding: Set by libavcodec.\
756 * - decoding: Set by libavcodec.\
761 * Picture type of the frame, see ?_TYPE below.\
762 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
763 * - decoding: Set by libavcodec.\
768 * presentation timestamp in time_base units (time when frame should be shown to user)\
769 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
770 * - encoding: MUST be set by user.\
771 * - decoding: Set by libavcodec.\
776 * picture number in bitstream order\
777 * - encoding: set by\
778 * - decoding: Set by libavcodec.\
780 int coded_picture_number;\
782 * picture number in display order\
783 * - encoding: set by\
784 * - decoding: Set by libavcodec.\
786 int display_picture_number;\
789 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
790 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
791 * - decoding: Set by libavcodec.\
796 * buffer age (1->was last buffer and dint change, 2->..., ...).\
797 * Set to INT_MAX if the buffer has not been used yet.\
798 * - encoding: unused\
799 * - decoding: MUST be set by get_buffer().\
804 * is this picture used as reference\
805 * The values for this are the same as the MpegEncContext.picture_structure\
806 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
807 * Set to 4 for delayed, non-reference frames.\
808 * - encoding: unused\
809 * - decoding: Set by libavcodec. (before get_buffer() call)).\
815 * - encoding: unused\
816 * - decoding: Set by libavcodec.\
818 int8_t *qscale_table;\
821 * - encoding: unused\
822 * - decoding: Set by libavcodec.\
827 * mbskip_table[mb]>=1 if MB didn't change\
828 * stride= mb_width = (width+15)>>4\
829 * - encoding: unused\
830 * - decoding: Set by libavcodec.\
832 uint8_t *mbskip_table;\
835 * motion vector table\
838 * int mv_sample_log2= 4 - motion_subsample_log2;\
839 * int mb_width= (width+15)>>4;\
840 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
841 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
843 * - encoding: Set by user.\
844 * - decoding: Set by libavcodec.\
846 int16_t (*motion_val[2])[2];\
849 * macroblock type table\
850 * mb_type_base + mb_width + 2\
851 * - encoding: Set by user.\
852 * - decoding: Set by libavcodec.\
857 * log2 of the size of the block which a single vector in motion_val represents: \
858 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
859 * - encoding: unused\
860 * - decoding: Set by libavcodec.\
862 uint8_t motion_subsample_log2;\
865 * for some private data of the user\
866 * - encoding: unused\
867 * - decoding: Set by user.\
873 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
874 * - decoding: unused\
879 * type of the buffer (to keep track of who has to deallocate data[*])\
880 * - encoding: Set by the one who allocates it.\
881 * - decoding: Set by the one who allocates it.\
882 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
887 * When decoding, this signals how much the picture must be delayed.\
888 * extra_delay = repeat_pict / (2*fps)\
889 * - encoding: unused\
890 * - decoding: Set by libavcodec.\
900 * The content of the picture is interlaced.\
901 * - encoding: Set by user.\
902 * - decoding: Set by libavcodec. (default 0)\
904 int interlaced_frame;\
907 * If the content is interlaced, is top field displayed first.\
908 * - encoding: Set by user.\
909 * - decoding: Set by libavcodec.\
911 int top_field_first;\
915 * - encoding: Set by user.\
916 * - decoding: Set by libavcodec.\
918 AVPanScan *pan_scan;\
921 * Tell user application that palette has changed from previous frame.\
922 * - encoding: ??? (no palette-enabled encoder yet)\
923 * - decoding: Set by libavcodec. (default 0).\
925 int palette_has_changed;\
928 * codec suggestion on buffer type if != 0\
929 * - encoding: unused\
930 * - decoding: Set by libavcodec. (before get_buffer() call)).\
936 * - encoding: unused\
937 * - decoding: Set by libavcodec.\
942 * motion reference frame index\
943 * the order in which these are stored can depend on the codec.\
944 * - encoding: Set by user.\
945 * - decoding: Set by libavcodec.\
947 int8_t *ref_index[2];\
950 * reordered opaque 64bit (generally an integer or a double precision float\
951 * PTS but can be anything). \
952 * The user sets AVCodecContext.reordered_opaque to represent the input at\
954 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
955 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
956 * @deprecated in favor of pkt_pts\
957 * - encoding: unused\
958 * - decoding: Read by user.\
960 int64_t reordered_opaque;\
963 * hardware accelerator private data (Libav-allocated)\
964 * - encoding: unused\
965 * - decoding: Set by libavcodec\
967 void *hwaccel_picture_private;\
970 * reordered pts from the last AVPacket that has been input into the decoder\
971 * - encoding: unused\
972 * - decoding: Read by user.\
977 * dts from the last AVPacket that has been input into the decoder\
978 * - encoding: unused\
979 * - decoding: Read by user.\
984 * the AVCodecContext which ff_thread_get_buffer() was last called on\
985 * - encoding: Set by libavcodec.\
986 * - decoding: Set by libavcodec.\
988 struct AVCodecContext *owner;\
991 * used by multithreading to store frame-specific info\
992 * - encoding: Set by libavcodec.\
993 * - decoding: Set by libavcodec.\
995 void *thread_opaque;\
997 #define FF_QSCALE_TYPE_MPEG1 0
998 #define FF_QSCALE_TYPE_MPEG2 1
999 #define FF_QSCALE_TYPE_H264 2
1000 #define FF_QSCALE_TYPE_VP56 3
1002 #define FF_BUFFER_TYPE_INTERNAL 1
1003 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1004 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1005 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1008 #define FF_I_TYPE 1 ///< Intra
1009 #define FF_P_TYPE 2 ///< Predicted
1010 #define FF_B_TYPE 3 ///< Bi-dir predicted
1011 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
1012 #define FF_SI_TYPE 5 ///< Switching Intra
1013 #define FF_SP_TYPE 6 ///< Switching Predicted
1014 #define FF_BI_TYPE 7
1016 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1017 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1018 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1019 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1021 enum AVPacketSideDataType {
1022 AV_PKT_DATA_PALETTE,
1025 typedef struct AVPacket {
1027 * Presentation timestamp in AVStream->time_base units; the time at which
1028 * the decompressed packet will be presented to the user.
1029 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1030 * pts MUST be larger or equal to dts as presentation cannot happen before
1031 * decompression, unless one wants to view hex dumps. Some formats misuse
1032 * the terms dts and pts/cts to mean something different. Such timestamps
1033 * must be converted to true pts/dts before they are stored in AVPacket.
1037 * Decompression timestamp in AVStream->time_base units; the time at which
1038 * the packet is decompressed.
1039 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1047 * Additional packet data that can be provided by the container.
1048 * Packet can contain several types of side information.
1053 enum AVPacketSideDataType type;
1055 int side_data_elems;
1058 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1059 * Equals next_pts - this_pts in presentation order.
1062 void (*destruct)(struct AVPacket *);
1064 int64_t pos; ///< byte position in stream, -1 if unknown
1067 * Time difference in AVStream->time_base units from the pts of this
1068 * packet to the point at which the output from the decoder has converged
1069 * independent from the availability of previous frames. That is, the
1070 * frames are virtually identical no matter if decoding started from
1071 * the very first frame or from this keyframe.
1072 * Is AV_NOPTS_VALUE if unknown.
1073 * This field is not the display duration of the current packet.
1074 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1077 * The purpose of this field is to allow seeking in streams that have no
1078 * keyframes in the conventional sense. It corresponds to the
1079 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1080 * essential for some types of subtitle streams to ensure that all
1081 * subtitles are correctly displayed after seeking.
1083 int64_t convergence_duration;
1085 #define AV_PKT_FLAG_KEY 0x0001
1088 * Audio Video Frame.
1089 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1091 * Removal, reordering and changes to existing fields require a major
1092 * version bump. No fields should be added into AVFrame before or after
1094 * sizeof(AVFrame) must not be used outside libav*.
1096 typedef struct AVFrame {
1101 * main external API structure.
1102 * New fields can be added to the end with minor version bumps.
1103 * Removal, reordering and changes to existing fields require a major
1105 * sizeof(AVCodecContext) must not be used outside libav*.
1107 typedef struct AVCodecContext {
1109 * information on struct for av_log
1110 * - set by avcodec_alloc_context
1112 const AVClass *av_class;
1114 * the average bitrate
1115 * - encoding: Set by user; unused for constant quantizer encoding.
1116 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1121 * number of bits the bitstream is allowed to diverge from the reference.
1122 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1123 * - encoding: Set by user; unused for constant quantizer encoding.
1124 * - decoding: unused
1126 int bit_rate_tolerance;
1130 * - encoding: Set by user.
1131 * - decoding: Set by user.
1136 * Some codecs need additional format info. It is stored here.
1137 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1138 * specific codec MUST set it correctly otherwise stream copy breaks.
1139 * In general use of this field by muxers is not recommanded.
1140 * - encoding: Set by libavcodec.
1141 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1146 * Motion estimation algorithm used for video coding.
1147 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1148 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1149 * - encoding: MUST be set by user.
1150 * - decoding: unused
1155 * some codecs need / can use extradata like Huffman tables.
1156 * mjpeg: Huffman tables
1157 * rv10: additional flags
1158 * mpeg4: global headers (they can be in the bitstream or here)
1159 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1160 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1161 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1162 * - encoding: Set/allocated/freed by libavcodec.
1163 * - decoding: Set/allocated/freed by user.
1169 * This is the fundamental unit of time (in seconds) in terms
1170 * of which frame timestamps are represented. For fixed-fps content,
1171 * timebase should be 1/framerate and timestamp increments should be
1173 * - encoding: MUST be set by user.
1174 * - decoding: Set by libavcodec.
1176 AVRational time_base;
1180 * picture width / height.
1181 * - encoding: MUST be set by user.
1182 * - decoding: Set by libavcodec.
1183 * Note: For compatibility it is possible to set this instead of
1184 * coded_width/height before decoding.
1188 #define FF_ASPECT_EXTENDED 15
1191 * the number of pictures in a group of pictures, or 0 for intra_only
1192 * - encoding: Set by user.
1193 * - decoding: unused
1198 * Pixel format, see PIX_FMT_xxx.
1199 * May be set by the demuxer if known from headers.
1200 * May be overriden by the decoder if it knows better.
1201 * - encoding: Set by user.
1202 * - decoding: Set by user if known, overridden by libavcodec if known
1204 enum PixelFormat pix_fmt;
1207 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1208 * decoder to draw a horizontal band. It improves cache usage. Not
1209 * all codecs can do that. You must check the codec capabilities
1211 * When multithreading is used, it may be called from multiple threads
1212 * at the same time; threads might draw different parts of the same AVFrame,
1213 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1215 * The function is also used by hardware acceleration APIs.
1216 * It is called at least once during frame decoding to pass
1217 * the data needed for hardware render.
1218 * In that mode instead of pixel data, AVFrame points to
1219 * a structure specific to the acceleration API. The application
1220 * reads the structure and can change some fields to indicate progress
1222 * - encoding: unused
1223 * - decoding: Set by user.
1224 * @param height the height of the slice
1225 * @param y the y position of the slice
1226 * @param type 1->top field, 2->bottom field, 3->frame
1227 * @param offset offset into the AVFrame.data from which the slice should be read
1229 void (*draw_horiz_band)(struct AVCodecContext *s,
1230 const AVFrame *src, int offset[4],
1231 int y, int type, int height);
1234 int sample_rate; ///< samples per second
1235 int channels; ///< number of audio channels
1238 * audio sample format
1239 * - encoding: Set by user.
1240 * - decoding: Set by libavcodec.
1242 enum AVSampleFormat sample_fmt; ///< sample format
1244 /* The following data should not be initialized. */
1246 * Samples per packet, initialized when calling 'init'.
1249 int frame_number; ///< audio or video frame number
1252 * Number of frames the decoded output will be delayed relative to
1253 * the encoded input.
1254 * - encoding: Set by libavcodec.
1255 * - decoding: unused
1259 /* - encoding parameters */
1260 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1261 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1265 * - encoding: Set by user.
1266 * - decoding: unused
1272 * - encoding: Set by user.
1273 * - decoding: unused
1278 * maximum quantizer difference between frames
1279 * - encoding: Set by user.
1280 * - decoding: unused
1285 * maximum number of B-frames between non-B-frames
1286 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1287 * - encoding: Set by user.
1288 * - decoding: unused
1293 * qscale factor between IP and B-frames
1294 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1295 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1296 * - encoding: Set by user.
1297 * - decoding: unused
1299 float b_quant_factor;
1301 /** obsolete FIXME remove */
1303 #define FF_RC_STRATEGY_XVID 1
1305 int b_frame_strategy;
1307 struct AVCodec *codec;
1311 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1312 /* do its best to deliver a chunk with size */
1313 /* below rtp_payload_size, the chunk will start */
1314 /* with a start code on some codecs like H.263. */
1315 /* This doesn't take account of any particular */
1316 /* headers inside the transmitted RTP payload. */
1319 /* The RTP callback: This function is called */
1320 /* every time the encoder has a packet to send. */
1321 /* It depends on the encoder if the data starts */
1322 /* with a Start Code (it should). H.263 does. */
1323 /* mb_nb contains the number of macroblocks */
1324 /* encoded in the RTP payload. */
1325 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1327 /* statistics, used for 2-pass encoding */
1338 * number of bits used for the previously encoded frame
1339 * - encoding: Set by libavcodec.
1340 * - decoding: unused
1345 * Private data of the user, can be used to carry app specific stuff.
1346 * - encoding: Set by user.
1347 * - decoding: Set by user.
1351 char codec_name[32];
1352 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1353 enum CodecID codec_id; /* see CODEC_ID_xxx */
1356 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1357 * This is used to work around some encoder bugs.
1358 * A demuxer should set this to what is stored in the field used to identify the codec.
1359 * If there are multiple such fields in a container then the demuxer should choose the one
1360 * which maximizes the information about the used codec.
1361 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1362 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1363 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1365 * - encoding: Set by user, if not then the default based on codec_id will be used.
1366 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1368 unsigned int codec_tag;
1371 * Work around bugs in encoders which sometimes cannot be detected automatically.
1372 * - encoding: Set by user
1373 * - decoding: Set by user
1375 int workaround_bugs;
1376 #define FF_BUG_AUTODETECT 1 ///< autodetection
1377 #define FF_BUG_OLD_MSMPEG4 2
1378 #define FF_BUG_XVID_ILACE 4
1379 #define FF_BUG_UMP4 8
1380 #define FF_BUG_NO_PADDING 16
1381 #define FF_BUG_AMV 32
1382 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1383 #define FF_BUG_QPEL_CHROMA 64
1384 #define FF_BUG_STD_QPEL 128
1385 #define FF_BUG_QPEL_CHROMA2 256
1386 #define FF_BUG_DIRECT_BLOCKSIZE 512
1387 #define FF_BUG_EDGE 1024
1388 #define FF_BUG_HPEL_CHROMA 2048
1389 #define FF_BUG_DC_CLIP 4096
1390 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1391 #define FF_BUG_TRUNCATED 16384
1392 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1395 * luma single coefficient elimination threshold
1396 * - encoding: Set by user.
1397 * - decoding: unused
1399 int luma_elim_threshold;
1402 * chroma single coeff elimination threshold
1403 * - encoding: Set by user.
1404 * - decoding: unused
1406 int chroma_elim_threshold;
1409 * strictly follow the standard (MPEG4, ...).
1410 * - encoding: Set by user.
1411 * - decoding: Set by user.
1412 * Setting this to STRICT or higher means the encoder and decoder will
1413 * generally do stupid things, whereas setting it to unofficial or lower
1414 * will mean the encoder might produce output that is not supported by all
1415 * spec-compliant decoders. Decoders don't differentiate between normal,
1416 * unofficial and experimental (that is, they always try to decode things
1417 * when they can) unless they are explicitly asked to behave stupidly
1418 * (=strictly conform to the specs)
1420 int strict_std_compliance;
1421 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1422 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1423 #define FF_COMPLIANCE_NORMAL 0
1424 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1425 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1428 * qscale offset between IP and B-frames
1429 * - encoding: Set by user.
1430 * - decoding: unused
1432 float b_quant_offset;
1435 * Error recognization; higher values will detect more errors but may
1436 * misdetect some more or less valid parts as errors.
1437 * - encoding: unused
1438 * - decoding: Set by user.
1440 int error_recognition;
1441 #define FF_ER_CAREFUL 1
1442 #define FF_ER_COMPLIANT 2
1443 #define FF_ER_AGGRESSIVE 3
1444 #define FF_ER_VERY_AGGRESSIVE 4
1447 * Called at the beginning of each frame to get a buffer for it.
1448 * If pic.reference is set then the frame will be read later by libavcodec.
1449 * avcodec_align_dimensions2() should be used to find the required width and
1450 * height, as they normally need to be rounded up to the next multiple of 16.
1451 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1452 * avcodec_default_get_buffer() instead of providing buffers allocated by
1454 * If frame multithreading is used and thread_safe_callbacks is set,
1455 * it may be called from a different thread, but not from more than one at once.
1456 * Does not need to be reentrant.
1457 * - encoding: unused
1458 * - decoding: Set by libavcodec, user can override.
1460 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1463 * Called to release buffers which were allocated with get_buffer.
1464 * A released buffer can be reused in get_buffer().
1465 * pic.data[*] must be set to NULL.
1466 * May be called from a different thread if frame multithreading is used,
1467 * but not by more than one thread at once, so does not need to be reentrant.
1468 * - encoding: unused
1469 * - decoding: Set by libavcodec, user can override.
1471 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1474 * Size of the frame reordering buffer in the decoder.
1475 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1476 * - encoding: Set by libavcodec.
1477 * - decoding: Set by libavcodec.
1482 * number of bytes per packet if constant and known or 0
1483 * Used by some WAV based audio codecs.
1487 int parse_only; /* - decoding only: If true, only parsing is done
1488 (function avcodec_parse_frame()). The frame
1489 data is returned. Only MPEG codecs support this now. */
1492 * 0-> h263 quant 1-> mpeg quant
1493 * - encoding: Set by user.
1494 * - decoding: unused
1499 * pass1 encoding statistics output buffer
1500 * - encoding: Set by libavcodec.
1501 * - decoding: unused
1506 * pass2 encoding statistics input buffer
1507 * Concatenated stuff from stats_out of pass1 should be placed here.
1508 * - encoding: Allocated/set/freed by user.
1509 * - decoding: unused
1514 * ratecontrol qmin qmax limiting method
1515 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1516 * - encoding: Set by user.
1517 * - decoding: unused
1525 * ratecontrol override, see RcOverride
1526 * - encoding: Allocated/set/freed by user.
1527 * - decoding: unused
1529 RcOverride *rc_override;
1530 int rc_override_count;
1533 * rate control equation
1534 * - encoding: Set by user
1535 * - decoding: unused
1541 * - encoding: Set by user.
1542 * - decoding: unused
1548 * - encoding: Set by user.
1549 * - decoding: unused
1554 * decoder bitstream buffer size
1555 * - encoding: Set by user.
1556 * - decoding: unused
1559 float rc_buffer_aggressivity;
1562 * qscale factor between P and I-frames
1563 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1564 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1565 * - encoding: Set by user.
1566 * - decoding: unused
1568 float i_quant_factor;
1571 * qscale offset between P and I-frames
1572 * - encoding: Set by user.
1573 * - decoding: unused
1575 float i_quant_offset;
1578 * initial complexity for pass1 ratecontrol
1579 * - encoding: Set by user.
1580 * - decoding: unused
1582 float rc_initial_cplx;
1585 * DCT algorithm, see FF_DCT_* below
1586 * - encoding: Set by user.
1587 * - decoding: unused
1590 #define FF_DCT_AUTO 0
1591 #define FF_DCT_FASTINT 1
1592 #define FF_DCT_INT 2
1593 #define FF_DCT_MMX 3
1594 #define FF_DCT_MLIB 4
1595 #define FF_DCT_ALTIVEC 5
1596 #define FF_DCT_FAAN 6
1599 * luminance masking (0-> disabled)
1600 * - encoding: Set by user.
1601 * - decoding: unused
1606 * temporary complexity masking (0-> disabled)
1607 * - encoding: Set by user.
1608 * - decoding: unused
1610 float temporal_cplx_masking;
1613 * spatial complexity masking (0-> disabled)
1614 * - encoding: Set by user.
1615 * - decoding: unused
1617 float spatial_cplx_masking;
1620 * p block masking (0-> disabled)
1621 * - encoding: Set by user.
1622 * - decoding: unused
1627 * darkness masking (0-> disabled)
1628 * - encoding: Set by user.
1629 * - decoding: unused
1634 * IDCT algorithm, see FF_IDCT_* below.
1635 * - encoding: Set by user.
1636 * - decoding: Set by user.
1639 #define FF_IDCT_AUTO 0
1640 #define FF_IDCT_INT 1
1641 #define FF_IDCT_SIMPLE 2
1642 #define FF_IDCT_SIMPLEMMX 3
1643 #define FF_IDCT_LIBMPEG2MMX 4
1644 #define FF_IDCT_PS2 5
1645 #define FF_IDCT_MLIB 6
1646 #define FF_IDCT_ARM 7
1647 #define FF_IDCT_ALTIVEC 8
1648 #define FF_IDCT_SH4 9
1649 #define FF_IDCT_SIMPLEARM 10
1650 #define FF_IDCT_H264 11
1651 #define FF_IDCT_VP3 12
1652 #define FF_IDCT_IPP 13
1653 #define FF_IDCT_XVIDMMX 14
1654 #define FF_IDCT_CAVS 15
1655 #define FF_IDCT_SIMPLEARMV5TE 16
1656 #define FF_IDCT_SIMPLEARMV6 17
1657 #define FF_IDCT_SIMPLEVIS 18
1658 #define FF_IDCT_WMV2 19
1659 #define FF_IDCT_FAAN 20
1660 #define FF_IDCT_EA 21
1661 #define FF_IDCT_SIMPLENEON 22
1662 #define FF_IDCT_SIMPLEALPHA 23
1663 #define FF_IDCT_BINK 24
1667 * - encoding: Set by libavcodec.
1668 * - decoding: Set by user (or 0).
1672 * slice offsets in the frame in bytes
1673 * - encoding: Set/allocated by libavcodec.
1674 * - decoding: Set/allocated by user (or NULL).
1679 * error concealment flags
1680 * - encoding: unused
1681 * - decoding: Set by user.
1683 int error_concealment;
1684 #define FF_EC_GUESS_MVS 1
1685 #define FF_EC_DEBLOCK 2
1688 * dsp_mask could be add used to disable unwanted CPU features
1689 * CPU features (i.e. MMX, SSE. ...)
1691 * With the FORCE flag you may instead enable given CPU features.
1692 * (Dangerous: Usable in case of misdetection, improper usage however will
1693 * result into program crash.)
1698 * bits per sample/pixel from the demuxer (needed for huffyuv).
1699 * - encoding: Set by libavcodec.
1700 * - decoding: Set by user.
1702 int bits_per_coded_sample;
1705 * prediction method (needed for huffyuv)
1706 * - encoding: Set by user.
1707 * - decoding: unused
1709 int prediction_method;
1710 #define FF_PRED_LEFT 0
1711 #define FF_PRED_PLANE 1
1712 #define FF_PRED_MEDIAN 2
1715 * sample aspect ratio (0 if unknown)
1716 * That is the width of a pixel divided by the height of the pixel.
1717 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1718 * - encoding: Set by user.
1719 * - decoding: Set by libavcodec.
1721 AVRational sample_aspect_ratio;
1724 * the picture in the bitstream
1725 * - encoding: Set by libavcodec.
1726 * - decoding: Set by libavcodec.
1728 AVFrame *coded_frame;
1732 * - encoding: Set by user.
1733 * - decoding: Set by user.
1736 #define FF_DEBUG_PICT_INFO 1
1737 #define FF_DEBUG_RC 2
1738 #define FF_DEBUG_BITSTREAM 4
1739 #define FF_DEBUG_MB_TYPE 8
1740 #define FF_DEBUG_QP 16
1741 #define FF_DEBUG_MV 32
1742 #define FF_DEBUG_DCT_COEFF 0x00000040
1743 #define FF_DEBUG_SKIP 0x00000080
1744 #define FF_DEBUG_STARTCODE 0x00000100
1745 #define FF_DEBUG_PTS 0x00000200
1746 #define FF_DEBUG_ER 0x00000400
1747 #define FF_DEBUG_MMCO 0x00000800
1748 #define FF_DEBUG_BUGS 0x00001000
1749 #define FF_DEBUG_VIS_QP 0x00002000
1750 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1751 #define FF_DEBUG_BUFFERS 0x00008000
1752 #define FF_DEBUG_THREADS 0x00010000
1756 * - encoding: Set by user.
1757 * - decoding: Set by user.
1760 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1761 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1762 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1766 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1767 * - decoding: unused
1772 * motion estimation comparison function
1773 * - encoding: Set by user.
1774 * - decoding: unused
1778 * subpixel motion estimation comparison function
1779 * - encoding: Set by user.
1780 * - decoding: unused
1784 * macroblock comparison function (not supported yet)
1785 * - encoding: Set by user.
1786 * - decoding: unused
1790 * interlaced DCT comparison function
1791 * - encoding: Set by user.
1792 * - decoding: unused
1795 #define FF_CMP_SAD 0
1796 #define FF_CMP_SSE 1
1797 #define FF_CMP_SATD 2
1798 #define FF_CMP_DCT 3
1799 #define FF_CMP_PSNR 4
1800 #define FF_CMP_BIT 5
1802 #define FF_CMP_ZERO 7
1803 #define FF_CMP_VSAD 8
1804 #define FF_CMP_VSSE 9
1805 #define FF_CMP_NSSE 10
1806 #define FF_CMP_W53 11
1807 #define FF_CMP_W97 12
1808 #define FF_CMP_DCTMAX 13
1809 #define FF_CMP_DCT264 14
1810 #define FF_CMP_CHROMA 256
1813 * ME diamond size & shape
1814 * - encoding: Set by user.
1815 * - decoding: unused
1820 * amount of previous MV predictors (2a+1 x 2a+1 square)
1821 * - encoding: Set by user.
1822 * - decoding: unused
1824 int last_predictor_count;
1827 * prepass for motion estimation
1828 * - encoding: Set by user.
1829 * - decoding: unused
1834 * motion estimation prepass comparison function
1835 * - encoding: Set by user.
1836 * - decoding: unused
1841 * ME prepass diamond size & shape
1842 * - encoding: Set by user.
1843 * - decoding: unused
1849 * - encoding: Set by user.
1850 * - decoding: unused
1852 int me_subpel_quality;
1855 * callback to negotiate the pixelFormat
1856 * @param fmt is the list of formats which are supported by the codec,
1857 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1858 * The first is always the native one.
1859 * @return the chosen format
1860 * - encoding: unused
1861 * - decoding: Set by user, if not set the native format will be chosen.
1863 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1866 * DTG active format information (additional aspect ratio
1867 * information only used in DVB MPEG-2 transport streams)
1870 * - encoding: unused
1871 * - decoding: Set by decoder.
1873 int dtg_active_format;
1874 #define FF_DTG_AFD_SAME 8
1875 #define FF_DTG_AFD_4_3 9
1876 #define FF_DTG_AFD_16_9 10
1877 #define FF_DTG_AFD_14_9 11
1878 #define FF_DTG_AFD_4_3_SP_14_9 13
1879 #define FF_DTG_AFD_16_9_SP_14_9 14
1880 #define FF_DTG_AFD_SP_4_3 15
1883 * maximum motion estimation search range in subpel units
1884 * If 0 then no limit.
1886 * - encoding: Set by user.
1887 * - decoding: unused
1892 * intra quantizer bias
1893 * - encoding: Set by user.
1894 * - decoding: unused
1896 int intra_quant_bias;
1897 #define FF_DEFAULT_QUANT_BIAS 999999
1900 * inter quantizer bias
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int inter_quant_bias;
1908 * - encoding: unused
1909 * - decoding: Which clrtable should be used for 8bit RGB images.
1910 * Tables have to be stored somewhere. FIXME
1915 * internal_buffer count
1916 * Don't touch, used by libavcodec default_get_buffer().
1918 int internal_buffer_count;
1922 * Don't touch, used by libavcodec default_get_buffer().
1924 void *internal_buffer;
1927 * Global quality for codecs which cannot change it per frame.
1928 * This should be proportional to MPEG-1/2/4 qscale.
1929 * - encoding: Set by user.
1930 * - decoding: unused
1934 #define FF_CODER_TYPE_VLC 0
1935 #define FF_CODER_TYPE_AC 1
1936 #define FF_CODER_TYPE_RAW 2
1937 #define FF_CODER_TYPE_RLE 3
1938 #define FF_CODER_TYPE_DEFLATE 4
1941 * - encoding: Set by user.
1942 * - decoding: unused
1948 * - encoding: Set by user.
1949 * - decoding: unused
1955 * - encoding: unused
1956 * - decoding: Set by user.
1958 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1963 * - encoding: unused
1964 * - decoding: Set by user.
1967 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1968 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1969 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1972 * XVideo Motion Acceleration
1973 * - encoding: forbidden
1974 * - decoding: set by decoder
1976 int xvmc_acceleration;
1979 * macroblock decision mode
1980 * - encoding: Set by user.
1981 * - decoding: unused
1984 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1985 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1986 #define FF_MB_DECISION_RD 2 ///< rate distortion
1989 * custom intra quantization matrix
1990 * - encoding: Set by user, can be NULL.
1991 * - decoding: Set by libavcodec.
1993 uint16_t *intra_matrix;
1996 * custom inter quantization matrix
1997 * - encoding: Set by user, can be NULL.
1998 * - decoding: Set by libavcodec.
2000 uint16_t *inter_matrix;
2003 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2004 * This is used to work around some encoder bugs.
2005 * - encoding: unused
2006 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2008 unsigned int stream_codec_tag;
2011 * scene change detection threshold
2012 * 0 is default, larger means fewer detected scene changes.
2013 * - encoding: Set by user.
2014 * - decoding: unused
2016 int scenechange_threshold;
2019 * minimum Lagrange multipler
2020 * - encoding: Set by user.
2021 * - decoding: unused
2026 * maximum Lagrange multipler
2027 * - encoding: Set by user.
2028 * - decoding: unused
2032 #if FF_API_PALETTE_CONTROL
2034 * palette control structure
2035 * - encoding: ??? (no palette-enabled encoder yet)
2036 * - decoding: Set by user.
2038 struct AVPaletteControl *palctrl;
2042 * noise reduction strength
2043 * - encoding: Set by user.
2044 * - decoding: unused
2046 int noise_reduction;
2049 * Called at the beginning of a frame to get cr buffer for it.
2050 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2051 * libavcodec will pass previous buffer in pic, function should return
2052 * same buffer or new buffer with old frame "painted" into it.
2053 * If pic.data[0] == NULL must behave like get_buffer().
2054 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2055 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2057 * - encoding: unused
2058 * - decoding: Set by libavcodec, user can override.
2060 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2063 * Number of bits which should be loaded into the rc buffer before decoding starts.
2064 * - encoding: Set by user.
2065 * - decoding: unused
2067 int rc_initial_buffer_occupancy;
2071 * - encoding: Set by user.
2072 * - decoding: unused
2074 int inter_threshold;
2078 * - encoding: Set by user.
2079 * - decoding: Set by user.
2084 * Simulates errors in the bitstream to test error concealment.
2085 * - encoding: Set by user.
2086 * - decoding: unused
2090 #if FF_API_ANTIALIAS_ALGO
2092 * MP3 antialias algorithm, see FF_AA_* below.
2093 * - encoding: unused
2094 * - decoding: Set by user.
2096 attribute_deprecated int antialias_algo;
2097 #define FF_AA_AUTO 0
2098 #define FF_AA_FASTINT 1 //not implemented yet
2100 #define FF_AA_FLOAT 3
2104 * quantizer noise shaping
2105 * - encoding: Set by user.
2106 * - decoding: unused
2108 int quantizer_noise_shaping;
2112 * is used to decide how many independent tasks should be passed to execute()
2113 * - encoding: Set by user.
2114 * - decoding: Set by user.
2119 * The codec may call this to execute several independent things.
2120 * It will return only after finishing all tasks.
2121 * The user may replace this with some multithreaded implementation,
2122 * the default implementation will execute the parts serially.
2123 * @param count the number of things to execute
2124 * - encoding: Set by libavcodec, user can override.
2125 * - decoding: Set by libavcodec, user can override.
2127 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2131 * Can be used by execute() to store some per AVCodecContext stuff.
2132 * - encoding: set by execute()
2133 * - decoding: set by execute()
2135 void *thread_opaque;
2138 * Motion estimation threshold below which no motion estimation is
2139 * performed, but instead the user specified motion vectors are used.
2141 * - encoding: Set by user.
2142 * - decoding: unused
2147 * Macroblock threshold below which the user specified macroblock types will be used.
2148 * - encoding: Set by user.
2149 * - decoding: unused
2154 * precision of the intra DC coefficient - 8
2155 * - encoding: Set by user.
2156 * - decoding: unused
2158 int intra_dc_precision;
2161 * noise vs. sse weight for the nsse comparsion function
2162 * - encoding: Set by user.
2163 * - decoding: unused
2168 * Number of macroblock rows at the top which are skipped.
2169 * - encoding: unused
2170 * - decoding: Set by user.
2175 * Number of macroblock rows at the bottom which are skipped.
2176 * - encoding: unused
2177 * - decoding: Set by user.
2183 * - encoding: Set by user.
2184 * - decoding: Set by libavcodec.
2187 #define FF_PROFILE_UNKNOWN -99
2188 #define FF_PROFILE_RESERVED -100
2190 #define FF_PROFILE_AAC_MAIN 0
2191 #define FF_PROFILE_AAC_LOW 1
2192 #define FF_PROFILE_AAC_SSR 2
2193 #define FF_PROFILE_AAC_LTP 3
2195 #define FF_PROFILE_DTS 20
2196 #define FF_PROFILE_DTS_ES 30
2197 #define FF_PROFILE_DTS_96_24 40
2198 #define FF_PROFILE_DTS_HD_HRA 50
2199 #define FF_PROFILE_DTS_HD_MA 60
2201 #define FF_PROFILE_MPEG2_422 0
2202 #define FF_PROFILE_MPEG2_HIGH 1
2203 #define FF_PROFILE_MPEG2_SS 2
2204 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2205 #define FF_PROFILE_MPEG2_MAIN 4
2206 #define FF_PROFILE_MPEG2_SIMPLE 5
2208 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2209 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2211 #define FF_PROFILE_H264_BASELINE 66
2212 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2213 #define FF_PROFILE_H264_MAIN 77
2214 #define FF_PROFILE_H264_EXTENDED 88
2215 #define FF_PROFILE_H264_HIGH 100
2216 #define FF_PROFILE_H264_HIGH_10 110
2217 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2218 #define FF_PROFILE_H264_HIGH_422 122
2219 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2220 #define FF_PROFILE_H264_HIGH_444 144
2221 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2222 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2223 #define FF_PROFILE_H264_CAVLC_444 44
2225 #define FF_PROFILE_VC1_SIMPLE 0
2226 #define FF_PROFILE_VC1_MAIN 1
2227 #define FF_PROFILE_VC1_COMPLEX 2
2228 #define FF_PROFILE_VC1_ADVANCED 3
2232 * - encoding: Set by user.
2233 * - decoding: Set by libavcodec.
2236 #define FF_LEVEL_UNKNOWN -99
2239 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2240 * - encoding: unused
2241 * - decoding: Set by user.
2246 * Bitstream width / height, may be different from width/height if lowres
2247 * or other things are used.
2248 * - encoding: unused
2249 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2251 int coded_width, coded_height;
2254 * frame skip threshold
2255 * - encoding: Set by user.
2256 * - decoding: unused
2258 int frame_skip_threshold;
2262 * - encoding: Set by user.
2263 * - decoding: unused
2265 int frame_skip_factor;
2268 * frame skip exponent
2269 * - encoding: Set by user.
2270 * - decoding: unused
2275 * frame skip comparison function
2276 * - encoding: Set by user.
2277 * - decoding: unused
2282 * Border processing masking, raises the quantizer for mbs on the borders
2284 * - encoding: Set by user.
2285 * - decoding: unused
2287 float border_masking;
2290 * minimum MB lagrange multipler
2291 * - encoding: Set by user.
2292 * - decoding: unused
2297 * maximum MB lagrange multipler
2298 * - encoding: Set by user.
2299 * - decoding: unused
2305 * - encoding: Set by user.
2306 * - decoding: unused
2308 int me_penalty_compensation;
2312 * - encoding: unused
2313 * - decoding: Set by user.
2315 enum AVDiscard skip_loop_filter;
2319 * - encoding: unused
2320 * - decoding: Set by user.
2322 enum AVDiscard skip_idct;
2326 * - encoding: unused
2327 * - decoding: Set by user.
2329 enum AVDiscard skip_frame;
2333 * - encoding: Set by user.
2334 * - decoding: unused
2340 * - encoding: Set by user.
2341 * - decoding: unused
2346 * constant rate factor - quality-based VBR - values ~correspond to qps
2347 * - encoding: Set by user.
2348 * - decoding: unused
2353 * constant quantization parameter rate control method
2354 * - encoding: Set by user.
2355 * - decoding: unused
2361 * - encoding: Set by user.
2362 * - decoding: unused
2367 * number of reference frames
2368 * - encoding: Set by user.
2369 * - decoding: Set by lavc.
2374 * chroma qp offset from luma
2375 * - encoding: Set by user.
2376 * - decoding: unused
2381 * Influences how often B-frames are used.
2382 * - encoding: Set by user.
2383 * - decoding: unused
2388 * trellis RD quantization
2389 * - encoding: Set by user.
2390 * - decoding: unused
2395 * Reduce fluctuations in qp (before curve compression).
2396 * - encoding: Set by user.
2397 * - decoding: unused
2399 float complexityblur;
2402 * in-loop deblocking filter alphac0 parameter
2403 * alpha is in the range -6...6
2404 * - encoding: Set by user.
2405 * - decoding: unused
2410 * in-loop deblocking filter beta parameter
2411 * beta is in the range -6...6
2412 * - encoding: Set by user.
2413 * - decoding: unused
2418 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2419 * - encoding: Set by user.
2420 * - decoding: unused
2423 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2424 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2425 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2426 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2427 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2430 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2431 * - encoding: Set by user.
2432 * - decoding: unused
2437 * Audio cutoff bandwidth (0 means "automatic")
2438 * - encoding: Set by user.
2439 * - decoding: unused
2444 * Multiplied by qscale for each frame and added to scene_change_score.
2445 * - encoding: Set by user.
2446 * - decoding: unused
2448 int scenechange_factor;
2452 * Note: Value depends upon the compare function used for fullpel ME.
2453 * - encoding: Set by user.
2454 * - decoding: unused
2459 * Adjusts sensitivity of b_frame_strategy 1.
2460 * - encoding: Set by user.
2461 * - decoding: unused
2466 * - encoding: Set by user.
2467 * - decoding: unused
2469 int compression_level;
2470 #define FF_COMPRESSION_DEFAULT -1
2473 * LPC coefficient precision - used by FLAC encoder
2474 * - encoding: Set by user.
2475 * - decoding: unused
2477 int lpc_coeff_precision;
2480 * - encoding: Set by user.
2481 * - decoding: unused
2483 int min_prediction_order;
2486 * - encoding: Set by user.
2487 * - decoding: unused
2489 int max_prediction_order;
2492 * search method for selecting prediction order
2493 * - encoding: Set by user.
2494 * - decoding: unused
2496 int prediction_order_method;
2499 * - encoding: Set by user.
2500 * - decoding: unused
2502 int min_partition_order;
2505 * - encoding: Set by user.
2506 * - decoding: unused
2508 int max_partition_order;
2511 * GOP timecode frame start number, in non drop frame format
2512 * - encoding: Set by user.
2513 * - decoding: unused
2515 int64_t timecode_frame_start;
2517 #if FF_API_REQUEST_CHANNELS
2519 * Decoder should decode to this many channels if it can (0 for default)
2520 * - encoding: unused
2521 * - decoding: Set by user.
2522 * @deprecated Deprecated in favor of request_channel_layout.
2524 int request_channels;
2528 * Percentage of dynamic range compression to be applied by the decoder.
2529 * The default value is 1.0, corresponding to full compression.
2530 * - encoding: unused
2531 * - decoding: Set by user.
2536 * opaque 64bit number (generally a PTS) that will be reordered and
2537 * output in AVFrame.reordered_opaque
2538 * @deprecated in favor of pkt_pts
2539 * - encoding: unused
2540 * - decoding: Set by user.
2542 int64_t reordered_opaque;
2545 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2546 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2547 * - encoding: set by user.
2548 * - decoding: set by libavcodec.
2550 int bits_per_raw_sample;
2553 * Audio channel layout.
2554 * - encoding: set by user.
2555 * - decoding: set by libavcodec.
2557 int64_t channel_layout;
2560 * Request decoder to use this channel layout if it can (0 for default)
2561 * - encoding: unused
2562 * - decoding: Set by user.
2564 int64_t request_channel_layout;
2567 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2568 * - encoding: Set by user.
2569 * - decoding: unused.
2571 float rc_max_available_vbv_use;
2574 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2575 * - encoding: Set by user.
2576 * - decoding: unused.
2578 float rc_min_vbv_overflow_use;
2581 * Hardware accelerator in use
2582 * - encoding: unused.
2583 * - decoding: Set by libavcodec
2585 struct AVHWAccel *hwaccel;
2588 * For some codecs, the time base is closer to the field rate than the frame rate.
2589 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2590 * if no telecine is used ...
2592 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2594 int ticks_per_frame;
2597 * Hardware accelerator context.
2598 * For some hardware accelerators, a global context needs to be
2599 * provided by the user. In that case, this holds display-dependent
2600 * data Libav cannot instantiate itself. Please refer to the
2601 * Libav HW accelerator documentation to know how to fill this
2602 * is. e.g. for VA API, this is a struct vaapi_context.
2603 * - encoding: unused
2604 * - decoding: Set by user
2606 void *hwaccel_context;
2609 * Chromaticity coordinates of the source primaries.
2610 * - encoding: Set by user
2611 * - decoding: Set by libavcodec
2613 enum AVColorPrimaries color_primaries;
2616 * Color Transfer Characteristic.
2617 * - encoding: Set by user
2618 * - decoding: Set by libavcodec
2620 enum AVColorTransferCharacteristic color_trc;
2623 * YUV colorspace type.
2624 * - encoding: Set by user
2625 * - decoding: Set by libavcodec
2627 enum AVColorSpace colorspace;
2630 * MPEG vs JPEG YUV range.
2631 * - encoding: Set by user
2632 * - decoding: Set by libavcodec
2634 enum AVColorRange color_range;
2637 * This defines the location of chroma samples.
2638 * - encoding: Set by user
2639 * - decoding: Set by libavcodec
2641 enum AVChromaLocation chroma_sample_location;
2644 * The codec may call this to execute several independent things.
2645 * It will return only after finishing all tasks.
2646 * The user may replace this with some multithreaded implementation,
2647 * the default implementation will execute the parts serially.
2648 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2649 * @param c context passed also to func
2650 * @param count the number of things to execute
2651 * @param arg2 argument passed unchanged to func
2652 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2653 * @param func function that will be called count times, with jobnr from 0 to count-1.
2654 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2655 * two instances of func executing at the same time will have the same threadnr.
2656 * @return always 0 currently, but code should handle a future improvement where when any call to func
2657 * returns < 0 no further calls to func may be done and < 0 is returned.
2658 * - encoding: Set by libavcodec, user can override.
2659 * - decoding: Set by libavcodec, user can override.
2661 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2664 * explicit P-frame weighted prediction analysis method
2666 * 1: fast blind weighting (one reference duplicate with -1 offset)
2667 * 2: smart weighting (full fade detection analysis)
2668 * - encoding: Set by user.
2669 * - decoding: unused
2671 int weighted_p_pred;
2676 * 1: Variance AQ (complexity mask)
2677 * 2: Auto-variance AQ (experimental)
2678 * - encoding: Set by user
2679 * - decoding: unused
2685 * Reduces blocking and blurring in flat and textured areas.
2686 * - encoding: Set by user
2687 * - decoding: unused
2693 * Strength of psychovisual optimization
2694 * - encoding: Set by user
2695 * - decoding: unused
2701 * Strength of psychovisual optimization
2702 * - encoding: Set by user
2703 * - decoding: unused
2709 * Number of frames for frametype and ratecontrol lookahead
2710 * - encoding: Set by user
2711 * - decoding: unused
2716 * Constant rate factor maximum
2717 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2718 * than crf_max, even if doing so would violate VBV restrictions.
2719 * - encoding: Set by user.
2720 * - decoding: unused
2724 int log_level_offset;
2727 * Determines which LPC analysis algorithm to use.
2728 * - encoding: Set by user
2729 * - decoding: unused
2731 enum AVLPCType lpc_type;
2734 * Number of passes to use for Cholesky factorization during LPC analysis
2735 * - encoding: Set by user
2736 * - decoding: unused
2742 * Indicates number of picture subdivisions. Used for parallelized
2744 * - encoding: Set by user
2745 * - decoding: unused
2750 * Header containing style information for text subtitles.
2751 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2752 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2753 * the Format line following. It shouldn't include any Dialogue line.
2754 * - encoding: Set/allocated/freed by user (before avcodec_open())
2755 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2757 uint8_t *subtitle_header;
2758 int subtitle_header_size;
2761 * Current packet as passed into the decoder, to avoid having
2762 * to pass the packet into every function. Currently only valid
2763 * inside lavc and get/release_buffer callbacks.
2764 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2765 * - encoding: unused
2770 * Whether this is a copy of the context which had init() called on it.
2771 * This is used by multithreading - shared tables and picture pointers
2772 * should be freed from the original context only.
2773 * - encoding: Set by libavcodec.
2774 * - decoding: Set by libavcodec.
2779 * Which multithreading methods to use.
2780 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2781 * so clients which cannot provide future frames should not use it.
2783 * - encoding: Set by user, otherwise the default is used.
2784 * - decoding: Set by user, otherwise the default is used.
2787 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2788 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2791 * Which multithreading methods are in use by the codec.
2792 * - encoding: Set by libavcodec.
2793 * - decoding: Set by libavcodec.
2795 int active_thread_type;
2798 * Set by the client if its custom get_buffer() callback can be called
2799 * from another thread, which allows faster multithreaded decoding.
2800 * draw_horiz_band() will be called from other threads regardless of this setting.
2801 * Ignored if the default get_buffer() is used.
2802 * - encoding: Set by user.
2803 * - decoding: Set by user.
2805 int thread_safe_callbacks;
2808 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2809 * Used for compliant TS muxing.
2810 * - encoding: Set by libavcodec.
2811 * - decoding: unused.
2816 * Type of service that the audio stream conveys.
2817 * - encoding: Set by user.
2818 * - decoding: Set by libavcodec.
2820 enum AVAudioServiceType audio_service_type;
2826 typedef struct AVProfile {
2828 const char *name; ///< short name for the profile
2834 typedef struct AVCodec {
2836 * Name of the codec implementation.
2837 * The name is globally unique among encoders and among decoders (but an
2838 * encoder and a decoder can share the same name).
2839 * This is the primary way to find a codec from the user perspective.
2842 enum AVMediaType type;
2845 int (*init)(AVCodecContext *);
2846 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2847 int (*close)(AVCodecContext *);
2848 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2850 * Codec capabilities.
2854 struct AVCodec *next;
2857 * Will be called when seeking
2859 void (*flush)(AVCodecContext *);
2860 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2861 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2863 * Descriptive name for the codec, meant to be more human readable than name.
2864 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2866 const char *long_name;
2867 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2868 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2869 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2870 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2871 const AVClass *priv_class; ///< AVClass for the private context
2872 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2875 * @defgroup framethreading Frame-level threading support functions.
2879 * If defined, called on thread contexts when they are created.
2880 * If the codec allocates writable tables in init(), re-allocate them here.
2881 * priv_data will be set to a copy of the original.
2883 int (*init_thread_copy)(AVCodecContext *);
2885 * Copy necessary context variables from a previous thread context to the current one.
2886 * If not defined, the next thread will start automatically; otherwise, the codec
2887 * must call ff_thread_finish_setup().
2889 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2891 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2898 typedef struct AVHWAccel {
2900 * Name of the hardware accelerated codec.
2901 * The name is globally unique among encoders and among decoders (but an
2902 * encoder and a decoder can share the same name).
2907 * Type of codec implemented by the hardware accelerator.
2909 * See AVMEDIA_TYPE_xxx
2911 enum AVMediaType type;
2914 * Codec implemented by the hardware accelerator.
2921 * Supported pixel format.
2923 * Only hardware accelerated formats are supported here.
2925 enum PixelFormat pix_fmt;
2928 * Hardware accelerated codec capabilities.
2929 * see FF_HWACCEL_CODEC_CAP_*
2933 struct AVHWAccel *next;
2936 * Called at the beginning of each frame or field picture.
2938 * Meaningful frame information (codec specific) is guaranteed to
2939 * be parsed at this point. This function is mandatory.
2941 * Note that buf can be NULL along with buf_size set to 0.
2942 * Otherwise, this means the whole frame is available at this point.
2944 * @param avctx the codec context
2945 * @param buf the frame data buffer base
2946 * @param buf_size the size of the frame in bytes
2947 * @return zero if successful, a negative value otherwise
2949 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2952 * Callback for each slice.
2954 * Meaningful slice information (codec specific) is guaranteed to
2955 * be parsed at this point. This function is mandatory.
2957 * @param avctx the codec context
2958 * @param buf the slice data buffer base
2959 * @param buf_size the size of the slice in bytes
2960 * @return zero if successful, a negative value otherwise
2962 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2965 * Called at the end of each frame or field picture.
2967 * The whole picture is parsed at this point and can now be sent
2968 * to the hardware accelerator. This function is mandatory.
2970 * @param avctx the codec context
2971 * @return zero if successful, a negative value otherwise
2973 int (*end_frame)(AVCodecContext *avctx);
2976 * Size of HW accelerator private data.
2978 * Private data is allocated with av_mallocz() before
2979 * AVCodecContext.get_buffer() and deallocated after
2980 * AVCodecContext.release_buffer().
2986 * four components are given, that's all.
2987 * the last component is alpha
2989 typedef struct AVPicture {
2991 int linesize[4]; ///< number of bytes per line
2994 #if FF_API_PALETTE_CONTROL
2997 * This structure defines a method for communicating palette changes
2998 * between and demuxer and a decoder.
3000 * @deprecated Use AVPacket to send palette changes instead.
3001 * This is totally broken.
3003 #define AVPALETTE_SIZE 1024
3004 #define AVPALETTE_COUNT 256
3005 typedef struct AVPaletteControl {
3007 /* Demuxer sets this to 1 to indicate the palette has changed;
3008 * decoder resets to 0. */
3009 int palette_changed;
3011 /* 4-byte ARGB palette entries, stored in native byte order; note that
3012 * the individual palette components should be on a 8-bit scale; if
3013 * the palette data comes from an IBM VGA native format, the component
3014 * data is probably 6 bits in size and needs to be scaled. */
3015 unsigned int palette[AVPALETTE_COUNT];
3017 } AVPaletteControl attribute_deprecated;
3020 enum AVSubtitleType {
3023 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3026 * Plain text, the text field must be set by the decoder and is
3027 * authoritative. ass and pict fields may contain approximations.
3032 * Formatted text, the ass field must be set by the decoder and is
3033 * authoritative. pict and text fields may contain approximations.
3038 typedef struct AVSubtitleRect {
3039 int x; ///< top left corner of pict, undefined when pict is not set
3040 int y; ///< top left corner of pict, undefined when pict is not set
3041 int w; ///< width of pict, undefined when pict is not set
3042 int h; ///< height of pict, undefined when pict is not set
3043 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3046 * data+linesize for the bitmap of this subtitle.
3047 * can be set for text/ass as well once they where rendered
3050 enum AVSubtitleType type;
3052 char *text; ///< 0 terminated plain UTF-8 text
3055 * 0 terminated ASS/SSA compatible event line.
3056 * The pressentation of this is unaffected by the other values in this
3062 typedef struct AVSubtitle {
3063 uint16_t format; /* 0 = graphics */
3064 uint32_t start_display_time; /* relative to packet pts, in ms */
3065 uint32_t end_display_time; /* relative to packet pts, in ms */
3067 AVSubtitleRect **rects;
3068 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3071 /* packet functions */
3074 * @deprecated use NULL instead
3076 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3079 * Default packet destructor.
3081 void av_destruct_packet(AVPacket *pkt);
3084 * Initialize optional fields of a packet with default values.
3088 void av_init_packet(AVPacket *pkt);
3091 * Allocate the payload of a packet and initialize its fields with
3095 * @param size wanted payload size
3096 * @return 0 if OK, AVERROR_xxx otherwise
3098 int av_new_packet(AVPacket *pkt, int size);
3101 * Reduce packet size, correctly zeroing padding
3104 * @param size new size
3106 void av_shrink_packet(AVPacket *pkt, int size);
3109 * Increase packet size, correctly zeroing padding
3112 * @param grow_by number of bytes by which to increase the size of the packet
3114 int av_grow_packet(AVPacket *pkt, int grow_by);
3117 * @warning This is a hack - the packet memory allocation stuff is broken. The
3118 * packet is allocated if it was not really allocated.
3120 int av_dup_packet(AVPacket *pkt);
3125 * @param pkt packet to free
3127 void av_free_packet(AVPacket *pkt);
3130 * Allocate new information of a packet.
3133 * @param type side information type
3134 * @param size side information size
3135 * @return pointer to fresh allocated data or NULL otherwise
3137 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3141 * Get side information from packet.
3144 * @param type desired side information type
3145 * @param size pointer for side information size to store (optional)
3146 * @return pointer to data if present or NULL otherwise
3148 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3153 struct ReSampleContext;
3154 struct AVResampleContext;
3156 typedef struct ReSampleContext ReSampleContext;
3159 * Initialize audio resampling context.
3161 * @param output_channels number of output channels
3162 * @param input_channels number of input channels
3163 * @param output_rate output sample rate
3164 * @param input_rate input sample rate
3165 * @param sample_fmt_out requested output sample format
3166 * @param sample_fmt_in input sample format
3167 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3168 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3169 * @param linear if 1 then the used FIR filter will be linearly interpolated
3170 between the 2 closest, if 0 the closest will be used
3171 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3172 * @return allocated ReSampleContext, NULL if error occured
3174 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3175 int output_rate, int input_rate,
3176 enum AVSampleFormat sample_fmt_out,
3177 enum AVSampleFormat sample_fmt_in,
3178 int filter_length, int log2_phase_count,
3179 int linear, double cutoff);
3181 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3184 * Free resample context.
3186 * @param s a non-NULL pointer to a resample context previously
3187 * created with av_audio_resample_init()
3189 void audio_resample_close(ReSampleContext *s);
3193 * Initialize an audio resampler.
3194 * Note, if either rate is not an integer then simply scale both rates up so they are.
3195 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3196 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3197 * @param linear If 1 then the used FIR filter will be linearly interpolated
3198 between the 2 closest, if 0 the closest will be used
3199 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3201 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3204 * Resample an array of samples using a previously configured context.
3205 * @param src an array of unconsumed samples
3206 * @param consumed the number of samples of src which have been consumed are returned here
3207 * @param src_size the number of unconsumed samples available
3208 * @param dst_size the amount of space in samples available in dst
3209 * @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.
3210 * @return the number of samples written in dst or -1 if an error occurred
3212 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3216 * Compensate samplerate/timestamp drift. The compensation is done by changing
3217 * the resampler parameters, so no audible clicks or similar distortions occur
3218 * @param compensation_distance distance in output samples over which the compensation should be performed
3219 * @param sample_delta number of output samples which should be output less
3221 * example: av_resample_compensate(c, 10, 500)
3222 * here instead of 510 samples only 500 samples would be output
3224 * note, due to rounding the actual compensation might be slightly different,
3225 * especially if the compensation_distance is large and the in_rate used during init is small
3227 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3228 void av_resample_close(struct AVResampleContext *c);
3231 * Allocate memory for a picture. Call avpicture_free to free it.
3233 * @param picture the picture to be filled in
3234 * @param pix_fmt the format of the picture
3235 * @param width the width of the picture
3236 * @param height the height of the picture
3237 * @return zero if successful, a negative value if not
3239 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3242 * Free a picture previously allocated by avpicture_alloc().
3244 * @param picture the AVPicture to be freed
3246 void avpicture_free(AVPicture *picture);
3249 * Fill in the AVPicture fields.
3250 * The fields of the given AVPicture are filled in by using the 'ptr' address
3251 * which points to the image data buffer. Depending on the specified picture
3252 * format, one or multiple image data pointers and line sizes will be set.
3253 * If a planar format is specified, several pointers will be set pointing to
3254 * the different picture planes and the line sizes of the different planes
3255 * will be stored in the lines_sizes array.
3256 * Call with ptr == NULL to get the required size for the ptr buffer.
3258 * @param picture AVPicture whose fields are to be filled in
3259 * @param ptr Buffer which will contain or contains the actual image data
3260 * @param pix_fmt The format in which the picture data is stored.
3261 * @param width the width of the image in pixels
3262 * @param height the height of the image in pixels
3263 * @return size of the image data in bytes
3265 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3266 enum PixelFormat pix_fmt, int width, int height);
3267 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3268 unsigned char *dest, int dest_size);
3271 * Calculate the size in bytes that a picture of the given width and height
3272 * would occupy if stored in the given picture format.
3273 * Note that this returns the size of a compact representation as generated
3274 * by avpicture_layout, which can be smaller than the size required for e.g.
3277 * @param pix_fmt the given picture format
3278 * @param width the width of the image
3279 * @param height the height of the image
3280 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3282 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3283 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3284 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3285 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3288 * Return a value representing the fourCC code associated to the
3289 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3292 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3295 * Put a string representing the codec tag codec_tag in buf.
3297 * @param buf_size size in bytes of buf
3298 * @return the length of the string that would have been generated if
3299 * enough space had been available, excluding the trailing null
3301 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3303 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3304 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3305 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3306 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3307 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3308 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3311 * Compute what kind of losses will occur when converting from one specific
3312 * pixel format to another.
3313 * When converting from one pixel format to another, information loss may occur.
3314 * For example, when converting from RGB24 to GRAY, the color information will
3315 * be lost. Similarly, other losses occur when converting from some formats to
3316 * other formats. These losses can involve loss of chroma, but also loss of
3317 * resolution, loss of color depth, loss due to the color space conversion, loss
3318 * of the alpha bits or loss due to color quantization.
3319 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3320 * which will occur when converting from one pixel format to another.
3322 * @param[in] dst_pix_fmt destination pixel format
3323 * @param[in] src_pix_fmt source pixel format
3324 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3325 * @return Combination of flags informing you what kind of losses will occur.
3327 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3331 * Find the best pixel format to convert to given a certain source pixel
3332 * format. When converting from one pixel format to another, information loss
3333 * may occur. For example, when converting from RGB24 to GRAY, the color
3334 * information will be lost. Similarly, other losses occur when converting from
3335 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3336 * the given pixel formats should be used to suffer the least amount of loss.
3337 * The pixel formats from which it chooses one, are determined by the
3338 * pix_fmt_mask parameter.
3341 * src_pix_fmt = PIX_FMT_YUV420P;
3342 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3343 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3346 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3347 * @param[in] src_pix_fmt source pixel format
3348 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3349 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3350 * @return The best pixel format to convert to or -1 if none was found.
3352 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3353 int has_alpha, int *loss_ptr);
3355 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3356 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3359 * Tell if an image really has transparent alpha values.
3360 * @return ored mask of FF_ALPHA_xxx constants
3362 int img_get_alpha_info(const AVPicture *src,
3363 enum PixelFormat pix_fmt, int width, int height);
3365 /* deinterlace a picture */
3366 /* deinterlace - if not supported return -1 */
3367 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3368 enum PixelFormat pix_fmt, int width, int height);
3370 /* external high level API */
3373 * If c is NULL, returns the first registered codec,
3374 * if c is non-NULL, returns the next registered codec after c,
3375 * or NULL if c is the last one.
3377 AVCodec *av_codec_next(AVCodec *c);
3380 * Return the LIBAVCODEC_VERSION_INT constant.
3382 unsigned avcodec_version(void);
3385 * Return the libavcodec build-time configuration.
3387 const char *avcodec_configuration(void);
3390 * Return the libavcodec license.
3392 const char *avcodec_license(void);
3395 * Initialize libavcodec.
3397 * @warning This function must be called before any other libavcodec
3400 void avcodec_init(void);
3403 * Register the codec codec and initialize libavcodec.
3405 * @see avcodec_init()
3407 void avcodec_register(AVCodec *codec);
3410 * Find a registered encoder with a matching codec ID.
3412 * @param id CodecID of the requested encoder
3413 * @return An encoder if one was found, NULL otherwise.
3415 AVCodec *avcodec_find_encoder(enum CodecID id);
3418 * Find a registered encoder with the specified name.
3420 * @param name name of the requested encoder
3421 * @return An encoder if one was found, NULL otherwise.
3423 AVCodec *avcodec_find_encoder_by_name(const char *name);
3426 * Find a registered decoder with a matching codec ID.
3428 * @param id CodecID of the requested decoder
3429 * @return A decoder if one was found, NULL otherwise.
3431 AVCodec *avcodec_find_decoder(enum CodecID id);
3434 * Find a registered decoder with the specified name.
3436 * @param name name of the requested decoder
3437 * @return A decoder if one was found, NULL otherwise.
3439 AVCodec *avcodec_find_decoder_by_name(const char *name);
3440 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3443 * Return a name for the specified profile, if available.
3445 * @param codec the codec that is searched for the given profile
3446 * @param profile the profile value for which a name is requested
3447 * @return A name for the profile if found, NULL otherwise.
3449 const char *av_get_profile_name(const AVCodec *codec, int profile);
3452 * Set the fields of the given AVCodecContext to default values.
3454 * @param s The AVCodecContext of which the fields should be set to default values.
3456 void avcodec_get_context_defaults(AVCodecContext *s);
3458 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3459 * we WILL change its arguments and name a few times! */
3460 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3462 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3463 * we WILL change its arguments and name a few times! */
3464 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3467 * Allocate an AVCodecContext and set its fields to default values. The
3468 * resulting struct can be deallocated by simply calling av_free().
3470 * @return An AVCodecContext filled with default values or NULL on failure.
3471 * @see avcodec_get_context_defaults
3473 AVCodecContext *avcodec_alloc_context(void);
3475 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3476 * we WILL change its arguments and name a few times! */
3477 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3479 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3480 * we WILL change its arguments and name a few times! */
3481 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3484 * Copy the settings of the source AVCodecContext into the destination
3485 * AVCodecContext. The resulting destination codec context will be
3486 * unopened, i.e. you are required to call avcodec_open() before you
3487 * can use this AVCodecContext to decode/encode video/audio data.
3489 * @param dest target codec context, should be initialized with
3490 * avcodec_alloc_context(), but otherwise uninitialized
3491 * @param src source codec context
3492 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3494 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3497 * Set the fields of the given AVFrame to default values.
3499 * @param pic The AVFrame of which the fields should be set to default values.
3501 void avcodec_get_frame_defaults(AVFrame *pic);
3504 * Allocate an AVFrame and set its fields to default values. The resulting
3505 * struct can be deallocated by simply calling av_free().
3507 * @return An AVFrame filled with default values or NULL on failure.
3508 * @see avcodec_get_frame_defaults
3510 AVFrame *avcodec_alloc_frame(void);
3512 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3513 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3514 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3517 * Return the amount of padding in pixels which the get_buffer callback must
3518 * provide around the edge of the image for codecs which do not have the
3519 * CODEC_FLAG_EMU_EDGE flag.
3521 * @return Required padding in pixels.
3523 unsigned avcodec_get_edge_width(void);
3525 * Modify width and height values so that they will result in a memory
3526 * buffer that is acceptable for the codec if you do not use any horizontal
3529 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3530 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3531 * according to avcodec_get_edge_width() before.
3533 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3535 * Modify width and height values so that they will result in a memory
3536 * buffer that is acceptable for the codec if you also ensure that all
3537 * line sizes are a multiple of the respective linesize_align[i].
3539 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3540 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3541 * according to avcodec_get_edge_width() before.
3543 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3544 int linesize_align[4]);
3546 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3548 #if FF_API_THREAD_INIT
3550 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3552 attribute_deprecated
3553 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3556 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3557 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3558 //FIXME func typedef
3561 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3562 * function the context has to be allocated.
3564 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3565 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3566 * retrieving a codec.
3568 * @warning This function is not thread safe!
3571 * avcodec_register_all();
3572 * codec = avcodec_find_decoder(CODEC_ID_H264);
3576 * context = avcodec_alloc_context();
3578 * if (avcodec_open(context, codec) < 0)
3582 * @param avctx The context which will be set up to use the given codec.
3583 * @param codec The codec to use within the context.
3584 * @return zero on success, a negative value on error
3585 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3587 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3590 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3591 * Some decoders may support multiple frames in a single AVPacket, such
3592 * decoders would then just decode the first frame. In this case,
3593 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3594 * the remaining data in order to decode the second frame etc.
3596 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3597 * decompressed frame size in bytes.
3599 * @warning You must set frame_size_ptr to the allocated size of the
3600 * output buffer before calling avcodec_decode_audio3().
3602 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3603 * the actual read bytes because some optimized bitstream readers read 32 or 64
3604 * bits at once and could read over the end.
3606 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3607 * no overreading happens for damaged MPEG streams.
3609 * @note You might have to align the input buffer avpkt->data and output buffer
3610 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3611 * necessary at all, on others it won't work at all if not aligned and on others
3612 * it will work but it will have an impact on performance.
3614 * In practice, avpkt->data should have 4 byte alignment at minimum and
3615 * samples should be 16 byte aligned unless the CPU doesn't need it
3616 * (AltiVec and SSE do).
3618 * @param avctx the codec context
3619 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3620 * @param[in,out] frame_size_ptr the output buffer size in bytes
3621 * @param[in] avpkt The input AVPacket containing the input buffer.
3622 * You can create such packet with av_init_packet() and by then setting
3623 * data and size, some decoders might in addition need other fields.
3624 * All decoders are designed to use the least fields possible though.
3625 * @return On error a negative value is returned, otherwise the number of bytes
3626 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3628 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3629 int *frame_size_ptr,
3633 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3634 * Some decoders may support multiple frames in a single AVPacket, such
3635 * decoders would then just decode the first frame.
3637 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3638 * the actual read bytes because some optimized bitstream readers read 32 or 64
3639 * bits at once and could read over the end.
3641 * @warning The end of the input buffer buf should be set to 0 to ensure that
3642 * no overreading happens for damaged MPEG streams.
3644 * @note You might have to align the input buffer avpkt->data.
3645 * The alignment requirements depend on the CPU: on some CPUs it isn't
3646 * necessary at all, on others it won't work at all if not aligned and on others
3647 * it will work but it will have an impact on performance.
3649 * In practice, avpkt->data should have 4 byte alignment at minimum.
3651 * @note Some codecs have a delay between input and output, these need to be
3652 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3654 * @param avctx the codec context
3655 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3656 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3657 * allocate memory for the actual bitmap.
3658 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3659 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3660 * decodes and the decoder tells the user once it does not need the data anymore,
3661 * the user app can at this point free/reuse/keep the memory as it sees fit.
3663 * @param[in] avpkt The input AVpacket containing the input buffer.
3664 * You can create such packet with av_init_packet() and by then setting
3665 * data and size, some decoders might in addition need other fields like
3666 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3668 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3669 * @return On error a negative value is returned, otherwise the number of bytes
3670 * used or zero if no frame could be decompressed.
3672 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3673 int *got_picture_ptr,
3677 * Decode a subtitle message.
3678 * Return a negative value on error, otherwise return the number of bytes used.
3679 * If no subtitle could be decompressed, got_sub_ptr is zero.
3680 * Otherwise, the subtitle is stored in *sub.
3681 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3682 * simplicity, because the performance difference is expect to be negligible
3683 * and reusing a get_buffer written for video codecs would probably perform badly
3684 * due to a potentially very different allocation pattern.
3686 * @param avctx the codec context
3687 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3688 freed with avsubtitle_free if *got_sub_ptr is set.
3689 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3690 * @param[in] avpkt The input AVPacket containing the input buffer.
3692 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3697 * Frees all allocated data in the given subtitle struct.
3699 * @param sub AVSubtitle to free.
3701 void avsubtitle_free(AVSubtitle *sub);
3703 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3705 uint8_t *buf, int buf_size);
3708 * Encode an audio frame from samples into buf.
3710 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3711 * However, for PCM audio the user will know how much space is needed
3712 * because it depends on the value passed in buf_size as described
3713 * below. In that case a lower value can be used.
3715 * @param avctx the codec context
3716 * @param[out] buf the output buffer
3717 * @param[in] buf_size the output buffer size
3718 * @param[in] samples the input buffer containing the samples
3719 * The number of samples read from this buffer is frame_size*channels,
3720 * both of which are defined in avctx.
3721 * For PCM audio the number of samples read from samples is equal to
3722 * buf_size * input_sample_size / output_sample_size.
3723 * @return On error a negative value is returned, on success zero or the number
3724 * of bytes used to encode the data read from the input buffer.
3726 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3727 const short *samples);
3730 * Encode a video frame from pict into buf.
3731 * The input picture should be
3732 * stored using a specific format, namely avctx.pix_fmt.
3734 * @param avctx the codec context
3735 * @param[out] buf the output buffer for the bitstream of encoded frame
3736 * @param[in] buf_size the size of the output buffer in bytes
3737 * @param[in] pict the input picture to encode
3738 * @return On error a negative value is returned, on success zero or the number
3739 * of bytes used from the output buffer.
3741 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3742 const AVFrame *pict);
3743 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3744 const AVSubtitle *sub);
3746 int avcodec_close(AVCodecContext *avctx);
3749 * Register all the codecs, parsers and bitstream filters which were enabled at
3750 * configuration time. If you do not call this function you can select exactly
3751 * which formats you want to support, by using the individual registration
3754 * @see avcodec_register
3755 * @see av_register_codec_parser
3756 * @see av_register_bitstream_filter
3758 void avcodec_register_all(void);
3761 * Flush buffers, should be called when seeking or when switching to a different stream.
3763 void avcodec_flush_buffers(AVCodecContext *avctx);
3765 void avcodec_default_free_buffers(AVCodecContext *s);
3767 /* misc useful functions */
3770 * Return a single letter to describe the given picture type pict_type.
3772 * @param[in] pict_type the picture type
3773 * @return A single character representing the picture type.
3775 char av_get_pict_type_char(int pict_type);
3778 * Return codec bits per sample.
3780 * @param[in] codec_id the codec
3781 * @return Number of bits per sample or zero if unknown for the given codec.
3783 int av_get_bits_per_sample(enum CodecID codec_id);
3785 #if FF_API_OLD_SAMPLE_FMT
3787 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3789 attribute_deprecated
3790 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3794 typedef struct AVCodecParserContext {
3796 struct AVCodecParser *parser;
3797 int64_t frame_offset; /* offset of the current frame */
3798 int64_t cur_offset; /* current offset
3799 (incremented by each av_parser_parse()) */
3800 int64_t next_frame_offset; /* offset of the next frame */
3802 int pict_type; /* XXX: Put it back in AVCodecContext. */
3804 * This field is used for proper frame duration computation in lavf.
3805 * It signals, how much longer the frame duration of the current frame
3806 * is compared to normal frame duration.
3808 * frame_duration = (1 + repeat_pict) * time_base
3810 * It is used by codecs like H.264 to display telecined material.
3812 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3813 int64_t pts; /* pts of the current frame */
3814 int64_t dts; /* dts of the current frame */
3819 int fetch_timestamp;
3821 #define AV_PARSER_PTS_NB 4
3822 int cur_frame_start_index;
3823 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3824 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3825 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3828 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3829 #define PARSER_FLAG_ONCE 0x0002
3830 /// Set if the parser has a valid file offset
3831 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3833 int64_t offset; ///< byte offset from starting packet start
3834 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3837 * Set by parser to 1 for key frames and 0 for non-key frames.
3838 * It is initialized to -1, so if the parser doesn't set this flag,
3839 * old-style fallback using FF_I_TYPE picture type as key frames
3845 * Time difference in stream time base units from the pts of this
3846 * packet to the point at which the output from the decoder has converged
3847 * independent from the availability of previous frames. That is, the
3848 * frames are virtually identical no matter if decoding started from
3849 * the very first frame or from this keyframe.
3850 * Is AV_NOPTS_VALUE if unknown.
3851 * This field is not the display duration of the current frame.
3852 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3855 * The purpose of this field is to allow seeking in streams that have no
3856 * keyframes in the conventional sense. It corresponds to the
3857 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3858 * essential for some types of subtitle streams to ensure that all
3859 * subtitles are correctly displayed after seeking.
3861 int64_t convergence_duration;
3863 // Timestamp generation support:
3865 * Synchronization point for start of timestamp generation.
3867 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3870 * For example, this corresponds to presence of H.264 buffering period
3876 * Offset of the current timestamp against last timestamp sync point in
3877 * units of AVCodecContext.time_base.
3879 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3880 * contain a valid timestamp offset.
3882 * Note that the timestamp of sync point has usually a nonzero
3883 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3884 * the next frame after timestamp sync point will be usually 1.
3886 * For example, this corresponds to H.264 cpb_removal_delay.
3888 int dts_ref_dts_delta;
3891 * Presentation delay of current frame in units of AVCodecContext.time_base.
3893 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3894 * contain valid non-negative timestamp delta (presentation time of a frame
3895 * must not lie in the past).
3897 * This delay represents the difference between decoding and presentation
3898 * time of the frame.
3900 * For example, this corresponds to H.264 dpb_output_delay.
3905 * Position of the packet in file.
3907 * Analogous to cur_frame_pts/dts
3909 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3912 * Byte position of currently parsed frame in stream.
3917 * Previous frame byte position.
3920 } AVCodecParserContext;
3922 typedef struct AVCodecParser {
3923 int codec_ids[5]; /* several codec IDs are permitted */
3925 int (*parser_init)(AVCodecParserContext *s);
3926 int (*parser_parse)(AVCodecParserContext *s,
3927 AVCodecContext *avctx,
3928 const uint8_t **poutbuf, int *poutbuf_size,
3929 const uint8_t *buf, int buf_size);
3930 void (*parser_close)(AVCodecParserContext *s);
3931 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3932 struct AVCodecParser *next;
3935 AVCodecParser *av_parser_next(AVCodecParser *c);
3937 void av_register_codec_parser(AVCodecParser *parser);
3938 AVCodecParserContext *av_parser_init(int codec_id);
3943 * @param s parser context.
3944 * @param avctx codec context.
3945 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3946 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3947 * @param buf input buffer.
3948 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3949 * @param pts input presentation timestamp.
3950 * @param dts input decoding timestamp.
3951 * @param pos input byte position in stream.
3952 * @return the number of bytes of the input bitstream used.
3957 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3964 * decode_frame(data, size);
3968 int av_parser_parse2(AVCodecParserContext *s,
3969 AVCodecContext *avctx,
3970 uint8_t **poutbuf, int *poutbuf_size,
3971 const uint8_t *buf, int buf_size,
3972 int64_t pts, int64_t dts,
3975 int av_parser_change(AVCodecParserContext *s,
3976 AVCodecContext *avctx,
3977 uint8_t **poutbuf, int *poutbuf_size,
3978 const uint8_t *buf, int buf_size, int keyframe);
3979 void av_parser_close(AVCodecParserContext *s);
3982 typedef struct AVBitStreamFilterContext {
3984 struct AVBitStreamFilter *filter;
3985 AVCodecParserContext *parser;
3986 struct AVBitStreamFilterContext *next;
3987 } AVBitStreamFilterContext;
3990 typedef struct AVBitStreamFilter {
3993 int (*filter)(AVBitStreamFilterContext *bsfc,
3994 AVCodecContext *avctx, const char *args,
3995 uint8_t **poutbuf, int *poutbuf_size,
3996 const uint8_t *buf, int buf_size, int keyframe);
3997 void (*close)(AVBitStreamFilterContext *bsfc);
3998 struct AVBitStreamFilter *next;
3999 } AVBitStreamFilter;
4001 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4002 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4003 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4004 AVCodecContext *avctx, const char *args,
4005 uint8_t **poutbuf, int *poutbuf_size,
4006 const uint8_t *buf, int buf_size, int keyframe);
4007 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4009 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4014 * Reallocate the given block if it is not large enough, otherwise do nothing.
4018 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4021 * Allocate a buffer, reusing the given one if large enough.
4023 * Contrary to av_fast_realloc the current buffer contents might not be
4024 * preserved and on error the old buffer is freed, thus no special
4025 * handling to avoid memleaks is necessary.
4027 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4028 * @param size size of the buffer *ptr points to
4029 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4030 * *size 0 if an error occurred.
4032 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4035 * Copy image src to dst. Wraps av_picture_data_copy() above.
4037 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4038 enum PixelFormat pix_fmt, int width, int height);
4041 * Crop image top and left side.
4043 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4044 enum PixelFormat pix_fmt, int top_band, int left_band);
4049 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4050 int padtop, int padbottom, int padleft, int padright, int *color);
4053 * Encode extradata length to a buffer. Used by xiph codecs.
4055 * @param s buffer to write to; must be at least (v/255+1) bytes long
4056 * @param v size of extradata in bytes
4057 * @return number of bytes written to the buffer.
4059 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4062 * Logs a generic warning message about a missing feature. This function is
4063 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4064 * only, and would normally not be used by applications.
4065 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4066 * a pointer to an AVClass struct
4067 * @param[in] feature string containing the name of the missing feature
4068 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4069 * If want_sample is non-zero, additional verbage will be added to the log
4070 * message which tells the user how to report samples to the development
4073 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4076 * Log a generic warning message asking for a sample. This function is
4077 * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4078 * only, and would normally not be used by applications.
4079 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4080 * a pointer to an AVClass struct
4081 * @param[in] msg string containing an optional message, or NULL if no message
4083 void av_log_ask_for_sample(void *avc, const char *msg, ...);
4086 * Register the hardware accelerator hwaccel.
4088 void av_register_hwaccel(AVHWAccel *hwaccel);
4091 * If hwaccel is NULL, returns the first registered hardware accelerator,
4092 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4093 * after hwaccel, or NULL if hwaccel is the last one.
4095 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4099 * Lock operation used by lockmgr
4102 AV_LOCK_CREATE, ///< Create a mutex
4103 AV_LOCK_OBTAIN, ///< Lock the mutex
4104 AV_LOCK_RELEASE, ///< Unlock the mutex
4105 AV_LOCK_DESTROY, ///< Free mutex resources
4109 * Register a user provided lock manager supporting the operations
4110 * specified by AVLockOp. mutex points to a (void *) where the
4111 * lockmgr should store/get a pointer to a user allocated mutex. It's
4112 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4114 * @param cb User defined callback. Note: Libav may invoke calls to this
4115 * callback during the call to av_lockmgr_register().
4116 * Thus, the application must be prepared to handle that.
4117 * If cb is set to NULL the lockmgr will be unregistered.
4118 * Also note that during unregistration the previously registered
4119 * lockmgr callback may also be invoked.
4121 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4123 #endif /* AVCODEC_AVCODEC_H */