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)+(49<<8)+0)
37 #define LIBAVCODEC_VERSION 51.49.0
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,
192 CODEC_ID_PCM_S16LE_PLANAR,
194 /* various ADPCM codecs */
195 CODEC_ID_ADPCM_IMA_QT= 0x11000,
196 CODEC_ID_ADPCM_IMA_WAV,
197 CODEC_ID_ADPCM_IMA_DK3,
198 CODEC_ID_ADPCM_IMA_DK4,
199 CODEC_ID_ADPCM_IMA_WS,
200 CODEC_ID_ADPCM_IMA_SMJPEG,
209 CODEC_ID_ADPCM_YAMAHA,
210 CODEC_ID_ADPCM_SBPRO_4,
211 CODEC_ID_ADPCM_SBPRO_3,
212 CODEC_ID_ADPCM_SBPRO_2,
214 CODEC_ID_ADPCM_IMA_AMV,
215 CODEC_ID_ADPCM_EA_R1,
216 CODEC_ID_ADPCM_EA_R3,
217 CODEC_ID_ADPCM_EA_R2,
218 CODEC_ID_ADPCM_IMA_EA_SEAD,
219 CODEC_ID_ADPCM_IMA_EA_EACS,
220 CODEC_ID_ADPCM_EA_XAS,
223 CODEC_ID_AMR_NB= 0x12000,
226 /* RealAudio codecs*/
227 CODEC_ID_RA_144= 0x13000,
230 /* various DPCM codecs */
231 CODEC_ID_ROQ_DPCM= 0x14000,
232 CODEC_ID_INTERPLAY_DPCM,
236 CODEC_ID_MP2= 0x15000,
237 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
239 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
258 CODEC_ID_WESTWOOD_SND1,
259 CODEC_ID_GSM, ///< as in Berlin toast format
267 CODEC_ID_DSICINAUDIO,
271 CODEC_ID_GSM_MS, /* as found in WAV */
278 /* subtitle codecs */
279 CODEC_ID_DVD_SUBTITLE= 0x17000,
280 CODEC_ID_DVB_SUBTITLE,
281 CODEC_ID_TEXT, ///< raw UTF-8 text
284 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
285 * stream (only used by libavformat) */
288 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
289 /* CODEC_ID_MP3LAME is obsolete */
290 #define CODEC_ID_MP3LAME CODEC_ID_MP3
291 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
295 CODEC_TYPE_UNKNOWN = -1,
304 * Currently unused, may be used if 24/32 bits samples are ever supported.
305 * all in native-endian format
308 SAMPLE_FMT_NONE = -1,
309 SAMPLE_FMT_U8, ///< unsigned 8 bits
310 SAMPLE_FMT_S16, ///< signed 16 bits
311 SAMPLE_FMT_S24, ///< signed 24 bits
312 SAMPLE_FMT_S32, ///< signed 32 bits
313 SAMPLE_FMT_FLT, ///< float
317 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
320 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
321 * This is mainly needed because some optimized bitstream readers read
322 * 32 or 64 bit at once and could read over the end.<br>
323 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
324 * MPEG bitstreams could cause overread and segfault.
326 #define FF_INPUT_BUFFER_PADDING_SIZE 8
329 * minimum encoding buffer size
330 * Used to avoid some checks during header writing.
332 #define FF_MIN_BUFFER_SIZE 16384
335 * motion estimation type, EPZS by default
350 /* We leave some space between them for extensions (drop some
351 * keyframes for intra-only or drop just some bidir frames). */
352 AVDISCARD_NONE =-16, ///< discard nothing
353 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
354 AVDISCARD_NONREF = 8, ///< discard all non reference
355 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
356 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
357 AVDISCARD_ALL = 48, ///< discard all
360 typedef struct RcOverride{
363 int qscale; // If this is 0 then quality_factor will be used instead.
364 float quality_factor;
367 #define FF_MAX_B_FRAMES 16
370 These flags can be passed in AVCodecContext.flags before initialization.
371 Note: Not everything is supported yet.
374 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
375 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
376 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
377 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
378 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
379 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
380 /* The parent program guarantees that the input for B-frames containing
381 * streams is not written to for at least s->max_b_frames+1 frames, if
382 * this is not set the input will be copied. */
383 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
384 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
385 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
386 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
387 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
388 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
389 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
390 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
391 location instead of only at frame boundaries. */
392 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
393 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
394 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
395 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
396 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
397 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
398 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
399 /* Fx : Flag for h263+ extra options */
400 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
401 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
403 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
404 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
405 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
406 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
407 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
408 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
409 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
410 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
411 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
412 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
413 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
414 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
415 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
416 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
417 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
418 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
419 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
420 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
421 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
422 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
423 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
424 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
425 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
426 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
427 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
428 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
429 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
430 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
432 /* Unsupported options :
433 * Syntax Arithmetic coding (SAC)
434 * Reference Picture Selection
435 * Independent Segment Decoding */
437 /* codec capabilities */
439 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
441 * Codec uses get_buffer() for allocating buffers.
442 * direct rendering method 1
444 #define CODEC_CAP_DR1 0x0002
445 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
446 #define CODEC_CAP_PARSE_ONLY 0x0004
447 #define CODEC_CAP_TRUNCATED 0x0008
448 /* Codec can export data for HW decoding (XvMC). */
449 #define CODEC_CAP_HWACCEL 0x0010
451 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
452 * If this is not set, the codec is guaranteed to never be fed with NULL data.
454 #define CODEC_CAP_DELAY 0x0020
456 * Codec can be fed a final frame with a smaller size.
457 * This can be used to prevent truncation of the last audio samples.
459 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
461 //The following defines may change, don't expect compatibility if you use them.
462 #define MB_TYPE_INTRA4x4 0x0001
463 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
464 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
465 #define MB_TYPE_16x16 0x0008
466 #define MB_TYPE_16x8 0x0010
467 #define MB_TYPE_8x16 0x0020
468 #define MB_TYPE_8x8 0x0040
469 #define MB_TYPE_INTERLACED 0x0080
470 #define MB_TYPE_DIRECT2 0x0100 //FIXME
471 #define MB_TYPE_ACPRED 0x0200
472 #define MB_TYPE_GMC 0x0400
473 #define MB_TYPE_SKIP 0x0800
474 #define MB_TYPE_P0L0 0x1000
475 #define MB_TYPE_P1L0 0x2000
476 #define MB_TYPE_P0L1 0x4000
477 #define MB_TYPE_P1L1 0x8000
478 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
479 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
480 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
481 #define MB_TYPE_QUANT 0x00010000
482 #define MB_TYPE_CBP 0x00020000
483 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
487 * This specifies the area which should be displayed.
488 * Note there may be multiple such areas for one frame.
490 typedef struct AVPanScan{
493 * - encoding: Set by user.
494 * - decoding: Set by libavcodec.
499 * width and height in 1/16 pel
500 * - encoding: Set by user.
501 * - decoding: Set by libavcodec.
507 * position of the top left corner in 1/16 pel for up to 3 fields/frames
508 * - encoding: Set by user.
509 * - decoding: Set by libavcodec.
511 int16_t position[3][2];
514 #define FF_COMMON_FRAME \
516 * pointer to the picture planes.\
517 * This might be different from the first allocated byte\
524 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
525 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
531 * 1 -> keyframe, 0-> not\
532 * - encoding: Set by libavcodec.\
533 * - decoding: Set by libavcodec.\
538 * Picture type of the frame, see ?_TYPE below.\
539 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
540 * - decoding: Set by libavcodec.\
545 * presentation timestamp in time_base units (time when frame should be shown to user)\
546 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
547 * - encoding: MUST be set by user.\
548 * - decoding: Set by libavcodec.\
553 * picture number in bitstream order\
554 * - encoding: set by\
555 * - decoding: Set by libavcodec.\
557 int coded_picture_number;\
559 * picture number in display order\
560 * - encoding: set by\
561 * - decoding: Set by libavcodec.\
563 int display_picture_number;\
566 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
567 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
568 * - decoding: Set by libavcodec.\
573 * buffer age (1->was last buffer and dint change, 2->..., ...).\
574 * Set to INT_MAX if the buffer has not been used yet.\
575 * - encoding: unused\
576 * - decoding: MUST be set by get_buffer().\
581 * is this picture used as reference\
582 * - encoding: unused\
583 * - decoding: Set by libavcodec. (before get_buffer() call)).\
589 * - encoding: unused\
590 * - decoding: Set by libavcodec.\
592 int8_t *qscale_table;\
595 * - encoding: unused\
596 * - decoding: Set by libavcodec.\
601 * mbskip_table[mb]>=1 if MB didn't change\
602 * stride= mb_width = (width+15)>>4\
603 * - encoding: unused\
604 * - decoding: Set by libavcodec.\
606 uint8_t *mbskip_table;\
609 * motion vector table\
612 * int mv_sample_log2= 4 - motion_subsample_log2;\
613 * int mb_width= (width+15)>>4;\
614 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
615 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
617 * - encoding: Set by user.\
618 * - decoding: Set by libavcodec.\
620 int16_t (*motion_val[2])[2];\
623 * macroblock type table\
624 * mb_type_base + mb_width + 2\
625 * - encoding: Set by user.\
626 * - decoding: Set by libavcodec.\
631 * log2 of the size of the block which a single vector in motion_val represents: \
632 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
633 * - encoding: unused\
634 * - decoding: Set by libavcodec.\
636 uint8_t motion_subsample_log2;\
639 * for some private data of the user\
640 * - encoding: unused\
641 * - decoding: Set by user.\
647 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
648 * - decoding: unused\
653 * type of the buffer (to keep track of who has to deallocate data[*])\
654 * - encoding: Set by the one who allocates it.\
655 * - decoding: Set by the one who allocates it.\
656 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
661 * When decoding, this signals how much the picture must be delayed.\
662 * extra_delay = repeat_pict / (2*fps)\
663 * - encoding: unused\
664 * - decoding: Set by libavcodec.\
674 * The content of the picture is interlaced.\
675 * - encoding: Set by user.\
676 * - decoding: Set by libavcodec. (default 0)\
678 int interlaced_frame;\
681 * If the content is interlaced, is top field displayed first.\
682 * - encoding: Set by user.\
683 * - decoding: Set by libavcodec.\
685 int top_field_first;\
689 * - encoding: Set by user.\
690 * - decoding: Set by libavcodec.\
692 AVPanScan *pan_scan;\
695 * Tell user application that palette has changed from previous frame.\
696 * - encoding: ??? (no palette-enabled encoder yet)\
697 * - decoding: Set by libavcodec. (default 0).\
699 int palette_has_changed;\
702 * codec suggestion on buffer type if != 0\
703 * - encoding: unused\
704 * - decoding: Set by libavcodec. (before get_buffer() call)).\
710 * - encoding: unused\
711 * - decoding: Set by libavcodec.\
716 * motion referece frame index\
717 * - encoding: Set by user.\
718 * - decoding: Set by libavcodec.\
720 int8_t *ref_index[2];
722 #define FF_QSCALE_TYPE_MPEG1 0
723 #define FF_QSCALE_TYPE_MPEG2 1
724 #define FF_QSCALE_TYPE_H264 2
726 #define FF_BUFFER_TYPE_INTERNAL 1
727 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
728 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
729 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
732 #define FF_I_TYPE 1 // Intra
733 #define FF_P_TYPE 2 // Predicted
734 #define FF_B_TYPE 3 // Bi-dir predicted
735 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
739 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
740 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
741 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
742 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
747 typedef struct AVFrame {
751 #define DEFAULT_FRAME_RATE_BASE 1001000
754 * main external API structure
756 typedef struct AVCodecContext {
758 * information on struct for av_log
759 * - set by avcodec_alloc_context
763 * the average bitrate
764 * - encoding: Set by user; unused for constant quantizer encoding.
765 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
770 * number of bits the bitstream is allowed to diverge from the reference.
771 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
772 * - encoding: Set by user; unused for constant quantizer encoding.
775 int bit_rate_tolerance;
779 * - encoding: Set by user.
780 * - decoding: Set by user.
785 * Some codecs need additional format info. It is stored here.
786 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
787 * specific codec MUST set it correctly otherwise stream copy breaks.
788 * In general use of this field by muxers is not recommanded.
789 * - encoding: Set by libavcodec.
790 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
795 * Motion estimation algorithm used for video coding.
796 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
797 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
798 * - encoding: MUST be set by user.
804 * some codecs need / can use extradata like Huffman tables.
805 * mjpeg: Huffman tables
806 * rv10: additional flags
807 * mpeg4: global headers (they can be in the bitstream or here)
808 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
809 * than extradata_size to avoid prolems if it is read with the bitstream reader.
810 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
811 * - encoding: Set/allocated/freed by libavcodec.
812 * - decoding: Set/allocated/freed by user.
818 * This is the fundamental unit of time (in seconds) in terms
819 * of which frame timestamps are represented. For fixed-fps content,
820 * timebase should be 1/framerate and timestamp increments should be
822 * - encoding: MUST be set by user.
823 * - decoding: Set by libavcodec.
825 AVRational time_base;
829 * picture width / height.
830 * - encoding: MUST be set by user.
831 * - decoding: Set by libavcodec.
832 * Note: For compatibility it is possible to set this instead of
833 * coded_width/height before decoding.
837 #define FF_ASPECT_EXTENDED 15
840 * the number of pictures in a group of pictures, or 0 for intra_only
841 * - encoding: Set by user.
847 * Pixel format, see PIX_FMT_xxx.
848 * - encoding: Set by user.
849 * - decoding: Set by libavcodec.
851 enum PixelFormat pix_fmt;
854 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
855 * has to read frames at native frame rate.
856 * - encoding: Set by user.
862 * If non NULL, 'draw_horiz_band' is called by the libavcodec
863 * decoder to draw a horizontal band. It improves cache usage. Not
864 * all codecs can do that. You must check the codec capabilities
867 * - decoding: Set by user.
868 * @param height the height of the slice
869 * @param y the y position of the slice
870 * @param type 1->top field, 2->bottom field, 3->frame
871 * @param offset offset into the AVFrame.data from which the slice should be read
873 void (*draw_horiz_band)(struct AVCodecContext *s,
874 const AVFrame *src, int offset[4],
875 int y, int type, int height);
878 int sample_rate; ///< samples per second
882 * audio sample format
883 * - encoding: Set by user.
884 * - decoding: Set by libavcodec.
886 enum SampleFormat sample_fmt; ///< sample format, currently unused
888 /* The following data should not be initialized. */
890 * Samples per packet, initialized when calling 'init'.
893 int frame_number; ///< audio or video frame number
894 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
897 * Number of frames the decoded output will be delayed relative to
899 * - encoding: Set by libavcodec.
904 /* - encoding parameters */
905 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
906 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
910 * - encoding: Set by user.
917 * - encoding: Set by user.
923 * maximum quantizer difference between frames
924 * - encoding: Set by user.
930 * maximum number of B-frames between non-B-frames
931 * Note: The output will be delayed by max_b_frames+1 relative to the input.
932 * - encoding: Set by user.
938 * qscale factor between IP and B-frames
939 * - encoding: Set by user.
942 float b_quant_factor;
944 /** obsolete FIXME remove */
946 #define FF_RC_STRATEGY_XVID 1
948 int b_frame_strategy;
953 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
954 * @deprecated Deprecated in favor of skip_idct and skip_frame.
958 struct AVCodec *codec;
962 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
963 /* unused, FIXME remove*/
967 int rtp_payload_size; /* The size of the RTP payload: the coder will */
968 /* do its best to deliver a chunk with size */
969 /* below rtp_payload_size, the chunk will start */
970 /* with a start code on some codecs like H.263. */
971 /* This doesn't take account of any particular */
972 /* headers inside the transmitted RTP payload. */
975 /* The RTP callback: This function is called */
976 /* every time the encoder has a packet to send. */
977 /* It depends on the encoder if the data starts */
978 /* with a Start Code (it should). H.263 does. */
979 /* mb_nb contains the number of macroblocks */
980 /* encoded in the RTP payload. */
981 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
983 /* statistics, used for 2-pass encoding */
994 * number of bits used for the previously encoded frame
995 * - encoding: Set by libavcodec.
1001 * Private data of the user, can be used to carry app specific stuff.
1002 * - encoding: Set by user.
1003 * - decoding: Set by user.
1007 char codec_name[32];
1008 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1009 enum CodecID codec_id; /* see CODEC_ID_xxx */
1012 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1013 * This is used to work around some encoder bugs.
1014 * A demuxer should set this to what is stored in the field used to identify the codec.
1015 * If there are multiple such fields in a container then the demuxer should choose the one
1016 * which maximizes the information about the used codec.
1017 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1018 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1019 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1021 * - encoding: Set by user, if not then the default based on codec_id will be used.
1022 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1024 unsigned int codec_tag;
1027 * Work around bugs in encoders which sometimes cannot be detected automatically.
1028 * - encoding: Set by user
1029 * - decoding: Set by user
1031 int workaround_bugs;
1032 #define FF_BUG_AUTODETECT 1 ///< autodetection
1033 #define FF_BUG_OLD_MSMPEG4 2
1034 #define FF_BUG_XVID_ILACE 4
1035 #define FF_BUG_UMP4 8
1036 #define FF_BUG_NO_PADDING 16
1037 #define FF_BUG_AMV 32
1038 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1039 #define FF_BUG_QPEL_CHROMA 64
1040 #define FF_BUG_STD_QPEL 128
1041 #define FF_BUG_QPEL_CHROMA2 256
1042 #define FF_BUG_DIRECT_BLOCKSIZE 512
1043 #define FF_BUG_EDGE 1024
1044 #define FF_BUG_HPEL_CHROMA 2048
1045 #define FF_BUG_DC_CLIP 4096
1046 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1047 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1050 * luma single coefficient elimination threshold
1051 * - encoding: Set by user.
1052 * - decoding: unused
1054 int luma_elim_threshold;
1057 * chroma single coeff elimination threshold
1058 * - encoding: Set by user.
1059 * - decoding: unused
1061 int chroma_elim_threshold;
1064 * strictly follow the standard (MPEG4, ...).
1065 * - encoding: Set by user.
1066 * - decoding: unused
1068 int strict_std_compliance;
1069 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1070 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1071 #define FF_COMPLIANCE_NORMAL 0
1072 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1073 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1076 * qscale offset between IP and B-frames
1077 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1078 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1079 * - encoding: Set by user.
1080 * - decoding: unused
1082 float b_quant_offset;
1085 * Error resilience; higher values will detect more errors but may
1086 * misdetect some more or less valid parts as errors.
1087 * - encoding: unused
1088 * - decoding: Set by user.
1090 int error_resilience;
1091 #define FF_ER_CAREFUL 1
1092 #define FF_ER_COMPLIANT 2
1093 #define FF_ER_AGGRESSIVE 3
1094 #define FF_ER_VERY_AGGRESSIVE 4
1097 * Called at the beginning of each frame to get a buffer for it.
1098 * If pic.reference is set then the frame will be read later by libavcodec.
1099 * avcodec_align_dimensions() should be used to find the required width and
1100 * height, as they normally need to be rounded up to the next multiple of 16.
1101 * - encoding: unused
1102 * - decoding: Set by libavcodec., user can override.
1104 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1107 * Called to release buffers which where allocated with get_buffer.
1108 * A released buffer can be reused in get_buffer().
1109 * pic.data[*] must be set to NULL.
1110 * - encoding: unused
1111 * - decoding: Set by libavcodec., user can override.
1113 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1116 * If 1 the stream has a 1 frame delay during decoding.
1117 * - encoding: Set by libavcodec.
1118 * - decoding: Set by libavcodec.
1123 * number of bytes per packet if constant and known or 0
1124 * Used by some WAV based audio codecs.
1128 int parse_only; /* - decoding only: If true, only parsing is done
1129 (function avcodec_parse_frame()). The frame
1130 data is returned. Only MPEG codecs support this now. */
1133 * 0-> h263 quant 1-> mpeg quant
1134 * - encoding: Set by user.
1135 * - decoding: unused
1140 * pass1 encoding statistics output buffer
1141 * - encoding: Set by libavcodec.
1142 * - decoding: unused
1147 * pass2 encoding statistics input buffer
1148 * Concatenated stuff from stats_out of pass1 should be placed here.
1149 * - encoding: Allocated/set/freed by user.
1150 * - decoding: unused
1155 * ratecontrol qmin qmax limiting method
1156 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1157 * - encoding: Set by user.
1158 * - decoding: unused
1166 * ratecontrol override, see RcOverride
1167 * - encoding: Allocated/set/freed by user.
1168 * - decoding: unused
1170 RcOverride *rc_override;
1171 int rc_override_count;
1174 * rate control equation
1175 * - encoding: Set by user
1176 * - decoding: unused
1182 * - encoding: Set by user.
1183 * - decoding: unused
1189 * - encoding: Set by user.
1190 * - decoding: unused
1195 * decoder bitstream buffer size
1196 * - encoding: Set by user.
1197 * - decoding: unused
1200 float rc_buffer_aggressivity;
1203 * qscale factor between P and I-frames
1204 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1205 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1206 * - encoding: Set by user.
1207 * - decoding: unused
1209 float i_quant_factor;
1212 * qscale offset between P and I-frames
1213 * - encoding: Set by user.
1214 * - decoding: unused
1216 float i_quant_offset;
1219 * initial complexity for pass1 ratecontrol
1220 * - encoding: Set by user.
1221 * - decoding: unused
1223 float rc_initial_cplx;
1226 * DCT algorithm, see FF_DCT_* below
1227 * - encoding: Set by user.
1228 * - decoding: unused
1231 #define FF_DCT_AUTO 0
1232 #define FF_DCT_FASTINT 1
1233 #define FF_DCT_INT 2
1234 #define FF_DCT_MMX 3
1235 #define FF_DCT_MLIB 4
1236 #define FF_DCT_ALTIVEC 5
1237 #define FF_DCT_FAAN 6
1240 * luminance masking (0-> disabled)
1241 * - encoding: Set by user.
1242 * - decoding: unused
1247 * temporary complexity masking (0-> disabled)
1248 * - encoding: Set by user.
1249 * - decoding: unused
1251 float temporal_cplx_masking;
1254 * spatial complexity masking (0-> disabled)
1255 * - encoding: Set by user.
1256 * - decoding: unused
1258 float spatial_cplx_masking;
1261 * p block masking (0-> disabled)
1262 * - encoding: Set by user.
1263 * - decoding: unused
1268 * darkness masking (0-> disabled)
1269 * - encoding: Set by user.
1270 * - decoding: unused
1275 /* for binary compatibility */
1279 * IDCT algorithm, see FF_IDCT_* below.
1280 * - encoding: Set by user.
1281 * - decoding: Set by user.
1284 #define FF_IDCT_AUTO 0
1285 #define FF_IDCT_INT 1
1286 #define FF_IDCT_SIMPLE 2
1287 #define FF_IDCT_SIMPLEMMX 3
1288 #define FF_IDCT_LIBMPEG2MMX 4
1289 #define FF_IDCT_PS2 5
1290 #define FF_IDCT_MLIB 6
1291 #define FF_IDCT_ARM 7
1292 #define FF_IDCT_ALTIVEC 8
1293 #define FF_IDCT_SH4 9
1294 #define FF_IDCT_SIMPLEARM 10
1295 #define FF_IDCT_H264 11
1296 #define FF_IDCT_VP3 12
1297 #define FF_IDCT_IPP 13
1298 #define FF_IDCT_XVIDMMX 14
1299 #define FF_IDCT_CAVS 15
1300 #define FF_IDCT_SIMPLEARMV5TE 16
1301 #define FF_IDCT_SIMPLEARMV6 17
1302 #define FF_IDCT_SIMPLEVIS 18
1303 #define FF_IDCT_WMV2 19
1307 * - encoding: Set by libavcodec.
1308 * - decoding: Set by user (or 0).
1312 * slice offsets in the frame in bytes
1313 * - encoding: Set/allocated by libavcodec.
1314 * - decoding: Set/allocated by user (or NULL).
1319 * error concealment flags
1320 * - encoding: unused
1321 * - decoding: Set by user.
1323 int error_concealment;
1324 #define FF_EC_GUESS_MVS 1
1325 #define FF_EC_DEBLOCK 2
1328 * dsp_mask could be add used to disable unwanted CPU features
1329 * CPU features (i.e. MMX, SSE. ...)
1331 * With the FORCE flag you may instead enable given CPU features.
1332 * (Dangerous: Usable in case of misdetection, improper usage however will
1333 * result into program crash.)
1336 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1337 /* lower 16 bits - CPU features */
1338 #define FF_MM_MMX 0x0001 /* standard MMX */
1339 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1340 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1341 #define FF_MM_SSE 0x0008 /* SSE functions */
1342 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1343 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1344 #define FF_MM_SSE3 0x0040 /* Prescott SSE3 functions */
1345 #define FF_MM_SSSE3 0x0080 /* Conroe SSSE3 functions */
1346 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1349 * bits per sample/pixel from the demuxer (needed for huffyuv).
1350 * - encoding: Set by libavcodec.
1351 * - decoding: Set by user.
1353 int bits_per_sample;
1356 * prediction method (needed for huffyuv)
1357 * - encoding: Set by user.
1358 * - decoding: unused
1360 int prediction_method;
1361 #define FF_PRED_LEFT 0
1362 #define FF_PRED_PLANE 1
1363 #define FF_PRED_MEDIAN 2
1366 * sample aspect ratio (0 if unknown)
1367 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1368 * - encoding: Set by user.
1369 * - decoding: Set by libavcodec.
1371 AVRational sample_aspect_ratio;
1374 * the picture in the bitstream
1375 * - encoding: Set by libavcodec.
1376 * - decoding: Set by libavcodec.
1378 AVFrame *coded_frame;
1382 * - encoding: Set by user.
1383 * - decoding: Set by user.
1386 #define FF_DEBUG_PICT_INFO 1
1387 #define FF_DEBUG_RC 2
1388 #define FF_DEBUG_BITSTREAM 4
1389 #define FF_DEBUG_MB_TYPE 8
1390 #define FF_DEBUG_QP 16
1391 #define FF_DEBUG_MV 32
1392 #define FF_DEBUG_DCT_COEFF 0x00000040
1393 #define FF_DEBUG_SKIP 0x00000080
1394 #define FF_DEBUG_STARTCODE 0x00000100
1395 #define FF_DEBUG_PTS 0x00000200
1396 #define FF_DEBUG_ER 0x00000400
1397 #define FF_DEBUG_MMCO 0x00000800
1398 #define FF_DEBUG_BUGS 0x00001000
1399 #define FF_DEBUG_VIS_QP 0x00002000
1400 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1404 * - encoding: Set by user.
1405 * - decoding: Set by user.
1408 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1409 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1410 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1414 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1415 * - decoding: unused
1420 * minimum MB quantizer
1421 * - encoding: unused
1422 * - decoding: unused
1427 * maximum MB quantizer
1428 * - encoding: unused
1429 * - decoding: unused
1434 * motion estimation comparison function
1435 * - encoding: Set by user.
1436 * - decoding: unused
1440 * subpixel motion estimation comparison function
1441 * - encoding: Set by user.
1442 * - decoding: unused
1446 * macroblock comparison function (not supported yet)
1447 * - encoding: Set by user.
1448 * - decoding: unused
1452 * interlaced DCT comparison function
1453 * - encoding: Set by user.
1454 * - decoding: unused
1457 #define FF_CMP_SAD 0
1458 #define FF_CMP_SSE 1
1459 #define FF_CMP_SATD 2
1460 #define FF_CMP_DCT 3
1461 #define FF_CMP_PSNR 4
1462 #define FF_CMP_BIT 5
1464 #define FF_CMP_ZERO 7
1465 #define FF_CMP_VSAD 8
1466 #define FF_CMP_VSSE 9
1467 #define FF_CMP_NSSE 10
1468 #define FF_CMP_W53 11
1469 #define FF_CMP_W97 12
1470 #define FF_CMP_DCTMAX 13
1471 #define FF_CMP_DCT264 14
1472 #define FF_CMP_CHROMA 256
1475 * ME diamond size & shape
1476 * - encoding: Set by user.
1477 * - decoding: unused
1482 * amount of previous MV predictors (2a+1 x 2a+1 square)
1483 * - encoding: Set by user.
1484 * - decoding: unused
1486 int last_predictor_count;
1489 * prepass for motion estimation
1490 * - encoding: Set by user.
1491 * - decoding: unused
1496 * motion estimation prepass comparison function
1497 * - encoding: Set by user.
1498 * - decoding: unused
1503 * ME prepass diamond size & shape
1504 * - encoding: Set by user.
1505 * - decoding: unused
1511 * - encoding: Set by user.
1512 * - decoding: unused
1514 int me_subpel_quality;
1517 * callback to negotiate the pixelFormat
1518 * @param fmt is the list of formats which are supported by the codec,
1519 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1520 * The first is always the native one.
1521 * @return the chosen format
1522 * - encoding: unused
1523 * - decoding: Set by user, if not set the native format will be chosen.
1525 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1528 * DTG active format information (additional aspect ratio
1529 * information only used in DVB MPEG-2 transport streams)
1532 * - encoding: unused
1533 * - decoding: Set by decoder.
1535 int dtg_active_format;
1536 #define FF_DTG_AFD_SAME 8
1537 #define FF_DTG_AFD_4_3 9
1538 #define FF_DTG_AFD_16_9 10
1539 #define FF_DTG_AFD_14_9 11
1540 #define FF_DTG_AFD_4_3_SP_14_9 13
1541 #define FF_DTG_AFD_16_9_SP_14_9 14
1542 #define FF_DTG_AFD_SP_4_3 15
1545 * maximum motion estimation search range in subpel units
1546 * If 0 then no limit.
1548 * - encoding: Set by user.
1549 * - decoding: unused
1554 * intra quantizer bias
1555 * - encoding: Set by user.
1556 * - decoding: unused
1558 int intra_quant_bias;
1559 #define FF_DEFAULT_QUANT_BIAS 999999
1562 * inter quantizer bias
1563 * - encoding: Set by user.
1564 * - decoding: unused
1566 int inter_quant_bias;
1570 * - encoding: unused
1571 * - decoding: Which clrtable should be used for 8bit RGB images.
1572 * Tables have to be stored somewhere. FIXME
1577 * internal_buffer count
1578 * Don't touch, used by libavcodec default_get_buffer().
1580 int internal_buffer_count;
1584 * Don't touch, used by libavcodec default_get_buffer().
1586 void *internal_buffer;
1588 #define FF_LAMBDA_SHIFT 7
1589 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1590 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1591 #define FF_LAMBDA_MAX (256*128-1)
1593 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1595 * Global quality for codecs which cannot change it per frame.
1596 * This should be proportional to MPEG-1/2/4 qscale.
1597 * - encoding: Set by user.
1598 * - decoding: unused
1602 #define FF_CODER_TYPE_VLC 0
1603 #define FF_CODER_TYPE_AC 1
1604 #define FF_CODER_TYPE_RAW 2
1605 #define FF_CODER_TYPE_RLE 3
1606 #define FF_CODER_TYPE_DEFLATE 4
1609 * - encoding: Set by user.
1610 * - decoding: unused
1616 * - encoding: Set by user.
1617 * - decoding: unused
1623 * - encoding: unused
1624 * - decoding: Set by user.
1626 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1631 * - encoding: unused
1632 * - decoding: Set by user.
1635 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1636 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1637 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1640 * XVideo Motion Acceleration
1641 * - encoding: forbidden
1642 * - decoding: set by decoder
1644 int xvmc_acceleration;
1647 * macroblock decision mode
1648 * - encoding: Set by user.
1649 * - decoding: unused
1652 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1653 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1654 #define FF_MB_DECISION_RD 2 ///< rate distoration
1657 * custom intra quantization matrix
1658 * - encoding: Set by user, can be NULL.
1659 * - decoding: Set by libavcodec.
1661 uint16_t *intra_matrix;
1664 * custom inter quantization matrix
1665 * - encoding: Set by user, can be NULL.
1666 * - decoding: Set by libavcodec.
1668 uint16_t *inter_matrix;
1671 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1672 * This is used to work around some encoder bugs.
1673 * - encoding: unused
1674 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1676 unsigned int stream_codec_tag;
1679 * scene change detection threshold
1680 * 0 is default, larger means fewer detected scene changes.
1681 * - encoding: Set by user.
1682 * - decoding: unused
1684 int scenechange_threshold;
1687 * minimum Lagrange multipler
1688 * - encoding: Set by user.
1689 * - decoding: unused
1694 * maximum Lagrange multipler
1695 * - encoding: Set by user.
1696 * - decoding: unused
1701 * palette control structure
1702 * - encoding: ??? (no palette-enabled encoder yet)
1703 * - decoding: Set by user.
1705 struct AVPaletteControl *palctrl;
1708 * noise reduction strength
1709 * - encoding: Set by user.
1710 * - decoding: unused
1712 int noise_reduction;
1715 * Called at the beginning of a frame to get cr buffer for it.
1716 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1717 * libavcodec will pass previous buffer in pic, function should return
1718 * same buffer or new buffer with old frame "painted" into it.
1719 * If pic.data[0] == NULL must behave like get_buffer().
1720 * - encoding: unused
1721 * - decoding: Set by libavcodec., user can override
1723 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1726 * Number of bits which should be loaded into the rc buffer before decoding starts.
1727 * - encoding: Set by user.
1728 * - decoding: unused
1730 int rc_initial_buffer_occupancy;
1734 * - encoding: Set by user.
1735 * - decoding: unused
1737 int inter_threshold;
1741 * - encoding: Set by user.
1742 * - decoding: Set by user.
1747 * Simulates errors in the bitstream to test error concealment.
1748 * - encoding: Set by user.
1749 * - decoding: unused
1754 * MP3 antialias algorithm, see FF_AA_* below.
1755 * - encoding: unused
1756 * - decoding: Set by user.
1759 #define FF_AA_AUTO 0
1760 #define FF_AA_FASTINT 1 //not implemented yet
1762 #define FF_AA_FLOAT 3
1764 * quantizer noise shaping
1765 * - encoding: Set by user.
1766 * - decoding: unused
1768 int quantizer_noise_shaping;
1772 * is used to decide how many independent tasks should be passed to execute()
1773 * - encoding: Set by user.
1774 * - decoding: Set by user.
1779 * The codec may call this to execute several independent things.
1780 * It will return only after finishing all tasks.
1781 * The user may replace this with some multithreaded implementation,
1782 * the default implementation will execute the parts serially.
1783 * @param count the number of things to execute
1784 * - encoding: Set by libavcodec, user can override.
1785 * - decoding: Set by libavcodec, user can override.
1787 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1791 * Can be used by execute() to store some per AVCodecContext stuff.
1792 * - encoding: set by execute()
1793 * - decoding: set by execute()
1795 void *thread_opaque;
1798 * Motion estimation threshold below which no motion estimation is
1799 * performed, but instead the user specified motion vectors are used.
1801 * - encoding: Set by user.
1802 * - decoding: unused
1807 * Macroblock threshold below which the user specified macroblock types will be used.
1808 * - encoding: Set by user.
1809 * - decoding: unused
1814 * precision of the intra DC coefficient - 8
1815 * - encoding: Set by user.
1816 * - decoding: unused
1818 int intra_dc_precision;
1821 * noise vs. sse weight for the nsse comparsion function
1822 * - encoding: Set by user.
1823 * - decoding: unused
1828 * Number of macroblock rows at the top which are skipped.
1829 * - encoding: unused
1830 * - decoding: Set by user.
1835 * Number of macroblock rows at the bottom which are skipped.
1836 * - encoding: unused
1837 * - decoding: Set by user.
1843 * - encoding: Set by user.
1844 * - decoding: Set by libavcodec.
1847 #define FF_PROFILE_UNKNOWN -99
1848 #define FF_PROFILE_AAC_MAIN 0
1849 #define FF_PROFILE_AAC_LOW 1
1850 #define FF_PROFILE_AAC_SSR 2
1851 #define FF_PROFILE_AAC_LTP 3
1855 * - encoding: Set by user.
1856 * - decoding: Set by libavcodec.
1859 #define FF_LEVEL_UNKNOWN -99
1862 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1863 * - encoding: unused
1864 * - decoding: Set by user.
1869 * Bitstream width / height, may be different from width/height if lowres
1870 * or other things are used.
1871 * - encoding: unused
1872 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1874 int coded_width, coded_height;
1877 * frame skip threshold
1878 * - encoding: Set by user.
1879 * - decoding: unused
1881 int frame_skip_threshold;
1885 * - encoding: Set by user.
1886 * - decoding: unused
1888 int frame_skip_factor;
1891 * frame skip exponent
1892 * - encoding: Set by user.
1893 * - decoding: unused
1898 * frame skip comparison function
1899 * - encoding: Set by user.
1900 * - decoding: unused
1905 * Border processing masking, raises the quantizer for mbs on the borders
1907 * - encoding: Set by user.
1908 * - decoding: unused
1910 float border_masking;
1913 * minimum MB lagrange multipler
1914 * - encoding: Set by user.
1915 * - decoding: unused
1920 * maximum MB lagrange multipler
1921 * - encoding: Set by user.
1922 * - decoding: unused
1928 * - encoding: Set by user.
1929 * - decoding: unused
1931 int me_penalty_compensation;
1935 * - encoding: unused
1936 * - decoding: Set by user.
1938 enum AVDiscard skip_loop_filter;
1942 * - encoding: unused
1943 * - decoding: Set by user.
1945 enum AVDiscard skip_idct;
1949 * - encoding: unused
1950 * - decoding: Set by user.
1952 enum AVDiscard skip_frame;
1956 * - encoding: Set by user.
1957 * - decoding: unused
1963 * - encoding: Set by user.
1964 * - decoding: unused
1969 * constant rate factor - quality-based VBR - values ~correspond to qps
1970 * - encoding: Set by user.
1971 * - decoding: unused
1976 * constant quantization parameter rate control method
1977 * - encoding: Set by user.
1978 * - decoding: unused
1984 * - encoding: Set by user.
1985 * - decoding: unused
1990 * number of reference frames
1991 * - encoding: Set by user.
1992 * - decoding: unused
1997 * chroma qp offset from luma
1998 * - encoding: Set by user.
1999 * - decoding: unused
2004 * Influences how often B-frames are used.
2005 * - encoding: Set by user.
2006 * - decoding: unused
2011 * trellis RD quantization
2012 * - encoding: Set by user.
2013 * - decoding: unused
2018 * Reduce fluctuations in qp (before curve compression).
2019 * - encoding: Set by user.
2020 * - decoding: unused
2022 float complexityblur;
2025 * in-loop deblocking filter alphac0 parameter
2026 * alpha is in the range -6...6
2027 * - encoding: Set by user.
2028 * - decoding: unused
2033 * in-loop deblocking filter beta parameter
2034 * beta is in the range -6...6
2035 * - encoding: Set by user.
2036 * - decoding: unused
2041 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2042 * - encoding: Set by user.
2043 * - decoding: unused
2046 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2047 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2048 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2049 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2050 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2053 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2054 * - encoding: Set by user.
2055 * - decoding: unused
2060 * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2061 * - encoding: Set by user.
2062 * - decoding: unused
2067 * Multiplied by qscale for each frame and added to scene_change_score.
2068 * - encoding: Set by user.
2069 * - decoding: unused
2071 int scenechange_factor;
2075 * Note: Value depends upon the compare function used for fullpel ME.
2076 * - encoding: Set by user.
2077 * - decoding: unused
2082 * Adjusts sensitivity of b_frame_strategy 1.
2083 * - encoding: Set by user.
2084 * - decoding: unused
2089 * - encoding: Set by user.
2090 * - decoding: unused
2092 int compression_level;
2093 #define FF_COMPRESSION_DEFAULT -1
2096 * Sets whether to use LPC mode - used by FLAC encoder.
2097 * - encoding: Set by user.
2098 * - decoding: unused
2103 * LPC coefficient precision - used by FLAC encoder
2104 * - encoding: Set by user.
2105 * - decoding: unused
2107 int lpc_coeff_precision;
2110 * - encoding: Set by user.
2111 * - decoding: unused
2113 int min_prediction_order;
2116 * - encoding: Set by user.
2117 * - decoding: unused
2119 int max_prediction_order;
2122 * search method for selecting prediction order
2123 * - encoding: Set by user.
2124 * - decoding: unused
2126 int prediction_order_method;
2129 * - encoding: Set by user.
2130 * - decoding: unused
2132 int min_partition_order;
2135 * - encoding: Set by user.
2136 * - decoding: unused
2138 int max_partition_order;
2141 * GOP timecode frame start number, in non drop frame format
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 int64_t timecode_frame_start;
2148 * Decoder should decode to this many channels if it can (0 for default)
2149 * - encoding: unused
2150 * - decoding: Set by user.
2152 int request_channels;
2158 typedef struct AVCodec {
2160 * Name of the codec implementation.
2161 * The name is globally unique among encoders and among decoders (but an
2162 * encoder and a decoder can share the same name).
2163 * This is the primary way to find a codec from the user perspective.
2166 enum CodecType type;
2169 int (*init)(AVCodecContext *);
2170 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2171 int (*close)(AVCodecContext *);
2172 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2173 uint8_t *buf, int buf_size);
2175 struct AVCodec *next;
2176 void (*flush)(AVCodecContext *);
2177 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2178 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2182 * four components are given, that's all.
2183 * the last component is alpha
2185 typedef struct AVPicture {
2187 int linesize[4]; ///< number of bytes per line
2192 * This structure defines a method for communicating palette changes
2193 * between and demuxer and a decoder.
2195 * @deprecated Use AVPacket to send palette changes instead.
2196 * This is totally broken.
2198 #define AVPALETTE_SIZE 1024
2199 #define AVPALETTE_COUNT 256
2200 typedef struct AVPaletteControl {
2202 /* Demuxer sets this to 1 to indicate the palette has changed;
2203 * decoder resets to 0. */
2204 int palette_changed;
2206 /* 4-byte ARGB palette entries, stored in native byte order; note that
2207 * the individual palette components should be on a 8-bit scale; if
2208 * the palette data comes from an IBM VGA native format, the component
2209 * data is probably 6 bits in size and needs to be scaled. */
2210 unsigned int palette[AVPALETTE_COUNT];
2212 } AVPaletteControl attribute_deprecated;
2214 typedef struct AVSubtitleRect {
2221 uint32_t *rgba_palette;
2225 typedef struct AVSubtitle {
2226 uint16_t format; /* 0 = graphics */
2227 uint32_t start_display_time; /* relative to packet pts, in ms */
2228 uint32_t end_display_time; /* relative to packet pts, in ms */
2230 AVSubtitleRect *rects;
2236 struct ReSampleContext;
2237 struct AVResampleContext;
2239 typedef struct ReSampleContext ReSampleContext;
2241 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2242 int output_rate, int input_rate);
2243 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2244 void audio_resample_close(ReSampleContext *s);
2246 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2247 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2248 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2249 void av_resample_close(struct AVResampleContext *c);
2251 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2252 /* YUV420 format is assumed ! */
2255 * @deprecated Use the software scaler (swscale) instead.
2257 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2260 * @deprecated Use the software scaler (swscale) instead.
2262 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2263 int input_width, int input_height);
2266 * @deprecated Use the software scaler (swscale) instead.
2268 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2269 int iwidth, int iheight,
2270 int topBand, int bottomBand,
2271 int leftBand, int rightBand,
2272 int padtop, int padbottom,
2273 int padleft, int padright);
2276 * @deprecated Use the software scaler (swscale) instead.
2278 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2279 AVPicture *output, const AVPicture *input);
2282 * @deprecated Use the software scaler (swscale) instead.
2284 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2289 * Allocate memory for a picture. Call avpicture_free to free it.
2291 * @param picture the picture to be filled in
2292 * @param pix_fmt the format of the picture
2293 * @param width the width of the picture
2294 * @param height the height of the picture
2295 * @return zero if successful, a negative value if not
2297 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2300 * Free a picture previously allocated by avpicture_alloc().
2302 * @param picture the AVPicture to be freed
2304 void avpicture_free(AVPicture *picture);
2307 * Fill in the AVPicture fields.
2308 * The fields of the given AVPicture are filled in by using the 'ptr' address
2309 * which points to the image data buffer. Depending on the specified picture
2310 * format, one or multiple image data pointers and line sizes will be set.
2311 * If a planar format is specified, several pointers will be set pointing to
2312 * the different picture planes and the line sizes of the different planes
2313 * will be stored in the lines_sizes array.
2315 * @param picture AVPicture whose fields are to be filled in
2316 * @param ptr Buffer which will contain or contains the actual image data
2317 * @param pix_fmt The format in which the picture data is stored.
2318 * @param width the width of the image in pixels
2319 * @param height the height of the image in pixels
2320 * @return size of the image data in bytes
2322 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2323 int pix_fmt, int width, int height);
2324 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2325 unsigned char *dest, int dest_size);
2328 * Calculate the size in bytes that a picture of the given width and height
2329 * would occupy if stored in the given picture format.
2331 * @param pix_fmt the given picture format
2332 * @param width the width of the image
2333 * @param height the height of the image
2334 * @return Image data size in bytes
2336 int avpicture_get_size(int pix_fmt, int width, int height);
2337 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2338 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2339 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2340 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2341 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2343 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2344 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2345 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2346 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2347 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2348 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2351 * Computes what kind of losses will occur when converting from one specific
2352 * pixel format to another.
2353 * When converting from one pixel format to another, information loss may occur.
2354 * For example, when converting from RGB24 to GRAY, the color information will
2355 * be lost. Similarly, other losses occur when converting from some formats to
2356 * other formats. These losses can involve loss of chroma, but also loss of
2357 * resolution, loss of color depth, loss due to the color space conversion, loss
2358 * of the alpha bits or loss due to color quantization.
2359 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2360 * which will occur when converting from one pixel format to another.
2362 * @param[in] dst_pix_fmt destination pixel format
2363 * @param[in] src_pix_fmt source pixel format
2364 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2365 * @return Combination of flags informing you what kind of losses will occur.
2367 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2371 * Finds the best pixel format to convert to given a certain source pixel
2372 * format. When converting from one pixel format to another, information loss
2373 * may occur. For example, when converting from RGB24 to GRAY, the color
2374 * information will be lost. Similarly, other losses occur when converting from
2375 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2376 * the given pixel formats should be used to suffer the least amount of loss.
2377 * The pixel formats from which it chooses one, are determined by the
2378 * \p pix_fmt_mask parameter.
2381 * src_pix_fmt = PIX_FMT_YUV420P;
2382 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2383 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2386 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2387 * @param[in] src_pix_fmt source pixel format
2388 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2389 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2390 * @return The best pixel format to convert to or -1 if none was found.
2392 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2393 int has_alpha, int *loss_ptr);
2397 * Print in buf the string corresponding to the pixel format with
2398 * number pix_fmt, or an header if pix_fmt is negative.
2400 * @param[in] buf the buffer where to write the string
2401 * @param[in] buf_size the size of buf
2402 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2403 * a negative value to print the corresponding header.
2404 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2406 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2408 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2409 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2412 * Tell if an image really has transparent alpha values.
2413 * @return ored mask of FF_ALPHA_xxx constants
2415 int img_get_alpha_info(const AVPicture *src,
2416 int pix_fmt, int width, int height);
2418 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2420 * convert among pixel formats
2421 * @deprecated Use the software scaler (swscale) instead.
2423 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2424 const AVPicture *src, int pix_fmt,
2425 int width, int height);
2428 /* deinterlace a picture */
2429 /* deinterlace - if not supported return -1 */
2430 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2431 int pix_fmt, int width, int height);
2433 /* external high level API */
2435 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2436 extern AVCodec *first_avcodec;
2438 AVCodec *av_codec_next(AVCodec *c);
2440 /* returns LIBAVCODEC_VERSION_INT constant */
2441 unsigned avcodec_version(void);
2442 /* returns LIBAVCODEC_BUILD constant */
2443 unsigned avcodec_build(void);
2446 * Initializes libavcodec.
2448 * @warning This function \e must be called before any other libavcodec
2451 void avcodec_init(void);
2453 void register_avcodec(AVCodec *format);
2456 * Finds a registered encoder with a matching codec ID.
2458 * @param id CodecID of the requested encoder
2459 * @return An encoder if one was found, NULL otherwise.
2461 AVCodec *avcodec_find_encoder(enum CodecID id);
2464 * Finds a registered encoder with the specified name.
2466 * @param name name of the requested encoder
2467 * @return An encoder if one was found, NULL otherwise.
2469 AVCodec *avcodec_find_encoder_by_name(const char *name);
2472 * Finds a registered decoder with a matching codec ID.
2474 * @param id CodecID of the requested decoder
2475 * @return A decoder if one was found, NULL otherwise.
2477 AVCodec *avcodec_find_decoder(enum CodecID id);
2480 * Finds a registered decoder with the specified name.
2482 * @param name name of the requested decoder
2483 * @return A decoder if one was found, NULL otherwise.
2485 AVCodec *avcodec_find_decoder_by_name(const char *name);
2486 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2489 * Sets the fields of the given AVCodecContext to default values.
2491 * @param s The AVCodecContext of which the fields should be set to default values.
2493 void avcodec_get_context_defaults(AVCodecContext *s);
2495 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2496 * we WILL change its arguments and name a few times! */
2497 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2500 * Allocates an AVCodecContext and sets its fields to default values. The
2501 * resulting struct can be deallocated by simply calling av_free().
2503 * @return An AVCodecContext filled with default values or NULL on failure.
2504 * @see avcodec_get_context_defaults
2506 AVCodecContext *avcodec_alloc_context(void);
2508 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2509 * we WILL change its arguments and name a few times! */
2510 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2513 * Sets the fields of the given AVFrame to default values.
2515 * @param pic The AVFrame of which the fields should be set to default values.
2517 void avcodec_get_frame_defaults(AVFrame *pic);
2520 * Allocates an AVFrame and sets its fields to default values. The resulting
2521 * struct can be deallocated by simply calling av_free().
2523 * @return An AVFrame filled with default values or NULL on failure.
2524 * @see avcodec_get_frame_defaults
2526 AVFrame *avcodec_alloc_frame(void);
2528 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2529 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2530 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2531 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2534 * Checks if the given dimension of a picture is valid, meaning that all
2535 * bytes of the picture can be addressed with a signed int.
2537 * @param[in] w Width of the picture.
2538 * @param[in] h Height of the picture.
2539 * @return Zero if valid, a negative value if invalid.
2541 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2542 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2544 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2545 void avcodec_thread_free(AVCodecContext *s);
2546 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2547 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2548 //FIXME func typedef
2551 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2552 * function the context has to be allocated.
2554 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2555 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2556 * retrieving a codec.
2558 * @warning This function is not thread safe!
2561 * avcodec_register_all();
2562 * codec = avcodec_find_decoder(CODEC_ID_H264);
2566 * context = avcodec_alloc_context();
2568 * if (avcodec_open(context, codec) < 0)
2572 * @param avctx The context which will be set up to use the given codec.
2573 * @param codec The codec to use within the context.
2574 * @return zero on success, a negative value on error
2575 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2577 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2580 * @deprecated Use avcodec_decode_audio2() instead.
2582 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2583 int *frame_size_ptr,
2584 uint8_t *buf, int buf_size);
2587 * Decodes an audio frame from \p buf into \p samples.
2588 * The avcodec_decode_audio2() function decodes an audio frame from the input
2589 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2590 * audio codec which was coupled with \p avctx using avcodec_open(). The
2591 * resulting decoded frame is stored in output buffer \p samples. If no frame
2592 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2593 * decompressed frame size in \e bytes.
2595 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2596 * output buffer before calling avcodec_decode_audio2().
2598 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2599 * the actual read bytes because some optimized bitstream readers read 32 or 64
2600 * bits at once and could read over the end.
2602 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2603 * no overreading happens for damaged MPEG streams.
2605 * @note You might have to align the input buffer \p buf and output buffer \p
2606 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2607 * necessary at all, on others it won't work at all if not aligned and on others
2608 * it will work but it will have an impact on performance. In practice, the
2609 * bitstream should have 4 byte alignment at minimum and all sample data should
2610 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2611 * the linesize is not a multiple of 16 then there's no sense in aligning the
2612 * start of the buffer to 16.
2614 * @param avctx the codec context
2615 * @param[out] samples the output buffer
2616 * @param[in,out] frame_size_ptr the output buffer size in bytes
2617 * @param[in] buf the input buffer
2618 * @param[in] buf_size the input buffer size in bytes
2619 * @return On error a negative value is returned, otherwise the number of bytes
2620 * used or zero if no frame could be decompressed.
2622 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2623 int *frame_size_ptr,
2624 uint8_t *buf, int buf_size);
2627 * Decodes a video frame from \p buf into \p picture.
2628 * The avcodec_decode_video() function decodes a video frame from the input
2629 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2630 * video codec which was coupled with \p avctx using avcodec_open(). The
2631 * resulting decoded frame is stored in \p picture.
2633 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2634 * the actual read bytes because some optimized bitstream readers read 32 or 64
2635 * bits at once and could read over the end.
2637 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2638 * no overreading happens for damaged MPEG streams.
2640 * @note You might have to align the input buffer \p buf and output buffer \p
2641 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2642 * necessary at all, on others it won't work at all if not aligned and on others
2643 * it will work but it will have an impact on performance. In practice, the
2644 * bitstream should have 4 byte alignment at minimum and all sample data should
2645 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2646 * the linesize is not a multiple of 16 then there's no sense in aligning the
2647 * start of the buffer to 16.
2649 * @param avctx the codec context
2650 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2651 * @param[in] buf the input buffer
2652 * @param[in] buf_size the size of the input buffer in bytes
2653 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2654 * @return On error a negative value is returned, otherwise the number of bytes
2655 * used or zero if no frame could be decompressed.
2657 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2658 int *got_picture_ptr,
2659 uint8_t *buf, int buf_size);
2661 /* Decode a subtitle message. Return -1 if error, otherwise return the
2662 * number of bytes used. If no subtitle could be decompressed,
2663 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2664 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2666 const uint8_t *buf, int buf_size);
2667 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2669 uint8_t *buf, int buf_size);
2672 * Encodes an audio frame from \p samples into \p buf.
2673 * The avcodec_encode_audio() function encodes an audio frame from the input
2674 * buffer \p samples. To encode it, it makes use of the audio codec which was
2675 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2676 * stored in output buffer \p buf.
2678 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2680 * @param avctx the codec context
2681 * @param[out] buf the output buffer
2682 * @param[in] buf_size the output buffer size
2683 * @param[in] samples the input buffer containing the samples
2684 * The number of samples read from this buffer is frame_size*channels,
2685 * both of which are defined in \p avctx.
2686 * @return On error a negative value is returned, on success zero or the number
2687 * of bytes used to encode the data read from the input buffer.
2689 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2690 const short *samples);
2693 * Encodes a video frame from \p pict into \p buf.
2694 * The avcodec_encode_video() function encodes a video frame from the input
2695 * \p pict. To encode it, it makes use of the video codec which was coupled with
2696 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2697 * frame are stored in the output buffer \p buf. The input picture should be
2698 * stored using a specific format, namely \c avctx.pix_fmt.
2700 * @param avctx the codec context
2701 * @param[out] buf the output buffer for the bitstream of encoded frame
2702 * @param[in] buf_size the size of the output buffer in bytes
2703 * @param[in] pict the input picture to encode
2704 * @return On error a negative value is returned, on success zero or the number
2705 * of bytes used from the input buffer.
2707 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2708 const AVFrame *pict);
2709 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2710 const AVSubtitle *sub);
2712 int avcodec_close(AVCodecContext *avctx);
2714 void avcodec_register_all(void);
2717 * Flush buffers, should be called when seeking or when switching to a different stream.
2719 void avcodec_flush_buffers(AVCodecContext *avctx);
2721 void avcodec_default_free_buffers(AVCodecContext *s);
2723 /* misc useful functions */
2726 * Returns a single letter to describe the given picture type \p pict_type.
2728 * @param[in] pict_type the picture type
2729 * @return A single character representing the picture type.
2731 char av_get_pict_type_char(int pict_type);
2734 * Returns codec bits per sample.
2736 * @param[in] codec_id the codec
2737 * @return Number of bits per sample or zero if unknown for the given codec.
2739 int av_get_bits_per_sample(enum CodecID codec_id);
2742 * Returns sample format bits per sample.
2744 * @param[in] sample_fmt the sample format
2745 * @return Number of bits per sample or zero if unknown for the given sample format.
2747 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2750 typedef struct AVCodecParserContext {
2752 struct AVCodecParser *parser;
2753 int64_t frame_offset; /* offset of the current frame */
2754 int64_t cur_offset; /* current offset
2755 (incremented by each av_parser_parse()) */
2756 int64_t last_frame_offset; /* offset of the last frame */
2758 int pict_type; /* XXX: Put it back in AVCodecContext. */
2759 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2760 int64_t pts; /* pts of the current frame */
2761 int64_t dts; /* dts of the current frame */
2766 int fetch_timestamp;
2768 #define AV_PARSER_PTS_NB 4
2769 int cur_frame_start_index;
2770 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2771 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2772 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2775 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2777 int64_t offset; ///< byte offset from starting packet start
2778 int64_t last_offset;
2779 } AVCodecParserContext;
2781 typedef struct AVCodecParser {
2782 int codec_ids[5]; /* several codec IDs are permitted */
2784 int (*parser_init)(AVCodecParserContext *s);
2785 int (*parser_parse)(AVCodecParserContext *s,
2786 AVCodecContext *avctx,
2787 const uint8_t **poutbuf, int *poutbuf_size,
2788 const uint8_t *buf, int buf_size);
2789 void (*parser_close)(AVCodecParserContext *s);
2790 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2791 struct AVCodecParser *next;
2794 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2795 extern AVCodecParser *av_first_parser;
2797 AVCodecParser *av_parser_next(AVCodecParser *c);
2799 void av_register_codec_parser(AVCodecParser *parser);
2800 AVCodecParserContext *av_parser_init(int codec_id);
2801 int av_parser_parse(AVCodecParserContext *s,
2802 AVCodecContext *avctx,
2803 uint8_t **poutbuf, int *poutbuf_size,
2804 const uint8_t *buf, int buf_size,
2805 int64_t pts, int64_t dts);
2806 int av_parser_change(AVCodecParserContext *s,
2807 AVCodecContext *avctx,
2808 uint8_t **poutbuf, int *poutbuf_size,
2809 const uint8_t *buf, int buf_size, int keyframe);
2810 void av_parser_close(AVCodecParserContext *s);
2813 typedef struct AVBitStreamFilterContext {
2815 struct AVBitStreamFilter *filter;
2816 AVCodecParserContext *parser;
2817 struct AVBitStreamFilterContext *next;
2818 } AVBitStreamFilterContext;
2821 typedef struct AVBitStreamFilter {
2824 int (*filter)(AVBitStreamFilterContext *bsfc,
2825 AVCodecContext *avctx, const char *args,
2826 uint8_t **poutbuf, int *poutbuf_size,
2827 const uint8_t *buf, int buf_size, int keyframe);
2828 void (*close)(AVBitStreamFilterContext *bsfc);
2829 struct AVBitStreamFilter *next;
2830 } AVBitStreamFilter;
2832 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2833 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2834 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2835 AVCodecContext *avctx, const char *args,
2836 uint8_t **poutbuf, int *poutbuf_size,
2837 const uint8_t *buf, int buf_size, int keyframe);
2838 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2840 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2845 * Reallocates the given block if it is not large enough, otherwise it
2850 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2852 /* for static data only */
2855 * Frees all static arrays and resets their pointers to 0.
2856 * Call this function to release all statically allocated tables.
2858 * @deprecated. Code which uses av_free_static is broken/misdesigned
2859 * and should correctly use static arrays
2862 attribute_deprecated void av_free_static(void);
2865 * Allocation of static arrays.
2867 * @warning Do not use for normal allocation.
2869 * @param[in] size The amount of memory you need in bytes.
2870 * @return block of memory of the requested size
2871 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2872 * and should correctly use static arrays
2874 attribute_deprecated void *av_mallocz_static(unsigned int size);
2877 * Copy image 'src' to 'dst'.
2879 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2880 int pix_fmt, int width, int height);
2883 * Crop image top and left side.
2885 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2886 int pix_fmt, int top_band, int left_band);
2891 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2892 int padtop, int padbottom, int padleft, int padright, int *color);
2894 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2896 * @deprecated Use the software scaler (swscale) instead.
2898 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2899 int pix_fmt, int width, int height);
2902 * @deprecated Use the software scaler (swscale) instead.
2904 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2905 int pix_fmt, int top_band, int left_band);
2908 * @deprecated Use the software scaler (swscale) instead.
2910 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2911 int padtop, int padbottom, int padleft, int padright, int *color);
2914 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2917 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2919 * @return 0 in case of a successful parsing, a negative value otherwise
2920 * @param[in] str the string to parse: it has to be a string in the format
2921 * <width>x<height> or a valid video frame size abbreviation.
2922 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2924 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2925 * frame height value
2927 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2930 * Parses \p str and put in \p frame_rate the detected values.
2932 * @return 0 in case of a successful parsing, a negative value otherwise
2933 * @param[in] str the string to parse: it has to be a string in the format
2934 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2935 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2938 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2940 /* error handling */
2942 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2943 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2945 /* Some platforms have E* and errno already negated. */
2946 #define AVERROR(e) (e)
2947 #define AVUNERROR(e) (e)
2949 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2950 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2951 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2952 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2953 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2954 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2955 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2956 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2957 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2959 #endif /* FFMPEG_AVCODEC_H */