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,
174 /* various PCM "codecs" */
175 CODEC_ID_PCM_S16LE= 0x10000,
191 CODEC_ID_PCM_S24DAUD,
193 CODEC_ID_PCM_S16LE_PLANAR,
195 /* various ADPCM codecs */
196 CODEC_ID_ADPCM_IMA_QT= 0x11000,
197 CODEC_ID_ADPCM_IMA_WAV,
198 CODEC_ID_ADPCM_IMA_DK3,
199 CODEC_ID_ADPCM_IMA_DK4,
200 CODEC_ID_ADPCM_IMA_WS,
201 CODEC_ID_ADPCM_IMA_SMJPEG,
210 CODEC_ID_ADPCM_YAMAHA,
211 CODEC_ID_ADPCM_SBPRO_4,
212 CODEC_ID_ADPCM_SBPRO_3,
213 CODEC_ID_ADPCM_SBPRO_2,
215 CODEC_ID_ADPCM_IMA_AMV,
216 CODEC_ID_ADPCM_EA_R1,
217 CODEC_ID_ADPCM_EA_R3,
218 CODEC_ID_ADPCM_EA_R2,
219 CODEC_ID_ADPCM_IMA_EA_SEAD,
220 CODEC_ID_ADPCM_IMA_EA_EACS,
221 CODEC_ID_ADPCM_EA_XAS,
224 CODEC_ID_AMR_NB= 0x12000,
227 /* RealAudio codecs*/
228 CODEC_ID_RA_144= 0x13000,
231 /* various DPCM codecs */
232 CODEC_ID_ROQ_DPCM= 0x14000,
233 CODEC_ID_INTERPLAY_DPCM,
237 CODEC_ID_MP2= 0x15000,
238 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
240 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
259 CODEC_ID_WESTWOOD_SND1,
260 CODEC_ID_GSM, ///< as in Berlin toast format
268 CODEC_ID_DSICINAUDIO,
272 CODEC_ID_GSM_MS, /* as found in WAV */
279 /* subtitle codecs */
280 CODEC_ID_DVD_SUBTITLE= 0x17000,
281 CODEC_ID_DVB_SUBTITLE,
282 CODEC_ID_TEXT, ///< raw UTF-8 text
285 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
286 * stream (only used by libavformat) */
289 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
290 /* CODEC_ID_MP3LAME is obsolete */
291 #define CODEC_ID_MP3LAME CODEC_ID_MP3
292 #define CODEC_ID_MPEG4AAC CODEC_ID_AAC
296 CODEC_TYPE_UNKNOWN = -1,
305 * Currently unused, may be used if 24/32 bits samples are ever supported.
306 * all in native-endian format
309 SAMPLE_FMT_NONE = -1,
310 SAMPLE_FMT_U8, ///< unsigned 8 bits
311 SAMPLE_FMT_S16, ///< signed 16 bits
312 SAMPLE_FMT_S24, ///< signed 24 bits
313 SAMPLE_FMT_S32, ///< signed 32 bits
314 SAMPLE_FMT_FLT, ///< float
318 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
321 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
322 * This is mainly needed because some optimized bitstream readers read
323 * 32 or 64 bit at once and could read over the end.<br>
324 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
325 * MPEG bitstreams could cause overread and segfault.
327 #define FF_INPUT_BUFFER_PADDING_SIZE 8
330 * minimum encoding buffer size
331 * Used to avoid some checks during header writing.
333 #define FF_MIN_BUFFER_SIZE 16384
336 * motion estimation type.
339 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
343 ME_EPZS, ///< enhanced predictive zonal search
344 ME_X1, ///< reserved for experiments
345 ME_HEX, ///< hexagon based search
346 ME_UMH, ///< uneven multi-hexagon search
347 ME_ITER, ///< iterative search
351 /* We leave some space between them for extensions (drop some
352 * keyframes for intra-only or drop just some bidir frames). */
353 AVDISCARD_NONE =-16, ///< discard nothing
354 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
355 AVDISCARD_NONREF = 8, ///< discard all non reference
356 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
357 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
358 AVDISCARD_ALL = 48, ///< discard all
361 typedef struct RcOverride{
364 int qscale; // If this is 0 then quality_factor will be used instead.
365 float quality_factor;
368 #define FF_MAX_B_FRAMES 16
371 These flags can be passed in AVCodecContext.flags before initialization.
372 Note: Not everything is supported yet.
375 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
376 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
377 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
378 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
379 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
380 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
382 * The parent program guarantees that the input for B-frames containing
383 * streams is not written to for at least s->max_b_frames+1 frames, if
384 * this is not set the input will be copied.
386 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
387 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
388 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
389 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
390 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
391 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
392 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
393 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
394 location instead of only at frame boundaries. */
395 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
396 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
397 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
398 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
399 #define CODEC_FLAG_TRELLIS_QUANT 0x00200000 ///< Use trellis quantization.
400 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
401 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
402 /* Fx : Flag for h263+ extra options */
403 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
404 #define CODEC_FLAG_H263P_AIC 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction (remove this)
406 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
407 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
408 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
409 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
410 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
411 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
412 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
413 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
414 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
415 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
416 #define CODEC_FLAG_CLOSED_GOP ((int)0x80000000)
417 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
418 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
419 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
420 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
421 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
422 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
423 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
424 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
425 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
426 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
427 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
428 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
429 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
430 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
431 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
432 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
433 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
435 /* Unsupported options :
436 * Syntax Arithmetic coding (SAC)
437 * Reference Picture Selection
438 * Independent Segment Decoding */
440 /* codec capabilities */
442 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
444 * Codec uses get_buffer() for allocating buffers.
445 * direct rendering method 1
447 #define CODEC_CAP_DR1 0x0002
448 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
449 #define CODEC_CAP_PARSE_ONLY 0x0004
450 #define CODEC_CAP_TRUNCATED 0x0008
451 /* Codec can export data for HW decoding (XvMC). */
452 #define CODEC_CAP_HWACCEL 0x0010
454 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
455 * If this is not set, the codec is guaranteed to never be fed with NULL data.
457 #define CODEC_CAP_DELAY 0x0020
459 * Codec can be fed a final frame with a smaller size.
460 * This can be used to prevent truncation of the last audio samples.
462 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
464 //The following defines may change, don't expect compatibility if you use them.
465 #define MB_TYPE_INTRA4x4 0x0001
466 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
467 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
468 #define MB_TYPE_16x16 0x0008
469 #define MB_TYPE_16x8 0x0010
470 #define MB_TYPE_8x16 0x0020
471 #define MB_TYPE_8x8 0x0040
472 #define MB_TYPE_INTERLACED 0x0080
473 #define MB_TYPE_DIRECT2 0x0100 //FIXME
474 #define MB_TYPE_ACPRED 0x0200
475 #define MB_TYPE_GMC 0x0400
476 #define MB_TYPE_SKIP 0x0800
477 #define MB_TYPE_P0L0 0x1000
478 #define MB_TYPE_P1L0 0x2000
479 #define MB_TYPE_P0L1 0x4000
480 #define MB_TYPE_P1L1 0x8000
481 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
482 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
483 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
484 #define MB_TYPE_QUANT 0x00010000
485 #define MB_TYPE_CBP 0x00020000
486 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
490 * This specifies the area which should be displayed.
491 * Note there may be multiple such areas for one frame.
493 typedef struct AVPanScan{
496 * - encoding: Set by user.
497 * - decoding: Set by libavcodec.
502 * width and height in 1/16 pel
503 * - encoding: Set by user.
504 * - decoding: Set by libavcodec.
510 * position of the top left corner in 1/16 pel for up to 3 fields/frames
511 * - encoding: Set by user.
512 * - decoding: Set by libavcodec.
514 int16_t position[3][2];
517 #define FF_COMMON_FRAME \
519 * pointer to the picture planes.\
520 * This might be different from the first allocated byte\
527 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
528 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
534 * 1 -> keyframe, 0-> not\
535 * - encoding: Set by libavcodec.\
536 * - decoding: Set by libavcodec.\
541 * Picture type of the frame, see ?_TYPE below.\
542 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
543 * - decoding: Set by libavcodec.\
548 * presentation timestamp in time_base units (time when frame should be shown to user)\
549 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
550 * - encoding: MUST be set by user.\
551 * - decoding: Set by libavcodec.\
556 * picture number in bitstream order\
557 * - encoding: set by\
558 * - decoding: Set by libavcodec.\
560 int coded_picture_number;\
562 * picture number in display order\
563 * - encoding: set by\
564 * - decoding: Set by libavcodec.\
566 int display_picture_number;\
569 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
570 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
571 * - decoding: Set by libavcodec.\
576 * buffer age (1->was last buffer and dint change, 2->..., ...).\
577 * Set to INT_MAX if the buffer has not been used yet.\
578 * - encoding: unused\
579 * - decoding: MUST be set by get_buffer().\
584 * is this picture used as reference\
585 * - encoding: unused\
586 * - decoding: Set by libavcodec. (before get_buffer() call)).\
592 * - encoding: unused\
593 * - decoding: Set by libavcodec.\
595 int8_t *qscale_table;\
598 * - encoding: unused\
599 * - decoding: Set by libavcodec.\
604 * mbskip_table[mb]>=1 if MB didn't change\
605 * stride= mb_width = (width+15)>>4\
606 * - encoding: unused\
607 * - decoding: Set by libavcodec.\
609 uint8_t *mbskip_table;\
612 * motion vector table\
615 * int mv_sample_log2= 4 - motion_subsample_log2;\
616 * int mb_width= (width+15)>>4;\
617 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
618 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
620 * - encoding: Set by user.\
621 * - decoding: Set by libavcodec.\
623 int16_t (*motion_val[2])[2];\
626 * macroblock type table\
627 * mb_type_base + mb_width + 2\
628 * - encoding: Set by user.\
629 * - decoding: Set by libavcodec.\
634 * log2 of the size of the block which a single vector in motion_val represents: \
635 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
636 * - encoding: unused\
637 * - decoding: Set by libavcodec.\
639 uint8_t motion_subsample_log2;\
642 * for some private data of the user\
643 * - encoding: unused\
644 * - decoding: Set by user.\
650 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
651 * - decoding: unused\
656 * type of the buffer (to keep track of who has to deallocate data[*])\
657 * - encoding: Set by the one who allocates it.\
658 * - decoding: Set by the one who allocates it.\
659 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
664 * When decoding, this signals how much the picture must be delayed.\
665 * extra_delay = repeat_pict / (2*fps)\
666 * - encoding: unused\
667 * - decoding: Set by libavcodec.\
677 * The content of the picture is interlaced.\
678 * - encoding: Set by user.\
679 * - decoding: Set by libavcodec. (default 0)\
681 int interlaced_frame;\
684 * If the content is interlaced, is top field displayed first.\
685 * - encoding: Set by user.\
686 * - decoding: Set by libavcodec.\
688 int top_field_first;\
692 * - encoding: Set by user.\
693 * - decoding: Set by libavcodec.\
695 AVPanScan *pan_scan;\
698 * Tell user application that palette has changed from previous frame.\
699 * - encoding: ??? (no palette-enabled encoder yet)\
700 * - decoding: Set by libavcodec. (default 0).\
702 int palette_has_changed;\
705 * codec suggestion on buffer type if != 0\
706 * - encoding: unused\
707 * - decoding: Set by libavcodec. (before get_buffer() call)).\
713 * - encoding: unused\
714 * - decoding: Set by libavcodec.\
719 * motion referece frame index\
720 * - encoding: Set by user.\
721 * - decoding: Set by libavcodec.\
723 int8_t *ref_index[2];
725 #define FF_QSCALE_TYPE_MPEG1 0
726 #define FF_QSCALE_TYPE_MPEG2 1
727 #define FF_QSCALE_TYPE_H264 2
729 #define FF_BUFFER_TYPE_INTERNAL 1
730 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
731 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
732 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
735 #define FF_I_TYPE 1 // Intra
736 #define FF_P_TYPE 2 // Predicted
737 #define FF_B_TYPE 3 // Bi-dir predicted
738 #define FF_S_TYPE 4 // S(GMC)-VOP MPEG4
742 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
743 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
744 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
745 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
749 * New fields can be added to the end of FF_COMMON_FRAME with minor version
751 * Removal, reordering and changes to existing fields require a major
752 * version bump. No fields should be added into AVFrame before or after
754 * sizeof(AVFrame) must not be used outside libav*.
756 typedef struct AVFrame {
760 #define DEFAULT_FRAME_RATE_BASE 1001000
763 * main external API structure.
764 * New fields can be added to the end with minor version bumps.
765 * Removal, reordering and changes to existing fields require a major
767 * sizeof(AVCodecContext) must not be used outside libav*.
769 typedef struct AVCodecContext {
771 * information on struct for av_log
772 * - set by avcodec_alloc_context
776 * the average bitrate
777 * - encoding: Set by user; unused for constant quantizer encoding.
778 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
783 * number of bits the bitstream is allowed to diverge from the reference.
784 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
785 * - encoding: Set by user; unused for constant quantizer encoding.
788 int bit_rate_tolerance;
792 * - encoding: Set by user.
793 * - decoding: Set by user.
798 * Some codecs need additional format info. It is stored here.
799 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
800 * specific codec MUST set it correctly otherwise stream copy breaks.
801 * In general use of this field by muxers is not recommanded.
802 * - encoding: Set by libavcodec.
803 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
808 * Motion estimation algorithm used for video coding.
809 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
810 * 8 (umh), 9 (iter) [7, 8 are x264 specific, 9 is snow specific]
811 * - encoding: MUST be set by user.
817 * some codecs need / can use extradata like Huffman tables.
818 * mjpeg: Huffman tables
819 * rv10: additional flags
820 * mpeg4: global headers (they can be in the bitstream or here)
821 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
822 * than extradata_size to avoid prolems if it is read with the bitstream reader.
823 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
824 * - encoding: Set/allocated/freed by libavcodec.
825 * - decoding: Set/allocated/freed by user.
831 * This is the fundamental unit of time (in seconds) in terms
832 * of which frame timestamps are represented. For fixed-fps content,
833 * timebase should be 1/framerate and timestamp increments should be
835 * - encoding: MUST be set by user.
836 * - decoding: Set by libavcodec.
838 AVRational time_base;
842 * picture width / height.
843 * - encoding: MUST be set by user.
844 * - decoding: Set by libavcodec.
845 * Note: For compatibility it is possible to set this instead of
846 * coded_width/height before decoding.
850 #define FF_ASPECT_EXTENDED 15
853 * the number of pictures in a group of pictures, or 0 for intra_only
854 * - encoding: Set by user.
860 * Pixel format, see PIX_FMT_xxx.
861 * - encoding: Set by user.
862 * - decoding: Set by libavcodec.
864 enum PixelFormat pix_fmt;
867 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
868 * has to read frames at native frame rate.
869 * - encoding: Set by user.
875 * If non NULL, 'draw_horiz_band' is called by the libavcodec
876 * decoder to draw a horizontal band. It improves cache usage. Not
877 * all codecs can do that. You must check the codec capabilities
880 * - decoding: Set by user.
881 * @param height the height of the slice
882 * @param y the y position of the slice
883 * @param type 1->top field, 2->bottom field, 3->frame
884 * @param offset offset into the AVFrame.data from which the slice should be read
886 void (*draw_horiz_band)(struct AVCodecContext *s,
887 const AVFrame *src, int offset[4],
888 int y, int type, int height);
891 int sample_rate; ///< samples per second
895 * audio sample format
896 * - encoding: Set by user.
897 * - decoding: Set by libavcodec.
899 enum SampleFormat sample_fmt; ///< sample format, currently unused
901 /* The following data should not be initialized. */
903 * Samples per packet, initialized when calling 'init'.
906 int frame_number; ///< audio or video frame number
907 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
910 * Number of frames the decoded output will be delayed relative to
912 * - encoding: Set by libavcodec.
917 /* - encoding parameters */
918 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
919 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
923 * - encoding: Set by user.
930 * - encoding: Set by user.
936 * maximum quantizer difference between frames
937 * - encoding: Set by user.
943 * maximum number of B-frames between non-B-frames
944 * Note: The output will be delayed by max_b_frames+1 relative to the input.
945 * - encoding: Set by user.
951 * qscale factor between IP and B-frames
952 * - encoding: Set by user.
955 float b_quant_factor;
957 /** obsolete FIXME remove */
959 #define FF_RC_STRATEGY_XVID 1
961 int b_frame_strategy;
966 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
967 * @deprecated Deprecated in favor of skip_idct and skip_frame.
971 struct AVCodec *codec;
975 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
976 /* unused, FIXME remove*/
980 int rtp_payload_size; /* The size of the RTP payload: the coder will */
981 /* do its best to deliver a chunk with size */
982 /* below rtp_payload_size, the chunk will start */
983 /* with a start code on some codecs like H.263. */
984 /* This doesn't take account of any particular */
985 /* headers inside the transmitted RTP payload. */
988 /* The RTP callback: This function is called */
989 /* every time the encoder has a packet to send. */
990 /* It depends on the encoder if the data starts */
991 /* with a Start Code (it should). H.263 does. */
992 /* mb_nb contains the number of macroblocks */
993 /* encoded in the RTP payload. */
994 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
996 /* statistics, used for 2-pass encoding */
1007 * number of bits used for the previously encoded frame
1008 * - encoding: Set by libavcodec.
1009 * - decoding: unused
1014 * Private data of the user, can be used to carry app specific stuff.
1015 * - encoding: Set by user.
1016 * - decoding: Set by user.
1020 char codec_name[32];
1021 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1022 enum CodecID codec_id; /* see CODEC_ID_xxx */
1025 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1026 * This is used to work around some encoder bugs.
1027 * A demuxer should set this to what is stored in the field used to identify the codec.
1028 * If there are multiple such fields in a container then the demuxer should choose the one
1029 * which maximizes the information about the used codec.
1030 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1031 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1032 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1034 * - encoding: Set by user, if not then the default based on codec_id will be used.
1035 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1037 unsigned int codec_tag;
1040 * Work around bugs in encoders which sometimes cannot be detected automatically.
1041 * - encoding: Set by user
1042 * - decoding: Set by user
1044 int workaround_bugs;
1045 #define FF_BUG_AUTODETECT 1 ///< autodetection
1046 #define FF_BUG_OLD_MSMPEG4 2
1047 #define FF_BUG_XVID_ILACE 4
1048 #define FF_BUG_UMP4 8
1049 #define FF_BUG_NO_PADDING 16
1050 #define FF_BUG_AMV 32
1051 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1052 #define FF_BUG_QPEL_CHROMA 64
1053 #define FF_BUG_STD_QPEL 128
1054 #define FF_BUG_QPEL_CHROMA2 256
1055 #define FF_BUG_DIRECT_BLOCKSIZE 512
1056 #define FF_BUG_EDGE 1024
1057 #define FF_BUG_HPEL_CHROMA 2048
1058 #define FF_BUG_DC_CLIP 4096
1059 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1060 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1063 * luma single coefficient elimination threshold
1064 * - encoding: Set by user.
1065 * - decoding: unused
1067 int luma_elim_threshold;
1070 * chroma single coeff elimination threshold
1071 * - encoding: Set by user.
1072 * - decoding: unused
1074 int chroma_elim_threshold;
1077 * strictly follow the standard (MPEG4, ...).
1078 * - encoding: Set by user.
1079 * - decoding: unused
1081 int strict_std_compliance;
1082 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1083 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1084 #define FF_COMPLIANCE_NORMAL 0
1085 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1086 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1089 * qscale offset between IP and B-frames
1090 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1091 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1092 * - encoding: Set by user.
1093 * - decoding: unused
1095 float b_quant_offset;
1098 * Error resilience; higher values will detect more errors but may
1099 * misdetect some more or less valid parts as errors.
1100 * - encoding: unused
1101 * - decoding: Set by user.
1103 int error_resilience;
1104 #define FF_ER_CAREFUL 1
1105 #define FF_ER_COMPLIANT 2
1106 #define FF_ER_AGGRESSIVE 3
1107 #define FF_ER_VERY_AGGRESSIVE 4
1110 * Called at the beginning of each frame to get a buffer for it.
1111 * If pic.reference is set then the frame will be read later by libavcodec.
1112 * avcodec_align_dimensions() should be used to find the required width and
1113 * height, as they normally need to be rounded up to the next multiple of 16.
1114 * - encoding: unused
1115 * - decoding: Set by libavcodec., user can override.
1117 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1120 * Called to release buffers which where allocated with get_buffer.
1121 * A released buffer can be reused in get_buffer().
1122 * pic.data[*] must be set to NULL.
1123 * - encoding: unused
1124 * - decoding: Set by libavcodec., user can override.
1126 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1129 * If 1 the stream has a 1 frame delay during decoding.
1130 * - encoding: Set by libavcodec.
1131 * - decoding: Set by libavcodec.
1136 * number of bytes per packet if constant and known or 0
1137 * Used by some WAV based audio codecs.
1141 int parse_only; /* - decoding only: If true, only parsing is done
1142 (function avcodec_parse_frame()). The frame
1143 data is returned. Only MPEG codecs support this now. */
1146 * 0-> h263 quant 1-> mpeg quant
1147 * - encoding: Set by user.
1148 * - decoding: unused
1153 * pass1 encoding statistics output buffer
1154 * - encoding: Set by libavcodec.
1155 * - decoding: unused
1160 * pass2 encoding statistics input buffer
1161 * Concatenated stuff from stats_out of pass1 should be placed here.
1162 * - encoding: Allocated/set/freed by user.
1163 * - decoding: unused
1168 * ratecontrol qmin qmax limiting method
1169 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1170 * - encoding: Set by user.
1171 * - decoding: unused
1179 * ratecontrol override, see RcOverride
1180 * - encoding: Allocated/set/freed by user.
1181 * - decoding: unused
1183 RcOverride *rc_override;
1184 int rc_override_count;
1187 * rate control equation
1188 * - encoding: Set by user
1189 * - decoding: unused
1195 * - encoding: Set by user.
1196 * - decoding: unused
1202 * - encoding: Set by user.
1203 * - decoding: unused
1208 * decoder bitstream buffer size
1209 * - encoding: Set by user.
1210 * - decoding: unused
1213 float rc_buffer_aggressivity;
1216 * qscale factor between P and I-frames
1217 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1218 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1219 * - encoding: Set by user.
1220 * - decoding: unused
1222 float i_quant_factor;
1225 * qscale offset between P and I-frames
1226 * - encoding: Set by user.
1227 * - decoding: unused
1229 float i_quant_offset;
1232 * initial complexity for pass1 ratecontrol
1233 * - encoding: Set by user.
1234 * - decoding: unused
1236 float rc_initial_cplx;
1239 * DCT algorithm, see FF_DCT_* below
1240 * - encoding: Set by user.
1241 * - decoding: unused
1244 #define FF_DCT_AUTO 0
1245 #define FF_DCT_FASTINT 1
1246 #define FF_DCT_INT 2
1247 #define FF_DCT_MMX 3
1248 #define FF_DCT_MLIB 4
1249 #define FF_DCT_ALTIVEC 5
1250 #define FF_DCT_FAAN 6
1253 * luminance masking (0-> disabled)
1254 * - encoding: Set by user.
1255 * - decoding: unused
1260 * temporary complexity masking (0-> disabled)
1261 * - encoding: Set by user.
1262 * - decoding: unused
1264 float temporal_cplx_masking;
1267 * spatial complexity masking (0-> disabled)
1268 * - encoding: Set by user.
1269 * - decoding: unused
1271 float spatial_cplx_masking;
1274 * p block masking (0-> disabled)
1275 * - encoding: Set by user.
1276 * - decoding: unused
1281 * darkness masking (0-> disabled)
1282 * - encoding: Set by user.
1283 * - decoding: unused
1288 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
1289 /* for binary compatibility */
1294 * IDCT algorithm, see FF_IDCT_* below.
1295 * - encoding: Set by user.
1296 * - decoding: Set by user.
1299 #define FF_IDCT_AUTO 0
1300 #define FF_IDCT_INT 1
1301 #define FF_IDCT_SIMPLE 2
1302 #define FF_IDCT_SIMPLEMMX 3
1303 #define FF_IDCT_LIBMPEG2MMX 4
1304 #define FF_IDCT_PS2 5
1305 #define FF_IDCT_MLIB 6
1306 #define FF_IDCT_ARM 7
1307 #define FF_IDCT_ALTIVEC 8
1308 #define FF_IDCT_SH4 9
1309 #define FF_IDCT_SIMPLEARM 10
1310 #define FF_IDCT_H264 11
1311 #define FF_IDCT_VP3 12
1312 #define FF_IDCT_IPP 13
1313 #define FF_IDCT_XVIDMMX 14
1314 #define FF_IDCT_CAVS 15
1315 #define FF_IDCT_SIMPLEARMV5TE 16
1316 #define FF_IDCT_SIMPLEARMV6 17
1317 #define FF_IDCT_SIMPLEVIS 18
1318 #define FF_IDCT_WMV2 19
1322 * - encoding: Set by libavcodec.
1323 * - decoding: Set by user (or 0).
1327 * slice offsets in the frame in bytes
1328 * - encoding: Set/allocated by libavcodec.
1329 * - decoding: Set/allocated by user (or NULL).
1334 * error concealment flags
1335 * - encoding: unused
1336 * - decoding: Set by user.
1338 int error_concealment;
1339 #define FF_EC_GUESS_MVS 1
1340 #define FF_EC_DEBLOCK 2
1343 * dsp_mask could be add used to disable unwanted CPU features
1344 * CPU features (i.e. MMX, SSE. ...)
1346 * With the FORCE flag you may instead enable given CPU features.
1347 * (Dangerous: Usable in case of misdetection, improper usage however will
1348 * result into program crash.)
1351 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1352 /* lower 16 bits - CPU features */
1353 #define FF_MM_MMX 0x0001 ///< standard MMX
1354 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1355 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1356 #define FF_MM_SSE 0x0008 ///< SSE functions
1357 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1358 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1359 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1360 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1361 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1364 * bits per sample/pixel from the demuxer (needed for huffyuv).
1365 * - encoding: Set by libavcodec.
1366 * - decoding: Set by user.
1368 int bits_per_sample;
1371 * prediction method (needed for huffyuv)
1372 * - encoding: Set by user.
1373 * - decoding: unused
1375 int prediction_method;
1376 #define FF_PRED_LEFT 0
1377 #define FF_PRED_PLANE 1
1378 #define FF_PRED_MEDIAN 2
1381 * sample aspect ratio (0 if unknown)
1382 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1383 * - encoding: Set by user.
1384 * - decoding: Set by libavcodec.
1386 AVRational sample_aspect_ratio;
1389 * the picture in the bitstream
1390 * - encoding: Set by libavcodec.
1391 * - decoding: Set by libavcodec.
1393 AVFrame *coded_frame;
1397 * - encoding: Set by user.
1398 * - decoding: Set by user.
1401 #define FF_DEBUG_PICT_INFO 1
1402 #define FF_DEBUG_RC 2
1403 #define FF_DEBUG_BITSTREAM 4
1404 #define FF_DEBUG_MB_TYPE 8
1405 #define FF_DEBUG_QP 16
1406 #define FF_DEBUG_MV 32
1407 #define FF_DEBUG_DCT_COEFF 0x00000040
1408 #define FF_DEBUG_SKIP 0x00000080
1409 #define FF_DEBUG_STARTCODE 0x00000100
1410 #define FF_DEBUG_PTS 0x00000200
1411 #define FF_DEBUG_ER 0x00000400
1412 #define FF_DEBUG_MMCO 0x00000800
1413 #define FF_DEBUG_BUGS 0x00001000
1414 #define FF_DEBUG_VIS_QP 0x00002000
1415 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1419 * - encoding: Set by user.
1420 * - decoding: Set by user.
1423 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1424 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1425 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1429 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1430 * - decoding: unused
1435 * minimum MB quantizer
1436 * - encoding: unused
1437 * - decoding: unused
1442 * maximum MB quantizer
1443 * - encoding: unused
1444 * - decoding: unused
1449 * motion estimation comparison function
1450 * - encoding: Set by user.
1451 * - decoding: unused
1455 * subpixel motion estimation comparison function
1456 * - encoding: Set by user.
1457 * - decoding: unused
1461 * macroblock comparison function (not supported yet)
1462 * - encoding: Set by user.
1463 * - decoding: unused
1467 * interlaced DCT comparison function
1468 * - encoding: Set by user.
1469 * - decoding: unused
1472 #define FF_CMP_SAD 0
1473 #define FF_CMP_SSE 1
1474 #define FF_CMP_SATD 2
1475 #define FF_CMP_DCT 3
1476 #define FF_CMP_PSNR 4
1477 #define FF_CMP_BIT 5
1479 #define FF_CMP_ZERO 7
1480 #define FF_CMP_VSAD 8
1481 #define FF_CMP_VSSE 9
1482 #define FF_CMP_NSSE 10
1483 #define FF_CMP_W53 11
1484 #define FF_CMP_W97 12
1485 #define FF_CMP_DCTMAX 13
1486 #define FF_CMP_DCT264 14
1487 #define FF_CMP_CHROMA 256
1490 * ME diamond size & shape
1491 * - encoding: Set by user.
1492 * - decoding: unused
1497 * amount of previous MV predictors (2a+1 x 2a+1 square)
1498 * - encoding: Set by user.
1499 * - decoding: unused
1501 int last_predictor_count;
1504 * prepass for motion estimation
1505 * - encoding: Set by user.
1506 * - decoding: unused
1511 * motion estimation prepass comparison function
1512 * - encoding: Set by user.
1513 * - decoding: unused
1518 * ME prepass diamond size & shape
1519 * - encoding: Set by user.
1520 * - decoding: unused
1526 * - encoding: Set by user.
1527 * - decoding: unused
1529 int me_subpel_quality;
1532 * callback to negotiate the pixelFormat
1533 * @param fmt is the list of formats which are supported by the codec,
1534 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1535 * The first is always the native one.
1536 * @return the chosen format
1537 * - encoding: unused
1538 * - decoding: Set by user, if not set the native format will be chosen.
1540 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1543 * DTG active format information (additional aspect ratio
1544 * information only used in DVB MPEG-2 transport streams)
1547 * - encoding: unused
1548 * - decoding: Set by decoder.
1550 int dtg_active_format;
1551 #define FF_DTG_AFD_SAME 8
1552 #define FF_DTG_AFD_4_3 9
1553 #define FF_DTG_AFD_16_9 10
1554 #define FF_DTG_AFD_14_9 11
1555 #define FF_DTG_AFD_4_3_SP_14_9 13
1556 #define FF_DTG_AFD_16_9_SP_14_9 14
1557 #define FF_DTG_AFD_SP_4_3 15
1560 * maximum motion estimation search range in subpel units
1561 * If 0 then no limit.
1563 * - encoding: Set by user.
1564 * - decoding: unused
1569 * intra quantizer bias
1570 * - encoding: Set by user.
1571 * - decoding: unused
1573 int intra_quant_bias;
1574 #define FF_DEFAULT_QUANT_BIAS 999999
1577 * inter quantizer bias
1578 * - encoding: Set by user.
1579 * - decoding: unused
1581 int inter_quant_bias;
1585 * - encoding: unused
1586 * - decoding: Which clrtable should be used for 8bit RGB images.
1587 * Tables have to be stored somewhere. FIXME
1592 * internal_buffer count
1593 * Don't touch, used by libavcodec default_get_buffer().
1595 int internal_buffer_count;
1599 * Don't touch, used by libavcodec default_get_buffer().
1601 void *internal_buffer;
1603 #define FF_LAMBDA_SHIFT 7
1604 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1605 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1606 #define FF_LAMBDA_MAX (256*128-1)
1608 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1610 * Global quality for codecs which cannot change it per frame.
1611 * This should be proportional to MPEG-1/2/4 qscale.
1612 * - encoding: Set by user.
1613 * - decoding: unused
1617 #define FF_CODER_TYPE_VLC 0
1618 #define FF_CODER_TYPE_AC 1
1619 #define FF_CODER_TYPE_RAW 2
1620 #define FF_CODER_TYPE_RLE 3
1621 #define FF_CODER_TYPE_DEFLATE 4
1624 * - encoding: Set by user.
1625 * - decoding: unused
1631 * - encoding: Set by user.
1632 * - decoding: unused
1638 * - encoding: unused
1639 * - decoding: Set by user.
1641 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1646 * - encoding: unused
1647 * - decoding: Set by user.
1650 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1651 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1652 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1655 * XVideo Motion Acceleration
1656 * - encoding: forbidden
1657 * - decoding: set by decoder
1659 int xvmc_acceleration;
1662 * macroblock decision mode
1663 * - encoding: Set by user.
1664 * - decoding: unused
1667 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1668 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1669 #define FF_MB_DECISION_RD 2 ///< rate distoration
1672 * custom intra quantization matrix
1673 * - encoding: Set by user, can be NULL.
1674 * - decoding: Set by libavcodec.
1676 uint16_t *intra_matrix;
1679 * custom inter quantization matrix
1680 * - encoding: Set by user, can be NULL.
1681 * - decoding: Set by libavcodec.
1683 uint16_t *inter_matrix;
1686 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1687 * This is used to work around some encoder bugs.
1688 * - encoding: unused
1689 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1691 unsigned int stream_codec_tag;
1694 * scene change detection threshold
1695 * 0 is default, larger means fewer detected scene changes.
1696 * - encoding: Set by user.
1697 * - decoding: unused
1699 int scenechange_threshold;
1702 * minimum Lagrange multipler
1703 * - encoding: Set by user.
1704 * - decoding: unused
1709 * maximum Lagrange multipler
1710 * - encoding: Set by user.
1711 * - decoding: unused
1716 * palette control structure
1717 * - encoding: ??? (no palette-enabled encoder yet)
1718 * - decoding: Set by user.
1720 struct AVPaletteControl *palctrl;
1723 * noise reduction strength
1724 * - encoding: Set by user.
1725 * - decoding: unused
1727 int noise_reduction;
1730 * Called at the beginning of a frame to get cr buffer for it.
1731 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1732 * libavcodec will pass previous buffer in pic, function should return
1733 * same buffer or new buffer with old frame "painted" into it.
1734 * If pic.data[0] == NULL must behave like get_buffer().
1735 * - encoding: unused
1736 * - decoding: Set by libavcodec., user can override
1738 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1741 * Number of bits which should be loaded into the rc buffer before decoding starts.
1742 * - encoding: Set by user.
1743 * - decoding: unused
1745 int rc_initial_buffer_occupancy;
1749 * - encoding: Set by user.
1750 * - decoding: unused
1752 int inter_threshold;
1756 * - encoding: Set by user.
1757 * - decoding: Set by user.
1762 * Simulates errors in the bitstream to test error concealment.
1763 * - encoding: Set by user.
1764 * - decoding: unused
1769 * MP3 antialias algorithm, see FF_AA_* below.
1770 * - encoding: unused
1771 * - decoding: Set by user.
1774 #define FF_AA_AUTO 0
1775 #define FF_AA_FASTINT 1 //not implemented yet
1777 #define FF_AA_FLOAT 3
1779 * quantizer noise shaping
1780 * - encoding: Set by user.
1781 * - decoding: unused
1783 int quantizer_noise_shaping;
1787 * is used to decide how many independent tasks should be passed to execute()
1788 * - encoding: Set by user.
1789 * - decoding: Set by user.
1794 * The codec may call this to execute several independent things.
1795 * It will return only after finishing all tasks.
1796 * The user may replace this with some multithreaded implementation,
1797 * the default implementation will execute the parts serially.
1798 * @param count the number of things to execute
1799 * - encoding: Set by libavcodec, user can override.
1800 * - decoding: Set by libavcodec, user can override.
1802 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1806 * Can be used by execute() to store some per AVCodecContext stuff.
1807 * - encoding: set by execute()
1808 * - decoding: set by execute()
1810 void *thread_opaque;
1813 * Motion estimation threshold below which no motion estimation is
1814 * performed, but instead the user specified motion vectors are used.
1816 * - encoding: Set by user.
1817 * - decoding: unused
1822 * Macroblock threshold below which the user specified macroblock types will be used.
1823 * - encoding: Set by user.
1824 * - decoding: unused
1829 * precision of the intra DC coefficient - 8
1830 * - encoding: Set by user.
1831 * - decoding: unused
1833 int intra_dc_precision;
1836 * noise vs. sse weight for the nsse comparsion function
1837 * - encoding: Set by user.
1838 * - decoding: unused
1843 * Number of macroblock rows at the top which are skipped.
1844 * - encoding: unused
1845 * - decoding: Set by user.
1850 * Number of macroblock rows at the bottom which are skipped.
1851 * - encoding: unused
1852 * - decoding: Set by user.
1858 * - encoding: Set by user.
1859 * - decoding: Set by libavcodec.
1862 #define FF_PROFILE_UNKNOWN -99
1863 #define FF_PROFILE_AAC_MAIN 0
1864 #define FF_PROFILE_AAC_LOW 1
1865 #define FF_PROFILE_AAC_SSR 2
1866 #define FF_PROFILE_AAC_LTP 3
1870 * - encoding: Set by user.
1871 * - decoding: Set by libavcodec.
1874 #define FF_LEVEL_UNKNOWN -99
1877 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1878 * - encoding: unused
1879 * - decoding: Set by user.
1884 * Bitstream width / height, may be different from width/height if lowres
1885 * or other things are used.
1886 * - encoding: unused
1887 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1889 int coded_width, coded_height;
1892 * frame skip threshold
1893 * - encoding: Set by user.
1894 * - decoding: unused
1896 int frame_skip_threshold;
1900 * - encoding: Set by user.
1901 * - decoding: unused
1903 int frame_skip_factor;
1906 * frame skip exponent
1907 * - encoding: Set by user.
1908 * - decoding: unused
1913 * frame skip comparison function
1914 * - encoding: Set by user.
1915 * - decoding: unused
1920 * Border processing masking, raises the quantizer for mbs on the borders
1922 * - encoding: Set by user.
1923 * - decoding: unused
1925 float border_masking;
1928 * minimum MB lagrange multipler
1929 * - encoding: Set by user.
1930 * - decoding: unused
1935 * maximum MB lagrange multipler
1936 * - encoding: Set by user.
1937 * - decoding: unused
1943 * - encoding: Set by user.
1944 * - decoding: unused
1946 int me_penalty_compensation;
1950 * - encoding: unused
1951 * - decoding: Set by user.
1953 enum AVDiscard skip_loop_filter;
1957 * - encoding: unused
1958 * - decoding: Set by user.
1960 enum AVDiscard skip_idct;
1964 * - encoding: unused
1965 * - decoding: Set by user.
1967 enum AVDiscard skip_frame;
1971 * - encoding: Set by user.
1972 * - decoding: unused
1978 * - encoding: Set by user.
1979 * - decoding: unused
1984 * constant rate factor - quality-based VBR - values ~correspond to qps
1985 * - encoding: Set by user.
1986 * - decoding: unused
1991 * constant quantization parameter rate control method
1992 * - encoding: Set by user.
1993 * - decoding: unused
1999 * - encoding: Set by user.
2000 * - decoding: unused
2005 * number of reference frames
2006 * - encoding: Set by user.
2007 * - decoding: unused
2012 * chroma qp offset from luma
2013 * - encoding: Set by user.
2014 * - decoding: unused
2019 * Influences how often B-frames are used.
2020 * - encoding: Set by user.
2021 * - decoding: unused
2026 * trellis RD quantization
2027 * - encoding: Set by user.
2028 * - decoding: unused
2033 * Reduce fluctuations in qp (before curve compression).
2034 * - encoding: Set by user.
2035 * - decoding: unused
2037 float complexityblur;
2040 * in-loop deblocking filter alphac0 parameter
2041 * alpha is in the range -6...6
2042 * - encoding: Set by user.
2043 * - decoding: unused
2048 * in-loop deblocking filter beta parameter
2049 * beta is in the range -6...6
2050 * - encoding: Set by user.
2051 * - decoding: unused
2056 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2057 * - encoding: Set by user.
2058 * - decoding: unused
2061 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2062 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2063 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2064 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2065 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2068 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2069 * - encoding: Set by user.
2070 * - decoding: unused
2075 * Audio cutoff bandwidth (0 means "automatic")
2076 * - encoding: Set by user.
2077 * - decoding: unused
2082 * Multiplied by qscale for each frame and added to scene_change_score.
2083 * - encoding: Set by user.
2084 * - decoding: unused
2086 int scenechange_factor;
2090 * Note: Value depends upon the compare function used for fullpel ME.
2091 * - encoding: Set by user.
2092 * - decoding: unused
2097 * Adjusts sensitivity of b_frame_strategy 1.
2098 * - encoding: Set by user.
2099 * - decoding: unused
2104 * - encoding: Set by user.
2105 * - decoding: unused
2107 int compression_level;
2108 #define FF_COMPRESSION_DEFAULT -1
2111 * Sets whether to use LPC mode - used by FLAC encoder.
2112 * - encoding: Set by user.
2113 * - decoding: unused
2118 * LPC coefficient precision - used by FLAC encoder
2119 * - encoding: Set by user.
2120 * - decoding: unused
2122 int lpc_coeff_precision;
2125 * - encoding: Set by user.
2126 * - decoding: unused
2128 int min_prediction_order;
2131 * - encoding: Set by user.
2132 * - decoding: unused
2134 int max_prediction_order;
2137 * search method for selecting prediction order
2138 * - encoding: Set by user.
2139 * - decoding: unused
2141 int prediction_order_method;
2144 * - encoding: Set by user.
2145 * - decoding: unused
2147 int min_partition_order;
2150 * - encoding: Set by user.
2151 * - decoding: unused
2153 int max_partition_order;
2156 * GOP timecode frame start number, in non drop frame format
2157 * - encoding: Set by user.
2158 * - decoding: unused
2160 int64_t timecode_frame_start;
2163 * Decoder should decode to this many channels if it can (0 for default)
2164 * - encoding: unused
2165 * - decoding: Set by user.
2167 int request_channels;
2170 * Percentage of dynamic range compression to be applied by the decoder.
2171 * The default value is 1.0, corresponding to full compression.
2172 * - encoding: unused
2173 * - decoding: Set by user.
2181 typedef struct AVCodec {
2183 * Name of the codec implementation.
2184 * The name is globally unique among encoders and among decoders (but an
2185 * encoder and a decoder can share the same name).
2186 * This is the primary way to find a codec from the user perspective.
2189 enum CodecType type;
2192 int (*init)(AVCodecContext *);
2193 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2194 int (*close)(AVCodecContext *);
2195 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2196 uint8_t *buf, int buf_size);
2198 struct AVCodec *next;
2199 void (*flush)(AVCodecContext *);
2200 const AVRational *supported_framerates; ///array of supported framerates, or NULL if any, array is terminated by {0,0}
2201 const enum PixelFormat *pix_fmts; ///array of supported pixel formats, or NULL if unknown, array is terminanted by -1
2205 * four components are given, that's all.
2206 * the last component is alpha
2208 typedef struct AVPicture {
2210 int linesize[4]; ///< number of bytes per line
2215 * This structure defines a method for communicating palette changes
2216 * between and demuxer and a decoder.
2218 * @deprecated Use AVPacket to send palette changes instead.
2219 * This is totally broken.
2221 #define AVPALETTE_SIZE 1024
2222 #define AVPALETTE_COUNT 256
2223 typedef struct AVPaletteControl {
2225 /* Demuxer sets this to 1 to indicate the palette has changed;
2226 * decoder resets to 0. */
2227 int palette_changed;
2229 /* 4-byte ARGB palette entries, stored in native byte order; note that
2230 * the individual palette components should be on a 8-bit scale; if
2231 * the palette data comes from an IBM VGA native format, the component
2232 * data is probably 6 bits in size and needs to be scaled. */
2233 unsigned int palette[AVPALETTE_COUNT];
2235 } AVPaletteControl attribute_deprecated;
2237 typedef struct AVSubtitleRect {
2244 uint32_t *rgba_palette;
2248 typedef struct AVSubtitle {
2249 uint16_t format; /* 0 = graphics */
2250 uint32_t start_display_time; /* relative to packet pts, in ms */
2251 uint32_t end_display_time; /* relative to packet pts, in ms */
2253 AVSubtitleRect *rects;
2259 struct ReSampleContext;
2260 struct AVResampleContext;
2262 typedef struct ReSampleContext ReSampleContext;
2264 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2265 int output_rate, int input_rate);
2266 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2267 void audio_resample_close(ReSampleContext *s);
2269 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2270 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2271 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2272 void av_resample_close(struct AVResampleContext *c);
2274 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2275 /* YUV420 format is assumed ! */
2278 * @deprecated Use the software scaler (swscale) instead.
2280 typedef struct ImgReSampleContext ImgReSampleContext attribute_deprecated;
2283 * @deprecated Use the software scaler (swscale) instead.
2285 attribute_deprecated ImgReSampleContext *img_resample_init(int output_width, int output_height,
2286 int input_width, int input_height);
2289 * @deprecated Use the software scaler (swscale) instead.
2291 attribute_deprecated ImgReSampleContext *img_resample_full_init(int owidth, int oheight,
2292 int iwidth, int iheight,
2293 int topBand, int bottomBand,
2294 int leftBand, int rightBand,
2295 int padtop, int padbottom,
2296 int padleft, int padright);
2299 * @deprecated Use the software scaler (swscale) instead.
2301 attribute_deprecated void img_resample(struct ImgReSampleContext *s,
2302 AVPicture *output, const AVPicture *input);
2305 * @deprecated Use the software scaler (swscale) instead.
2307 attribute_deprecated void img_resample_close(struct ImgReSampleContext *s);
2312 * Allocate memory for a picture. Call avpicture_free to free it.
2314 * @param picture the picture to be filled in
2315 * @param pix_fmt the format of the picture
2316 * @param width the width of the picture
2317 * @param height the height of the picture
2318 * @return zero if successful, a negative value if not
2320 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2323 * Free a picture previously allocated by avpicture_alloc().
2325 * @param picture the AVPicture to be freed
2327 void avpicture_free(AVPicture *picture);
2330 * Fill in the AVPicture fields.
2331 * The fields of the given AVPicture are filled in by using the 'ptr' address
2332 * which points to the image data buffer. Depending on the specified picture
2333 * format, one or multiple image data pointers and line sizes will be set.
2334 * If a planar format is specified, several pointers will be set pointing to
2335 * the different picture planes and the line sizes of the different planes
2336 * will be stored in the lines_sizes array.
2338 * @param picture AVPicture whose fields are to be filled in
2339 * @param ptr Buffer which will contain or contains the actual image data
2340 * @param pix_fmt The format in which the picture data is stored.
2341 * @param width the width of the image in pixels
2342 * @param height the height of the image in pixels
2343 * @return size of the image data in bytes
2345 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2346 int pix_fmt, int width, int height);
2347 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2348 unsigned char *dest, int dest_size);
2351 * Calculate the size in bytes that a picture of the given width and height
2352 * would occupy if stored in the given picture format.
2354 * @param pix_fmt the given picture format
2355 * @param width the width of the image
2356 * @param height the height of the image
2357 * @return Image data size in bytes
2359 int avpicture_get_size(int pix_fmt, int width, int height);
2360 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2361 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2362 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2363 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2364 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2366 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2367 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2368 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2369 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2370 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2371 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2374 * Computes what kind of losses will occur when converting from one specific
2375 * pixel format to another.
2376 * When converting from one pixel format to another, information loss may occur.
2377 * For example, when converting from RGB24 to GRAY, the color information will
2378 * be lost. Similarly, other losses occur when converting from some formats to
2379 * other formats. These losses can involve loss of chroma, but also loss of
2380 * resolution, loss of color depth, loss due to the color space conversion, loss
2381 * of the alpha bits or loss due to color quantization.
2382 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2383 * which will occur when converting from one pixel format to another.
2385 * @param[in] dst_pix_fmt destination pixel format
2386 * @param[in] src_pix_fmt source pixel format
2387 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2388 * @return Combination of flags informing you what kind of losses will occur.
2390 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2394 * Finds the best pixel format to convert to given a certain source pixel
2395 * format. When converting from one pixel format to another, information loss
2396 * may occur. For example, when converting from RGB24 to GRAY, the color
2397 * information will be lost. Similarly, other losses occur when converting from
2398 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2399 * the given pixel formats should be used to suffer the least amount of loss.
2400 * The pixel formats from which it chooses one, are determined by the
2401 * \p pix_fmt_mask parameter.
2404 * src_pix_fmt = PIX_FMT_YUV420P;
2405 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2406 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2409 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2410 * @param[in] src_pix_fmt source pixel format
2411 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2412 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2413 * @return The best pixel format to convert to or -1 if none was found.
2415 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2416 int has_alpha, int *loss_ptr);
2420 * Print in buf the string corresponding to the pixel format with
2421 * number pix_fmt, or an header if pix_fmt is negative.
2423 * @param[in] buf the buffer where to write the string
2424 * @param[in] buf_size the size of buf
2425 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2426 * a negative value to print the corresponding header.
2427 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2429 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2431 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2432 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2435 * Tell if an image really has transparent alpha values.
2436 * @return ored mask of FF_ALPHA_xxx constants
2438 int img_get_alpha_info(const AVPicture *src,
2439 int pix_fmt, int width, int height);
2441 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2443 * convert among pixel formats
2444 * @deprecated Use the software scaler (swscale) instead.
2446 attribute_deprecated int img_convert(AVPicture *dst, int dst_pix_fmt,
2447 const AVPicture *src, int pix_fmt,
2448 int width, int height);
2451 /* deinterlace a picture */
2452 /* deinterlace - if not supported return -1 */
2453 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2454 int pix_fmt, int width, int height);
2456 /* external high level API */
2458 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2459 extern AVCodec *first_avcodec;
2461 AVCodec *av_codec_next(AVCodec *c);
2463 /* returns LIBAVCODEC_VERSION_INT constant */
2464 unsigned avcodec_version(void);
2465 /* returns LIBAVCODEC_BUILD constant */
2466 unsigned avcodec_build(void);
2469 * Initializes libavcodec.
2471 * @warning This function \e must be called before any other libavcodec
2474 void avcodec_init(void);
2476 void register_avcodec(AVCodec *format);
2479 * Finds a registered encoder with a matching codec ID.
2481 * @param id CodecID of the requested encoder
2482 * @return An encoder if one was found, NULL otherwise.
2484 AVCodec *avcodec_find_encoder(enum CodecID id);
2487 * Finds a registered encoder with the specified name.
2489 * @param name name of the requested encoder
2490 * @return An encoder if one was found, NULL otherwise.
2492 AVCodec *avcodec_find_encoder_by_name(const char *name);
2495 * Finds a registered decoder with a matching codec ID.
2497 * @param id CodecID of the requested decoder
2498 * @return A decoder if one was found, NULL otherwise.
2500 AVCodec *avcodec_find_decoder(enum CodecID id);
2503 * Finds a registered decoder with the specified name.
2505 * @param name name of the requested decoder
2506 * @return A decoder if one was found, NULL otherwise.
2508 AVCodec *avcodec_find_decoder_by_name(const char *name);
2509 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2512 * Sets the fields of the given AVCodecContext to default values.
2514 * @param s The AVCodecContext of which the fields should be set to default values.
2516 void avcodec_get_context_defaults(AVCodecContext *s);
2518 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2519 * we WILL change its arguments and name a few times! */
2520 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2523 * Allocates an AVCodecContext and sets its fields to default values. The
2524 * resulting struct can be deallocated by simply calling av_free().
2526 * @return An AVCodecContext filled with default values or NULL on failure.
2527 * @see avcodec_get_context_defaults
2529 AVCodecContext *avcodec_alloc_context(void);
2531 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2532 * we WILL change its arguments and name a few times! */
2533 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2536 * Sets the fields of the given AVFrame to default values.
2538 * @param pic The AVFrame of which the fields should be set to default values.
2540 void avcodec_get_frame_defaults(AVFrame *pic);
2543 * Allocates an AVFrame and sets its fields to default values. The resulting
2544 * struct can be deallocated by simply calling av_free().
2546 * @return An AVFrame filled with default values or NULL on failure.
2547 * @see avcodec_get_frame_defaults
2549 AVFrame *avcodec_alloc_frame(void);
2551 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2552 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2553 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2554 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2557 * Checks if the given dimension of a picture is valid, meaning that all
2558 * bytes of the picture can be addressed with a signed int.
2560 * @param[in] w Width of the picture.
2561 * @param[in] h Height of the picture.
2562 * @return Zero if valid, a negative value if invalid.
2564 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2565 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2567 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2568 void avcodec_thread_free(AVCodecContext *s);
2569 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2570 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2571 //FIXME func typedef
2574 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2575 * function the context has to be allocated.
2577 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2578 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2579 * retrieving a codec.
2581 * @warning This function is not thread safe!
2584 * avcodec_register_all();
2585 * codec = avcodec_find_decoder(CODEC_ID_H264);
2589 * context = avcodec_alloc_context();
2591 * if (avcodec_open(context, codec) < 0)
2595 * @param avctx The context which will be set up to use the given codec.
2596 * @param codec The codec to use within the context.
2597 * @return zero on success, a negative value on error
2598 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2600 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2603 * @deprecated Use avcodec_decode_audio2() instead.
2605 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2606 int *frame_size_ptr,
2607 uint8_t *buf, int buf_size);
2610 * Decodes an audio frame from \p buf into \p samples.
2611 * The avcodec_decode_audio2() function decodes an audio frame from the input
2612 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2613 * audio codec which was coupled with \p avctx using avcodec_open(). The
2614 * resulting decoded frame is stored in output buffer \p samples. If no frame
2615 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2616 * decompressed frame size in \e bytes.
2618 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2619 * output buffer before calling avcodec_decode_audio2().
2621 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2622 * the actual read bytes because some optimized bitstream readers read 32 or 64
2623 * bits at once and could read over the end.
2625 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2626 * no overreading happens for damaged MPEG streams.
2628 * @note You might have to align the input buffer \p buf and output buffer \p
2629 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2630 * necessary at all, on others it won't work at all if not aligned and on others
2631 * it will work but it will have an impact on performance. In practice, the
2632 * bitstream should have 4 byte alignment at minimum and all sample data should
2633 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2634 * the linesize is not a multiple of 16 then there's no sense in aligning the
2635 * start of the buffer to 16.
2637 * @param avctx the codec context
2638 * @param[out] samples the output buffer
2639 * @param[in,out] frame_size_ptr the output buffer size in bytes
2640 * @param[in] buf the input buffer
2641 * @param[in] buf_size the input buffer size in bytes
2642 * @return On error a negative value is returned, otherwise the number of bytes
2643 * used or zero if no frame could be decompressed.
2645 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2646 int *frame_size_ptr,
2647 uint8_t *buf, int buf_size);
2650 * Decodes a video frame from \p buf into \p picture.
2651 * The avcodec_decode_video() function decodes a video frame from the input
2652 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2653 * video codec which was coupled with \p avctx using avcodec_open(). The
2654 * resulting decoded frame is stored in \p picture.
2656 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2657 * the actual read bytes because some optimized bitstream readers read 32 or 64
2658 * bits at once and could read over the end.
2660 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2661 * no overreading happens for damaged MPEG streams.
2663 * @note You might have to align the input buffer \p buf and output buffer \p
2664 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2665 * necessary at all, on others it won't work at all if not aligned and on others
2666 * it will work but it will have an impact on performance. In practice, the
2667 * bitstream should have 4 byte alignment at minimum and all sample data should
2668 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2669 * the linesize is not a multiple of 16 then there's no sense in aligning the
2670 * start of the buffer to 16.
2672 * @param avctx the codec context
2673 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2674 * @param[in] buf the input buffer
2675 * @param[in] buf_size the size of the input buffer in bytes
2676 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2677 * @return On error a negative value is returned, otherwise the number of bytes
2678 * used or zero if no frame could be decompressed.
2680 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2681 int *got_picture_ptr,
2682 uint8_t *buf, int buf_size);
2684 /* Decode a subtitle message. Return -1 if error, otherwise return the
2685 * number of bytes used. If no subtitle could be decompressed,
2686 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2687 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2689 const uint8_t *buf, int buf_size);
2690 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2692 uint8_t *buf, int buf_size);
2695 * Encodes an audio frame from \p samples into \p buf.
2696 * The avcodec_encode_audio() function encodes an audio frame from the input
2697 * buffer \p samples. To encode it, it makes use of the audio codec which was
2698 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2699 * stored in output buffer \p buf.
2701 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2703 * @param avctx the codec context
2704 * @param[out] buf the output buffer
2705 * @param[in] buf_size the output buffer size
2706 * @param[in] samples the input buffer containing the samples
2707 * The number of samples read from this buffer is frame_size*channels,
2708 * both of which are defined in \p avctx.
2709 * @return On error a negative value is returned, on success zero or the number
2710 * of bytes used to encode the data read from the input buffer.
2712 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2713 const short *samples);
2716 * Encodes a video frame from \p pict into \p buf.
2717 * The avcodec_encode_video() function encodes a video frame from the input
2718 * \p pict. To encode it, it makes use of the video codec which was coupled with
2719 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2720 * frame are stored in the output buffer \p buf. The input picture should be
2721 * stored using a specific format, namely \c avctx.pix_fmt.
2723 * @param avctx the codec context
2724 * @param[out] buf the output buffer for the bitstream of encoded frame
2725 * @param[in] buf_size the size of the output buffer in bytes
2726 * @param[in] pict the input picture to encode
2727 * @return On error a negative value is returned, on success zero or the number
2728 * of bytes used from the input buffer.
2730 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2731 const AVFrame *pict);
2732 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2733 const AVSubtitle *sub);
2735 int avcodec_close(AVCodecContext *avctx);
2737 void avcodec_register_all(void);
2740 * Flush buffers, should be called when seeking or when switching to a different stream.
2742 void avcodec_flush_buffers(AVCodecContext *avctx);
2744 void avcodec_default_free_buffers(AVCodecContext *s);
2746 /* misc useful functions */
2749 * Returns a single letter to describe the given picture type \p pict_type.
2751 * @param[in] pict_type the picture type
2752 * @return A single character representing the picture type.
2754 char av_get_pict_type_char(int pict_type);
2757 * Returns codec bits per sample.
2759 * @param[in] codec_id the codec
2760 * @return Number of bits per sample or zero if unknown for the given codec.
2762 int av_get_bits_per_sample(enum CodecID codec_id);
2765 * Returns sample format bits per sample.
2767 * @param[in] sample_fmt the sample format
2768 * @return Number of bits per sample or zero if unknown for the given sample format.
2770 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2773 typedef struct AVCodecParserContext {
2775 struct AVCodecParser *parser;
2776 int64_t frame_offset; /* offset of the current frame */
2777 int64_t cur_offset; /* current offset
2778 (incremented by each av_parser_parse()) */
2779 int64_t last_frame_offset; /* offset of the last frame */
2781 int pict_type; /* XXX: Put it back in AVCodecContext. */
2782 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2783 int64_t pts; /* pts of the current frame */
2784 int64_t dts; /* dts of the current frame */
2789 int fetch_timestamp;
2791 #define AV_PARSER_PTS_NB 4
2792 int cur_frame_start_index;
2793 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2794 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2795 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2798 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2800 int64_t offset; ///< byte offset from starting packet start
2801 int64_t last_offset;
2802 } AVCodecParserContext;
2804 typedef struct AVCodecParser {
2805 int codec_ids[5]; /* several codec IDs are permitted */
2807 int (*parser_init)(AVCodecParserContext *s);
2808 int (*parser_parse)(AVCodecParserContext *s,
2809 AVCodecContext *avctx,
2810 const uint8_t **poutbuf, int *poutbuf_size,
2811 const uint8_t *buf, int buf_size);
2812 void (*parser_close)(AVCodecParserContext *s);
2813 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2814 struct AVCodecParser *next;
2817 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2818 extern AVCodecParser *av_first_parser;
2820 AVCodecParser *av_parser_next(AVCodecParser *c);
2822 void av_register_codec_parser(AVCodecParser *parser);
2823 AVCodecParserContext *av_parser_init(int codec_id);
2824 int av_parser_parse(AVCodecParserContext *s,
2825 AVCodecContext *avctx,
2826 uint8_t **poutbuf, int *poutbuf_size,
2827 const uint8_t *buf, int buf_size,
2828 int64_t pts, int64_t dts);
2829 int av_parser_change(AVCodecParserContext *s,
2830 AVCodecContext *avctx,
2831 uint8_t **poutbuf, int *poutbuf_size,
2832 const uint8_t *buf, int buf_size, int keyframe);
2833 void av_parser_close(AVCodecParserContext *s);
2836 typedef struct AVBitStreamFilterContext {
2838 struct AVBitStreamFilter *filter;
2839 AVCodecParserContext *parser;
2840 struct AVBitStreamFilterContext *next;
2841 } AVBitStreamFilterContext;
2844 typedef struct AVBitStreamFilter {
2847 int (*filter)(AVBitStreamFilterContext *bsfc,
2848 AVCodecContext *avctx, const char *args,
2849 uint8_t **poutbuf, int *poutbuf_size,
2850 const uint8_t *buf, int buf_size, int keyframe);
2851 void (*close)(AVBitStreamFilterContext *bsfc);
2852 struct AVBitStreamFilter *next;
2853 } AVBitStreamFilter;
2855 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2856 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2857 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2858 AVCodecContext *avctx, const char *args,
2859 uint8_t **poutbuf, int *poutbuf_size,
2860 const uint8_t *buf, int buf_size, int keyframe);
2861 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2863 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2868 * Reallocates the given block if it is not large enough, otherwise it
2873 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2875 /* for static data only */
2878 * Frees all static arrays and resets their pointers to 0.
2879 * Call this function to release all statically allocated tables.
2881 * @deprecated. Code which uses av_free_static is broken/misdesigned
2882 * and should correctly use static arrays
2885 attribute_deprecated void av_free_static(void);
2888 * Allocation of static arrays.
2890 * @warning Do not use for normal allocation.
2892 * @param[in] size The amount of memory you need in bytes.
2893 * @return block of memory of the requested size
2894 * @deprecated. Code which uses av_mallocz_static is broken/misdesigned
2895 * and should correctly use static arrays
2897 attribute_deprecated void *av_mallocz_static(unsigned int size);
2900 * Copy image 'src' to 'dst'.
2902 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2903 int pix_fmt, int width, int height);
2906 * Crop image top and left side.
2908 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2909 int pix_fmt, int top_band, int left_band);
2914 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2915 int padtop, int padbottom, int padleft, int padright, int *color);
2917 #if LIBAVCODEC_VERSION_INT < ((52<<16)+(0<<8)+0)
2919 * @deprecated Use the software scaler (swscale) instead.
2921 attribute_deprecated void img_copy(AVPicture *dst, const AVPicture *src,
2922 int pix_fmt, int width, int height);
2925 * @deprecated Use the software scaler (swscale) instead.
2927 attribute_deprecated int img_crop(AVPicture *dst, const AVPicture *src,
2928 int pix_fmt, int top_band, int left_band);
2931 * @deprecated Use the software scaler (swscale) instead.
2933 attribute_deprecated int img_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2934 int padtop, int padbottom, int padleft, int padright, int *color);
2937 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2940 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2942 * @return 0 in case of a successful parsing, a negative value otherwise
2943 * @param[in] str the string to parse: it has to be a string in the format
2944 * <width>x<height> or a valid video frame size abbreviation.
2945 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2947 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2948 * frame height value
2950 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2953 * Parses \p str and put in \p frame_rate the detected values.
2955 * @return 0 in case of a successful parsing, a negative value otherwise
2956 * @param[in] str the string to parse: it has to be a string in the format
2957 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2958 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2961 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2963 /* error handling */
2965 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2966 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2968 /* Some platforms have E* and errno already negated. */
2969 #define AVERROR(e) (e)
2970 #define AVUNERROR(e) (e)
2972 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2973 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2974 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2975 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2976 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2977 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2978 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2979 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2980 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2982 #endif /* FFMPEG_AVCODEC_H */