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 FFMPEG_AVCODEC_H
22 #define FFMPEG_AVCODEC_H
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 51
33 #define LIBAVCODEC_VERSION_MINOR 60
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,
192 /* various PCM "codecs" */
193 CODEC_ID_PCM_S16LE= 0x10000,
209 CODEC_ID_PCM_S24DAUD,
211 CODEC_ID_PCM_S16LE_PLANAR,
214 /* various ADPCM codecs */
215 CODEC_ID_ADPCM_IMA_QT= 0x11000,
216 CODEC_ID_ADPCM_IMA_WAV,
217 CODEC_ID_ADPCM_IMA_DK3,
218 CODEC_ID_ADPCM_IMA_DK4,
219 CODEC_ID_ADPCM_IMA_WS,
220 CODEC_ID_ADPCM_IMA_SMJPEG,
229 CODEC_ID_ADPCM_YAMAHA,
230 CODEC_ID_ADPCM_SBPRO_4,
231 CODEC_ID_ADPCM_SBPRO_3,
232 CODEC_ID_ADPCM_SBPRO_2,
234 CODEC_ID_ADPCM_IMA_AMV,
235 CODEC_ID_ADPCM_EA_R1,
236 CODEC_ID_ADPCM_EA_R3,
237 CODEC_ID_ADPCM_EA_R2,
238 CODEC_ID_ADPCM_IMA_EA_SEAD,
239 CODEC_ID_ADPCM_IMA_EA_EACS,
240 CODEC_ID_ADPCM_EA_XAS,
241 CODEC_ID_ADPCM_EA_MAXIS_XA,
244 CODEC_ID_AMR_NB= 0x12000,
247 /* RealAudio codecs*/
248 CODEC_ID_RA_144= 0x13000,
251 /* various DPCM codecs */
252 CODEC_ID_ROQ_DPCM= 0x14000,
253 CODEC_ID_INTERPLAY_DPCM,
258 CODEC_ID_MP2= 0x15000,
259 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
261 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
280 CODEC_ID_WESTWOOD_SND1,
281 CODEC_ID_GSM, ///< as in Berlin toast format
289 CODEC_ID_DSICINAUDIO,
293 CODEC_ID_GSM_MS, /* as found in WAV */
302 CODEC_ID_WMALOSSLESS,
305 /* subtitle codecs */
306 CODEC_ID_DVD_SUBTITLE= 0x17000,
307 CODEC_ID_DVB_SUBTITLE,
308 CODEC_ID_TEXT, ///< raw UTF-8 text
313 /* other specific kind of codecs (generally used for attachments) */
314 CODEC_ID_TTF= 0x18000,
316 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
318 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
319 * stream (only used by libavformat) */
322 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
323 /* CODEC_ID_MP3LAME is obsolete */
324 #define CODEC_ID_MP3LAME CODEC_ID_MP3
325 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
329 CODEC_TYPE_UNKNOWN = -1,
334 CODEC_TYPE_ATTACHMENT,
339 * Currently unused, may be used if 24/32 bits samples are ever supported.
340 * all in native-endian format
343 SAMPLE_FMT_NONE = -1,
344 SAMPLE_FMT_U8, ///< unsigned 8 bits
345 SAMPLE_FMT_S16, ///< signed 16 bits
346 SAMPLE_FMT_S24, ///< signed 24 bits
347 SAMPLE_FMT_S32, ///< signed 32 bits
348 SAMPLE_FMT_FLT, ///< float
352 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
355 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
356 * This is mainly needed because some optimized bitstream readers read
357 * 32 or 64 bit at once and could read over the end.<br>
358 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
359 * MPEG bitstreams could cause overread and segfault.
361 #define FF_INPUT_BUFFER_PADDING_SIZE 8
364 * minimum encoding buffer size
365 * Used to avoid some checks during header writing.
367 #define FF_MIN_BUFFER_SIZE 16384
370 * motion estimation type.
373 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
377 ME_EPZS, ///< enhanced predictive zonal search
378 ME_X1, ///< reserved for experiments
379 ME_HEX, ///< hexagon based search
380 ME_UMH, ///< uneven multi-hexagon search
381 ME_ITER, ///< iterative search
382 ME_TESA, ///< transformed exhaustive search algorithm
386 /* We leave some space between them for extensions (drop some
387 * keyframes for intra-only or drop just some bidir frames). */
388 AVDISCARD_NONE =-16, ///< discard nothing
389 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
390 AVDISCARD_NONREF = 8, ///< discard all non reference
391 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
392 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
393 AVDISCARD_ALL = 48, ///< discard all
396 typedef struct RcOverride{
399 int qscale; // If this is 0 then quality_factor will be used instead.
400 float quality_factor;
403 #define FF_MAX_B_FRAMES 16
406 These flags can be passed in AVCodecContext.flags before initialization.
407 Note: Not everything is supported yet.
410 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
411 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
412 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
413 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
414 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
415 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
417 * The parent program guarantees that the input for B-frames containing
418 * streams is not written to for at least s->max_b_frames+1 frames, if
419 * this is not set the input will be copied.
421 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
422 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
423 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
424 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
425 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
426 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
427 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
428 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
429 location instead of only at frame boundaries. */
430 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
431 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
432 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
433 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
434 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
435 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
437 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
438 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
439 /* Fx : Flag for h263+ extra options */
440 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
441 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
443 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
444 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
445 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
446 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
447 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
448 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
449 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
450 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
451 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
452 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
453 #define CODEC_FLAG_CLOSED_GOP 0x80000000
454 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
455 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
456 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
457 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
458 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
459 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
460 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
461 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
462 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
463 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
464 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
465 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
466 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
467 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
468 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
469 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
470 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
471 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
473 /* Unsupported options :
474 * Syntax Arithmetic coding (SAC)
475 * Reference Picture Selection
476 * Independent Segment Decoding */
478 /* codec capabilities */
480 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
482 * Codec uses get_buffer() for allocating buffers.
483 * direct rendering method 1
485 #define CODEC_CAP_DR1 0x0002
486 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
487 #define CODEC_CAP_PARSE_ONLY 0x0004
488 #define CODEC_CAP_TRUNCATED 0x0008
489 /* Codec can export data for HW decoding (XvMC). */
490 #define CODEC_CAP_HWACCEL 0x0010
492 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
493 * If this is not set, the codec is guaranteed to never be fed with NULL data.
495 #define CODEC_CAP_DELAY 0x0020
497 * Codec can be fed a final frame with a smaller size.
498 * This can be used to prevent truncation of the last audio samples.
500 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
502 //The following defines may change, don't expect compatibility if you use them.
503 #define MB_TYPE_INTRA4x4 0x0001
504 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
505 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
506 #define MB_TYPE_16x16 0x0008
507 #define MB_TYPE_16x8 0x0010
508 #define MB_TYPE_8x16 0x0020
509 #define MB_TYPE_8x8 0x0040
510 #define MB_TYPE_INTERLACED 0x0080
511 #define MB_TYPE_DIRECT2 0x0100 //FIXME
512 #define MB_TYPE_ACPRED 0x0200
513 #define MB_TYPE_GMC 0x0400
514 #define MB_TYPE_SKIP 0x0800
515 #define MB_TYPE_P0L0 0x1000
516 #define MB_TYPE_P1L0 0x2000
517 #define MB_TYPE_P0L1 0x4000
518 #define MB_TYPE_P1L1 0x8000
519 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
520 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
521 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
522 #define MB_TYPE_QUANT 0x00010000
523 #define MB_TYPE_CBP 0x00020000
524 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
528 * This specifies the area which should be displayed.
529 * Note there may be multiple such areas for one frame.
531 typedef struct AVPanScan{
534 * - encoding: Set by user.
535 * - decoding: Set by libavcodec.
540 * width and height in 1/16 pel
541 * - encoding: Set by user.
542 * - decoding: Set by libavcodec.
548 * position of the top left corner in 1/16 pel for up to 3 fields/frames
549 * - encoding: Set by user.
550 * - decoding: Set by libavcodec.
552 int16_t position[3][2];
555 #define FF_COMMON_FRAME \
557 * pointer to the picture planes.\
558 * This might be different from the first allocated byte\
565 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
566 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
572 * 1 -> keyframe, 0-> not\
573 * - encoding: Set by libavcodec.\
574 * - decoding: Set by libavcodec.\
579 * Picture type of the frame, see ?_TYPE below.\
580 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
581 * - decoding: Set by libavcodec.\
586 * presentation timestamp in time_base units (time when frame should be shown to user)\
587 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
588 * - encoding: MUST be set by user.\
589 * - decoding: Set by libavcodec.\
594 * picture number in bitstream order\
595 * - encoding: set by\
596 * - decoding: Set by libavcodec.\
598 int coded_picture_number;\
600 * picture number in display order\
601 * - encoding: set by\
602 * - decoding: Set by libavcodec.\
604 int display_picture_number;\
607 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
608 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
609 * - decoding: Set by libavcodec.\
614 * buffer age (1->was last buffer and dint change, 2->..., ...).\
615 * Set to INT_MAX if the buffer has not been used yet.\
616 * - encoding: unused\
617 * - decoding: MUST be set by get_buffer().\
622 * is this picture used as reference\
623 * The values for this are the same as the MpegEncContext.picture_structure\
624 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
625 * - encoding: unused\
626 * - decoding: Set by libavcodec. (before get_buffer() call)).\
632 * - encoding: unused\
633 * - decoding: Set by libavcodec.\
635 int8_t *qscale_table;\
638 * - encoding: unused\
639 * - decoding: Set by libavcodec.\
644 * mbskip_table[mb]>=1 if MB didn't change\
645 * stride= mb_width = (width+15)>>4\
646 * - encoding: unused\
647 * - decoding: Set by libavcodec.\
649 uint8_t *mbskip_table;\
652 * motion vector table\
655 * int mv_sample_log2= 4 - motion_subsample_log2;\
656 * int mb_width= (width+15)>>4;\
657 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
658 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
660 * - encoding: Set by user.\
661 * - decoding: Set by libavcodec.\
663 int16_t (*motion_val[2])[2];\
666 * macroblock type table\
667 * mb_type_base + mb_width + 2\
668 * - encoding: Set by user.\
669 * - decoding: Set by libavcodec.\
674 * log2 of the size of the block which a single vector in motion_val represents: \
675 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
676 * - encoding: unused\
677 * - decoding: Set by libavcodec.\
679 uint8_t motion_subsample_log2;\
682 * for some private data of the user\
683 * - encoding: unused\
684 * - decoding: Set by user.\
690 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
691 * - decoding: unused\
696 * type of the buffer (to keep track of who has to deallocate data[*])\
697 * - encoding: Set by the one who allocates it.\
698 * - decoding: Set by the one who allocates it.\
699 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
704 * When decoding, this signals how much the picture must be delayed.\
705 * extra_delay = repeat_pict / (2*fps)\
706 * - encoding: unused\
707 * - decoding: Set by libavcodec.\
717 * The content of the picture is interlaced.\
718 * - encoding: Set by user.\
719 * - decoding: Set by libavcodec. (default 0)\
721 int interlaced_frame;\
724 * If the content is interlaced, is top field displayed first.\
725 * - encoding: Set by user.\
726 * - decoding: Set by libavcodec.\
728 int top_field_first;\
732 * - encoding: Set by user.\
733 * - decoding: Set by libavcodec.\
735 AVPanScan *pan_scan;\
738 * Tell user application that palette has changed from previous frame.\
739 * - encoding: ??? (no palette-enabled encoder yet)\
740 * - decoding: Set by libavcodec. (default 0).\
742 int palette_has_changed;\
745 * codec suggestion on buffer type if != 0\
746 * - encoding: unused\
747 * - decoding: Set by libavcodec. (before get_buffer() call)).\
753 * - encoding: unused\
754 * - decoding: Set by libavcodec.\
759 * motion referece frame index\
760 * - encoding: Set by user.\
761 * - decoding: Set by libavcodec.\
763 int8_t *ref_index[2];
765 #define FF_QSCALE_TYPE_MPEG1 0
766 #define FF_QSCALE_TYPE_MPEG2 1
767 #define FF_QSCALE_TYPE_H264 2
769 #define FF_BUFFER_TYPE_INTERNAL 1
770 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
771 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
772 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
775 #define FF_I_TYPE 1 ///< Intra
776 #define FF_P_TYPE 2 ///< Predicted
777 #define FF_B_TYPE 3 ///< Bi-dir predicted
778 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
779 #define FF_SI_TYPE 5 ///< Switching Intra
780 #define FF_SP_TYPE 6 ///< Switching Predicted
783 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
784 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
785 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
786 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
790 * New fields can be added to the end of FF_COMMON_FRAME with minor version
792 * Removal, reordering and changes to existing fields require a major
793 * version bump. No fields should be added into AVFrame before or after
795 * sizeof(AVFrame) must not be used outside libav*.
797 typedef struct AVFrame {
801 #define DEFAULT_FRAME_RATE_BASE 1001000
804 * main external API structure.
805 * New fields can be added to the end with minor version bumps.
806 * Removal, reordering and changes to existing fields require a major
808 * sizeof(AVCodecContext) must not be used outside libav*.
810 typedef struct AVCodecContext {
812 * information on struct for av_log
813 * - set by avcodec_alloc_context
815 const AVClass *av_class;
817 * the average bitrate
818 * - encoding: Set by user; unused for constant quantizer encoding.
819 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
824 * number of bits the bitstream is allowed to diverge from the reference.
825 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
826 * - encoding: Set by user; unused for constant quantizer encoding.
829 int bit_rate_tolerance;
833 * - encoding: Set by user.
834 * - decoding: Set by user.
839 * Some codecs need additional format info. It is stored here.
840 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
841 * specific codec MUST set it correctly otherwise stream copy breaks.
842 * In general use of this field by muxers is not recommanded.
843 * - encoding: Set by libavcodec.
844 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
849 * Motion estimation algorithm used for video coding.
850 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
851 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
852 * - encoding: MUST be set by user.
858 * some codecs need / can use extradata like Huffman tables.
859 * mjpeg: Huffman tables
860 * rv10: additional flags
861 * mpeg4: global headers (they can be in the bitstream or here)
862 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
863 * than extradata_size to avoid prolems if it is read with the bitstream reader.
864 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
865 * - encoding: Set/allocated/freed by libavcodec.
866 * - decoding: Set/allocated/freed by user.
872 * This is the fundamental unit of time (in seconds) in terms
873 * of which frame timestamps are represented. For fixed-fps content,
874 * timebase should be 1/framerate and timestamp increments should be
876 * - encoding: MUST be set by user.
877 * - decoding: Set by libavcodec.
879 AVRational time_base;
883 * picture width / height.
884 * - encoding: MUST be set by user.
885 * - decoding: Set by libavcodec.
886 * Note: For compatibility it is possible to set this instead of
887 * coded_width/height before decoding.
891 #define FF_ASPECT_EXTENDED 15
894 * the number of pictures in a group of pictures, or 0 for intra_only
895 * - encoding: Set by user.
901 * Pixel format, see PIX_FMT_xxx.
902 * - encoding: Set by user.
903 * - decoding: Set by libavcodec.
905 enum PixelFormat pix_fmt;
908 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
909 * has to read frames at native frame rate.
910 * - encoding: Set by user.
916 * If non NULL, 'draw_horiz_band' is called by the libavcodec
917 * decoder to draw a horizontal band. It improves cache usage. Not
918 * all codecs can do that. You must check the codec capabilities
921 * - decoding: Set by user.
922 * @param height the height of the slice
923 * @param y the y position of the slice
924 * @param type 1->top field, 2->bottom field, 3->frame
925 * @param offset offset into the AVFrame.data from which the slice should be read
927 void (*draw_horiz_band)(struct AVCodecContext *s,
928 const AVFrame *src, int offset[4],
929 int y, int type, int height);
932 int sample_rate; ///< samples per second
933 int channels; ///< number of audio channels
936 * audio sample format
937 * - encoding: Set by user.
938 * - decoding: Set by libavcodec.
940 enum SampleFormat sample_fmt; ///< sample format, currently unused
942 /* The following data should not be initialized. */
944 * Samples per packet, initialized when calling 'init'.
947 int frame_number; ///< audio or video frame number
948 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
951 * Number of frames the decoded output will be delayed relative to
953 * - encoding: Set by libavcodec.
958 /* - encoding parameters */
959 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
960 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
964 * - encoding: Set by user.
971 * - encoding: Set by user.
977 * maximum quantizer difference between frames
978 * - encoding: Set by user.
984 * maximum number of B-frames between non-B-frames
985 * Note: The output will be delayed by max_b_frames+1 relative to the input.
986 * - encoding: Set by user.
992 * qscale factor between IP and B-frames
993 * - encoding: Set by user.
996 float b_quant_factor;
998 /** obsolete FIXME remove */
1000 #define FF_RC_STRATEGY_XVID 1
1002 int b_frame_strategy;
1006 * - encoding: unused
1007 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1008 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1012 struct AVCodec *codec;
1016 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1017 /* unused, FIXME remove*/
1021 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1022 /* do its best to deliver a chunk with size */
1023 /* below rtp_payload_size, the chunk will start */
1024 /* with a start code on some codecs like H.263. */
1025 /* This doesn't take account of any particular */
1026 /* headers inside the transmitted RTP payload. */
1029 /* The RTP callback: This function is called */
1030 /* every time the encoder has a packet to send. */
1031 /* It depends on the encoder if the data starts */
1032 /* with a Start Code (it should). H.263 does. */
1033 /* mb_nb contains the number of macroblocks */
1034 /* encoded in the RTP payload. */
1035 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1037 /* statistics, used for 2-pass encoding */
1048 * number of bits used for the previously encoded frame
1049 * - encoding: Set by libavcodec.
1050 * - decoding: unused
1055 * Private data of the user, can be used to carry app specific stuff.
1056 * - encoding: Set by user.
1057 * - decoding: Set by user.
1061 char codec_name[32];
1062 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1063 enum CodecID codec_id; /* see CODEC_ID_xxx */
1066 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1067 * This is used to work around some encoder bugs.
1068 * A demuxer should set this to what is stored in the field used to identify the codec.
1069 * If there are multiple such fields in a container then the demuxer should choose the one
1070 * which maximizes the information about the used codec.
1071 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1072 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1073 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1075 * - encoding: Set by user, if not then the default based on codec_id will be used.
1076 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1078 unsigned int codec_tag;
1081 * Work around bugs in encoders which sometimes cannot be detected automatically.
1082 * - encoding: Set by user
1083 * - decoding: Set by user
1085 int workaround_bugs;
1086 #define FF_BUG_AUTODETECT 1 ///< autodetection
1087 #define FF_BUG_OLD_MSMPEG4 2
1088 #define FF_BUG_XVID_ILACE 4
1089 #define FF_BUG_UMP4 8
1090 #define FF_BUG_NO_PADDING 16
1091 #define FF_BUG_AMV 32
1092 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1093 #define FF_BUG_QPEL_CHROMA 64
1094 #define FF_BUG_STD_QPEL 128
1095 #define FF_BUG_QPEL_CHROMA2 256
1096 #define FF_BUG_DIRECT_BLOCKSIZE 512
1097 #define FF_BUG_EDGE 1024
1098 #define FF_BUG_HPEL_CHROMA 2048
1099 #define FF_BUG_DC_CLIP 4096
1100 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1101 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1104 * luma single coefficient elimination threshold
1105 * - encoding: Set by user.
1106 * - decoding: unused
1108 int luma_elim_threshold;
1111 * chroma single coeff elimination threshold
1112 * - encoding: Set by user.
1113 * - decoding: unused
1115 int chroma_elim_threshold;
1118 * strictly follow the standard (MPEG4, ...).
1119 * - encoding: Set by user.
1120 * - decoding: unused
1122 int strict_std_compliance;
1123 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1124 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1125 #define FF_COMPLIANCE_NORMAL 0
1126 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1127 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1130 * qscale offset between IP and B-frames
1131 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1132 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1133 * - encoding: Set by user.
1134 * - decoding: unused
1136 float b_quant_offset;
1139 * Error resilience; higher values will detect more errors but may
1140 * misdetect some more or less valid parts as errors.
1141 * - encoding: unused
1142 * - decoding: Set by user.
1144 int error_resilience;
1145 #define FF_ER_CAREFUL 1
1146 #define FF_ER_COMPLIANT 2
1147 #define FF_ER_AGGRESSIVE 3
1148 #define FF_ER_VERY_AGGRESSIVE 4
1151 * Called at the beginning of each frame to get a buffer for it.
1152 * If pic.reference is set then the frame will be read later by libavcodec.
1153 * avcodec_align_dimensions() should be used to find the required width and
1154 * height, as they normally need to be rounded up to the next multiple of 16.
1155 * - encoding: unused
1156 * - decoding: Set by libavcodec., user can override.
1158 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1161 * Called to release buffers which were allocated with get_buffer.
1162 * A released buffer can be reused in get_buffer().
1163 * pic.data[*] must be set to NULL.
1164 * - encoding: unused
1165 * - decoding: Set by libavcodec., user can override.
1167 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1170 * If 1 the stream has a 1 frame delay during decoding.
1171 * - encoding: Set by libavcodec.
1172 * - decoding: Set by libavcodec.
1177 * number of bytes per packet if constant and known or 0
1178 * Used by some WAV based audio codecs.
1182 int parse_only; /* - decoding only: If true, only parsing is done
1183 (function avcodec_parse_frame()). The frame
1184 data is returned. Only MPEG codecs support this now. */
1187 * 0-> h263 quant 1-> mpeg quant
1188 * - encoding: Set by user.
1189 * - decoding: unused
1194 * pass1 encoding statistics output buffer
1195 * - encoding: Set by libavcodec.
1196 * - decoding: unused
1201 * pass2 encoding statistics input buffer
1202 * Concatenated stuff from stats_out of pass1 should be placed here.
1203 * - encoding: Allocated/set/freed by user.
1204 * - decoding: unused
1209 * ratecontrol qmin qmax limiting method
1210 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1211 * - encoding: Set by user.
1212 * - decoding: unused
1220 * ratecontrol override, see RcOverride
1221 * - encoding: Allocated/set/freed by user.
1222 * - decoding: unused
1224 RcOverride *rc_override;
1225 int rc_override_count;
1228 * rate control equation
1229 * - encoding: Set by user
1230 * - decoding: unused
1236 * - encoding: Set by user.
1237 * - decoding: unused
1243 * - encoding: Set by user.
1244 * - decoding: unused
1249 * decoder bitstream buffer size
1250 * - encoding: Set by user.
1251 * - decoding: unused
1254 float rc_buffer_aggressivity;
1257 * qscale factor between P and I-frames
1258 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1259 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1260 * - encoding: Set by user.
1261 * - decoding: unused
1263 float i_quant_factor;
1266 * qscale offset between P and I-frames
1267 * - encoding: Set by user.
1268 * - decoding: unused
1270 float i_quant_offset;
1273 * initial complexity for pass1 ratecontrol
1274 * - encoding: Set by user.
1275 * - decoding: unused
1277 float rc_initial_cplx;
1280 * DCT algorithm, see FF_DCT_* below
1281 * - encoding: Set by user.
1282 * - decoding: unused
1285 #define FF_DCT_AUTO 0
1286 #define FF_DCT_FASTINT 1
1287 #define FF_DCT_INT 2
1288 #define FF_DCT_MMX 3
1289 #define FF_DCT_MLIB 4
1290 #define FF_DCT_ALTIVEC 5
1291 #define FF_DCT_FAAN 6
1294 * luminance masking (0-> disabled)
1295 * - encoding: Set by user.
1296 * - decoding: unused
1301 * temporary complexity masking (0-> disabled)
1302 * - encoding: Set by user.
1303 * - decoding: unused
1305 float temporal_cplx_masking;
1308 * spatial complexity masking (0-> disabled)
1309 * - encoding: Set by user.
1310 * - decoding: unused
1312 float spatial_cplx_masking;
1315 * p block masking (0-> disabled)
1316 * - encoding: Set by user.
1317 * - decoding: unused
1322 * darkness masking (0-> disabled)
1323 * - encoding: Set by user.
1324 * - decoding: unused
1329 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1330 /* for binary compatibility */
1335 * IDCT algorithm, see FF_IDCT_* below.
1336 * - encoding: Set by user.
1337 * - decoding: Set by user.
1340 #define FF_IDCT_AUTO 0
1341 #define FF_IDCT_INT 1
1342 #define FF_IDCT_SIMPLE 2
1343 #define FF_IDCT_SIMPLEMMX 3
1344 #define FF_IDCT_LIBMPEG2MMX 4
1345 #define FF_IDCT_PS2 5
1346 #define FF_IDCT_MLIB 6
1347 #define FF_IDCT_ARM 7
1348 #define FF_IDCT_ALTIVEC 8
1349 #define FF_IDCT_SH4 9
1350 #define FF_IDCT_SIMPLEARM 10
1351 #define FF_IDCT_H264 11
1352 #define FF_IDCT_VP3 12
1353 #define FF_IDCT_IPP 13
1354 #define FF_IDCT_XVIDMMX 14
1355 #define FF_IDCT_CAVS 15
1356 #define FF_IDCT_SIMPLEARMV5TE 16
1357 #define FF_IDCT_SIMPLEARMV6 17
1358 #define FF_IDCT_SIMPLEVIS 18
1359 #define FF_IDCT_WMV2 19
1360 #define FF_IDCT_FAAN 20
1364 * - encoding: Set by libavcodec.
1365 * - decoding: Set by user (or 0).
1369 * slice offsets in the frame in bytes
1370 * - encoding: Set/allocated by libavcodec.
1371 * - decoding: Set/allocated by user (or NULL).
1376 * error concealment flags
1377 * - encoding: unused
1378 * - decoding: Set by user.
1380 int error_concealment;
1381 #define FF_EC_GUESS_MVS 1
1382 #define FF_EC_DEBLOCK 2
1385 * dsp_mask could be add used to disable unwanted CPU features
1386 * CPU features (i.e. MMX, SSE. ...)
1388 * With the FORCE flag you may instead enable given CPU features.
1389 * (Dangerous: Usable in case of misdetection, improper usage however will
1390 * result into program crash.)
1393 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1394 /* lower 16 bits - CPU features */
1395 #define FF_MM_MMX 0x0001 ///< standard MMX
1396 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1397 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1398 #define FF_MM_SSE 0x0008 ///< SSE functions
1399 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1400 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1401 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1402 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1403 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1406 * bits per sample/pixel from the demuxer (needed for huffyuv).
1407 * - encoding: Set by libavcodec.
1408 * - decoding: Set by user.
1410 int bits_per_sample;
1413 * prediction method (needed for huffyuv)
1414 * - encoding: Set by user.
1415 * - decoding: unused
1417 int prediction_method;
1418 #define FF_PRED_LEFT 0
1419 #define FF_PRED_PLANE 1
1420 #define FF_PRED_MEDIAN 2
1423 * sample aspect ratio (0 if unknown)
1424 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1425 * - encoding: Set by user.
1426 * - decoding: Set by libavcodec.
1428 AVRational sample_aspect_ratio;
1431 * the picture in the bitstream
1432 * - encoding: Set by libavcodec.
1433 * - decoding: Set by libavcodec.
1435 AVFrame *coded_frame;
1439 * - encoding: Set by user.
1440 * - decoding: Set by user.
1443 #define FF_DEBUG_PICT_INFO 1
1444 #define FF_DEBUG_RC 2
1445 #define FF_DEBUG_BITSTREAM 4
1446 #define FF_DEBUG_MB_TYPE 8
1447 #define FF_DEBUG_QP 16
1448 #define FF_DEBUG_MV 32
1449 #define FF_DEBUG_DCT_COEFF 0x00000040
1450 #define FF_DEBUG_SKIP 0x00000080
1451 #define FF_DEBUG_STARTCODE 0x00000100
1452 #define FF_DEBUG_PTS 0x00000200
1453 #define FF_DEBUG_ER 0x00000400
1454 #define FF_DEBUG_MMCO 0x00000800
1455 #define FF_DEBUG_BUGS 0x00001000
1456 #define FF_DEBUG_VIS_QP 0x00002000
1457 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1461 * - encoding: Set by user.
1462 * - decoding: Set by user.
1465 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1466 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1467 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1471 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1472 * - decoding: unused
1477 * minimum MB quantizer
1478 * - encoding: unused
1479 * - decoding: unused
1484 * maximum MB quantizer
1485 * - encoding: unused
1486 * - decoding: unused
1491 * motion estimation comparison function
1492 * - encoding: Set by user.
1493 * - decoding: unused
1497 * subpixel motion estimation comparison function
1498 * - encoding: Set by user.
1499 * - decoding: unused
1503 * macroblock comparison function (not supported yet)
1504 * - encoding: Set by user.
1505 * - decoding: unused
1509 * interlaced DCT comparison function
1510 * - encoding: Set by user.
1511 * - decoding: unused
1514 #define FF_CMP_SAD 0
1515 #define FF_CMP_SSE 1
1516 #define FF_CMP_SATD 2
1517 #define FF_CMP_DCT 3
1518 #define FF_CMP_PSNR 4
1519 #define FF_CMP_BIT 5
1521 #define FF_CMP_ZERO 7
1522 #define FF_CMP_VSAD 8
1523 #define FF_CMP_VSSE 9
1524 #define FF_CMP_NSSE 10
1525 #define FF_CMP_W53 11
1526 #define FF_CMP_W97 12
1527 #define FF_CMP_DCTMAX 13
1528 #define FF_CMP_DCT264 14
1529 #define FF_CMP_CHROMA 256
1532 * ME diamond size & shape
1533 * - encoding: Set by user.
1534 * - decoding: unused
1539 * amount of previous MV predictors (2a+1 x 2a+1 square)
1540 * - encoding: Set by user.
1541 * - decoding: unused
1543 int last_predictor_count;
1546 * prepass for motion estimation
1547 * - encoding: Set by user.
1548 * - decoding: unused
1553 * motion estimation prepass comparison function
1554 * - encoding: Set by user.
1555 * - decoding: unused
1560 * ME prepass diamond size & shape
1561 * - encoding: Set by user.
1562 * - decoding: unused
1568 * - encoding: Set by user.
1569 * - decoding: unused
1571 int me_subpel_quality;
1574 * callback to negotiate the pixelFormat
1575 * @param fmt is the list of formats which are supported by the codec,
1576 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1577 * The first is always the native one.
1578 * @return the chosen format
1579 * - encoding: unused
1580 * - decoding: Set by user, if not set the native format will be chosen.
1582 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1585 * DTG active format information (additional aspect ratio
1586 * information only used in DVB MPEG-2 transport streams)
1589 * - encoding: unused
1590 * - decoding: Set by decoder.
1592 int dtg_active_format;
1593 #define FF_DTG_AFD_SAME 8
1594 #define FF_DTG_AFD_4_3 9
1595 #define FF_DTG_AFD_16_9 10
1596 #define FF_DTG_AFD_14_9 11
1597 #define FF_DTG_AFD_4_3_SP_14_9 13
1598 #define FF_DTG_AFD_16_9_SP_14_9 14
1599 #define FF_DTG_AFD_SP_4_3 15
1602 * maximum motion estimation search range in subpel units
1603 * If 0 then no limit.
1605 * - encoding: Set by user.
1606 * - decoding: unused
1611 * intra quantizer bias
1612 * - encoding: Set by user.
1613 * - decoding: unused
1615 int intra_quant_bias;
1616 #define FF_DEFAULT_QUANT_BIAS 999999
1619 * inter quantizer bias
1620 * - encoding: Set by user.
1621 * - decoding: unused
1623 int inter_quant_bias;
1627 * - encoding: unused
1628 * - decoding: Which clrtable should be used for 8bit RGB images.
1629 * Tables have to be stored somewhere. FIXME
1634 * internal_buffer count
1635 * Don't touch, used by libavcodec default_get_buffer().
1637 int internal_buffer_count;
1641 * Don't touch, used by libavcodec default_get_buffer().
1643 void *internal_buffer;
1645 #define FF_LAMBDA_SHIFT 7
1646 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1647 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1648 #define FF_LAMBDA_MAX (256*128-1)
1650 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1652 * Global quality for codecs which cannot change it per frame.
1653 * This should be proportional to MPEG-1/2/4 qscale.
1654 * - encoding: Set by user.
1655 * - decoding: unused
1659 #define FF_CODER_TYPE_VLC 0
1660 #define FF_CODER_TYPE_AC 1
1661 #define FF_CODER_TYPE_RAW 2
1662 #define FF_CODER_TYPE_RLE 3
1663 #define FF_CODER_TYPE_DEFLATE 4
1666 * - encoding: Set by user.
1667 * - decoding: unused
1673 * - encoding: Set by user.
1674 * - decoding: unused
1680 * - encoding: unused
1681 * - decoding: Set by user.
1683 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1688 * - encoding: unused
1689 * - decoding: Set by user.
1692 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1693 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1694 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1697 * XVideo Motion Acceleration
1698 * - encoding: forbidden
1699 * - decoding: set by decoder
1701 int xvmc_acceleration;
1704 * macroblock decision mode
1705 * - encoding: Set by user.
1706 * - decoding: unused
1709 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1710 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1711 #define FF_MB_DECISION_RD 2 ///< rate distortion
1714 * custom intra quantization matrix
1715 * - encoding: Set by user, can be NULL.
1716 * - decoding: Set by libavcodec.
1718 uint16_t *intra_matrix;
1721 * custom inter quantization matrix
1722 * - encoding: Set by user, can be NULL.
1723 * - decoding: Set by libavcodec.
1725 uint16_t *inter_matrix;
1728 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1729 * This is used to work around some encoder bugs.
1730 * - encoding: unused
1731 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1733 unsigned int stream_codec_tag;
1736 * scene change detection threshold
1737 * 0 is default, larger means fewer detected scene changes.
1738 * - encoding: Set by user.
1739 * - decoding: unused
1741 int scenechange_threshold;
1744 * minimum Lagrange multipler
1745 * - encoding: Set by user.
1746 * - decoding: unused
1751 * maximum Lagrange multipler
1752 * - encoding: Set by user.
1753 * - decoding: unused
1758 * palette control structure
1759 * - encoding: ??? (no palette-enabled encoder yet)
1760 * - decoding: Set by user.
1762 struct AVPaletteControl *palctrl;
1765 * noise reduction strength
1766 * - encoding: Set by user.
1767 * - decoding: unused
1769 int noise_reduction;
1772 * Called at the beginning of a frame to get cr buffer for it.
1773 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1774 * libavcodec will pass previous buffer in pic, function should return
1775 * same buffer or new buffer with old frame "painted" into it.
1776 * If pic.data[0] == NULL must behave like get_buffer().
1777 * - encoding: unused
1778 * - decoding: Set by libavcodec., user can override
1780 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1783 * Number of bits which should be loaded into the rc buffer before decoding starts.
1784 * - encoding: Set by user.
1785 * - decoding: unused
1787 int rc_initial_buffer_occupancy;
1791 * - encoding: Set by user.
1792 * - decoding: unused
1794 int inter_threshold;
1798 * - encoding: Set by user.
1799 * - decoding: Set by user.
1804 * Simulates errors in the bitstream to test error concealment.
1805 * - encoding: Set by user.
1806 * - decoding: unused
1811 * MP3 antialias algorithm, see FF_AA_* below.
1812 * - encoding: unused
1813 * - decoding: Set by user.
1816 #define FF_AA_AUTO 0
1817 #define FF_AA_FASTINT 1 //not implemented yet
1819 #define FF_AA_FLOAT 3
1821 * quantizer noise shaping
1822 * - encoding: Set by user.
1823 * - decoding: unused
1825 int quantizer_noise_shaping;
1829 * is used to decide how many independent tasks should be passed to execute()
1830 * - encoding: Set by user.
1831 * - decoding: Set by user.
1836 * The codec may call this to execute several independent things.
1837 * It will return only after finishing all tasks.
1838 * The user may replace this with some multithreaded implementation,
1839 * the default implementation will execute the parts serially.
1840 * @param count the number of things to execute
1841 * - encoding: Set by libavcodec, user can override.
1842 * - decoding: Set by libavcodec, user can override.
1844 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1848 * Can be used by execute() to store some per AVCodecContext stuff.
1849 * - encoding: set by execute()
1850 * - decoding: set by execute()
1852 void *thread_opaque;
1855 * Motion estimation threshold below which no motion estimation is
1856 * performed, but instead the user specified motion vectors are used.
1858 * - encoding: Set by user.
1859 * - decoding: unused
1864 * Macroblock threshold below which the user specified macroblock types will be used.
1865 * - encoding: Set by user.
1866 * - decoding: unused
1871 * precision of the intra DC coefficient - 8
1872 * - encoding: Set by user.
1873 * - decoding: unused
1875 int intra_dc_precision;
1878 * noise vs. sse weight for the nsse comparsion function
1879 * - encoding: Set by user.
1880 * - decoding: unused
1885 * Number of macroblock rows at the top which are skipped.
1886 * - encoding: unused
1887 * - decoding: Set by user.
1892 * Number of macroblock rows at the bottom which are skipped.
1893 * - encoding: unused
1894 * - decoding: Set by user.
1900 * - encoding: Set by user.
1901 * - decoding: Set by libavcodec.
1904 #define FF_PROFILE_UNKNOWN -99
1905 #define FF_PROFILE_AAC_MAIN 0
1906 #define FF_PROFILE_AAC_LOW 1
1907 #define FF_PROFILE_AAC_SSR 2
1908 #define FF_PROFILE_AAC_LTP 3
1912 * - encoding: Set by user.
1913 * - decoding: Set by libavcodec.
1916 #define FF_LEVEL_UNKNOWN -99
1919 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1920 * - encoding: unused
1921 * - decoding: Set by user.
1926 * Bitstream width / height, may be different from width/height if lowres
1927 * or other things are used.
1928 * - encoding: unused
1929 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1931 int coded_width, coded_height;
1934 * frame skip threshold
1935 * - encoding: Set by user.
1936 * - decoding: unused
1938 int frame_skip_threshold;
1942 * - encoding: Set by user.
1943 * - decoding: unused
1945 int frame_skip_factor;
1948 * frame skip exponent
1949 * - encoding: Set by user.
1950 * - decoding: unused
1955 * frame skip comparison function
1956 * - encoding: Set by user.
1957 * - decoding: unused
1962 * Border processing masking, raises the quantizer for mbs on the borders
1964 * - encoding: Set by user.
1965 * - decoding: unused
1967 float border_masking;
1970 * minimum MB lagrange multipler
1971 * - encoding: Set by user.
1972 * - decoding: unused
1977 * maximum MB lagrange multipler
1978 * - encoding: Set by user.
1979 * - decoding: unused
1985 * - encoding: Set by user.
1986 * - decoding: unused
1988 int me_penalty_compensation;
1992 * - encoding: unused
1993 * - decoding: Set by user.
1995 enum AVDiscard skip_loop_filter;
1999 * - encoding: unused
2000 * - decoding: Set by user.
2002 enum AVDiscard skip_idct;
2006 * - encoding: unused
2007 * - decoding: Set by user.
2009 enum AVDiscard skip_frame;
2013 * - encoding: Set by user.
2014 * - decoding: unused
2020 * - encoding: Set by user.
2021 * - decoding: unused
2026 * constant rate factor - quality-based VBR - values ~correspond to qps
2027 * - encoding: Set by user.
2028 * - decoding: unused
2033 * constant quantization parameter rate control method
2034 * - encoding: Set by user.
2035 * - decoding: unused
2041 * - encoding: Set by user.
2042 * - decoding: unused
2047 * number of reference frames
2048 * - encoding: Set by user.
2049 * - decoding: unused
2054 * chroma qp offset from luma
2055 * - encoding: Set by user.
2056 * - decoding: unused
2061 * Influences how often B-frames are used.
2062 * - encoding: Set by user.
2063 * - decoding: unused
2068 * trellis RD quantization
2069 * - encoding: Set by user.
2070 * - decoding: unused
2075 * Reduce fluctuations in qp (before curve compression).
2076 * - encoding: Set by user.
2077 * - decoding: unused
2079 float complexityblur;
2082 * in-loop deblocking filter alphac0 parameter
2083 * alpha is in the range -6...6
2084 * - encoding: Set by user.
2085 * - decoding: unused
2090 * in-loop deblocking filter beta parameter
2091 * beta is in the range -6...6
2092 * - encoding: Set by user.
2093 * - decoding: unused
2098 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2099 * - encoding: Set by user.
2100 * - decoding: unused
2103 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2104 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2105 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2106 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2107 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2110 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2111 * - encoding: Set by user.
2112 * - decoding: unused
2117 * Audio cutoff bandwidth (0 means "automatic")
2118 * - encoding: Set by user.
2119 * - decoding: unused
2124 * Multiplied by qscale for each frame and added to scene_change_score.
2125 * - encoding: Set by user.
2126 * - decoding: unused
2128 int scenechange_factor;
2132 * Note: Value depends upon the compare function used for fullpel ME.
2133 * - encoding: Set by user.
2134 * - decoding: unused
2139 * Adjusts sensitivity of b_frame_strategy 1.
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * - encoding: Set by user.
2147 * - decoding: unused
2149 int compression_level;
2150 #define FF_COMPRESSION_DEFAULT -1
2153 * Sets whether to use LPC mode - used by FLAC encoder.
2154 * - encoding: Set by user.
2155 * - decoding: unused
2160 * LPC coefficient precision - used by FLAC encoder
2161 * - encoding: Set by user.
2162 * - decoding: unused
2164 int lpc_coeff_precision;
2167 * - encoding: Set by user.
2168 * - decoding: unused
2170 int min_prediction_order;
2173 * - encoding: Set by user.
2174 * - decoding: unused
2176 int max_prediction_order;
2179 * search method for selecting prediction order
2180 * - encoding: Set by user.
2181 * - decoding: unused
2183 int prediction_order_method;
2186 * - encoding: Set by user.
2187 * - decoding: unused
2189 int min_partition_order;
2192 * - encoding: Set by user.
2193 * - decoding: unused
2195 int max_partition_order;
2198 * GOP timecode frame start number, in non drop frame format
2199 * - encoding: Set by user.
2200 * - decoding: unused
2202 int64_t timecode_frame_start;
2205 * Decoder should decode to this many channels if it can (0 for default)
2206 * - encoding: unused
2207 * - decoding: Set by user.
2209 int request_channels;
2212 * Percentage of dynamic range compression to be applied by the decoder.
2213 * The default value is 1.0, corresponding to full compression.
2214 * - encoding: unused
2215 * - decoding: Set by user.
2223 typedef struct AVCodec {
2225 * Name of the codec implementation.
2226 * The name is globally unique among encoders and among decoders (but an
2227 * encoder and a decoder can share the same name).
2228 * This is the primary way to find a codec from the user perspective.
2231 enum CodecType type;
2234 int (*init)(AVCodecContext *);
2235 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2236 int (*close)(AVCodecContext *);
2237 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2238 const uint8_t *buf, int buf_size);
2240 * Codec capabilities.
2244 struct AVCodec *next;
2247 * Will be called when seeking
2249 void (*flush)(AVCodecContext *);
2250 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2251 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2253 * Descriptive name for the codec, meant to be more human readable than \p name.
2254 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2256 const char *long_name;
2257 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2261 * four components are given, that's all.
2262 * the last component is alpha
2264 typedef struct AVPicture {
2266 int linesize[4]; ///< number of bytes per line
2271 * This structure defines a method for communicating palette changes
2272 * between and demuxer and a decoder.
2274 * @deprecated Use AVPacket to send palette changes instead.
2275 * This is totally broken.
2277 #define AVPALETTE_SIZE 1024
2278 #define AVPALETTE_COUNT 256
2279 typedef struct AVPaletteControl {
2281 /* Demuxer sets this to 1 to indicate the palette has changed;
2282 * decoder resets to 0. */
2283 int palette_changed;
2285 /* 4-byte ARGB palette entries, stored in native byte order; note that
2286 * the individual palette components should be on a 8-bit scale; if
2287 * the palette data comes from an IBM VGA native format, the component
2288 * data is probably 6 bits in size and needs to be scaled. */
2289 unsigned int palette[AVPALETTE_COUNT];
2291 } AVPaletteControl attribute_deprecated;
2293 typedef struct AVSubtitleRect {
2300 uint32_t *rgba_palette;
2304 typedef struct AVSubtitle {
2305 uint16_t format; /* 0 = graphics */
2306 uint32_t start_display_time; /* relative to packet pts, in ms */
2307 uint32_t end_display_time; /* relative to packet pts, in ms */
2309 AVSubtitleRect *rects;
2315 struct ReSampleContext;
2316 struct AVResampleContext;
2318 typedef struct ReSampleContext ReSampleContext;
2320 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2321 int output_rate, int input_rate);
2322 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2323 void audio_resample_close(ReSampleContext *s);
2325 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2326 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2327 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2328 void av_resample_close(struct AVResampleContext *c);
2330 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2331 /* YUV420 format is assumed ! */
2334 * @deprecated Use the software scaler (swscale) instead.
2336 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2339 * @deprecated Use the software scaler (swscale) instead.
2341 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2342 int input_width, int input_height);
2345 * @deprecated Use the software scaler (swscale) instead.
2347 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2348 int iwidth, int iheight,
2349 int topBand, int bottomBand,
2350 int leftBand, int rightBand,
2351 int padtop, int padbottom,
2352 int padleft, int padright);
2355 * @deprecated Use the software scaler (swscale) instead.
2357 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2358 AVPicture *output, const AVPicture *input);
2361 * @deprecated Use the software scaler (swscale) instead.
2363 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2368 * Allocate memory for a picture. Call avpicture_free to free it.
2370 * @param picture the picture to be filled in
2371 * @param pix_fmt the format of the picture
2372 * @param width the width of the picture
2373 * @param height the height of the picture
2374 * @return zero if successful, a negative value if not
2376 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2379 * Free a picture previously allocated by avpicture_alloc().
2381 * @param picture the AVPicture to be freed
2383 void avpicture_free(AVPicture *picture);
2386 * Fill in the AVPicture fields.
2387 * The fields of the given AVPicture are filled in by using the 'ptr' address
2388 * which points to the image data buffer. Depending on the specified picture
2389 * format, one or multiple image data pointers and line sizes will be set.
2390 * If a planar format is specified, several pointers will be set pointing to
2391 * the different picture planes and the line sizes of the different planes
2392 * will be stored in the lines_sizes array.
2394 * @param picture AVPicture whose fields are to be filled in
2395 * @param ptr Buffer which will contain or contains the actual image data
2396 * @param pix_fmt The format in which the picture data is stored.
2397 * @param width the width of the image in pixels
2398 * @param height the height of the image in pixels
2399 * @return size of the image data in bytes
2401 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2402 int pix_fmt, int width, int height);
2403 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2404 unsigned char *dest, int dest_size);
2407 * Calculate the size in bytes that a picture of the given width and height
2408 * would occupy if stored in the given picture format.
2410 * @param pix_fmt the given picture format
2411 * @param width the width of the image
2412 * @param height the height of the image
2413 * @return Image data size in bytes
2415 int avpicture_get_size(int pix_fmt, int width, int height);
2416 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2417 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2418 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2419 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2420 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2422 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2423 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2424 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2425 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2426 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2427 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2430 * Computes what kind of losses will occur when converting from one specific
2431 * pixel format to another.
2432 * When converting from one pixel format to another, information loss may occur.
2433 * For example, when converting from RGB24 to GRAY, the color information will
2434 * be lost. Similarly, other losses occur when converting from some formats to
2435 * other formats. These losses can involve loss of chroma, but also loss of
2436 * resolution, loss of color depth, loss due to the color space conversion, loss
2437 * of the alpha bits or loss due to color quantization.
2438 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2439 * which will occur when converting from one pixel format to another.
2441 * @param[in] dst_pix_fmt destination pixel format
2442 * @param[in] src_pix_fmt source pixel format
2443 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2444 * @return Combination of flags informing you what kind of losses will occur.
2446 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2450 * Finds the best pixel format to convert to given a certain source pixel
2451 * format. When converting from one pixel format to another, information loss
2452 * may occur. For example, when converting from RGB24 to GRAY, the color
2453 * information will be lost. Similarly, other losses occur when converting from
2454 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2455 * the given pixel formats should be used to suffer the least amount of loss.
2456 * The pixel formats from which it chooses one, are determined by the
2457 * \p pix_fmt_mask parameter.
2460 * src_pix_fmt = PIX_FMT_YUV420P;
2461 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2462 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2465 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2466 * @param[in] src_pix_fmt source pixel format
2467 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2468 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2469 * @return The best pixel format to convert to or -1 if none was found.
2471 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2472 int has_alpha, int *loss_ptr);
2476 * Print in buf the string corresponding to the pixel format with
2477 * number pix_fmt, or an header if pix_fmt is negative.
2479 * @param[in] buf the buffer where to write the string
2480 * @param[in] buf_size the size of buf
2481 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2482 * a negative value to print the corresponding header.
2483 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2485 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2487 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2488 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2491 * Tell if an image really has transparent alpha values.
2492 * @return ored mask of FF_ALPHA_xxx constants
2494 int img_get_alpha_info(const AVPicture *src,
2495 int pix_fmt, int width, int height);
2497 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2499 * convert among pixel formats
2500 * @deprecated Use the software scaler (swscale) instead.
2502 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2503 const AVPicture *src, int pix_fmt,
2504 int width, int height);
2507 /* deinterlace a picture */
2508 /* deinterlace - if not supported return -1 */
2509 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2510 int pix_fmt, int width, int height);
2512 /* external high level API */
2514 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2515 extern AVCodec *first_avcodec;
2517 AVCodec *av_codec_next(AVCodec *c);
2519 /* returns LIBAVCODEC_VERSION_INT constant */
2520 unsigned avcodec_version(void);
2521 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2522 /* returns LIBAVCODEC_BUILD constant */
2523 attribute_deprecated unsigned avcodec_build(void);
2527 * Initializes libavcodec.
2529 * @warning This function \e must be called before any other libavcodec
2532 void avcodec_init(void);
2534 void register_avcodec(AVCodec *format);
2537 * Finds a registered encoder with a matching codec ID.
2539 * @param id CodecID of the requested encoder
2540 * @return An encoder if one was found, NULL otherwise.
2542 AVCodec *avcodec_find_encoder(enum CodecID id);
2545 * Finds a registered encoder with the specified name.
2547 * @param name name of the requested encoder
2548 * @return An encoder if one was found, NULL otherwise.
2550 AVCodec *avcodec_find_encoder_by_name(const char *name);
2553 * Finds a registered decoder with a matching codec ID.
2555 * @param id CodecID of the requested decoder
2556 * @return A decoder if one was found, NULL otherwise.
2558 AVCodec *avcodec_find_decoder(enum CodecID id);
2561 * Finds a registered decoder with the specified name.
2563 * @param name name of the requested decoder
2564 * @return A decoder if one was found, NULL otherwise.
2566 AVCodec *avcodec_find_decoder_by_name(const char *name);
2567 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2570 * Sets the fields of the given AVCodecContext to default values.
2572 * @param s The AVCodecContext of which the fields should be set to default values.
2574 void avcodec_get_context_defaults(AVCodecContext *s);
2576 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2577 * we WILL change its arguments and name a few times! */
2578 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2581 * Allocates an AVCodecContext and sets its fields to default values. The
2582 * resulting struct can be deallocated by simply calling av_free().
2584 * @return An AVCodecContext filled with default values or NULL on failure.
2585 * @see avcodec_get_context_defaults
2587 AVCodecContext *avcodec_alloc_context(void);
2589 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2590 * we WILL change its arguments and name a few times! */
2591 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2594 * Sets the fields of the given AVFrame to default values.
2596 * @param pic The AVFrame of which the fields should be set to default values.
2598 void avcodec_get_frame_defaults(AVFrame *pic);
2601 * Allocates an AVFrame and sets its fields to default values. The resulting
2602 * struct can be deallocated by simply calling av_free().
2604 * @return An AVFrame filled with default values or NULL on failure.
2605 * @see avcodec_get_frame_defaults
2607 AVFrame *avcodec_alloc_frame(void);
2609 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2610 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2611 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2612 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2615 * Checks if the given dimension of a picture is valid, meaning that all
2616 * bytes of the picture can be addressed with a signed int.
2618 * @param[in] w Width of the picture.
2619 * @param[in] h Height of the picture.
2620 * @return Zero if valid, a negative value if invalid.
2622 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2623 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2625 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2626 void avcodec_thread_free(AVCodecContext *s);
2627 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2628 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2629 //FIXME func typedef
2632 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2633 * function the context has to be allocated.
2635 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2636 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2637 * retrieving a codec.
2639 * @warning This function is not thread safe!
2642 * avcodec_register_all();
2643 * codec = avcodec_find_decoder(CODEC_ID_H264);
2647 * context = avcodec_alloc_context();
2649 * if (avcodec_open(context, codec) < 0)
2653 * @param avctx The context which will be set up to use the given codec.
2654 * @param codec The codec to use within the context.
2655 * @return zero on success, a negative value on error
2656 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2658 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2661 * @deprecated Use avcodec_decode_audio2() instead.
2663 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2664 int *frame_size_ptr,
2665 const uint8_t *buf, int buf_size);
2668 * Decodes an audio frame from \p buf into \p samples.
2669 * The avcodec_decode_audio2() function decodes an audio frame from the input
2670 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2671 * audio codec which was coupled with \p avctx using avcodec_open(). The
2672 * resulting decoded frame is stored in output buffer \p samples. If no frame
2673 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2674 * decompressed frame size in \e bytes.
2676 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2677 * output buffer before calling avcodec_decode_audio2().
2679 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2680 * the actual read bytes because some optimized bitstream readers read 32 or 64
2681 * bits at once and could read over the end.
2683 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2684 * no overreading happens for damaged MPEG streams.
2686 * @note You might have to align the input buffer \p buf and output buffer \p
2687 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2688 * necessary at all, on others it won't work at all if not aligned and on others
2689 * it will work but it will have an impact on performance. In practice, the
2690 * bitstream should have 4 byte alignment at minimum and all sample data should
2691 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2692 * the linesize is not a multiple of 16 then there's no sense in aligning the
2693 * start of the buffer to 16.
2695 * @param avctx the codec context
2696 * @param[out] samples the output buffer
2697 * @param[in,out] frame_size_ptr the output buffer size in bytes
2698 * @param[in] buf the input buffer
2699 * @param[in] buf_size the input buffer size in bytes
2700 * @return On error a negative value is returned, otherwise the number of bytes
2701 * used or zero if no frame could be decompressed.
2703 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2704 int *frame_size_ptr,
2705 const uint8_t *buf, int buf_size);
2708 * Decodes a video frame from \p buf into \p picture.
2709 * The avcodec_decode_video() function decodes a video frame from the input
2710 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2711 * video codec which was coupled with \p avctx using avcodec_open(). The
2712 * resulting decoded frame is stored in \p picture.
2714 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2715 * the actual read bytes because some optimized bitstream readers read 32 or 64
2716 * bits at once and could read over the end.
2718 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2719 * no overreading happens for damaged MPEG streams.
2721 * @note You might have to align the input buffer \p buf and output buffer \p
2722 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2723 * necessary at all, on others it won't work at all if not aligned and on others
2724 * it will work but it will have an impact on performance. In practice, the
2725 * bitstream should have 4 byte alignment at minimum and all sample data should
2726 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2727 * the linesize is not a multiple of 16 then there's no sense in aligning the
2728 * start of the buffer to 16.
2730 * @param avctx the codec context
2731 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2732 * @param[in] buf the input buffer
2733 * @param[in] buf_size the size of the input buffer in bytes
2734 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2735 * @return On error a negative value is returned, otherwise the number of bytes
2736 * used or zero if no frame could be decompressed.
2738 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2739 int *got_picture_ptr,
2740 const uint8_t *buf, int buf_size);
2742 /* Decode a subtitle message. Return -1 if error, otherwise return the
2743 * number of bytes used. If no subtitle could be decompressed,
2744 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2745 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2747 const uint8_t *buf, int buf_size);
2748 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2750 uint8_t *buf, int buf_size);
2753 * Encodes an audio frame from \p samples into \p buf.
2754 * The avcodec_encode_audio() function encodes an audio frame from the input
2755 * buffer \p samples. To encode it, it makes use of the audio codec which was
2756 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2757 * stored in output buffer \p buf.
2759 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2761 * @param avctx the codec context
2762 * @param[out] buf the output buffer
2763 * @param[in] buf_size the output buffer size
2764 * @param[in] samples the input buffer containing the samples
2765 * The number of samples read from this buffer is frame_size*channels,
2766 * both of which are defined in \p avctx.
2767 * For PCM audio the number of samples read from \p samples is equal to
2768 * \p buf_size * input_sample_size / output_sample_size.
2769 * @return On error a negative value is returned, on success zero or the number
2770 * of bytes used to encode the data read from the input buffer.
2772 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2773 const short *samples);
2776 * Encodes a video frame from \p pict into \p buf.
2777 * The avcodec_encode_video() function encodes a video frame from the input
2778 * \p pict. To encode it, it makes use of the video codec which was coupled with
2779 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2780 * frame are stored in the output buffer \p buf. The input picture should be
2781 * stored using a specific format, namely \c avctx.pix_fmt.
2783 * @param avctx the codec context
2784 * @param[out] buf the output buffer for the bitstream of encoded frame
2785 * @param[in] buf_size the size of the output buffer in bytes
2786 * @param[in] pict the input picture to encode
2787 * @return On error a negative value is returned, on success zero or the number
2788 * of bytes used from the input buffer.
2790 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2791 const AVFrame *pict);
2792 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2793 const AVSubtitle *sub);
2795 int avcodec_close(AVCodecContext *avctx);
2797 void avcodec_register_all(void);
2800 * Flush buffers, should be called when seeking or when switching to a different stream.
2802 void avcodec_flush_buffers(AVCodecContext *avctx);
2804 void avcodec_default_free_buffers(AVCodecContext *s);
2806 /* misc useful functions */
2809 * Returns a single letter to describe the given picture type \p pict_type.
2811 * @param[in] pict_type the picture type
2812 * @return A single character representing the picture type.
2814 char av_get_pict_type_char(int pict_type);
2817 * Returns codec bits per sample.
2819 * @param[in] codec_id the codec
2820 * @return Number of bits per sample or zero if unknown for the given codec.
2822 int av_get_bits_per_sample(enum CodecID codec_id);
2825 * Returns sample format bits per sample.
2827 * @param[in] sample_fmt the sample format
2828 * @return Number of bits per sample or zero if unknown for the given sample format.
2830 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2833 typedef struct AVCodecParserContext {
2835 struct AVCodecParser *parser;
2836 int64_t frame_offset; /* offset of the current frame */
2837 int64_t cur_offset; /* current offset
2838 (incremented by each av_parser_parse()) */
2839 int64_t next_frame_offset; /* offset of the next frame */
2841 int pict_type; /* XXX: Put it back in AVCodecContext. */
2842 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2843 int64_t pts; /* pts of the current frame */
2844 int64_t dts; /* dts of the current frame */
2849 int fetch_timestamp;
2851 #define AV_PARSER_PTS_NB 4
2852 int cur_frame_start_index;
2853 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2854 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2855 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2858 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2860 int64_t offset; ///< byte offset from starting packet start
2861 int64_t cur_frame_end[AV_PARSER_PTS_NB];
2862 } AVCodecParserContext;
2864 typedef struct AVCodecParser {
2865 int codec_ids[5]; /* several codec IDs are permitted */
2867 int (*parser_init)(AVCodecParserContext *s);
2868 int (*parser_parse)(AVCodecParserContext *s,
2869 AVCodecContext *avctx,
2870 const uint8_t **poutbuf, int *poutbuf_size,
2871 const uint8_t *buf, int buf_size);
2872 void (*parser_close)(AVCodecParserContext *s);
2873 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2874 struct AVCodecParser *next;
2877 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2878 extern AVCodecParser *av_first_parser;
2880 AVCodecParser *av_parser_next(AVCodecParser *c);
2882 void av_register_codec_parser(AVCodecParser *parser);
2883 AVCodecParserContext *av_parser_init(int codec_id);
2884 int av_parser_parse(AVCodecParserContext *s,
2885 AVCodecContext *avctx,
2886 uint8_t **poutbuf, int *poutbuf_size,
2887 const uint8_t *buf, int buf_size,
2888 int64_t pts, int64_t dts);
2889 int av_parser_change(AVCodecParserContext *s,
2890 AVCodecContext *avctx,
2891 uint8_t **poutbuf, int *poutbuf_size,
2892 const uint8_t *buf, int buf_size, int keyframe);
2893 void av_parser_close(AVCodecParserContext *s);
2896 typedef struct AVBitStreamFilterContext {
2898 struct AVBitStreamFilter *filter;
2899 AVCodecParserContext *parser;
2900 struct AVBitStreamFilterContext *next;
2901 } AVBitStreamFilterContext;
2904 typedef struct AVBitStreamFilter {
2907 int (*filter)(AVBitStreamFilterContext *bsfc,
2908 AVCodecContext *avctx, const char *args,
2909 uint8_t **poutbuf, int *poutbuf_size,
2910 const uint8_t *buf, int buf_size, int keyframe);
2911 void (*close)(AVBitStreamFilterContext *bsfc);
2912 struct AVBitStreamFilter *next;
2913 } AVBitStreamFilter;
2915 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2916 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2917 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2918 AVCodecContext *avctx, const char *args,
2919 uint8_t **poutbuf, int *poutbuf_size,
2920 const uint8_t *buf, int buf_size, int keyframe);
2921 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2923 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2928 * Reallocates the given block if it is not large enough, otherwise it
2933 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2936 * Copy image 'src' to 'dst'.
2938 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2939 int pix_fmt, int width, int height);
2942 * Crop image top and left side.
2944 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2945 int pix_fmt, int top_band, int left_band);
2950 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2951 int padtop, int padbottom, int padleft, int padright, int *color);
2953 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2955 * @deprecated Use the software scaler (swscale) instead.
2957 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2958 int pix_fmt, int width, int height);
2961 * @deprecated Use the software scaler (swscale) instead.
2963 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2964 int pix_fmt, int top_band, int left_band);
2967 * @deprecated Use the software scaler (swscale) instead.
2969 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2970 int padtop, int padbottom, int padleft, int padright, int *color);
2973 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2976 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2978 * @return 0 in case of a successful parsing, a negative value otherwise
2979 * @param[in] str the string to parse: it has to be a string in the format
2980 * <width>x<height> or a valid video frame size abbreviation.
2981 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2983 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2984 * frame height value
2986 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2989 * Parses \p str and put in \p frame_rate the detected values.
2991 * @return 0 in case of a successful parsing, a negative value otherwise
2992 * @param[in] str the string to parse: it has to be a string in the format
2993 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2994 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2997 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2999 /* error handling */
3001 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3002 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3004 /* Some platforms have E* and errno already negated. */
3005 #define AVERROR(e) (e)
3006 #define AVUNERROR(e) (e)
3008 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3009 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3010 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3011 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3012 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3013 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3014 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3015 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3016 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3018 #endif /* FFMPEG_AVCODEC_H */