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
25 * @file libavcodec/avcodec.h
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 28
34 #define LIBAVCODEC_VERSION_MICRO 0
36 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
42 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
44 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
46 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
47 #define AV_TIME_BASE 1000000
48 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
51 * Identifies the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
68 CODEC_ID_MPEG2VIDEO_XVMC,
105 CODEC_ID_INTERPLAY_VIDEO,
117 CODEC_ID_TRUEMOTION1,
145 CODEC_ID_TRUEMOTION2,
162 CODEC_ID_DSICINVIDEO,
163 CODEC_ID_TIERTEXSEQVIDEO,
172 CODEC_ID_BETHSOFTVID,
190 CODEC_ID_MOTIONPIXELS,
198 /* various PCM "codecs" */
199 CODEC_ID_PCM_S16LE= 0x10000,
215 CODEC_ID_PCM_S24DAUD,
217 CODEC_ID_PCM_S16LE_PLANAR,
224 /* various ADPCM codecs */
225 CODEC_ID_ADPCM_IMA_QT= 0x11000,
226 CODEC_ID_ADPCM_IMA_WAV,
227 CODEC_ID_ADPCM_IMA_DK3,
228 CODEC_ID_ADPCM_IMA_DK4,
229 CODEC_ID_ADPCM_IMA_WS,
230 CODEC_ID_ADPCM_IMA_SMJPEG,
239 CODEC_ID_ADPCM_YAMAHA,
240 CODEC_ID_ADPCM_SBPRO_4,
241 CODEC_ID_ADPCM_SBPRO_3,
242 CODEC_ID_ADPCM_SBPRO_2,
244 CODEC_ID_ADPCM_IMA_AMV,
245 CODEC_ID_ADPCM_EA_R1,
246 CODEC_ID_ADPCM_EA_R3,
247 CODEC_ID_ADPCM_EA_R2,
248 CODEC_ID_ADPCM_IMA_EA_SEAD,
249 CODEC_ID_ADPCM_IMA_EA_EACS,
250 CODEC_ID_ADPCM_EA_XAS,
251 CODEC_ID_ADPCM_EA_MAXIS_XA,
252 CODEC_ID_ADPCM_IMA_ISS,
255 CODEC_ID_AMR_NB= 0x12000,
258 /* RealAudio codecs*/
259 CODEC_ID_RA_144= 0x13000,
262 /* various DPCM codecs */
263 CODEC_ID_ROQ_DPCM= 0x14000,
264 CODEC_ID_INTERPLAY_DPCM,
269 CODEC_ID_MP2= 0x15000,
270 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
288 CODEC_ID_WESTWOOD_SND1,
289 CODEC_ID_GSM, ///< as in Berlin toast format
297 CODEC_ID_DSICINAUDIO,
301 CODEC_ID_GSM_MS, /* as found in WAV */
310 CODEC_ID_WMALOSSLESS,
319 /* subtitle codecs */
320 CODEC_ID_DVD_SUBTITLE= 0x17000,
321 CODEC_ID_DVB_SUBTITLE,
322 CODEC_ID_TEXT, ///< raw UTF-8 text
327 /* other specific kind of codecs (generally used for attachments) */
328 CODEC_ID_TTF= 0x18000,
330 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
332 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
333 * stream (only used by libavformat) */
337 CODEC_TYPE_UNKNOWN = -1,
342 CODEC_TYPE_ATTACHMENT,
347 * all in native-endian format
350 SAMPLE_FMT_NONE = -1,
351 SAMPLE_FMT_U8, ///< unsigned 8 bits
352 SAMPLE_FMT_S16, ///< signed 16 bits
353 SAMPLE_FMT_S32, ///< signed 32 bits
354 SAMPLE_FMT_FLT, ///< float
355 SAMPLE_FMT_DBL, ///< double
356 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
359 /* Audio channel masks */
360 #define CH_FRONT_LEFT 0x00000001
361 #define CH_FRONT_RIGHT 0x00000002
362 #define CH_FRONT_CENTER 0x00000004
363 #define CH_LOW_FREQUENCY 0x00000008
364 #define CH_BACK_LEFT 0x00000010
365 #define CH_BACK_RIGHT 0x00000020
366 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
367 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
368 #define CH_BACK_CENTER 0x00000100
369 #define CH_SIDE_LEFT 0x00000200
370 #define CH_SIDE_RIGHT 0x00000400
371 #define CH_TOP_CENTER 0x00000800
372 #define CH_TOP_FRONT_LEFT 0x00001000
373 #define CH_TOP_FRONT_CENTER 0x00002000
374 #define CH_TOP_FRONT_RIGHT 0x00004000
375 #define CH_TOP_BACK_LEFT 0x00008000
376 #define CH_TOP_BACK_CENTER 0x00010000
377 #define CH_TOP_BACK_RIGHT 0x00020000
378 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
379 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
381 /* Audio channel convenience macros */
382 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
383 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
384 #define CH_LAYOUT_2_1 (CH_LAYOUT_STEREO|CH_BACK_CENTER)
385 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
386 #define CH_LAYOUT_4POINT0 (CH_LAYOUT_SURROUND|CH_BACK_CENTER)
387 #define CH_LAYOUT_2_2 (CH_LAYOUT_STEREO|CH_SIDE_LEFT|CH_SIDE_RIGHT)
388 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
389 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
390 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
391 #define CH_LAYOUT_5POINT0_BACK (CH_LAYOUT_SURROUND|CH_BACK_LEFT|CH_BACK_RIGHT)
392 #define CH_LAYOUT_5POINT1_BACK (CH_LAYOUT_5POINT0_BACK|CH_LOW_FREQUENCY)
393 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
394 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_5POINT1_BACK|\
395 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
396 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
399 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
402 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
403 * This is mainly needed because some optimized bitstream readers read
404 * 32 or 64 bit at once and could read over the end.<br>
405 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
406 * MPEG bitstreams could cause overread and segfault.
408 #define FF_INPUT_BUFFER_PADDING_SIZE 8
411 * minimum encoding buffer size
412 * Used to avoid some checks during header writing.
414 #define FF_MIN_BUFFER_SIZE 16384
418 * motion estimation type.
421 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
425 ME_EPZS, ///< enhanced predictive zonal search
426 ME_X1, ///< reserved for experiments
427 ME_HEX, ///< hexagon based search
428 ME_UMH, ///< uneven multi-hexagon search
429 ME_ITER, ///< iterative search
430 ME_TESA, ///< transformed exhaustive search algorithm
434 /* We leave some space between them for extensions (drop some
435 * keyframes for intra-only or drop just some bidir frames). */
436 AVDISCARD_NONE =-16, ///< discard nothing
437 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
438 AVDISCARD_NONREF = 8, ///< discard all non reference
439 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
440 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
441 AVDISCARD_ALL = 48, ///< discard all
444 enum AVColorPrimaries{
445 AVCOL_PRI_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
446 AVCOL_PRI_UNSPECIFIED=2,
448 AVCOL_PRI_BT470BG =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
449 AVCOL_PRI_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
450 AVCOL_PRI_SMPTE240M =7, ///< functionally identical to above
452 AVCOL_PRI_NB , ///< Not part of ABI
455 enum AVColorTransferCharacteristic{
456 AVCOL_TRC_BT709 =1, ///< also ITU-R BT1361
457 AVCOL_TRC_UNSPECIFIED=2,
458 AVCOL_TRC_GAMMA22 =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
459 AVCOL_TRC_GAMMA28 =5, ///< also ITU-R BT470BG
460 AVCOL_TRC_NB , ///< Not part of ABI
465 AVCOL_SPC_BT709 =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
466 AVCOL_SPC_UNSPECIFIED=2,
468 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
469 AVCOL_SPC_SMPTE170M =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
470 AVCOL_SPC_SMPTE240M =7,
471 AVCOL_SPC_NB , ///< Not part of ABI
475 AVCOL_RANGE_UNSPECIFIED=0,
476 AVCOL_RANGE_MPEG =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
477 AVCOL_RANGE_JPEG =2, ///< the normal 2^n-1 "JPEG" YUV ranges
478 AVCOL_RANGE_NB , ///< Not part of ABI
481 typedef struct RcOverride{
484 int qscale; // If this is 0 then quality_factor will be used instead.
485 float quality_factor;
488 #define FF_MAX_B_FRAMES 16
491 These flags can be passed in AVCodecContext.flags before initialization.
492 Note: Not everything is supported yet.
495 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
496 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
497 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
498 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
499 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
500 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
502 * The parent program guarantees that the input for B-frames containing
503 * streams is not written to for at least s->max_b_frames+1 frames, if
504 * this is not set the input will be copied.
506 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
507 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
508 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
509 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
510 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
511 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
512 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
513 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
514 location instead of only at frame boundaries. */
515 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
516 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
517 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
518 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
519 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
520 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
521 /* Fx : Flag for h263+ extra options */
522 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
523 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
524 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
525 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
526 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
527 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
528 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
529 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
530 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
531 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
532 #define CODEC_FLAG_CLOSED_GOP 0x80000000
533 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
534 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
535 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
536 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
537 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
538 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
539 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
540 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
541 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
542 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
543 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
544 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
545 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
546 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
547 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
548 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
549 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
550 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
552 /* Unsupported options :
553 * Syntax Arithmetic coding (SAC)
554 * Reference Picture Selection
555 * Independent Segment Decoding */
557 /* codec capabilities */
559 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
561 * Codec uses get_buffer() for allocating buffers.
562 * direct rendering method 1
564 #define CODEC_CAP_DR1 0x0002
565 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
566 #define CODEC_CAP_PARSE_ONLY 0x0004
567 #define CODEC_CAP_TRUNCATED 0x0008
568 /* Codec can export data for HW decoding (XvMC). */
569 #define CODEC_CAP_HWACCEL 0x0010
571 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
572 * If this is not set, the codec is guaranteed to never be fed with NULL data.
574 #define CODEC_CAP_DELAY 0x0020
576 * Codec can be fed a final frame with a smaller size.
577 * This can be used to prevent truncation of the last audio samples.
579 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
581 * Codec can export data for HW decoding (VDPAU).
583 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
585 //The following defines may change, don't expect compatibility if you use them.
586 #define MB_TYPE_INTRA4x4 0x0001
587 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
588 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
589 #define MB_TYPE_16x16 0x0008
590 #define MB_TYPE_16x8 0x0010
591 #define MB_TYPE_8x16 0x0020
592 #define MB_TYPE_8x8 0x0040
593 #define MB_TYPE_INTERLACED 0x0080
594 #define MB_TYPE_DIRECT2 0x0100 //FIXME
595 #define MB_TYPE_ACPRED 0x0200
596 #define MB_TYPE_GMC 0x0400
597 #define MB_TYPE_SKIP 0x0800
598 #define MB_TYPE_P0L0 0x1000
599 #define MB_TYPE_P1L0 0x2000
600 #define MB_TYPE_P0L1 0x4000
601 #define MB_TYPE_P1L1 0x8000
602 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
603 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
604 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
605 #define MB_TYPE_QUANT 0x00010000
606 #define MB_TYPE_CBP 0x00020000
607 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
611 * This specifies the area which should be displayed.
612 * Note there may be multiple such areas for one frame.
614 typedef struct AVPanScan{
617 * - encoding: Set by user.
618 * - decoding: Set by libavcodec.
623 * width and height in 1/16 pel
624 * - encoding: Set by user.
625 * - decoding: Set by libavcodec.
631 * position of the top left corner in 1/16 pel for up to 3 fields/frames
632 * - encoding: Set by user.
633 * - decoding: Set by libavcodec.
635 int16_t position[3][2];
638 #define FF_COMMON_FRAME \
640 * pointer to the picture planes.\
641 * This might be different from the first allocated byte\
648 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
649 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
655 * 1 -> keyframe, 0-> not\
656 * - encoding: Set by libavcodec.\
657 * - decoding: Set by libavcodec.\
662 * Picture type of the frame, see ?_TYPE below.\
663 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
664 * - decoding: Set by libavcodec.\
669 * presentation timestamp in time_base units (time when frame should be shown to user)\
670 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
671 * - encoding: MUST be set by user.\
672 * - decoding: Set by libavcodec.\
677 * picture number in bitstream order\
678 * - encoding: set by\
679 * - decoding: Set by libavcodec.\
681 int coded_picture_number;\
683 * picture number in display order\
684 * - encoding: set by\
685 * - decoding: Set by libavcodec.\
687 int display_picture_number;\
690 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
691 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
692 * - decoding: Set by libavcodec.\
697 * buffer age (1->was last buffer and dint change, 2->..., ...).\
698 * Set to INT_MAX if the buffer has not been used yet.\
699 * - encoding: unused\
700 * - decoding: MUST be set by get_buffer().\
705 * is this picture used as reference\
706 * The values for this are the same as the MpegEncContext.picture_structure\
707 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
708 * Set to 4 for delayed, non-reference frames.\
709 * - encoding: unused\
710 * - decoding: Set by libavcodec. (before get_buffer() call)).\
716 * - encoding: unused\
717 * - decoding: Set by libavcodec.\
719 int8_t *qscale_table;\
722 * - encoding: unused\
723 * - decoding: Set by libavcodec.\
728 * mbskip_table[mb]>=1 if MB didn't change\
729 * stride= mb_width = (width+15)>>4\
730 * - encoding: unused\
731 * - decoding: Set by libavcodec.\
733 uint8_t *mbskip_table;\
736 * motion vector table\
739 * int mv_sample_log2= 4 - motion_subsample_log2;\
740 * int mb_width= (width+15)>>4;\
741 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
742 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
744 * - encoding: Set by user.\
745 * - decoding: Set by libavcodec.\
747 int16_t (*motion_val[2])[2];\
750 * macroblock type table\
751 * mb_type_base + mb_width + 2\
752 * - encoding: Set by user.\
753 * - decoding: Set by libavcodec.\
758 * log2 of the size of the block which a single vector in motion_val represents: \
759 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
760 * - encoding: unused\
761 * - decoding: Set by libavcodec.\
763 uint8_t motion_subsample_log2;\
766 * for some private data of the user\
767 * - encoding: unused\
768 * - decoding: Set by user.\
774 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
775 * - decoding: unused\
780 * type of the buffer (to keep track of who has to deallocate data[*])\
781 * - encoding: Set by the one who allocates it.\
782 * - decoding: Set by the one who allocates it.\
783 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
788 * When decoding, this signals how much the picture must be delayed.\
789 * extra_delay = repeat_pict / (2*fps)\
790 * - encoding: unused\
791 * - decoding: Set by libavcodec.\
801 * The content of the picture is interlaced.\
802 * - encoding: Set by user.\
803 * - decoding: Set by libavcodec. (default 0)\
805 int interlaced_frame;\
808 * If the content is interlaced, is top field displayed first.\
809 * - encoding: Set by user.\
810 * - decoding: Set by libavcodec.\
812 int top_field_first;\
816 * - encoding: Set by user.\
817 * - decoding: Set by libavcodec.\
819 AVPanScan *pan_scan;\
822 * Tell user application that palette has changed from previous frame.\
823 * - encoding: ??? (no palette-enabled encoder yet)\
824 * - decoding: Set by libavcodec. (default 0).\
826 int palette_has_changed;\
829 * codec suggestion on buffer type if != 0\
830 * - encoding: unused\
831 * - decoding: Set by libavcodec. (before get_buffer() call)).\
837 * - encoding: unused\
838 * - decoding: Set by libavcodec.\
843 * motion referece frame index\
844 * - encoding: Set by user.\
845 * - decoding: Set by libavcodec.\
847 int8_t *ref_index[2];\
850 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
851 * output in AVFrame.reordered_opaque\
852 * - encoding: unused\
853 * - decoding: Read by user.\
855 int64_t reordered_opaque;\
858 * hardware accelerator private data (FFmpeg allocated)\
859 * - encoding: unused\
860 * - decoding: Set by libavcodec\
862 void *hwaccel_picture_private;\
865 #define FF_QSCALE_TYPE_MPEG1 0
866 #define FF_QSCALE_TYPE_MPEG2 1
867 #define FF_QSCALE_TYPE_H264 2
869 #define FF_BUFFER_TYPE_INTERNAL 1
870 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
871 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
872 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
875 #define FF_I_TYPE 1 ///< Intra
876 #define FF_P_TYPE 2 ///< Predicted
877 #define FF_B_TYPE 3 ///< Bi-dir predicted
878 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
879 #define FF_SI_TYPE 5 ///< Switching Intra
880 #define FF_SP_TYPE 6 ///< Switching Predicted
883 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
884 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
885 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
886 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
888 typedef struct AVPacket {
890 * Presentation timestamp in AVStream->time_base units; the time at which
891 * the decompressed packet will be presented to the user.
892 * Can be AV_NOPTS_VALUE if it is not stored in the file.
893 * pts MUST be larger or equal to dts as presentation cannot happen before
894 * decompression, unless one wants to view hex dumps. Some formats misuse
895 * the terms dts and pts/cts to mean something different. Such timestamps
896 * must be converted to true pts/dts before they are stored in AVPacket.
900 * Decompression timestamp in AVStream->time_base units; the time at which
901 * the packet is decompressed.
902 * Can be AV_NOPTS_VALUE if it is not stored in the file.
910 * Duration of this packet in AVStream->time_base units, 0 if unknown.
911 * Equals next_pts - this_pts in presentation order.
914 void (*destruct)(struct AVPacket *);
916 int64_t pos; ///< byte position in stream, -1 if unknown
919 * Time difference in AVStream->time_base units from the pts of this
920 * packet to the point at which the output from the decoder has converged
921 * independent from the availability of previous frames. That is, the
922 * frames are virtually identical no matter if decoding started from
923 * the very first frame or from this keyframe.
924 * Is AV_NOPTS_VALUE if unknown.
925 * This field is not the display duration of the current packet.
927 * The purpose of this field is to allow seeking in streams that have no
928 * keyframes in the conventional sense. It corresponds to the
929 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
930 * essential for some types of subtitle streams to ensure that all
931 * subtitles are correctly displayed after seeking.
933 int64_t convergence_duration;
935 #define PKT_FLAG_KEY 0x0001
939 * New fields can be added to the end of FF_COMMON_FRAME with minor version
941 * Removal, reordering and changes to existing fields require a major
942 * version bump. No fields should be added into AVFrame before or after
944 * sizeof(AVFrame) must not be used outside libav*.
946 typedef struct AVFrame {
951 * main external API structure.
952 * New fields can be added to the end with minor version bumps.
953 * Removal, reordering and changes to existing fields require a major
955 * sizeof(AVCodecContext) must not be used outside libav*.
957 typedef struct AVCodecContext {
959 * information on struct for av_log
960 * - set by avcodec_alloc_context
962 const AVClass *av_class;
964 * the average bitrate
965 * - encoding: Set by user; unused for constant quantizer encoding.
966 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
971 * number of bits the bitstream is allowed to diverge from the reference.
972 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
973 * - encoding: Set by user; unused for constant quantizer encoding.
976 int bit_rate_tolerance;
980 * - encoding: Set by user.
981 * - decoding: Set by user.
986 * Some codecs need additional format info. It is stored here.
987 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
988 * specific codec MUST set it correctly otherwise stream copy breaks.
989 * In general use of this field by muxers is not recommanded.
990 * - encoding: Set by libavcodec.
991 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
996 * Motion estimation algorithm used for video coding.
997 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
998 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
999 * - encoding: MUST be set by user.
1000 * - decoding: unused
1005 * some codecs need / can use extradata like Huffman tables.
1006 * mjpeg: Huffman tables
1007 * rv10: additional flags
1008 * mpeg4: global headers (they can be in the bitstream or here)
1009 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1010 * than extradata_size to avoid prolems if it is read with the bitstream reader.
1011 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1012 * - encoding: Set/allocated/freed by libavcodec.
1013 * - decoding: Set/allocated/freed by user.
1019 * This is the fundamental unit of time (in seconds) in terms
1020 * of which frame timestamps are represented. For fixed-fps content,
1021 * timebase should be 1/framerate and timestamp increments should be
1023 * - encoding: MUST be set by user.
1024 * - decoding: Set by libavcodec.
1026 AVRational time_base;
1030 * picture width / height.
1031 * - encoding: MUST be set by user.
1032 * - decoding: Set by libavcodec.
1033 * Note: For compatibility it is possible to set this instead of
1034 * coded_width/height before decoding.
1038 #define FF_ASPECT_EXTENDED 15
1041 * the number of pictures in a group of pictures, or 0 for intra_only
1042 * - encoding: Set by user.
1043 * - decoding: unused
1048 * Pixel format, see PIX_FMT_xxx.
1049 * - encoding: Set by user.
1050 * - decoding: Set by libavcodec.
1052 enum PixelFormat pix_fmt;
1055 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1056 * has to read frames at native frame rate.
1057 * - encoding: Set by user.
1058 * - decoding: unused
1063 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1064 * decoder to draw a horizontal band. It improves cache usage. Not
1065 * all codecs can do that. You must check the codec capabilities
1067 * The function is also used by hardware acceleration APIs.
1068 * It is called at least once during frame decoding to pass
1069 * the data needed for hardware render.
1070 * In that mode instead of pixel data, AVFrame points to
1071 * a structure specific to the acceleration API. The application
1072 * reads the structure and can change some fields to indicate progress
1074 * - encoding: unused
1075 * - decoding: Set by user.
1076 * @param height the height of the slice
1077 * @param y the y position of the slice
1078 * @param type 1->top field, 2->bottom field, 3->frame
1079 * @param offset offset into the AVFrame.data from which the slice should be read
1081 void (*draw_horiz_band)(struct AVCodecContext *s,
1082 const AVFrame *src, int offset[4],
1083 int y, int type, int height);
1086 int sample_rate; ///< samples per second
1087 int channels; ///< number of audio channels
1090 * audio sample format
1091 * - encoding: Set by user.
1092 * - decoding: Set by libavcodec.
1094 enum SampleFormat sample_fmt; ///< sample format, currently unused
1096 /* The following data should not be initialized. */
1098 * Samples per packet, initialized when calling 'init'.
1101 int frame_number; ///< audio or video frame number
1102 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1105 * Number of frames the decoded output will be delayed relative to
1106 * the encoded input.
1107 * - encoding: Set by libavcodec.
1108 * - decoding: unused
1112 /* - encoding parameters */
1113 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1114 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1118 * - encoding: Set by user.
1119 * - decoding: unused
1125 * - encoding: Set by user.
1126 * - decoding: unused
1131 * maximum quantizer difference between frames
1132 * - encoding: Set by user.
1133 * - decoding: unused
1138 * maximum number of B-frames between non-B-frames
1139 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1140 * - encoding: Set by user.
1141 * - decoding: unused
1146 * qscale factor between IP and B-frames
1147 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1148 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1149 * - encoding: Set by user.
1150 * - decoding: unused
1152 float b_quant_factor;
1154 /** obsolete FIXME remove */
1156 #define FF_RC_STRATEGY_XVID 1
1158 int b_frame_strategy;
1162 * - encoding: unused
1163 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1164 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1168 struct AVCodec *codec;
1172 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1173 /* do its best to deliver a chunk with size */
1174 /* below rtp_payload_size, the chunk will start */
1175 /* with a start code on some codecs like H.263. */
1176 /* This doesn't take account of any particular */
1177 /* headers inside the transmitted RTP payload. */
1180 /* The RTP callback: This function is called */
1181 /* every time the encoder has a packet to send. */
1182 /* It depends on the encoder if the data starts */
1183 /* with a Start Code (it should). H.263 does. */
1184 /* mb_nb contains the number of macroblocks */
1185 /* encoded in the RTP payload. */
1186 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1188 /* statistics, used for 2-pass encoding */
1199 * number of bits used for the previously encoded frame
1200 * - encoding: Set by libavcodec.
1201 * - decoding: unused
1206 * Private data of the user, can be used to carry app specific stuff.
1207 * - encoding: Set by user.
1208 * - decoding: Set by user.
1212 char codec_name[32];
1213 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1214 enum CodecID codec_id; /* see CODEC_ID_xxx */
1217 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1218 * This is used to work around some encoder bugs.
1219 * A demuxer should set this to what is stored in the field used to identify the codec.
1220 * If there are multiple such fields in a container then the demuxer should choose the one
1221 * which maximizes the information about the used codec.
1222 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1223 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1224 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1226 * - encoding: Set by user, if not then the default based on codec_id will be used.
1227 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1229 unsigned int codec_tag;
1232 * Work around bugs in encoders which sometimes cannot be detected automatically.
1233 * - encoding: Set by user
1234 * - decoding: Set by user
1236 int workaround_bugs;
1237 #define FF_BUG_AUTODETECT 1 ///< autodetection
1238 #define FF_BUG_OLD_MSMPEG4 2
1239 #define FF_BUG_XVID_ILACE 4
1240 #define FF_BUG_UMP4 8
1241 #define FF_BUG_NO_PADDING 16
1242 #define FF_BUG_AMV 32
1243 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1244 #define FF_BUG_QPEL_CHROMA 64
1245 #define FF_BUG_STD_QPEL 128
1246 #define FF_BUG_QPEL_CHROMA2 256
1247 #define FF_BUG_DIRECT_BLOCKSIZE 512
1248 #define FF_BUG_EDGE 1024
1249 #define FF_BUG_HPEL_CHROMA 2048
1250 #define FF_BUG_DC_CLIP 4096
1251 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1252 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1255 * luma single coefficient elimination threshold
1256 * - encoding: Set by user.
1257 * - decoding: unused
1259 int luma_elim_threshold;
1262 * chroma single coeff elimination threshold
1263 * - encoding: Set by user.
1264 * - decoding: unused
1266 int chroma_elim_threshold;
1269 * strictly follow the standard (MPEG4, ...).
1270 * - encoding: Set by user.
1271 * - decoding: Set by user.
1272 * Setting this to STRICT or higher means the encoder and decoder will
1273 * generally do stupid things. While setting it to inofficial or lower
1274 * will mean the encoder might use things that are not supported by all
1275 * spec compliant decoders. Decoders make no difference between normal,
1276 * inofficial and experimental, that is they always try to decode things
1277 * when they can unless they are explicitly asked to behave stupid
1278 * (=strictly conform to the specs)
1280 int strict_std_compliance;
1281 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1282 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1283 #define FF_COMPLIANCE_NORMAL 0
1284 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1285 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1288 * qscale offset between IP and B-frames
1289 * - encoding: Set by user.
1290 * - decoding: unused
1292 float b_quant_offset;
1295 * Error recognization; higher values will detect more errors but may
1296 * misdetect some more or less valid parts as errors.
1297 * - encoding: unused
1298 * - decoding: Set by user.
1300 int error_recognition;
1301 #define FF_ER_CAREFUL 1
1302 #define FF_ER_COMPLIANT 2
1303 #define FF_ER_AGGRESSIVE 3
1304 #define FF_ER_VERY_AGGRESSIVE 4
1307 * Called at the beginning of each frame to get a buffer for it.
1308 * If pic.reference is set then the frame will be read later by libavcodec.
1309 * avcodec_align_dimensions() should be used to find the required width and
1310 * height, as they normally need to be rounded up to the next multiple of 16.
1311 * - encoding: unused
1312 * - decoding: Set by libavcodec., user can override.
1314 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1317 * Called to release buffers which were allocated with get_buffer.
1318 * A released buffer can be reused in get_buffer().
1319 * pic.data[*] must be set to NULL.
1320 * - encoding: unused
1321 * - decoding: Set by libavcodec., user can override.
1323 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1326 * Size of the frame reordering buffer in the decoder.
1327 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1328 * - encoding: Set by libavcodec.
1329 * - decoding: Set by libavcodec.
1334 * number of bytes per packet if constant and known or 0
1335 * Used by some WAV based audio codecs.
1339 int parse_only; /* - decoding only: If true, only parsing is done
1340 (function avcodec_parse_frame()). The frame
1341 data is returned. Only MPEG codecs support this now. */
1344 * 0-> h263 quant 1-> mpeg quant
1345 * - encoding: Set by user.
1346 * - decoding: unused
1351 * pass1 encoding statistics output buffer
1352 * - encoding: Set by libavcodec.
1353 * - decoding: unused
1358 * pass2 encoding statistics input buffer
1359 * Concatenated stuff from stats_out of pass1 should be placed here.
1360 * - encoding: Allocated/set/freed by user.
1361 * - decoding: unused
1366 * ratecontrol qmin qmax limiting method
1367 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1368 * - encoding: Set by user.
1369 * - decoding: unused
1377 * ratecontrol override, see RcOverride
1378 * - encoding: Allocated/set/freed by user.
1379 * - decoding: unused
1381 RcOverride *rc_override;
1382 int rc_override_count;
1385 * rate control equation
1386 * - encoding: Set by user
1387 * - decoding: unused
1393 * - encoding: Set by user.
1394 * - decoding: unused
1400 * - encoding: Set by user.
1401 * - decoding: unused
1406 * decoder bitstream buffer size
1407 * - encoding: Set by user.
1408 * - decoding: unused
1411 float rc_buffer_aggressivity;
1414 * qscale factor between P and I-frames
1415 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1416 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1417 * - encoding: Set by user.
1418 * - decoding: unused
1420 float i_quant_factor;
1423 * qscale offset between P and I-frames
1424 * - encoding: Set by user.
1425 * - decoding: unused
1427 float i_quant_offset;
1430 * initial complexity for pass1 ratecontrol
1431 * - encoding: Set by user.
1432 * - decoding: unused
1434 float rc_initial_cplx;
1437 * DCT algorithm, see FF_DCT_* below
1438 * - encoding: Set by user.
1439 * - decoding: unused
1442 #define FF_DCT_AUTO 0
1443 #define FF_DCT_FASTINT 1
1444 #define FF_DCT_INT 2
1445 #define FF_DCT_MMX 3
1446 #define FF_DCT_MLIB 4
1447 #define FF_DCT_ALTIVEC 5
1448 #define FF_DCT_FAAN 6
1451 * luminance masking (0-> disabled)
1452 * - encoding: Set by user.
1453 * - decoding: unused
1458 * temporary complexity masking (0-> disabled)
1459 * - encoding: Set by user.
1460 * - decoding: unused
1462 float temporal_cplx_masking;
1465 * spatial complexity masking (0-> disabled)
1466 * - encoding: Set by user.
1467 * - decoding: unused
1469 float spatial_cplx_masking;
1472 * p block masking (0-> disabled)
1473 * - encoding: Set by user.
1474 * - decoding: unused
1479 * darkness masking (0-> disabled)
1480 * - encoding: Set by user.
1481 * - decoding: unused
1486 * IDCT algorithm, see FF_IDCT_* below.
1487 * - encoding: Set by user.
1488 * - decoding: Set by user.
1491 #define FF_IDCT_AUTO 0
1492 #define FF_IDCT_INT 1
1493 #define FF_IDCT_SIMPLE 2
1494 #define FF_IDCT_SIMPLEMMX 3
1495 #define FF_IDCT_LIBMPEG2MMX 4
1496 #define FF_IDCT_PS2 5
1497 #define FF_IDCT_MLIB 6
1498 #define FF_IDCT_ARM 7
1499 #define FF_IDCT_ALTIVEC 8
1500 #define FF_IDCT_SH4 9
1501 #define FF_IDCT_SIMPLEARM 10
1502 #define FF_IDCT_H264 11
1503 #define FF_IDCT_VP3 12
1504 #define FF_IDCT_IPP 13
1505 #define FF_IDCT_XVIDMMX 14
1506 #define FF_IDCT_CAVS 15
1507 #define FF_IDCT_SIMPLEARMV5TE 16
1508 #define FF_IDCT_SIMPLEARMV6 17
1509 #define FF_IDCT_SIMPLEVIS 18
1510 #define FF_IDCT_WMV2 19
1511 #define FF_IDCT_FAAN 20
1512 #define FF_IDCT_EA 21
1513 #define FF_IDCT_SIMPLENEON 22
1514 #define FF_IDCT_SIMPLEALPHA 23
1518 * - encoding: Set by libavcodec.
1519 * - decoding: Set by user (or 0).
1523 * slice offsets in the frame in bytes
1524 * - encoding: Set/allocated by libavcodec.
1525 * - decoding: Set/allocated by user (or NULL).
1530 * error concealment flags
1531 * - encoding: unused
1532 * - decoding: Set by user.
1534 int error_concealment;
1535 #define FF_EC_GUESS_MVS 1
1536 #define FF_EC_DEBLOCK 2
1539 * dsp_mask could be add used to disable unwanted CPU features
1540 * CPU features (i.e. MMX, SSE. ...)
1542 * With the FORCE flag you may instead enable given CPU features.
1543 * (Dangerous: Usable in case of misdetection, improper usage however will
1544 * result into program crash.)
1547 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1548 /* lower 16 bits - CPU features */
1549 #define FF_MM_MMX 0x0001 ///< standard MMX
1550 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1551 #if LIBAVCODEC_VERSION_MAJOR < 53
1552 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1554 #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
1555 #define FF_MM_SSE 0x0008 ///< SSE functions
1556 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1557 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1558 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1559 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1560 #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1561 #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
1562 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1563 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1566 * bits per sample/pixel from the demuxer (needed for huffyuv).
1567 * - encoding: Set by libavcodec.
1568 * - decoding: Set by user.
1570 int bits_per_coded_sample;
1573 * prediction method (needed for huffyuv)
1574 * - encoding: Set by user.
1575 * - decoding: unused
1577 int prediction_method;
1578 #define FF_PRED_LEFT 0
1579 #define FF_PRED_PLANE 1
1580 #define FF_PRED_MEDIAN 2
1583 * sample aspect ratio (0 if unknown)
1584 * That is the width of a pixel divided by the height of the pixel.
1585 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1586 * - encoding: Set by user.
1587 * - decoding: Set by libavcodec.
1589 AVRational sample_aspect_ratio;
1592 * the picture in the bitstream
1593 * - encoding: Set by libavcodec.
1594 * - decoding: Set by libavcodec.
1596 AVFrame *coded_frame;
1600 * - encoding: Set by user.
1601 * - decoding: Set by user.
1604 #define FF_DEBUG_PICT_INFO 1
1605 #define FF_DEBUG_RC 2
1606 #define FF_DEBUG_BITSTREAM 4
1607 #define FF_DEBUG_MB_TYPE 8
1608 #define FF_DEBUG_QP 16
1609 #define FF_DEBUG_MV 32
1610 #define FF_DEBUG_DCT_COEFF 0x00000040
1611 #define FF_DEBUG_SKIP 0x00000080
1612 #define FF_DEBUG_STARTCODE 0x00000100
1613 #define FF_DEBUG_PTS 0x00000200
1614 #define FF_DEBUG_ER 0x00000400
1615 #define FF_DEBUG_MMCO 0x00000800
1616 #define FF_DEBUG_BUGS 0x00001000
1617 #define FF_DEBUG_VIS_QP 0x00002000
1618 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1619 #define FF_DEBUG_BUFFERS 0x00008000
1623 * - encoding: Set by user.
1624 * - decoding: Set by user.
1627 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1628 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1629 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1633 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1634 * - decoding: unused
1639 * minimum MB quantizer
1640 * - encoding: unused
1641 * - decoding: unused
1646 * maximum MB quantizer
1647 * - encoding: unused
1648 * - decoding: unused
1653 * motion estimation comparison function
1654 * - encoding: Set by user.
1655 * - decoding: unused
1659 * subpixel motion estimation comparison function
1660 * - encoding: Set by user.
1661 * - decoding: unused
1665 * macroblock comparison function (not supported yet)
1666 * - encoding: Set by user.
1667 * - decoding: unused
1671 * interlaced DCT comparison function
1672 * - encoding: Set by user.
1673 * - decoding: unused
1676 #define FF_CMP_SAD 0
1677 #define FF_CMP_SSE 1
1678 #define FF_CMP_SATD 2
1679 #define FF_CMP_DCT 3
1680 #define FF_CMP_PSNR 4
1681 #define FF_CMP_BIT 5
1683 #define FF_CMP_ZERO 7
1684 #define FF_CMP_VSAD 8
1685 #define FF_CMP_VSSE 9
1686 #define FF_CMP_NSSE 10
1687 #define FF_CMP_W53 11
1688 #define FF_CMP_W97 12
1689 #define FF_CMP_DCTMAX 13
1690 #define FF_CMP_DCT264 14
1691 #define FF_CMP_CHROMA 256
1694 * ME diamond size & shape
1695 * - encoding: Set by user.
1696 * - decoding: unused
1701 * amount of previous MV predictors (2a+1 x 2a+1 square)
1702 * - encoding: Set by user.
1703 * - decoding: unused
1705 int last_predictor_count;
1708 * prepass for motion estimation
1709 * - encoding: Set by user.
1710 * - decoding: unused
1715 * motion estimation prepass comparison function
1716 * - encoding: Set by user.
1717 * - decoding: unused
1722 * ME prepass diamond size & shape
1723 * - encoding: Set by user.
1724 * - decoding: unused
1730 * - encoding: Set by user.
1731 * - decoding: unused
1733 int me_subpel_quality;
1736 * callback to negotiate the pixelFormat
1737 * @param fmt is the list of formats which are supported by the codec,
1738 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1739 * The first is always the native one.
1740 * @return the chosen format
1741 * - encoding: unused
1742 * - decoding: Set by user, if not set the native format will be chosen.
1744 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1747 * DTG active format information (additional aspect ratio
1748 * information only used in DVB MPEG-2 transport streams)
1751 * - encoding: unused
1752 * - decoding: Set by decoder.
1754 int dtg_active_format;
1755 #define FF_DTG_AFD_SAME 8
1756 #define FF_DTG_AFD_4_3 9
1757 #define FF_DTG_AFD_16_9 10
1758 #define FF_DTG_AFD_14_9 11
1759 #define FF_DTG_AFD_4_3_SP_14_9 13
1760 #define FF_DTG_AFD_16_9_SP_14_9 14
1761 #define FF_DTG_AFD_SP_4_3 15
1764 * maximum motion estimation search range in subpel units
1765 * If 0 then no limit.
1767 * - encoding: Set by user.
1768 * - decoding: unused
1773 * intra quantizer bias
1774 * - encoding: Set by user.
1775 * - decoding: unused
1777 int intra_quant_bias;
1778 #define FF_DEFAULT_QUANT_BIAS 999999
1781 * inter quantizer bias
1782 * - encoding: Set by user.
1783 * - decoding: unused
1785 int inter_quant_bias;
1789 * - encoding: unused
1790 * - decoding: Which clrtable should be used for 8bit RGB images.
1791 * Tables have to be stored somewhere. FIXME
1796 * internal_buffer count
1797 * Don't touch, used by libavcodec default_get_buffer().
1799 int internal_buffer_count;
1803 * Don't touch, used by libavcodec default_get_buffer().
1805 void *internal_buffer;
1807 #define FF_LAMBDA_SHIFT 7
1808 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1809 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1810 #define FF_LAMBDA_MAX (256*128-1)
1812 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1814 * Global quality for codecs which cannot change it per frame.
1815 * This should be proportional to MPEG-1/2/4 qscale.
1816 * - encoding: Set by user.
1817 * - decoding: unused
1821 #define FF_CODER_TYPE_VLC 0
1822 #define FF_CODER_TYPE_AC 1
1823 #define FF_CODER_TYPE_RAW 2
1824 #define FF_CODER_TYPE_RLE 3
1825 #define FF_CODER_TYPE_DEFLATE 4
1828 * - encoding: Set by user.
1829 * - decoding: unused
1835 * - encoding: Set by user.
1836 * - decoding: unused
1842 * - encoding: unused
1843 * - decoding: Set by user.
1845 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1850 * - encoding: unused
1851 * - decoding: Set by user.
1854 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1855 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1856 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1859 * XVideo Motion Acceleration
1860 * - encoding: forbidden
1861 * - decoding: set by decoder
1863 int xvmc_acceleration;
1866 * macroblock decision mode
1867 * - encoding: Set by user.
1868 * - decoding: unused
1871 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1872 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1873 #define FF_MB_DECISION_RD 2 ///< rate distortion
1876 * custom intra quantization matrix
1877 * - encoding: Set by user, can be NULL.
1878 * - decoding: Set by libavcodec.
1880 uint16_t *intra_matrix;
1883 * custom inter quantization matrix
1884 * - encoding: Set by user, can be NULL.
1885 * - decoding: Set by libavcodec.
1887 uint16_t *inter_matrix;
1890 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1891 * This is used to work around some encoder bugs.
1892 * - encoding: unused
1893 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1895 unsigned int stream_codec_tag;
1898 * scene change detection threshold
1899 * 0 is default, larger means fewer detected scene changes.
1900 * - encoding: Set by user.
1901 * - decoding: unused
1903 int scenechange_threshold;
1906 * minimum Lagrange multipler
1907 * - encoding: Set by user.
1908 * - decoding: unused
1913 * maximum Lagrange multipler
1914 * - encoding: Set by user.
1915 * - decoding: unused
1920 * palette control structure
1921 * - encoding: ??? (no palette-enabled encoder yet)
1922 * - decoding: Set by user.
1924 struct AVPaletteControl *palctrl;
1927 * noise reduction strength
1928 * - encoding: Set by user.
1929 * - decoding: unused
1931 int noise_reduction;
1934 * Called at the beginning of a frame to get cr buffer for it.
1935 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1936 * libavcodec will pass previous buffer in pic, function should return
1937 * same buffer or new buffer with old frame "painted" into it.
1938 * If pic.data[0] == NULL must behave like get_buffer().
1939 * - encoding: unused
1940 * - decoding: Set by libavcodec., user can override
1942 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1945 * Number of bits which should be loaded into the rc buffer before decoding starts.
1946 * - encoding: Set by user.
1947 * - decoding: unused
1949 int rc_initial_buffer_occupancy;
1953 * - encoding: Set by user.
1954 * - decoding: unused
1956 int inter_threshold;
1960 * - encoding: Set by user.
1961 * - decoding: Set by user.
1966 * Simulates errors in the bitstream to test error concealment.
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * MP3 antialias algorithm, see FF_AA_* below.
1974 * - encoding: unused
1975 * - decoding: Set by user.
1978 #define FF_AA_AUTO 0
1979 #define FF_AA_FASTINT 1 //not implemented yet
1981 #define FF_AA_FLOAT 3
1983 * quantizer noise shaping
1984 * - encoding: Set by user.
1985 * - decoding: unused
1987 int quantizer_noise_shaping;
1991 * is used to decide how many independent tasks should be passed to execute()
1992 * - encoding: Set by user.
1993 * - decoding: Set by user.
1998 * The codec may call this to execute several independent things.
1999 * It will return only after finishing all tasks.
2000 * The user may replace this with some multithreaded implementation,
2001 * the default implementation will execute the parts serially.
2002 * @param count the number of things to execute
2003 * - encoding: Set by libavcodec, user can override.
2004 * - decoding: Set by libavcodec, user can override.
2006 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2010 * Can be used by execute() to store some per AVCodecContext stuff.
2011 * - encoding: set by execute()
2012 * - decoding: set by execute()
2014 void *thread_opaque;
2017 * Motion estimation threshold below which no motion estimation is
2018 * performed, but instead the user specified motion vectors are used.
2020 * - encoding: Set by user.
2021 * - decoding: unused
2026 * Macroblock threshold below which the user specified macroblock types will be used.
2027 * - encoding: Set by user.
2028 * - decoding: unused
2033 * precision of the intra DC coefficient - 8
2034 * - encoding: Set by user.
2035 * - decoding: unused
2037 int intra_dc_precision;
2040 * noise vs. sse weight for the nsse comparsion function
2041 * - encoding: Set by user.
2042 * - decoding: unused
2047 * Number of macroblock rows at the top which are skipped.
2048 * - encoding: unused
2049 * - decoding: Set by user.
2054 * Number of macroblock rows at the bottom which are skipped.
2055 * - encoding: unused
2056 * - decoding: Set by user.
2062 * - encoding: Set by user.
2063 * - decoding: Set by libavcodec.
2066 #define FF_PROFILE_UNKNOWN -99
2067 #define FF_PROFILE_AAC_MAIN 0
2068 #define FF_PROFILE_AAC_LOW 1
2069 #define FF_PROFILE_AAC_SSR 2
2070 #define FF_PROFILE_AAC_LTP 3
2074 * - encoding: Set by user.
2075 * - decoding: Set by libavcodec.
2078 #define FF_LEVEL_UNKNOWN -99
2081 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2082 * - encoding: unused
2083 * - decoding: Set by user.
2088 * Bitstream width / height, may be different from width/height if lowres
2089 * or other things are used.
2090 * - encoding: unused
2091 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2093 int coded_width, coded_height;
2096 * frame skip threshold
2097 * - encoding: Set by user.
2098 * - decoding: unused
2100 int frame_skip_threshold;
2104 * - encoding: Set by user.
2105 * - decoding: unused
2107 int frame_skip_factor;
2110 * frame skip exponent
2111 * - encoding: Set by user.
2112 * - decoding: unused
2117 * frame skip comparison function
2118 * - encoding: Set by user.
2119 * - decoding: unused
2124 * Border processing masking, raises the quantizer for mbs on the borders
2126 * - encoding: Set by user.
2127 * - decoding: unused
2129 float border_masking;
2132 * minimum MB lagrange multipler
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * maximum MB lagrange multipler
2140 * - encoding: Set by user.
2141 * - decoding: unused
2147 * - encoding: Set by user.
2148 * - decoding: unused
2150 int me_penalty_compensation;
2154 * - encoding: unused
2155 * - decoding: Set by user.
2157 enum AVDiscard skip_loop_filter;
2161 * - encoding: unused
2162 * - decoding: Set by user.
2164 enum AVDiscard skip_idct;
2168 * - encoding: unused
2169 * - decoding: Set by user.
2171 enum AVDiscard skip_frame;
2175 * - encoding: Set by user.
2176 * - decoding: unused
2182 * - encoding: Set by user.
2183 * - decoding: unused
2188 * constant rate factor - quality-based VBR - values ~correspond to qps
2189 * - encoding: Set by user.
2190 * - decoding: unused
2195 * constant quantization parameter rate control method
2196 * - encoding: Set by user.
2197 * - decoding: unused
2203 * - encoding: Set by user.
2204 * - decoding: unused
2209 * number of reference frames
2210 * - encoding: Set by user.
2211 * - decoding: Set by lavc.
2216 * chroma qp offset from luma
2217 * - encoding: Set by user.
2218 * - decoding: unused
2223 * Influences how often B-frames are used.
2224 * - encoding: Set by user.
2225 * - decoding: unused
2230 * trellis RD quantization
2231 * - encoding: Set by user.
2232 * - decoding: unused
2237 * Reduce fluctuations in qp (before curve compression).
2238 * - encoding: Set by user.
2239 * - decoding: unused
2241 float complexityblur;
2244 * in-loop deblocking filter alphac0 parameter
2245 * alpha is in the range -6...6
2246 * - encoding: Set by user.
2247 * - decoding: unused
2252 * in-loop deblocking filter beta parameter
2253 * beta is in the range -6...6
2254 * - encoding: Set by user.
2255 * - decoding: unused
2260 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2261 * - encoding: Set by user.
2262 * - decoding: unused
2265 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2266 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2267 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2268 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2269 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2272 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2273 * - encoding: Set by user.
2274 * - decoding: unused
2279 * Audio cutoff bandwidth (0 means "automatic")
2280 * - encoding: Set by user.
2281 * - decoding: unused
2286 * Multiplied by qscale for each frame and added to scene_change_score.
2287 * - encoding: Set by user.
2288 * - decoding: unused
2290 int scenechange_factor;
2294 * Note: Value depends upon the compare function used for fullpel ME.
2295 * - encoding: Set by user.
2296 * - decoding: unused
2301 * Adjusts sensitivity of b_frame_strategy 1.
2302 * - encoding: Set by user.
2303 * - decoding: unused
2308 * - encoding: Set by user.
2309 * - decoding: unused
2311 int compression_level;
2312 #define FF_COMPRESSION_DEFAULT -1
2315 * Sets whether to use LPC mode - used by FLAC encoder.
2316 * - encoding: Set by user.
2317 * - decoding: unused
2322 * LPC coefficient precision - used by FLAC encoder
2323 * - encoding: Set by user.
2324 * - decoding: unused
2326 int lpc_coeff_precision;
2329 * - encoding: Set by user.
2330 * - decoding: unused
2332 int min_prediction_order;
2335 * - encoding: Set by user.
2336 * - decoding: unused
2338 int max_prediction_order;
2341 * search method for selecting prediction order
2342 * - encoding: Set by user.
2343 * - decoding: unused
2345 int prediction_order_method;
2348 * - encoding: Set by user.
2349 * - decoding: unused
2351 int min_partition_order;
2354 * - encoding: Set by user.
2355 * - decoding: unused
2357 int max_partition_order;
2360 * GOP timecode frame start number, in non drop frame format
2361 * - encoding: Set by user.
2362 * - decoding: unused
2364 int64_t timecode_frame_start;
2366 #if LIBAVCODEC_VERSION_MAJOR < 53
2368 * Decoder should decode to this many channels if it can (0 for default)
2369 * - encoding: unused
2370 * - decoding: Set by user.
2371 * @deprecated Deprecated in favor of request_channel_layout.
2373 int request_channels;
2377 * Percentage of dynamic range compression to be applied by the decoder.
2378 * The default value is 1.0, corresponding to full compression.
2379 * - encoding: unused
2380 * - decoding: Set by user.
2385 * opaque 64bit number (generally a PTS) that will be reordered and
2386 * output in AVFrame.reordered_opaque
2387 * - encoding: unused
2388 * - decoding: Set by user.
2390 int64_t reordered_opaque;
2393 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2394 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2395 * - encoding: set by user.
2396 * - decoding: set by libavcodec.
2398 int bits_per_raw_sample;
2401 * Audio channel layout.
2402 * - encoding: set by user.
2403 * - decoding: set by libavcodec.
2405 int64_t channel_layout;
2408 * Request decoder to use this channel layout if it can (0 for default)
2409 * - encoding: unused
2410 * - decoding: Set by user.
2412 int64_t request_channel_layout;
2415 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2416 * - encoding: Set by user.
2417 * - decoding: unused.
2419 float rc_max_available_vbv_use;
2422 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2423 * - encoding: Set by user.
2424 * - decoding: unused.
2426 float rc_min_vbv_overflow_use;
2429 * Hardware accelerator in use
2430 * - encoding: unused.
2431 * - decoding: Set by libavcodec
2433 struct AVHWAccel *hwaccel;
2436 * For some codecs, the time base is closer to the field rate than the frame rate.
2437 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2438 * if no telecine is used ...
2440 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2442 int ticks_per_frame;
2445 * Hardware accelerator context.
2446 * For some hardware accelerators, a global context needs to be
2447 * provided by the user. In that case, this holds display-dependent
2448 * data FFmpeg cannot instantiate itself. Please refer to the
2449 * FFmpeg HW accelerator documentation to know how to fill this
2450 * is. e.g. for VA API, this is a struct vaapi_context.
2451 * - encoding: unused
2452 * - decoding: Set by user
2454 void *hwaccel_context;
2457 * Chromaticity coordinates of the source primaries.
2458 * - encoding: Set by user
2459 * - decoding: Set by libavcodec
2461 enum AVColorPrimaries color_primaries;
2464 * Color Transfer Characteristic.
2465 * - encoding: Set by user
2466 * - decoding: Set by libavcodec
2468 enum AVColorTransferCharacteristic color_trc;
2471 * YUV colorspace type.
2472 * - encoding: Set by user
2473 * - decoding: Set by libavcodec
2475 enum AVColorSpace colorspace;
2478 * MPEG vs JPEG YUV range.
2479 * - encoding: Set by user
2480 * - decoding: Set by libavcodec
2482 enum AVColorRange color_range;
2488 typedef struct AVCodec {
2490 * Name of the codec implementation.
2491 * The name is globally unique among encoders and among decoders (but an
2492 * encoder and a decoder can share the same name).
2493 * This is the primary way to find a codec from the user perspective.
2496 enum CodecType type;
2499 int (*init)(AVCodecContext *);
2500 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2501 int (*close)(AVCodecContext *);
2502 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2504 * Codec capabilities.
2508 struct AVCodec *next;
2511 * Will be called when seeking
2513 void (*flush)(AVCodecContext *);
2514 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2515 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2517 * Descriptive name for the codec, meant to be more human readable than \p name.
2518 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2520 const char *long_name;
2521 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2522 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2523 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2529 typedef struct AVHWAccel {
2531 * Name of the hardware accelerated codec.
2532 * The name is globally unique among encoders and among decoders (but an
2533 * encoder and a decoder can share the same name).
2538 * Type of codec implemented by the hardware accelerator.
2540 * See CODEC_TYPE_xxx
2542 enum CodecType type;
2545 * Codec implemented by the hardware accelerator.
2552 * Supported pixel format.
2554 * Only hardware accelerated formats are supported here.
2556 enum PixelFormat pix_fmt;
2559 * Hardware accelerated codec capabilities.
2560 * see FF_HWACCEL_CODEC_CAP_*
2564 struct AVHWAccel *next;
2567 * Called at the beginning of each frame or field picture.
2569 * Meaningful frame information (codec specific) is guaranteed to
2570 * be parsed at this point. This function is mandatory.
2572 * Note that \p buf can be NULL along with \p buf_size set to 0.
2573 * Otherwise, this means the whole frame is available at this point.
2575 * @param avctx the codec context
2576 * @param buf the frame data buffer base
2577 * @param buf_size the size of the frame in bytes
2578 * @return zero if successful, a negative value otherwise
2580 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2583 * Callback for each slice.
2585 * Meaningful slice information (codec specific) is guaranteed to
2586 * be parsed at this point. This function is mandatory.
2588 * @param avctx the codec context
2589 * @param buf the slice data buffer base
2590 * @param buf_size the size of the slice in bytes
2591 * @return zero if successful, a negative value otherwise
2593 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2596 * Called at the end of each frame or field picture.
2598 * The whole picture is parsed at this point and can now be sent
2599 * to the hardware accelerator. This function is mandatory.
2601 * @param avctx the codec context
2602 * @return zero if successful, a negative value otherwise
2604 int (*end_frame)(AVCodecContext *avctx);
2607 * Size of HW accelerator private data.
2609 * Private data is allocated with av_mallocz() before
2610 * AVCodecContext.get_buffer() and deallocated after
2611 * AVCodecContext.release_buffer().
2617 * four components are given, that's all.
2618 * the last component is alpha
2620 typedef struct AVPicture {
2622 int linesize[4]; ///< number of bytes per line
2625 #if LIBAVCODEC_VERSION_MAJOR < 53
2628 * This structure defines a method for communicating palette changes
2629 * between and demuxer and a decoder.
2631 * @deprecated Use AVPacket to send palette changes instead.
2632 * This is totally broken.
2634 #define AVPALETTE_SIZE 1024
2635 #define AVPALETTE_COUNT 256
2636 typedef struct AVPaletteControl {
2638 /* Demuxer sets this to 1 to indicate the palette has changed;
2639 * decoder resets to 0. */
2640 int palette_changed;
2642 /* 4-byte ARGB palette entries, stored in native byte order; note that
2643 * the individual palette components should be on a 8-bit scale; if
2644 * the palette data comes from an IBM VGA native format, the component
2645 * data is probably 6 bits in size and needs to be scaled. */
2646 unsigned int palette[AVPALETTE_COUNT];
2648 } AVPaletteControl attribute_deprecated;
2651 enum AVSubtitleType {
2654 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2657 * Plain text, the text field must be set by the decoder and is
2658 * authoritative. ass and pict fields may contain approximations.
2663 * Formatted text, the ass field must be set by the decoder and is
2664 * authoritative. pict and text fields may contain approximations.
2669 typedef struct AVSubtitleRect {
2670 int x; ///< top left corner of pict, undefined when pict is not set
2671 int y; ///< top left corner of pict, undefined when pict is not set
2672 int w; ///< width of pict, undefined when pict is not set
2673 int h; ///< height of pict, undefined when pict is not set
2674 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2677 * data+linesize for the bitmap of this subtitle.
2678 * can be set for text/ass as well once they where rendered
2681 enum AVSubtitleType type;
2683 char *text; ///< 0 terminated plain UTF-8 text
2686 * 0 terminated ASS/SSA compatible event line.
2687 * The pressentation of this is unaffected by the other values in this
2693 typedef struct AVSubtitle {
2694 uint16_t format; /* 0 = graphics */
2695 uint32_t start_display_time; /* relative to packet pts, in ms */
2696 uint32_t end_display_time; /* relative to packet pts, in ms */
2698 AVSubtitleRect **rects;
2701 /* packet functions */
2704 * @deprecated use NULL instead
2706 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2709 * Default packet destructor.
2711 void av_destruct_packet(AVPacket *pkt);
2714 * Initialize optional fields of a packet with default values.
2718 void av_init_packet(AVPacket *pkt);
2721 * Allocate the payload of a packet and initialize its fields with
2725 * @param size wanted payload size
2726 * @return 0 if OK, AVERROR_xxx otherwise
2728 int av_new_packet(AVPacket *pkt, int size);
2731 * Reduce packet size, correctly zeroing padding
2734 * @param size new size
2736 void av_shrink_packet(AVPacket *pkt, int size);
2739 * @warning This is a hack - the packet memory allocation stuff is broken. The
2740 * packet is allocated if it was not really allocated.
2742 int av_dup_packet(AVPacket *pkt);
2747 * @param pkt packet to free
2749 void av_free_packet(AVPacket *pkt);
2753 struct ReSampleContext;
2754 struct AVResampleContext;
2756 typedef struct ReSampleContext ReSampleContext;
2758 #if LIBAVCODEC_VERSION_MAJOR < 53
2760 * @deprecated Use av_audio_resample_init() instead.
2762 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2763 int output_rate, int input_rate);
2766 * Initializes audio resampling context
2768 * @param output_channels number of output channels
2769 * @param input_channels number of input channels
2770 * @param output_rate output sample rate
2771 * @param input_rate input sample rate
2772 * @param sample_fmt_out requested output sample format
2773 * @param sample_fmt_in input sample format
2774 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2775 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2776 * @param linear If 1 then the used FIR filter will be linearly interpolated
2777 between the 2 closest, if 0 the closest will be used
2778 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2779 * @return allocated ReSampleContext, NULL if error occured
2781 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2782 int output_rate, int input_rate,
2783 enum SampleFormat sample_fmt_out,
2784 enum SampleFormat sample_fmt_in,
2785 int filter_length, int log2_phase_count,
2786 int linear, double cutoff);
2788 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2789 void audio_resample_close(ReSampleContext *s);
2793 * Initializes an audio resampler.
2794 * Note, if either rate is not an integer then simply scale both rates up so they are.
2795 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2796 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2797 * @param linear If 1 then the used FIR filter will be linearly interpolated
2798 between the 2 closest, if 0 the closest will be used
2799 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2801 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2805 * @param src an array of unconsumed samples
2806 * @param consumed the number of samples of src which have been consumed are returned here
2807 * @param src_size the number of unconsumed samples available
2808 * @param dst_size the amount of space in samples available in dst
2809 * @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.
2810 * @return the number of samples written in dst or -1 if an error occurred
2812 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2816 * Compensates samplerate/timestamp drift. The compensation is done by changing
2817 * the resampler parameters, so no audible clicks or similar distortions occur
2818 * @param compensation_distance distance in output samples over which the compensation should be performed
2819 * @param sample_delta number of output samples which should be output less
2821 * example: av_resample_compensate(c, 10, 500)
2822 * here instead of 510 samples only 500 samples would be output
2824 * note, due to rounding the actual compensation might be slightly different,
2825 * especially if the compensation_distance is large and the in_rate used during init is small
2827 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2828 void av_resample_close(struct AVResampleContext *c);
2831 * Allocate memory for a picture. Call avpicture_free to free it.
2833 * @param picture the picture to be filled in
2834 * @param pix_fmt the format of the picture
2835 * @param width the width of the picture
2836 * @param height the height of the picture
2837 * @return zero if successful, a negative value if not
2839 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2842 * Free a picture previously allocated by avpicture_alloc().
2844 * @param picture the AVPicture to be freed
2846 void avpicture_free(AVPicture *picture);
2849 * Fill in the AVPicture fields.
2850 * The fields of the given AVPicture are filled in by using the 'ptr' address
2851 * which points to the image data buffer. Depending on the specified picture
2852 * format, one or multiple image data pointers and line sizes will be set.
2853 * If a planar format is specified, several pointers will be set pointing to
2854 * the different picture planes and the line sizes of the different planes
2855 * will be stored in the lines_sizes array.
2856 * Call with ptr == NULL to get the required size for the ptr buffer.
2858 * @param picture AVPicture whose fields are to be filled in
2859 * @param ptr Buffer which will contain or contains the actual image data
2860 * @param pix_fmt The format in which the picture data is stored.
2861 * @param width the width of the image in pixels
2862 * @param height the height of the image in pixels
2863 * @return size of the image data in bytes
2865 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2866 int pix_fmt, int width, int height);
2867 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2868 unsigned char *dest, int dest_size);
2871 * Calculate the size in bytes that a picture of the given width and height
2872 * would occupy if stored in the given picture format.
2873 * Note that this returns the size of a compact representation as generated
2874 * by avpicture_layout, which can be smaller than the size required for e.g.
2877 * @param pix_fmt the given picture format
2878 * @param width the width of the image
2879 * @param height the height of the image
2880 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2882 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2883 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2884 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2885 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2888 * Returns the pixel format corresponding to the name \p name.
2890 * If there is no pixel format with name \p name, then looks for a
2891 * pixel format with the name corresponding to the native endian
2892 * format of \p name.
2893 * For example in a little-endian system, first looks for "gray16",
2894 * then for "gray16le".
2896 * Finally if no pixel format has been found, returns \c PIX_FMT_NONE.
2898 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2899 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2901 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2902 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2903 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2904 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2905 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2906 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2909 * Computes what kind of losses will occur when converting from one specific
2910 * pixel format to another.
2911 * When converting from one pixel format to another, information loss may occur.
2912 * For example, when converting from RGB24 to GRAY, the color information will
2913 * be lost. Similarly, other losses occur when converting from some formats to
2914 * other formats. These losses can involve loss of chroma, but also loss of
2915 * resolution, loss of color depth, loss due to the color space conversion, loss
2916 * of the alpha bits or loss due to color quantization.
2917 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2918 * which will occur when converting from one pixel format to another.
2920 * @param[in] dst_pix_fmt destination pixel format
2921 * @param[in] src_pix_fmt source pixel format
2922 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2923 * @return Combination of flags informing you what kind of losses will occur.
2925 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
2929 * Finds the best pixel format to convert to given a certain source pixel
2930 * format. When converting from one pixel format to another, information loss
2931 * may occur. For example, when converting from RGB24 to GRAY, the color
2932 * information will be lost. Similarly, other losses occur when converting from
2933 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2934 * the given pixel formats should be used to suffer the least amount of loss.
2935 * The pixel formats from which it chooses one, are determined by the
2936 * \p pix_fmt_mask parameter.
2939 * src_pix_fmt = PIX_FMT_YUV420P;
2940 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2941 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2944 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2945 * @param[in] src_pix_fmt source pixel format
2946 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2947 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2948 * @return The best pixel format to convert to or -1 if none was found.
2950 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
2951 int has_alpha, int *loss_ptr);
2955 * Print in buf the string corresponding to the pixel format with
2956 * number pix_fmt, or an header if pix_fmt is negative.
2958 * @param[in] buf the buffer where to write the string
2959 * @param[in] buf_size the size of buf
2960 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2961 * a negative value to print the corresponding header.
2962 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2964 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
2966 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2967 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2970 * Tell if an image really has transparent alpha values.
2971 * @return ored mask of FF_ALPHA_xxx constants
2973 int img_get_alpha_info(const AVPicture *src,
2974 enum PixelFormat pix_fmt, int width, int height);
2976 /* deinterlace a picture */
2977 /* deinterlace - if not supported return -1 */
2978 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2979 enum PixelFormat pix_fmt, int width, int height);
2981 /* external high level API */
2984 * If c is NULL, returns the first registered codec,
2985 * if c is non-NULL, returns the next registered codec after c,
2986 * or NULL if c is the last one.
2988 AVCodec *av_codec_next(AVCodec *c);
2991 * Returns the LIBAVCODEC_VERSION_INT constant.
2993 unsigned avcodec_version(void);
2996 * Initializes libavcodec.
2998 * @warning This function \e must be called before any other libavcodec
3001 void avcodec_init(void);
3003 #if LIBAVCODEC_VERSION_MAJOR < 53
3005 * @deprecated Deprecated in favor of avcodec_register().
3007 attribute_deprecated void register_avcodec(AVCodec *codec);
3011 * Register the codec \p codec and initialize libavcodec.
3013 * @see avcodec_init()
3015 void avcodec_register(AVCodec *codec);
3018 * Finds a registered encoder with a matching codec ID.
3020 * @param id CodecID of the requested encoder
3021 * @return An encoder if one was found, NULL otherwise.
3023 AVCodec *avcodec_find_encoder(enum CodecID id);
3026 * Finds a registered encoder with the specified name.
3028 * @param name name of the requested encoder
3029 * @return An encoder if one was found, NULL otherwise.
3031 AVCodec *avcodec_find_encoder_by_name(const char *name);
3034 * Finds a registered decoder with a matching codec ID.
3036 * @param id CodecID of the requested decoder
3037 * @return A decoder if one was found, NULL otherwise.
3039 AVCodec *avcodec_find_decoder(enum CodecID id);
3042 * Finds a registered decoder with the specified name.
3044 * @param name name of the requested decoder
3045 * @return A decoder if one was found, NULL otherwise.
3047 AVCodec *avcodec_find_decoder_by_name(const char *name);
3048 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3051 * Sets the fields of the given AVCodecContext to default values.
3053 * @param s The AVCodecContext of which the fields should be set to default values.
3055 void avcodec_get_context_defaults(AVCodecContext *s);
3057 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3058 * we WILL change its arguments and name a few times! */
3059 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
3062 * Allocates an AVCodecContext and sets its fields to default values. The
3063 * resulting struct can be deallocated by simply calling av_free().
3065 * @return An AVCodecContext filled with default values or NULL on failure.
3066 * @see avcodec_get_context_defaults
3068 AVCodecContext *avcodec_alloc_context(void);
3070 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3071 * we WILL change its arguments and name a few times! */
3072 AVCodecContext *avcodec_alloc_context2(enum CodecType);
3075 * Sets the fields of the given AVFrame to default values.
3077 * @param pic The AVFrame of which the fields should be set to default values.
3079 void avcodec_get_frame_defaults(AVFrame *pic);
3082 * Allocates an AVFrame and sets its fields to default values. The resulting
3083 * struct can be deallocated by simply calling av_free().
3085 * @return An AVFrame filled with default values or NULL on failure.
3086 * @see avcodec_get_frame_defaults
3088 AVFrame *avcodec_alloc_frame(void);
3090 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3091 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3092 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3093 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3096 * Checks if the given dimension of a picture is valid, meaning that all
3097 * bytes of the picture can be addressed with a signed int.
3099 * @param[in] w Width of the picture.
3100 * @param[in] h Height of the picture.
3101 * @return Zero if valid, a negative value if invalid.
3103 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3104 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3106 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3107 void avcodec_thread_free(AVCodecContext *s);
3108 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3109 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3110 //FIXME func typedef
3113 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3114 * function the context has to be allocated.
3116 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3117 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3118 * retrieving a codec.
3120 * @warning This function is not thread safe!
3123 * avcodec_register_all();
3124 * codec = avcodec_find_decoder(CODEC_ID_H264);
3128 * context = avcodec_alloc_context();
3130 * if (avcodec_open(context, codec) < 0)
3134 * @param avctx The context which will be set up to use the given codec.
3135 * @param codec The codec to use within the context.
3136 * @return zero on success, a negative value on error
3137 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3139 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3141 #if LIBAVCODEC_VERSION_MAJOR < 53
3143 * Decodes an audio frame from \p buf into \p samples.
3144 * Wrapper function which calls avcodec_decode_audio3.
3146 * @deprecated Use avcodec_decode_audio3 instead.
3147 * @param avctx the codec context
3148 * @param[out] samples the output buffer
3149 * @param[in,out] frame_size_ptr the output buffer size in bytes
3150 * @param[in] buf the input buffer
3151 * @param[in] buf_size the input buffer size in bytes
3152 * @return On error a negative value is returned, otherwise the number of bytes
3153 * used or zero if no frame could be decompressed.
3155 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3156 int *frame_size_ptr,
3157 const uint8_t *buf, int buf_size);
3161 * Decodes the audio frame of size avpkt->size from avpkt->data into samples.
3162 * Some decoders may support multiple frames in a single AVPacket, such
3163 * decoders would then just decode the first frame.
3165 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
3166 * decompressed frame size in \e bytes.
3168 * @warning You \e must set \p frame_size_ptr to the allocated size of the
3169 * output buffer before calling avcodec_decode_audio3().
3171 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3172 * the actual read bytes because some optimized bitstream readers read 32 or 64
3173 * bits at once and could read over the end.
3175 * @warning The end of the input buffer \p avpkt->data should be set to 0 to ensure that
3176 * no overreading happens for damaged MPEG streams.
3178 * @note You might have to align the input buffer \p avpkt->data and output buffer \p
3179 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3180 * necessary at all, on others it won't work at all if not aligned and on others
3181 * it will work but it will have an impact on performance. In practice, the
3182 * bitstream should have 4 byte alignment at minimum and all sample data should
3183 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3184 * the linesize is not a multiple of 16 then there's no sense in aligning the
3185 * start of the buffer to 16.
3187 * @param avctx the codec context
3188 * @param[out] samples the output buffer
3189 * @param[in,out] frame_size_ptr the output buffer size in bytes
3190 * @param[in] avpkt The input AVPacket containing the input buffer.
3191 * @return On error a negative value is returned, otherwise the number of bytes
3192 * used or zero if no frame could be decompressed.
3194 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3195 int *frame_size_ptr,
3198 #if LIBAVCODEC_VERSION_MAJOR < 53
3200 * Decodes a video frame from \p buf into \p picture.
3201 * Wrapper function which calls avcodec_decode_video2.
3203 * @deprecated Use avcodec_decode_video2 instead.
3204 * @param avctx the codec context
3205 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3206 * @param[in] buf the input buffer
3207 * @param[in] buf_size the size of the input buffer in bytes
3208 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3209 * @return On error a negative value is returned, otherwise the number of bytes
3210 * used or zero if no frame could be decompressed.
3212 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3213 int *got_picture_ptr,
3214 const uint8_t *buf, int buf_size);
3218 * Decodes the video frame of size avpkt->size from avpkt->data into picture.
3219 * Some decoders may support multiple frames in a single AVPacket, such
3220 * decoders would then just decode the first frame.
3222 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3223 * the actual read bytes because some optimized bitstream readers read 32 or 64
3224 * bits at once and could read over the end.
3226 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
3227 * no overreading happens for damaged MPEG streams.
3229 * @note You might have to align the input buffer \p avpkt->data and output buffer \p
3230 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
3231 * necessary at all, on others it won't work at all if not aligned and on others
3232 * it will work but it will have an impact on performance. In practice, the
3233 * bitstream should have 4 byte alignment at minimum and all sample data should
3234 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3235 * the linesize is not a multiple of 16 then there's no sense in aligning the
3236 * start of the buffer to 16.
3238 * @note Some codecs have a delay between input and output, these need to be
3239 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3241 * @param avctx the codec context
3242 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3243 * @param[in] avpkt The input AVpacket containing the input buffer.
3244 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3245 * @return On error a negative value is returned, otherwise the number of bytes
3246 * used or zero if no frame could be decompressed.
3248 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3249 int *got_picture_ptr,
3252 #if LIBAVCODEC_VERSION_MAJOR < 53
3253 /* Decode a subtitle message. Return -1 if error, otherwise return the
3254 * number of bytes used. If no subtitle could be decompressed,
3255 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3256 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3258 const uint8_t *buf, int buf_size);
3262 * Decodes a subtitle message.
3263 * Returns a negative value on error, otherwise returns the number of bytes used.
3264 * If no subtitle could be decompressed, \p got_sub_ptr is zero.
3265 * Otherwise, the subtitle is stored in \p *sub.
3267 * @param avctx the codec context
3268 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3269 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3270 * @param[in] avpkt The input AVPacket containing the input buffer.
3272 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3275 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3277 uint8_t *buf, int buf_size);
3280 * Encodes an audio frame from \p samples into \p buf.
3282 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3283 * However, for PCM audio the user will know how much space is needed
3284 * because it depends on the value passed in \p buf_size as described
3285 * below. In that case a lower value can be used.
3287 * @param avctx the codec context
3288 * @param[out] buf the output buffer
3289 * @param[in] buf_size the output buffer size
3290 * @param[in] samples the input buffer containing the samples
3291 * The number of samples read from this buffer is frame_size*channels,
3292 * both of which are defined in \p avctx.
3293 * For PCM audio the number of samples read from \p samples is equal to
3294 * \p buf_size * input_sample_size / output_sample_size.
3295 * @return On error a negative value is returned, on success zero or the number
3296 * of bytes used to encode the data read from the input buffer.
3298 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3299 const short *samples);
3302 * Encodes a video frame from \p pict into \p buf.
3303 * The input picture should be
3304 * stored using a specific format, namely \c avctx.pix_fmt.
3306 * @param avctx the codec context
3307 * @param[out] buf the output buffer for the bitstream of encoded frame
3308 * @param[in] buf_size the size of the output buffer in bytes
3309 * @param[in] pict the input picture to encode
3310 * @return On error a negative value is returned, on success zero or the number
3311 * of bytes used from the output buffer.
3313 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3314 const AVFrame *pict);
3315 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3316 const AVSubtitle *sub);
3318 int avcodec_close(AVCodecContext *avctx);
3321 * Register all the codecs, parsers and bitstream filters which were enabled at
3322 * configuration time. If you do not call this function you can select exactly
3323 * which formats you want to support, by using the individual registration
3326 * @see avcodec_register
3327 * @see av_register_codec_parser
3328 * @see av_register_bitstream_filter
3330 void avcodec_register_all(void);
3333 * Flush buffers, should be called when seeking or when switching to a different stream.
3335 void avcodec_flush_buffers(AVCodecContext *avctx);
3337 void avcodec_default_free_buffers(AVCodecContext *s);
3339 /* misc useful functions */
3342 * Returns a single letter to describe the given picture type \p pict_type.
3344 * @param[in] pict_type the picture type
3345 * @return A single character representing the picture type.
3347 char av_get_pict_type_char(int pict_type);
3350 * Returns codec bits per sample.
3352 * @param[in] codec_id the codec
3353 * @return Number of bits per sample or zero if unknown for the given codec.
3355 int av_get_bits_per_sample(enum CodecID codec_id);
3358 * Returns sample format bits per sample.
3360 * @param[in] sample_fmt the sample format
3361 * @return Number of bits per sample or zero if unknown for the given sample format.
3363 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3366 typedef struct AVCodecParserContext {
3368 struct AVCodecParser *parser;
3369 int64_t frame_offset; /* offset of the current frame */
3370 int64_t cur_offset; /* current offset
3371 (incremented by each av_parser_parse()) */
3372 int64_t next_frame_offset; /* offset of the next frame */
3374 int pict_type; /* XXX: Put it back in AVCodecContext. */
3376 * This field is used for proper frame duration computation in lavf.
3377 * It signals, how much longer the frame duration of the current frame
3378 * is compared to normal frame duration.
3380 * frame_duration = (1 + repeat_pict) * time_base
3382 * It is used by codecs like H.264 to display telecined material.
3384 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3385 int64_t pts; /* pts of the current frame */
3386 int64_t dts; /* dts of the current frame */
3391 int fetch_timestamp;
3393 #define AV_PARSER_PTS_NB 4
3394 int cur_frame_start_index;
3395 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3396 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3397 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3400 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3402 int64_t offset; ///< byte offset from starting packet start
3403 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3406 * Set by parser to 1 for key frames and 0 for non-key frames.
3407 * It is initialized to -1, so if the parser doesn't set this flag,
3408 * old-style fallback using FF_I_TYPE picture type as key frames
3414 * Time difference in stream time base units from the pts of this
3415 * packet to the point at which the output from the decoder has converged
3416 * independent from the availability of previous frames. That is, the
3417 * frames are virtually identical no matter if decoding started from
3418 * the very first frame or from this keyframe.
3419 * Is AV_NOPTS_VALUE if unknown.
3420 * This field is not the display duration of the current frame.
3422 * The purpose of this field is to allow seeking in streams that have no
3423 * keyframes in the conventional sense. It corresponds to the
3424 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3425 * essential for some types of subtitle streams to ensure that all
3426 * subtitles are correctly displayed after seeking.
3428 int64_t convergence_duration;
3430 // Timestamp generation support:
3432 * Synchronization point for start of timestamp generation.
3434 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3437 * For example, this corresponds to presence of H.264 buffering period
3443 * Offset of the current timestamp against last timestamp sync point in
3444 * units of AVCodecContext.time_base.
3446 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3447 * contain a valid timestamp offset.
3449 * Note that the timestamp of sync point has usually a nonzero
3450 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3451 * the next frame after timestamp sync point will be usually 1.
3453 * For example, this corresponds to H.264 cpb_removal_delay.
3455 int dts_ref_dts_delta;
3458 * Presentation delay of current frame in units of AVCodecContext.time_base.
3460 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3461 * contain valid non-negative timestamp delta (presentation time of a frame
3462 * must not lie in the past).
3464 * This delay represents the difference between decoding and presentation
3465 * time of the frame.
3467 * For example, this corresponds to H.264 dpb_output_delay.
3472 * Position of the packet in file.
3474 * Analogous to cur_frame_pts/dts
3476 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3479 * Byte position of currently parsed frame in stream.
3484 * Previous frame byte position.
3487 } AVCodecParserContext;
3489 typedef struct AVCodecParser {
3490 int codec_ids[5]; /* several codec IDs are permitted */
3492 int (*parser_init)(AVCodecParserContext *s);
3493 int (*parser_parse)(AVCodecParserContext *s,
3494 AVCodecContext *avctx,
3495 const uint8_t **poutbuf, int *poutbuf_size,
3496 const uint8_t *buf, int buf_size);
3497 void (*parser_close)(AVCodecParserContext *s);
3498 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3499 struct AVCodecParser *next;
3502 AVCodecParser *av_parser_next(AVCodecParser *c);
3504 void av_register_codec_parser(AVCodecParser *parser);
3505 AVCodecParserContext *av_parser_init(int codec_id);
3507 #if LIBAVCODEC_VERSION_MAJOR < 53
3508 attribute_deprecated
3509 int av_parser_parse(AVCodecParserContext *s,
3510 AVCodecContext *avctx,
3511 uint8_t **poutbuf, int *poutbuf_size,
3512 const uint8_t *buf, int buf_size,
3513 int64_t pts, int64_t dts);
3519 * @param s parser context.
3520 * @param avctx codec context.
3521 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3522 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3523 * @param buf input buffer.
3524 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3525 * @param pts input presentation timestamp.
3526 * @param dts input decoding timestamp.
3527 * @param pos input byte position in stream.
3528 * @return the number of bytes of the input bitstream used.
3533 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3540 * decode_frame(data, size);
3544 int av_parser_parse2(AVCodecParserContext *s,
3545 AVCodecContext *avctx,
3546 uint8_t **poutbuf, int *poutbuf_size,
3547 const uint8_t *buf, int buf_size,
3548 int64_t pts, int64_t dts,
3551 int av_parser_change(AVCodecParserContext *s,
3552 AVCodecContext *avctx,
3553 uint8_t **poutbuf, int *poutbuf_size,
3554 const uint8_t *buf, int buf_size, int keyframe);
3555 void av_parser_close(AVCodecParserContext *s);
3558 typedef struct AVBitStreamFilterContext {
3560 struct AVBitStreamFilter *filter;
3561 AVCodecParserContext *parser;
3562 struct AVBitStreamFilterContext *next;
3563 } AVBitStreamFilterContext;
3566 typedef struct AVBitStreamFilter {
3569 int (*filter)(AVBitStreamFilterContext *bsfc,
3570 AVCodecContext *avctx, const char *args,
3571 uint8_t **poutbuf, int *poutbuf_size,
3572 const uint8_t *buf, int buf_size, int keyframe);
3573 void (*close)(AVBitStreamFilterContext *bsfc);
3574 struct AVBitStreamFilter *next;
3575 } AVBitStreamFilter;
3577 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3578 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3579 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3580 AVCodecContext *avctx, const char *args,
3581 uint8_t **poutbuf, int *poutbuf_size,
3582 const uint8_t *buf, int buf_size, int keyframe);
3583 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3585 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3590 * Reallocates the given block if it is not large enough, otherwise it
3595 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3598 * Allocates a buffer, reusing the given one if large enough.
3600 * Contrary to av_fast_realloc the current buffer contents might not be
3601 * preserved and on error the old buffer is freed, thus no special
3602 * handling to avoid memleaks is necessary.
3604 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3605 * @param size size of the buffer *ptr points to
3606 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3607 * *size 0 if an error occurred.
3609 void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3612 * Copy image 'src' to 'dst'.
3614 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3615 enum PixelFormat pix_fmt, int width, int height);
3618 * Crop image top and left side.
3620 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3621 enum PixelFormat pix_fmt, int top_band, int left_band);
3626 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3627 int padtop, int padbottom, int padleft, int padright, int *color);
3629 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3632 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3634 * @return 0 in case of a successful parsing, a negative value otherwise
3635 * @param[in] str the string to parse: it has to be a string in the format
3636 * <width>x<height> or a valid video frame size abbreviation.
3637 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3639 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3640 * frame height value
3642 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3645 * Parses \p str and put in \p frame_rate the detected values.
3647 * @return 0 in case of a successful parsing, a negative value otherwise
3648 * @param[in] str the string to parse: it has to be a string in the format
3649 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3650 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3653 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3655 /* error handling */
3657 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3658 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3660 /* Some platforms have E* and errno already negated. */
3661 #define AVERROR(e) (e)
3662 #define AVUNERROR(e) (e)
3664 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3665 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3666 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3667 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3668 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3669 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3670 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3671 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3672 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3673 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3676 * Registers the hardware accelerator \p hwaccel.
3678 void av_register_hwaccel(AVHWAccel *hwaccel);
3681 * If hwaccel is NULL, returns the first registered hardware accelerator,
3682 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3683 * after hwaccel, or NULL if hwaccel is the last one.
3685 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3687 #endif /* AVCODEC_AVCODEC_H */