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 27
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 typedef struct RcOverride{
447 int qscale; // If this is 0 then quality_factor will be used instead.
448 float quality_factor;
451 #define FF_MAX_B_FRAMES 16
454 These flags can be passed in AVCodecContext.flags before initialization.
455 Note: Not everything is supported yet.
458 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
459 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
460 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
461 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
462 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
463 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
465 * The parent program guarantees that the input for B-frames containing
466 * streams is not written to for at least s->max_b_frames+1 frames, if
467 * this is not set the input will be copied.
469 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
470 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
471 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
472 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
473 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
474 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
475 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
476 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
477 location instead of only at frame boundaries. */
478 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
479 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
480 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
481 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
482 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
483 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
484 /* Fx : Flag for h263+ extra options */
485 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
486 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
487 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
488 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
489 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
490 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
491 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
492 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
493 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
494 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
495 #define CODEC_FLAG_CLOSED_GOP 0x80000000
496 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
497 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
498 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
499 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
500 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
501 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
502 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
503 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
504 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
505 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
506 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
507 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
508 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
509 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
510 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
511 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
512 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
513 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
515 /* Unsupported options :
516 * Syntax Arithmetic coding (SAC)
517 * Reference Picture Selection
518 * Independent Segment Decoding */
520 /* codec capabilities */
522 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
524 * Codec uses get_buffer() for allocating buffers.
525 * direct rendering method 1
527 #define CODEC_CAP_DR1 0x0002
528 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
529 #define CODEC_CAP_PARSE_ONLY 0x0004
530 #define CODEC_CAP_TRUNCATED 0x0008
531 /* Codec can export data for HW decoding (XvMC). */
532 #define CODEC_CAP_HWACCEL 0x0010
534 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
535 * If this is not set, the codec is guaranteed to never be fed with NULL data.
537 #define CODEC_CAP_DELAY 0x0020
539 * Codec can be fed a final frame with a smaller size.
540 * This can be used to prevent truncation of the last audio samples.
542 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
544 * Codec can export data for HW decoding (VDPAU).
546 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
548 //The following defines may change, don't expect compatibility if you use them.
549 #define MB_TYPE_INTRA4x4 0x0001
550 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
551 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
552 #define MB_TYPE_16x16 0x0008
553 #define MB_TYPE_16x8 0x0010
554 #define MB_TYPE_8x16 0x0020
555 #define MB_TYPE_8x8 0x0040
556 #define MB_TYPE_INTERLACED 0x0080
557 #define MB_TYPE_DIRECT2 0x0100 //FIXME
558 #define MB_TYPE_ACPRED 0x0200
559 #define MB_TYPE_GMC 0x0400
560 #define MB_TYPE_SKIP 0x0800
561 #define MB_TYPE_P0L0 0x1000
562 #define MB_TYPE_P1L0 0x2000
563 #define MB_TYPE_P0L1 0x4000
564 #define MB_TYPE_P1L1 0x8000
565 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
566 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
567 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
568 #define MB_TYPE_QUANT 0x00010000
569 #define MB_TYPE_CBP 0x00020000
570 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
574 * This specifies the area which should be displayed.
575 * Note there may be multiple such areas for one frame.
577 typedef struct AVPanScan{
580 * - encoding: Set by user.
581 * - decoding: Set by libavcodec.
586 * width and height in 1/16 pel
587 * - encoding: Set by user.
588 * - decoding: Set by libavcodec.
594 * position of the top left corner in 1/16 pel for up to 3 fields/frames
595 * - encoding: Set by user.
596 * - decoding: Set by libavcodec.
598 int16_t position[3][2];
601 #define FF_COMMON_FRAME \
603 * pointer to the picture planes.\
604 * This might be different from the first allocated byte\
611 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
612 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
618 * 1 -> keyframe, 0-> not\
619 * - encoding: Set by libavcodec.\
620 * - decoding: Set by libavcodec.\
625 * Picture type of the frame, see ?_TYPE below.\
626 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
627 * - decoding: Set by libavcodec.\
632 * presentation timestamp in time_base units (time when frame should be shown to user)\
633 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
634 * - encoding: MUST be set by user.\
635 * - decoding: Set by libavcodec.\
640 * picture number in bitstream order\
641 * - encoding: set by\
642 * - decoding: Set by libavcodec.\
644 int coded_picture_number;\
646 * picture number in display order\
647 * - encoding: set by\
648 * - decoding: Set by libavcodec.\
650 int display_picture_number;\
653 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
654 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
655 * - decoding: Set by libavcodec.\
660 * buffer age (1->was last buffer and dint change, 2->..., ...).\
661 * Set to INT_MAX if the buffer has not been used yet.\
662 * - encoding: unused\
663 * - decoding: MUST be set by get_buffer().\
668 * is this picture used as reference\
669 * The values for this are the same as the MpegEncContext.picture_structure\
670 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
671 * Set to 4 for delayed, non-reference frames.\
672 * - encoding: unused\
673 * - decoding: Set by libavcodec. (before get_buffer() call)).\
679 * - encoding: unused\
680 * - decoding: Set by libavcodec.\
682 int8_t *qscale_table;\
685 * - encoding: unused\
686 * - decoding: Set by libavcodec.\
691 * mbskip_table[mb]>=1 if MB didn't change\
692 * stride= mb_width = (width+15)>>4\
693 * - encoding: unused\
694 * - decoding: Set by libavcodec.\
696 uint8_t *mbskip_table;\
699 * motion vector table\
702 * int mv_sample_log2= 4 - motion_subsample_log2;\
703 * int mb_width= (width+15)>>4;\
704 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
705 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
707 * - encoding: Set by user.\
708 * - decoding: Set by libavcodec.\
710 int16_t (*motion_val[2])[2];\
713 * macroblock type table\
714 * mb_type_base + mb_width + 2\
715 * - encoding: Set by user.\
716 * - decoding: Set by libavcodec.\
721 * log2 of the size of the block which a single vector in motion_val represents: \
722 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
723 * - encoding: unused\
724 * - decoding: Set by libavcodec.\
726 uint8_t motion_subsample_log2;\
729 * for some private data of the user\
730 * - encoding: unused\
731 * - decoding: Set by user.\
737 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
738 * - decoding: unused\
743 * type of the buffer (to keep track of who has to deallocate data[*])\
744 * - encoding: Set by the one who allocates it.\
745 * - decoding: Set by the one who allocates it.\
746 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
751 * When decoding, this signals how much the picture must be delayed.\
752 * extra_delay = repeat_pict / (2*fps)\
753 * - encoding: unused\
754 * - decoding: Set by libavcodec.\
764 * The content of the picture is interlaced.\
765 * - encoding: Set by user.\
766 * - decoding: Set by libavcodec. (default 0)\
768 int interlaced_frame;\
771 * If the content is interlaced, is top field displayed first.\
772 * - encoding: Set by user.\
773 * - decoding: Set by libavcodec.\
775 int top_field_first;\
779 * - encoding: Set by user.\
780 * - decoding: Set by libavcodec.\
782 AVPanScan *pan_scan;\
785 * Tell user application that palette has changed from previous frame.\
786 * - encoding: ??? (no palette-enabled encoder yet)\
787 * - decoding: Set by libavcodec. (default 0).\
789 int palette_has_changed;\
792 * codec suggestion on buffer type if != 0\
793 * - encoding: unused\
794 * - decoding: Set by libavcodec. (before get_buffer() call)).\
800 * - encoding: unused\
801 * - decoding: Set by libavcodec.\
806 * motion referece frame index\
807 * - encoding: Set by user.\
808 * - decoding: Set by libavcodec.\
810 int8_t *ref_index[2];\
813 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
814 * output in AVFrame.reordered_opaque\
815 * - encoding: unused\
816 * - decoding: Read by user.\
818 int64_t reordered_opaque;\
821 * hardware accelerator private data (FFmpeg allocated)\
822 * - encoding: unused\
823 * - decoding: Set by libavcodec\
825 void *hwaccel_picture_private;\
828 #define FF_QSCALE_TYPE_MPEG1 0
829 #define FF_QSCALE_TYPE_MPEG2 1
830 #define FF_QSCALE_TYPE_H264 2
832 #define FF_BUFFER_TYPE_INTERNAL 1
833 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
834 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
835 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
838 #define FF_I_TYPE 1 ///< Intra
839 #define FF_P_TYPE 2 ///< Predicted
840 #define FF_B_TYPE 3 ///< Bi-dir predicted
841 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
842 #define FF_SI_TYPE 5 ///< Switching Intra
843 #define FF_SP_TYPE 6 ///< Switching Predicted
846 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
847 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
848 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
849 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
851 typedef struct AVPacket {
853 * Presentation timestamp in AVStream->time_base units; the time at which
854 * the decompressed packet will be presented to the user.
855 * Can be AV_NOPTS_VALUE if it is not stored in the file.
856 * pts MUST be larger or equal to dts as presentation cannot happen before
857 * decompression, unless one wants to view hex dumps. Some formats misuse
858 * the terms dts and pts/cts to mean something different. Such timestamps
859 * must be converted to true pts/dts before they are stored in AVPacket.
863 * Decompression timestamp in AVStream->time_base units; the time at which
864 * the packet is decompressed.
865 * Can be AV_NOPTS_VALUE if it is not stored in the file.
873 * Duration of this packet in AVStream->time_base units, 0 if unknown.
874 * Equals next_pts - this_pts in presentation order.
877 void (*destruct)(struct AVPacket *);
879 int64_t pos; ///< byte position in stream, -1 if unknown
882 * Time difference in AVStream->time_base units from the pts of this
883 * packet to the point at which the output from the decoder has converged
884 * independent from the availability of previous frames. That is, the
885 * frames are virtually identical no matter if decoding started from
886 * the very first frame or from this keyframe.
887 * Is AV_NOPTS_VALUE if unknown.
888 * This field is not the display duration of the current packet.
890 * The purpose of this field is to allow seeking in streams that have no
891 * keyframes in the conventional sense. It corresponds to the
892 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
893 * essential for some types of subtitle streams to ensure that all
894 * subtitles are correctly displayed after seeking.
896 int64_t convergence_duration;
898 #define PKT_FLAG_KEY 0x0001
902 * New fields can be added to the end of FF_COMMON_FRAME with minor version
904 * Removal, reordering and changes to existing fields require a major
905 * version bump. No fields should be added into AVFrame before or after
907 * sizeof(AVFrame) must not be used outside libav*.
909 typedef struct AVFrame {
914 * main external API structure.
915 * New fields can be added to the end with minor version bumps.
916 * Removal, reordering and changes to existing fields require a major
918 * sizeof(AVCodecContext) must not be used outside libav*.
920 typedef struct AVCodecContext {
922 * information on struct for av_log
923 * - set by avcodec_alloc_context
925 const AVClass *av_class;
927 * the average bitrate
928 * - encoding: Set by user; unused for constant quantizer encoding.
929 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
934 * number of bits the bitstream is allowed to diverge from the reference.
935 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
936 * - encoding: Set by user; unused for constant quantizer encoding.
939 int bit_rate_tolerance;
943 * - encoding: Set by user.
944 * - decoding: Set by user.
949 * Some codecs need additional format info. It is stored here.
950 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
951 * specific codec MUST set it correctly otherwise stream copy breaks.
952 * In general use of this field by muxers is not recommanded.
953 * - encoding: Set by libavcodec.
954 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
959 * Motion estimation algorithm used for video coding.
960 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
961 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
962 * - encoding: MUST be set by user.
968 * some codecs need / can use extradata like Huffman tables.
969 * mjpeg: Huffman tables
970 * rv10: additional flags
971 * mpeg4: global headers (they can be in the bitstream or here)
972 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
973 * than extradata_size to avoid prolems if it is read with the bitstream reader.
974 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
975 * - encoding: Set/allocated/freed by libavcodec.
976 * - decoding: Set/allocated/freed by user.
982 * This is the fundamental unit of time (in seconds) in terms
983 * of which frame timestamps are represented. For fixed-fps content,
984 * timebase should be 1/framerate and timestamp increments should be
986 * - encoding: MUST be set by user.
987 * - decoding: Set by libavcodec.
989 AVRational time_base;
993 * picture width / height.
994 * - encoding: MUST be set by user.
995 * - decoding: Set by libavcodec.
996 * Note: For compatibility it is possible to set this instead of
997 * coded_width/height before decoding.
1001 #define FF_ASPECT_EXTENDED 15
1004 * the number of pictures in a group of pictures, or 0 for intra_only
1005 * - encoding: Set by user.
1006 * - decoding: unused
1011 * Pixel format, see PIX_FMT_xxx.
1012 * - encoding: Set by user.
1013 * - decoding: Set by libavcodec.
1015 enum PixelFormat pix_fmt;
1018 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
1019 * has to read frames at native frame rate.
1020 * - encoding: Set by user.
1021 * - decoding: unused
1026 * If non NULL, 'draw_horiz_band' is called by the libavcodec
1027 * decoder to draw a horizontal band. It improves cache usage. Not
1028 * all codecs can do that. You must check the codec capabilities
1030 * The function is also used by hardware acceleration APIs.
1031 * It is called at least once during frame decoding to pass
1032 * the data needed for hardware render.
1033 * In that mode instead of pixel data, AVFrame points to
1034 * a structure specific to the acceleration API. The application
1035 * reads the structure and can change some fields to indicate progress
1037 * - encoding: unused
1038 * - decoding: Set by user.
1039 * @param height the height of the slice
1040 * @param y the y position of the slice
1041 * @param type 1->top field, 2->bottom field, 3->frame
1042 * @param offset offset into the AVFrame.data from which the slice should be read
1044 void (*draw_horiz_band)(struct AVCodecContext *s,
1045 const AVFrame *src, int offset[4],
1046 int y, int type, int height);
1049 int sample_rate; ///< samples per second
1050 int channels; ///< number of audio channels
1053 * audio sample format
1054 * - encoding: Set by user.
1055 * - decoding: Set by libavcodec.
1057 enum SampleFormat sample_fmt; ///< sample format, currently unused
1059 /* The following data should not be initialized. */
1061 * Samples per packet, initialized when calling 'init'.
1064 int frame_number; ///< audio or video frame number
1065 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1068 * Number of frames the decoded output will be delayed relative to
1069 * the encoded input.
1070 * - encoding: Set by libavcodec.
1071 * - decoding: unused
1075 /* - encoding parameters */
1076 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1077 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1081 * - encoding: Set by user.
1082 * - decoding: unused
1088 * - encoding: Set by user.
1089 * - decoding: unused
1094 * maximum quantizer difference between frames
1095 * - encoding: Set by user.
1096 * - decoding: unused
1101 * maximum number of B-frames between non-B-frames
1102 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1103 * - encoding: Set by user.
1104 * - decoding: unused
1109 * qscale factor between IP and B-frames
1110 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1111 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1112 * - encoding: Set by user.
1113 * - decoding: unused
1115 float b_quant_factor;
1117 /** obsolete FIXME remove */
1119 #define FF_RC_STRATEGY_XVID 1
1121 int b_frame_strategy;
1125 * - encoding: unused
1126 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1127 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1131 struct AVCodec *codec;
1135 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1136 /* do its best to deliver a chunk with size */
1137 /* below rtp_payload_size, the chunk will start */
1138 /* with a start code on some codecs like H.263. */
1139 /* This doesn't take account of any particular */
1140 /* headers inside the transmitted RTP payload. */
1143 /* The RTP callback: This function is called */
1144 /* every time the encoder has a packet to send. */
1145 /* It depends on the encoder if the data starts */
1146 /* with a Start Code (it should). H.263 does. */
1147 /* mb_nb contains the number of macroblocks */
1148 /* encoded in the RTP payload. */
1149 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1151 /* statistics, used for 2-pass encoding */
1162 * number of bits used for the previously encoded frame
1163 * - encoding: Set by libavcodec.
1164 * - decoding: unused
1169 * Private data of the user, can be used to carry app specific stuff.
1170 * - encoding: Set by user.
1171 * - decoding: Set by user.
1175 char codec_name[32];
1176 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1177 enum CodecID codec_id; /* see CODEC_ID_xxx */
1180 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1181 * This is used to work around some encoder bugs.
1182 * A demuxer should set this to what is stored in the field used to identify the codec.
1183 * If there are multiple such fields in a container then the demuxer should choose the one
1184 * which maximizes the information about the used codec.
1185 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1186 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1187 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1189 * - encoding: Set by user, if not then the default based on codec_id will be used.
1190 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1192 unsigned int codec_tag;
1195 * Work around bugs in encoders which sometimes cannot be detected automatically.
1196 * - encoding: Set by user
1197 * - decoding: Set by user
1199 int workaround_bugs;
1200 #define FF_BUG_AUTODETECT 1 ///< autodetection
1201 #define FF_BUG_OLD_MSMPEG4 2
1202 #define FF_BUG_XVID_ILACE 4
1203 #define FF_BUG_UMP4 8
1204 #define FF_BUG_NO_PADDING 16
1205 #define FF_BUG_AMV 32
1206 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1207 #define FF_BUG_QPEL_CHROMA 64
1208 #define FF_BUG_STD_QPEL 128
1209 #define FF_BUG_QPEL_CHROMA2 256
1210 #define FF_BUG_DIRECT_BLOCKSIZE 512
1211 #define FF_BUG_EDGE 1024
1212 #define FF_BUG_HPEL_CHROMA 2048
1213 #define FF_BUG_DC_CLIP 4096
1214 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1215 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1218 * luma single coefficient elimination threshold
1219 * - encoding: Set by user.
1220 * - decoding: unused
1222 int luma_elim_threshold;
1225 * chroma single coeff elimination threshold
1226 * - encoding: Set by user.
1227 * - decoding: unused
1229 int chroma_elim_threshold;
1232 * strictly follow the standard (MPEG4, ...).
1233 * - encoding: Set by user.
1234 * - decoding: Set by user.
1235 * Setting this to STRICT or higher means the encoder and decoder will
1236 * generally do stupid things. While setting it to inofficial or lower
1237 * will mean the encoder might use things that are not supported by all
1238 * spec compliant decoders. Decoders make no difference between normal,
1239 * inofficial and experimental, that is they always try to decode things
1240 * when they can unless they are explicitly asked to behave stupid
1241 * (=strictly conform to the specs)
1243 int strict_std_compliance;
1244 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1245 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1246 #define FF_COMPLIANCE_NORMAL 0
1247 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1248 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1251 * qscale offset between IP and B-frames
1252 * - encoding: Set by user.
1253 * - decoding: unused
1255 float b_quant_offset;
1258 * Error recognization; higher values will detect more errors but may
1259 * misdetect some more or less valid parts as errors.
1260 * - encoding: unused
1261 * - decoding: Set by user.
1263 int error_recognition;
1264 #define FF_ER_CAREFUL 1
1265 #define FF_ER_COMPLIANT 2
1266 #define FF_ER_AGGRESSIVE 3
1267 #define FF_ER_VERY_AGGRESSIVE 4
1270 * Called at the beginning of each frame to get a buffer for it.
1271 * If pic.reference is set then the frame will be read later by libavcodec.
1272 * avcodec_align_dimensions() should be used to find the required width and
1273 * height, as they normally need to be rounded up to the next multiple of 16.
1274 * - encoding: unused
1275 * - decoding: Set by libavcodec., user can override.
1277 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1280 * Called to release buffers which were allocated with get_buffer.
1281 * A released buffer can be reused in get_buffer().
1282 * pic.data[*] must be set to NULL.
1283 * - encoding: unused
1284 * - decoding: Set by libavcodec., user can override.
1286 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1289 * Size of the frame reordering buffer in the decoder.
1290 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1291 * - encoding: Set by libavcodec.
1292 * - decoding: Set by libavcodec.
1297 * number of bytes per packet if constant and known or 0
1298 * Used by some WAV based audio codecs.
1302 int parse_only; /* - decoding only: If true, only parsing is done
1303 (function avcodec_parse_frame()). The frame
1304 data is returned. Only MPEG codecs support this now. */
1307 * 0-> h263 quant 1-> mpeg quant
1308 * - encoding: Set by user.
1309 * - decoding: unused
1314 * pass1 encoding statistics output buffer
1315 * - encoding: Set by libavcodec.
1316 * - decoding: unused
1321 * pass2 encoding statistics input buffer
1322 * Concatenated stuff from stats_out of pass1 should be placed here.
1323 * - encoding: Allocated/set/freed by user.
1324 * - decoding: unused
1329 * ratecontrol qmin qmax limiting method
1330 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1331 * - encoding: Set by user.
1332 * - decoding: unused
1340 * ratecontrol override, see RcOverride
1341 * - encoding: Allocated/set/freed by user.
1342 * - decoding: unused
1344 RcOverride *rc_override;
1345 int rc_override_count;
1348 * rate control equation
1349 * - encoding: Set by user
1350 * - decoding: unused
1356 * - encoding: Set by user.
1357 * - decoding: unused
1363 * - encoding: Set by user.
1364 * - decoding: unused
1369 * decoder bitstream buffer size
1370 * - encoding: Set by user.
1371 * - decoding: unused
1374 float rc_buffer_aggressivity;
1377 * qscale factor between P and I-frames
1378 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1379 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1380 * - encoding: Set by user.
1381 * - decoding: unused
1383 float i_quant_factor;
1386 * qscale offset between P and I-frames
1387 * - encoding: Set by user.
1388 * - decoding: unused
1390 float i_quant_offset;
1393 * initial complexity for pass1 ratecontrol
1394 * - encoding: Set by user.
1395 * - decoding: unused
1397 float rc_initial_cplx;
1400 * DCT algorithm, see FF_DCT_* below
1401 * - encoding: Set by user.
1402 * - decoding: unused
1405 #define FF_DCT_AUTO 0
1406 #define FF_DCT_FASTINT 1
1407 #define FF_DCT_INT 2
1408 #define FF_DCT_MMX 3
1409 #define FF_DCT_MLIB 4
1410 #define FF_DCT_ALTIVEC 5
1411 #define FF_DCT_FAAN 6
1414 * luminance masking (0-> disabled)
1415 * - encoding: Set by user.
1416 * - decoding: unused
1421 * temporary complexity masking (0-> disabled)
1422 * - encoding: Set by user.
1423 * - decoding: unused
1425 float temporal_cplx_masking;
1428 * spatial complexity masking (0-> disabled)
1429 * - encoding: Set by user.
1430 * - decoding: unused
1432 float spatial_cplx_masking;
1435 * p block masking (0-> disabled)
1436 * - encoding: Set by user.
1437 * - decoding: unused
1442 * darkness masking (0-> disabled)
1443 * - encoding: Set by user.
1444 * - decoding: unused
1449 * IDCT algorithm, see FF_IDCT_* below.
1450 * - encoding: Set by user.
1451 * - decoding: Set by user.
1454 #define FF_IDCT_AUTO 0
1455 #define FF_IDCT_INT 1
1456 #define FF_IDCT_SIMPLE 2
1457 #define FF_IDCT_SIMPLEMMX 3
1458 #define FF_IDCT_LIBMPEG2MMX 4
1459 #define FF_IDCT_PS2 5
1460 #define FF_IDCT_MLIB 6
1461 #define FF_IDCT_ARM 7
1462 #define FF_IDCT_ALTIVEC 8
1463 #define FF_IDCT_SH4 9
1464 #define FF_IDCT_SIMPLEARM 10
1465 #define FF_IDCT_H264 11
1466 #define FF_IDCT_VP3 12
1467 #define FF_IDCT_IPP 13
1468 #define FF_IDCT_XVIDMMX 14
1469 #define FF_IDCT_CAVS 15
1470 #define FF_IDCT_SIMPLEARMV5TE 16
1471 #define FF_IDCT_SIMPLEARMV6 17
1472 #define FF_IDCT_SIMPLEVIS 18
1473 #define FF_IDCT_WMV2 19
1474 #define FF_IDCT_FAAN 20
1475 #define FF_IDCT_EA 21
1476 #define FF_IDCT_SIMPLENEON 22
1477 #define FF_IDCT_SIMPLEALPHA 23
1481 * - encoding: Set by libavcodec.
1482 * - decoding: Set by user (or 0).
1486 * slice offsets in the frame in bytes
1487 * - encoding: Set/allocated by libavcodec.
1488 * - decoding: Set/allocated by user (or NULL).
1493 * error concealment flags
1494 * - encoding: unused
1495 * - decoding: Set by user.
1497 int error_concealment;
1498 #define FF_EC_GUESS_MVS 1
1499 #define FF_EC_DEBLOCK 2
1502 * dsp_mask could be add used to disable unwanted CPU features
1503 * CPU features (i.e. MMX, SSE. ...)
1505 * With the FORCE flag you may instead enable given CPU features.
1506 * (Dangerous: Usable in case of misdetection, improper usage however will
1507 * result into program crash.)
1510 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1511 /* lower 16 bits - CPU features */
1512 #define FF_MM_MMX 0x0001 ///< standard MMX
1513 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1514 #if LIBAVCODEC_VERSION_MAJOR < 53
1515 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1517 #define FF_MM_MMX2 0x0002 ///< SSE integer functions or AMD MMX ext
1518 #define FF_MM_SSE 0x0008 ///< SSE functions
1519 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1520 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1521 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1522 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1523 #define FF_MM_SSE4 0x0100 ///< Penryn SSE4.1 functions
1524 #define FF_MM_SSE42 0x0200 ///< Nehalem SSE4.2 functions
1525 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1526 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1529 * bits per sample/pixel from the demuxer (needed for huffyuv).
1530 * - encoding: Set by libavcodec.
1531 * - decoding: Set by user.
1533 int bits_per_coded_sample;
1536 * prediction method (needed for huffyuv)
1537 * - encoding: Set by user.
1538 * - decoding: unused
1540 int prediction_method;
1541 #define FF_PRED_LEFT 0
1542 #define FF_PRED_PLANE 1
1543 #define FF_PRED_MEDIAN 2
1546 * sample aspect ratio (0 if unknown)
1547 * That is the width of a pixel divided by the height of the pixel.
1548 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1549 * - encoding: Set by user.
1550 * - decoding: Set by libavcodec.
1552 AVRational sample_aspect_ratio;
1555 * the picture in the bitstream
1556 * - encoding: Set by libavcodec.
1557 * - decoding: Set by libavcodec.
1559 AVFrame *coded_frame;
1563 * - encoding: Set by user.
1564 * - decoding: Set by user.
1567 #define FF_DEBUG_PICT_INFO 1
1568 #define FF_DEBUG_RC 2
1569 #define FF_DEBUG_BITSTREAM 4
1570 #define FF_DEBUG_MB_TYPE 8
1571 #define FF_DEBUG_QP 16
1572 #define FF_DEBUG_MV 32
1573 #define FF_DEBUG_DCT_COEFF 0x00000040
1574 #define FF_DEBUG_SKIP 0x00000080
1575 #define FF_DEBUG_STARTCODE 0x00000100
1576 #define FF_DEBUG_PTS 0x00000200
1577 #define FF_DEBUG_ER 0x00000400
1578 #define FF_DEBUG_MMCO 0x00000800
1579 #define FF_DEBUG_BUGS 0x00001000
1580 #define FF_DEBUG_VIS_QP 0x00002000
1581 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1582 #define FF_DEBUG_BUFFERS 0x00008000
1586 * - encoding: Set by user.
1587 * - decoding: Set by user.
1590 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1591 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1592 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1596 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1597 * - decoding: unused
1602 * minimum MB quantizer
1603 * - encoding: unused
1604 * - decoding: unused
1609 * maximum MB quantizer
1610 * - encoding: unused
1611 * - decoding: unused
1616 * motion estimation comparison function
1617 * - encoding: Set by user.
1618 * - decoding: unused
1622 * subpixel motion estimation comparison function
1623 * - encoding: Set by user.
1624 * - decoding: unused
1628 * macroblock comparison function (not supported yet)
1629 * - encoding: Set by user.
1630 * - decoding: unused
1634 * interlaced DCT comparison function
1635 * - encoding: Set by user.
1636 * - decoding: unused
1639 #define FF_CMP_SAD 0
1640 #define FF_CMP_SSE 1
1641 #define FF_CMP_SATD 2
1642 #define FF_CMP_DCT 3
1643 #define FF_CMP_PSNR 4
1644 #define FF_CMP_BIT 5
1646 #define FF_CMP_ZERO 7
1647 #define FF_CMP_VSAD 8
1648 #define FF_CMP_VSSE 9
1649 #define FF_CMP_NSSE 10
1650 #define FF_CMP_W53 11
1651 #define FF_CMP_W97 12
1652 #define FF_CMP_DCTMAX 13
1653 #define FF_CMP_DCT264 14
1654 #define FF_CMP_CHROMA 256
1657 * ME diamond size & shape
1658 * - encoding: Set by user.
1659 * - decoding: unused
1664 * amount of previous MV predictors (2a+1 x 2a+1 square)
1665 * - encoding: Set by user.
1666 * - decoding: unused
1668 int last_predictor_count;
1671 * prepass for motion estimation
1672 * - encoding: Set by user.
1673 * - decoding: unused
1678 * motion estimation prepass comparison function
1679 * - encoding: Set by user.
1680 * - decoding: unused
1685 * ME prepass diamond size & shape
1686 * - encoding: Set by user.
1687 * - decoding: unused
1693 * - encoding: Set by user.
1694 * - decoding: unused
1696 int me_subpel_quality;
1699 * callback to negotiate the pixelFormat
1700 * @param fmt is the list of formats which are supported by the codec,
1701 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1702 * The first is always the native one.
1703 * @return the chosen format
1704 * - encoding: unused
1705 * - decoding: Set by user, if not set the native format will be chosen.
1707 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1710 * DTG active format information (additional aspect ratio
1711 * information only used in DVB MPEG-2 transport streams)
1714 * - encoding: unused
1715 * - decoding: Set by decoder.
1717 int dtg_active_format;
1718 #define FF_DTG_AFD_SAME 8
1719 #define FF_DTG_AFD_4_3 9
1720 #define FF_DTG_AFD_16_9 10
1721 #define FF_DTG_AFD_14_9 11
1722 #define FF_DTG_AFD_4_3_SP_14_9 13
1723 #define FF_DTG_AFD_16_9_SP_14_9 14
1724 #define FF_DTG_AFD_SP_4_3 15
1727 * maximum motion estimation search range in subpel units
1728 * If 0 then no limit.
1730 * - encoding: Set by user.
1731 * - decoding: unused
1736 * intra quantizer bias
1737 * - encoding: Set by user.
1738 * - decoding: unused
1740 int intra_quant_bias;
1741 #define FF_DEFAULT_QUANT_BIAS 999999
1744 * inter quantizer bias
1745 * - encoding: Set by user.
1746 * - decoding: unused
1748 int inter_quant_bias;
1752 * - encoding: unused
1753 * - decoding: Which clrtable should be used for 8bit RGB images.
1754 * Tables have to be stored somewhere. FIXME
1759 * internal_buffer count
1760 * Don't touch, used by libavcodec default_get_buffer().
1762 int internal_buffer_count;
1766 * Don't touch, used by libavcodec default_get_buffer().
1768 void *internal_buffer;
1770 #define FF_LAMBDA_SHIFT 7
1771 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1772 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1773 #define FF_LAMBDA_MAX (256*128-1)
1775 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1777 * Global quality for codecs which cannot change it per frame.
1778 * This should be proportional to MPEG-1/2/4 qscale.
1779 * - encoding: Set by user.
1780 * - decoding: unused
1784 #define FF_CODER_TYPE_VLC 0
1785 #define FF_CODER_TYPE_AC 1
1786 #define FF_CODER_TYPE_RAW 2
1787 #define FF_CODER_TYPE_RLE 3
1788 #define FF_CODER_TYPE_DEFLATE 4
1791 * - encoding: Set by user.
1792 * - decoding: unused
1798 * - encoding: Set by user.
1799 * - decoding: unused
1805 * - encoding: unused
1806 * - decoding: Set by user.
1808 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1813 * - encoding: unused
1814 * - decoding: Set by user.
1817 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1818 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1819 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1822 * XVideo Motion Acceleration
1823 * - encoding: forbidden
1824 * - decoding: set by decoder
1826 int xvmc_acceleration;
1829 * macroblock decision mode
1830 * - encoding: Set by user.
1831 * - decoding: unused
1834 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1835 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1836 #define FF_MB_DECISION_RD 2 ///< rate distortion
1839 * custom intra quantization matrix
1840 * - encoding: Set by user, can be NULL.
1841 * - decoding: Set by libavcodec.
1843 uint16_t *intra_matrix;
1846 * custom inter quantization matrix
1847 * - encoding: Set by user, can be NULL.
1848 * - decoding: Set by libavcodec.
1850 uint16_t *inter_matrix;
1853 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1854 * This is used to work around some encoder bugs.
1855 * - encoding: unused
1856 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1858 unsigned int stream_codec_tag;
1861 * scene change detection threshold
1862 * 0 is default, larger means fewer detected scene changes.
1863 * - encoding: Set by user.
1864 * - decoding: unused
1866 int scenechange_threshold;
1869 * minimum Lagrange multipler
1870 * - encoding: Set by user.
1871 * - decoding: unused
1876 * maximum Lagrange multipler
1877 * - encoding: Set by user.
1878 * - decoding: unused
1883 * palette control structure
1884 * - encoding: ??? (no palette-enabled encoder yet)
1885 * - decoding: Set by user.
1887 struct AVPaletteControl *palctrl;
1890 * noise reduction strength
1891 * - encoding: Set by user.
1892 * - decoding: unused
1894 int noise_reduction;
1897 * Called at the beginning of a frame to get cr buffer for it.
1898 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1899 * libavcodec will pass previous buffer in pic, function should return
1900 * same buffer or new buffer with old frame "painted" into it.
1901 * If pic.data[0] == NULL must behave like get_buffer().
1902 * - encoding: unused
1903 * - decoding: Set by libavcodec., user can override
1905 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1908 * Number of bits which should be loaded into the rc buffer before decoding starts.
1909 * - encoding: Set by user.
1910 * - decoding: unused
1912 int rc_initial_buffer_occupancy;
1916 * - encoding: Set by user.
1917 * - decoding: unused
1919 int inter_threshold;
1923 * - encoding: Set by user.
1924 * - decoding: Set by user.
1929 * Simulates errors in the bitstream to test error concealment.
1930 * - encoding: Set by user.
1931 * - decoding: unused
1936 * MP3 antialias algorithm, see FF_AA_* below.
1937 * - encoding: unused
1938 * - decoding: Set by user.
1941 #define FF_AA_AUTO 0
1942 #define FF_AA_FASTINT 1 //not implemented yet
1944 #define FF_AA_FLOAT 3
1946 * quantizer noise shaping
1947 * - encoding: Set by user.
1948 * - decoding: unused
1950 int quantizer_noise_shaping;
1954 * is used to decide how many independent tasks should be passed to execute()
1955 * - encoding: Set by user.
1956 * - decoding: Set by user.
1961 * The codec may call this to execute several independent things.
1962 * It will return only after finishing all tasks.
1963 * The user may replace this with some multithreaded implementation,
1964 * the default implementation will execute the parts serially.
1965 * @param count the number of things to execute
1966 * - encoding: Set by libavcodec, user can override.
1967 * - decoding: Set by libavcodec, user can override.
1969 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1973 * Can be used by execute() to store some per AVCodecContext stuff.
1974 * - encoding: set by execute()
1975 * - decoding: set by execute()
1977 void *thread_opaque;
1980 * Motion estimation threshold below which no motion estimation is
1981 * performed, but instead the user specified motion vectors are used.
1983 * - encoding: Set by user.
1984 * - decoding: unused
1989 * Macroblock threshold below which the user specified macroblock types will be used.
1990 * - encoding: Set by user.
1991 * - decoding: unused
1996 * precision of the intra DC coefficient - 8
1997 * - encoding: Set by user.
1998 * - decoding: unused
2000 int intra_dc_precision;
2003 * noise vs. sse weight for the nsse comparsion function
2004 * - encoding: Set by user.
2005 * - decoding: unused
2010 * Number of macroblock rows at the top which are skipped.
2011 * - encoding: unused
2012 * - decoding: Set by user.
2017 * Number of macroblock rows at the bottom which are skipped.
2018 * - encoding: unused
2019 * - decoding: Set by user.
2025 * - encoding: Set by user.
2026 * - decoding: Set by libavcodec.
2029 #define FF_PROFILE_UNKNOWN -99
2030 #define FF_PROFILE_AAC_MAIN 0
2031 #define FF_PROFILE_AAC_LOW 1
2032 #define FF_PROFILE_AAC_SSR 2
2033 #define FF_PROFILE_AAC_LTP 3
2037 * - encoding: Set by user.
2038 * - decoding: Set by libavcodec.
2041 #define FF_LEVEL_UNKNOWN -99
2044 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2045 * - encoding: unused
2046 * - decoding: Set by user.
2051 * Bitstream width / height, may be different from width/height if lowres
2052 * or other things are used.
2053 * - encoding: unused
2054 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2056 int coded_width, coded_height;
2059 * frame skip threshold
2060 * - encoding: Set by user.
2061 * - decoding: unused
2063 int frame_skip_threshold;
2067 * - encoding: Set by user.
2068 * - decoding: unused
2070 int frame_skip_factor;
2073 * frame skip exponent
2074 * - encoding: Set by user.
2075 * - decoding: unused
2080 * frame skip comparison function
2081 * - encoding: Set by user.
2082 * - decoding: unused
2087 * Border processing masking, raises the quantizer for mbs on the borders
2089 * - encoding: Set by user.
2090 * - decoding: unused
2092 float border_masking;
2095 * minimum MB lagrange multipler
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * maximum MB lagrange multipler
2103 * - encoding: Set by user.
2104 * - decoding: unused
2110 * - encoding: Set by user.
2111 * - decoding: unused
2113 int me_penalty_compensation;
2117 * - encoding: unused
2118 * - decoding: Set by user.
2120 enum AVDiscard skip_loop_filter;
2124 * - encoding: unused
2125 * - decoding: Set by user.
2127 enum AVDiscard skip_idct;
2131 * - encoding: unused
2132 * - decoding: Set by user.
2134 enum AVDiscard skip_frame;
2138 * - encoding: Set by user.
2139 * - decoding: unused
2145 * - encoding: Set by user.
2146 * - decoding: unused
2151 * constant rate factor - quality-based VBR - values ~correspond to qps
2152 * - encoding: Set by user.
2153 * - decoding: unused
2158 * constant quantization parameter rate control method
2159 * - encoding: Set by user.
2160 * - decoding: unused
2166 * - encoding: Set by user.
2167 * - decoding: unused
2172 * number of reference frames
2173 * - encoding: Set by user.
2174 * - decoding: Set by lavc.
2179 * chroma qp offset from luma
2180 * - encoding: Set by user.
2181 * - decoding: unused
2186 * Influences how often B-frames are used.
2187 * - encoding: Set by user.
2188 * - decoding: unused
2193 * trellis RD quantization
2194 * - encoding: Set by user.
2195 * - decoding: unused
2200 * Reduce fluctuations in qp (before curve compression).
2201 * - encoding: Set by user.
2202 * - decoding: unused
2204 float complexityblur;
2207 * in-loop deblocking filter alphac0 parameter
2208 * alpha is in the range -6...6
2209 * - encoding: Set by user.
2210 * - decoding: unused
2215 * in-loop deblocking filter beta parameter
2216 * beta is in the range -6...6
2217 * - encoding: Set by user.
2218 * - decoding: unused
2223 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2224 * - encoding: Set by user.
2225 * - decoding: unused
2228 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2229 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2230 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2231 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2232 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2235 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2236 * - encoding: Set by user.
2237 * - decoding: unused
2242 * Audio cutoff bandwidth (0 means "automatic")
2243 * - encoding: Set by user.
2244 * - decoding: unused
2249 * Multiplied by qscale for each frame and added to scene_change_score.
2250 * - encoding: Set by user.
2251 * - decoding: unused
2253 int scenechange_factor;
2257 * Note: Value depends upon the compare function used for fullpel ME.
2258 * - encoding: Set by user.
2259 * - decoding: unused
2264 * Adjusts sensitivity of b_frame_strategy 1.
2265 * - encoding: Set by user.
2266 * - decoding: unused
2271 * - encoding: Set by user.
2272 * - decoding: unused
2274 int compression_level;
2275 #define FF_COMPRESSION_DEFAULT -1
2278 * Sets whether to use LPC mode - used by FLAC encoder.
2279 * - encoding: Set by user.
2280 * - decoding: unused
2285 * LPC coefficient precision - used by FLAC encoder
2286 * - encoding: Set by user.
2287 * - decoding: unused
2289 int lpc_coeff_precision;
2292 * - encoding: Set by user.
2293 * - decoding: unused
2295 int min_prediction_order;
2298 * - encoding: Set by user.
2299 * - decoding: unused
2301 int max_prediction_order;
2304 * search method for selecting prediction order
2305 * - encoding: Set by user.
2306 * - decoding: unused
2308 int prediction_order_method;
2311 * - encoding: Set by user.
2312 * - decoding: unused
2314 int min_partition_order;
2317 * - encoding: Set by user.
2318 * - decoding: unused
2320 int max_partition_order;
2323 * GOP timecode frame start number, in non drop frame format
2324 * - encoding: Set by user.
2325 * - decoding: unused
2327 int64_t timecode_frame_start;
2329 #if LIBAVCODEC_VERSION_MAJOR < 53
2331 * Decoder should decode to this many channels if it can (0 for default)
2332 * - encoding: unused
2333 * - decoding: Set by user.
2334 * @deprecated Deprecated in favor of request_channel_layout.
2336 int request_channels;
2340 * Percentage of dynamic range compression to be applied by the decoder.
2341 * The default value is 1.0, corresponding to full compression.
2342 * - encoding: unused
2343 * - decoding: Set by user.
2348 * opaque 64bit number (generally a PTS) that will be reordered and
2349 * output in AVFrame.reordered_opaque
2350 * - encoding: unused
2351 * - decoding: Set by user.
2353 int64_t reordered_opaque;
2356 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2357 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2358 * - encoding: set by user.
2359 * - decoding: set by libavcodec.
2361 int bits_per_raw_sample;
2364 * Audio channel layout.
2365 * - encoding: set by user.
2366 * - decoding: set by libavcodec.
2368 int64_t channel_layout;
2371 * Request decoder to use this channel layout if it can (0 for default)
2372 * - encoding: unused
2373 * - decoding: Set by user.
2375 int64_t request_channel_layout;
2378 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2379 * - encoding: Set by user.
2380 * - decoding: unused.
2382 float rc_max_available_vbv_use;
2385 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2386 * - encoding: Set by user.
2387 * - decoding: unused.
2389 float rc_min_vbv_overflow_use;
2392 * Hardware accelerator in use
2393 * - encoding: unused.
2394 * - decoding: Set by libavcodec
2396 struct AVHWAccel *hwaccel;
2399 * For some codecs, the time base is closer to the field rate than the frame rate.
2400 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2401 * if no telecine is used ...
2403 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2405 int ticks_per_frame;
2408 * Hardware accelerator context.
2409 * For some hardware accelerators, a global context needs to be
2410 * provided by the user. In that case, this holds display-dependent
2411 * data FFmpeg cannot instantiate itself. Please refer to the
2412 * FFmpeg HW accelerator documentation to know how to fill this
2413 * is. e.g. for VA API, this is a struct vaapi_context.
2414 * - encoding: unused
2415 * - decoding: Set by user
2417 void *hwaccel_context;
2423 typedef struct AVCodec {
2425 * Name of the codec implementation.
2426 * The name is globally unique among encoders and among decoders (but an
2427 * encoder and a decoder can share the same name).
2428 * This is the primary way to find a codec from the user perspective.
2431 enum CodecType type;
2434 int (*init)(AVCodecContext *);
2435 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2436 int (*close)(AVCodecContext *);
2437 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2439 * Codec capabilities.
2443 struct AVCodec *next;
2446 * Will be called when seeking
2448 void (*flush)(AVCodecContext *);
2449 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2450 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2452 * Descriptive name for the codec, meant to be more human readable than \p name.
2453 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2455 const char *long_name;
2456 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2457 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2458 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2464 typedef struct AVHWAccel {
2466 * Name of the hardware accelerated codec.
2467 * The name is globally unique among encoders and among decoders (but an
2468 * encoder and a decoder can share the same name).
2473 * Type of codec implemented by the hardware accelerator.
2475 * See CODEC_TYPE_xxx
2477 enum CodecType type;
2480 * Codec implemented by the hardware accelerator.
2487 * Supported pixel format.
2489 * Only hardware accelerated formats are supported here.
2491 enum PixelFormat pix_fmt;
2494 * Hardware accelerated codec capabilities.
2495 * see FF_HWACCEL_CODEC_CAP_*
2499 struct AVHWAccel *next;
2502 * Called at the beginning of each frame or field picture.
2504 * Meaningful frame information (codec specific) is guaranteed to
2505 * be parsed at this point. This function is mandatory.
2507 * Note that \p buf can be NULL along with \p buf_size set to 0.
2508 * Otherwise, this means the whole frame is available at this point.
2510 * @param avctx the codec context
2511 * @param buf the frame data buffer base
2512 * @param buf_size the size of the frame in bytes
2513 * @return zero if successful, a negative value otherwise
2515 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2518 * Callback for each slice.
2520 * Meaningful slice information (codec specific) is guaranteed to
2521 * be parsed at this point. This function is mandatory.
2523 * @param avctx the codec context
2524 * @param buf the slice data buffer base
2525 * @param buf_size the size of the slice in bytes
2526 * @return zero if successful, a negative value otherwise
2528 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2531 * Called at the end of each frame or field picture.
2533 * The whole picture is parsed at this point and can now be sent
2534 * to the hardware accelerator. This function is mandatory.
2536 * @param avctx the codec context
2537 * @return zero if successful, a negative value otherwise
2539 int (*end_frame)(AVCodecContext *avctx);
2542 * Size of HW accelerator private data.
2544 * Private data is allocated with av_mallocz() before
2545 * AVCodecContext.get_buffer() and deallocated after
2546 * AVCodecContext.release_buffer().
2552 * four components are given, that's all.
2553 * the last component is alpha
2555 typedef struct AVPicture {
2557 int linesize[4]; ///< number of bytes per line
2560 #if LIBAVCODEC_VERSION_MAJOR < 53
2563 * This structure defines a method for communicating palette changes
2564 * between and demuxer and a decoder.
2566 * @deprecated Use AVPacket to send palette changes instead.
2567 * This is totally broken.
2569 #define AVPALETTE_SIZE 1024
2570 #define AVPALETTE_COUNT 256
2571 typedef struct AVPaletteControl {
2573 /* Demuxer sets this to 1 to indicate the palette has changed;
2574 * decoder resets to 0. */
2575 int palette_changed;
2577 /* 4-byte ARGB palette entries, stored in native byte order; note that
2578 * the individual palette components should be on a 8-bit scale; if
2579 * the palette data comes from an IBM VGA native format, the component
2580 * data is probably 6 bits in size and needs to be scaled. */
2581 unsigned int palette[AVPALETTE_COUNT];
2583 } AVPaletteControl attribute_deprecated;
2586 enum AVSubtitleType {
2589 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2592 * Plain text, the text field must be set by the decoder and is
2593 * authoritative. ass and pict fields may contain approximations.
2598 * Formatted text, the ass field must be set by the decoder and is
2599 * authoritative. pict and text fields may contain approximations.
2604 typedef struct AVSubtitleRect {
2605 int x; ///< top left corner of pict, undefined when pict is not set
2606 int y; ///< top left corner of pict, undefined when pict is not set
2607 int w; ///< width of pict, undefined when pict is not set
2608 int h; ///< height of pict, undefined when pict is not set
2609 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2612 * data+linesize for the bitmap of this subtitle.
2613 * can be set for text/ass as well once they where rendered
2616 enum AVSubtitleType type;
2618 char *text; ///< 0 terminated plain UTF-8 text
2621 * 0 terminated ASS/SSA compatible event line.
2622 * The pressentation of this is unaffected by the other values in this
2628 typedef struct AVSubtitle {
2629 uint16_t format; /* 0 = graphics */
2630 uint32_t start_display_time; /* relative to packet pts, in ms */
2631 uint32_t end_display_time; /* relative to packet pts, in ms */
2633 AVSubtitleRect **rects;
2636 /* packet functions */
2639 * @deprecated use NULL instead
2641 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
2644 * Default packet destructor.
2646 void av_destruct_packet(AVPacket *pkt);
2649 * Initialize optional fields of a packet with default values.
2653 void av_init_packet(AVPacket *pkt);
2656 * Allocate the payload of a packet and initialize its fields with
2660 * @param size wanted payload size
2661 * @return 0 if OK, AVERROR_xxx otherwise
2663 int av_new_packet(AVPacket *pkt, int size);
2666 * Reduce packet size, correctly zeroing padding
2669 * @param size new size
2671 void av_shrink_packet(AVPacket *pkt, int size);
2674 * @warning This is a hack - the packet memory allocation stuff is broken. The
2675 * packet is allocated if it was not really allocated.
2677 int av_dup_packet(AVPacket *pkt);
2682 * @param pkt packet to free
2684 static inline void av_free_packet(AVPacket *pkt)
2687 if (pkt->destruct) pkt->destruct(pkt);
2688 pkt->data = NULL; pkt->size = 0;
2694 struct ReSampleContext;
2695 struct AVResampleContext;
2697 typedef struct ReSampleContext ReSampleContext;
2699 #if LIBAVCODEC_VERSION_MAJOR < 53
2701 * @deprecated Use av_audio_resample_init() instead.
2703 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2704 int output_rate, int input_rate);
2707 * Initializes audio resampling context
2709 * @param output_channels number of output channels
2710 * @param input_channels number of input channels
2711 * @param output_rate output sample rate
2712 * @param input_rate input sample rate
2713 * @param sample_fmt_out requested output sample format
2714 * @param sample_fmt_in input sample format
2715 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2716 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2717 * @param linear If 1 then the used FIR filter will be linearly interpolated
2718 between the 2 closest, if 0 the closest will be used
2719 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2720 * @return allocated ReSampleContext, NULL if error occured
2722 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2723 int output_rate, int input_rate,
2724 enum SampleFormat sample_fmt_out,
2725 enum SampleFormat sample_fmt_in,
2726 int filter_length, int log2_phase_count,
2727 int linear, double cutoff);
2729 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2730 void audio_resample_close(ReSampleContext *s);
2734 * Initializes an audio resampler.
2735 * Note, if either rate is not an integer then simply scale both rates up so they are.
2736 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2737 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2738 * @param linear If 1 then the used FIR filter will be linearly interpolated
2739 between the 2 closest, if 0 the closest will be used
2740 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2742 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2746 * @param src an array of unconsumed samples
2747 * @param consumed the number of samples of src which have been consumed are returned here
2748 * @param src_size the number of unconsumed samples available
2749 * @param dst_size the amount of space in samples available in dst
2750 * @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.
2751 * @return the number of samples written in dst or -1 if an error occurred
2753 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2757 * Compensates samplerate/timestamp drift. The compensation is done by changing
2758 * the resampler parameters, so no audible clicks or similar distortions occur
2759 * @param compensation_distance distance in output samples over which the compensation should be performed
2760 * @param sample_delta number of output samples which should be output less
2762 * example: av_resample_compensate(c, 10, 500)
2763 * here instead of 510 samples only 500 samples would be output
2765 * note, due to rounding the actual compensation might be slightly different,
2766 * especially if the compensation_distance is large and the in_rate used during init is small
2768 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2769 void av_resample_close(struct AVResampleContext *c);
2772 * Allocate memory for a picture. Call avpicture_free to free it.
2774 * @param picture the picture to be filled in
2775 * @param pix_fmt the format of the picture
2776 * @param width the width of the picture
2777 * @param height the height of the picture
2778 * @return zero if successful, a negative value if not
2780 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2783 * Free a picture previously allocated by avpicture_alloc().
2785 * @param picture the AVPicture to be freed
2787 void avpicture_free(AVPicture *picture);
2790 * Fill in the AVPicture fields.
2791 * The fields of the given AVPicture are filled in by using the 'ptr' address
2792 * which points to the image data buffer. Depending on the specified picture
2793 * format, one or multiple image data pointers and line sizes will be set.
2794 * If a planar format is specified, several pointers will be set pointing to
2795 * the different picture planes and the line sizes of the different planes
2796 * will be stored in the lines_sizes array.
2797 * Call with ptr == NULL to get the required size for the ptr buffer.
2799 * @param picture AVPicture whose fields are to be filled in
2800 * @param ptr Buffer which will contain or contains the actual image data
2801 * @param pix_fmt The format in which the picture data is stored.
2802 * @param width the width of the image in pixels
2803 * @param height the height of the image in pixels
2804 * @return size of the image data in bytes
2806 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2807 int pix_fmt, int width, int height);
2808 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2809 unsigned char *dest, int dest_size);
2812 * Calculate the size in bytes that a picture of the given width and height
2813 * would occupy if stored in the given picture format.
2814 * Note that this returns the size of a compact representation as generated
2815 * by avpicture_layout, which can be smaller than the size required for e.g.
2818 * @param pix_fmt the given picture format
2819 * @param width the width of the image
2820 * @param height the height of the image
2821 * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2823 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2824 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2825 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2826 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2829 * Returns the pixel format corresponding to the name \p name.
2831 * If there is no pixel format with name \p name, then looks for a
2832 * pixel format with the name corresponding to the native endian
2833 * format of \p name.
2834 * For example in a little-endian system, first looks for "gray16",
2835 * then for "gray16le".
2837 * Finally if no pixel format has been found, returns \c PIX_FMT_NONE.
2839 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2840 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2842 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2843 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2844 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2845 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2846 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2847 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2850 * Computes what kind of losses will occur when converting from one specific
2851 * pixel format to another.
2852 * When converting from one pixel format to another, information loss may occur.
2853 * For example, when converting from RGB24 to GRAY, the color information will
2854 * be lost. Similarly, other losses occur when converting from some formats to
2855 * other formats. These losses can involve loss of chroma, but also loss of
2856 * resolution, loss of color depth, loss due to the color space conversion, loss
2857 * of the alpha bits or loss due to color quantization.
2858 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2859 * which will occur when converting from one pixel format to another.
2861 * @param[in] dst_pix_fmt destination pixel format
2862 * @param[in] src_pix_fmt source pixel format
2863 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2864 * @return Combination of flags informing you what kind of losses will occur.
2866 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
2870 * Finds the best pixel format to convert to given a certain source pixel
2871 * format. When converting from one pixel format to another, information loss
2872 * may occur. For example, when converting from RGB24 to GRAY, the color
2873 * information will be lost. Similarly, other losses occur when converting from
2874 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2875 * the given pixel formats should be used to suffer the least amount of loss.
2876 * The pixel formats from which it chooses one, are determined by the
2877 * \p pix_fmt_mask parameter.
2880 * src_pix_fmt = PIX_FMT_YUV420P;
2881 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2882 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2885 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2886 * @param[in] src_pix_fmt source pixel format
2887 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2888 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2889 * @return The best pixel format to convert to or -1 if none was found.
2891 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
2892 int has_alpha, int *loss_ptr);
2896 * Print in buf the string corresponding to the pixel format with
2897 * number pix_fmt, or an header if pix_fmt is negative.
2899 * @param[in] buf the buffer where to write the string
2900 * @param[in] buf_size the size of buf
2901 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2902 * a negative value to print the corresponding header.
2903 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2905 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
2907 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2908 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2911 * Tell if an image really has transparent alpha values.
2912 * @return ored mask of FF_ALPHA_xxx constants
2914 int img_get_alpha_info(const AVPicture *src,
2915 enum PixelFormat pix_fmt, int width, int height);
2917 /* deinterlace a picture */
2918 /* deinterlace - if not supported return -1 */
2919 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2920 enum PixelFormat pix_fmt, int width, int height);
2922 /* external high level API */
2925 * If c is NULL, returns the first registered codec,
2926 * if c is non-NULL, returns the next registered codec after c,
2927 * or NULL if c is the last one.
2929 AVCodec *av_codec_next(AVCodec *c);
2932 * Returns the LIBAVCODEC_VERSION_INT constant.
2934 unsigned avcodec_version(void);
2937 * Initializes libavcodec.
2939 * @warning This function \e must be called before any other libavcodec
2942 void avcodec_init(void);
2944 #if LIBAVCODEC_VERSION_MAJOR < 53
2946 * @deprecated Deprecated in favor of avcodec_register().
2948 attribute_deprecated void register_avcodec(AVCodec *codec);
2952 * Register the codec \p codec and initialize libavcodec.
2954 * @see avcodec_init()
2956 void avcodec_register(AVCodec *codec);
2959 * Finds a registered encoder with a matching codec ID.
2961 * @param id CodecID of the requested encoder
2962 * @return An encoder if one was found, NULL otherwise.
2964 AVCodec *avcodec_find_encoder(enum CodecID id);
2967 * Finds a registered encoder with the specified name.
2969 * @param name name of the requested encoder
2970 * @return An encoder if one was found, NULL otherwise.
2972 AVCodec *avcodec_find_encoder_by_name(const char *name);
2975 * Finds a registered decoder with a matching codec ID.
2977 * @param id CodecID of the requested decoder
2978 * @return A decoder if one was found, NULL otherwise.
2980 AVCodec *avcodec_find_decoder(enum CodecID id);
2983 * Finds a registered decoder with the specified name.
2985 * @param name name of the requested decoder
2986 * @return A decoder if one was found, NULL otherwise.
2988 AVCodec *avcodec_find_decoder_by_name(const char *name);
2989 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2992 * Sets the fields of the given AVCodecContext to default values.
2994 * @param s The AVCodecContext of which the fields should be set to default values.
2996 void avcodec_get_context_defaults(AVCodecContext *s);
2998 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2999 * we WILL change its arguments and name a few times! */
3000 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
3003 * Allocates an AVCodecContext and sets its fields to default values. The
3004 * resulting struct can be deallocated by simply calling av_free().
3006 * @return An AVCodecContext filled with default values or NULL on failure.
3007 * @see avcodec_get_context_defaults
3009 AVCodecContext *avcodec_alloc_context(void);
3011 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3012 * we WILL change its arguments and name a few times! */
3013 AVCodecContext *avcodec_alloc_context2(enum CodecType);
3016 * Sets the fields of the given AVFrame to default values.
3018 * @param pic The AVFrame of which the fields should be set to default values.
3020 void avcodec_get_frame_defaults(AVFrame *pic);
3023 * Allocates an AVFrame and sets its fields to default values. The resulting
3024 * struct can be deallocated by simply calling av_free().
3026 * @return An AVFrame filled with default values or NULL on failure.
3027 * @see avcodec_get_frame_defaults
3029 AVFrame *avcodec_alloc_frame(void);
3031 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3032 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3033 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3034 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3037 * Checks if the given dimension of a picture is valid, meaning that all
3038 * bytes of the picture can be addressed with a signed int.
3040 * @param[in] w Width of the picture.
3041 * @param[in] h Height of the picture.
3042 * @return Zero if valid, a negative value if invalid.
3044 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
3045 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3047 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3048 void avcodec_thread_free(AVCodecContext *s);
3049 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3050 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3051 //FIXME func typedef
3054 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
3055 * function the context has to be allocated.
3057 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3058 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3059 * retrieving a codec.
3061 * @warning This function is not thread safe!
3064 * avcodec_register_all();
3065 * codec = avcodec_find_decoder(CODEC_ID_H264);
3069 * context = avcodec_alloc_context();
3071 * if (avcodec_open(context, codec) < 0)
3075 * @param avctx The context which will be set up to use the given codec.
3076 * @param codec The codec to use within the context.
3077 * @return zero on success, a negative value on error
3078 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3080 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3082 #if LIBAVCODEC_VERSION_MAJOR < 53
3084 * Decodes an audio frame from \p buf into \p samples.
3085 * Wrapper function which calls avcodec_decode_audio3.
3087 * @deprecated Use avcodec_decode_audio3 instead.
3088 * @param avctx the codec context
3089 * @param[out] samples the output buffer
3090 * @param[in,out] frame_size_ptr the output buffer size in bytes
3091 * @param[in] buf the input buffer
3092 * @param[in] buf_size the input buffer size in bytes
3093 * @return On error a negative value is returned, otherwise the number of bytes
3094 * used or zero if no frame could be decompressed.
3096 attribute_deprecated int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3097 int *frame_size_ptr,
3098 const uint8_t *buf, int buf_size);
3102 * Decodes an audio frame from \p avpkt->data into \p samples.
3103 * The avcodec_decode_audio3() function decodes an audio frame from the input
3104 * buffer \p avpkt->data of size \p avpkt->size. To decode it, it makes use of the
3105 * audio codec which was coupled with \p avctx using avcodec_open(). The
3106 * resulting decoded frame is stored in output buffer \p samples. If no frame
3107 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
3108 * decompressed frame size in \e bytes.
3110 * @warning You \e must set \p frame_size_ptr to the allocated size of the
3111 * output buffer before calling avcodec_decode_audio3().
3113 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3114 * the actual read bytes because some optimized bitstream readers read 32 or 64
3115 * bits at once and could read over the end.
3117 * @warning The end of the input buffer \p avpkt->data should be set to 0 to ensure that
3118 * no overreading happens for damaged MPEG streams.
3120 * @note You might have to align the input buffer \p avpkt->data and output buffer \p
3121 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3122 * necessary at all, on others it won't work at all if not aligned and on others
3123 * it will work but it will have an impact on performance. In practice, the
3124 * bitstream should have 4 byte alignment at minimum and all sample data should
3125 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3126 * the linesize is not a multiple of 16 then there's no sense in aligning the
3127 * start of the buffer to 16.
3129 * @param avctx the codec context
3130 * @param[out] samples the output buffer
3131 * @param[in,out] frame_size_ptr the output buffer size in bytes
3132 * @param[in] avpkt The input AVPacket containing the input buffer.
3133 * @return On error a negative value is returned, otherwise the number of bytes
3134 * used or zero if no frame could be decompressed.
3136 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3137 int *frame_size_ptr,
3140 #if LIBAVCODEC_VERSION_MAJOR < 53
3142 * Decodes a video frame from \p buf into \p picture.
3143 * Wrapper function which calls avcodec_decode_video2.
3145 * @deprecated Use avcodec_decode_video2 instead.
3146 * @param avctx the codec context
3147 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3148 * @param[in] buf the input buffer
3149 * @param[in] buf_size the size of the input buffer in bytes
3150 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3151 * @return On error a negative value is returned, otherwise the number of bytes
3152 * used or zero if no frame could be decompressed.
3154 attribute_deprecated int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3155 int *got_picture_ptr,
3156 const uint8_t *buf, int buf_size);
3160 * Decodes a video frame from \p avpkt->data into \p picture.
3161 * The avcodec_decode_video2() function decodes a video frame from the input
3162 * buffer \p avpkt->data of size \p avpkt->size. To decode it, it makes use of the
3163 * video codec which was coupled with \p avctx using avcodec_open(). The
3164 * resulting decoded frame is stored in \p picture.
3166 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3167 * the actual read bytes because some optimized bitstream readers read 32 or 64
3168 * bits at once and could read over the end.
3170 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
3171 * no overreading happens for damaged MPEG streams.
3173 * @note You might have to align the input buffer \p avpkt->data and output buffer \p
3174 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
3175 * necessary at all, on others it won't work at all if not aligned and on others
3176 * it will work but it will have an impact on performance. In practice, the
3177 * bitstream should have 4 byte alignment at minimum and all sample data should
3178 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3179 * the linesize is not a multiple of 16 then there's no sense in aligning the
3180 * start of the buffer to 16.
3182 * @note Some codecs have a delay between input and output, these need to be
3183 * feeded with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3185 * @param avctx the codec context
3186 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3187 * @param[in] avpkt The input AVpacket containing the input buffer.
3188 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3189 * @return On error a negative value is returned, otherwise the number of bytes
3190 * used or zero if no frame could be decompressed.
3192 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3193 int *got_picture_ptr,
3196 #if LIBAVCODEC_VERSION_MAJOR < 53
3197 /* Decode a subtitle message. Return -1 if error, otherwise return the
3198 * number of bytes used. If no subtitle could be decompressed,
3199 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3200 attribute_deprecated int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3202 const uint8_t *buf, int buf_size);
3206 * Decodes a subtitle message.
3207 * Returns -1 if error, otherwise returns the number of bytes used.
3208 * If no subtitle could be decompressed, \p got_sub_ptr is zero.
3209 * Otherwise, the subtitle is stored in \p *sub.
3211 * @param avctx the codec context
3212 * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored.
3213 * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3214 * @param[in] avpkt The input AVPacket containing the input buffer.
3216 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3219 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3221 uint8_t *buf, int buf_size);
3224 * Encodes an audio frame from \p samples into \p buf.
3225 * The avcodec_encode_audio() function encodes an audio frame from the input
3226 * buffer \p samples. To encode it, it makes use of the audio codec which was
3227 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3228 * stored in output buffer \p buf.
3230 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3231 * However, for PCM audio the user will know how much space is needed
3232 * because it depends on the value passed in \p buf_size as described
3233 * below. In that case a lower value can be used.
3235 * @param avctx the codec context
3236 * @param[out] buf the output buffer
3237 * @param[in] buf_size the output buffer size
3238 * @param[in] samples the input buffer containing the samples
3239 * The number of samples read from this buffer is frame_size*channels,
3240 * both of which are defined in \p avctx.
3241 * For PCM audio the number of samples read from \p samples is equal to
3242 * \p buf_size * input_sample_size / output_sample_size.
3243 * @return On error a negative value is returned, on success zero or the number
3244 * of bytes used to encode the data read from the input buffer.
3246 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3247 const short *samples);
3250 * Encodes a video frame from \p pict into \p buf.
3251 * The avcodec_encode_video() function encodes a video frame from the input
3252 * \p pict. To encode it, it makes use of the video codec which was coupled with
3253 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
3254 * frame are stored in the output buffer \p buf. The input picture should be
3255 * stored using a specific format, namely \c avctx.pix_fmt.
3257 * @param avctx the codec context
3258 * @param[out] buf the output buffer for the bitstream of encoded frame
3259 * @param[in] buf_size the size of the output buffer in bytes
3260 * @param[in] pict the input picture to encode
3261 * @return On error a negative value is returned, on success zero or the number
3262 * of bytes used from the output buffer.
3264 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3265 const AVFrame *pict);
3266 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3267 const AVSubtitle *sub);
3269 int avcodec_close(AVCodecContext *avctx);
3272 * Register all the codecs, parsers and bitstream filters which were enabled at
3273 * configuration time. If you do not call this function you can select exactly
3274 * which formats you want to support, by using the individual registration
3277 * @see avcodec_register
3278 * @see av_register_codec_parser
3279 * @see av_register_bitstream_filter
3281 void avcodec_register_all(void);
3284 * Flush buffers, should be called when seeking or when switching to a different stream.
3286 void avcodec_flush_buffers(AVCodecContext *avctx);
3288 void avcodec_default_free_buffers(AVCodecContext *s);
3290 /* misc useful functions */
3293 * Returns a single letter to describe the given picture type \p pict_type.
3295 * @param[in] pict_type the picture type
3296 * @return A single character representing the picture type.
3298 char av_get_pict_type_char(int pict_type);
3301 * Returns codec bits per sample.
3303 * @param[in] codec_id the codec
3304 * @return Number of bits per sample or zero if unknown for the given codec.
3306 int av_get_bits_per_sample(enum CodecID codec_id);
3309 * Returns sample format bits per sample.
3311 * @param[in] sample_fmt the sample format
3312 * @return Number of bits per sample or zero if unknown for the given sample format.
3314 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3317 typedef struct AVCodecParserContext {
3319 struct AVCodecParser *parser;
3320 int64_t frame_offset; /* offset of the current frame */
3321 int64_t cur_offset; /* current offset
3322 (incremented by each av_parser_parse()) */
3323 int64_t next_frame_offset; /* offset of the next frame */
3325 int pict_type; /* XXX: Put it back in AVCodecContext. */
3327 * This field is used for proper frame duration computation in lavf.
3328 * It signals, how much longer the frame duration of the current frame
3329 * is compared to normal frame duration.
3331 * frame_duration = (1 + repeat_pict) * time_base
3333 * It is used by codecs like H.264 to display telecined material.
3335 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3336 int64_t pts; /* pts of the current frame */
3337 int64_t dts; /* dts of the current frame */
3342 int fetch_timestamp;
3344 #define AV_PARSER_PTS_NB 4
3345 int cur_frame_start_index;
3346 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3347 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3348 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3351 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3353 int64_t offset; ///< byte offset from starting packet start
3354 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3357 * Set by parser to 1 for key frames and 0 for non-key frames.
3358 * It is initialized to -1, so if the parser doesn't set this flag,
3359 * old-style fallback using FF_I_TYPE picture type as key frames
3365 * Time difference in stream time base units from the pts of this
3366 * packet to the point at which the output from the decoder has converged
3367 * independent from the availability of previous frames. That is, the
3368 * frames are virtually identical no matter if decoding started from
3369 * the very first frame or from this keyframe.
3370 * Is AV_NOPTS_VALUE if unknown.
3371 * This field is not the display duration of the current frame.
3373 * The purpose of this field is to allow seeking in streams that have no
3374 * keyframes in the conventional sense. It corresponds to the
3375 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3376 * essential for some types of subtitle streams to ensure that all
3377 * subtitles are correctly displayed after seeking.
3379 int64_t convergence_duration;
3381 // Timestamp generation support:
3383 * Synchronization point for start of timestamp generation.
3385 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3388 * For example, this corresponds to presence of H.264 buffering period
3394 * Offset of the current timestamp against last timestamp sync point in
3395 * units of AVCodecContext.time_base.
3397 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3398 * contain a valid timestamp offset.
3400 * Note that the timestamp of sync point has usually a nonzero
3401 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3402 * the next frame after timestamp sync point will be usually 1.
3404 * For example, this corresponds to H.264 cpb_removal_delay.
3406 int dts_ref_dts_delta;
3409 * Presentation delay of current frame in units of AVCodecContext.time_base.
3411 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3412 * contain valid non-negative timestamp delta (presentation time of a frame
3413 * must not lie in the past).
3415 * This delay represents the difference between decoding and presentation
3416 * time of the frame.
3418 * For example, this corresponds to H.264 dpb_output_delay.
3423 * Position of the packet in file.
3425 * Analogous to cur_frame_pts/dts
3427 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3430 * Byte position of currently parsed frame in stream.
3435 * Previous frame byte position.
3438 } AVCodecParserContext;
3440 typedef struct AVCodecParser {
3441 int codec_ids[5]; /* several codec IDs are permitted */
3443 int (*parser_init)(AVCodecParserContext *s);
3444 int (*parser_parse)(AVCodecParserContext *s,
3445 AVCodecContext *avctx,
3446 const uint8_t **poutbuf, int *poutbuf_size,
3447 const uint8_t *buf, int buf_size);
3448 void (*parser_close)(AVCodecParserContext *s);
3449 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3450 struct AVCodecParser *next;
3453 AVCodecParser *av_parser_next(AVCodecParser *c);
3455 void av_register_codec_parser(AVCodecParser *parser);
3456 AVCodecParserContext *av_parser_init(int codec_id);
3458 #if LIBAVCODEC_VERSION_MAJOR < 53
3459 attribute_deprecated
3460 int av_parser_parse(AVCodecParserContext *s,
3461 AVCodecContext *avctx,
3462 uint8_t **poutbuf, int *poutbuf_size,
3463 const uint8_t *buf, int buf_size,
3464 int64_t pts, int64_t dts);
3470 * @param s parser context.
3471 * @param avctx codec context.
3472 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3473 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3474 * @param buf input buffer.
3475 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3476 * @param pts input presentation timestamp.
3477 * @param dts input decoding timestamp.
3478 * @param pos input byte position in stream.
3479 * @return the number of bytes of the input bitstream used.
3484 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3491 * decode_frame(data, size);
3495 int av_parser_parse2(AVCodecParserContext *s,
3496 AVCodecContext *avctx,
3497 uint8_t **poutbuf, int *poutbuf_size,
3498 const uint8_t *buf, int buf_size,
3499 int64_t pts, int64_t dts,
3502 int av_parser_change(AVCodecParserContext *s,
3503 AVCodecContext *avctx,
3504 uint8_t **poutbuf, int *poutbuf_size,
3505 const uint8_t *buf, int buf_size, int keyframe);
3506 void av_parser_close(AVCodecParserContext *s);
3509 typedef struct AVBitStreamFilterContext {
3511 struct AVBitStreamFilter *filter;
3512 AVCodecParserContext *parser;
3513 struct AVBitStreamFilterContext *next;
3514 } AVBitStreamFilterContext;
3517 typedef struct AVBitStreamFilter {
3520 int (*filter)(AVBitStreamFilterContext *bsfc,
3521 AVCodecContext *avctx, const char *args,
3522 uint8_t **poutbuf, int *poutbuf_size,
3523 const uint8_t *buf, int buf_size, int keyframe);
3524 void (*close)(AVBitStreamFilterContext *bsfc);
3525 struct AVBitStreamFilter *next;
3526 } AVBitStreamFilter;
3528 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3529 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3530 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3531 AVCodecContext *avctx, const char *args,
3532 uint8_t **poutbuf, int *poutbuf_size,
3533 const uint8_t *buf, int buf_size, int keyframe);
3534 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3536 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3541 * Reallocates the given block if it is not large enough, otherwise it
3546 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3549 * Allocates a buffer, reusing the given one if large enough.
3551 * Contrary to av_fast_realloc the current buffer contents might not be
3552 * preserved and on error the old buffer is freed, thus no special
3553 * handling to avoid memleaks is necessary.
3555 * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
3556 * @param size size of the buffer *ptr points to
3557 * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
3558 * *size 0 if an error occurred.
3560 void av_fast_malloc(void *ptr, unsigned int *size, unsigned int min_size);
3563 * Copy image 'src' to 'dst'.
3565 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3566 enum PixelFormat pix_fmt, int width, int height);
3569 * Crop image top and left side.
3571 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3572 enum PixelFormat pix_fmt, int top_band, int left_band);
3577 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3578 int padtop, int padbottom, int padleft, int padright, int *color);
3580 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3583 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3585 * @return 0 in case of a successful parsing, a negative value otherwise
3586 * @param[in] str the string to parse: it has to be a string in the format
3587 * <width>x<height> or a valid video frame size abbreviation.
3588 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3590 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3591 * frame height value
3593 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3596 * Parses \p str and put in \p frame_rate the detected values.
3598 * @return 0 in case of a successful parsing, a negative value otherwise
3599 * @param[in] str the string to parse: it has to be a string in the format
3600 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3601 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3604 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3606 /* error handling */
3608 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3609 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3611 /* Some platforms have E* and errno already negated. */
3612 #define AVERROR(e) (e)
3613 #define AVUNERROR(e) (e)
3615 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3616 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3617 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3618 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3619 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3620 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3621 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3622 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3623 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3624 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3627 * Registers the hardware accelerator \p hwaccel.
3629 void av_register_hwaccel(AVHWAccel *hwaccel);
3632 * If hwaccel is NULL, returns the first registered hardware accelerator,
3633 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3634 * after hwaccel, or NULL if hwaccel is the last one.
3636 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3638 #endif /* AVCODEC_AVCODEC_H */