2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/samplefmt.h"
31 #include "libavutil/avutil.h"
32 #include "libavutil/cpu.h"
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,
209 /* various PCM "codecs" */
210 CODEC_ID_PCM_S16LE= 0x10000,
226 CODEC_ID_PCM_S24DAUD,
228 CODEC_ID_PCM_S16LE_PLANAR,
238 /* various ADPCM codecs */
239 CODEC_ID_ADPCM_IMA_QT= 0x11000,
240 CODEC_ID_ADPCM_IMA_WAV,
241 CODEC_ID_ADPCM_IMA_DK3,
242 CODEC_ID_ADPCM_IMA_DK4,
243 CODEC_ID_ADPCM_IMA_WS,
244 CODEC_ID_ADPCM_IMA_SMJPEG,
253 CODEC_ID_ADPCM_YAMAHA,
254 CODEC_ID_ADPCM_SBPRO_4,
255 CODEC_ID_ADPCM_SBPRO_3,
256 CODEC_ID_ADPCM_SBPRO_2,
258 CODEC_ID_ADPCM_IMA_AMV,
259 CODEC_ID_ADPCM_EA_R1,
260 CODEC_ID_ADPCM_EA_R3,
261 CODEC_ID_ADPCM_EA_R2,
262 CODEC_ID_ADPCM_IMA_EA_SEAD,
263 CODEC_ID_ADPCM_IMA_EA_EACS,
264 CODEC_ID_ADPCM_EA_XAS,
265 CODEC_ID_ADPCM_EA_MAXIS_XA,
266 CODEC_ID_ADPCM_IMA_ISS,
270 CODEC_ID_AMR_NB= 0x12000,
273 /* RealAudio codecs*/
274 CODEC_ID_RA_144= 0x13000,
277 /* various DPCM codecs */
278 CODEC_ID_ROQ_DPCM= 0x14000,
279 CODEC_ID_INTERPLAY_DPCM,
284 CODEC_ID_MP2= 0x15000,
285 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
303 CODEC_ID_WESTWOOD_SND1,
304 CODEC_ID_GSM, ///< as in Berlin toast format
312 CODEC_ID_DSICINAUDIO,
316 CODEC_ID_GSM_MS, /* as found in WAV */
325 CODEC_ID_WMALOSSLESS,
334 CODEC_ID_BINKAUDIO_RDFT,
335 CODEC_ID_BINKAUDIO_DCT,
340 /* subtitle codecs */
341 CODEC_ID_DVD_SUBTITLE= 0x17000,
342 CODEC_ID_DVB_SUBTITLE,
343 CODEC_ID_TEXT, ///< raw UTF-8 text
347 CODEC_ID_HDMV_PGS_SUBTITLE,
348 CODEC_ID_DVB_TELETEXT,
352 /* other specific kind of codecs (generally used for attachments) */
353 CODEC_ID_TTF= 0x18000,
355 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
357 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
358 * stream (only used by libavformat) */
359 CODEC_ID_FFMETADATA=0x21000, ///< Dummy codec for streams containing only metadata information.
362 #if FF_API_OLD_SAMPLE_FMT
363 #define SampleFormat AVSampleFormat
365 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
366 #define SAMPLE_FMT_U8 AV_SAMPLE_FMT_U8
367 #define SAMPLE_FMT_S16 AV_SAMPLE_FMT_S16
368 #define SAMPLE_FMT_S32 AV_SAMPLE_FMT_S32
369 #define SAMPLE_FMT_FLT AV_SAMPLE_FMT_FLT
370 #define SAMPLE_FMT_DBL AV_SAMPLE_FMT_DBL
371 #define SAMPLE_FMT_NB AV_SAMPLE_FMT_NB
374 #if FF_API_OLD_AUDIOCONVERT
375 #include "libavutil/audioconvert.h"
377 /* Audio channel masks */
378 #define CH_FRONT_LEFT AV_CH_FRONT_LEFT
379 #define CH_FRONT_RIGHT AV_CH_FRONT_RIGHT
380 #define CH_FRONT_CENTER AV_CH_FRONT_CENTER
381 #define CH_LOW_FREQUENCY AV_CH_LOW_FREQUENCY
382 #define CH_BACK_LEFT AV_CH_BACK_LEFT
383 #define CH_BACK_RIGHT AV_CH_BACK_RIGHT
384 #define CH_FRONT_LEFT_OF_CENTER AV_CH_FRONT_LEFT_OF_CENTER
385 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
386 #define CH_BACK_CENTER AV_CH_BACK_CENTER
387 #define CH_SIDE_LEFT AV_CH_SIDE_LEFT
388 #define CH_SIDE_RIGHT AV_CH_SIDE_RIGHT
389 #define CH_TOP_CENTER AV_CH_TOP_CENTER
390 #define CH_TOP_FRONT_LEFT AV_CH_TOP_FRONT_LEFT
391 #define CH_TOP_FRONT_CENTER AV_CH_TOP_FRONT_CENTER
392 #define CH_TOP_FRONT_RIGHT AV_CH_TOP_FRONT_RIGHT
393 #define CH_TOP_BACK_LEFT AV_CH_TOP_BACK_LEFT
394 #define CH_TOP_BACK_CENTER AV_CH_TOP_BACK_CENTER
395 #define CH_TOP_BACK_RIGHT AV_CH_TOP_BACK_RIGHT
396 #define CH_STEREO_LEFT AV_CH_STEREO_LEFT
397 #define CH_STEREO_RIGHT AV_CH_STEREO_RIGHT
399 /** Channel mask value used for AVCodecContext.request_channel_layout
400 to indicate that the user requests the channel order of the decoder output
401 to be the native codec channel order. */
402 #define CH_LAYOUT_NATIVE AV_CH_LAYOUT_NATIVE
404 /* Audio channel convenience macros */
405 #define CH_LAYOUT_MONO AV_CH_LAYOUT_MONO
406 #define CH_LAYOUT_STEREO AV_CH_LAYOUT_STEREO
407 #define CH_LAYOUT_2_1 AV_CH_LAYOUT_2_1
408 #define CH_LAYOUT_SURROUND AV_CH_LAYOUT_SURROUND
409 #define CH_LAYOUT_4POINT0 AV_CH_LAYOUT_4POINT0
410 #define CH_LAYOUT_2_2 AV_CH_LAYOUT_2_2
411 #define CH_LAYOUT_QUAD AV_CH_LAYOUT_QUAD
412 #define CH_LAYOUT_5POINT0 AV_CH_LAYOUT_5POINT0
413 #define CH_LAYOUT_5POINT1 AV_CH_LAYOUT_5POINT1
414 #define CH_LAYOUT_5POINT0_BACK AV_CH_LAYOUT_5POINT0_BACK
415 #define CH_LAYOUT_5POINT1_BACK AV_CH_LAYOUT_5POINT1_BACK
416 #define CH_LAYOUT_7POINT0 AV_CH_LAYOUT_7POINT0
417 #define CH_LAYOUT_7POINT1 AV_CH_LAYOUT_7POINT1
418 #define CH_LAYOUT_7POINT1_WIDE AV_CH_LAYOUT_7POINT1_WIDE
419 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
423 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
426 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
427 * This is mainly needed because some optimized bitstream readers read
428 * 32 or 64 bit at once and could read over the end.<br>
429 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
430 * MPEG bitstreams could cause overread and segfault.
432 #define FF_INPUT_BUFFER_PADDING_SIZE 8
435 * minimum encoding buffer size
436 * Used to avoid some checks during header writing.
438 #define FF_MIN_BUFFER_SIZE 16384
442 * motion estimation type.
445 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
449 ME_EPZS, ///< enhanced predictive zonal search
450 ME_X1, ///< reserved for experiments
451 ME_HEX, ///< hexagon based search
452 ME_UMH, ///< uneven multi-hexagon search
453 ME_ITER, ///< iterative search
454 ME_TESA, ///< transformed exhaustive search algorithm
458 /* We leave some space between them for extensions (drop some
459 * keyframes for intra-only or drop just some bidir frames). */
460 AVDISCARD_NONE =-16, ///< discard nothing
461 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
462 AVDISCARD_NONREF = 8, ///< discard all non reference
463 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
464 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
465 AVDISCARD_ALL = 48, ///< discard all
468 enum AVColorPrimaries{
469 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
470 AVCOL_PRI_UNSPECIFIED=2,
472 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
473 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
474 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
476 AVCOL_PRI_NB , ///< Not part of ABI
479 enum AVColorTransferCharacteristic{
480 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
481 AVCOL_TRC_UNSPECIFIED=2,
482 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
483 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
484 AVCOL_TRC_NB , ///< Not part of ABI
489 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
490 AVCOL_SPC_UNSPECIFIED=2,
492 AVCOL_SPC_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM / IEC 61966-2-4 xvYCC601
493 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
494 AVCOL_SPC_SMPTE240M =7,
495 AVCOL_SPC_NB , ///< Not part of ABI
499 AVCOL_RANGE_UNSPECIFIED=0,
500 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
501 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
502 AVCOL_RANGE_NB , ///< Not part of ABI
506 * X X 3 4 X X are luma samples,
507 * 1 2 1-6 are possible chroma positions
508 * X X 5 6 X 0 is undefined/unknown position
510 enum AVChromaLocation{
511 AVCHROMA_LOC_UNSPECIFIED=0,
512 AVCHROMA_LOC_LEFT =1, ///< mpeg2/4, h264 default
513 AVCHROMA_LOC_CENTER =2, ///< mpeg1, jpeg, h263
514 AVCHROMA_LOC_TOPLEFT =3, ///< DV
516 AVCHROMA_LOC_BOTTOMLEFT =5,
517 AVCHROMA_LOC_BOTTOM =6,
518 AVCHROMA_LOC_NB , ///< Not part of ABI
521 #if FF_API_FLAC_GLOBAL_OPTS
525 attribute_deprecated enum AVLPCType {
526 AV_LPC_TYPE_DEFAULT = -1, ///< use the codec default LPC type
527 AV_LPC_TYPE_NONE = 0, ///< do not use LPC prediction or use all zero coefficients
528 AV_LPC_TYPE_FIXED = 1, ///< fixed LPC coefficients
529 AV_LPC_TYPE_LEVINSON = 2, ///< Levinson-Durbin recursion
530 AV_LPC_TYPE_CHOLESKY = 3, ///< Cholesky factorization
531 AV_LPC_TYPE_NB , ///< Not part of ABI
535 enum AVAudioServiceType {
536 AV_AUDIO_SERVICE_TYPE_MAIN = 0,
537 AV_AUDIO_SERVICE_TYPE_EFFECTS = 1,
538 AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
539 AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED = 3,
540 AV_AUDIO_SERVICE_TYPE_DIALOGUE = 4,
541 AV_AUDIO_SERVICE_TYPE_COMMENTARY = 5,
542 AV_AUDIO_SERVICE_TYPE_EMERGENCY = 6,
543 AV_AUDIO_SERVICE_TYPE_VOICE_OVER = 7,
544 AV_AUDIO_SERVICE_TYPE_KARAOKE = 8,
545 AV_AUDIO_SERVICE_TYPE_NB , ///< Not part of ABI
548 typedef struct RcOverride{
551 int qscale; // If this is 0 then quality_factor will be used instead.
552 float quality_factor;
555 #define FF_MAX_B_FRAMES 16
558 These flags can be passed in AVCodecContext.flags before initialization.
559 Note: Not everything is supported yet.
562 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
563 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
564 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
565 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
566 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
567 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
569 * The parent program guarantees that the input for B-frames containing
570 * streams is not written to for at least s->max_b_frames+1 frames, if
571 * this is not set the input will be copied.
573 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
574 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
575 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
576 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
577 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
578 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
579 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
580 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
581 location instead of only at frame boundaries. */
582 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
583 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
584 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
585 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
586 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
587 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
588 /* Fx : Flag for h263+ extra options */
589 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
590 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
591 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
592 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
593 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
594 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
595 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
596 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
597 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
598 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
599 #define CODEC_FLAG_CLOSED_GOP 0x80000000
600 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
601 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
602 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
603 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
604 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
605 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
606 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
607 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
608 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
609 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
610 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
611 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
612 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
613 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
614 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
615 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
616 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
617 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
618 #define CODEC_FLAG2_MBTREE 0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
619 #define CODEC_FLAG2_PSY 0x00080000 ///< Use psycho visual optimizations.
620 #define CODEC_FLAG2_SSIM 0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
621 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
623 /* Unsupported options :
624 * Syntax Arithmetic coding (SAC)
625 * Reference Picture Selection
626 * Independent Segment Decoding */
628 /* codec capabilities */
630 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
632 * Codec uses get_buffer() for allocating buffers and supports custom allocators.
633 * If not set, it might not use get_buffer() at all or use operations that
634 * assume the buffer was allocated by avcodec_default_get_buffer.
636 #define CODEC_CAP_DR1 0x0002
637 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
638 #define CODEC_CAP_PARSE_ONLY 0x0004
639 #define CODEC_CAP_TRUNCATED 0x0008
640 /* Codec can export data for HW decoding (XvMC). */
641 #define CODEC_CAP_HWACCEL 0x0010
643 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
644 * If this is not set, the codec is guaranteed to never be fed with NULL data.
646 #define CODEC_CAP_DELAY 0x0020
648 * Codec can be fed a final frame with a smaller size.
649 * This can be used to prevent truncation of the last audio samples.
651 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
653 * Codec can export data for HW decoding (VDPAU).
655 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
657 * Codec can output multiple frames per AVPacket
658 * Normally demuxers return one frame at a time, demuxers which do not do
659 * are connected to a parser to split what they return into proper frames.
660 * This flag is reserved to the very rare category of codecs which have a
661 * bitstream that cannot be split into frames without timeconsuming
662 * operations like full decoding. Demuxers carring such bitstreams thus
663 * may return multiple frames in a packet. This has many disadvantages like
664 * prohibiting stream copy in many cases thus it should only be considered
667 #define CODEC_CAP_SUBFRAMES 0x0100
669 * Codec is experimental and is thus avoided in favor of non experimental
672 #define CODEC_CAP_EXPERIMENTAL 0x0200
674 * Codec should fill in channel configuration and samplerate instead of container
676 #define CODEC_CAP_CHANNEL_CONF 0x0400
679 * Codec is able to deal with negative linesizes
681 #define CODEC_CAP_NEG_LINESIZES 0x0800
684 * Codec supports frame-level multithreading.
686 #define CODEC_CAP_FRAME_THREADS 0x1000
688 * Codec supports slice-based (or partition-based) multithreading.
690 #define CODEC_CAP_SLICE_THREADS 0x2000
692 //The following defines may change, don't expect compatibility if you use them.
693 #define MB_TYPE_INTRA4x4 0x0001
694 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
695 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
696 #define MB_TYPE_16x16 0x0008
697 #define MB_TYPE_16x8 0x0010
698 #define MB_TYPE_8x16 0x0020
699 #define MB_TYPE_8x8 0x0040
700 #define MB_TYPE_INTERLACED 0x0080
701 #define MB_TYPE_DIRECT2 0x0100 //FIXME
702 #define MB_TYPE_ACPRED 0x0200
703 #define MB_TYPE_GMC 0x0400
704 #define MB_TYPE_SKIP 0x0800
705 #define MB_TYPE_P0L0 0x1000
706 #define MB_TYPE_P1L0 0x2000
707 #define MB_TYPE_P0L1 0x4000
708 #define MB_TYPE_P1L1 0x8000
709 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
710 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
711 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
712 #define MB_TYPE_QUANT 0x00010000
713 #define MB_TYPE_CBP 0x00020000
714 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
718 * This specifies the area which should be displayed.
719 * Note there may be multiple such areas for one frame.
721 typedef struct AVPanScan{
724 * - encoding: Set by user.
725 * - decoding: Set by libavcodec.
730 * width and height in 1/16 pel
731 * - encoding: Set by user.
732 * - decoding: Set by libavcodec.
738 * position of the top left corner in 1/16 pel for up to 3 fields/frames
739 * - encoding: Set by user.
740 * - decoding: Set by libavcodec.
742 int16_t position[3][2];
745 #define FF_COMMON_FRAME \
747 * pointer to the picture planes.\
748 * This might be different from the first allocated byte\
755 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
756 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
762 * 1 -> keyframe, 0-> not\
763 * - encoding: Set by libavcodec.\
764 * - decoding: Set by libavcodec.\
769 * Picture type of the frame, see ?_TYPE below.\
770 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
771 * - decoding: Set by libavcodec.\
773 enum AVPictureType pict_type;\
776 * presentation timestamp in time_base units (time when frame should be shown to user)\
777 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
778 * - encoding: MUST be set by user.\
779 * - decoding: Set by libavcodec.\
784 * picture number in bitstream order\
785 * - encoding: set by\
786 * - decoding: Set by libavcodec.\
788 int coded_picture_number;\
790 * picture number in display order\
791 * - encoding: set by\
792 * - decoding: Set by libavcodec.\
794 int display_picture_number;\
797 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
798 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
799 * - decoding: Set by libavcodec.\
804 * buffer age (1->was last buffer and dint change, 2->..., ...).\
805 * Set to INT_MAX if the buffer has not been used yet.\
806 * - encoding: unused\
807 * - decoding: MUST be set by get_buffer().\
812 * is this picture used as reference\
813 * The values for this are the same as the MpegEncContext.picture_structure\
814 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
815 * Set to 4 for delayed, non-reference frames.\
816 * - encoding: unused\
817 * - decoding: Set by libavcodec. (before get_buffer() call)).\
823 * - encoding: unused\
824 * - decoding: Set by libavcodec.\
826 int8_t *qscale_table;\
829 * - encoding: unused\
830 * - decoding: Set by libavcodec.\
835 * mbskip_table[mb]>=1 if MB didn't change\
836 * stride= mb_width = (width+15)>>4\
837 * - encoding: unused\
838 * - decoding: Set by libavcodec.\
840 uint8_t *mbskip_table;\
843 * motion vector table\
846 * int mv_sample_log2= 4 - motion_subsample_log2;\
847 * int mb_width= (width+15)>>4;\
848 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
849 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
851 * - encoding: Set by user.\
852 * - decoding: Set by libavcodec.\
854 int16_t (*motion_val[2])[2];\
857 * macroblock type table\
858 * mb_type_base + mb_width + 2\
859 * - encoding: Set by user.\
860 * - decoding: Set by libavcodec.\
865 * log2 of the size of the block which a single vector in motion_val represents: \
866 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
867 * - encoding: unused\
868 * - decoding: Set by libavcodec.\
870 uint8_t motion_subsample_log2;\
873 * for some private data of the user\
874 * - encoding: unused\
875 * - decoding: Set by user.\
881 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
882 * - decoding: unused\
887 * type of the buffer (to keep track of who has to deallocate data[*])\
888 * - encoding: Set by the one who allocates it.\
889 * - decoding: Set by the one who allocates it.\
890 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
895 * When decoding, this signals how much the picture must be delayed.\
896 * extra_delay = repeat_pict / (2*fps)\
897 * - encoding: unused\
898 * - decoding: Set by libavcodec.\
908 * The content of the picture is interlaced.\
909 * - encoding: Set by user.\
910 * - decoding: Set by libavcodec. (default 0)\
912 int interlaced_frame;\
915 * If the content is interlaced, is top field displayed first.\
916 * - encoding: Set by user.\
917 * - decoding: Set by libavcodec.\
919 int top_field_first;\
923 * - encoding: Set by user.\
924 * - decoding: Set by libavcodec.\
926 AVPanScan *pan_scan;\
929 * Tell user application that palette has changed from previous frame.\
930 * - encoding: ??? (no palette-enabled encoder yet)\
931 * - decoding: Set by libavcodec. (default 0).\
933 int palette_has_changed;\
936 * codec suggestion on buffer type if != 0\
937 * - encoding: unused\
938 * - decoding: Set by libavcodec. (before get_buffer() call)).\
944 * - encoding: unused\
945 * - decoding: Set by libavcodec.\
950 * motion reference frame index\
951 * the order in which these are stored can depend on the codec.\
952 * - encoding: Set by user.\
953 * - decoding: Set by libavcodec.\
955 int8_t *ref_index[2];\
958 * reordered opaque 64bit (generally an integer or a double precision float\
959 * PTS but can be anything). \
960 * The user sets AVCodecContext.reordered_opaque to represent the input at\
962 * the decoder reorders values as needed and sets AVFrame.reordered_opaque\
963 * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque \
964 * @deprecated in favor of pkt_pts\
965 * - encoding: unused\
966 * - decoding: Read by user.\
968 int64_t reordered_opaque;\
971 * hardware accelerator private data (FFmpeg allocated)\
972 * - encoding: unused\
973 * - decoding: Set by libavcodec\
975 void *hwaccel_picture_private;\
978 * reordered pts from the last AVPacket that has been input into the decoder\
979 * - encoding: unused\
980 * - decoding: Read by user.\
985 * dts from the last AVPacket that has been input into the decoder\
986 * - encoding: unused\
987 * - decoding: Read by user.\
992 * the AVCodecContext which ff_thread_get_buffer() was last called on\
993 * - encoding: Set by libavcodec.\
994 * - decoding: Set by libavcodec.\
996 struct AVCodecContext *owner;\
999 * used by multithreading to store frame-specific info\
1000 * - encoding: Set by libavcodec.\
1001 * - decoding: Set by libavcodec.\
1003 void *thread_opaque;\
1006 * frame timestamp estimated using various heuristics, in stream time base\
1007 * - encoding: unused\
1008 * - decoding: set by libavcodec, read by user.\
1010 int64_t best_effort_timestamp;\
1013 * reordered pos from the last AVPacket that has been input into the decoder\
1014 * - encoding: unused\
1015 * - decoding: Read by user.\
1020 * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1021 * - encoding: unused\
1022 * - decoding: Read by user.\
1024 AVRational sample_aspect_ratio;\
1027 * width and height of the video frame\
1028 * - encoding: unused\
1029 * - decoding: Read by user.\
1034 * format of the frame, -1 if unknown or unset\
1035 * It should be cast to the corresponding enum (enum PixelFormat\
1036 * for video, enum AVSampleFormat for audio)\
1037 * - encoding: unused\
1038 * - decoding: Read by user.\
1043 #define FF_QSCALE_TYPE_MPEG1 0
1044 #define FF_QSCALE_TYPE_MPEG2 1
1045 #define FF_QSCALE_TYPE_H264 2
1046 #define FF_QSCALE_TYPE_VP56 3
1048 #define FF_BUFFER_TYPE_INTERNAL 1
1049 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
1050 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
1051 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
1053 #if FF_API_OLD_FF_PICT_TYPES
1054 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
1055 #define FF_I_TYPE AV_PICTURE_TYPE_I ///< Intra
1056 #define FF_P_TYPE AV_PICTURE_TYPE_P ///< Predicted
1057 #define FF_B_TYPE AV_PICTURE_TYPE_B ///< Bi-dir predicted
1058 #define FF_S_TYPE AV_PICTURE_TYPE_S ///< S(GMC)-VOP MPEG4
1059 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
1060 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
1061 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
1064 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
1065 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
1066 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
1067 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
1069 enum AVPacketSideDataType {
1070 AV_PKT_DATA_PALETTE,
1073 typedef struct AVPacket {
1075 * Presentation timestamp in AVStream->time_base units; the time at which
1076 * the decompressed packet will be presented to the user.
1077 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1078 * pts MUST be larger or equal to dts as presentation cannot happen before
1079 * decompression, unless one wants to view hex dumps. Some formats misuse
1080 * the terms dts and pts/cts to mean something different. Such timestamps
1081 * must be converted to true pts/dts before they are stored in AVPacket.
1085 * Decompression timestamp in AVStream->time_base units; the time at which
1086 * the packet is decompressed.
1087 * Can be AV_NOPTS_VALUE if it is not stored in the file.
1095 * Additional packet data that can be provided by the container.
1096 * Packet can contain several types of side information.
1101 enum AVPacketSideDataType type;
1103 int side_data_elems;
1106 * Duration of this packet in AVStream->time_base units, 0 if unknown.
1107 * Equals next_pts - this_pts in presentation order.
1110 void (*destruct)(struct AVPacket *);
1112 int64_t pos; ///< byte position in stream, -1 if unknown
1115 * Time difference in AVStream->time_base units from the pts of this
1116 * packet to the point at which the output from the decoder has converged
1117 * independent from the availability of previous frames. That is, the
1118 * frames are virtually identical no matter if decoding started from
1119 * the very first frame or from this keyframe.
1120 * Is AV_NOPTS_VALUE if unknown.
1121 * This field is not the display duration of the current packet.
1122 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1125 * The purpose of this field is to allow seeking in streams that have no
1126 * keyframes in the conventional sense. It corresponds to the
1127 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1128 * essential for some types of subtitle streams to ensure that all
1129 * subtitles are correctly displayed after seeking.
1131 int64_t convergence_duration;
1133 #define AV_PKT_FLAG_KEY 0x0001
1136 * Audio Video Frame.
1137 * New fields can be added to the end of FF_COMMON_FRAME with minor version
1139 * Removal, reordering and changes to existing fields require a major
1140 * version bump. No fields should be added into AVFrame before or after
1142 * sizeof(AVFrame) must not be used outside libav*.
1144 typedef struct AVFrame {
1149 * main external API structure.
1150 * New fields can be added to the end with minor version bumps.
1151 * Removal, reordering and changes to existing fields require a major
1153 * sizeof(AVCodecContext) must not be used outside libav*.
1155 typedef struct AVCodecContext {
1157 * information on struct for av_log
1158 * - set by avcodec_alloc_context
1160 const AVClass *av_class;
1162 * the average bitrate
1163 * - encoding: Set by user; unused for constant quantizer encoding.
1164 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1169 * number of bits the bitstream is allowed to diverge from the reference.
1170 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
1171 * - encoding: Set by user; unused for constant quantizer encoding.
1172 * - decoding: unused
1174 int bit_rate_tolerance;
1178 * - encoding: Set by user.
1179 * - decoding: Set by user.
1184 * Some codecs need additional format info. It is stored here.
1185 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1186 * specific codec MUST set it correctly otherwise stream copy breaks.
1187 * In general use of this field by muxers is not recommanded.
1188 * - encoding: Set by libavcodec.
1189 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1194 * Motion estimation algorithm used for video coding.
1195 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1196 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1197 * - encoding: MUST be set by user.
1198 * - decoding: unused
1203 * some codecs need / can use extradata like Huffman tables.
1204 * mjpeg: Huffman tables
1205 * rv10: additional flags
1206 * mpeg4: global headers (they can be in the bitstream or here)
1207 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1208 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1209 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1210 * - encoding: Set/allocated/freed by libavcodec.
1211 * - decoding: Set/allocated/freed by user.
1217 * This is the fundamental unit of time (in seconds) in terms
1218 * of which frame timestamps are represented. For fixed-fps content,
1219 * timebase should be 1/framerate and timestamp increments should be
1221 * - encoding: MUST be set by user.
1222 * - decoding: Set by libavcodec.
1224 AVRational time_base;
1228 * picture width / height.
1229 * - encoding: MUST be set by user.
1230 * - decoding: Set by libavcodec.
1231 * Note: For compatibility it is possible to set this instead of
1232 * coded_width/height before decoding.
1236 #define FF_ASPECT_EXTENDED 15
1239 * the number of pictures in a group of pictures, or 0 for intra_only
1240 * - encoding: Set by user.
1241 * - decoding: unused
1246 * Pixel format, see PIX_FMT_xxx.
1247 * May be set by the demuxer if known from headers.
1248 * May be overriden by the decoder if it knows better.
1249 * - encoding: Set by user.
1250 * - decoding: Set by user if known, overridden by libavcodec if known
1252 enum PixelFormat pix_fmt;
1255 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1256 * decoder to draw a horizontal band. It improves cache usage. Not
1257 * all codecs can do that. You must check the codec capabilities
1259 * When multithreading is used, it may be called from multiple threads
1260 * at the same time; threads might draw different parts of the same AVFrame,
1261 * or multiple AVFrames, and there is no guarantee that slices will be drawn
1263 * The function is also used by hardware acceleration APIs.
1264 * It is called at least once during frame decoding to pass
1265 * the data needed for hardware render.
1266 * In that mode instead of pixel data, AVFrame points to
1267 * a structure specific to the acceleration API. The application
1268 * reads the structure and can change some fields to indicate progress
1270 * - encoding: unused
1271 * - decoding: Set by user.
1272 * @param height the height of the slice
1273 * @param y the y position of the slice
1274 * @param type 1->top field, 2->bottom field, 3->frame
1275 * @param offset offset into the AVFrame.data from which the slice should be read
1277 void (*draw_horiz_band)(struct AVCodecContext *s,
1278 const AVFrame *src, int offset[4],
1279 int y, int type, int height);
1282 int sample_rate; ///< samples per second
1283 int channels; ///< number of audio channels
1286 * audio sample format
1287 * - encoding: Set by user.
1288 * - decoding: Set by libavcodec.
1290 enum AVSampleFormat sample_fmt; ///< sample format
1292 /* The following data should not be initialized. */
1294 * Samples per packet, initialized when calling 'init'.
1297 int frame_number; ///< audio or video frame number
1300 * Number of frames the decoded output will be delayed relative to
1301 * the encoded input.
1302 * - encoding: Set by libavcodec.
1303 * - decoding: unused
1307 /* - encoding parameters */
1308 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1309 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1313 * - encoding: Set by user.
1314 * - decoding: unused
1320 * - encoding: Set by user.
1321 * - decoding: unused
1326 * maximum quantizer difference between frames
1327 * - encoding: Set by user.
1328 * - decoding: unused
1333 * maximum number of B-frames between non-B-frames
1334 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1335 * - encoding: Set by user.
1336 * - decoding: unused
1341 * qscale factor between IP and B-frames
1342 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1343 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1344 * - encoding: Set by user.
1345 * - decoding: unused
1347 float b_quant_factor;
1349 /** obsolete FIXME remove */
1351 #define FF_RC_STRATEGY_XVID 1
1353 int b_frame_strategy;
1355 struct AVCodec *codec;
1359 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1360 /* do its best to deliver a chunk with size */
1361 /* below rtp_payload_size, the chunk will start */
1362 /* with a start code on some codecs like H.263. */
1363 /* This doesn't take account of any particular */
1364 /* headers inside the transmitted RTP payload. */
1367 /* The RTP callback: This function is called */
1368 /* every time the encoder has a packet to send. */
1369 /* It depends on the encoder if the data starts */
1370 /* with a Start Code (it should). H.263 does. */
1371 /* mb_nb contains the number of macroblocks */
1372 /* encoded in the RTP payload. */
1373 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1375 /* statistics, used for 2-pass encoding */
1386 * number of bits used for the previously encoded frame
1387 * - encoding: Set by libavcodec.
1388 * - decoding: unused
1393 * Private data of the user, can be used to carry app specific stuff.
1394 * - encoding: Set by user.
1395 * - decoding: Set by user.
1399 char codec_name[32];
1400 enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1401 enum CodecID codec_id; /* see CODEC_ID_xxx */
1404 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1405 * This is used to work around some encoder bugs.
1406 * A demuxer should set this to what is stored in the field used to identify the codec.
1407 * If there are multiple such fields in a container then the demuxer should choose the one
1408 * which maximizes the information about the used codec.
1409 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1410 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1411 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1413 * - encoding: Set by user, if not then the default based on codec_id will be used.
1414 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1416 unsigned int codec_tag;
1419 * Work around bugs in encoders which sometimes cannot be detected automatically.
1420 * - encoding: Set by user
1421 * - decoding: Set by user
1423 int workaround_bugs;
1424 #define FF_BUG_AUTODETECT 1 ///< autodetection
1425 #define FF_BUG_OLD_MSMPEG4 2
1426 #define FF_BUG_XVID_ILACE 4
1427 #define FF_BUG_UMP4 8
1428 #define FF_BUG_NO_PADDING 16
1429 #define FF_BUG_AMV 32
1430 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1431 #define FF_BUG_QPEL_CHROMA 64
1432 #define FF_BUG_STD_QPEL 128
1433 #define FF_BUG_QPEL_CHROMA2 256
1434 #define FF_BUG_DIRECT_BLOCKSIZE 512
1435 #define FF_BUG_EDGE 1024
1436 #define FF_BUG_HPEL_CHROMA 2048
1437 #define FF_BUG_DC_CLIP 4096
1438 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1439 #define FF_BUG_TRUNCATED 16384
1440 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1443 * luma single coefficient elimination threshold
1444 * - encoding: Set by user.
1445 * - decoding: unused
1447 int luma_elim_threshold;
1450 * chroma single coeff elimination threshold
1451 * - encoding: Set by user.
1452 * - decoding: unused
1454 int chroma_elim_threshold;
1457 * strictly follow the standard (MPEG4, ...).
1458 * - encoding: Set by user.
1459 * - decoding: Set by user.
1460 * Setting this to STRICT or higher means the encoder and decoder will
1461 * generally do stupid things, whereas setting it to unofficial or lower
1462 * will mean the encoder might produce output that is not supported by all
1463 * spec-compliant decoders. Decoders don't differentiate between normal,
1464 * unofficial and experimental (that is, they always try to decode things
1465 * when they can) unless they are explicitly asked to behave stupidly
1466 * (=strictly conform to the specs)
1468 int strict_std_compliance;
1469 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to an older more strict version of the spec or reference software.
1470 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1471 #define FF_COMPLIANCE_NORMAL 0
1472 #define FF_COMPLIANCE_UNOFFICIAL -1 ///< Allow unofficial extensions
1473 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1476 * qscale offset between IP and B-frames
1477 * - encoding: Set by user.
1478 * - decoding: unused
1480 float b_quant_offset;
1483 * Error recognization; higher values will detect more errors but may
1484 * misdetect some more or less valid parts as errors.
1485 * - encoding: unused
1486 * - decoding: Set by user.
1488 int error_recognition;
1489 #define FF_ER_CAREFUL 1
1490 #define FF_ER_COMPLIANT 2
1491 #define FF_ER_AGGRESSIVE 3
1492 #define FF_ER_VERY_AGGRESSIVE 4
1495 * Called at the beginning of each frame to get a buffer for it.
1496 * If pic.reference is set then the frame will be read later by libavcodec.
1497 * avcodec_align_dimensions2() should be used to find the required width and
1498 * height, as they normally need to be rounded up to the next multiple of 16.
1499 * if CODEC_CAP_DR1 is not set then get_buffer() must call
1500 * avcodec_default_get_buffer() instead of providing buffers allocated by
1502 * If frame multithreading is used and thread_safe_callbacks is set,
1503 * it may be called from a different thread, but not from more than one at once.
1504 * Does not need to be reentrant.
1505 * - encoding: unused
1506 * - decoding: Set by libavcodec, user can override.
1508 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1511 * Called to release buffers which were allocated with get_buffer.
1512 * A released buffer can be reused in get_buffer().
1513 * pic.data[*] must be set to NULL.
1514 * May be called from a different thread if frame multithreading is used,
1515 * but not by more than one thread at once, so does not need to be reentrant.
1516 * - encoding: unused
1517 * - decoding: Set by libavcodec, user can override.
1519 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1522 * Size of the frame reordering buffer in the decoder.
1523 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1524 * - encoding: Set by libavcodec.
1525 * - decoding: Set by libavcodec.
1530 * number of bytes per packet if constant and known or 0
1531 * Used by some WAV based audio codecs.
1535 int parse_only; /* - decoding only: If true, only parsing is done
1536 (function avcodec_parse_frame()). The frame
1537 data is returned. Only MPEG codecs support this now. */
1540 * 0-> h263 quant 1-> mpeg quant
1541 * - encoding: Set by user.
1542 * - decoding: unused
1547 * pass1 encoding statistics output buffer
1548 * - encoding: Set by libavcodec.
1549 * - decoding: unused
1554 * pass2 encoding statistics input buffer
1555 * Concatenated stuff from stats_out of pass1 should be placed here.
1556 * - encoding: Allocated/set/freed by user.
1557 * - decoding: unused
1562 * ratecontrol qmin qmax limiting method
1563 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1564 * - encoding: Set by user.
1565 * - decoding: unused
1573 * ratecontrol override, see RcOverride
1574 * - encoding: Allocated/set/freed by user.
1575 * - decoding: unused
1577 RcOverride *rc_override;
1578 int rc_override_count;
1581 * rate control equation
1582 * - encoding: Set by user
1583 * - decoding: unused
1589 * - encoding: Set by user.
1590 * - decoding: unused
1596 * - encoding: Set by user.
1597 * - decoding: unused
1602 * decoder bitstream buffer size
1603 * - encoding: Set by user.
1604 * - decoding: unused
1607 float rc_buffer_aggressivity;
1610 * qscale factor between P and I-frames
1611 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1612 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1613 * - encoding: Set by user.
1614 * - decoding: unused
1616 float i_quant_factor;
1619 * qscale offset between P and I-frames
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 float i_quant_offset;
1626 * initial complexity for pass1 ratecontrol
1627 * - encoding: Set by user.
1628 * - decoding: unused
1630 float rc_initial_cplx;
1633 * DCT algorithm, see FF_DCT_* below
1634 * - encoding: Set by user.
1635 * - decoding: unused
1638 #define FF_DCT_AUTO 0
1639 #define FF_DCT_FASTINT 1
1640 #define FF_DCT_INT 2
1641 #define FF_DCT_MMX 3
1642 #define FF_DCT_MLIB 4
1643 #define FF_DCT_ALTIVEC 5
1644 #define FF_DCT_FAAN 6
1647 * luminance masking (0-> disabled)
1648 * - encoding: Set by user.
1649 * - decoding: unused
1654 * temporary complexity masking (0-> disabled)
1655 * - encoding: Set by user.
1656 * - decoding: unused
1658 float temporal_cplx_masking;
1661 * spatial complexity masking (0-> disabled)
1662 * - encoding: Set by user.
1663 * - decoding: unused
1665 float spatial_cplx_masking;
1668 * p block masking (0-> disabled)
1669 * - encoding: Set by user.
1670 * - decoding: unused
1675 * darkness masking (0-> disabled)
1676 * - encoding: Set by user.
1677 * - decoding: unused
1682 * IDCT algorithm, see FF_IDCT_* below.
1683 * - encoding: Set by user.
1684 * - decoding: Set by user.
1687 #define FF_IDCT_AUTO 0
1688 #define FF_IDCT_INT 1
1689 #define FF_IDCT_SIMPLE 2
1690 #define FF_IDCT_SIMPLEMMX 3
1691 #define FF_IDCT_LIBMPEG2MMX 4
1692 #define FF_IDCT_PS2 5
1693 #define FF_IDCT_MLIB 6
1694 #define FF_IDCT_ARM 7
1695 #define FF_IDCT_ALTIVEC 8
1696 #define FF_IDCT_SH4 9
1697 #define FF_IDCT_SIMPLEARM 10
1698 #define FF_IDCT_H264 11
1699 #define FF_IDCT_VP3 12
1700 #define FF_IDCT_IPP 13
1701 #define FF_IDCT_XVIDMMX 14
1702 #define FF_IDCT_CAVS 15
1703 #define FF_IDCT_SIMPLEARMV5TE 16
1704 #define FF_IDCT_SIMPLEARMV6 17
1705 #define FF_IDCT_SIMPLEVIS 18
1706 #define FF_IDCT_WMV2 19
1707 #define FF_IDCT_FAAN 20
1708 #define FF_IDCT_EA 21
1709 #define FF_IDCT_SIMPLENEON 22
1710 #define FF_IDCT_SIMPLEALPHA 23
1711 #define FF_IDCT_BINK 24
1715 * - encoding: Set by libavcodec.
1716 * - decoding: Set by user (or 0).
1720 * slice offsets in the frame in bytes
1721 * - encoding: Set/allocated by libavcodec.
1722 * - decoding: Set/allocated by user (or NULL).
1727 * error concealment flags
1728 * - encoding: unused
1729 * - decoding: Set by user.
1731 int error_concealment;
1732 #define FF_EC_GUESS_MVS 1
1733 #define FF_EC_DEBLOCK 2
1736 * dsp_mask could be add used to disable unwanted CPU features
1737 * CPU features (i.e. MMX, SSE. ...)
1739 * With the FORCE flag you may instead enable given CPU features.
1740 * (Dangerous: Usable in case of misdetection, improper usage however will
1741 * result into program crash.)
1746 * bits per sample/pixel from the demuxer (needed for huffyuv).
1747 * - encoding: Set by libavcodec.
1748 * - decoding: Set by user.
1750 int bits_per_coded_sample;
1753 * prediction method (needed for huffyuv)
1754 * - encoding: Set by user.
1755 * - decoding: unused
1757 int prediction_method;
1758 #define FF_PRED_LEFT 0
1759 #define FF_PRED_PLANE 1
1760 #define FF_PRED_MEDIAN 2
1763 * sample aspect ratio (0 if unknown)
1764 * That is the width of a pixel divided by the height of the pixel.
1765 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1766 * - encoding: Set by user.
1767 * - decoding: Set by libavcodec.
1769 AVRational sample_aspect_ratio;
1772 * the picture in the bitstream
1773 * - encoding: Set by libavcodec.
1774 * - decoding: Set by libavcodec.
1776 AVFrame *coded_frame;
1780 * - encoding: Set by user.
1781 * - decoding: Set by user.
1784 #define FF_DEBUG_PICT_INFO 1
1785 #define FF_DEBUG_RC 2
1786 #define FF_DEBUG_BITSTREAM 4
1787 #define FF_DEBUG_MB_TYPE 8
1788 #define FF_DEBUG_QP 16
1789 #define FF_DEBUG_MV 32
1790 #define FF_DEBUG_DCT_COEFF 0x00000040
1791 #define FF_DEBUG_SKIP 0x00000080
1792 #define FF_DEBUG_STARTCODE 0x00000100
1793 #define FF_DEBUG_PTS 0x00000200
1794 #define FF_DEBUG_ER 0x00000400
1795 #define FF_DEBUG_MMCO 0x00000800
1796 #define FF_DEBUG_BUGS 0x00001000
1797 #define FF_DEBUG_VIS_QP 0x00002000
1798 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1799 #define FF_DEBUG_BUFFERS 0x00008000
1800 #define FF_DEBUG_THREADS 0x00010000
1804 * - encoding: Set by user.
1805 * - decoding: Set by user.
1808 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1809 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1810 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1814 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1815 * - decoding: unused
1820 * motion estimation comparison function
1821 * - encoding: Set by user.
1822 * - decoding: unused
1826 * subpixel motion estimation comparison function
1827 * - encoding: Set by user.
1828 * - decoding: unused
1832 * macroblock comparison function (not supported yet)
1833 * - encoding: Set by user.
1834 * - decoding: unused
1838 * interlaced DCT comparison function
1839 * - encoding: Set by user.
1840 * - decoding: unused
1843 #define FF_CMP_SAD 0
1844 #define FF_CMP_SSE 1
1845 #define FF_CMP_SATD 2
1846 #define FF_CMP_DCT 3
1847 #define FF_CMP_PSNR 4
1848 #define FF_CMP_BIT 5
1850 #define FF_CMP_ZERO 7
1851 #define FF_CMP_VSAD 8
1852 #define FF_CMP_VSSE 9
1853 #define FF_CMP_NSSE 10
1854 #define FF_CMP_W53 11
1855 #define FF_CMP_W97 12
1856 #define FF_CMP_DCTMAX 13
1857 #define FF_CMP_DCT264 14
1858 #define FF_CMP_CHROMA 256
1861 * ME diamond size & shape
1862 * - encoding: Set by user.
1863 * - decoding: unused
1868 * amount of previous MV predictors (2a+1 x 2a+1 square)
1869 * - encoding: Set by user.
1870 * - decoding: unused
1872 int last_predictor_count;
1875 * prepass for motion estimation
1876 * - encoding: Set by user.
1877 * - decoding: unused
1882 * motion estimation prepass comparison function
1883 * - encoding: Set by user.
1884 * - decoding: unused
1889 * ME prepass diamond size & shape
1890 * - encoding: Set by user.
1891 * - decoding: unused
1897 * - encoding: Set by user.
1898 * - decoding: unused
1900 int me_subpel_quality;
1903 * callback to negotiate the pixelFormat
1904 * @param fmt is the list of formats which are supported by the codec,
1905 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1906 * The first is always the native one.
1907 * @return the chosen format
1908 * - encoding: unused
1909 * - decoding: Set by user, if not set the native format will be chosen.
1911 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1914 * DTG active format information (additional aspect ratio
1915 * information only used in DVB MPEG-2 transport streams)
1918 * - encoding: unused
1919 * - decoding: Set by decoder.
1921 int dtg_active_format;
1922 #define FF_DTG_AFD_SAME 8
1923 #define FF_DTG_AFD_4_3 9
1924 #define FF_DTG_AFD_16_9 10
1925 #define FF_DTG_AFD_14_9 11
1926 #define FF_DTG_AFD_4_3_SP_14_9 13
1927 #define FF_DTG_AFD_16_9_SP_14_9 14
1928 #define FF_DTG_AFD_SP_4_3 15
1931 * maximum motion estimation search range in subpel units
1932 * If 0 then no limit.
1934 * - encoding: Set by user.
1935 * - decoding: unused
1940 * intra quantizer bias
1941 * - encoding: Set by user.
1942 * - decoding: unused
1944 int intra_quant_bias;
1945 #define FF_DEFAULT_QUANT_BIAS 999999
1948 * inter quantizer bias
1949 * - encoding: Set by user.
1950 * - decoding: unused
1952 int inter_quant_bias;
1956 * - encoding: unused
1957 * - decoding: Which clrtable should be used for 8bit RGB images.
1958 * Tables have to be stored somewhere. FIXME
1963 * internal_buffer count
1964 * Don't touch, used by libavcodec default_get_buffer().
1966 int internal_buffer_count;
1970 * Don't touch, used by libavcodec default_get_buffer().
1972 void *internal_buffer;
1975 * Global quality for codecs which cannot change it per frame.
1976 * This should be proportional to MPEG-1/2/4 qscale.
1977 * - encoding: Set by user.
1978 * - decoding: unused
1982 #define FF_CODER_TYPE_VLC 0
1983 #define FF_CODER_TYPE_AC 1
1984 #define FF_CODER_TYPE_RAW 2
1985 #define FF_CODER_TYPE_RLE 3
1986 #define FF_CODER_TYPE_DEFLATE 4
1989 * - encoding: Set by user.
1990 * - decoding: unused
1996 * - encoding: Set by user.
1997 * - decoding: unused
2003 * - encoding: unused
2004 * - decoding: Set by user.
2006 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2011 * - encoding: unused
2012 * - decoding: Set by user.
2015 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
2016 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2017 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2020 * XVideo Motion Acceleration
2021 * - encoding: forbidden
2022 * - decoding: set by decoder
2024 int xvmc_acceleration;
2027 * macroblock decision mode
2028 * - encoding: Set by user.
2029 * - decoding: unused
2032 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
2033 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
2034 #define FF_MB_DECISION_RD 2 ///< rate distortion
2037 * custom intra quantization matrix
2038 * - encoding: Set by user, can be NULL.
2039 * - decoding: Set by libavcodec.
2041 uint16_t *intra_matrix;
2044 * custom inter quantization matrix
2045 * - encoding: Set by user, can be NULL.
2046 * - decoding: Set by libavcodec.
2048 uint16_t *inter_matrix;
2051 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2052 * This is used to work around some encoder bugs.
2053 * - encoding: unused
2054 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2056 unsigned int stream_codec_tag;
2059 * scene change detection threshold
2060 * 0 is default, larger means fewer detected scene changes.
2061 * - encoding: Set by user.
2062 * - decoding: unused
2064 int scenechange_threshold;
2067 * minimum Lagrange multipler
2068 * - encoding: Set by user.
2069 * - decoding: unused
2074 * maximum Lagrange multipler
2075 * - encoding: Set by user.
2076 * - decoding: unused
2080 #if FF_API_PALETTE_CONTROL
2082 * palette control structure
2083 * - encoding: ??? (no palette-enabled encoder yet)
2084 * - decoding: Set by user.
2086 struct AVPaletteControl *palctrl;
2090 * noise reduction strength
2091 * - encoding: Set by user.
2092 * - decoding: unused
2094 int noise_reduction;
2097 * Called at the beginning of a frame to get cr buffer for it.
2098 * Buffer type (size, hints) must be the same. libavcodec won't check it.
2099 * libavcodec will pass previous buffer in pic, function should return
2100 * same buffer or new buffer with old frame "painted" into it.
2101 * If pic.data[0] == NULL must behave like get_buffer().
2102 * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2103 * avcodec_default_reget_buffer() instead of providing buffers allocated by
2105 * - encoding: unused
2106 * - decoding: Set by libavcodec, user can override.
2108 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2111 * Number of bits which should be loaded into the rc buffer before decoding starts.
2112 * - encoding: Set by user.
2113 * - decoding: unused
2115 int rc_initial_buffer_occupancy;
2119 * - encoding: Set by user.
2120 * - decoding: unused
2122 int inter_threshold;
2126 * - encoding: Set by user.
2127 * - decoding: Set by user.
2132 * Simulates errors in the bitstream to test error concealment.
2133 * - encoding: Set by user.
2134 * - decoding: unused
2138 #if FF_API_ANTIALIAS_ALGO
2140 * MP3 antialias algorithm, see FF_AA_* below.
2141 * - encoding: unused
2142 * - decoding: Set by user.
2144 attribute_deprecated int antialias_algo;
2145 #define FF_AA_AUTO 0
2146 #define FF_AA_FASTINT 1 //not implemented yet
2148 #define FF_AA_FLOAT 3
2152 * quantizer noise shaping
2153 * - encoding: Set by user.
2154 * - decoding: unused
2156 int quantizer_noise_shaping;
2160 * is used to decide how many independent tasks should be passed to execute()
2161 * - encoding: Set by user.
2162 * - decoding: Set by user.
2167 * The codec may call this to execute several independent things.
2168 * It will return only after finishing all tasks.
2169 * The user may replace this with some multithreaded implementation,
2170 * the default implementation will execute the parts serially.
2171 * @param count the number of things to execute
2172 * - encoding: Set by libavcodec, user can override.
2173 * - decoding: Set by libavcodec, user can override.
2175 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2179 * Can be used by execute() to store some per AVCodecContext stuff.
2180 * - encoding: set by execute()
2181 * - decoding: set by execute()
2183 void *thread_opaque;
2186 * Motion estimation threshold below which no motion estimation is
2187 * performed, but instead the user specified motion vectors are used.
2189 * - encoding: Set by user.
2190 * - decoding: unused
2195 * Macroblock threshold below which the user specified macroblock types will be used.
2196 * - encoding: Set by user.
2197 * - decoding: unused
2202 * precision of the intra DC coefficient - 8
2203 * - encoding: Set by user.
2204 * - decoding: unused
2206 int intra_dc_precision;
2209 * noise vs. sse weight for the nsse comparsion function
2210 * - encoding: Set by user.
2211 * - decoding: unused
2216 * Number of macroblock rows at the top which are skipped.
2217 * - encoding: unused
2218 * - decoding: Set by user.
2223 * Number of macroblock rows at the bottom which are skipped.
2224 * - encoding: unused
2225 * - decoding: Set by user.
2231 * - encoding: Set by user.
2232 * - decoding: Set by libavcodec.
2235 #define FF_PROFILE_UNKNOWN -99
2236 #define FF_PROFILE_RESERVED -100
2238 #define FF_PROFILE_AAC_MAIN 0
2239 #define FF_PROFILE_AAC_LOW 1
2240 #define FF_PROFILE_AAC_SSR 2
2241 #define FF_PROFILE_AAC_LTP 3
2243 #define FF_PROFILE_DTS 20
2244 #define FF_PROFILE_DTS_ES 30
2245 #define FF_PROFILE_DTS_96_24 40
2246 #define FF_PROFILE_DTS_HD_HRA 50
2247 #define FF_PROFILE_DTS_HD_MA 60
2249 #define FF_PROFILE_MPEG2_422 0
2250 #define FF_PROFILE_MPEG2_HIGH 1
2251 #define FF_PROFILE_MPEG2_SS 2
2252 #define FF_PROFILE_MPEG2_SNR_SCALABLE 3
2253 #define FF_PROFILE_MPEG2_MAIN 4
2254 #define FF_PROFILE_MPEG2_SIMPLE 5
2256 #define FF_PROFILE_H264_CONSTRAINED (1<<9) // 8+1; constraint_set1_flag
2257 #define FF_PROFILE_H264_INTRA (1<<11) // 8+3; constraint_set3_flag
2259 #define FF_PROFILE_H264_BASELINE 66
2260 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2261 #define FF_PROFILE_H264_MAIN 77
2262 #define FF_PROFILE_H264_EXTENDED 88
2263 #define FF_PROFILE_H264_HIGH 100
2264 #define FF_PROFILE_H264_HIGH_10 110
2265 #define FF_PROFILE_H264_HIGH_10_INTRA (110|FF_PROFILE_H264_INTRA)
2266 #define FF_PROFILE_H264_HIGH_422 122
2267 #define FF_PROFILE_H264_HIGH_422_INTRA (122|FF_PROFILE_H264_INTRA)
2268 #define FF_PROFILE_H264_HIGH_444 144
2269 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE 244
2270 #define FF_PROFILE_H264_HIGH_444_INTRA (244|FF_PROFILE_H264_INTRA)
2271 #define FF_PROFILE_H264_CAVLC_444 44
2273 #define FF_PROFILE_VC1_SIMPLE 0
2274 #define FF_PROFILE_VC1_MAIN 1
2275 #define FF_PROFILE_VC1_COMPLEX 2
2276 #define FF_PROFILE_VC1_ADVANCED 3
2280 * - encoding: Set by user.
2281 * - decoding: Set by libavcodec.
2284 #define FF_LEVEL_UNKNOWN -99
2287 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2288 * - encoding: unused
2289 * - decoding: Set by user.
2294 * Bitstream width / height, may be different from width/height if lowres
2295 * or other things are used.
2296 * - encoding: unused
2297 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2299 int coded_width, coded_height;
2302 * frame skip threshold
2303 * - encoding: Set by user.
2304 * - decoding: unused
2306 int frame_skip_threshold;
2310 * - encoding: Set by user.
2311 * - decoding: unused
2313 int frame_skip_factor;
2316 * frame skip exponent
2317 * - encoding: Set by user.
2318 * - decoding: unused
2323 * frame skip comparison function
2324 * - encoding: Set by user.
2325 * - decoding: unused
2330 * Border processing masking, raises the quantizer for mbs on the borders
2332 * - encoding: Set by user.
2333 * - decoding: unused
2335 float border_masking;
2338 * minimum MB lagrange multipler
2339 * - encoding: Set by user.
2340 * - decoding: unused
2345 * maximum MB lagrange multipler
2346 * - encoding: Set by user.
2347 * - decoding: unused
2353 * - encoding: Set by user.
2354 * - decoding: unused
2356 int me_penalty_compensation;
2360 * - encoding: unused
2361 * - decoding: Set by user.
2363 enum AVDiscard skip_loop_filter;
2367 * - encoding: unused
2368 * - decoding: Set by user.
2370 enum AVDiscard skip_idct;
2374 * - encoding: unused
2375 * - decoding: Set by user.
2377 enum AVDiscard skip_frame;
2381 * - encoding: Set by user.
2382 * - decoding: unused
2388 * - encoding: Set by user.
2389 * - decoding: unused
2394 * constant rate factor - quality-based VBR - values ~correspond to qps
2395 * - encoding: Set by user.
2396 * - decoding: unused
2401 * constant quantization parameter rate control method
2402 * - encoding: Set by user.
2403 * - decoding: unused
2409 * - encoding: Set by user.
2410 * - decoding: unused
2415 * number of reference frames
2416 * - encoding: Set by user.
2417 * - decoding: Set by lavc.
2422 * chroma qp offset from luma
2423 * - encoding: Set by user.
2424 * - decoding: unused
2429 * Influences how often B-frames are used.
2430 * - encoding: Set by user.
2431 * - decoding: unused
2436 * trellis RD quantization
2437 * - encoding: Set by user.
2438 * - decoding: unused
2443 * Reduce fluctuations in qp (before curve compression).
2444 * - encoding: Set by user.
2445 * - decoding: unused
2447 float complexityblur;
2450 * in-loop deblocking filter alphac0 parameter
2451 * alpha is in the range -6...6
2452 * - encoding: Set by user.
2453 * - decoding: unused
2458 * in-loop deblocking filter beta parameter
2459 * beta is in the range -6...6
2460 * - encoding: Set by user.
2461 * - decoding: unused
2466 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2467 * - encoding: Set by user.
2468 * - decoding: unused
2471 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2472 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2473 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2474 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2475 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2478 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2479 * - encoding: Set by user.
2480 * - decoding: unused
2485 * Audio cutoff bandwidth (0 means "automatic")
2486 * - encoding: Set by user.
2487 * - decoding: unused
2492 * Multiplied by qscale for each frame and added to scene_change_score.
2493 * - encoding: Set by user.
2494 * - decoding: unused
2496 int scenechange_factor;
2500 * Note: Value depends upon the compare function used for fullpel ME.
2501 * - encoding: Set by user.
2502 * - decoding: unused
2507 * Adjusts sensitivity of b_frame_strategy 1.
2508 * - encoding: Set by user.
2509 * - decoding: unused
2514 * - encoding: Set by user.
2515 * - decoding: unused
2517 int compression_level;
2518 #define FF_COMPRESSION_DEFAULT -1
2521 * - encoding: Set by user.
2522 * - decoding: unused
2524 int min_prediction_order;
2527 * - encoding: Set by user.
2528 * - decoding: unused
2530 int max_prediction_order;
2532 #if FF_API_FLAC_GLOBAL_OPTS
2534 * @defgroup flac_opts FLAC options
2535 * @deprecated Use FLAC encoder private options instead.
2540 * LPC coefficient precision - used by FLAC encoder
2541 * - encoding: Set by user.
2542 * - decoding: unused
2544 attribute_deprecated int lpc_coeff_precision;
2547 * search method for selecting prediction order
2548 * - encoding: Set by user.
2549 * - decoding: unused
2551 attribute_deprecated int prediction_order_method;
2554 * - encoding: Set by user.
2555 * - decoding: unused
2557 attribute_deprecated int min_partition_order;
2560 * - encoding: Set by user.
2561 * - decoding: unused
2563 attribute_deprecated int max_partition_order;
2570 * GOP timecode frame start number, in non drop frame format
2571 * - encoding: Set by user.
2572 * - decoding: unused
2574 int64_t timecode_frame_start;
2576 #if FF_API_REQUEST_CHANNELS
2578 * Decoder should decode to this many channels if it can (0 for default)
2579 * - encoding: unused
2580 * - decoding: Set by user.
2581 * @deprecated Deprecated in favor of request_channel_layout.
2583 int request_channels;
2587 * Percentage of dynamic range compression to be applied by the decoder.
2588 * The default value is 1.0, corresponding to full compression.
2589 * - encoding: unused
2590 * - decoding: Set by user.
2595 * opaque 64bit number (generally a PTS) that will be reordered and
2596 * output in AVFrame.reordered_opaque
2597 * @deprecated in favor of pkt_pts
2598 * - encoding: unused
2599 * - decoding: Set by user.
2601 int64_t reordered_opaque;
2604 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2605 * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2606 * - encoding: set by user.
2607 * - decoding: set by libavcodec.
2609 int bits_per_raw_sample;
2612 * Audio channel layout.
2613 * - encoding: set by user.
2614 * - decoding: set by user, may be overwritten by libavcodec.
2616 int64_t channel_layout;
2619 * Request decoder to use this channel layout if it can (0 for default)
2620 * - encoding: unused
2621 * - decoding: Set by user.
2623 int64_t request_channel_layout;
2626 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2627 * - encoding: Set by user.
2628 * - decoding: unused.
2630 float rc_max_available_vbv_use;
2633 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2634 * - encoding: Set by user.
2635 * - decoding: unused.
2637 float rc_min_vbv_overflow_use;
2640 * Hardware accelerator in use
2641 * - encoding: unused.
2642 * - decoding: Set by libavcodec
2644 struct AVHWAccel *hwaccel;
2647 * For some codecs, the time base is closer to the field rate than the frame rate.
2648 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2649 * if no telecine is used ...
2651 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2653 int ticks_per_frame;
2656 * Hardware accelerator context.
2657 * For some hardware accelerators, a global context needs to be
2658 * provided by the user. In that case, this holds display-dependent
2659 * data FFmpeg cannot instantiate itself. Please refer to the
2660 * FFmpeg HW accelerator documentation to know how to fill this
2661 * is. e.g. for VA API, this is a struct vaapi_context.
2662 * - encoding: unused
2663 * - decoding: Set by user
2665 void *hwaccel_context;
2668 * Chromaticity coordinates of the source primaries.
2669 * - encoding: Set by user
2670 * - decoding: Set by libavcodec
2672 enum AVColorPrimaries color_primaries;
2675 * Color Transfer Characteristic.
2676 * - encoding: Set by user
2677 * - decoding: Set by libavcodec
2679 enum AVColorTransferCharacteristic color_trc;
2682 * YUV colorspace type.
2683 * - encoding: Set by user
2684 * - decoding: Set by libavcodec
2686 enum AVColorSpace colorspace;
2689 * MPEG vs JPEG YUV range.
2690 * - encoding: Set by user
2691 * - decoding: Set by libavcodec
2693 enum AVColorRange color_range;
2696 * This defines the location of chroma samples.
2697 * - encoding: Set by user
2698 * - decoding: Set by libavcodec
2700 enum AVChromaLocation chroma_sample_location;
2703 * The codec may call this to execute several independent things.
2704 * It will return only after finishing all tasks.
2705 * The user may replace this with some multithreaded implementation,
2706 * the default implementation will execute the parts serially.
2707 * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2708 * @param c context passed also to func
2709 * @param count the number of things to execute
2710 * @param arg2 argument passed unchanged to func
2711 * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2712 * @param func function that will be called count times, with jobnr from 0 to count-1.
2713 * threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2714 * two instances of func executing at the same time will have the same threadnr.
2715 * @return always 0 currently, but code should handle a future improvement where when any call to func
2716 * returns < 0 no further calls to func may be done and < 0 is returned.
2717 * - encoding: Set by libavcodec, user can override.
2718 * - decoding: Set by libavcodec, user can override.
2720 int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2723 * explicit P-frame weighted prediction analysis method
2725 * 1: fast blind weighting (one reference duplicate with -1 offset)
2726 * 2: smart weighting (full fade detection analysis)
2727 * - encoding: Set by user.
2728 * - decoding: unused
2730 int weighted_p_pred;
2735 * 1: Variance AQ (complexity mask)
2736 * 2: Auto-variance AQ (experimental)
2737 * - encoding: Set by user
2738 * - decoding: unused
2744 * Reduces blocking and blurring in flat and textured areas.
2745 * - encoding: Set by user
2746 * - decoding: unused
2752 * Strength of psychovisual optimization
2753 * - encoding: Set by user
2754 * - decoding: unused
2760 * Strength of psychovisual optimization
2761 * - encoding: Set by user
2762 * - decoding: unused
2768 * Number of frames for frametype and ratecontrol lookahead
2769 * - encoding: Set by user
2770 * - decoding: unused
2775 * Constant rate factor maximum
2776 * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2777 * than crf_max, even if doing so would violate VBV restrictions.
2778 * - encoding: Set by user.
2779 * - decoding: unused
2783 int log_level_offset;
2785 #if FF_API_FLAC_GLOBAL_OPTS
2787 * Determines which LPC analysis algorithm to use.
2788 * - encoding: Set by user
2789 * - decoding: unused
2791 attribute_deprecated enum AVLPCType lpc_type;
2794 * Number of passes to use for Cholesky factorization during LPC analysis
2795 * - encoding: Set by user
2796 * - decoding: unused
2798 attribute_deprecated int lpc_passes;
2803 * Indicates number of picture subdivisions. Used for parallelized
2805 * - encoding: Set by user
2806 * - decoding: unused
2811 * Header containing style information for text subtitles.
2812 * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2813 * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2814 * the Format line following. It shouldn't include any Dialogue line.
2815 * - encoding: Set/allocated/freed by user (before avcodec_open())
2816 * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2818 uint8_t *subtitle_header;
2819 int subtitle_header_size;
2822 * Current packet as passed into the decoder, to avoid having
2823 * to pass the packet into every function. Currently only valid
2824 * inside lavc and get/release_buffer callbacks.
2825 * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2826 * - encoding: unused
2831 * Whether this is a copy of the context which had init() called on it.
2832 * This is used by multithreading - shared tables and picture pointers
2833 * should be freed from the original context only.
2834 * - encoding: Set by libavcodec.
2835 * - decoding: Set by libavcodec.
2840 * Which multithreading methods to use.
2841 * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2842 * so clients which cannot provide future frames should not use it.
2844 * - encoding: Set by user, otherwise the default is used.
2845 * - decoding: Set by user, otherwise the default is used.
2848 #define FF_THREAD_FRAME 1 //< Decode more than one frame at once
2849 #define FF_THREAD_SLICE 2 //< Decode more than one part of a single frame at once
2852 * Which multithreading methods are in use by the codec.
2853 * - encoding: Set by libavcodec.
2854 * - decoding: Set by libavcodec.
2856 int active_thread_type;
2859 * Set by the client if its custom get_buffer() callback can be called
2860 * from another thread, which allows faster multithreaded decoding.
2861 * draw_horiz_band() will be called from other threads regardless of this setting.
2862 * Ignored if the default get_buffer() is used.
2863 * - encoding: Set by user.
2864 * - decoding: Set by user.
2866 int thread_safe_callbacks;
2869 * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2870 * Used for compliant TS muxing.
2871 * - encoding: Set by libavcodec.
2872 * - decoding: unused.
2877 * Type of service that the audio stream conveys.
2878 * - encoding: Set by user.
2879 * - decoding: Set by libavcodec.
2881 enum AVAudioServiceType audio_service_type;
2884 * desired sample format
2885 * - encoding: Not used.
2886 * - decoding: Set by user.
2887 * Decoder will decode to this format if it can.
2889 enum AVSampleFormat request_sample_fmt;
2892 * Current statistics for PTS correction.
2893 * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2894 * - encoding: unused
2896 int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2897 int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2898 int64_t pts_correction_last_pts; /// PTS of the last frame
2899 int64_t pts_correction_last_dts; /// DTS of the last frame
2907 typedef struct AVProfile {
2909 const char *name; ///< short name for the profile
2915 typedef struct AVCodec {
2917 * Name of the codec implementation.
2918 * The name is globally unique among encoders and among decoders (but an
2919 * encoder and a decoder can share the same name).
2920 * This is the primary way to find a codec from the user perspective.
2923 enum AVMediaType type;
2926 int (*init)(AVCodecContext *);
2927 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2928 int (*close)(AVCodecContext *);
2929 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2931 * Codec capabilities.
2935 struct AVCodec *next;
2938 * Will be called when seeking
2940 void (*flush)(AVCodecContext *);
2941 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2942 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2944 * Descriptive name for the codec, meant to be more human readable than name.
2945 * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2947 const char *long_name;
2948 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2949 const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2950 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2951 uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2952 const AVClass *priv_class; ///< AVClass for the private context
2953 const AVProfile *profiles; ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2956 * @defgroup framethreading Frame-level threading support functions.
2960 * If defined, called on thread contexts when they are created.
2961 * If the codec allocates writable tables in init(), re-allocate them here.
2962 * priv_data will be set to a copy of the original.
2964 int (*init_thread_copy)(AVCodecContext *);
2966 * Copy necessary context variables from a previous thread context to the current one.
2967 * If not defined, the next thread will start automatically; otherwise, the codec
2968 * must call ff_thread_finish_setup().
2970 * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2972 int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2979 typedef struct AVHWAccel {
2981 * Name of the hardware accelerated codec.
2982 * The name is globally unique among encoders and among decoders (but an
2983 * encoder and a decoder can share the same name).
2988 * Type of codec implemented by the hardware accelerator.
2990 * See AVMEDIA_TYPE_xxx
2992 enum AVMediaType type;
2995 * Codec implemented by the hardware accelerator.
3002 * Supported pixel format.
3004 * Only hardware accelerated formats are supported here.
3006 enum PixelFormat pix_fmt;
3009 * Hardware accelerated codec capabilities.
3010 * see FF_HWACCEL_CODEC_CAP_*
3014 struct AVHWAccel *next;
3017 * Called at the beginning of each frame or field picture.
3019 * Meaningful frame information (codec specific) is guaranteed to
3020 * be parsed at this point. This function is mandatory.
3022 * Note that buf can be NULL along with buf_size set to 0.
3023 * Otherwise, this means the whole frame is available at this point.
3025 * @param avctx the codec context
3026 * @param buf the frame data buffer base
3027 * @param buf_size the size of the frame in bytes
3028 * @return zero if successful, a negative value otherwise
3030 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3033 * Callback for each slice.
3035 * Meaningful slice information (codec specific) is guaranteed to
3036 * be parsed at this point. This function is mandatory.
3038 * @param avctx the codec context
3039 * @param buf the slice data buffer base
3040 * @param buf_size the size of the slice in bytes
3041 * @return zero if successful, a negative value otherwise
3043 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3046 * Called at the end of each frame or field picture.
3048 * The whole picture is parsed at this point and can now be sent
3049 * to the hardware accelerator. This function is mandatory.
3051 * @param avctx the codec context
3052 * @return zero if successful, a negative value otherwise
3054 int (*end_frame)(AVCodecContext *avctx);
3057 * Size of HW accelerator private data.
3059 * Private data is allocated with av_mallocz() before
3060 * AVCodecContext.get_buffer() and deallocated after
3061 * AVCodecContext.release_buffer().
3067 * four components are given, that's all.
3068 * the last component is alpha
3070 typedef struct AVPicture {
3072 int linesize[4]; ///< number of bytes per line
3075 #if FF_API_PALETTE_CONTROL
3078 * This structure defines a method for communicating palette changes
3079 * between and demuxer and a decoder.
3081 * @deprecated Use AVPacket to send palette changes instead.
3082 * This is totally broken.
3084 #define AVPALETTE_SIZE 1024
3085 #define AVPALETTE_COUNT 256
3086 typedef struct AVPaletteControl {
3088 /* Demuxer sets this to 1 to indicate the palette has changed;
3089 * decoder resets to 0. */
3090 int palette_changed;
3092 /* 4-byte ARGB palette entries, stored in native byte order; note that
3093 * the individual palette components should be on a 8-bit scale; if
3094 * the palette data comes from an IBM VGA native format, the component
3095 * data is probably 6 bits in size and needs to be scaled. */
3096 unsigned int palette[AVPALETTE_COUNT];
3098 } AVPaletteControl attribute_deprecated;
3101 enum AVSubtitleType {
3104 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
3107 * Plain text, the text field must be set by the decoder and is
3108 * authoritative. ass and pict fields may contain approximations.
3113 * Formatted text, the ass field must be set by the decoder and is
3114 * authoritative. pict and text fields may contain approximations.
3119 typedef struct AVSubtitleRect {
3120 int x; ///< top left corner of pict, undefined when pict is not set
3121 int y; ///< top left corner of pict, undefined when pict is not set
3122 int w; ///< width of pict, undefined when pict is not set
3123 int h; ///< height of pict, undefined when pict is not set
3124 int nb_colors; ///< number of colors in pict, undefined when pict is not set
3127 * data+linesize for the bitmap of this subtitle.
3128 * can be set for text/ass as well once they where rendered
3131 enum AVSubtitleType type;
3133 char *text; ///< 0 terminated plain UTF-8 text
3136 * 0 terminated ASS/SSA compatible event line.
3137 * The pressentation of this is unaffected by the other values in this
3143 typedef struct AVSubtitle {
3144 uint16_t format; /* 0 = graphics */
3145 uint32_t start_display_time; /* relative to packet pts, in ms */
3146 uint32_t end_display_time; /* relative to packet pts, in ms */
3148 AVSubtitleRect **rects;
3149 int64_t pts; ///< Same as packet pts, in AV_TIME_BASE
3152 /* packet functions */
3155 * @deprecated use NULL instead
3157 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3160 * Default packet destructor.
3162 void av_destruct_packet(AVPacket *pkt);
3165 * Initialize optional fields of a packet with default values.
3169 void av_init_packet(AVPacket *pkt);
3172 * Allocate the payload of a packet and initialize its fields with
3176 * @param size wanted payload size
3177 * @return 0 if OK, AVERROR_xxx otherwise
3179 int av_new_packet(AVPacket *pkt, int size);
3182 * Reduce packet size, correctly zeroing padding
3185 * @param size new size
3187 void av_shrink_packet(AVPacket *pkt, int size);
3190 * Increase packet size, correctly zeroing padding
3193 * @param grow_by number of bytes by which to increase the size of the packet
3195 int av_grow_packet(AVPacket *pkt, int grow_by);
3198 * @warning This is a hack - the packet memory allocation stuff is broken. The
3199 * packet is allocated if it was not really allocated.
3201 int av_dup_packet(AVPacket *pkt);
3206 * @param pkt packet to free
3208 void av_free_packet(AVPacket *pkt);
3211 * Allocate new information of a packet.
3214 * @param type side information type
3215 * @param size side information size
3216 * @return pointer to fresh allocated data or NULL otherwise
3218 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3222 * Get side information from packet.
3225 * @param type desired side information type
3226 * @param size pointer for side information size to store (optional)
3227 * @return pointer to data if present or NULL otherwise
3229 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3232 int av_packet_merge_side_data(AVPacket *pkt);
3234 int av_packet_split_side_data(AVPacket *pkt);
3239 struct ReSampleContext;
3240 struct AVResampleContext;
3242 typedef struct ReSampleContext ReSampleContext;
3245 * Initialize audio resampling context.
3247 * @param output_channels number of output channels
3248 * @param input_channels number of input channels
3249 * @param output_rate output sample rate
3250 * @param input_rate input sample rate
3251 * @param sample_fmt_out requested output sample format
3252 * @param sample_fmt_in input sample format
3253 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff frequency
3254 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3255 * @param linear if 1 then the used FIR filter will be linearly interpolated
3256 between the 2 closest, if 0 the closest will be used
3257 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3258 * @return allocated ReSampleContext, NULL if error occured
3260 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3261 int output_rate, int input_rate,
3262 enum AVSampleFormat sample_fmt_out,
3263 enum AVSampleFormat sample_fmt_in,
3264 int filter_length, int log2_phase_count,
3265 int linear, double cutoff);
3267 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3270 * Free resample context.
3272 * @param s a non-NULL pointer to a resample context previously
3273 * created with av_audio_resample_init()
3275 void audio_resample_close(ReSampleContext *s);
3279 * Initialize an audio resampler.
3280 * Note, if either rate is not an integer then simply scale both rates up so they are.
3281 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3282 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3283 * @param linear If 1 then the used FIR filter will be linearly interpolated
3284 between the 2 closest, if 0 the closest will be used
3285 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3287 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3290 * Resample an array of samples using a previously configured context.
3291 * @param src an array of unconsumed samples
3292 * @param consumed the number of samples of src which have been consumed are returned here
3293 * @param src_size the number of unconsumed samples available
3294 * @param dst_size the amount of space in samples available in dst
3295 * @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.
3296 * @return the number of samples written in dst or -1 if an error occurred
3298 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3302 * Compensate samplerate/timestamp drift. The compensation is done by changing
3303 * the resampler parameters, so no audible clicks or similar distortions occur
3304 * @param compensation_distance distance in output samples over which the compensation should be performed
3305 * @param sample_delta number of output samples which should be output less
3307 * example: av_resample_compensate(c, 10, 500)
3308 * here instead of 510 samples only 500 samples would be output
3310 * note, due to rounding the actual compensation might be slightly different,
3311 * especially if the compensation_distance is large and the in_rate used during init is small
3313 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3314 void av_resample_close(struct AVResampleContext *c);
3317 * Allocate memory for a picture. Call avpicture_free() to free it.
3319 * \see avpicture_fill()
3321 * @param picture the picture to be filled in
3322 * @param pix_fmt the format of the picture
3323 * @param width the width of the picture
3324 * @param height the height of the picture
3325 * @return zero if successful, a negative value if not
3327 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3330 * Free a picture previously allocated by avpicture_alloc().
3331 * The data buffer used by the AVPicture is freed, but the AVPicture structure
3334 * @param picture the AVPicture to be freed
3336 void avpicture_free(AVPicture *picture);
3339 * Fill in the AVPicture fields.
3340 * The fields of the given AVPicture are filled in by using the 'ptr' address
3341 * which points to the image data buffer. Depending on the specified picture
3342 * format, one or multiple image data pointers and line sizes will be set.
3343 * If a planar format is specified, several pointers will be set pointing to
3344 * the different picture planes and the line sizes of the different planes
3345 * will be stored in the lines_sizes array.
3346 * Call with ptr == NULL to get the required size for the ptr buffer.
3348 * To allocate the buffer and fill in the AVPicture fields in one call,
3349 * use avpicture_alloc().
3351 * @param picture AVPicture whose fields are to be filled in
3352 * @param ptr Buffer which will contain or contains the actual image data
3353 * @param pix_fmt The format in which the picture data is stored.
3354 * @param width the width of the image in pixels
3355 * @param height the height of the image in pixels
3356 * @return size of the image data in bytes
3358 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3359 enum PixelFormat pix_fmt, int width, int height);
3362 * Copy pixel data from an AVPicture into a buffer.
3363 * The data is stored compactly, without any gaps for alignment or padding
3364 * which may be applied by avpicture_fill().
3366 * \see avpicture_get_size()
3368 * @param[in] src AVPicture containing image data
3369 * @param[in] pix_fmt The format in which the picture data is stored.
3370 * @param[in] width the width of the image in pixels.
3371 * @param[in] height the height of the image in pixels.
3372 * @param[out] dest A buffer into which picture data will be copied.
3373 * @param[in] dest_size The size of 'dest'.
3374 * @return The number of bytes written to dest, or a negative value (error code) on error.
3376 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3377 unsigned char *dest, int dest_size);
3380 * Calculate the size in bytes that a picture of the given width and height
3381 * would occupy if stored in the given picture format.
3382 * Note that this returns the size of a compact representation as generated
3383 * by avpicture_layout(), which can be smaller than the size required for e.g.
3386 * @param pix_fmt the given picture format
3387 * @param width the width of the image
3388 * @param height the height of the image
3389 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3391 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3392 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3394 #if FF_API_GET_PIX_FMT_NAME
3396 * Return the short name for a pixel format.
3398 * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3399 * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3401 attribute_deprecated
3402 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3405 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3408 * Return a value representing the fourCC code associated to the
3409 * pixel format pix_fmt, or 0 if no associated fourCC code can be
3412 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3415 * Put a string representing the codec tag codec_tag in buf.
3417 * @param buf_size size in bytes of buf
3418 * @return the length of the string that would have been generated if
3419 * enough space had been available, excluding the trailing null
3421 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3423 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
3424 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
3425 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
3426 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
3427 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
3428 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3431 * Compute what kind of losses will occur when converting from one specific
3432 * pixel format to another.
3433 * When converting from one pixel format to another, information loss may occur.
3434 * For example, when converting from RGB24 to GRAY, the color information will
3435 * be lost. Similarly, other losses occur when converting from some formats to
3436 * other formats. These losses can involve loss of chroma, but also loss of
3437 * resolution, loss of color depth, loss due to the color space conversion, loss
3438 * of the alpha bits or loss due to color quantization.
3439 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3440 * which will occur when converting from one pixel format to another.
3442 * @param[in] dst_pix_fmt destination pixel format
3443 * @param[in] src_pix_fmt source pixel format
3444 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3445 * @return Combination of flags informing you what kind of losses will occur.
3447 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3451 * Find the best pixel format to convert to given a certain source pixel
3452 * format. When converting from one pixel format to another, information loss
3453 * may occur. For example, when converting from RGB24 to GRAY, the color
3454 * information will be lost. Similarly, other losses occur when converting from
3455 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3456 * the given pixel formats should be used to suffer the least amount of loss.
3457 * The pixel formats from which it chooses one, are determined by the
3458 * pix_fmt_mask parameter.
3461 * src_pix_fmt = PIX_FMT_YUV420P;
3462 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3463 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3466 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3467 * @param[in] src_pix_fmt source pixel format
3468 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3469 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3470 * @return The best pixel format to convert to or -1 if none was found.
3472 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3473 int has_alpha, int *loss_ptr);
3475 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
3476 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
3479 * Tell if an image really has transparent alpha values.
3480 * @return ored mask of FF_ALPHA_xxx constants
3482 int img_get_alpha_info(const AVPicture *src,
3483 enum PixelFormat pix_fmt, int width, int height);
3485 /* deinterlace a picture */
3486 /* deinterlace - if not supported return -1 */
3487 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3488 enum PixelFormat pix_fmt, int width, int height);
3490 /* external high level API */
3493 * If c is NULL, returns the first registered codec,
3494 * if c is non-NULL, returns the next registered codec after c,
3495 * or NULL if c is the last one.
3497 AVCodec *av_codec_next(AVCodec *c);
3500 * Return the LIBAVCODEC_VERSION_INT constant.
3502 unsigned avcodec_version(void);
3505 * Return the libavcodec build-time configuration.
3507 const char *avcodec_configuration(void);
3510 * Return the libavcodec license.
3512 const char *avcodec_license(void);
3515 * Initialize libavcodec.
3516 * If called more than once, does nothing.
3518 * @warning This function must be called before any other libavcodec
3521 * @warning This function is not thread-safe.
3523 void avcodec_init(void);
3526 * Register the codec codec and initialize libavcodec.
3528 * @see avcodec_init(), avcodec_register_all()
3530 void avcodec_register(AVCodec *codec);
3533 * Find a registered encoder with a matching codec ID.
3535 * @param id CodecID of the requested encoder
3536 * @return An encoder if one was found, NULL otherwise.
3538 AVCodec *avcodec_find_encoder(enum CodecID id);
3541 * Find a registered encoder with the specified name.
3543 * @param name name of the requested encoder
3544 * @return An encoder if one was found, NULL otherwise.
3546 AVCodec *avcodec_find_encoder_by_name(const char *name);
3549 * Find a registered decoder with a matching codec ID.
3551 * @param id CodecID of the requested decoder
3552 * @return A decoder if one was found, NULL otherwise.
3554 AVCodec *avcodec_find_decoder(enum CodecID id);
3557 * Find a registered decoder with the specified name.
3559 * @param name name of the requested decoder
3560 * @return A decoder if one was found, NULL otherwise.
3562 AVCodec *avcodec_find_decoder_by_name(const char *name);
3563 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3566 * Return a name for the specified profile, if available.
3568 * @param codec the codec that is searched for the given profile
3569 * @param profile the profile value for which a name is requested
3570 * @return A name for the profile if found, NULL otherwise.
3572 const char *av_get_profile_name(const AVCodec *codec, int profile);
3575 * Set the fields of the given AVCodecContext to default values.
3577 * @param s The AVCodecContext of which the fields should be set to default values.
3579 void avcodec_get_context_defaults(AVCodecContext *s);
3581 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3582 * we WILL change its arguments and name a few times! */
3583 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3585 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3586 * we WILL change its arguments and name a few times! */
3587 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3590 * Allocate an AVCodecContext and set its fields to default values. The
3591 * resulting struct can be deallocated by simply calling av_free().
3593 * @return An AVCodecContext filled with default values or NULL on failure.
3594 * @see avcodec_get_context_defaults
3596 AVCodecContext *avcodec_alloc_context(void);
3598 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3599 * we WILL change its arguments and name a few times! */
3600 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3602 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3603 * we WILL change its arguments and name a few times! */
3604 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3607 * Copy the settings of the source AVCodecContext into the destination
3608 * AVCodecContext. The resulting destination codec context will be
3609 * unopened, i.e. you are required to call avcodec_open() before you
3610 * can use this AVCodecContext to decode/encode video/audio data.
3612 * @param dest target codec context, should be initialized with
3613 * avcodec_alloc_context(), but otherwise uninitialized
3614 * @param src source codec context
3615 * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3617 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3620 * Set the fields of the given AVFrame to default values.
3622 * @param pic The AVFrame of which the fields should be set to default values.
3624 void avcodec_get_frame_defaults(AVFrame *pic);
3627 * Allocate an AVFrame and set its fields to default values. The resulting
3628 * struct can be deallocated by simply calling av_free().
3630 * @return An AVFrame filled with default values or NULL on failure.
3631 * @see avcodec_get_frame_defaults
3633 AVFrame *avcodec_alloc_frame(void);
3635 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3636 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3637 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3640 * Return the amount of padding in pixels which the get_buffer callback must
3641 * provide around the edge of the image for codecs which do not have the
3642 * CODEC_FLAG_EMU_EDGE flag.
3644 * @return Required padding in pixels.
3646 unsigned avcodec_get_edge_width(void);
3648 * Modify width and height values so that they will result in a memory
3649 * buffer that is acceptable for the codec if you do not use any horizontal
3652 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3653 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3654 * according to avcodec_get_edge_width() before.
3656 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3658 * Modify width and height values so that they will result in a memory
3659 * buffer that is acceptable for the codec if you also ensure that all
3660 * line sizes are a multiple of the respective linesize_align[i].
3662 * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3663 * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3664 * according to avcodec_get_edge_width() before.
3666 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3667 int linesize_align[4]);
3669 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3671 #if FF_API_THREAD_INIT
3673 * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3675 attribute_deprecated
3676 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3679 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3680 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3681 //FIXME func typedef
3684 * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3685 * function the context has to be allocated.
3687 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3688 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3689 * retrieving a codec.
3691 * @warning This function is not thread safe!
3694 * avcodec_register_all();
3695 * codec = avcodec_find_decoder(CODEC_ID_H264);
3699 * context = avcodec_alloc_context();
3701 * if (avcodec_open(context, codec) < 0)
3705 * @param avctx The context which will be set up to use the given codec.
3706 * @param codec The codec to use within the context.
3707 * @return zero on success, a negative value on error
3708 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3710 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3713 * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3714 * Some decoders may support multiple frames in a single AVPacket, such
3715 * decoders would then just decode the first frame. In this case,
3716 * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3717 * the remaining data in order to decode the second frame etc.
3719 * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3720 * decompressed frame size in bytes.
3722 * @warning You must set frame_size_ptr to the allocated size of the
3723 * output buffer before calling avcodec_decode_audio3().
3725 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3726 * the actual read bytes because some optimized bitstream readers read 32 or 64
3727 * bits at once and could read over the end.
3729 * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3730 * no overreading happens for damaged MPEG streams.
3732 * @note You might have to align the input buffer avpkt->data and output buffer
3733 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3734 * necessary at all, on others it won't work at all if not aligned and on others
3735 * it will work but it will have an impact on performance.
3737 * In practice, avpkt->data should have 4 byte alignment at minimum and
3738 * samples should be 16 byte aligned unless the CPU doesn't need it
3739 * (AltiVec and SSE do).
3741 * @param avctx the codec context
3742 * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3743 * @param[in,out] frame_size_ptr the output buffer size in bytes
3744 * @param[in] avpkt The input AVPacket containing the input buffer.
3745 * You can create such packet with av_init_packet() and by then setting
3746 * data and size, some decoders might in addition need other fields.
3747 * All decoders are designed to use the least fields possible though.
3748 * @return On error a negative value is returned, otherwise the number of bytes
3749 * used or zero if no frame data was decompressed (used) from the input AVPacket.
3751 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3752 int *frame_size_ptr,
3756 * Decode the video frame of size avpkt->size from avpkt->data into picture.
3757 * Some decoders may support multiple frames in a single AVPacket, such
3758 * decoders would then just decode the first frame.
3760 * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3761 * the actual read bytes because some optimized bitstream readers read 32 or 64
3762 * bits at once and could read over the end.
3764 * @warning The end of the input buffer buf should be set to 0 to ensure that
3765 * no overreading happens for damaged MPEG streams.
3767 * @note You might have to align the input buffer avpkt->data.
3768 * The alignment requirements depend on the CPU: on some CPUs it isn't
3769 * necessary at all, on others it won't work at all if not aligned and on others
3770 * it will work but it will have an impact on performance.
3772 * In practice, avpkt->data should have 4 byte alignment at minimum.
3774 * @note Some codecs have a delay between input and output, these need to be
3775 * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3777 * @param avctx the codec context
3778 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3779 * Use avcodec_alloc_frame to get an AVFrame, the codec will
3780 * allocate memory for the actual bitmap.
3781 * with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3782 * with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3783 * decodes and the decoder tells the user once it does not need the data anymore,
3784 * the user app can at this point free/reuse/keep the memory as it sees fit.
3786 * @param[in] avpkt The input AVpacket containing the input buffer.
3787 * You can create such packet with av_init_packet() and by then setting
3788 * data and size, some decoders might in addition need other fields like
3789 * flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3791 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3792 * @return On error a negative value is returned, otherwise the number of bytes
3793 * used or zero if no frame could be decompressed.
3795 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3796 int *got_picture_ptr,
3800 * Decode a subtitle message.
3801 * Return a negative value on error, otherwise return the number of bytes used.
3802 * If no subtitle could be decompressed, got_sub_ptr is zero.
3803 * Otherwise, the subtitle is stored in *sub.
3804 * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3805 * simplicity, because the performance difference is expect to be negligible
3806 * and reusing a get_buffer written for video codecs would probably perform badly
3807 * due to a potentially very different allocation pattern.
3809 * @param avctx the codec context
3810 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3811 freed with avsubtitle_free if *got_sub_ptr is set.
3812 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3813 * @param[in] avpkt The input AVPacket containing the input buffer.
3815 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3820 * Frees all allocated data in the given subtitle struct.
3822 * @param sub AVSubtitle to free.
3824 void avsubtitle_free(AVSubtitle *sub);
3826 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3828 uint8_t *buf, int buf_size);
3831 * Encode an audio frame from samples into buf.
3833 * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3834 * However, for PCM audio the user will know how much space is needed
3835 * because it depends on the value passed in buf_size as described
3836 * below. In that case a lower value can be used.
3838 * @param avctx the codec context
3839 * @param[out] buf the output buffer
3840 * @param[in] buf_size the output buffer size
3841 * @param[in] samples the input buffer containing the samples
3842 * The number of samples read from this buffer is frame_size*channels,
3843 * both of which are defined in avctx.
3844 * For PCM audio the number of samples read from samples is equal to
3845 * buf_size * input_sample_size / output_sample_size.
3846 * @return On error a negative value is returned, on success zero or the number
3847 * of bytes used to encode the data read from the input buffer.
3849 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3850 const short *samples);
3853 * Encode a video frame from pict into buf.
3854 * The input picture should be
3855 * stored using a specific format, namely avctx.pix_fmt.
3857 * @param avctx the codec context
3858 * @param[out] buf the output buffer for the bitstream of encoded frame
3859 * @param[in] buf_size the size of the output buffer in bytes
3860 * @param[in] pict the input picture to encode
3861 * @return On error a negative value is returned, on success zero or the number
3862 * of bytes used from the output buffer.
3864 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3865 const AVFrame *pict);
3866 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3867 const AVSubtitle *sub);
3869 int avcodec_close(AVCodecContext *avctx);
3872 * Register all the codecs, parsers and bitstream filters which were enabled at
3873 * configuration time. If you do not call this function you can select exactly
3874 * which formats you want to support, by using the individual registration
3877 * @see avcodec_register
3878 * @see av_register_codec_parser
3879 * @see av_register_bitstream_filter
3881 void avcodec_register_all(void);
3884 * Flush buffers, should be called when seeking or when switching to a different stream.
3886 void avcodec_flush_buffers(AVCodecContext *avctx);
3888 void avcodec_default_free_buffers(AVCodecContext *s);
3890 /* misc useful functions */
3892 #if FF_API_OLD_FF_PICT_TYPES
3894 * Return a single letter to describe the given picture type pict_type.
3896 * @param[in] pict_type the picture type
3897 * @return A single character representing the picture type.
3898 * @deprecated Use av_get_picture_type_char() instead.
3900 attribute_deprecated
3901 char av_get_pict_type_char(int pict_type);
3905 * Return codec bits per sample.
3907 * @param[in] codec_id the codec
3908 * @return Number of bits per sample or zero if unknown for the given codec.
3910 int av_get_bits_per_sample(enum CodecID codec_id);
3912 #if FF_API_OLD_SAMPLE_FMT
3914 * @deprecated Use av_get_bits_per_sample_fmt() instead.
3916 attribute_deprecated
3917 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
3921 typedef struct AVCodecParserContext {
3923 struct AVCodecParser *parser;
3924 int64_t frame_offset; /* offset of the current frame */
3925 int64_t cur_offset; /* current offset
3926 (incremented by each av_parser_parse()) */
3927 int64_t next_frame_offset; /* offset of the next frame */
3929 int pict_type; /* XXX: Put it back in AVCodecContext. */
3931 * This field is used for proper frame duration computation in lavf.
3932 * It signals, how much longer the frame duration of the current frame
3933 * is compared to normal frame duration.
3935 * frame_duration = (1 + repeat_pict) * time_base
3937 * It is used by codecs like H.264 to display telecined material.
3939 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3940 int64_t pts; /* pts of the current frame */
3941 int64_t dts; /* dts of the current frame */
3946 int fetch_timestamp;
3948 #define AV_PARSER_PTS_NB 4
3949 int cur_frame_start_index;
3950 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3951 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3952 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3955 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3956 #define PARSER_FLAG_ONCE 0x0002
3957 /// Set if the parser has a valid file offset
3958 #define PARSER_FLAG_FETCHED_OFFSET 0x0004
3960 int64_t offset; ///< byte offset from starting packet start
3961 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3964 * Set by parser to 1 for key frames and 0 for non-key frames.
3965 * It is initialized to -1, so if the parser doesn't set this flag,
3966 * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3972 * Time difference in stream time base units from the pts of this
3973 * packet to the point at which the output from the decoder has converged
3974 * independent from the availability of previous frames. That is, the
3975 * frames are virtually identical no matter if decoding started from
3976 * the very first frame or from this keyframe.
3977 * Is AV_NOPTS_VALUE if unknown.
3978 * This field is not the display duration of the current frame.
3979 * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3982 * The purpose of this field is to allow seeking in streams that have no
3983 * keyframes in the conventional sense. It corresponds to the
3984 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3985 * essential for some types of subtitle streams to ensure that all
3986 * subtitles are correctly displayed after seeking.
3988 int64_t convergence_duration;
3990 // Timestamp generation support:
3992 * Synchronization point for start of timestamp generation.
3994 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3997 * For example, this corresponds to presence of H.264 buffering period
4003 * Offset of the current timestamp against last timestamp sync point in
4004 * units of AVCodecContext.time_base.
4006 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4007 * contain a valid timestamp offset.
4009 * Note that the timestamp of sync point has usually a nonzero
4010 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4011 * the next frame after timestamp sync point will be usually 1.
4013 * For example, this corresponds to H.264 cpb_removal_delay.
4015 int dts_ref_dts_delta;
4018 * Presentation delay of current frame in units of AVCodecContext.time_base.
4020 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4021 * contain valid non-negative timestamp delta (presentation time of a frame
4022 * must not lie in the past).
4024 * This delay represents the difference between decoding and presentation
4025 * time of the frame.
4027 * For example, this corresponds to H.264 dpb_output_delay.
4032 * Position of the packet in file.
4034 * Analogous to cur_frame_pts/dts
4036 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4039 * Byte position of currently parsed frame in stream.
4044 * Previous frame byte position.
4047 } AVCodecParserContext;
4049 typedef struct AVCodecParser {
4050 int codec_ids[5]; /* several codec IDs are permitted */
4052 int (*parser_init)(AVCodecParserContext *s);
4053 int (*parser_parse)(AVCodecParserContext *s,
4054 AVCodecContext *avctx,
4055 const uint8_t **poutbuf, int *poutbuf_size,
4056 const uint8_t *buf, int buf_size);
4057 void (*parser_close)(AVCodecParserContext *s);
4058 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4059 struct AVCodecParser *next;
4062 AVCodecParser *av_parser_next(AVCodecParser *c);
4064 void av_register_codec_parser(AVCodecParser *parser);
4065 AVCodecParserContext *av_parser_init(int codec_id);
4070 * @param s parser context.
4071 * @param avctx codec context.
4072 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
4073 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
4074 * @param buf input buffer.
4075 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
4076 * @param pts input presentation timestamp.
4077 * @param dts input decoding timestamp.
4078 * @param pos input byte position in stream.
4079 * @return the number of bytes of the input bitstream used.
4084 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4091 * decode_frame(data, size);
4095 int av_parser_parse2(AVCodecParserContext *s,
4096 AVCodecContext *avctx,
4097 uint8_t **poutbuf, int *poutbuf_size,
4098 const uint8_t *buf, int buf_size,
4099 int64_t pts, int64_t dts,
4102 int av_parser_change(AVCodecParserContext *s,
4103 AVCodecContext *avctx,
4104 uint8_t **poutbuf, int *poutbuf_size,
4105 const uint8_t *buf, int buf_size, int keyframe);
4106 void av_parser_close(AVCodecParserContext *s);
4109 typedef struct AVBitStreamFilterContext {
4111 struct AVBitStreamFilter *filter;
4112 AVCodecParserContext *parser;
4113 struct AVBitStreamFilterContext *next;
4114 } AVBitStreamFilterContext;
4117 typedef struct AVBitStreamFilter {
4120 int (*filter)(AVBitStreamFilterContext *bsfc,
4121 AVCodecContext *avctx, const char *args,
4122 uint8_t **poutbuf, int *poutbuf_size,
4123 const uint8_t *buf, int buf_size, int keyframe);
4124 void (*close)(AVBitStreamFilterContext *bsfc);
4125 struct AVBitStreamFilter *next;
4126 } AVBitStreamFilter;
4128 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4129 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4130 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4131 AVCodecContext *avctx, const char *args,
4132 uint8_t **poutbuf, int *poutbuf_size,
4133 const uint8_t *buf, int buf_size, int keyframe);
4134 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4136 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4141 * Reallocate the given block if it is not large enough, otherwise do nothing.
4145 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4148 * Allocate a buffer, reusing the given one if large enough.
4150 * Contrary to av_fast_realloc the current buffer contents might not be
4151 * preserved and on error the old buffer is freed, thus no special
4152 * handling to avoid memleaks is necessary.
4154 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4155 * @param size size of the buffer *ptr points to
4156 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4157 * *size 0 if an error occurred.
4159 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4162 * Copy image src to dst. Wraps av_picture_data_copy() above.
4164 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4165 enum PixelFormat pix_fmt, int width, int height);
4168 * Crop image top and left side.
4170 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4171 enum PixelFormat pix_fmt, int top_band, int left_band);
4176 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4177 int padtop, int padbottom, int padleft, int padright, int *color);
4180 * Encode extradata length to a buffer. Used by xiph codecs.
4182 * @param s buffer to write to; must be at least (v/255+1) bytes long
4183 * @param v size of extradata in bytes
4184 * @return number of bytes written to the buffer.
4186 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4189 * Logs a generic warning message about a missing feature. This function is
4190 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4191 * only, and would normally not be used by applications.
4192 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4193 * a pointer to an AVClass struct
4194 * @param[in] feature string containing the name of the missing feature
4195 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4196 * If want_sample is non-zero, additional verbage will be added to the log
4197 * message which tells the user how to report samples to the development
4200 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4203 * Log a generic warning message asking for a sample. This function is
4204 * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4205 * only, and would normally not be used by applications.
4206 * @param[in] avc a pointer to an arbitrary struct of which the first field is
4207 * a pointer to an AVClass struct
4208 * @param[in] msg string containing an optional message, or NULL if no message
4210 void av_log_ask_for_sample(void *avc, const char *msg, ...);
4213 * Register the hardware accelerator hwaccel.
4215 void av_register_hwaccel(AVHWAccel *hwaccel);
4218 * If hwaccel is NULL, returns the first registered hardware accelerator,
4219 * if hwaccel is non-NULL, returns the next registered hardware accelerator
4220 * after hwaccel, or NULL if hwaccel is the last one.
4222 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4226 * Lock operation used by lockmgr
4229 AV_LOCK_CREATE, ///< Create a mutex
4230 AV_LOCK_OBTAIN, ///< Lock the mutex
4231 AV_LOCK_RELEASE, ///< Unlock the mutex
4232 AV_LOCK_DESTROY, ///< Free mutex resources
4236 * Register a user provided lock manager supporting the operations
4237 * specified by AVLockOp. mutex points to a (void *) where the
4238 * lockmgr should store/get a pointer to a user allocated mutex. It's
4239 * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4241 * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4242 * callback during the call to av_lockmgr_register().
4243 * Thus, the application must be prepared to handle that.
4244 * If cb is set to NULL the lockmgr will be unregistered.
4245 * Also note that during unregistration the previously registered
4246 * lockmgr callback may also be invoked.
4248 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4250 #endif /* AVCODEC_AVCODEC_H */