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.
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.
381 * The parent program guarantees that the input for B-frames containing
382 * streams is not written to for at least s->max_b_frames+1 frames, if
383 * this is not set the input will be copied.
385 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
386 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
387 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
388 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
389 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
390 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
391 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
392 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
393 location instead of only at frame boundaries. */
394 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
395 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
396 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
397 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
398 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
399 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
400 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
401 /* Fx : Flag for h263+ extra options */
402 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
403 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
405 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
406 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
407 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
408 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
409 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
410 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
411 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
412 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
413 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
414 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
415 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
416 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
417 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
418 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
419 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
420 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
421 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
422 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
423 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
424 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
425 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
426 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
427 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
428 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
429 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
430 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
431 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
432 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
434 /* Unsupported options :
435 * Syntax Arithmetic coding (SAC)
436 * Reference Picture Selection
437 * Independent Segment Decoding */
439 /* codec capabilities */
441 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
443 * Codec uses get_buffer() for allocating buffers.
444 * direct rendering method 1
446 #define CODEC_CAP_DR1 0x0002
447 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
448 #define CODEC_CAP_PARSE_ONLY 0x0004
449 #define CODEC_CAP_TRUNCATED 0x0008
450 /* Codec can export data for HW decoding (XvMC). */
451 #define CODEC_CAP_HWACCEL 0x0010
453 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
454 * If this is not set, the codec is guaranteed to never be fed with NULL data.
456 #define CODEC_CAP_DELAY 0x0020
458 * Codec can be fed a final frame with a smaller size.
459 * This can be used to prevent truncation of the last audio samples.
461 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
463 //The following defines may change, don't expect compatibility if you use them.
464 #define MB_TYPE_INTRA4x4 0x0001
465 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
466 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
467 #define MB_TYPE_16x16 0x0008
468 #define MB_TYPE_16x8 0x0010
469 #define MB_TYPE_8x16 0x0020
470 #define MB_TYPE_8x8 0x0040
471 #define MB_TYPE_INTERLACED 0x0080
472 #define MB_TYPE_DIRECT2 0x0100 //FIXME
473 #define MB_TYPE_ACPRED 0x0200
474 #define MB_TYPE_GMC 0x0400
475 #define MB_TYPE_SKIP 0x0800
476 #define MB_TYPE_P0L0 0x1000
477 #define MB_TYPE_P1L0 0x2000
478 #define MB_TYPE_P0L1 0x4000
479 #define MB_TYPE_P1L1 0x8000
480 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
481 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
482 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
483 #define MB_TYPE_QUANT 0x00010000
484 #define MB_TYPE_CBP 0x00020000
485 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
489 * This specifies the area which should be displayed.
490 * Note there may be multiple such areas for one frame.
492 typedef struct AVPanScan{
495 * - encoding: Set by user.
496 * - decoding: Set by libavcodec.
501 * width and height in 1/16 pel
502 * - encoding: Set by user.
503 * - decoding: Set by libavcodec.
509 * position of the top left corner in 1/16 pel for up to 3 fields/frames
510 * - encoding: Set by user.
511 * - decoding: Set by libavcodec.
513 int16_t position[3][2];
516 #define FF_COMMON_FRAME \
518 * pointer to the picture planes.\
519 * This might be different from the first allocated byte\
526 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
527 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
533 * 1 -> keyframe, 0-> not\
534 * - encoding: Set by libavcodec.\
535 * - decoding: Set by libavcodec.\
540 * Picture type of the frame, see ?_TYPE below.\
541 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
542 * - decoding: Set by libavcodec.\
547 * presentation timestamp in time_base units (time when frame should be shown to user)\
548 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
549 * - encoding: MUST be set by user.\
550 * - decoding: Set by libavcodec.\
555 * picture number in bitstream order\
556 * - encoding: set by\
557 * - decoding: Set by libavcodec.\
559 int coded_picture_number;\
561 * picture number in display order\
562 * - encoding: set by\
563 * - decoding: Set by libavcodec.\
565 int display_picture_number;\
568 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
569 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
570 * - decoding: Set by libavcodec.\
575 * buffer age (1->was last buffer and dint change, 2->..., ...).\
576 * Set to INT_MAX if the buffer has not been used yet.\
577 * - encoding: unused\
578 * - decoding: MUST be set by get_buffer().\
583 * is this picture used as reference\
584 * - encoding: unused\
585 * - decoding: Set by libavcodec. (before get_buffer() call)).\
591 * - encoding: unused\
592 * - decoding: Set by libavcodec.\
594 int8_t *qscale_table;\
597 * - encoding: unused\
598 * - decoding: Set by libavcodec.\
603 * mbskip_table[mb]>=1 if MB didn't change\
604 * stride= mb_width = (width+15)>>4\
605 * - encoding: unused\
606 * - decoding: Set by libavcodec.\
608 uint8_t *mbskip_table;\
611 * motion vector table\
614 * int mv_sample_log2= 4 - motion_subsample_log2;\
615 * int mb_width= (width+15)>>4;\
616 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
617 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
619 * - encoding: Set by user.\
620 * - decoding: Set by libavcodec.\
622 int16_t (*motion_val[2])[2];\
625 * macroblock type table\
626 * mb_type_base + mb_width + 2\
627 * - encoding: Set by user.\
628 * - decoding: Set by libavcodec.\
633 * log2 of the size of the block which a single vector in motion_val represents: \
634 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
635 * - encoding: unused\
636 * - decoding: Set by libavcodec.\
638 uint8_t motion_subsample_log2;\
641 * for some private data of the user\
642 * - encoding: unused\
643 * - decoding: Set by user.\
649 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
650 * - decoding: unused\
655 * type of the buffer (to keep track of who has to deallocate data[*])\
656 * - encoding: Set by the one who allocates it.\
657 * - decoding: Set by the one who allocates it.\
658 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
663 * When decoding, this signals how much the picture must be delayed.\
664 * extra_delay = repeat_pict / (2*fps)\
665 * - encoding: unused\
666 * - decoding: Set by libavcodec.\
676 * The content of the picture is interlaced.\
677 * - encoding: Set by user.\
678 * - decoding: Set by libavcodec. (default 0)\
680 int interlaced_frame;\
683 * If the content is interlaced, is top field displayed first.\
684 * - encoding: Set by user.\
685 * - decoding: Set by libavcodec.\
687 int top_field_first;\
691 * - encoding: Set by user.\
692 * - decoding: Set by libavcodec.\
694 AVPanScan *pan_scan;\
697 * Tell user application that palette has changed from previous frame.\
698 * - encoding: ??? (no palette-enabled encoder yet)\
699 * - decoding: Set by libavcodec. (default 0).\
701 int palette_has_changed;\
704 * codec suggestion on buffer type if != 0\
705 * - encoding: unused\
706 * - decoding: Set by libavcodec. (before get_buffer() call)).\
712 * - encoding: unused\
713 * - decoding: Set by libavcodec.\
718 * motion referece frame index\
719 * - encoding: Set by user.\
720 * - decoding: Set by libavcodec.\
722 int8_t *ref_index[2];
724 #define FF_QSCALE_TYPE_MPEG1 0
725 #define FF_QSCALE_TYPE_MPEG2 1
726 #define FF_QSCALE_TYPE_H264 2
728 #define FF_BUFFER_TYPE_INTERNAL 1
729 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
730 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
731 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
734 #define FF_I_TYPE 1 // Intra
735 #define FF_P_TYPE 2 // Predicted
736 #define FF_B_TYPE 3 // Bi-dir predicted
737 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
741 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
742 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
743 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
744 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
749 typedef struct AVFrame {
753 #define DEFAULT_FRAME_RATE_BASE 1001000
756 * main external API structure
758 typedef struct AVCodecContext {
760 * information on struct for av_log
761 * - set by avcodec_alloc_context
765 * the average bitrate
766 * - encoding: Set by user; unused for constant quantizer encoding.
767 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
772 * number of bits the bitstream is allowed to diverge from the reference.
773 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
774 * - encoding: Set by user; unused for constant quantizer encoding.
777 int bit_rate_tolerance;
781 * - encoding: Set by user.
782 * - decoding: Set by user.
787 * Some codecs need additional format info. It is stored here.
788 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
789 * specific codec MUST set it correctly otherwise stream copy breaks.
790 * In general use of this field by muxers is not recommanded.
791 * - encoding: Set by libavcodec.
792 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
797 * Motion estimation algorithm used for video coding.
798 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
799 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
800 * - encoding: MUST be set by user.
806 * some codecs need / can use extradata like Huffman tables.
807 * mjpeg: Huffman tables
808 * rv10: additional flags
809 * mpeg4: global headers (they can be in the bitstream or here)
810 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
811 * than extradata_size to avoid prolems if it is read with the bitstream reader.
812 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
813 * - encoding: Set/allocated/freed by libavcodec.
814 * - decoding: Set/allocated/freed by user.
820 * This is the fundamental unit of time (in seconds) in terms
821 * of which frame timestamps are represented. For fixed-fps content,
822 * timebase should be 1/framerate and timestamp increments should be
824 * - encoding: MUST be set by user.
825 * - decoding: Set by libavcodec.
827 AVRational time_base;
831 * picture width / height.
832 * - encoding: MUST be set by user.
833 * - decoding: Set by libavcodec.
834 * Note: For compatibility it is possible to set this instead of
835 * coded_width/height before decoding.
839 #define FF_ASPECT_EXTENDED 15
842 * the number of pictures in a group of pictures, or 0 for intra_only
843 * - encoding: Set by user.
849 * Pixel format, see PIX_FMT_xxx.
850 * - encoding: Set by user.
851 * - decoding: Set by libavcodec.
853 enum PixelFormat pix_fmt;
856 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
857 * has to read frames at native frame rate.
858 * - encoding: Set by user.
864 * If non NULL, 'draw_horiz_band' is called by the libavcodec
865 * decoder to draw a horizontal band. It improves cache usage. Not
866 * all codecs can do that. You must check the codec capabilities
869 * - decoding: Set by user.
870 * @param height the height of the slice
871 * @param y the y position of the slice
872 * @param type 1->top field, 2->bottom field, 3->frame
873 * @param offset offset into the AVFrame.data from which the slice should be read
875 void (*draw_horiz_band)(struct AVCodecContext *s,
876 const AVFrame *src, int offset[4],
877 int y, int type, int height);
880 int sample_rate; ///< samples per second
884 * audio sample format
885 * - encoding: Set by user.
886 * - decoding: Set by libavcodec.
888 enum SampleFormat sample_fmt; ///< sample format, currently unused
890 /* The following data should not be initialized. */
892 * Samples per packet, initialized when calling 'init'.
895 int frame_number; ///< audio or video frame number
896 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
899 * Number of frames the decoded output will be delayed relative to
901 * - encoding: Set by libavcodec.
906 /* - encoding parameters */
907 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
908 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
912 * - encoding: Set by user.
919 * - encoding: Set by user.
925 * maximum quantizer difference between frames
926 * - encoding: Set by user.
932 * maximum number of B-frames between non-B-frames
933 * Note: The output will be delayed by max_b_frames+1 relative to the input.
934 * - encoding: Set by user.
940 * qscale factor between IP and B-frames
941 * - encoding: Set by user.
944 float b_quant_factor;
946 /** obsolete FIXME remove */
948 #define FF_RC_STRATEGY_XVID 1
950 int b_frame_strategy;
955 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
956 * @deprecated Deprecated in favor of skip_idct and skip_frame.
960 struct AVCodec *codec;
964 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
965 /* unused, FIXME remove*/
969 int rtp_payload_size; /* The size of the RTP payload: the coder will */
970 /* do its best to deliver a chunk with size */
971 /* below rtp_payload_size, the chunk will start */
972 /* with a start code on some codecs like H.263. */
973 /* This doesn't take account of any particular */
974 /* headers inside the transmitted RTP payload. */
977 /* The RTP callback: This function is called */
978 /* every time the encoder has a packet to send. */
979 /* It depends on the encoder if the data starts */
980 /* with a Start Code (it should). H.263 does. */
981 /* mb_nb contains the number of macroblocks */
982 /* encoded in the RTP payload. */
983 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
985 /* statistics, used for 2-pass encoding */
996 * number of bits used for the previously encoded frame
997 * - encoding: Set by libavcodec.
1003 * Private data of the user, can be used to carry app specific stuff.
1004 * - encoding: Set by user.
1005 * - decoding: Set by user.
1009 char codec_name[32];
1010 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1011 enum CodecID codec_id; /* see CODEC_ID_xxx */
1014 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1015 * This is used to work around some encoder bugs.
1016 * A demuxer should set this to what is stored in the field used to identify the codec.
1017 * If there are multiple such fields in a container then the demuxer should choose the one
1018 * which maximizes the information about the used codec.
1019 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1020 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1021 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1023 * - encoding: Set by user, if not then the default based on codec_id will be used.
1024 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1026 unsigned int codec_tag;
1029 * Work around bugs in encoders which sometimes cannot be detected automatically.
1030 * - encoding: Set by user
1031 * - decoding: Set by user
1033 int workaround_bugs;
1034 #define FF_BUG_AUTODETECT 1 ///< autodetection
1035 #define FF_BUG_OLD_MSMPEG4 2
1036 #define FF_BUG_XVID_ILACE 4
1037 #define FF_BUG_UMP4 8
1038 #define FF_BUG_NO_PADDING 16
1039 #define FF_BUG_AMV 32
1040 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1041 #define FF_BUG_QPEL_CHROMA 64
1042 #define FF_BUG_STD_QPEL 128
1043 #define FF_BUG_QPEL_CHROMA2 256
1044 #define FF_BUG_DIRECT_BLOCKSIZE 512
1045 #define FF_BUG_EDGE 1024
1046 #define FF_BUG_HPEL_CHROMA 2048
1047 #define FF_BUG_DC_CLIP 4096
1048 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1049 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1052 * luma single coefficient elimination threshold
1053 * - encoding: Set by user.
1054 * - decoding: unused
1056 int luma_elim_threshold;
1059 * chroma single coeff elimination threshold
1060 * - encoding: Set by user.
1061 * - decoding: unused
1063 int chroma_elim_threshold;
1066 * strictly follow the standard (MPEG4, ...).
1067 * - encoding: Set by user.
1068 * - decoding: unused
1070 int strict_std_compliance;
1071 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1072 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1073 #define FF_COMPLIANCE_NORMAL 0
1074 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1075 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1078 * qscale offset between IP and B-frames
1079 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1080 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1081 * - encoding: Set by user.
1082 * - decoding: unused
1084 float b_quant_offset;
1087 * Error resilience; higher values will detect more errors but may
1088 * misdetect some more or less valid parts as errors.
1089 * - encoding: unused
1090 * - decoding: Set by user.
1092 int error_resilience;
1093 #define FF_ER_CAREFUL 1
1094 #define FF_ER_COMPLIANT 2
1095 #define FF_ER_AGGRESSIVE 3
1096 #define FF_ER_VERY_AGGRESSIVE 4
1099 * Called at the beginning of each frame to get a buffer for it.
1100 * If pic.reference is set then the frame will be read later by libavcodec.
1101 * avcodec_align_dimensions() should be used to find the required width and
1102 * height, as they normally need to be rounded up to the next multiple of 16.
1103 * - encoding: unused
1104 * - decoding: Set by libavcodec., user can override.
1106 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1109 * Called to release buffers which where allocated with get_buffer.
1110 * A released buffer can be reused in get_buffer().
1111 * pic.data[*] must be set to NULL.
1112 * - encoding: unused
1113 * - decoding: Set by libavcodec., user can override.
1115 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1118 * If 1 the stream has a 1 frame delay during decoding.
1119 * - encoding: Set by libavcodec.
1120 * - decoding: Set by libavcodec.
1125 * number of bytes per packet if constant and known or 0
1126 * Used by some WAV based audio codecs.
1130 int parse_only; /* - decoding only: If true, only parsing is done
1131 (function avcodec_parse_frame()). The frame
1132 data is returned. Only MPEG codecs support this now. */
1135 * 0-> h263 quant 1-> mpeg quant
1136 * - encoding: Set by user.
1137 * - decoding: unused
1142 * pass1 encoding statistics output buffer
1143 * - encoding: Set by libavcodec.
1144 * - decoding: unused
1149 * pass2 encoding statistics input buffer
1150 * Concatenated stuff from stats_out of pass1 should be placed here.
1151 * - encoding: Allocated/set/freed by user.
1152 * - decoding: unused
1157 * ratecontrol qmin qmax limiting method
1158 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1159 * - encoding: Set by user.
1160 * - decoding: unused
1168 * ratecontrol override, see RcOverride
1169 * - encoding: Allocated/set/freed by user.
1170 * - decoding: unused
1172 RcOverride *rc_override;
1173 int rc_override_count;
1176 * rate control equation
1177 * - encoding: Set by user
1178 * - decoding: unused
1184 * - encoding: Set by user.
1185 * - decoding: unused
1191 * - encoding: Set by user.
1192 * - decoding: unused
1197 * decoder bitstream buffer size
1198 * - encoding: Set by user.
1199 * - decoding: unused
1202 float rc_buffer_aggressivity;
1205 * qscale factor between P and I-frames
1206 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1207 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1208 * - encoding: Set by user.
1209 * - decoding: unused
1211 float i_quant_factor;
1214 * qscale offset between P and I-frames
1215 * - encoding: Set by user.
1216 * - decoding: unused
1218 float i_quant_offset;
1221 * initial complexity for pass1 ratecontrol
1222 * - encoding: Set by user.
1223 * - decoding: unused
1225 float rc_initial_cplx;
1228 * DCT algorithm, see FF_DCT_* below
1229 * - encoding: Set by user.
1230 * - decoding: unused
1233 #define FF_DCT_AUTO 0
1234 #define FF_DCT_FASTINT 1
1235 #define FF_DCT_INT 2
1236 #define FF_DCT_MMX 3
1237 #define FF_DCT_MLIB 4
1238 #define FF_DCT_ALTIVEC 5
1239 #define FF_DCT_FAAN 6
1242 * luminance masking (0-> disabled)
1243 * - encoding: Set by user.
1244 * - decoding: unused
1249 * temporary complexity masking (0-> disabled)
1250 * - encoding: Set by user.
1251 * - decoding: unused
1253 float temporal_cplx_masking;
1256 * spatial complexity masking (0-> disabled)
1257 * - encoding: Set by user.
1258 * - decoding: unused
1260 float spatial_cplx_masking;
1263 * p block masking (0-> disabled)
1264 * - encoding: Set by user.
1265 * - decoding: unused
1270 * darkness masking (0-> disabled)
1271 * - encoding: Set by user.
1272 * - decoding: unused
1277 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1278 /* for binary compatibility */
1283 * IDCT algorithm, see FF_IDCT_* below.
1284 * - encoding: Set by user.
1285 * - decoding: Set by user.
1288 #define FF_IDCT_AUTO 0
1289 #define FF_IDCT_INT 1
1290 #define FF_IDCT_SIMPLE 2
1291 #define FF_IDCT_SIMPLEMMX 3
1292 #define FF_IDCT_LIBMPEG2MMX 4
1293 #define FF_IDCT_PS2 5
1294 #define FF_IDCT_MLIB 6
1295 #define FF_IDCT_ARM 7
1296 #define FF_IDCT_ALTIVEC 8
1297 #define FF_IDCT_SH4 9
1298 #define FF_IDCT_SIMPLEARM 10
1299 #define FF_IDCT_H264 11
1300 #define FF_IDCT_VP3 12
1301 #define FF_IDCT_IPP 13
1302 #define FF_IDCT_XVIDMMX 14
1303 #define FF_IDCT_CAVS 15
1304 #define FF_IDCT_SIMPLEARMV5TE 16
1305 #define FF_IDCT_SIMPLEARMV6 17
1306 #define FF_IDCT_SIMPLEVIS 18
1307 #define FF_IDCT_WMV2 19
1311 * - encoding: Set by libavcodec.
1312 * - decoding: Set by user (or 0).
1316 * slice offsets in the frame in bytes
1317 * - encoding: Set/allocated by libavcodec.
1318 * - decoding: Set/allocated by user (or NULL).
1323 * error concealment flags
1324 * - encoding: unused
1325 * - decoding: Set by user.
1327 int error_concealment;
1328 #define FF_EC_GUESS_MVS 1
1329 #define FF_EC_DEBLOCK 2
1332 * dsp_mask could be add used to disable unwanted CPU features
1333 * CPU features (i.e. MMX, SSE. ...)
1335 * With the FORCE flag you may instead enable given CPU features.
1336 * (Dangerous: Usable in case of misdetection, improper usage however will
1337 * result into program crash.)
1340 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1341 /* lower 16 bits - CPU features */
1342 #define FF_MM_MMX 0x0001 /* standard MMX */
1343 #define FF_MM_3DNOW 0x0004 /* AMD 3DNOW */
1344 #define FF_MM_MMXEXT 0x0002 /* SSE integer functions or AMD MMX ext */
1345 #define FF_MM_SSE 0x0008 /* SSE functions */
1346 #define FF_MM_SSE2 0x0010 /* PIV SSE2 functions */
1347 #define FF_MM_3DNOWEXT 0x0020 /* AMD 3DNowExt */
1348 #define FF_MM_SSE3 0x0040 /* Prescott SSE3 functions */
1349 #define FF_MM_SSSE3 0x0080 /* Conroe SSSE3 functions */
1350 #define FF_MM_IWMMXT 0x0100 /* XScale IWMMXT */
1353 * bits per sample/pixel from the demuxer (needed for huffyuv).
1354 * - encoding: Set by libavcodec.
1355 * - decoding: Set by user.
1357 int bits_per_sample;
1360 * prediction method (needed for huffyuv)
1361 * - encoding: Set by user.
1362 * - decoding: unused
1364 int prediction_method;
1365 #define FF_PRED_LEFT 0
1366 #define FF_PRED_PLANE 1
1367 #define FF_PRED_MEDIAN 2
1370 * sample aspect ratio (0 if unknown)
1371 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1372 * - encoding: Set by user.
1373 * - decoding: Set by libavcodec.
1375 AVRational sample_aspect_ratio;
1378 * the picture in the bitstream
1379 * - encoding: Set by libavcodec.
1380 * - decoding: Set by libavcodec.
1382 AVFrame *coded_frame;
1386 * - encoding: Set by user.
1387 * - decoding: Set by user.
1390 #define FF_DEBUG_PICT_INFO 1
1391 #define FF_DEBUG_RC 2
1392 #define FF_DEBUG_BITSTREAM 4
1393 #define FF_DEBUG_MB_TYPE 8
1394 #define FF_DEBUG_QP 16
1395 #define FF_DEBUG_MV 32
1396 #define FF_DEBUG_DCT_COEFF 0x00000040
1397 #define FF_DEBUG_SKIP 0x00000080
1398 #define FF_DEBUG_STARTCODE 0x00000100
1399 #define FF_DEBUG_PTS 0x00000200
1400 #define FF_DEBUG_ER 0x00000400
1401 #define FF_DEBUG_MMCO 0x00000800
1402 #define FF_DEBUG_BUGS 0x00001000
1403 #define FF_DEBUG_VIS_QP 0x00002000
1404 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1408 * - encoding: Set by user.
1409 * - decoding: Set by user.
1412 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1413 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1414 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1418 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1419 * - decoding: unused
1424 * minimum MB quantizer
1425 * - encoding: unused
1426 * - decoding: unused
1431 * maximum MB quantizer
1432 * - encoding: unused
1433 * - decoding: unused
1438 * motion estimation comparison function
1439 * - encoding: Set by user.
1440 * - decoding: unused
1444 * subpixel motion estimation comparison function
1445 * - encoding: Set by user.
1446 * - decoding: unused
1450 * macroblock comparison function (not supported yet)
1451 * - encoding: Set by user.
1452 * - decoding: unused
1456 * interlaced DCT comparison function
1457 * - encoding: Set by user.
1458 * - decoding: unused
1461 #define FF_CMP_SAD 0
1462 #define FF_CMP_SSE 1
1463 #define FF_CMP_SATD 2
1464 #define FF_CMP_DCT 3
1465 #define FF_CMP_PSNR 4
1466 #define FF_CMP_BIT 5
1468 #define FF_CMP_ZERO 7
1469 #define FF_CMP_VSAD 8
1470 #define FF_CMP_VSSE 9
1471 #define FF_CMP_NSSE 10
1472 #define FF_CMP_W53 11
1473 #define FF_CMP_W97 12
1474 #define FF_CMP_DCTMAX 13
1475 #define FF_CMP_DCT264 14
1476 #define FF_CMP_CHROMA 256
1479 * ME diamond size & shape
1480 * - encoding: Set by user.
1481 * - decoding: unused
1486 * amount of previous MV predictors (2a+1 x 2a+1 square)
1487 * - encoding: Set by user.
1488 * - decoding: unused
1490 int last_predictor_count;
1493 * prepass for motion estimation
1494 * - encoding: Set by user.
1495 * - decoding: unused
1500 * motion estimation prepass comparison function
1501 * - encoding: Set by user.
1502 * - decoding: unused
1507 * ME prepass diamond size & shape
1508 * - encoding: Set by user.
1509 * - decoding: unused
1515 * - encoding: Set by user.
1516 * - decoding: unused
1518 int me_subpel_quality;
1521 * callback to negotiate the pixelFormat
1522 * @param fmt is the list of formats which are supported by the codec,
1523 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1524 * The first is always the native one.
1525 * @return the chosen format
1526 * - encoding: unused
1527 * - decoding: Set by user, if not set the native format will be chosen.
1529 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1532 * DTG active format information (additional aspect ratio
1533 * information only used in DVB MPEG-2 transport streams)
1536 * - encoding: unused
1537 * - decoding: Set by decoder.
1539 int dtg_active_format;
1540 #define FF_DTG_AFD_SAME 8
1541 #define FF_DTG_AFD_4_3 9
1542 #define FF_DTG_AFD_16_9 10
1543 #define FF_DTG_AFD_14_9 11
1544 #define FF_DTG_AFD_4_3_SP_14_9 13
1545 #define FF_DTG_AFD_16_9_SP_14_9 14
1546 #define FF_DTG_AFD_SP_4_3 15
1549 * maximum motion estimation search range in subpel units
1550 * If 0 then no limit.
1552 * - encoding: Set by user.
1553 * - decoding: unused
1558 * intra quantizer bias
1559 * - encoding: Set by user.
1560 * - decoding: unused
1562 int intra_quant_bias;
1563 #define FF_DEFAULT_QUANT_BIAS 999999
1566 * inter quantizer bias
1567 * - encoding: Set by user.
1568 * - decoding: unused
1570 int inter_quant_bias;
1574 * - encoding: unused
1575 * - decoding: Which clrtable should be used for 8bit RGB images.
1576 * Tables have to be stored somewhere. FIXME
1581 * internal_buffer count
1582 * Don't touch, used by libavcodec default_get_buffer().
1584 int internal_buffer_count;
1588 * Don't touch, used by libavcodec default_get_buffer().
1590 void *internal_buffer;
1592 #define FF_LAMBDA_SHIFT 7
1593 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1594 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1595 #define FF_LAMBDA_MAX (256*128-1)
1597 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1599 * Global quality for codecs which cannot change it per frame.
1600 * This should be proportional to MPEG-1/2/4 qscale.
1601 * - encoding: Set by user.
1602 * - decoding: unused
1606 #define FF_CODER_TYPE_VLC 0
1607 #define FF_CODER_TYPE_AC 1
1608 #define FF_CODER_TYPE_RAW 2
1609 #define FF_CODER_TYPE_RLE 3
1610 #define FF_CODER_TYPE_DEFLATE 4
1613 * - encoding: Set by user.
1614 * - decoding: unused
1620 * - encoding: Set by user.
1621 * - decoding: unused
1627 * - encoding: unused
1628 * - decoding: Set by user.
1630 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1635 * - encoding: unused
1636 * - decoding: Set by user.
1639 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1640 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1641 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1644 * XVideo Motion Acceleration
1645 * - encoding: forbidden
1646 * - decoding: set by decoder
1648 int xvmc_acceleration;
1651 * macroblock decision mode
1652 * - encoding: Set by user.
1653 * - decoding: unused
1656 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1657 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1658 #define FF_MB_DECISION_RD 2 ///< rate distoration
1661 * custom intra quantization matrix
1662 * - encoding: Set by user, can be NULL.
1663 * - decoding: Set by libavcodec.
1665 uint16_t *intra_matrix;
1668 * custom inter quantization matrix
1669 * - encoding: Set by user, can be NULL.
1670 * - decoding: Set by libavcodec.
1672 uint16_t *inter_matrix;
1675 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1676 * This is used to work around some encoder bugs.
1677 * - encoding: unused
1678 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1680 unsigned int stream_codec_tag;
1683 * scene change detection threshold
1684 * 0 is default, larger means fewer detected scene changes.
1685 * - encoding: Set by user.
1686 * - decoding: unused
1688 int scenechange_threshold;
1691 * minimum Lagrange multipler
1692 * - encoding: Set by user.
1693 * - decoding: unused
1698 * maximum Lagrange multipler
1699 * - encoding: Set by user.
1700 * - decoding: unused
1705 * palette control structure
1706 * - encoding: ??? (no palette-enabled encoder yet)
1707 * - decoding: Set by user.
1709 struct AVPaletteControl *palctrl;
1712 * noise reduction strength
1713 * - encoding: Set by user.
1714 * - decoding: unused
1716 int noise_reduction;
1719 * Called at the beginning of a frame to get cr buffer for it.
1720 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1721 * libavcodec will pass previous buffer in pic, function should return
1722 * same buffer or new buffer with old frame "painted" into it.
1723 * If pic.data[0] == NULL must behave like get_buffer().
1724 * - encoding: unused
1725 * - decoding: Set by libavcodec., user can override
1727 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1730 * Number of bits which should be loaded into the rc buffer before decoding starts.
1731 * - encoding: Set by user.
1732 * - decoding: unused
1734 int rc_initial_buffer_occupancy;
1738 * - encoding: Set by user.
1739 * - decoding: unused
1741 int inter_threshold;
1745 * - encoding: Set by user.
1746 * - decoding: Set by user.
1751 * Simulates errors in the bitstream to test error concealment.
1752 * - encoding: Set by user.
1753 * - decoding: unused
1758 * MP3 antialias algorithm, see FF_AA_* below.
1759 * - encoding: unused
1760 * - decoding: Set by user.
1763 #define FF_AA_AUTO 0
1764 #define FF_AA_FASTINT 1 //not implemented yet
1766 #define FF_AA_FLOAT 3
1768 * quantizer noise shaping
1769 * - encoding: Set by user.
1770 * - decoding: unused
1772 int quantizer_noise_shaping;
1776 * is used to decide how many independent tasks should be passed to execute()
1777 * - encoding: Set by user.
1778 * - decoding: Set by user.
1783 * The codec may call this to execute several independent things.
1784 * It will return only after finishing all tasks.
1785 * The user may replace this with some multithreaded implementation,
1786 * the default implementation will execute the parts serially.
1787 * @param count the number of things to execute
1788 * - encoding: Set by libavcodec, user can override.
1789 * - decoding: Set by libavcodec, user can override.
1791 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1795 * Can be used by execute() to store some per AVCodecContext stuff.
1796 * - encoding: set by execute()
1797 * - decoding: set by execute()
1799 void *thread_opaque;
1802 * Motion estimation threshold below which no motion estimation is
1803 * performed, but instead the user specified motion vectors are used.
1805 * - encoding: Set by user.
1806 * - decoding: unused
1811 * Macroblock threshold below which the user specified macroblock types will be used.
1812 * - encoding: Set by user.
1813 * - decoding: unused
1818 * precision of the intra DC coefficient - 8
1819 * - encoding: Set by user.
1820 * - decoding: unused
1822 int intra_dc_precision;
1825 * noise vs. sse weight for the nsse comparsion function
1826 * - encoding: Set by user.
1827 * - decoding: unused
1832 * Number of macroblock rows at the top which are skipped.
1833 * - encoding: unused
1834 * - decoding: Set by user.
1839 * Number of macroblock rows at the bottom which are skipped.
1840 * - encoding: unused
1841 * - decoding: Set by user.
1847 * - encoding: Set by user.
1848 * - decoding: Set by libavcodec.
1851 #define FF_PROFILE_UNKNOWN -99
1852 #define FF_PROFILE_AAC_MAIN 0
1853 #define FF_PROFILE_AAC_LOW 1
1854 #define FF_PROFILE_AAC_SSR 2
1855 #define FF_PROFILE_AAC_LTP 3
1859 * - encoding: Set by user.
1860 * - decoding: Set by libavcodec.
1863 #define FF_LEVEL_UNKNOWN -99
1866 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1867 * - encoding: unused
1868 * - decoding: Set by user.
1873 * Bitstream width / height, may be different from width/height if lowres
1874 * or other things are used.
1875 * - encoding: unused
1876 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1878 int coded_width, coded_height;
1881 * frame skip threshold
1882 * - encoding: Set by user.
1883 * - decoding: unused
1885 int frame_skip_threshold;
1889 * - encoding: Set by user.
1890 * - decoding: unused
1892 int frame_skip_factor;
1895 * frame skip exponent
1896 * - encoding: Set by user.
1897 * - decoding: unused
1902 * frame skip comparison function
1903 * - encoding: Set by user.
1904 * - decoding: unused
1909 * Border processing masking, raises the quantizer for mbs on the borders
1911 * - encoding: Set by user.
1912 * - decoding: unused
1914 float border_masking;
1917 * minimum MB lagrange multipler
1918 * - encoding: Set by user.
1919 * - decoding: unused
1924 * maximum MB lagrange multipler
1925 * - encoding: Set by user.
1926 * - decoding: unused
1932 * - encoding: Set by user.
1933 * - decoding: unused
1935 int me_penalty_compensation;
1939 * - encoding: unused
1940 * - decoding: Set by user.
1942 enum AVDiscard skip_loop_filter;
1946 * - encoding: unused
1947 * - decoding: Set by user.
1949 enum AVDiscard skip_idct;
1953 * - encoding: unused
1954 * - decoding: Set by user.
1956 enum AVDiscard skip_frame;
1960 * - encoding: Set by user.
1961 * - decoding: unused
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * constant rate factor - quality-based VBR - values ~correspond to qps
1974 * - encoding: Set by user.
1975 * - decoding: unused
1980 * constant quantization parameter rate control method
1981 * - encoding: Set by user.
1982 * - decoding: unused
1988 * - encoding: Set by user.
1989 * - decoding: unused
1994 * number of reference frames
1995 * - encoding: Set by user.
1996 * - decoding: unused
2001 * chroma qp offset from luma
2002 * - encoding: Set by user.
2003 * - decoding: unused
2008 * Influences how often B-frames are used.
2009 * - encoding: Set by user.
2010 * - decoding: unused
2015 * trellis RD quantization
2016 * - encoding: Set by user.
2017 * - decoding: unused
2022 * Reduce fluctuations in qp (before curve compression).
2023 * - encoding: Set by user.
2024 * - decoding: unused
2026 float complexityblur;
2029 * in-loop deblocking filter alphac0 parameter
2030 * alpha is in the range -6...6
2031 * - encoding: Set by user.
2032 * - decoding: unused
2037 * in-loop deblocking filter beta parameter
2038 * beta is in the range -6...6
2039 * - encoding: Set by user.
2040 * - decoding: unused
2045 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2046 * - encoding: Set by user.
2047 * - decoding: unused
2050 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2051 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2052 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2053 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2054 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2057 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2058 * - encoding: Set by user.
2059 * - decoding: unused
2064 * Audio cutoff bandwidth (0 means "automatic"), currently used only by FAAC.
2065 * - encoding: Set by user.
2066 * - decoding: unused
2071 * Multiplied by qscale for each frame and added to scene_change_score.
2072 * - encoding: Set by user.
2073 * - decoding: unused
2075 int scenechange_factor;
2079 * Note: Value depends upon the compare function used for fullpel ME.
2080 * - encoding: Set by user.
2081 * - decoding: unused
2086 * Adjusts sensitivity of b_frame_strategy 1.
2087 * - encoding: Set by user.
2088 * - decoding: unused
2093 * - encoding: Set by user.
2094 * - decoding: unused
2096 int compression_level;
2097 #define FF_COMPRESSION_DEFAULT -1
2100 * Sets whether to use LPC mode - used by FLAC encoder.
2101 * - encoding: Set by user.
2102 * - decoding: unused
2107 * LPC coefficient precision - used by FLAC encoder
2108 * - encoding: Set by user.
2109 * - decoding: unused
2111 int lpc_coeff_precision;
2114 * - encoding: Set by user.
2115 * - decoding: unused
2117 int min_prediction_order;
2120 * - encoding: Set by user.
2121 * - decoding: unused
2123 int max_prediction_order;
2126 * search method for selecting prediction order
2127 * - encoding: Set by user.
2128 * - decoding: unused
2130 int prediction_order_method;
2133 * - encoding: Set by user.
2134 * - decoding: unused
2136 int min_partition_order;
2139 * - encoding: Set by user.
2140 * - decoding: unused
2142 int max_partition_order;
2145 * GOP timecode frame start number, in non drop frame format
2146 * - encoding: Set by user.
2147 * - decoding: unused
2149 int64_t timecode_frame_start;
2152 * Decoder should decode to this many channels if it can (0 for default)
2153 * - encoding: unused
2154 * - decoding: Set by user.
2156 int request_channels;
2162 typedef struct AVCodec {
2164 * Name of the codec implementation.
2165 * The name is globally unique among encoders and among decoders (but an
2166 * encoder and a decoder can share the same name).
2167 * This is the primary way to find a codec from the user perspective.
2170 enum CodecType type;
2173 int (*init)(AVCodecContext *);
2174 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2175 int (*close)(AVCodecContext *);
2176 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2177 uint8_t *buf, int buf_size);
2179 struct AVCodec *next;
2180 void (*flush)(AVCodecContext *);
2181 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2182 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2186 * four components are given, that's all.
2187 * the last component is alpha
2189 typedef struct AVPicture {
2191 int linesize[4]; ///< number of bytes per line
2196 * This structure defines a method for communicating palette changes
2197 * between and demuxer and a decoder.
2199 * @deprecated Use AVPacket to send palette changes instead.
2200 * This is totally broken.
2202 #define AVPALETTE_SIZE 1024
2203 #define AVPALETTE_COUNT 256
2204 typedef struct AVPaletteControl {
2206 /* Demuxer sets this to 1 to indicate the palette has changed;
2207 * decoder resets to 0. */
2208 int palette_changed;
2210 /* 4-byte ARGB palette entries, stored in native byte order; note that
2211 * the individual palette components should be on a 8-bit scale; if
2212 * the palette data comes from an IBM VGA native format, the component
2213 * data is probably 6 bits in size and needs to be scaled. */
2214 unsigned int palette[AVPALETTE_COUNT];
2216 } AVPaletteControl attribute_deprecated;
2218 typedef struct AVSubtitleRect {
2225 uint32_t *rgba_palette;
2229 typedef struct AVSubtitle {
2230 uint16_t format; /* 0 = graphics */
2231 uint32_t start_display_time; /* relative to packet pts, in ms */
2232 uint32_t end_display_time; /* relative to packet pts, in ms */
2234 AVSubtitleRect *rects;
2240 struct ReSampleContext;
2241 struct AVResampleContext;
2243 typedef struct ReSampleContext ReSampleContext;
2245 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2246 int output_rate, int input_rate);
2247 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2248 void audio_resample_close(ReSampleContext *s);
2250 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2251 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2252 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2253 void av_resample_close(struct AVResampleContext *c);
2255 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2256 /* YUV420 format is assumed ! */
2259 * @deprecated Use the software scaler (swscale) instead.
2261 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2264 * @deprecated Use the software scaler (swscale) instead.
2266 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2267 int input_width, int input_height);
2270 * @deprecated Use the software scaler (swscale) instead.
2272 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2273 int iwidth, int iheight,
2274 int topBand, int bottomBand,
2275 int leftBand, int rightBand,
2276 int padtop, int padbottom,
2277 int padleft, int padright);
2280 * @deprecated Use the software scaler (swscale) instead.
2282 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2283 AVPicture *output, const AVPicture *input);
2286 * @deprecated Use the software scaler (swscale) instead.
2288 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2293 * Allocate memory for a picture. Call avpicture_free to free it.
2295 * @param picture the picture to be filled in
2296 * @param pix_fmt the format of the picture
2297 * @param width the width of the picture
2298 * @param height the height of the picture
2299 * @return zero if successful, a negative value if not
2301 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2304 * Free a picture previously allocated by avpicture_alloc().
2306 * @param picture the AVPicture to be freed
2308 void avpicture_free(AVPicture *picture);
2311 * Fill in the AVPicture fields.
2312 * The fields of the given AVPicture are filled in by using the 'ptr' address
2313 * which points to the image data buffer. Depending on the specified picture
2314 * format, one or multiple image data pointers and line sizes will be set.
2315 * If a planar format is specified, several pointers will be set pointing to
2316 * the different picture planes and the line sizes of the different planes
2317 * will be stored in the lines_sizes array.
2319 * @param picture AVPicture whose fields are to be filled in
2320 * @param ptr Buffer which will contain or contains the actual image data
2321 * @param pix_fmt The format in which the picture data is stored.
2322 * @param width the width of the image in pixels
2323 * @param height the height of the image in pixels
2324 * @return size of the image data in bytes
2326 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2327 int pix_fmt, int width, int height);
2328 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2329 unsigned char *dest, int dest_size);
2332 * Calculate the size in bytes that a picture of the given width and height
2333 * would occupy if stored in the given picture format.
2335 * @param pix_fmt the given picture format
2336 * @param width the width of the image
2337 * @param height the height of the image
2338 * @return Image data size in bytes
2340 int avpicture_get_size(int pix_fmt, int width, int height);
2341 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2342 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2343 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2344 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2345 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2347 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2348 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2349 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2350 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2351 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2352 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2355 * Computes what kind of losses will occur when converting from one specific
2356 * pixel format to another.
2357 * When converting from one pixel format to another, information loss may occur.
2358 * For example, when converting from RGB24 to GRAY, the color information will
2359 * be lost. Similarly, other losses occur when converting from some formats to
2360 * other formats. These losses can involve loss of chroma, but also loss of
2361 * resolution, loss of color depth, loss due to the color space conversion, loss
2362 * of the alpha bits or loss due to color quantization.
2363 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2364 * which will occur when converting from one pixel format to another.
2366 * @param[in] dst_pix_fmt destination pixel format
2367 * @param[in] src_pix_fmt source pixel format
2368 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2369 * @return Combination of flags informing you what kind of losses will occur.
2371 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2375 * Finds the best pixel format to convert to given a certain source pixel
2376 * format. When converting from one pixel format to another, information loss
2377 * may occur. For example, when converting from RGB24 to GRAY, the color
2378 * information will be lost. Similarly, other losses occur when converting from
2379 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2380 * the given pixel formats should be used to suffer the least amount of loss.
2381 * The pixel formats from which it chooses one, are determined by the
2382 * \p pix_fmt_mask parameter.
2385 * src_pix_fmt = PIX_FMT_YUV420P;
2386 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2387 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2390 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2391 * @param[in] src_pix_fmt source pixel format
2392 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2393 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2394 * @return The best pixel format to convert to or -1 if none was found.
2396 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2397 int has_alpha, int *loss_ptr);
2401 * Print in buf the string corresponding to the pixel format with
2402 * number pix_fmt, or an header if pix_fmt is negative.
2404 * @param[in] buf the buffer where to write the string
2405 * @param[in] buf_size the size of buf
2406 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2407 * a negative value to print the corresponding header.
2408 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2410 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2412 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2413 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2416 * Tell if an image really has transparent alpha values.
2417 * @return ored mask of FF_ALPHA_xxx constants
2419 int img_get_alpha_info(const AVPicture *src,
2420 int pix_fmt, int width, int height);
2422 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2424 * convert among pixel formats
2425 * @deprecated Use the software scaler (swscale) instead.
2427 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2428 const AVPicture *src, int pix_fmt,
2429 int width, int height);
2432 /* deinterlace a picture */
2433 /* deinterlace - if not supported return -1 */
2434 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2435 int pix_fmt, int width, int height);
2437 /* external high level API */
2439 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2440 extern AVCodec *first_avcodec;
2442 AVCodec *av_codec_next(AVCodec *c);
2444 /* returns LIBAVCODEC_VERSION_INT constant */
2445 unsigned avcodec_version(void);
2446 /* returns LIBAVCODEC_BUILD constant */
2447 unsigned avcodec_build(void);
2450 * Initializes libavcodec.
2452 * @warning This function \e must be called before any other libavcodec
2455 void avcodec_init(void);
2457 void register_avcodec(AVCodec *format);
2460 * Finds a registered encoder with a matching codec ID.
2462 * @param id CodecID of the requested encoder
2463 * @return An encoder if one was found, NULL otherwise.
2465 AVCodec *avcodec_find_encoder(enum CodecID id);
2468 * Finds a registered encoder with the specified name.
2470 * @param name name of the requested encoder
2471 * @return An encoder if one was found, NULL otherwise.
2473 AVCodec *avcodec_find_encoder_by_name(const char *name);
2476 * Finds a registered decoder with a matching codec ID.
2478 * @param id CodecID of the requested decoder
2479 * @return A decoder if one was found, NULL otherwise.
2481 AVCodec *avcodec_find_decoder(enum CodecID id);
2484 * Finds a registered decoder with the specified name.
2486 * @param name name of the requested decoder
2487 * @return A decoder if one was found, NULL otherwise.
2489 AVCodec *avcodec_find_decoder_by_name(const char *name);
2490 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2493 * Sets the fields of the given AVCodecContext to default values.
2495 * @param s The AVCodecContext of which the fields should be set to default values.
2497 void avcodec_get_context_defaults(AVCodecContext *s);
2499 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2500 * we WILL change its arguments and name a few times! */
2501 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2504 * Allocates an AVCodecContext and sets its fields to default values. The
2505 * resulting struct can be deallocated by simply calling av_free().
2507 * @return An AVCodecContext filled with default values or NULL on failure.
2508 * @see avcodec_get_context_defaults
2510 AVCodecContext *avcodec_alloc_context(void);
2512 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2513 * we WILL change its arguments and name a few times! */
2514 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2517 * Sets the fields of the given AVFrame to default values.
2519 * @param pic The AVFrame of which the fields should be set to default values.
2521 void avcodec_get_frame_defaults(AVFrame *pic);
2524 * Allocates an AVFrame and sets its fields to default values. The resulting
2525 * struct can be deallocated by simply calling av_free().
2527 * @return An AVFrame filled with default values or NULL on failure.
2528 * @see avcodec_get_frame_defaults
2530 AVFrame *avcodec_alloc_frame(void);
2532 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2533 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2534 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2535 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2538 * Checks if the given dimension of a picture is valid, meaning that all
2539 * bytes of the picture can be addressed with a signed int.
2541 * @param[in] w Width of the picture.
2542 * @param[in] h Height of the picture.
2543 * @return Zero if valid, a negative value if invalid.
2545 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2546 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2548 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2549 void avcodec_thread_free(AVCodecContext *s);
2550 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2551 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2552 //FIXME func typedef
2555 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2556 * function the context has to be allocated.
2558 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2559 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2560 * retrieving a codec.
2562 * @warning This function is not thread safe!
2565 * avcodec_register_all();
2566 * codec = avcodec_find_decoder(CODEC_ID_H264);
2570 * context = avcodec_alloc_context();
2572 * if (avcodec_open(context, codec) < 0)
2576 * @param avctx The context which will be set up to use the given codec.
2577 * @param codec The codec to use within the context.
2578 * @return zero on success, a negative value on error
2579 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2581 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2584 * @deprecated Use avcodec_decode_audio2() instead.
2586 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2587 int *frame_size_ptr,
2588 uint8_t *buf, int buf_size);
2591 * Decodes an audio frame from \p buf into \p samples.
2592 * The avcodec_decode_audio2() function decodes an audio frame from the input
2593 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2594 * audio codec which was coupled with \p avctx using avcodec_open(). The
2595 * resulting decoded frame is stored in output buffer \p samples. If no frame
2596 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2597 * decompressed frame size in \e bytes.
2599 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2600 * output buffer before calling avcodec_decode_audio2().
2602 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2603 * the actual read bytes because some optimized bitstream readers read 32 or 64
2604 * bits at once and could read over the end.
2606 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2607 * no overreading happens for damaged MPEG streams.
2609 * @note You might have to align the input buffer \p buf and output buffer \p
2610 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2611 * necessary at all, on others it won't work at all if not aligned and on others
2612 * it will work but it will have an impact on performance. In practice, the
2613 * bitstream should have 4 byte alignment at minimum and all sample data should
2614 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2615 * the linesize is not a multiple of 16 then there's no sense in aligning the
2616 * start of the buffer to 16.
2618 * @param avctx the codec context
2619 * @param[out] samples the output buffer
2620 * @param[in,out] frame_size_ptr the output buffer size in bytes
2621 * @param[in] buf the input buffer
2622 * @param[in] buf_size the input buffer size in bytes
2623 * @return On error a negative value is returned, otherwise the number of bytes
2624 * used or zero if no frame could be decompressed.
2626 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2627 int *frame_size_ptr,
2628 uint8_t *buf, int buf_size);
2631 * Decodes a video frame from \p buf into \p picture.
2632 * The avcodec_decode_video() function decodes a video frame from the input
2633 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2634 * video codec which was coupled with \p avctx using avcodec_open(). The
2635 * resulting decoded frame is stored in \p picture.
2637 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2638 * the actual read bytes because some optimized bitstream readers read 32 or 64
2639 * bits at once and could read over the end.
2641 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2642 * no overreading happens for damaged MPEG streams.
2644 * @note You might have to align the input buffer \p buf and output buffer \p
2645 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2646 * necessary at all, on others it won't work at all if not aligned and on others
2647 * it will work but it will have an impact on performance. In practice, the
2648 * bitstream should have 4 byte alignment at minimum and all sample data should
2649 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2650 * the linesize is not a multiple of 16 then there's no sense in aligning the
2651 * start of the buffer to 16.
2653 * @param avctx the codec context
2654 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2655 * @param[in] buf the input buffer
2656 * @param[in] buf_size the size of the input buffer in bytes
2657 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2658 * @return On error a negative value is returned, otherwise the number of bytes
2659 * used or zero if no frame could be decompressed.
2661 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2662 int *got_picture_ptr,
2663 uint8_t *buf, int buf_size);
2665 /* Decode a subtitle message. Return -1 if error, otherwise return the
2666 * number of bytes used. If no subtitle could be decompressed,
2667 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2668 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2670 const uint8_t *buf, int buf_size);
2671 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2673 uint8_t *buf, int buf_size);
2676 * Encodes an audio frame from \p samples into \p buf.
2677 * The avcodec_encode_audio() function encodes an audio frame from the input
2678 * buffer \p samples. To encode it, it makes use of the audio codec which was
2679 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2680 * stored in output buffer \p buf.
2682 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2684 * @param avctx the codec context
2685 * @param[out] buf the output buffer
2686 * @param[in] buf_size the output buffer size
2687 * @param[in] samples the input buffer containing the samples
2688 * The number of samples read from this buffer is frame_size*channels,
2689 * both of which are defined in \p avctx.
2690 * @return On error a negative value is returned, on success zero or the number
2691 * of bytes used to encode the data read from the input buffer.
2693 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2694 const short *samples);
2697 * Encodes a video frame from \p pict into \p buf.
2698 * The avcodec_encode_video() function encodes a video frame from the input
2699 * \p pict. To encode it, it makes use of the video codec which was coupled with
2700 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2701 * frame are stored in the output buffer \p buf. The input picture should be
2702 * stored using a specific format, namely \c avctx.pix_fmt.
2704 * @param avctx the codec context
2705 * @param[out] buf the output buffer for the bitstream of encoded frame
2706 * @param[in] buf_size the size of the output buffer in bytes
2707 * @param[in] pict the input picture to encode
2708 * @return On error a negative value is returned, on success zero or the number
2709 * of bytes used from the input buffer.
2711 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2712 const AVFrame *pict);
2713 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2714 const AVSubtitle *sub);
2716 int avcodec_close(AVCodecContext *avctx);
2718 void avcodec_register_all(void);
2721 * Flush buffers, should be called when seeking or when switching to a different stream.
2723 void avcodec_flush_buffers(AVCodecContext *avctx);
2725 void avcodec_default_free_buffers(AVCodecContext *s);
2727 /* misc useful functions */
2730 * Returns a single letter to describe the given picture type \p pict_type.
2732 * @param[in] pict_type the picture type
2733 * @return A single character representing the picture type.
2735 char av_get_pict_type_char(int pict_type);
2738 * Returns codec bits per sample.
2740 * @param[in] codec_id the codec
2741 * @return Number of bits per sample or zero if unknown for the given codec.
2743 int av_get_bits_per_sample(enum CodecID codec_id);
2746 * Returns sample format bits per sample.
2748 * @param[in] sample_fmt the sample format
2749 * @return Number of bits per sample or zero if unknown for the given sample format.
2751 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2754 typedef struct AVCodecParserContext {
2756 struct AVCodecParser *parser;
2757 int64_t frame_offset; /* offset of the current frame */
2758 int64_t cur_offset; /* current offset
2759 (incremented by each av_parser_parse()) */
2760 int64_t last_frame_offset; /* offset of the last frame */
2762 int pict_type; /* XXX: Put it back in AVCodecContext. */
2763 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2764 int64_t pts; /* pts of the current frame */
2765 int64_t dts; /* dts of the current frame */
2770 int fetch_timestamp;
2772 #define AV_PARSER_PTS_NB 4
2773 int cur_frame_start_index;
2774 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2775 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2776 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2779 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2781 int64_t offset; ///< byte offset from starting packet start
2782 int64_t last_offset;
2783 } AVCodecParserContext;
2785 typedef struct AVCodecParser {
2786 int codec_ids[5]; /* several codec IDs are permitted */
2788 int (*parser_init)(AVCodecParserContext *s);
2789 int (*parser_parse)(AVCodecParserContext *s,
2790 AVCodecContext *avctx,
2791 const uint8_t **poutbuf, int *poutbuf_size,
2792 const uint8_t *buf, int buf_size);
2793 void (*parser_close)(AVCodecParserContext *s);
2794 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2795 struct AVCodecParser *next;
2798 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2799 extern AVCodecParser *av_first_parser;
2801 AVCodecParser *av_parser_next(AVCodecParser *c);
2803 void av_register_codec_parser(AVCodecParser *parser);
2804 AVCodecParserContext *av_parser_init(int codec_id);
2805 int av_parser_parse(AVCodecParserContext *s,
2806 AVCodecContext *avctx,
2807 uint8_t **poutbuf, int *poutbuf_size,
2808 const uint8_t *buf, int buf_size,
2809 int64_t pts, int64_t dts);
2810 int av_parser_change(AVCodecParserContext *s,
2811 AVCodecContext *avctx,
2812 uint8_t **poutbuf, int *poutbuf_size,
2813 const uint8_t *buf, int buf_size, int keyframe);
2814 void av_parser_close(AVCodecParserContext *s);
2817 typedef struct AVBitStreamFilterContext {
2819 struct AVBitStreamFilter *filter;
2820 AVCodecParserContext *parser;
2821 struct AVBitStreamFilterContext *next;
2822 } AVBitStreamFilterContext;
2825 typedef struct AVBitStreamFilter {
2828 int (*filter)(AVBitStreamFilterContext *bsfc,
2829 AVCodecContext *avctx, const char *args,
2830 uint8_t **poutbuf, int *poutbuf_size,
2831 const uint8_t *buf, int buf_size, int keyframe);
2832 void (*close)(AVBitStreamFilterContext *bsfc);
2833 struct AVBitStreamFilter *next;
2834 } AVBitStreamFilter;
2836 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2837 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2838 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2839 AVCodecContext *avctx, const char *args,
2840 uint8_t **poutbuf, int *poutbuf_size,
2841 const uint8_t *buf, int buf_size, int keyframe);
2842 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2844 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2849 * Reallocates the given block if it is not large enough, otherwise it
2854 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2856 /* for static data only */
2859 * Frees all static arrays and resets their pointers to 0.
2860 * Call this function to release all statically allocated tables.
2862 * @deprecated. Code which uses av_free_static is broken/misdesigned
2863 * and should correctly use static arrays
2866 attribute_deprecated void av_free_static(void);
2869 * Allocation of static arrays.
2871 * @warning Do not use for normal allocation.
2873 * @param[in] size The amount of memory you need in bytes.
2874 * @return block of memory of the requested size
2875 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2876 * and should correctly use static arrays
2878 attribute_deprecated void *av_mallocz_static(unsigned int size);
2881 * Copy image 'src' to 'dst'.
2883 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2884 int pix_fmt, int width, int height);
2887 * Crop image top and left side.
2889 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2890 int pix_fmt, int top_band, int left_band);
2895 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2896 int padtop, int padbottom, int padleft, int padright, int *color);
2898 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2900 * @deprecated Use the software scaler (swscale) instead.
2902 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2903 int pix_fmt, int width, int height);
2906 * @deprecated Use the software scaler (swscale) instead.
2908 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2909 int pix_fmt, int top_band, int left_band);
2912 * @deprecated Use the software scaler (swscale) instead.
2914 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2915 int padtop, int padbottom, int padleft, int padright, int *color);
2918 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2921 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2923 * @return 0 in case of a successful parsing, a negative value otherwise
2924 * @param[in] str the string to parse: it has to be a string in the format
2925 * <width>x<height> or a valid video frame size abbreviation.
2926 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2928 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2929 * frame height value
2931 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2934 * Parses \p str and put in \p frame_rate the detected values.
2936 * @return 0 in case of a successful parsing, a negative value otherwise
2937 * @param[in] str the string to parse: it has to be a string in the format
2938 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2939 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2942 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2944 /* error handling */
2946 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2947 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2949 /* Some platforms have E* and errno already negated. */
2950 #define AVERROR(e) (e)
2951 #define AVUNERROR(e) (e)
2953 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2954 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2955 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2956 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2957 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2958 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2959 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2960 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2961 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2963 #endif /* FFMPEG_AVCODEC_H */