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
31 #include <sys/types.h> /* size_t */
33 #define AV_STRINGIFY(s) AV_TOSTRING(s)
34 #define AV_TOSTRING(s) #s
36 #define LIBAVCODEC_VERSION_INT ((51<<16)+(47<<8)+2)
37 #define LIBAVCODEC_VERSION 51.47.2
38 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
40 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
42 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
43 #define AV_TIME_BASE 1000000
44 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
47 * Identifies the syntax and semantics of the bitstream.
48 * The principle is roughly:
49 * Two decoders with the same ID can decode the same streams.
50 * Two encoders with the same ID can encode compatible streams.
51 * There may be slight deviations from the principle due to implementation
54 * If you add a codec ID to this list, add it so that
55 * 1. no value of a existing codec ID changes (that would break ABI),
56 * 2. it is as close as possible to similar codecs.
61 CODEC_ID_MPEG2VIDEO, /* preferred ID for MPEG-1/2 video decoding */
62 CODEC_ID_MPEG2VIDEO_XVMC,
99 CODEC_ID_INTERPLAY_VIDEO,
111 CODEC_ID_TRUEMOTION1,
139 CODEC_ID_TRUEMOTION2,
156 CODEC_ID_DSICINVIDEO,
157 CODEC_ID_TIERTEXSEQVIDEO,
166 CODEC_ID_BETHSOFTVID,
173 /* various PCM "codecs" */
174 CODEC_ID_PCM_S16LE= 0x10000,
190 CODEC_ID_PCM_S24DAUD,
193 /* various ADPCM codecs */
194 CODEC_ID_ADPCM_IMA_QT= 0x11000,
195 CODEC_ID_ADPCM_IMA_WAV,
196 CODEC_ID_ADPCM_IMA_DK3,
197 CODEC_ID_ADPCM_IMA_DK4,
198 CODEC_ID_ADPCM_IMA_WS,
199 CODEC_ID_ADPCM_IMA_SMJPEG,
208 CODEC_ID_ADPCM_YAMAHA,
209 CODEC_ID_ADPCM_SBPRO_4,
210 CODEC_ID_ADPCM_SBPRO_3,
211 CODEC_ID_ADPCM_SBPRO_2,
213 CODEC_ID_ADPCM_IMA_AMV,
214 CODEC_ID_ADPCM_EA_R1,
215 CODEC_ID_ADPCM_EA_R3,
216 CODEC_ID_ADPCM_EA_R2,
217 CODEC_ID_ADPCM_IMA_EA_SEAD,
220 CODEC_ID_AMR_NB= 0x12000,
223 /* RealAudio codecs*/
224 CODEC_ID_RA_144= 0x13000,
227 /* various DPCM codecs */
228 CODEC_ID_ROQ_DPCM= 0x14000,
229 CODEC_ID_INTERPLAY_DPCM,
233 CODEC_ID_MP2= 0x15000,
234 CODEC_ID_MP3, /* preferred ID for decoding MPEG audio layer 1, 2 or 3 */
236 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
255 CODEC_ID_WESTWOOD_SND1,
256 CODEC_ID_GSM, /* as in Berlin toast format */
264 CODEC_ID_DSICINAUDIO,
268 CODEC_ID_GSM_MS, /* as found in WAV */
274 /* subtitle codecs */
275 CODEC_ID_DVD_SUBTITLE= 0x17000,
276 CODEC_ID_DVB_SUBTITLE,
277 CODEC_ID_TEXT, /* raw UTF-8 text */
280 CODEC_ID_MPEG2TS= 0x20000, /* _FAKE_ codec to indicate a raw MPEG-2 TS
281 * stream (only used by libavformat) */
284 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
285 /* CODEC_ID_MP3LAME is obsolete */
286 #define CODEC_ID_MP3LAME CODEC_ID_MP3
287 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
291 CODEC_TYPE_UNKNOWN = -1,
299 /* Currently unused, may be used if 24/32 bits samples are ever supported. */
300 /* all in native-endian format */
302 SAMPLE_FMT_NONE = -1,
303 SAMPLE_FMT_U8, ///< unsigned 8 bits
304 SAMPLE_FMT_S16, ///< signed 16 bits
305 SAMPLE_FMT_S24, ///< signed 24 bits
306 SAMPLE_FMT_S32, ///< signed 32 bits
307 SAMPLE_FMT_FLT, ///< float
311 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
314 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
315 * This is mainly needed because some optimized bitstream readers read
316 * 32 or 64 bit at once and could read over the end.<br>
317 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
318 * MPEG bitstreams could cause overread and segfault.
320 #define FF_INPUT_BUFFER_PADDING_SIZE 8
323 * minimum encoding buffer size
324 * Used to avoid some checks during header writing.
326 #define FF_MIN_BUFFER_SIZE 16384
328 /* motion estimation type, EPZS by default */
342 /* We leave some space between them for extensions (drop some
343 * keyframes for intra-only or drop just some bidir frames). */
344 AVDISCARD_NONE =-16, ///< discard nothing
345 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
346 AVDISCARD_NONREF = 8, ///< discard all non reference
347 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
348 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
349 AVDISCARD_ALL = 48, ///< discard all
352 typedef struct RcOverride{
355 int qscale; // If this is 0 then quality_factor will be used instead.
356 float quality_factor;
359 #define FF_MAX_B_FRAMES 16
362 These flags can be passed in AVCodecContext.flags before initialization.
363 Note: Not everything is supported yet.
366 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
367 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
368 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
369 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
370 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
371 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
372 /* The parent program guarantees that the input for B-frames containing
373 * streams is not written to for at least s->max_b_frames+1 frames, if
374 * this is not set the input will be copied. */
375 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
376 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
377 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
378 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
379 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
380 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
381 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
382 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
383 location instead of only at frame boundaries. */
384 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
385 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
386 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
387 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
388 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
389 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
390 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
391 /* Fx : Flag for h263+ extra options */
392 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
393 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
395 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
396 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
397 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
398 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
399 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
400 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
401 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
402 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
403 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
404 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
405 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
406 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
407 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
408 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
409 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
410 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
411 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
412 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
413 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
414 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
415 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
416 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
417 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
418 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
419 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
420 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
421 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
422 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
424 /* Unsupported options :
425 * Syntax Arithmetic coding (SAC)
426 * Reference Picture Selection
427 * Independent Segment Decoding */
429 /* codec capabilities */
431 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
433 * Codec uses get_buffer() for allocating buffers.
434 * direct rendering method 1
436 #define CODEC_CAP_DR1 0x0002
437 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
438 #define CODEC_CAP_PARSE_ONLY 0x0004
439 #define CODEC_CAP_TRUNCATED 0x0008
440 /* Codec can export data for HW decoding (XvMC). */
441 #define CODEC_CAP_HWACCEL 0x0010
443 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
444 * If this is not set, the codec is guaranteed to never be fed with NULL data.
446 #define CODEC_CAP_DELAY 0x0020
448 * Codec can be fed a final frame with a smaller size.
449 * This can be used to prevent truncation of the last audio samples.
451 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
453 //The following defines may change, don't expect compatibility if you use them.
454 #define MB_TYPE_INTRA4x4 0x0001
455 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
456 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
457 #define MB_TYPE_16x16 0x0008
458 #define MB_TYPE_16x8 0x0010
459 #define MB_TYPE_8x16 0x0020
460 #define MB_TYPE_8x8 0x0040
461 #define MB_TYPE_INTERLACED 0x0080
462 #define MB_TYPE_DIRECT2 0x0100 //FIXME
463 #define MB_TYPE_ACPRED 0x0200
464 #define MB_TYPE_GMC 0x0400
465 #define MB_TYPE_SKIP 0x0800
466 #define MB_TYPE_P0L0 0x1000
467 #define MB_TYPE_P1L0 0x2000
468 #define MB_TYPE_P0L1 0x4000
469 #define MB_TYPE_P1L1 0x8000
470 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
471 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
472 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
473 #define MB_TYPE_QUANT 0x00010000
474 #define MB_TYPE_CBP 0x00020000
475 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
479 * This specifies the area which should be displayed.
480 * Note there may be multiple such areas for one frame.
482 typedef struct AVPanScan{
485 * - encoding: Set by user.
486 * - decoding: Set by libavcodec.
491 * width and height in 1/16 pel
492 * - encoding: Set by user.
493 * - decoding: Set by libavcodec.
499 * position of the top left corner in 1/16 pel for up to 3 fields/frames
500 * - encoding: Set by user.
501 * - decoding: Set by libavcodec.
503 int16_t position[3][2];
506 #define FF_COMMON_FRAME \
508 * pointer to the picture planes.\
509 * This might be different from the first allocated byte\
516 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
517 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
523 * 1 -> keyframe, 0-> not\
524 * - encoding: Set by libavcodec.\
525 * - decoding: Set by libavcodec.\
530 * Picture type of the frame, see ?_TYPE below.\
531 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
532 * - decoding: Set by libavcodec.\
537 * presentation timestamp in time_base units (time when frame should be shown to user)\
538 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
539 * - encoding: MUST be set by user.\
540 * - decoding: Set by libavcodec.\
545 * picture number in bitstream order\
546 * - encoding: set by\
547 * - decoding: Set by libavcodec.\
549 int coded_picture_number;\
551 * picture number in display order\
552 * - encoding: set by\
553 * - decoding: Set by libavcodec.\
555 int display_picture_number;\
558 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
559 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
560 * - decoding: Set by libavcodec.\
565 * buffer age (1->was last buffer and dint change, 2->..., ...).\
566 * Set to INT_MAX if the buffer has not been used yet.\
567 * - encoding: unused\
568 * - decoding: MUST be set by get_buffer().\
573 * is this picture used as reference\
574 * - encoding: unused\
575 * - decoding: Set by libavcodec. (before get_buffer() call)).\
581 * - encoding: unused\
582 * - decoding: Set by libavcodec.\
584 int8_t *qscale_table;\
587 * - encoding: unused\
588 * - decoding: Set by libavcodec.\
593 * mbskip_table[mb]>=1 if MB didn't change\
594 * stride= mb_width = (width+15)>>4\
595 * - encoding: unused\
596 * - decoding: Set by libavcodec.\
598 uint8_t *mbskip_table;\
601 * motion vector table\
604 * int mv_sample_log2= 4 - motion_subsample_log2;\
605 * int mb_width= (width+15)>>4;\
606 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
607 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
609 * - encoding: Set by user.\
610 * - decoding: Set by libavcodec.\
612 int16_t (*motion_val[2])[2];\
615 * macroblock type table\
616 * mb_type_base + mb_width + 2\
617 * - encoding: Set by user.\
618 * - decoding: Set by libavcodec.\
623 * log2 of the size of the block which a single vector in motion_val represents: \
624 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
625 * - encoding: unused\
626 * - decoding: Set by libavcodec.\
628 uint8_t motion_subsample_log2;\
631 * for some private data of the user\
632 * - encoding: unused\
633 * - decoding: Set by user.\
639 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
640 * - decoding: unused\
645 * type of the buffer (to keep track of who has to deallocate data[*])\
646 * - encoding: Set by the one who allocates it.\
647 * - decoding: Set by the one who allocates it.\
648 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
653 * When decoding, this signals how much the picture must be delayed.\
654 * extra_delay = repeat_pict / (2*fps)\
655 * - encoding: unused\
656 * - decoding: Set by libavcodec.\
666 * The content of the picture is interlaced.\
667 * - encoding: Set by user.\
668 * - decoding: Set by libavcodec. (default 0)\
670 int interlaced_frame;\
673 * If the content is interlaced, is top field displayed first.\
674 * - encoding: Set by user.\
675 * - decoding: Set by libavcodec.\
677 int top_field_first;\
681 * - encoding: Set by user.\
682 * - decoding: Set by libavcodec.\
684 AVPanScan *pan_scan;\
687 * Tell user application that palette has changed from previous frame.\
688 * - encoding: ??? (no palette-enabled encoder yet)\
689 * - decoding: Set by libavcodec. (default 0).\
691 int palette_has_changed;\
694 * codec suggestion on buffer type if != 0\
695 * - encoding: unused\
696 * - decoding: Set by libavcodec. (before get_buffer() call)).\
702 * - encoding: unused\
703 * - decoding: Set by libavcodec.\
708 * motion referece frame index\
709 * - encoding: Set by user.\
710 * - decoding: Set by libavcodec.\
712 int8_t *ref_index[2];
714 #define FF_QSCALE_TYPE_MPEG1 0
715 #define FF_QSCALE_TYPE_MPEG2 1
716 #define FF_QSCALE_TYPE_H264 2
718 #define FF_BUFFER_TYPE_INTERNAL 1
719 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
720 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
721 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
724 #define FF_I_TYPE 1 // Intra
725 #define FF_P_TYPE 2 // Predicted
726 #define FF_B_TYPE 3 // Bi-dir predicted
727 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
731 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
732 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
733 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
734 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
739 typedef struct AVFrame {
743 #define DEFAULT_FRAME_RATE_BASE 1001000
746 * main external API structure
748 typedef struct AVCodecContext {
750 * information on struct for av_log
751 * - set by avcodec_alloc_context
755 * the average bitrate
756 * - encoding: Set by user; unused for constant quantizer encoding.
757 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
762 * number of bits the bitstream is allowed to diverge from the reference.
763 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
764 * - encoding: Set by user; unused for constant quantizer encoding.
767 int bit_rate_tolerance;
771 * - encoding: Set by user.
772 * - decoding: Set by user.
777 * Some codecs need additional format info. It is stored here.
778 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
779 * specific codec MUST set it correctly otherwise stream copy breaks.
780 * In general use of this field by muxers is not recommanded.
781 * - encoding: Set by libavcodec.
782 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
787 * Motion estimation algorithm used for video coding.
788 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
789 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
790 * - encoding: MUST be set by user.
796 * some codecs need / can use extradata like Huffman tables.
797 * mjpeg: Huffman tables
798 * rv10: additional flags
799 * mpeg4: global headers (they can be in the bitstream or here)
800 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
801 * than extradata_size to avoid prolems if it is read with the bitstream reader.
802 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
803 * - encoding: Set/allocated/freed by libavcodec.
804 * - decoding: Set/allocated/freed by user.
810 * This is the fundamental unit of time (in seconds) in terms
811 * of which frame timestamps are represented. For fixed-fps content,
812 * timebase should be 1/framerate and timestamp increments should be
814 * - encoding: MUST be set by user.
815 * - decoding: Set by libavcodec.
817 AVRational time_base;
821 * picture width / height.
822 * - encoding: MUST be set by user.
823 * - decoding: Set by libavcodec.
824 * Note: For compatibility it is possible to set this instead of
825 * coded_width/height before decoding.
829 #define FF_ASPECT_EXTENDED 15
832 * the number of pictures in a group of pictures, or 0 for intra_only
833 * - encoding: Set by user.
839 * Pixel format, see PIX_FMT_xxx.
840 * - encoding: Set by user.
841 * - decoding: Set by libavcodec.
843 enum PixelFormat pix_fmt;
846 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
847 * has to read frames at native frame rate.
848 * - encoding: Set by user.
854 * If non NULL, 'draw_horiz_band' is called by the libavcodec
855 * decoder to draw a horizontal band. It improves cache usage. Not
856 * all codecs can do that. You must check the codec capabilities
859 * - decoding: Set by user.
860 * @param height the height of the slice
861 * @param y the y position of the slice
862 * @param type 1->top field, 2->bottom field, 3->frame
863 * @param offset offset into the AVFrame.data from which the slice should be read
865 void (*draw_horiz_band)(struct AVCodecContext *s,
866 const AVFrame *src, int offset[4],
867 int y, int type, int height);
870 int sample_rate; ///< samples per second
874 * audio sample format
875 * - encoding: Set by user.
876 * - decoding: Set by libavcodec.
878 enum SampleFormat sample_fmt; ///< sample format, currently unused
880 /* The following data should not be initialized. */
882 * Samples per packet, initialized when calling 'init'.
885 int frame_number; ///< audio or video frame number
886 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
889 * Number of frames the decoded output will be delayed relative to
891 * - encoding: Set by libavcodec.
896 /* - encoding parameters */
897 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
898 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
902 * - encoding: Set by user.
909 * - encoding: Set by user.
915 * maximum quantizer difference between frames
916 * - encoding: Set by user.
922 * maximum number of B-frames between non-B-frames
923 * Note: The output will be delayed by max_b_frames+1 relative to the input.
924 * - encoding: Set by user.
930 * qscale factor between IP and B-frames
931 * - encoding: Set by user.
934 float b_quant_factor;
936 /** obsolete FIXME remove */
938 #define FF_RC_STRATEGY_XVID 1
940 int b_frame_strategy;
945 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
946 * @deprecated Deprecated in favor of skip_idct and skip_frame.
950 struct AVCodec *codec;
954 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
955 /* unused, FIXME remove*/
959 int rtp_payload_size; /* The size of the RTP payload: the coder will */
960 /* do its best to deliver a chunk with size */
961 /* below rtp_payload_size, the chunk will start */
962 /* with a start code on some codecs like H.263. */
963 /* This doesn't take account of any particular */
964 /* headers inside the transmitted RTP payload. */
967 /* The RTP callback: This function is called */
968 /* every time the encoder has a packet to send. */
969 /* It depends on the encoder if the data starts */
970 /* with a Start Code (it should). H.263 does. */
971 /* mb_nb contains the number of macroblocks */
972 /* encoded in the RTP payload. */
973 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
975 /* statistics, used for 2-pass encoding */
986 * number of bits used for the previously encoded frame
987 * - encoding: Set by libavcodec.
993 * Private data of the user, can be used to carry app specific stuff.
994 * - encoding: Set by user.
995 * - decoding: Set by user.
1000 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1001 enum CodecID codec_id; /* see CODEC_ID_xxx */
1004 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1005 * This is used to work around some encoder bugs.
1006 * A demuxer should set this to what is stored in the field used to identify the codec.
1007 * If there are multiple such fields in a container then the demuxer should choose the one
1008 * which maximizes the information about the used codec.
1009 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1010 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1011 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1013 * - encoding: Set by user, if not then the default based on codec_id will be used.
1014 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1016 unsigned int codec_tag;
1019 * Work around bugs in encoders which sometimes cannot be detected automatically.
1020 * - encoding: Set by user
1021 * - decoding: Set by user
1023 int workaround_bugs;
1024 #define FF_BUG_AUTODETECT 1 ///< autodetection
1025 #define FF_BUG_OLD_MSMPEG4 2
1026 #define FF_BUG_XVID_ILACE 4
1027 #define FF_BUG_UMP4 8
1028 #define FF_BUG_NO_PADDING 16
1029 #define FF_BUG_AMV 32
1030 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1031 #define FF_BUG_QPEL_CHROMA 64
1032 #define FF_BUG_STD_QPEL 128
1033 #define FF_BUG_QPEL_CHROMA2 256
1034 #define FF_BUG_DIRECT_BLOCKSIZE 512
1035 #define FF_BUG_EDGE 1024
1036 #define FF_BUG_HPEL_CHROMA 2048
1037 #define FF_BUG_DC_CLIP 4096
1038 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1039 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1042 * luma single coefficient elimination threshold
1043 * - encoding: Set by user.
1044 * - decoding: unused
1046 int luma_elim_threshold;
1049 * chroma single coeff elimination threshold
1050 * - encoding: Set by user.
1051 * - decoding: unused
1053 int chroma_elim_threshold;
1056 * strictly follow the standard (MPEG4, ...).
1057 * - encoding: Set by user.
1058 * - decoding: unused
1060 int strict_std_compliance;
1061 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1062 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1063 #define FF_COMPLIANCE_NORMAL 0
1064 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1065 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1068 * qscale offset between IP and B-frames
1069 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1070 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1071 * - encoding: Set by user.
1072 * - decoding: unused
1074 float b_quant_offset;
1077 * Error resilience; higher values will detect more errors but may
1078 * misdetect some more or less valid parts as errors.
1079 * - encoding: unused
1080 * - decoding: Set by user.
1082 int error_resilience;
1083 #define FF_ER_CAREFUL 1
1084 #define FF_ER_COMPLIANT 2
1085 #define FF_ER_AGGRESSIVE 3
1086 #define FF_ER_VERY_AGGRESSIVE 4
1089 * Called at the beginning of each frame to get a buffer for it.
1090 * If pic.reference is set then the frame will be read later by libavcodec.
1091 * avcodec_align_dimensions() should be used to find the required width and
1092 * height, as they normally need to be rounded up to the next multiple of 16.
1093 * - encoding: unused
1094 * - decoding: Set by libavcodec., user can override.
1096 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1099 * Called to release buffers which where allocated with get_buffer.
1100 * A released buffer can be reused in get_buffer().
1101 * pic.data[*] must be set to NULL.
1102 * - encoding: unused
1103 * - decoding: Set by libavcodec., user can override.
1105 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1108 * If 1 the stream has a 1 frame delay during decoding.
1109 * - encoding: Set by libavcodec.
1110 * - decoding: Set by libavcodec.
1115 * number of bytes per packet if constant and known or 0
1116 * Used by some WAV based audio codecs.
1120 int parse_only; /* - decoding only: If true, only parsing is done
1121 (function avcodec_parse_frame()). The frame
1122 data is returned. Only MPEG codecs support this now. */
1125 * 0-> h263 quant 1-> mpeg quant
1126 * - encoding: Set by user.
1127 * - decoding: unused
1132 * pass1 encoding statistics output buffer
1133 * - encoding: Set by libavcodec.
1134 * - decoding: unused
1139 * pass2 encoding statistics input buffer
1140 * Concatenated stuff from stats_out of pass1 should be placed here.
1141 * - encoding: Allocated/set/freed by user.
1142 * - decoding: unused
1147 * ratecontrol qmin qmax limiting method
1148 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1149 * - encoding: Set by user.
1150 * - decoding: unused
1158 * ratecontrol override, see RcOverride
1159 * - encoding: Allocated/set/freed by user.
1160 * - decoding: unused
1162 RcOverride *rc_override;
1163 int rc_override_count;
1166 * rate control equation
1167 * - encoding: Set by user
1168 * - decoding: unused
1174 * - encoding: Set by user.
1175 * - decoding: unused
1181 * - encoding: Set by user.
1182 * - decoding: unused
1187 * decoder bitstream buffer size
1188 * - encoding: Set by user.
1189 * - decoding: unused
1192 float rc_buffer_aggressivity;
1195 * qscale factor between P and I-frames
1196 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1197 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1198 * - encoding: Set by user.
1199 * - decoding: unused
1201 float i_quant_factor;
1204 * qscale offset between P and I-frames
1205 * - encoding: Set by user.
1206 * - decoding: unused
1208 float i_quant_offset;
1211 * initial complexity for pass1 ratecontrol
1212 * - encoding: Set by user.
1213 * - decoding: unused
1215 float rc_initial_cplx;
1218 * DCT algorithm, see FF_DCT_* below
1219 * - encoding: Set by user.
1220 * - decoding: unused
1223 #define FF_DCT_AUTO 0
1224 #define FF_DCT_FASTINT 1
1225 #define FF_DCT_INT 2
1226 #define FF_DCT_MMX 3
1227 #define FF_DCT_MLIB 4
1228 #define FF_DCT_ALTIVEC 5
1229 #define FF_DCT_FAAN 6
1232 * luminance masking (0-> disabled)
1233 * - encoding: Set by user.
1234 * - decoding: unused
1239 * temporary complexity masking (0-> disabled)
1240 * - encoding: Set by user.
1241 * - decoding: unused
1243 float temporal_cplx_masking;
1246 * spatial complexity masking (0-> disabled)
1247 * - encoding: Set by user.
1248 * - decoding: unused
1250 float spatial_cplx_masking;
1253 * p block masking (0-> disabled)
1254 * - encoding: Set by user.
1255 * - decoding: unused
1260 * darkness masking (0-> disabled)
1261 * - encoding: Set by user.
1262 * - decoding: unused
1267 /* for binary compatibility */
1271 * IDCT algorithm, see FF_IDCT_* below.
1272 * - encoding: Set by user.
1273 * - decoding: Set by user.
1276 #define FF_IDCT_AUTO 0
1277 #define FF_IDCT_INT 1
1278 #define FF_IDCT_SIMPLE 2
1279 #define FF_IDCT_SIMPLEMMX 3
1280 #define FF_IDCT_LIBMPEG2MMX 4
1281 #define FF_IDCT_PS2 5
1282 #define FF_IDCT_MLIB 6
1283 #define FF_IDCT_ARM 7
1284 #define FF_IDCT_ALTIVEC 8
1285 #define FF_IDCT_SH4 9
1286 #define FF_IDCT_SIMPLEARM 10
1287 #define FF_IDCT_H264 11
1288 #define FF_IDCT_VP3 12
1289 #define FF_IDCT_IPP 13
1290 #define FF_IDCT_XVIDMMX 14
1291 #define FF_IDCT_CAVS 15
1292 #define FF_IDCT_SIMPLEARMV5TE 16
1293 #define FF_IDCT_SIMPLEARMV6 17
1294 #define FF_IDCT_SIMPLEVIS 18
1298 * - encoding: Set by libavcodec.
1299 * - decoding: Set by user (or 0).
1303 * slice offsets in the frame in bytes
1304 * - encoding: Set/allocated by libavcodec.
1305 * - decoding: Set/allocated by user (or NULL).
1310 * error concealment flags
1311 * - encoding: unused
1312 * - decoding: Set by user.
1314 int error_concealment;
1315 #define FF_EC_GUESS_MVS 1
1316 #define FF_EC_DEBLOCK 2
1319 * dsp_mask could be add used to disable unwanted CPU features
1320 * CPU features (i.e. MMX, SSE. ...)
1322 * With the FORCE flag you may instead enable given CPU features.
1323 * (Dangerous: Usable in case of misdetection, improper usage however will
1324 * result into program crash.)
1327 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1328 /* lower 16 bits - CPU features */
1329 #define FF_MM_MMX 0x0001 /* standard MMX */
1330 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1331 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1332 #define FF_MM_SSE 0x0008 /* SSE functions */
1333 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1334 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1335 #define FF_MM_SSE3 0x0040 /* Prescott SSE3 functions */
1336 #define FF_MM_SSSE3 0x0080 /* Conroe SSSE3 functions */
1337 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1340 * bits per sample/pixel from the demuxer (needed for huffyuv).
1341 * - encoding: Set by libavcodec.
1342 * - decoding: Set by user.
1344 int bits_per_sample;
1347 * prediction method (needed for huffyuv)
1348 * - encoding: Set by user.
1349 * - decoding: unused
1351 int prediction_method;
1352 #define FF_PRED_LEFT 0
1353 #define FF_PRED_PLANE 1
1354 #define FF_PRED_MEDIAN 2
1357 * sample aspect ratio (0 if unknown)
1358 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1359 * - encoding: Set by user.
1360 * - decoding: Set by libavcodec.
1362 AVRational sample_aspect_ratio;
1365 * the picture in the bitstream
1366 * - encoding: Set by libavcodec.
1367 * - decoding: Set by libavcodec.
1369 AVFrame *coded_frame;
1373 * - encoding: Set by user.
1374 * - decoding: Set by user.
1377 #define FF_DEBUG_PICT_INFO 1
1378 #define FF_DEBUG_RC 2
1379 #define FF_DEBUG_BITSTREAM 4
1380 #define FF_DEBUG_MB_TYPE 8
1381 #define FF_DEBUG_QP 16
1382 #define FF_DEBUG_MV 32
1383 #define FF_DEBUG_DCT_COEFF 0x00000040
1384 #define FF_DEBUG_SKIP 0x00000080
1385 #define FF_DEBUG_STARTCODE 0x00000100
1386 #define FF_DEBUG_PTS 0x00000200
1387 #define FF_DEBUG_ER 0x00000400
1388 #define FF_DEBUG_MMCO 0x00000800
1389 #define FF_DEBUG_BUGS 0x00001000
1390 #define FF_DEBUG_VIS_QP 0x00002000
1391 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1395 * - encoding: Set by user.
1396 * - decoding: Set by user.
1399 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1400 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1401 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1405 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1406 * - decoding: unused
1411 * minimum MB quantizer
1412 * - encoding: unused
1413 * - decoding: unused
1418 * maximum MB quantizer
1419 * - encoding: unused
1420 * - decoding: unused
1425 * motion estimation comparison function
1426 * - encoding: Set by user.
1427 * - decoding: unused
1431 * subpixel motion estimation comparison function
1432 * - encoding: Set by user.
1433 * - decoding: unused
1437 * macroblock comparison function (not supported yet)
1438 * - encoding: Set by user.
1439 * - decoding: unused
1443 * interlaced DCT comparison function
1444 * - encoding: Set by user.
1445 * - decoding: unused
1448 #define FF_CMP_SAD 0
1449 #define FF_CMP_SSE 1
1450 #define FF_CMP_SATD 2
1451 #define FF_CMP_DCT 3
1452 #define FF_CMP_PSNR 4
1453 #define FF_CMP_BIT 5
1455 #define FF_CMP_ZERO 7
1456 #define FF_CMP_VSAD 8
1457 #define FF_CMP_VSSE 9
1458 #define FF_CMP_NSSE 10
1459 #define FF_CMP_W53 11
1460 #define FF_CMP_W97 12
1461 #define FF_CMP_DCTMAX 13
1462 #define FF_CMP_DCT264 14
1463 #define FF_CMP_CHROMA 256
1466 * ME diamond size & shape
1467 * - encoding: Set by user.
1468 * - decoding: unused
1473 * amount of previous MV predictors (2a+1 x 2a+1 square)
1474 * - encoding: Set by user.
1475 * - decoding: unused
1477 int last_predictor_count;
1480 * prepass for motion estimation
1481 * - encoding: Set by user.
1482 * - decoding: unused
1487 * motion estimation prepass comparison function
1488 * - encoding: Set by user.
1489 * - decoding: unused
1494 * ME prepass diamond size & shape
1495 * - encoding: Set by user.
1496 * - decoding: unused
1502 * - encoding: Set by user.
1503 * - decoding: unused
1505 int me_subpel_quality;
1508 * callback to negotiate the pixelFormat
1509 * @param fmt is the list of formats which are supported by the codec,
1510 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1511 * The first is always the native one.
1512 * @return the chosen format
1513 * - encoding: unused
1514 * - decoding: Set by user, if not set the native format will be chosen.
1516 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1519 * DTG active format information (additional aspect ratio
1520 * information only used in DVB MPEG-2 transport streams)
1523 * - encoding: unused
1524 * - decoding: Set by decoder.
1526 int dtg_active_format;
1527 #define FF_DTG_AFD_SAME 8
1528 #define FF_DTG_AFD_4_3 9
1529 #define FF_DTG_AFD_16_9 10
1530 #define FF_DTG_AFD_14_9 11
1531 #define FF_DTG_AFD_4_3_SP_14_9 13
1532 #define FF_DTG_AFD_16_9_SP_14_9 14
1533 #define FF_DTG_AFD_SP_4_3 15
1536 * maximum motion estimation search range in subpel units
1537 * If 0 then no limit.
1539 * - encoding: Set by user.
1540 * - decoding: unused
1545 * intra quantizer bias
1546 * - encoding: Set by user.
1547 * - decoding: unused
1549 int intra_quant_bias;
1550 #define FF_DEFAULT_QUANT_BIAS 999999
1553 * inter quantizer bias
1554 * - encoding: Set by user.
1555 * - decoding: unused
1557 int inter_quant_bias;
1561 * - encoding: unused
1562 * - decoding: Which clrtable should be used for 8bit RGB images.
1563 * Tables have to be stored somewhere. FIXME
1568 * internal_buffer count
1569 * Don't touch, used by libavcodec default_get_buffer().
1571 int internal_buffer_count;
1575 * Don't touch, used by libavcodec default_get_buffer().
1577 void *internal_buffer;
1579 #define FF_LAMBDA_SHIFT 7
1580 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1581 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1582 #define FF_LAMBDA_MAX (256*128-1)
1584 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1586 * Global quality for codecs which cannot change it per frame.
1587 * This should be proportional to MPEG-1/2/4 qscale.
1588 * - encoding: Set by user.
1589 * - decoding: unused
1593 #define FF_CODER_TYPE_VLC 0
1594 #define FF_CODER_TYPE_AC 1
1595 #define FF_CODER_TYPE_RAW 2
1596 #define FF_CODER_TYPE_RLE 3
1597 #define FF_CODER_TYPE_DEFLATE 4
1600 * - encoding: Set by user.
1601 * - decoding: unused
1607 * - encoding: Set by user.
1608 * - decoding: unused
1614 * - encoding: unused
1615 * - decoding: Set by user.
1617 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1622 * - encoding: unused
1623 * - decoding: Set by user.
1626 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1627 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1628 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1631 * XVideo Motion Acceleration
1632 * - encoding: forbidden
1633 * - decoding: set by decoder
1635 int xvmc_acceleration;
1638 * macroblock decision mode
1639 * - encoding: Set by user.
1640 * - decoding: unused
1643 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1644 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1645 #define FF_MB_DECISION_RD 2 ///< rate distoration
1648 * custom intra quantization matrix
1649 * - encoding: Set by user, can be NULL.
1650 * - decoding: Set by libavcodec.
1652 uint16_t *intra_matrix;
1655 * custom inter quantization matrix
1656 * - encoding: Set by user, can be NULL.
1657 * - decoding: Set by libavcodec.
1659 uint16_t *inter_matrix;
1662 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1663 * This is used to work around some encoder bugs.
1664 * - encoding: unused
1665 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1667 unsigned int stream_codec_tag;
1670 * scene change detection threshold
1671 * 0 is default, larger means fewer detected scene changes.
1672 * - encoding: Set by user.
1673 * - decoding: unused
1675 int scenechange_threshold;
1678 * minimum Lagrange multipler
1679 * - encoding: Set by user.
1680 * - decoding: unused
1685 * maximum Lagrange multipler
1686 * - encoding: Set by user.
1687 * - decoding: unused
1692 * palette control structure
1693 * - encoding: ??? (no palette-enabled encoder yet)
1694 * - decoding: Set by user.
1696 struct AVPaletteControl *palctrl;
1699 * noise reduction strength
1700 * - encoding: Set by user.
1701 * - decoding: unused
1703 int noise_reduction;
1706 * Called at the beginning of a frame to get cr buffer for it.
1707 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1708 * libavcodec will pass previous buffer in pic, function should return
1709 * same buffer or new buffer with old frame "painted" into it.
1710 * If pic.data[0] == NULL must behave like get_buffer().
1711 * - encoding: unused
1712 * - decoding: Set by libavcodec., user can override
1714 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1717 * Number of bits which should be loaded into the rc buffer before decoding starts.
1718 * - encoding: Set by user.
1719 * - decoding: unused
1721 int rc_initial_buffer_occupancy;
1725 * - encoding: Set by user.
1726 * - decoding: unused
1728 int inter_threshold;
1732 * - encoding: Set by user.
1733 * - decoding: Set by user.
1738 * Simulates errors in the bitstream to test error concealment.
1739 * - encoding: Set by user.
1740 * - decoding: unused
1745 * MP3 antialias algorithm, see FF_AA_* below.
1746 * - encoding: unused
1747 * - decoding: Set by user.
1750 #define FF_AA_AUTO 0
1751 #define FF_AA_FASTINT 1 //not implemented yet
1753 #define FF_AA_FLOAT 3
1755 * quantizer noise shaping
1756 * - encoding: Set by user.
1757 * - decoding: unused
1759 int quantizer_noise_shaping;
1763 * is used to decide how many independent tasks should be passed to execute()
1764 * - encoding: Set by user.
1765 * - decoding: Set by user.
1770 * The codec may call this to execute several independent things.
1771 * It will return only after finishing all tasks.
1772 * The user may replace this with some multithreaded implementation,
1773 * the default implementation will execute the parts serially.
1774 * @param count the number of things to execute
1775 * - encoding: Set by libavcodec, user can override.
1776 * - decoding: Set by libavcodec, user can override.
1778 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1782 * Can be used by execute() to store some per AVCodecContext stuff.
1783 * - encoding: set by execute()
1784 * - decoding: set by execute()
1786 void *thread_opaque;
1789 * Motion estimation threshold below which no motion estimation is
1790 * performed, but instead the user specified motion vectors are used.
1792 * - encoding: Set by user.
1793 * - decoding: unused
1798 * Macroblock threshold below which the user specified macroblock types will be used.
1799 * - encoding: Set by user.
1800 * - decoding: unused
1805 * precision of the intra DC coefficient - 8
1806 * - encoding: Set by user.
1807 * - decoding: unused
1809 int intra_dc_precision;
1812 * noise vs. sse weight for the nsse comparsion function
1813 * - encoding: Set by user.
1814 * - decoding: unused
1819 * Number of macroblock rows at the top which are skipped.
1820 * - encoding: unused
1821 * - decoding: Set by user.
1826 * Number of macroblock rows at the bottom which are skipped.
1827 * - encoding: unused
1828 * - decoding: Set by user.
1834 * - encoding: Set by user.
1835 * - decoding: Set by libavcodec.
1838 #define FF_PROFILE_UNKNOWN -99
1839 #define FF_PROFILE_AAC_MAIN 0
1840 #define FF_PROFILE_AAC_LOW 1
1841 #define FF_PROFILE_AAC_SSR 2
1842 #define FF_PROFILE_AAC_LTP 3
1846 * - encoding: Set by user.
1847 * - decoding: Set by libavcodec.
1850 #define FF_LEVEL_UNKNOWN -99
1853 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1854 * - encoding: unused
1855 * - decoding: Set by user.
1860 * Bitstream width / height, may be different from width/height if lowres
1861 * or other things are used.
1862 * - encoding: unused
1863 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1865 int coded_width, coded_height;
1868 * frame skip threshold
1869 * - encoding: Set by user.
1870 * - decoding: unused
1872 int frame_skip_threshold;
1876 * - encoding: Set by user.
1877 * - decoding: unused
1879 int frame_skip_factor;
1882 * frame skip exponent
1883 * - encoding: Set by user.
1884 * - decoding: unused
1889 * frame skip comparison function
1890 * - encoding: Set by user.
1891 * - decoding: unused
1896 * Border processing masking, raises the quantizer for mbs on the borders
1898 * - encoding: Set by user.
1899 * - decoding: unused
1901 float border_masking;
1904 * minimum MB lagrange multipler
1905 * - encoding: Set by user.
1906 * - decoding: unused
1911 * maximum MB lagrange multipler
1912 * - encoding: Set by user.
1913 * - decoding: unused
1919 * - encoding: Set by user.
1920 * - decoding: unused
1922 int me_penalty_compensation;
1926 * - encoding: unused
1927 * - decoding: Set by user.
1929 enum AVDiscard skip_loop_filter;
1933 * - encoding: unused
1934 * - decoding: Set by user.
1936 enum AVDiscard skip_idct;
1940 * - encoding: unused
1941 * - decoding: Set by user.
1943 enum AVDiscard skip_frame;
1947 * - encoding: Set by user.
1948 * - decoding: unused
1954 * - encoding: Set by user.
1955 * - decoding: unused
1960 * constant rate factor - quality-based VBR - values ~correspond to qps
1961 * - encoding: Set by user.
1962 * - decoding: unused
1967 * constant quantization parameter rate control method
1968 * - encoding: Set by user.
1969 * - decoding: unused
1975 * - encoding: Set by user.
1976 * - decoding: unused
1981 * number of reference frames
1982 * - encoding: Set by user.
1983 * - decoding: unused
1988 * chroma qp offset from luma
1989 * - encoding: Set by user.
1990 * - decoding: unused
1995 * Influences how often B-frames are used.
1996 * - encoding: Set by user.
1997 * - decoding: unused
2002 * trellis RD quantization
2003 * - encoding: Set by user.
2004 * - decoding: unused
2009 * Reduce fluctuations in qp (before curve compression).
2010 * - encoding: Set by user.
2011 * - decoding: unused
2013 float complexityblur;
2016 * in-loop deblocking filter alphac0 parameter
2017 * alpha is in the range -6...6
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * in-loop deblocking filter beta parameter
2025 * beta is in the range -6...6
2026 * - encoding: Set by user.
2027 * - decoding: unused
2032 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2033 * - encoding: Set by user.
2034 * - decoding: unused
2037 #define X264_PART_I4X4 0x001 /* Analyse i4x4 */
2038 #define X264_PART_I8X8 0x002 /* Analyse i8x8 (requires 8x8 transform) */
2039 #define X264_PART_P8X8 0x010 /* Analyse p16x8, p8x16 and p8x8 */
2040 #define X264_PART_P4X4 0x020 /* Analyse p8x4, p4x8, p4x4 */
2041 #define X264_PART_B8X8 0x100 /* Analyse b16x8, b8x16 and b8x8 */
2044 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2045 * - encoding: Set by user.
2046 * - decoding: unused
2051 * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2052 * - encoding: Set by user.
2053 * - decoding: unused
2058 * Multiplied by qscale for each frame and added to scene_change_score.
2059 * - encoding: Set by user.
2060 * - decoding: unused
2062 int scenechange_factor;
2066 * Note: Value depends upon the compare function used for fullpel ME.
2067 * - encoding: Set by user.
2068 * - decoding: unused
2073 * Adjusts sensitivity of b_frame_strategy 1.
2074 * - encoding: Set by user.
2075 * - decoding: unused
2080 * - encoding: Set by user.
2081 * - decoding: unused
2083 int compression_level;
2084 #define FF_COMPRESSION_DEFAULT -1
2087 * Sets whether to use LPC mode - used by FLAC encoder.
2088 * - encoding: Set by user.
2089 * - decoding: unused
2094 * LPC coefficient precision - used by FLAC encoder
2095 * - encoding: Set by user.
2096 * - decoding: unused
2098 int lpc_coeff_precision;
2101 * - encoding: Set by user.
2102 * - decoding: unused
2104 int min_prediction_order;
2107 * - encoding: Set by user.
2108 * - decoding: unused
2110 int max_prediction_order;
2113 * search method for selecting prediction order
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int prediction_order_method;
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int min_partition_order;
2126 * - encoding: Set by user.
2127 * - decoding: unused
2129 int max_partition_order;
2132 * GOP timecode frame start number, in non drop frame format
2133 * - encoding: Set by user.
2134 * - decoding: unused
2136 int64_t timecode_frame_start;
2139 * Decoder should decode to this many channels if it can (0 for default)
2140 * - encoding: unused
2141 * - decoding: Set by user.
2143 int request_channels;
2149 typedef struct AVCodec {
2151 * Name of the codec implementation.
2152 * The name is globally unique among encoders and among decoders (but an
2153 * encoder and a decoder can share the same name).
2154 * This is the primary way to find a codec from the user perspective.
2157 enum CodecType type;
2160 int (*init)(AVCodecContext *);
2161 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2162 int (*close)(AVCodecContext *);
2163 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2164 uint8_t *buf, int buf_size);
2166 struct AVCodec *next;
2167 void (*flush)(AVCodecContext *);
2168 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2169 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2173 * four components are given, that's all.
2174 * the last component is alpha
2176 typedef struct AVPicture {
2178 int linesize[4]; ///< number of bytes per line
2183 * This structure defines a method for communicating palette changes
2184 * between and demuxer and a decoder.
2186 * @deprecated Use AVPacket to send palette changes instead.
2187 * This is totally broken.
2189 #define AVPALETTE_SIZE 1024
2190 #define AVPALETTE_COUNT 256
2191 typedef struct AVPaletteControl {
2193 /* Demuxer sets this to 1 to indicate the palette has changed;
2194 * decoder resets to 0. */
2195 int palette_changed;
2197 /* 4-byte ARGB palette entries, stored in native byte order; note that
2198 * the individual palette components should be on a 8-bit scale; if
2199 * the palette data comes from an IBM VGA native format, the component
2200 * data is probably 6 bits in size and needs to be scaled. */
2201 unsigned int palette[AVPALETTE_COUNT];
2203 } AVPaletteControl attribute_deprecated;
2205 typedef struct AVSubtitleRect {
2212 uint32_t *rgba_palette;
2216 typedef struct AVSubtitle {
2217 uint16_t format; /* 0 = graphics */
2218 uint32_t start_display_time; /* relative to packet pts, in ms */
2219 uint32_t end_display_time; /* relative to packet pts, in ms */
2221 AVSubtitleRect *rects;
2227 struct ReSampleContext;
2228 struct AVResampleContext;
2230 typedef struct ReSampleContext ReSampleContext;
2232 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2233 int output_rate, int input_rate);
2234 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2235 void audio_resample_close(ReSampleContext *s);
2237 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2238 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2239 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2240 void av_resample_close(struct AVResampleContext *c);
2242 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2243 /* YUV420 format is assumed ! */
2246 * @deprecated Use the software scaler (swscale) instead.
2248 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2251 * @deprecated Use the software scaler (swscale) instead.
2253 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2254 int input_width, int input_height);
2257 * @deprecated Use the software scaler (swscale) instead.
2259 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2260 int iwidth, int iheight,
2261 int topBand, int bottomBand,
2262 int leftBand, int rightBand,
2263 int padtop, int padbottom,
2264 int padleft, int padright);
2267 * @deprecated Use the software scaler (swscale) instead.
2269 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2270 AVPicture *output, const AVPicture *input);
2273 * @deprecated Use the software scaler (swscale) instead.
2275 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2280 * Allocate memory for a picture. Call avpicture_free to free it.
2282 * @param picture the picture to be filled in
2283 * @param pix_fmt the format of the picture
2284 * @param width the width of the picture
2285 * @param height the height of the picture
2286 * @return zero if successful, a negative value if not
2288 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2291 * Free a picture previously allocated by avpicture_alloc().
2293 * @param picture the AVPicture to be freed
2295 void avpicture_free(AVPicture *picture);
2298 * Fill in the AVPicture fields.
2299 * The fields of the given AVPicture are filled in by using the 'ptr' address
2300 * which points to the image data buffer. Depending on the specified picture
2301 * format, one or multiple image data pointers and line sizes will be set.
2302 * If a planar format is specified, several pointers will be set pointing to
2303 * the different picture planes and the line sizes of the different planes
2304 * will be stored in the lines_sizes array.
2306 * @param picture AVPicture whose fields are to be filled in
2307 * @param ptr Buffer which will contain or contains the actual image data
2308 * @param pix_fmt The format in which the picture data is stored.
2309 * @param width the width of the image in pixels
2310 * @param height the height of the image in pixels
2311 * @return size of the image data in bytes
2313 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2314 int pix_fmt, int width, int height);
2315 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2316 unsigned char *dest, int dest_size);
2319 * Calculate the size in bytes that a picture of the given width and height
2320 * would occupy if stored in the given picture format.
2322 * @param pix_fmt the given picture format
2323 * @param width the width of the image
2324 * @param height the height of the image
2325 * @return Image data size in bytes
2327 int avpicture_get_size(int pix_fmt, int width, int height);
2328 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2329 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2330 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2331 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2332 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2334 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2335 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2336 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2337 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2338 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2339 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2342 * Computes what kind of losses will occur when converting from one specific
2343 * pixel format to another.
2344 * When converting from one pixel format to another, information loss may occur.
2345 * For example, when converting from RGB24 to GRAY, the color information will
2346 * be lost. Similarly, other losses occur when converting from some formats to
2347 * other formats. These losses can involve loss of chroma, but also loss of
2348 * resolution, loss of color depth, loss due to the color space conversion, loss
2349 * of the alpha bits or loss due to color quantization.
2350 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2351 * which will occur when converting from one pixel format to another.
2353 * @param[in] dst_pix_fmt destination pixel format
2354 * @param[in] src_pix_fmt source pixel format
2355 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2356 * @return Combination of flags informing you what kind of losses will occur.
2358 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2362 * Finds the best pixel format to convert to given a certain source pixel
2363 * format. When converting from one pixel format to another, information loss
2364 * may occur. For example, when converting from RGB24 to GRAY, the color
2365 * information will be lost. Similarly, other losses occur when converting from
2366 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2367 * the given pixel formats should be used to suffer the least amount of loss.
2368 * The pixel formats from which it chooses one, are determined by the
2369 * \p pix_fmt_mask parameter.
2372 * src_pix_fmt = PIX_FMT_YUV420P;
2373 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2374 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2377 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2378 * @param[in] src_pix_fmt source pixel format
2379 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2380 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2381 * @return The best pixel format to convert to or -1 if none was found.
2383 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2384 int has_alpha, int *loss_ptr);
2388 * Print in buf the string corresponding to the pixel format with
2389 * number pix_fmt, or an header if pix_fmt is negative.
2391 * @param buf[in] the buffer where to write the string
2392 * @param buf_size[in] the size of buf
2393 * @param pix_fmt[in] the number of the pixel format to print the corresponding info string, or
2394 * a negative value to print the corresponding header.
2395 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2397 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2399 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2400 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2403 * Tell if an image really has transparent alpha values.
2404 * @return ored mask of FF_ALPHA_xxx constants
2406 int img_get_alpha_info(const AVPicture *src,
2407 int pix_fmt, int width, int height);
2409 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2411 * convert among pixel formats
2412 * @deprecated Use the software scaler (swscale) instead.
2414 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2415 const AVPicture *src, int pix_fmt,
2416 int width, int height);
2419 /* deinterlace a picture */
2420 /* deinterlace - if not supported return -1 */
2421 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2422 int pix_fmt, int width, int height);
2424 /* external high level API */
2426 extern AVCodec *first_avcodec;
2428 /* returns LIBAVCODEC_VERSION_INT constant */
2429 unsigned avcodec_version(void);
2430 /* returns LIBAVCODEC_BUILD constant */
2431 unsigned avcodec_build(void);
2434 * Initializes libavcodec.
2436 * @warning This function \e must be called before any other libavcodec
2439 void avcodec_init(void);
2441 void register_avcodec(AVCodec *format);
2444 * Finds a registered encoder with a matching codec ID.
2446 * @param id CodecID of the requested encoder
2447 * @return An encoder if one was found, NULL otherwise.
2449 AVCodec *avcodec_find_encoder(enum CodecID id);
2452 * Finds a registered encoder with the specified name.
2454 * @param name name of the requested encoder
2455 * @return An encoder if one was found, NULL otherwise.
2457 AVCodec *avcodec_find_encoder_by_name(const char *name);
2460 * Finds a registered decoder with a matching codec ID.
2462 * @param id CodecID of the requested decoder
2463 * @return A decoder if one was found, NULL otherwise.
2465 AVCodec *avcodec_find_decoder(enum CodecID id);
2468 * Finds a registered decoder with the specified name.
2470 * @param name name of the requested decoder
2471 * @return A decoder if one was found, NULL otherwise.
2473 AVCodec *avcodec_find_decoder_by_name(const char *name);
2474 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2477 * Sets the fields of the given AVCodecContext to default values.
2479 * @param s The AVCodecContext of which the fields should be set to default values.
2481 void avcodec_get_context_defaults(AVCodecContext *s);
2483 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2484 * we WILL change its arguments and name a few times! */
2485 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2488 * Allocates an AVCodecContext and sets its fields to default values. The
2489 * resulting struct can be deallocated by simply calling av_free().
2491 * @return An AVCodecContext filled with default values or NULL on failure.
2492 * @see avcodec_get_context_defaults
2494 AVCodecContext *avcodec_alloc_context(void);
2496 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2497 * we WILL change its arguments and name a few times! */
2498 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2501 * Sets the fields of the given AVFrame to default values.
2503 * @param pic The AVFrame of which the fields should be set to default values.
2505 void avcodec_get_frame_defaults(AVFrame *pic);
2508 * Allocates an AVFrame and sets its fields to default values. The resulting
2509 * struct can be deallocated by simply calling av_free().
2511 * @return An AVFrame filled with default values or NULL on failure.
2512 * @see avcodec_get_frame_defaults
2514 AVFrame *avcodec_alloc_frame(void);
2516 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2517 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2518 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2519 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2522 * Checks if the given dimension of a picture is valid, meaning that all
2523 * bytes of the picture can be addressed with a signed int.
2525 * @param[in] w Width of the picture.
2526 * @param[in] h Height of the picture.
2527 * @return Zero if valid, a negative value if invalid.
2529 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2530 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2532 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2533 void avcodec_thread_free(AVCodecContext *s);
2534 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2535 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2536 //FIXME func typedef
2539 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2540 * function the context has to be allocated.
2542 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2543 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2544 * retrieving a codec.
2546 * @warning This function is not thread safe!
2549 * avcodec_register_all();
2550 * codec = avcodec_find_decoder(CODEC_ID_H264);
2554 * context = avcodec_alloc_context();
2556 * if (avcodec_open(context, codec) < 0)
2560 * @param avctx The context which will be set up to use the given codec.
2561 * @param codec The codec to use within the context.
2562 * @return zero on success, a negative value on error
2563 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2565 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2568 * @deprecated Use avcodec_decode_audio2() instead.
2570 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2571 int *frame_size_ptr,
2572 uint8_t *buf, int buf_size);
2575 * Decodes an audio frame from \p buf into \p samples.
2576 * The avcodec_decode_audio2() function decodes an audio frame from the input
2577 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2578 * audio codec which was coupled with \p avctx using avcodec_open(). The
2579 * resulting decoded frame is stored in output buffer \p samples. If no frame
2580 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2581 * decompressed frame size in \e bytes.
2583 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2584 * output buffer before calling avcodec_decode_audio2().
2586 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2587 * the actual read bytes because some optimized bitstream readers read 32 or 64
2588 * bits at once and could read over the end.
2590 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2591 * no overreading happens for damaged MPEG streams.
2593 * @note You might have to align the input buffer \p buf and output buffer \p
2594 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2595 * necessary at all, on others it won't work at all if not aligned and on others
2596 * it will work but it will have an impact on performance. In practice, the
2597 * bitstream should have 4 byte alignment at minimum and all sample data should
2598 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2599 * the linesize is not a multiple of 16 then there's no sense in aligning the
2600 * start of the buffer to 16.
2602 * @param avctx the codec context
2603 * @param[out] samples the output buffer
2604 * @param[in,out] frame_size_ptr the output buffer size in bytes
2605 * @param[in] buf the input buffer
2606 * @param[in] buf_size the input buffer size in bytes
2607 * @return On error a negative value is returned, otherwise the number of bytes
2608 * used or zero if no frame could be decompressed.
2610 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2611 int *frame_size_ptr,
2612 uint8_t *buf, int buf_size);
2615 * Decodes a video frame from \p buf into \p picture.
2616 * The avcodec_decode_video() function decodes a video frame from the input
2617 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2618 * video codec which was coupled with \p avctx using avcodec_open(). The
2619 * resulting decoded frame is stored in \p picture.
2621 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2622 * the actual read bytes because some optimized bitstream readers read 32 or 64
2623 * bits at once and could read over the end.
2625 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2626 * no overreading happens for damaged MPEG streams.
2628 * @note You might have to align the input buffer \p buf and output buffer \p
2629 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2630 * necessary at all, on others it won't work at all if not aligned and on others
2631 * it will work but it will have an impact on performance. In practice, the
2632 * bitstream should have 4 byte alignment at minimum and all sample data should
2633 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2634 * the linesize is not a multiple of 16 then there's no sense in aligning the
2635 * start of the buffer to 16.
2637 * @param avctx the codec context
2638 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2639 * @param[in] buf the input buffer
2640 * @param[in] buf_size the size of the input buffer in bytes
2641 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2642 * @return On error a negative value is returned, otherwise the number of bytes
2643 * used or zero if no frame could be decompressed.
2645 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2646 int *got_picture_ptr,
2647 uint8_t *buf, int buf_size);
2649 /* Decode a subtitle message. Return -1 if error, otherwise return the
2650 * number of bytes used. If no subtitle could be decompressed,
2651 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2652 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2654 const uint8_t *buf, int buf_size);
2655 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2657 uint8_t *buf, int buf_size);
2660 * Encodes an audio frame from \p samples into \p buf.
2661 * The avcodec_encode_audio() function encodes an audio frame from the input
2662 * buffer \p samples. To encode it, it makes use of the audio codec which was
2663 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2664 * stored in output buffer \p buf.
2666 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2668 * @param avctx the codec context
2669 * @param[out] buf the output buffer
2670 * @param[in] buf_size the output buffer size
2671 * @param[in] samples the input buffer containing the samples
2672 * @return On error a negative value is returned, on succes zero or the number
2673 * of bytes used from the input buffer.
2675 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2676 const short *samples);
2679 * Encodes a video frame from \p pict into \p buf.
2680 * The avcodec_encode_video() function encodes a video frame from the input
2681 * \p pict. To encode it, it makes use of the video codec which was coupled with
2682 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2683 * frame are stored in the output buffer \p buf. The input picture should be
2684 * stored using a specific format, namely \c avctx.pix_fmt.
2686 * @param avctx the codec context
2687 * @param[out] buf the output buffer for the bitstream of encoded frame
2688 * @param[in] buf_size the size of the output buffer in bytes
2689 * @param[in] pict the input picture to encode
2690 * @return On error a negative value is returned, on success zero or the number
2691 * of bytes used from the input buffer.
2693 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2694 const AVFrame *pict);
2695 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2696 const AVSubtitle *sub);
2698 int avcodec_close(AVCodecContext *avctx);
2700 void avcodec_register_all(void);
2703 * Flush buffers, should be called when seeking or when switching to a different stream.
2705 void avcodec_flush_buffers(AVCodecContext *avctx);
2707 void avcodec_default_free_buffers(AVCodecContext *s);
2709 /* misc useful functions */
2712 * Returns a single letter to describe the given picture type \p pict_type.
2714 * @param[in] pict_type the picture type
2715 * @return A single character representing the picture type.
2717 char av_get_pict_type_char(int pict_type);
2720 * Returns codec bits per sample.
2722 * @param[in] codec_id the codec
2723 * @return Number of bits per sample or zero if unknown for the given codec.
2725 int av_get_bits_per_sample(enum CodecID codec_id);
2728 * Returns sample format bits per sample.
2730 * @param[in] sample_fmt the sample format
2731 * @return Number of bits per sample or zero if unknown for the given sample format.
2733 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2736 typedef struct AVCodecParserContext {
2738 struct AVCodecParser *parser;
2739 int64_t frame_offset; /* offset of the current frame */
2740 int64_t cur_offset; /* current offset
2741 (incremented by each av_parser_parse()) */
2742 int64_t last_frame_offset; /* offset of the last frame */
2744 int pict_type; /* XXX: Put it back in AVCodecContext. */
2745 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2746 int64_t pts; /* pts of the current frame */
2747 int64_t dts; /* dts of the current frame */
2752 int fetch_timestamp;
2754 #define AV_PARSER_PTS_NB 4
2755 int cur_frame_start_index;
2756 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2757 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2758 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2761 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2763 int64_t offset; ///< byte offset from starting packet start
2764 int64_t last_offset;
2765 } AVCodecParserContext;
2767 typedef struct AVCodecParser {
2768 int codec_ids[5]; /* several codec IDs are permitted */
2770 int (*parser_init)(AVCodecParserContext *s);
2771 int (*parser_parse)(AVCodecParserContext *s,
2772 AVCodecContext *avctx,
2773 const uint8_t **poutbuf, int *poutbuf_size,
2774 const uint8_t *buf, int buf_size);
2775 void (*parser_close)(AVCodecParserContext *s);
2776 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2777 struct AVCodecParser *next;
2780 extern AVCodecParser *av_first_parser;
2782 void av_register_codec_parser(AVCodecParser *parser);
2783 AVCodecParserContext *av_parser_init(int codec_id);
2784 int av_parser_parse(AVCodecParserContext *s,
2785 AVCodecContext *avctx,
2786 uint8_t **poutbuf, int *poutbuf_size,
2787 const uint8_t *buf, int buf_size,
2788 int64_t pts, int64_t dts);
2789 int av_parser_change(AVCodecParserContext *s,
2790 AVCodecContext *avctx,
2791 uint8_t **poutbuf, int *poutbuf_size,
2792 const uint8_t *buf, int buf_size, int keyframe);
2793 void av_parser_close(AVCodecParserContext *s);
2796 typedef struct AVBitStreamFilterContext {
2798 struct AVBitStreamFilter *filter;
2799 AVCodecParserContext *parser;
2800 struct AVBitStreamFilterContext *next;
2801 } AVBitStreamFilterContext;
2804 typedef struct AVBitStreamFilter {
2807 int (*filter)(AVBitStreamFilterContext *bsfc,
2808 AVCodecContext *avctx, const char *args,
2809 uint8_t **poutbuf, int *poutbuf_size,
2810 const uint8_t *buf, int buf_size, int keyframe);
2811 void (*close)(AVBitStreamFilterContext *bsfc);
2812 struct AVBitStreamFilter *next;
2813 } AVBitStreamFilter;
2815 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2816 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2817 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2818 AVCodecContext *avctx, const char *args,
2819 uint8_t **poutbuf, int *poutbuf_size,
2820 const uint8_t *buf, int buf_size, int keyframe);
2821 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2827 * Reallocates the given block if it is not large enough, otherwise it
2832 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2834 /* for static data only */
2837 * Frees all static arrays and resets their pointers to 0.
2838 * Call this function to release all statically allocated tables.
2840 * @deprecated. Code which uses av_free_static is broken/misdesigned
2841 * and should correctly use static arrays
2844 attribute_deprecated void av_free_static(void);
2847 * Allocation of static arrays.
2849 * @warning Do not use for normal allocation.
2851 * @param[in] size The amount of memory you need in bytes.
2852 * @return block of memory of the requested size
2853 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2854 * and should correctly use static arrays
2856 attribute_deprecated void *av_mallocz_static(unsigned int size);
2859 * Copy image 'src' to 'dst'.
2861 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2862 int pix_fmt, int width, int height);
2865 * Crop image top and left side.
2867 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2868 int pix_fmt, int top_band, int left_band);
2873 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2874 int padtop, int padbottom, int padleft, int padright, int *color);
2876 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2878 * @deprecated Use the software scaler (swscale) instead.
2880 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2881 int pix_fmt, int width, int height);
2884 * @deprecated Use the software scaler (swscale) instead.
2886 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2887 int pix_fmt, int top_band, int left_band);
2890 * @deprecated Use the software scaler (swscale) instead.
2892 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2893 int padtop, int padbottom, int padleft, int padright, int *color);
2896 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2899 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2901 * @return 0 in case of a successful parsing, a negative value otherwise
2902 * @param[in] str the string to parse: it has to be a string in the format
2903 * <width>x<height> or a valid video frame size abbreviation.
2904 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2906 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2907 * frame height value
2909 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2912 * Parses \p str and put in \p frame_rate the detected values.
2914 * @return 0 in case of a successful parsing, a negative value otherwise
2915 * @param[in] str the string to parse: it has to be a string in the format
2916 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2917 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2920 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2922 /* error handling */
2924 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2925 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2927 /* Some platforms have E* and errno already negated. */
2928 #define AVERROR(e) (e)
2929 #define AVUNERROR(e) (e)
2931 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2932 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2933 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2934 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2935 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2936 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2937 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2938 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2939 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2941 #endif /* FFMPEG_AVCODEC_H */