2 * copyright (c) 2001 Fabrice Bellard
4 * This file is part of FFmpeg.
6 * FFmpeg is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * FFmpeg is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with FFmpeg; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 51
33 #define LIBAVCODEC_VERSION_MINOR 71
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,
193 /* various PCM "codecs" */
194 CODEC_ID_PCM_S16LE= 0x10000,
210 CODEC_ID_PCM_S24DAUD,
212 CODEC_ID_PCM_S16LE_PLANAR,
219 /* various ADPCM codecs */
220 CODEC_ID_ADPCM_IMA_QT= 0x11000,
221 CODEC_ID_ADPCM_IMA_WAV,
222 CODEC_ID_ADPCM_IMA_DK3,
223 CODEC_ID_ADPCM_IMA_DK4,
224 CODEC_ID_ADPCM_IMA_WS,
225 CODEC_ID_ADPCM_IMA_SMJPEG,
234 CODEC_ID_ADPCM_YAMAHA,
235 CODEC_ID_ADPCM_SBPRO_4,
236 CODEC_ID_ADPCM_SBPRO_3,
237 CODEC_ID_ADPCM_SBPRO_2,
239 CODEC_ID_ADPCM_IMA_AMV,
240 CODEC_ID_ADPCM_EA_R1,
241 CODEC_ID_ADPCM_EA_R3,
242 CODEC_ID_ADPCM_EA_R2,
243 CODEC_ID_ADPCM_IMA_EA_SEAD,
244 CODEC_ID_ADPCM_IMA_EA_EACS,
245 CODEC_ID_ADPCM_EA_XAS,
246 CODEC_ID_ADPCM_EA_MAXIS_XA,
249 CODEC_ID_AMR_NB= 0x12000,
252 /* RealAudio codecs*/
253 CODEC_ID_RA_144= 0x13000,
256 /* various DPCM codecs */
257 CODEC_ID_ROQ_DPCM= 0x14000,
258 CODEC_ID_INTERPLAY_DPCM,
263 CODEC_ID_MP2= 0x15000,
264 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
266 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
285 CODEC_ID_WESTWOOD_SND1,
286 CODEC_ID_GSM, ///< as in Berlin toast format
294 CODEC_ID_DSICINAUDIO,
298 CODEC_ID_GSM_MS, /* as found in WAV */
307 CODEC_ID_WMALOSSLESS,
311 /* subtitle codecs */
312 CODEC_ID_DVD_SUBTITLE= 0x17000,
313 CODEC_ID_DVB_SUBTITLE,
314 CODEC_ID_TEXT, ///< raw UTF-8 text
319 /* other specific kind of codecs (generally used for attachments) */
320 CODEC_ID_TTF= 0x18000,
322 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
324 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
325 * stream (only used by libavformat) */
328 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
329 /* CODEC_ID_MP3LAME is obsolete */
330 #define CODEC_ID_MP3LAME CODEC_ID_MP3
331 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
335 CODEC_TYPE_UNKNOWN = -1,
340 CODEC_TYPE_ATTACHMENT,
345 * all in native-endian format
348 SAMPLE_FMT_NONE = -1,
349 SAMPLE_FMT_U8, ///< unsigned 8 bits
350 SAMPLE_FMT_S16, ///< signed 16 bits
351 SAMPLE_FMT_S24, ///< signed 24 bits @deprecated Deprecated in favor of SAMPLE_FMT_S32
352 SAMPLE_FMT_S32, ///< signed 32 bits
353 SAMPLE_FMT_FLT, ///< float
354 SAMPLE_FMT_DBL, ///< double
355 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
359 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
362 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
363 * This is mainly needed because some optimized bitstream readers read
364 * 32 or 64 bit at once and could read over the end.<br>
365 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
366 * MPEG bitstreams could cause overread and segfault.
368 #define FF_INPUT_BUFFER_PADDING_SIZE 8
371 * minimum encoding buffer size
372 * Used to avoid some checks during header writing.
374 #define FF_MIN_BUFFER_SIZE 16384
377 * motion estimation type.
380 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
384 ME_EPZS, ///< enhanced predictive zonal search
385 ME_X1, ///< reserved for experiments
386 ME_HEX, ///< hexagon based search
387 ME_UMH, ///< uneven multi-hexagon search
388 ME_ITER, ///< iterative search
389 ME_TESA, ///< transformed exhaustive search algorithm
393 /* We leave some space between them for extensions (drop some
394 * keyframes for intra-only or drop just some bidir frames). */
395 AVDISCARD_NONE =-16, ///< discard nothing
396 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
397 AVDISCARD_NONREF = 8, ///< discard all non reference
398 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
399 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
400 AVDISCARD_ALL = 48, ///< discard all
403 typedef struct RcOverride{
406 int qscale; // If this is 0 then quality_factor will be used instead.
407 float quality_factor;
410 #define FF_MAX_B_FRAMES 16
413 These flags can be passed in AVCodecContext.flags before initialization.
414 Note: Not everything is supported yet.
417 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
418 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
419 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
420 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
421 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
422 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
424 * The parent program guarantees that the input for B-frames containing
425 * streams is not written to for at least s->max_b_frames+1 frames, if
426 * this is not set the input will be copied.
428 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
429 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
430 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
431 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
432 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
433 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
434 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
435 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
436 location instead of only at frame boundaries. */
437 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
438 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
439 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
440 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
441 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
442 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
444 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
445 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
446 /* Fx : Flag for h263+ extra options */
447 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
448 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
450 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
451 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
452 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
453 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
454 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
455 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
456 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
457 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
458 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
459 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
460 #define CODEC_FLAG_CLOSED_GOP 0x80000000
461 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
462 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
463 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
464 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
465 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
466 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
467 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
468 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
469 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
470 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
471 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
472 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
473 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
474 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
475 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
476 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
477 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
478 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
480 /* Unsupported options :
481 * Syntax Arithmetic coding (SAC)
482 * Reference Picture Selection
483 * Independent Segment Decoding */
485 /* codec capabilities */
487 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
489 * Codec uses get_buffer() for allocating buffers.
490 * direct rendering method 1
492 #define CODEC_CAP_DR1 0x0002
493 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
494 #define CODEC_CAP_PARSE_ONLY 0x0004
495 #define CODEC_CAP_TRUNCATED 0x0008
496 /* Codec can export data for HW decoding (XvMC). */
497 #define CODEC_CAP_HWACCEL 0x0010
499 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
500 * If this is not set, the codec is guaranteed to never be fed with NULL data.
502 #define CODEC_CAP_DELAY 0x0020
504 * Codec can be fed a final frame with a smaller size.
505 * This can be used to prevent truncation of the last audio samples.
507 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
509 //The following defines may change, don't expect compatibility if you use them.
510 #define MB_TYPE_INTRA4x4 0x0001
511 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
512 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
513 #define MB_TYPE_16x16 0x0008
514 #define MB_TYPE_16x8 0x0010
515 #define MB_TYPE_8x16 0x0020
516 #define MB_TYPE_8x8 0x0040
517 #define MB_TYPE_INTERLACED 0x0080
518 #define MB_TYPE_DIRECT2 0x0100 //FIXME
519 #define MB_TYPE_ACPRED 0x0200
520 #define MB_TYPE_GMC 0x0400
521 #define MB_TYPE_SKIP 0x0800
522 #define MB_TYPE_P0L0 0x1000
523 #define MB_TYPE_P1L0 0x2000
524 #define MB_TYPE_P0L1 0x4000
525 #define MB_TYPE_P1L1 0x8000
526 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
527 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
528 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
529 #define MB_TYPE_QUANT 0x00010000
530 #define MB_TYPE_CBP 0x00020000
531 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
535 * This specifies the area which should be displayed.
536 * Note there may be multiple such areas for one frame.
538 typedef struct AVPanScan{
541 * - encoding: Set by user.
542 * - decoding: Set by libavcodec.
547 * width and height in 1/16 pel
548 * - encoding: Set by user.
549 * - decoding: Set by libavcodec.
555 * position of the top left corner in 1/16 pel for up to 3 fields/frames
556 * - encoding: Set by user.
557 * - decoding: Set by libavcodec.
559 int16_t position[3][2];
562 #define FF_COMMON_FRAME \
564 * pointer to the picture planes.\
565 * This might be different from the first allocated byte\
572 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
573 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
579 * 1 -> keyframe, 0-> not\
580 * - encoding: Set by libavcodec.\
581 * - decoding: Set by libavcodec.\
586 * Picture type of the frame, see ?_TYPE below.\
587 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
588 * - decoding: Set by libavcodec.\
593 * presentation timestamp in time_base units (time when frame should be shown to user)\
594 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
595 * - encoding: MUST be set by user.\
596 * - decoding: Set by libavcodec.\
601 * picture number in bitstream order\
602 * - encoding: set by\
603 * - decoding: Set by libavcodec.\
605 int coded_picture_number;\
607 * picture number in display order\
608 * - encoding: set by\
609 * - decoding: Set by libavcodec.\
611 int display_picture_number;\
614 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
615 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
616 * - decoding: Set by libavcodec.\
621 * buffer age (1->was last buffer and dint change, 2->..., ...).\
622 * Set to INT_MAX if the buffer has not been used yet.\
623 * - encoding: unused\
624 * - decoding: MUST be set by get_buffer().\
629 * is this picture used as reference\
630 * The values for this are the same as the MpegEncContext.picture_structure\
631 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
632 * - encoding: unused\
633 * - decoding: Set by libavcodec. (before get_buffer() call)).\
639 * - encoding: unused\
640 * - decoding: Set by libavcodec.\
642 int8_t *qscale_table;\
645 * - encoding: unused\
646 * - decoding: Set by libavcodec.\
651 * mbskip_table[mb]>=1 if MB didn't change\
652 * stride= mb_width = (width+15)>>4\
653 * - encoding: unused\
654 * - decoding: Set by libavcodec.\
656 uint8_t *mbskip_table;\
659 * motion vector table\
662 * int mv_sample_log2= 4 - motion_subsample_log2;\
663 * int mb_width= (width+15)>>4;\
664 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
665 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
667 * - encoding: Set by user.\
668 * - decoding: Set by libavcodec.\
670 int16_t (*motion_val[2])[2];\
673 * macroblock type table\
674 * mb_type_base + mb_width + 2\
675 * - encoding: Set by user.\
676 * - decoding: Set by libavcodec.\
681 * log2 of the size of the block which a single vector in motion_val represents: \
682 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
683 * - encoding: unused\
684 * - decoding: Set by libavcodec.\
686 uint8_t motion_subsample_log2;\
689 * for some private data of the user\
690 * - encoding: unused\
691 * - decoding: Set by user.\
697 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
698 * - decoding: unused\
703 * type of the buffer (to keep track of who has to deallocate data[*])\
704 * - encoding: Set by the one who allocates it.\
705 * - decoding: Set by the one who allocates it.\
706 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
711 * When decoding, this signals how much the picture must be delayed.\
712 * extra_delay = repeat_pict / (2*fps)\
713 * - encoding: unused\
714 * - decoding: Set by libavcodec.\
724 * The content of the picture is interlaced.\
725 * - encoding: Set by user.\
726 * - decoding: Set by libavcodec. (default 0)\
728 int interlaced_frame;\
731 * If the content is interlaced, is top field displayed first.\
732 * - encoding: Set by user.\
733 * - decoding: Set by libavcodec.\
735 int top_field_first;\
739 * - encoding: Set by user.\
740 * - decoding: Set by libavcodec.\
742 AVPanScan *pan_scan;\
745 * Tell user application that palette has changed from previous frame.\
746 * - encoding: ??? (no palette-enabled encoder yet)\
747 * - decoding: Set by libavcodec. (default 0).\
749 int palette_has_changed;\
752 * codec suggestion on buffer type if != 0\
753 * - encoding: unused\
754 * - decoding: Set by libavcodec. (before get_buffer() call)).\
760 * - encoding: unused\
761 * - decoding: Set by libavcodec.\
766 * motion referece frame index\
767 * - encoding: Set by user.\
768 * - decoding: Set by libavcodec.\
770 int8_t *ref_index[2];\
773 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
774 * output in AVFrame.reordered_opaque\
775 * - encoding: unused\
776 * - decoding: Read by user.\
778 int64_t reordered_opaque;\
781 #define FF_QSCALE_TYPE_MPEG1 0
782 #define FF_QSCALE_TYPE_MPEG2 1
783 #define FF_QSCALE_TYPE_H264 2
785 #define FF_BUFFER_TYPE_INTERNAL 1
786 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
787 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
788 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
791 #define FF_I_TYPE 1 ///< Intra
792 #define FF_P_TYPE 2 ///< Predicted
793 #define FF_B_TYPE 3 ///< Bi-dir predicted
794 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
795 #define FF_SI_TYPE 5 ///< Switching Intra
796 #define FF_SP_TYPE 6 ///< Switching Predicted
799 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
800 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
801 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
802 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
806 * New fields can be added to the end of FF_COMMON_FRAME with minor version
808 * Removal, reordering and changes to existing fields require a major
809 * version bump. No fields should be added into AVFrame before or after
811 * sizeof(AVFrame) must not be used outside libav*.
813 typedef struct AVFrame {
817 #define DEFAULT_FRAME_RATE_BASE 1001000
820 * main external API structure.
821 * New fields can be added to the end with minor version bumps.
822 * Removal, reordering and changes to existing fields require a major
824 * sizeof(AVCodecContext) must not be used outside libav*.
826 typedef struct AVCodecContext {
828 * information on struct for av_log
829 * - set by avcodec_alloc_context
831 const AVClass *av_class;
833 * the average bitrate
834 * - encoding: Set by user; unused for constant quantizer encoding.
835 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
840 * number of bits the bitstream is allowed to diverge from the reference.
841 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
842 * - encoding: Set by user; unused for constant quantizer encoding.
845 int bit_rate_tolerance;
849 * - encoding: Set by user.
850 * - decoding: Set by user.
855 * Some codecs need additional format info. It is stored here.
856 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
857 * specific codec MUST set it correctly otherwise stream copy breaks.
858 * In general use of this field by muxers is not recommanded.
859 * - encoding: Set by libavcodec.
860 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
865 * Motion estimation algorithm used for video coding.
866 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
867 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
868 * - encoding: MUST be set by user.
874 * some codecs need / can use extradata like Huffman tables.
875 * mjpeg: Huffman tables
876 * rv10: additional flags
877 * mpeg4: global headers (they can be in the bitstream or here)
878 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
879 * than extradata_size to avoid prolems if it is read with the bitstream reader.
880 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
881 * - encoding: Set/allocated/freed by libavcodec.
882 * - decoding: Set/allocated/freed by user.
888 * This is the fundamental unit of time (in seconds) in terms
889 * of which frame timestamps are represented. For fixed-fps content,
890 * timebase should be 1/framerate and timestamp increments should be
892 * - encoding: MUST be set by user.
893 * - decoding: Set by libavcodec.
895 AVRational time_base;
899 * picture width / height.
900 * - encoding: MUST be set by user.
901 * - decoding: Set by libavcodec.
902 * Note: For compatibility it is possible to set this instead of
903 * coded_width/height before decoding.
907 #define FF_ASPECT_EXTENDED 15
910 * the number of pictures in a group of pictures, or 0 for intra_only
911 * - encoding: Set by user.
917 * Pixel format, see PIX_FMT_xxx.
918 * - encoding: Set by user.
919 * - decoding: Set by libavcodec.
921 enum PixelFormat pix_fmt;
924 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
925 * has to read frames at native frame rate.
926 * - encoding: Set by user.
932 * If non NULL, 'draw_horiz_band' is called by the libavcodec
933 * decoder to draw a horizontal band. It improves cache usage. Not
934 * all codecs can do that. You must check the codec capabilities
937 * - decoding: Set by user.
938 * @param height the height of the slice
939 * @param y the y position of the slice
940 * @param type 1->top field, 2->bottom field, 3->frame
941 * @param offset offset into the AVFrame.data from which the slice should be read
943 void (*draw_horiz_band)(struct AVCodecContext *s,
944 const AVFrame *src, int offset[4],
945 int y, int type, int height);
948 int sample_rate; ///< samples per second
949 int channels; ///< number of audio channels
952 * audio sample format
953 * - encoding: Set by user.
954 * - decoding: Set by libavcodec.
956 enum SampleFormat sample_fmt; ///< sample format, currently unused
958 /* The following data should not be initialized. */
960 * Samples per packet, initialized when calling 'init'.
963 int frame_number; ///< audio or video frame number
964 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
967 * Number of frames the decoded output will be delayed relative to
969 * - encoding: Set by libavcodec.
974 /* - encoding parameters */
975 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
976 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
980 * - encoding: Set by user.
987 * - encoding: Set by user.
993 * maximum quantizer difference between frames
994 * - encoding: Set by user.
1000 * maximum number of B-frames between non-B-frames
1001 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1002 * - encoding: Set by user.
1003 * - decoding: unused
1008 * qscale factor between IP and B-frames
1009 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1010 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1011 * - encoding: Set by user.
1012 * - decoding: unused
1014 float b_quant_factor;
1016 /** obsolete FIXME remove */
1018 #define FF_RC_STRATEGY_XVID 1
1020 int b_frame_strategy;
1024 * - encoding: unused
1025 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1026 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1030 struct AVCodec *codec;
1034 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1035 /* unused, FIXME remove*/
1039 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1040 /* do its best to deliver a chunk with size */
1041 /* below rtp_payload_size, the chunk will start */
1042 /* with a start code on some codecs like H.263. */
1043 /* This doesn't take account of any particular */
1044 /* headers inside the transmitted RTP payload. */
1047 /* The RTP callback: This function is called */
1048 /* every time the encoder has a packet to send. */
1049 /* It depends on the encoder if the data starts */
1050 /* with a Start Code (it should). H.263 does. */
1051 /* mb_nb contains the number of macroblocks */
1052 /* encoded in the RTP payload. */
1053 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1055 /* statistics, used for 2-pass encoding */
1066 * number of bits used for the previously encoded frame
1067 * - encoding: Set by libavcodec.
1068 * - decoding: unused
1073 * Private data of the user, can be used to carry app specific stuff.
1074 * - encoding: Set by user.
1075 * - decoding: Set by user.
1079 char codec_name[32];
1080 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1081 enum CodecID codec_id; /* see CODEC_ID_xxx */
1084 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1085 * This is used to work around some encoder bugs.
1086 * A demuxer should set this to what is stored in the field used to identify the codec.
1087 * If there are multiple such fields in a container then the demuxer should choose the one
1088 * which maximizes the information about the used codec.
1089 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1090 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1091 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1093 * - encoding: Set by user, if not then the default based on codec_id will be used.
1094 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1096 unsigned int codec_tag;
1099 * Work around bugs in encoders which sometimes cannot be detected automatically.
1100 * - encoding: Set by user
1101 * - decoding: Set by user
1103 int workaround_bugs;
1104 #define FF_BUG_AUTODETECT 1 ///< autodetection
1105 #define FF_BUG_OLD_MSMPEG4 2
1106 #define FF_BUG_XVID_ILACE 4
1107 #define FF_BUG_UMP4 8
1108 #define FF_BUG_NO_PADDING 16
1109 #define FF_BUG_AMV 32
1110 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1111 #define FF_BUG_QPEL_CHROMA 64
1112 #define FF_BUG_STD_QPEL 128
1113 #define FF_BUG_QPEL_CHROMA2 256
1114 #define FF_BUG_DIRECT_BLOCKSIZE 512
1115 #define FF_BUG_EDGE 1024
1116 #define FF_BUG_HPEL_CHROMA 2048
1117 #define FF_BUG_DC_CLIP 4096
1118 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1119 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1122 * luma single coefficient elimination threshold
1123 * - encoding: Set by user.
1124 * - decoding: unused
1126 int luma_elim_threshold;
1129 * chroma single coeff elimination threshold
1130 * - encoding: Set by user.
1131 * - decoding: unused
1133 int chroma_elim_threshold;
1136 * strictly follow the standard (MPEG4, ...).
1137 * - encoding: Set by user.
1138 * - decoding: Set by user.
1139 * Setting this to STRICT or higher means the encoder and decoder will
1140 * generally do stupid things. While setting it to inofficial or lower
1141 * will mean the encoder might use things that are not supported by all
1142 * spec compliant decoders. Decoders make no difference between normal,
1143 * inofficial and experimental, that is they always try to decode things
1144 * when they can unless they are explicitly asked to behave stupid
1145 * (=strictly conform to the specs)
1147 int strict_std_compliance;
1148 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1149 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1150 #define FF_COMPLIANCE_NORMAL 0
1151 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1152 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1155 * qscale offset between IP and B-frames
1156 * - encoding: Set by user.
1157 * - decoding: unused
1159 float b_quant_offset;
1162 * Error resilience; higher values will detect more errors but may
1163 * misdetect some more or less valid parts as errors.
1164 * - encoding: unused
1165 * - decoding: Set by user.
1167 int error_resilience;
1168 #define FF_ER_CAREFUL 1
1169 #define FF_ER_COMPLIANT 2
1170 #define FF_ER_AGGRESSIVE 3
1171 #define FF_ER_VERY_AGGRESSIVE 4
1174 * Called at the beginning of each frame to get a buffer for it.
1175 * If pic.reference is set then the frame will be read later by libavcodec.
1176 * avcodec_align_dimensions() should be used to find the required width and
1177 * height, as they normally need to be rounded up to the next multiple of 16.
1178 * - encoding: unused
1179 * - decoding: Set by libavcodec., user can override.
1181 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1184 * Called to release buffers which were allocated with get_buffer.
1185 * A released buffer can be reused in get_buffer().
1186 * pic.data[*] must be set to NULL.
1187 * - encoding: unused
1188 * - decoding: Set by libavcodec., user can override.
1190 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1193 * If 1 the stream has a 1 frame delay during decoding.
1194 * - encoding: Set by libavcodec.
1195 * - decoding: Set by libavcodec.
1200 * number of bytes per packet if constant and known or 0
1201 * Used by some WAV based audio codecs.
1205 int parse_only; /* - decoding only: If true, only parsing is done
1206 (function avcodec_parse_frame()). The frame
1207 data is returned. Only MPEG codecs support this now. */
1210 * 0-> h263 quant 1-> mpeg quant
1211 * - encoding: Set by user.
1212 * - decoding: unused
1217 * pass1 encoding statistics output buffer
1218 * - encoding: Set by libavcodec.
1219 * - decoding: unused
1224 * pass2 encoding statistics input buffer
1225 * Concatenated stuff from stats_out of pass1 should be placed here.
1226 * - encoding: Allocated/set/freed by user.
1227 * - decoding: unused
1232 * ratecontrol qmin qmax limiting method
1233 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1234 * - encoding: Set by user.
1235 * - decoding: unused
1243 * ratecontrol override, see RcOverride
1244 * - encoding: Allocated/set/freed by user.
1245 * - decoding: unused
1247 RcOverride *rc_override;
1248 int rc_override_count;
1251 * rate control equation
1252 * - encoding: Set by user
1253 * - decoding: unused
1259 * - encoding: Set by user.
1260 * - decoding: unused
1266 * - encoding: Set by user.
1267 * - decoding: unused
1272 * decoder bitstream buffer size
1273 * - encoding: Set by user.
1274 * - decoding: unused
1277 float rc_buffer_aggressivity;
1280 * qscale factor between P and I-frames
1281 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1282 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1283 * - encoding: Set by user.
1284 * - decoding: unused
1286 float i_quant_factor;
1289 * qscale offset between P and I-frames
1290 * - encoding: Set by user.
1291 * - decoding: unused
1293 float i_quant_offset;
1296 * initial complexity for pass1 ratecontrol
1297 * - encoding: Set by user.
1298 * - decoding: unused
1300 float rc_initial_cplx;
1303 * DCT algorithm, see FF_DCT_* below
1304 * - encoding: Set by user.
1305 * - decoding: unused
1308 #define FF_DCT_AUTO 0
1309 #define FF_DCT_FASTINT 1
1310 #define FF_DCT_INT 2
1311 #define FF_DCT_MMX 3
1312 #define FF_DCT_MLIB 4
1313 #define FF_DCT_ALTIVEC 5
1314 #define FF_DCT_FAAN 6
1317 * luminance masking (0-> disabled)
1318 * - encoding: Set by user.
1319 * - decoding: unused
1324 * temporary complexity masking (0-> disabled)
1325 * - encoding: Set by user.
1326 * - decoding: unused
1328 float temporal_cplx_masking;
1331 * spatial complexity masking (0-> disabled)
1332 * - encoding: Set by user.
1333 * - decoding: unused
1335 float spatial_cplx_masking;
1338 * p block masking (0-> disabled)
1339 * - encoding: Set by user.
1340 * - decoding: unused
1345 * darkness masking (0-> disabled)
1346 * - encoding: Set by user.
1347 * - decoding: unused
1352 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1353 /* for binary compatibility */
1358 * IDCT algorithm, see FF_IDCT_* below.
1359 * - encoding: Set by user.
1360 * - decoding: Set by user.
1363 #define FF_IDCT_AUTO 0
1364 #define FF_IDCT_INT 1
1365 #define FF_IDCT_SIMPLE 2
1366 #define FF_IDCT_SIMPLEMMX 3
1367 #define FF_IDCT_LIBMPEG2MMX 4
1368 #define FF_IDCT_PS2 5
1369 #define FF_IDCT_MLIB 6
1370 #define FF_IDCT_ARM 7
1371 #define FF_IDCT_ALTIVEC 8
1372 #define FF_IDCT_SH4 9
1373 #define FF_IDCT_SIMPLEARM 10
1374 #define FF_IDCT_H264 11
1375 #define FF_IDCT_VP3 12
1376 #define FF_IDCT_IPP 13
1377 #define FF_IDCT_XVIDMMX 14
1378 #define FF_IDCT_CAVS 15
1379 #define FF_IDCT_SIMPLEARMV5TE 16
1380 #define FF_IDCT_SIMPLEARMV6 17
1381 #define FF_IDCT_SIMPLEVIS 18
1382 #define FF_IDCT_WMV2 19
1383 #define FF_IDCT_FAAN 20
1387 * - encoding: Set by libavcodec.
1388 * - decoding: Set by user (or 0).
1392 * slice offsets in the frame in bytes
1393 * - encoding: Set/allocated by libavcodec.
1394 * - decoding: Set/allocated by user (or NULL).
1399 * error concealment flags
1400 * - encoding: unused
1401 * - decoding: Set by user.
1403 int error_concealment;
1404 #define FF_EC_GUESS_MVS 1
1405 #define FF_EC_DEBLOCK 2
1408 * dsp_mask could be add used to disable unwanted CPU features
1409 * CPU features (i.e. MMX, SSE. ...)
1411 * With the FORCE flag you may instead enable given CPU features.
1412 * (Dangerous: Usable in case of misdetection, improper usage however will
1413 * result into program crash.)
1416 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1417 /* lower 16 bits - CPU features */
1418 #define FF_MM_MMX 0x0001 ///< standard MMX
1419 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1420 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1421 #define FF_MM_SSE 0x0008 ///< SSE functions
1422 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1423 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1424 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1425 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1426 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1429 * bits per sample/pixel from the demuxer (needed for huffyuv).
1430 * - encoding: Set by libavcodec.
1431 * - decoding: Set by user.
1433 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1434 int bits_per_sample;
1436 int bits_per_coded_sample;
1440 * prediction method (needed for huffyuv)
1441 * - encoding: Set by user.
1442 * - decoding: unused
1444 int prediction_method;
1445 #define FF_PRED_LEFT 0
1446 #define FF_PRED_PLANE 1
1447 #define FF_PRED_MEDIAN 2
1450 * sample aspect ratio (0 if unknown)
1451 * That is the width of a pixel divided by the height of the pixel.
1452 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1453 * - encoding: Set by user.
1454 * - decoding: Set by libavcodec.
1456 AVRational sample_aspect_ratio;
1459 * the picture in the bitstream
1460 * - encoding: Set by libavcodec.
1461 * - decoding: Set by libavcodec.
1463 AVFrame *coded_frame;
1467 * - encoding: Set by user.
1468 * - decoding: Set by user.
1471 #define FF_DEBUG_PICT_INFO 1
1472 #define FF_DEBUG_RC 2
1473 #define FF_DEBUG_BITSTREAM 4
1474 #define FF_DEBUG_MB_TYPE 8
1475 #define FF_DEBUG_QP 16
1476 #define FF_DEBUG_MV 32
1477 #define FF_DEBUG_DCT_COEFF 0x00000040
1478 #define FF_DEBUG_SKIP 0x00000080
1479 #define FF_DEBUG_STARTCODE 0x00000100
1480 #define FF_DEBUG_PTS 0x00000200
1481 #define FF_DEBUG_ER 0x00000400
1482 #define FF_DEBUG_MMCO 0x00000800
1483 #define FF_DEBUG_BUGS 0x00001000
1484 #define FF_DEBUG_VIS_QP 0x00002000
1485 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1486 #define FF_DEBUG_BUFFERS 0x00008000
1490 * - encoding: Set by user.
1491 * - decoding: Set by user.
1494 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1495 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1496 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1500 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1501 * - decoding: unused
1506 * minimum MB quantizer
1507 * - encoding: unused
1508 * - decoding: unused
1513 * maximum MB quantizer
1514 * - encoding: unused
1515 * - decoding: unused
1520 * motion estimation comparison function
1521 * - encoding: Set by user.
1522 * - decoding: unused
1526 * subpixel motion estimation comparison function
1527 * - encoding: Set by user.
1528 * - decoding: unused
1532 * macroblock comparison function (not supported yet)
1533 * - encoding: Set by user.
1534 * - decoding: unused
1538 * interlaced DCT comparison function
1539 * - encoding: Set by user.
1540 * - decoding: unused
1543 #define FF_CMP_SAD 0
1544 #define FF_CMP_SSE 1
1545 #define FF_CMP_SATD 2
1546 #define FF_CMP_DCT 3
1547 #define FF_CMP_PSNR 4
1548 #define FF_CMP_BIT 5
1550 #define FF_CMP_ZERO 7
1551 #define FF_CMP_VSAD 8
1552 #define FF_CMP_VSSE 9
1553 #define FF_CMP_NSSE 10
1554 #define FF_CMP_W53 11
1555 #define FF_CMP_W97 12
1556 #define FF_CMP_DCTMAX 13
1557 #define FF_CMP_DCT264 14
1558 #define FF_CMP_CHROMA 256
1561 * ME diamond size & shape
1562 * - encoding: Set by user.
1563 * - decoding: unused
1568 * amount of previous MV predictors (2a+1 x 2a+1 square)
1569 * - encoding: Set by user.
1570 * - decoding: unused
1572 int last_predictor_count;
1575 * prepass for motion estimation
1576 * - encoding: Set by user.
1577 * - decoding: unused
1582 * motion estimation prepass comparison function
1583 * - encoding: Set by user.
1584 * - decoding: unused
1589 * ME prepass diamond size & shape
1590 * - encoding: Set by user.
1591 * - decoding: unused
1597 * - encoding: Set by user.
1598 * - decoding: unused
1600 int me_subpel_quality;
1603 * callback to negotiate the pixelFormat
1604 * @param fmt is the list of formats which are supported by the codec,
1605 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1606 * The first is always the native one.
1607 * @return the chosen format
1608 * - encoding: unused
1609 * - decoding: Set by user, if not set the native format will be chosen.
1611 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1614 * DTG active format information (additional aspect ratio
1615 * information only used in DVB MPEG-2 transport streams)
1618 * - encoding: unused
1619 * - decoding: Set by decoder.
1621 int dtg_active_format;
1622 #define FF_DTG_AFD_SAME 8
1623 #define FF_DTG_AFD_4_3 9
1624 #define FF_DTG_AFD_16_9 10
1625 #define FF_DTG_AFD_14_9 11
1626 #define FF_DTG_AFD_4_3_SP_14_9 13
1627 #define FF_DTG_AFD_16_9_SP_14_9 14
1628 #define FF_DTG_AFD_SP_4_3 15
1631 * maximum motion estimation search range in subpel units
1632 * If 0 then no limit.
1634 * - encoding: Set by user.
1635 * - decoding: unused
1640 * intra quantizer bias
1641 * - encoding: Set by user.
1642 * - decoding: unused
1644 int intra_quant_bias;
1645 #define FF_DEFAULT_QUANT_BIAS 999999
1648 * inter quantizer bias
1649 * - encoding: Set by user.
1650 * - decoding: unused
1652 int inter_quant_bias;
1656 * - encoding: unused
1657 * - decoding: Which clrtable should be used for 8bit RGB images.
1658 * Tables have to be stored somewhere. FIXME
1663 * internal_buffer count
1664 * Don't touch, used by libavcodec default_get_buffer().
1666 int internal_buffer_count;
1670 * Don't touch, used by libavcodec default_get_buffer().
1672 void *internal_buffer;
1674 #define FF_LAMBDA_SHIFT 7
1675 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1676 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1677 #define FF_LAMBDA_MAX (256*128-1)
1679 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1681 * Global quality for codecs which cannot change it per frame.
1682 * This should be proportional to MPEG-1/2/4 qscale.
1683 * - encoding: Set by user.
1684 * - decoding: unused
1688 #define FF_CODER_TYPE_VLC 0
1689 #define FF_CODER_TYPE_AC 1
1690 #define FF_CODER_TYPE_RAW 2
1691 #define FF_CODER_TYPE_RLE 3
1692 #define FF_CODER_TYPE_DEFLATE 4
1695 * - encoding: Set by user.
1696 * - decoding: unused
1702 * - encoding: Set by user.
1703 * - decoding: unused
1709 * - encoding: unused
1710 * - decoding: Set by user.
1712 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1717 * - encoding: unused
1718 * - decoding: Set by user.
1721 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1722 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1723 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1726 * XVideo Motion Acceleration
1727 * - encoding: forbidden
1728 * - decoding: set by decoder
1730 int xvmc_acceleration;
1733 * macroblock decision mode
1734 * - encoding: Set by user.
1735 * - decoding: unused
1738 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1739 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1740 #define FF_MB_DECISION_RD 2 ///< rate distortion
1743 * custom intra quantization matrix
1744 * - encoding: Set by user, can be NULL.
1745 * - decoding: Set by libavcodec.
1747 uint16_t *intra_matrix;
1750 * custom inter quantization matrix
1751 * - encoding: Set by user, can be NULL.
1752 * - decoding: Set by libavcodec.
1754 uint16_t *inter_matrix;
1757 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1758 * This is used to work around some encoder bugs.
1759 * - encoding: unused
1760 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1762 unsigned int stream_codec_tag;
1765 * scene change detection threshold
1766 * 0 is default, larger means fewer detected scene changes.
1767 * - encoding: Set by user.
1768 * - decoding: unused
1770 int scenechange_threshold;
1773 * minimum Lagrange multipler
1774 * - encoding: Set by user.
1775 * - decoding: unused
1780 * maximum Lagrange multipler
1781 * - encoding: Set by user.
1782 * - decoding: unused
1787 * palette control structure
1788 * - encoding: ??? (no palette-enabled encoder yet)
1789 * - decoding: Set by user.
1791 struct AVPaletteControl *palctrl;
1794 * noise reduction strength
1795 * - encoding: Set by user.
1796 * - decoding: unused
1798 int noise_reduction;
1801 * Called at the beginning of a frame to get cr buffer for it.
1802 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1803 * libavcodec will pass previous buffer in pic, function should return
1804 * same buffer or new buffer with old frame "painted" into it.
1805 * If pic.data[0] == NULL must behave like get_buffer().
1806 * - encoding: unused
1807 * - decoding: Set by libavcodec., user can override
1809 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1812 * Number of bits which should be loaded into the rc buffer before decoding starts.
1813 * - encoding: Set by user.
1814 * - decoding: unused
1816 int rc_initial_buffer_occupancy;
1820 * - encoding: Set by user.
1821 * - decoding: unused
1823 int inter_threshold;
1827 * - encoding: Set by user.
1828 * - decoding: Set by user.
1833 * Simulates errors in the bitstream to test error concealment.
1834 * - encoding: Set by user.
1835 * - decoding: unused
1840 * MP3 antialias algorithm, see FF_AA_* below.
1841 * - encoding: unused
1842 * - decoding: Set by user.
1845 #define FF_AA_AUTO 0
1846 #define FF_AA_FASTINT 1 //not implemented yet
1848 #define FF_AA_FLOAT 3
1850 * quantizer noise shaping
1851 * - encoding: Set by user.
1852 * - decoding: unused
1854 int quantizer_noise_shaping;
1858 * is used to decide how many independent tasks should be passed to execute()
1859 * - encoding: Set by user.
1860 * - decoding: Set by user.
1865 * The codec may call this to execute several independent things.
1866 * It will return only after finishing all tasks.
1867 * The user may replace this with some multithreaded implementation,
1868 * the default implementation will execute the parts serially.
1869 * @param count the number of things to execute
1870 * - encoding: Set by libavcodec, user can override.
1871 * - decoding: Set by libavcodec, user can override.
1873 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1877 * Can be used by execute() to store some per AVCodecContext stuff.
1878 * - encoding: set by execute()
1879 * - decoding: set by execute()
1881 void *thread_opaque;
1884 * Motion estimation threshold below which no motion estimation is
1885 * performed, but instead the user specified motion vectors are used.
1887 * - encoding: Set by user.
1888 * - decoding: unused
1893 * Macroblock threshold below which the user specified macroblock types will be used.
1894 * - encoding: Set by user.
1895 * - decoding: unused
1900 * precision of the intra DC coefficient - 8
1901 * - encoding: Set by user.
1902 * - decoding: unused
1904 int intra_dc_precision;
1907 * noise vs. sse weight for the nsse comparsion function
1908 * - encoding: Set by user.
1909 * - decoding: unused
1914 * Number of macroblock rows at the top which are skipped.
1915 * - encoding: unused
1916 * - decoding: Set by user.
1921 * Number of macroblock rows at the bottom which are skipped.
1922 * - encoding: unused
1923 * - decoding: Set by user.
1929 * - encoding: Set by user.
1930 * - decoding: Set by libavcodec.
1933 #define FF_PROFILE_UNKNOWN -99
1934 #define FF_PROFILE_AAC_MAIN 0
1935 #define FF_PROFILE_AAC_LOW 1
1936 #define FF_PROFILE_AAC_SSR 2
1937 #define FF_PROFILE_AAC_LTP 3
1941 * - encoding: Set by user.
1942 * - decoding: Set by libavcodec.
1945 #define FF_LEVEL_UNKNOWN -99
1948 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1949 * - encoding: unused
1950 * - decoding: Set by user.
1955 * Bitstream width / height, may be different from width/height if lowres
1956 * or other things are used.
1957 * - encoding: unused
1958 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1960 int coded_width, coded_height;
1963 * frame skip threshold
1964 * - encoding: Set by user.
1965 * - decoding: unused
1967 int frame_skip_threshold;
1971 * - encoding: Set by user.
1972 * - decoding: unused
1974 int frame_skip_factor;
1977 * frame skip exponent
1978 * - encoding: Set by user.
1979 * - decoding: unused
1984 * frame skip comparison function
1985 * - encoding: Set by user.
1986 * - decoding: unused
1991 * Border processing masking, raises the quantizer for mbs on the borders
1993 * - encoding: Set by user.
1994 * - decoding: unused
1996 float border_masking;
1999 * minimum MB lagrange multipler
2000 * - encoding: Set by user.
2001 * - decoding: unused
2006 * maximum MB lagrange multipler
2007 * - encoding: Set by user.
2008 * - decoding: unused
2014 * - encoding: Set by user.
2015 * - decoding: unused
2017 int me_penalty_compensation;
2021 * - encoding: unused
2022 * - decoding: Set by user.
2024 enum AVDiscard skip_loop_filter;
2028 * - encoding: unused
2029 * - decoding: Set by user.
2031 enum AVDiscard skip_idct;
2035 * - encoding: unused
2036 * - decoding: Set by user.
2038 enum AVDiscard skip_frame;
2042 * - encoding: Set by user.
2043 * - decoding: unused
2049 * - encoding: Set by user.
2050 * - decoding: unused
2055 * constant rate factor - quality-based VBR - values ~correspond to qps
2056 * - encoding: Set by user.
2057 * - decoding: unused
2062 * constant quantization parameter rate control method
2063 * - encoding: Set by user.
2064 * - decoding: unused
2070 * - encoding: Set by user.
2071 * - decoding: unused
2076 * number of reference frames
2077 * - encoding: Set by user.
2078 * - decoding: unused
2083 * chroma qp offset from luma
2084 * - encoding: Set by user.
2085 * - decoding: unused
2090 * Influences how often B-frames are used.
2091 * - encoding: Set by user.
2092 * - decoding: unused
2097 * trellis RD quantization
2098 * - encoding: Set by user.
2099 * - decoding: unused
2104 * Reduce fluctuations in qp (before curve compression).
2105 * - encoding: Set by user.
2106 * - decoding: unused
2108 float complexityblur;
2111 * in-loop deblocking filter alphac0 parameter
2112 * alpha is in the range -6...6
2113 * - encoding: Set by user.
2114 * - decoding: unused
2119 * in-loop deblocking filter beta parameter
2120 * beta is in the range -6...6
2121 * - encoding: Set by user.
2122 * - decoding: unused
2127 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2128 * - encoding: Set by user.
2129 * - decoding: unused
2132 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2133 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2134 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2135 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2136 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2139 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * Audio cutoff bandwidth (0 means "automatic")
2147 * - encoding: Set by user.
2148 * - decoding: unused
2153 * Multiplied by qscale for each frame and added to scene_change_score.
2154 * - encoding: Set by user.
2155 * - decoding: unused
2157 int scenechange_factor;
2161 * Note: Value depends upon the compare function used for fullpel ME.
2162 * - encoding: Set by user.
2163 * - decoding: unused
2168 * Adjusts sensitivity of b_frame_strategy 1.
2169 * - encoding: Set by user.
2170 * - decoding: unused
2175 * - encoding: Set by user.
2176 * - decoding: unused
2178 int compression_level;
2179 #define FF_COMPRESSION_DEFAULT -1
2182 * Sets whether to use LPC mode - used by FLAC encoder.
2183 * - encoding: Set by user.
2184 * - decoding: unused
2189 * LPC coefficient precision - used by FLAC encoder
2190 * - encoding: Set by user.
2191 * - decoding: unused
2193 int lpc_coeff_precision;
2196 * - encoding: Set by user.
2197 * - decoding: unused
2199 int min_prediction_order;
2202 * - encoding: Set by user.
2203 * - decoding: unused
2205 int max_prediction_order;
2208 * search method for selecting prediction order
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int prediction_order_method;
2215 * - encoding: Set by user.
2216 * - decoding: unused
2218 int min_partition_order;
2221 * - encoding: Set by user.
2222 * - decoding: unused
2224 int max_partition_order;
2227 * GOP timecode frame start number, in non drop frame format
2228 * - encoding: Set by user.
2229 * - decoding: unused
2231 int64_t timecode_frame_start;
2234 * Decoder should decode to this many channels if it can (0 for default)
2235 * - encoding: unused
2236 * - decoding: Set by user.
2238 int request_channels;
2241 * Percentage of dynamic range compression to be applied by the decoder.
2242 * The default value is 1.0, corresponding to full compression.
2243 * - encoding: unused
2244 * - decoding: Set by user.
2249 * opaque 64bit number (generally a PTS) that will be reordered and
2250 * output in AVFrame.reordered_opaque
2251 * - encoding: unused
2252 * - decoding: Set by user.
2254 int64_t reordered_opaque;
2257 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2258 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2259 * - encoding: set by user.
2260 * - decoding: set by libavcodec.
2262 int bits_per_raw_sample;
2268 typedef struct AVCodec {
2270 * Name of the codec implementation.
2271 * The name is globally unique among encoders and among decoders (but an
2272 * encoder and a decoder can share the same name).
2273 * This is the primary way to find a codec from the user perspective.
2276 enum CodecType type;
2279 int (*init)(AVCodecContext *);
2280 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2281 int (*close)(AVCodecContext *);
2282 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2283 const uint8_t *buf, int buf_size);
2285 * Codec capabilities.
2289 struct AVCodec *next;
2292 * Will be called when seeking
2294 void (*flush)(AVCodecContext *);
2295 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2296 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2298 * Descriptive name for the codec, meant to be more human readable than \p name.
2299 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2301 const char *long_name;
2302 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2303 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2307 * four components are given, that's all.
2308 * the last component is alpha
2310 typedef struct AVPicture {
2312 int linesize[4]; ///< number of bytes per line
2317 * This structure defines a method for communicating palette changes
2318 * between and demuxer and a decoder.
2320 * @deprecated Use AVPacket to send palette changes instead.
2321 * This is totally broken.
2323 #define AVPALETTE_SIZE 1024
2324 #define AVPALETTE_COUNT 256
2325 typedef struct AVPaletteControl {
2327 /* Demuxer sets this to 1 to indicate the palette has changed;
2328 * decoder resets to 0. */
2329 int palette_changed;
2331 /* 4-byte ARGB palette entries, stored in native byte order; note that
2332 * the individual palette components should be on a 8-bit scale; if
2333 * the palette data comes from an IBM VGA native format, the component
2334 * data is probably 6 bits in size and needs to be scaled. */
2335 unsigned int palette[AVPALETTE_COUNT];
2337 } AVPaletteControl attribute_deprecated;
2339 typedef struct AVSubtitleRect {
2346 uint32_t *rgba_palette;
2350 typedef struct AVSubtitle {
2351 uint16_t format; /* 0 = graphics */
2352 uint32_t start_display_time; /* relative to packet pts, in ms */
2353 uint32_t end_display_time; /* relative to packet pts, in ms */
2355 AVSubtitleRect *rects;
2361 struct ReSampleContext;
2362 struct AVResampleContext;
2364 typedef struct ReSampleContext ReSampleContext;
2366 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2367 int output_rate, int input_rate);
2368 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2369 void audio_resample_close(ReSampleContext *s);
2371 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2372 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2373 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2374 void av_resample_close(struct AVResampleContext *c);
2376 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2377 /* YUV420 format is assumed ! */
2380 * @deprecated Use the software scaler (swscale) instead.
2382 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2385 * @deprecated Use the software scaler (swscale) instead.
2387 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2388 int input_width, int input_height);
2391 * @deprecated Use the software scaler (swscale) instead.
2393 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2394 int iwidth, int iheight,
2395 int topBand, int bottomBand,
2396 int leftBand, int rightBand,
2397 int padtop, int padbottom,
2398 int padleft, int padright);
2401 * @deprecated Use the software scaler (swscale) instead.
2403 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2404 AVPicture *output, const AVPicture *input);
2407 * @deprecated Use the software scaler (swscale) instead.
2409 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2414 * Allocate memory for a picture. Call avpicture_free to free it.
2416 * @param picture the picture to be filled in
2417 * @param pix_fmt the format of the picture
2418 * @param width the width of the picture
2419 * @param height the height of the picture
2420 * @return zero if successful, a negative value if not
2422 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2425 * Free a picture previously allocated by avpicture_alloc().
2427 * @param picture the AVPicture to be freed
2429 void avpicture_free(AVPicture *picture);
2432 * Fill in the AVPicture fields.
2433 * The fields of the given AVPicture are filled in by using the 'ptr' address
2434 * which points to the image data buffer. Depending on the specified picture
2435 * format, one or multiple image data pointers and line sizes will be set.
2436 * If a planar format is specified, several pointers will be set pointing to
2437 * the different picture planes and the line sizes of the different planes
2438 * will be stored in the lines_sizes array.
2440 * @param picture AVPicture whose fields are to be filled in
2441 * @param ptr Buffer which will contain or contains the actual image data
2442 * @param pix_fmt The format in which the picture data is stored.
2443 * @param width the width of the image in pixels
2444 * @param height the height of the image in pixels
2445 * @return size of the image data in bytes
2447 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2448 int pix_fmt, int width, int height);
2449 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2450 unsigned char *dest, int dest_size);
2453 * Calculate the size in bytes that a picture of the given width and height
2454 * would occupy if stored in the given picture format.
2456 * @param pix_fmt the given picture format
2457 * @param width the width of the image
2458 * @param height the height of the image
2459 * @return Image data size in bytes
2461 int avpicture_get_size(int pix_fmt, int width, int height);
2462 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2463 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2464 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2465 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2466 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2468 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2469 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2470 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2471 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2472 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2473 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2476 * Computes what kind of losses will occur when converting from one specific
2477 * pixel format to another.
2478 * When converting from one pixel format to another, information loss may occur.
2479 * For example, when converting from RGB24 to GRAY, the color information will
2480 * be lost. Similarly, other losses occur when converting from some formats to
2481 * other formats. These losses can involve loss of chroma, but also loss of
2482 * resolution, loss of color depth, loss due to the color space conversion, loss
2483 * of the alpha bits or loss due to color quantization.
2484 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2485 * which will occur when converting from one pixel format to another.
2487 * @param[in] dst_pix_fmt destination pixel format
2488 * @param[in] src_pix_fmt source pixel format
2489 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2490 * @return Combination of flags informing you what kind of losses will occur.
2492 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2496 * Finds the best pixel format to convert to given a certain source pixel
2497 * format. When converting from one pixel format to another, information loss
2498 * may occur. For example, when converting from RGB24 to GRAY, the color
2499 * information will be lost. Similarly, other losses occur when converting from
2500 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2501 * the given pixel formats should be used to suffer the least amount of loss.
2502 * The pixel formats from which it chooses one, are determined by the
2503 * \p pix_fmt_mask parameter.
2506 * src_pix_fmt = PIX_FMT_YUV420P;
2507 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2508 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2511 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2512 * @param[in] src_pix_fmt source pixel format
2513 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2514 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2515 * @return The best pixel format to convert to or -1 if none was found.
2517 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2518 int has_alpha, int *loss_ptr);
2522 * Print in buf the string corresponding to the pixel format with
2523 * number pix_fmt, or an header if pix_fmt is negative.
2525 * @param[in] buf the buffer where to write the string
2526 * @param[in] buf_size the size of buf
2527 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2528 * a negative value to print the corresponding header.
2529 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2531 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2533 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2534 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2537 * Tell if an image really has transparent alpha values.
2538 * @return ored mask of FF_ALPHA_xxx constants
2540 int img_get_alpha_info(const AVPicture *src,
2541 int pix_fmt, int width, int height);
2543 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2545 * convert among pixel formats
2546 * @deprecated Use the software scaler (swscale) instead.
2548 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2549 const AVPicture *src, int pix_fmt,
2550 int width, int height);
2553 /* deinterlace a picture */
2554 /* deinterlace - if not supported return -1 */
2555 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2556 int pix_fmt, int width, int height);
2558 /* external high level API */
2560 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2561 extern AVCodec *first_avcodec;
2563 AVCodec *av_codec_next(AVCodec *c);
2566 * Returns the LIBAVCODEC_VERSION_INT constant.
2568 unsigned avcodec_version(void);
2570 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2571 /* returns LIBAVCODEC_BUILD constant */
2572 attribute_deprecated unsigned avcodec_build(void);
2576 * Initializes libavcodec.
2578 * @warning This function \e must be called before any other libavcodec
2581 void avcodec_init(void);
2583 void register_avcodec(AVCodec *format);
2586 * Finds a registered encoder with a matching codec ID.
2588 * @param id CodecID of the requested encoder
2589 * @return An encoder if one was found, NULL otherwise.
2591 AVCodec *avcodec_find_encoder(enum CodecID id);
2594 * Finds a registered encoder with the specified name.
2596 * @param name name of the requested encoder
2597 * @return An encoder if one was found, NULL otherwise.
2599 AVCodec *avcodec_find_encoder_by_name(const char *name);
2602 * Finds a registered decoder with a matching codec ID.
2604 * @param id CodecID of the requested decoder
2605 * @return A decoder if one was found, NULL otherwise.
2607 AVCodec *avcodec_find_decoder(enum CodecID id);
2610 * Finds a registered decoder with the specified name.
2612 * @param name name of the requested decoder
2613 * @return A decoder if one was found, NULL otherwise.
2615 AVCodec *avcodec_find_decoder_by_name(const char *name);
2616 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2619 * Sets the fields of the given AVCodecContext to default values.
2621 * @param s The AVCodecContext of which the fields should be set to default values.
2623 void avcodec_get_context_defaults(AVCodecContext *s);
2625 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2626 * we WILL change its arguments and name a few times! */
2627 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2630 * Allocates an AVCodecContext and sets its fields to default values. The
2631 * resulting struct can be deallocated by simply calling av_free().
2633 * @return An AVCodecContext filled with default values or NULL on failure.
2634 * @see avcodec_get_context_defaults
2636 AVCodecContext *avcodec_alloc_context(void);
2638 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2639 * we WILL change its arguments and name a few times! */
2640 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2643 * Sets the fields of the given AVFrame to default values.
2645 * @param pic The AVFrame of which the fields should be set to default values.
2647 void avcodec_get_frame_defaults(AVFrame *pic);
2650 * Allocates an AVFrame and sets its fields to default values. The resulting
2651 * struct can be deallocated by simply calling av_free().
2653 * @return An AVFrame filled with default values or NULL on failure.
2654 * @see avcodec_get_frame_defaults
2656 AVFrame *avcodec_alloc_frame(void);
2658 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2659 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2660 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2661 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2664 * Checks if the given dimension of a picture is valid, meaning that all
2665 * bytes of the picture can be addressed with a signed int.
2667 * @param[in] w Width of the picture.
2668 * @param[in] h Height of the picture.
2669 * @return Zero if valid, a negative value if invalid.
2671 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2672 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2674 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2675 void avcodec_thread_free(AVCodecContext *s);
2676 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2677 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2678 //FIXME func typedef
2681 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2682 * function the context has to be allocated.
2684 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2685 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2686 * retrieving a codec.
2688 * @warning This function is not thread safe!
2691 * avcodec_register_all();
2692 * codec = avcodec_find_decoder(CODEC_ID_H264);
2696 * context = avcodec_alloc_context();
2698 * if (avcodec_open(context, codec) < 0)
2702 * @param avctx The context which will be set up to use the given codec.
2703 * @param codec The codec to use within the context.
2704 * @return zero on success, a negative value on error
2705 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2707 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2710 * @deprecated Use avcodec_decode_audio2() instead.
2712 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2713 int *frame_size_ptr,
2714 const uint8_t *buf, int buf_size);
2717 * Decodes an audio frame from \p buf into \p samples.
2718 * The avcodec_decode_audio2() function decodes an audio frame from the input
2719 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2720 * audio codec which was coupled with \p avctx using avcodec_open(). The
2721 * resulting decoded frame is stored in output buffer \p samples. If no frame
2722 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2723 * decompressed frame size in \e bytes.
2725 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2726 * output buffer before calling avcodec_decode_audio2().
2728 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2729 * the actual read bytes because some optimized bitstream readers read 32 or 64
2730 * bits at once and could read over the end.
2732 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2733 * no overreading happens for damaged MPEG streams.
2735 * @note You might have to align the input buffer \p buf and output buffer \p
2736 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2737 * necessary at all, on others it won't work at all if not aligned and on others
2738 * it will work but it will have an impact on performance. In practice, the
2739 * bitstream should have 4 byte alignment at minimum and all sample data should
2740 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2741 * the linesize is not a multiple of 16 then there's no sense in aligning the
2742 * start of the buffer to 16.
2744 * @param avctx the codec context
2745 * @param[out] samples the output buffer
2746 * @param[in,out] frame_size_ptr the output buffer size in bytes
2747 * @param[in] buf the input buffer
2748 * @param[in] buf_size the input buffer size in bytes
2749 * @return On error a negative value is returned, otherwise the number of bytes
2750 * used or zero if no frame could be decompressed.
2752 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2753 int *frame_size_ptr,
2754 const uint8_t *buf, int buf_size);
2757 * Decodes a video frame from \p buf into \p picture.
2758 * The avcodec_decode_video() function decodes a video frame from the input
2759 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2760 * video codec which was coupled with \p avctx using avcodec_open(). The
2761 * resulting decoded frame is stored in \p picture.
2763 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2764 * the actual read bytes because some optimized bitstream readers read 32 or 64
2765 * bits at once and could read over the end.
2767 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2768 * no overreading happens for damaged MPEG streams.
2770 * @note You might have to align the input buffer \p buf and output buffer \p
2771 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2772 * necessary at all, on others it won't work at all if not aligned and on others
2773 * it will work but it will have an impact on performance. In practice, the
2774 * bitstream should have 4 byte alignment at minimum and all sample data should
2775 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2776 * the linesize is not a multiple of 16 then there's no sense in aligning the
2777 * start of the buffer to 16.
2779 * @param avctx the codec context
2780 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2781 * @param[in] buf the input buffer
2782 * @param[in] buf_size the size of the input buffer in bytes
2783 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2784 * @return On error a negative value is returned, otherwise the number of bytes
2785 * used or zero if no frame could be decompressed.
2787 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2788 int *got_picture_ptr,
2789 const uint8_t *buf, int buf_size);
2791 /* Decode a subtitle message. Return -1 if error, otherwise return the
2792 * number of bytes used. If no subtitle could be decompressed,
2793 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2794 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2796 const uint8_t *buf, int buf_size);
2797 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2799 uint8_t *buf, int buf_size);
2802 * Encodes an audio frame from \p samples into \p buf.
2803 * The avcodec_encode_audio() function encodes an audio frame from the input
2804 * buffer \p samples. To encode it, it makes use of the audio codec which was
2805 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2806 * stored in output buffer \p buf.
2808 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2810 * @param avctx the codec context
2811 * @param[out] buf the output buffer
2812 * @param[in] buf_size the output buffer size
2813 * @param[in] samples the input buffer containing the samples
2814 * The number of samples read from this buffer is frame_size*channels,
2815 * both of which are defined in \p avctx.
2816 * For PCM audio the number of samples read from \p samples is equal to
2817 * \p buf_size * input_sample_size / output_sample_size.
2818 * @return On error a negative value is returned, on success zero or the number
2819 * of bytes used to encode the data read from the input buffer.
2821 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2822 const short *samples);
2825 * Encodes a video frame from \p pict into \p buf.
2826 * The avcodec_encode_video() function encodes a video frame from the input
2827 * \p pict. To encode it, it makes use of the video codec which was coupled with
2828 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2829 * frame are stored in the output buffer \p buf. The input picture should be
2830 * stored using a specific format, namely \c avctx.pix_fmt.
2832 * @param avctx the codec context
2833 * @param[out] buf the output buffer for the bitstream of encoded frame
2834 * @param[in] buf_size the size of the output buffer in bytes
2835 * @param[in] pict the input picture to encode
2836 * @return On error a negative value is returned, on success zero or the number
2837 * of bytes used from the input buffer.
2839 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2840 const AVFrame *pict);
2841 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2842 const AVSubtitle *sub);
2844 int avcodec_close(AVCodecContext *avctx);
2846 void avcodec_register_all(void);
2849 * Flush buffers, should be called when seeking or when switching to a different stream.
2851 void avcodec_flush_buffers(AVCodecContext *avctx);
2853 void avcodec_default_free_buffers(AVCodecContext *s);
2855 /* misc useful functions */
2858 * Returns a single letter to describe the given picture type \p pict_type.
2860 * @param[in] pict_type the picture type
2861 * @return A single character representing the picture type.
2863 char av_get_pict_type_char(int pict_type);
2866 * Returns codec bits per sample.
2868 * @param[in] codec_id the codec
2869 * @return Number of bits per sample or zero if unknown for the given codec.
2871 int av_get_bits_per_sample(enum CodecID codec_id);
2874 * Returns sample format bits per sample.
2876 * @param[in] sample_fmt the sample format
2877 * @return Number of bits per sample or zero if unknown for the given sample format.
2879 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2882 typedef struct AVCodecParserContext {
2884 struct AVCodecParser *parser;
2885 int64_t frame_offset; /* offset of the current frame */
2886 int64_t cur_offset; /* current offset
2887 (incremented by each av_parser_parse()) */
2888 int64_t next_frame_offset; /* offset of the next frame */
2890 int pict_type; /* XXX: Put it back in AVCodecContext. */
2891 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2892 int64_t pts; /* pts of the current frame */
2893 int64_t dts; /* dts of the current frame */
2898 int fetch_timestamp;
2900 #define AV_PARSER_PTS_NB 4
2901 int cur_frame_start_index;
2902 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2903 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2904 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2907 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2909 int64_t offset; ///< byte offset from starting packet start
2910 int64_t cur_frame_end[AV_PARSER_PTS_NB];
2911 } AVCodecParserContext;
2913 typedef struct AVCodecParser {
2914 int codec_ids[5]; /* several codec IDs are permitted */
2916 int (*parser_init)(AVCodecParserContext *s);
2917 int (*parser_parse)(AVCodecParserContext *s,
2918 AVCodecContext *avctx,
2919 const uint8_t **poutbuf, int *poutbuf_size,
2920 const uint8_t *buf, int buf_size);
2921 void (*parser_close)(AVCodecParserContext *s);
2922 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2923 struct AVCodecParser *next;
2926 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2927 extern AVCodecParser *av_first_parser;
2929 AVCodecParser *av_parser_next(AVCodecParser *c);
2931 void av_register_codec_parser(AVCodecParser *parser);
2932 AVCodecParserContext *av_parser_init(int codec_id);
2933 int av_parser_parse(AVCodecParserContext *s,
2934 AVCodecContext *avctx,
2935 uint8_t **poutbuf, int *poutbuf_size,
2936 const uint8_t *buf, int buf_size,
2937 int64_t pts, int64_t dts);
2938 int av_parser_change(AVCodecParserContext *s,
2939 AVCodecContext *avctx,
2940 uint8_t **poutbuf, int *poutbuf_size,
2941 const uint8_t *buf, int buf_size, int keyframe);
2942 void av_parser_close(AVCodecParserContext *s);
2945 typedef struct AVBitStreamFilterContext {
2947 struct AVBitStreamFilter *filter;
2948 AVCodecParserContext *parser;
2949 struct AVBitStreamFilterContext *next;
2950 } AVBitStreamFilterContext;
2953 typedef struct AVBitStreamFilter {
2956 int (*filter)(AVBitStreamFilterContext *bsfc,
2957 AVCodecContext *avctx, const char *args,
2958 uint8_t **poutbuf, int *poutbuf_size,
2959 const uint8_t *buf, int buf_size, int keyframe);
2960 void (*close)(AVBitStreamFilterContext *bsfc);
2961 struct AVBitStreamFilter *next;
2962 } AVBitStreamFilter;
2964 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2965 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2966 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2967 AVCodecContext *avctx, const char *args,
2968 uint8_t **poutbuf, int *poutbuf_size,
2969 const uint8_t *buf, int buf_size, int keyframe);
2970 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2972 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2977 * Reallocates the given block if it is not large enough, otherwise it
2982 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2985 * Copy image 'src' to 'dst'.
2987 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2988 int pix_fmt, int width, int height);
2991 * Crop image top and left side.
2993 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2994 int pix_fmt, int top_band, int left_band);
2999 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3000 int padtop, int padbottom, int padleft, int padright, int *color);
3002 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
3004 * @deprecated Use the software scaler (swscale) instead.
3006 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
3007 int pix_fmt, int width, int height);
3010 * @deprecated Use the software scaler (swscale) instead.
3012 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
3013 int pix_fmt, int top_band, int left_band);
3016 * @deprecated Use the software scaler (swscale) instead.
3018 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3019 int padtop, int padbottom, int padleft, int padright, int *color);
3022 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3025 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3027 * @return 0 in case of a successful parsing, a negative value otherwise
3028 * @param[in] str the string to parse: it has to be a string in the format
3029 * <width>x<height> or a valid video frame size abbreviation.
3030 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3032 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3033 * frame height value
3035 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3038 * Parses \p str and put in \p frame_rate the detected values.
3040 * @return 0 in case of a successful parsing, a negative value otherwise
3041 * @param[in] str the string to parse: it has to be a string in the format
3042 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
3043 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3046 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3049 * Logs a generic warning message about a missing feature.
3050 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3051 * a pointer to an AVClass struct
3052 * @param[in] feature string containing the name of the missing feature
3053 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3054 * If \p want_sample is non-zero, additional verbage will be added to the log
3055 * message which tells the user how to report samples to the development
3058 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
3060 /* error handling */
3062 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3063 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3065 /* Some platforms have E* and errno already negated. */
3066 #define AVERROR(e) (e)
3067 #define AVUNERROR(e) (e)
3069 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3070 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3071 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3072 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3073 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3074 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3075 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3076 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3077 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3079 #endif /* AVCODEC_AVCODEC_H */