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 AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 0
34 #define LIBAVCODEC_VERSION_MICRO 0
36 #define LIBAVCODEC_VERSION_INT AV_VERSION_INT(LIBAVCODEC_VERSION_MAJOR, \
37 LIBAVCODEC_VERSION_MINOR, \
38 LIBAVCODEC_VERSION_MICRO)
39 #define LIBAVCODEC_VERSION AV_VERSION(LIBAVCODEC_VERSION_MAJOR, \
40 LIBAVCODEC_VERSION_MINOR, \
41 LIBAVCODEC_VERSION_MICRO)
42 #define LIBAVCODEC_BUILD LIBAVCODEC_VERSION_INT
44 #define LIBAVCODEC_IDENT "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
46 #define AV_NOPTS_VALUE INT64_C(0x8000000000000000)
47 #define AV_TIME_BASE 1000000
48 #define AV_TIME_BASE_Q (AVRational){1, AV_TIME_BASE}
51 * Identifies the syntax and semantics of the bitstream.
52 * The principle is roughly:
53 * Two decoders with the same ID can decode the same streams.
54 * Two encoders with the same ID can encode compatible streams.
55 * There may be slight deviations from the principle due to implementation
58 * If you add a codec ID to this list, add it so that
59 * 1. no value of a existing codec ID changes (that would break ABI),
60 * 2. it is as close as possible to similar codecs.
67 CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
68 CODEC_ID_MPEG2VIDEO_XVMC,
105 CODEC_ID_INTERPLAY_VIDEO,
117 CODEC_ID_TRUEMOTION1,
145 CODEC_ID_TRUEMOTION2,
162 CODEC_ID_DSICINVIDEO,
163 CODEC_ID_TIERTEXSEQVIDEO,
172 CODEC_ID_BETHSOFTVID,
190 CODEC_ID_MOTIONPIXELS,
193 /* various PCM "codecs" */
194 CODEC_ID_PCM_S16LE= 0x10000,
210 CODEC_ID_PCM_S24DAUD,
212 CODEC_ID_PCM_S16LE_PLANAR,
219 /* various ADPCM codecs */
220 CODEC_ID_ADPCM_IMA_QT= 0x11000,
221 CODEC_ID_ADPCM_IMA_WAV,
222 CODEC_ID_ADPCM_IMA_DK3,
223 CODEC_ID_ADPCM_IMA_DK4,
224 CODEC_ID_ADPCM_IMA_WS,
225 CODEC_ID_ADPCM_IMA_SMJPEG,
234 CODEC_ID_ADPCM_YAMAHA,
235 CODEC_ID_ADPCM_SBPRO_4,
236 CODEC_ID_ADPCM_SBPRO_3,
237 CODEC_ID_ADPCM_SBPRO_2,
239 CODEC_ID_ADPCM_IMA_AMV,
240 CODEC_ID_ADPCM_EA_R1,
241 CODEC_ID_ADPCM_EA_R3,
242 CODEC_ID_ADPCM_EA_R2,
243 CODEC_ID_ADPCM_IMA_EA_SEAD,
244 CODEC_ID_ADPCM_IMA_EA_EACS,
245 CODEC_ID_ADPCM_EA_XAS,
246 CODEC_ID_ADPCM_EA_MAXIS_XA,
249 CODEC_ID_AMR_NB= 0x12000,
252 /* RealAudio codecs*/
253 CODEC_ID_RA_144= 0x13000,
256 /* various DPCM codecs */
257 CODEC_ID_ROQ_DPCM= 0x14000,
258 CODEC_ID_INTERPLAY_DPCM,
263 CODEC_ID_MP2= 0x15000,
264 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
282 CODEC_ID_WESTWOOD_SND1,
283 CODEC_ID_GSM, ///< as in Berlin toast format
291 CODEC_ID_DSICINAUDIO,
295 CODEC_ID_GSM_MS, /* as found in WAV */
304 CODEC_ID_WMALOSSLESS,
308 /* subtitle codecs */
309 CODEC_ID_DVD_SUBTITLE= 0x17000,
310 CODEC_ID_DVB_SUBTITLE,
311 CODEC_ID_TEXT, ///< raw UTF-8 text
316 /* other specific kind of codecs (generally used for attachments) */
317 CODEC_ID_TTF= 0x18000,
319 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
321 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
322 * stream (only used by libavformat) */
326 CODEC_TYPE_UNKNOWN = -1,
331 CODEC_TYPE_ATTACHMENT,
336 * all in native-endian format
339 SAMPLE_FMT_NONE = -1,
340 SAMPLE_FMT_U8, ///< unsigned 8 bits
341 SAMPLE_FMT_S16, ///< signed 16 bits
342 SAMPLE_FMT_S32, ///< signed 32 bits
343 SAMPLE_FMT_FLT, ///< float
344 SAMPLE_FMT_DBL, ///< double
345 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
349 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
352 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
353 * This is mainly needed because some optimized bitstream readers read
354 * 32 or 64 bit at once and could read over the end.<br>
355 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
356 * MPEG bitstreams could cause overread and segfault.
358 #define FF_INPUT_BUFFER_PADDING_SIZE 8
361 * minimum encoding buffer size
362 * Used to avoid some checks during header writing.
364 #define FF_MIN_BUFFER_SIZE 16384
367 * motion estimation type.
370 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
374 ME_EPZS, ///< enhanced predictive zonal search
375 ME_X1, ///< reserved for experiments
376 ME_HEX, ///< hexagon based search
377 ME_UMH, ///< uneven multi-hexagon search
378 ME_ITER, ///< iterative search
379 ME_TESA, ///< transformed exhaustive search algorithm
383 /* We leave some space between them for extensions (drop some
384 * keyframes for intra-only or drop just some bidir frames). */
385 AVDISCARD_NONE =-16, ///< discard nothing
386 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
387 AVDISCARD_NONREF = 8, ///< discard all non reference
388 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
389 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
390 AVDISCARD_ALL = 48, ///< discard all
393 typedef struct RcOverride{
396 int qscale; // If this is 0 then quality_factor will be used instead.
397 float quality_factor;
400 #define FF_MAX_B_FRAMES 16
403 These flags can be passed in AVCodecContext.flags before initialization.
404 Note: Not everything is supported yet.
407 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
408 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
409 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
410 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
411 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
412 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
414 * The parent program guarantees that the input for B-frames containing
415 * streams is not written to for at least s->max_b_frames+1 frames, if
416 * this is not set the input will be copied.
418 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
419 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
420 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
421 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
422 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
423 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
424 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
425 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
426 location instead of only at frame boundaries. */
427 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
428 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
429 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
430 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
431 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
432 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
433 /* Fx : Flag for h263+ extra options */
434 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
435 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
436 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
437 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
438 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
439 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
440 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
441 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
442 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
443 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
444 #define CODEC_FLAG_CLOSED_GOP 0x80000000
445 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
446 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
447 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
448 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
449 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
450 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
451 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
452 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
453 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
454 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
455 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
456 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
457 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
458 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
459 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
460 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
461 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
462 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
464 /* Unsupported options :
465 * Syntax Arithmetic coding (SAC)
466 * Reference Picture Selection
467 * Independent Segment Decoding */
469 /* codec capabilities */
471 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
473 * Codec uses get_buffer() for allocating buffers.
474 * direct rendering method 1
476 #define CODEC_CAP_DR1 0x0002
477 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
478 #define CODEC_CAP_PARSE_ONLY 0x0004
479 #define CODEC_CAP_TRUNCATED 0x0008
480 /* Codec can export data for HW decoding (XvMC). */
481 #define CODEC_CAP_HWACCEL 0x0010
483 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
484 * If this is not set, the codec is guaranteed to never be fed with NULL data.
486 #define CODEC_CAP_DELAY 0x0020
488 * Codec can be fed a final frame with a smaller size.
489 * This can be used to prevent truncation of the last audio samples.
491 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
493 //The following defines may change, don't expect compatibility if you use them.
494 #define MB_TYPE_INTRA4x4 0x0001
495 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
496 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
497 #define MB_TYPE_16x16 0x0008
498 #define MB_TYPE_16x8 0x0010
499 #define MB_TYPE_8x16 0x0020
500 #define MB_TYPE_8x8 0x0040
501 #define MB_TYPE_INTERLACED 0x0080
502 #define MB_TYPE_DIRECT2 0x0100 //FIXME
503 #define MB_TYPE_ACPRED 0x0200
504 #define MB_TYPE_GMC 0x0400
505 #define MB_TYPE_SKIP 0x0800
506 #define MB_TYPE_P0L0 0x1000
507 #define MB_TYPE_P1L0 0x2000
508 #define MB_TYPE_P0L1 0x4000
509 #define MB_TYPE_P1L1 0x8000
510 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
511 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
512 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
513 #define MB_TYPE_QUANT 0x00010000
514 #define MB_TYPE_CBP 0x00020000
515 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
519 * This specifies the area which should be displayed.
520 * Note there may be multiple such areas for one frame.
522 typedef struct AVPanScan{
525 * - encoding: Set by user.
526 * - decoding: Set by libavcodec.
531 * width and height in 1/16 pel
532 * - encoding: Set by user.
533 * - decoding: Set by libavcodec.
539 * position of the top left corner in 1/16 pel for up to 3 fields/frames
540 * - encoding: Set by user.
541 * - decoding: Set by libavcodec.
543 int16_t position[3][2];
546 #define FF_COMMON_FRAME \
548 * pointer to the picture planes.\
549 * This might be different from the first allocated byte\
556 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
557 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
563 * 1 -> keyframe, 0-> not\
564 * - encoding: Set by libavcodec.\
565 * - decoding: Set by libavcodec.\
570 * Picture type of the frame, see ?_TYPE below.\
571 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
572 * - decoding: Set by libavcodec.\
577 * presentation timestamp in time_base units (time when frame should be shown to user)\
578 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
579 * - encoding: MUST be set by user.\
580 * - decoding: Set by libavcodec.\
585 * picture number in bitstream order\
586 * - encoding: set by\
587 * - decoding: Set by libavcodec.\
589 int coded_picture_number;\
591 * picture number in display order\
592 * - encoding: set by\
593 * - decoding: Set by libavcodec.\
595 int display_picture_number;\
598 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
599 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
600 * - decoding: Set by libavcodec.\
605 * buffer age (1->was last buffer and dint change, 2->..., ...).\
606 * Set to INT_MAX if the buffer has not been used yet.\
607 * - encoding: unused\
608 * - decoding: MUST be set by get_buffer().\
613 * is this picture used as reference\
614 * The values for this are the same as the MpegEncContext.picture_structure\
615 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
616 * - encoding: unused\
617 * - decoding: Set by libavcodec. (before get_buffer() call)).\
623 * - encoding: unused\
624 * - decoding: Set by libavcodec.\
626 int8_t *qscale_table;\
629 * - encoding: unused\
630 * - decoding: Set by libavcodec.\
635 * mbskip_table[mb]>=1 if MB didn't change\
636 * stride= mb_width = (width+15)>>4\
637 * - encoding: unused\
638 * - decoding: Set by libavcodec.\
640 uint8_t *mbskip_table;\
643 * motion vector table\
646 * int mv_sample_log2= 4 - motion_subsample_log2;\
647 * int mb_width= (width+15)>>4;\
648 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
649 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
651 * - encoding: Set by user.\
652 * - decoding: Set by libavcodec.\
654 int16_t (*motion_val[2])[2];\
657 * macroblock type table\
658 * mb_type_base + mb_width + 2\
659 * - encoding: Set by user.\
660 * - decoding: Set by libavcodec.\
665 * log2 of the size of the block which a single vector in motion_val represents: \
666 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
667 * - encoding: unused\
668 * - decoding: Set by libavcodec.\
670 uint8_t motion_subsample_log2;\
673 * for some private data of the user\
674 * - encoding: unused\
675 * - decoding: Set by user.\
681 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
682 * - decoding: unused\
687 * type of the buffer (to keep track of who has to deallocate data[*])\
688 * - encoding: Set by the one who allocates it.\
689 * - decoding: Set by the one who allocates it.\
690 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
695 * When decoding, this signals how much the picture must be delayed.\
696 * extra_delay = repeat_pict / (2*fps)\
697 * - encoding: unused\
698 * - decoding: Set by libavcodec.\
708 * The content of the picture is interlaced.\
709 * - encoding: Set by user.\
710 * - decoding: Set by libavcodec. (default 0)\
712 int interlaced_frame;\
715 * If the content is interlaced, is top field displayed first.\
716 * - encoding: Set by user.\
717 * - decoding: Set by libavcodec.\
719 int top_field_first;\
723 * - encoding: Set by user.\
724 * - decoding: Set by libavcodec.\
726 AVPanScan *pan_scan;\
729 * Tell user application that palette has changed from previous frame.\
730 * - encoding: ??? (no palette-enabled encoder yet)\
731 * - decoding: Set by libavcodec. (default 0).\
733 int palette_has_changed;\
736 * codec suggestion on buffer type if != 0\
737 * - encoding: unused\
738 * - decoding: Set by libavcodec. (before get_buffer() call)).\
744 * - encoding: unused\
745 * - decoding: Set by libavcodec.\
750 * motion referece frame index\
751 * - encoding: Set by user.\
752 * - decoding: Set by libavcodec.\
754 int8_t *ref_index[2];\
757 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
758 * output in AVFrame.reordered_opaque\
759 * - encoding: unused\
760 * - decoding: Read by user.\
762 int64_t reordered_opaque;\
765 #define FF_QSCALE_TYPE_MPEG1 0
766 #define FF_QSCALE_TYPE_MPEG2 1
767 #define FF_QSCALE_TYPE_H264 2
769 #define FF_BUFFER_TYPE_INTERNAL 1
770 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
771 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
772 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
775 #define FF_I_TYPE 1 ///< Intra
776 #define FF_P_TYPE 2 ///< Predicted
777 #define FF_B_TYPE 3 ///< Bi-dir predicted
778 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
779 #define FF_SI_TYPE 5 ///< Switching Intra
780 #define FF_SP_TYPE 6 ///< Switching Predicted
783 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
784 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
785 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
786 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
790 * New fields can be added to the end of FF_COMMON_FRAME with minor version
792 * Removal, reordering and changes to existing fields require a major
793 * version bump. No fields should be added into AVFrame before or after
795 * sizeof(AVFrame) must not be used outside libav*.
797 typedef struct AVFrame {
802 * main external API structure.
803 * New fields can be added to the end with minor version bumps.
804 * Removal, reordering and changes to existing fields require a major
806 * sizeof(AVCodecContext) must not be used outside libav*.
808 typedef struct AVCodecContext {
810 * information on struct for av_log
811 * - set by avcodec_alloc_context
813 const AVClass *av_class;
815 * the average bitrate
816 * - encoding: Set by user; unused for constant quantizer encoding.
817 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
822 * number of bits the bitstream is allowed to diverge from the reference.
823 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
824 * - encoding: Set by user; unused for constant quantizer encoding.
827 int bit_rate_tolerance;
831 * - encoding: Set by user.
832 * - decoding: Set by user.
837 * Some codecs need additional format info. It is stored here.
838 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
839 * specific codec MUST set it correctly otherwise stream copy breaks.
840 * In general use of this field by muxers is not recommanded.
841 * - encoding: Set by libavcodec.
842 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
847 * Motion estimation algorithm used for video coding.
848 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
849 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
850 * - encoding: MUST be set by user.
856 * some codecs need / can use extradata like Huffman tables.
857 * mjpeg: Huffman tables
858 * rv10: additional flags
859 * mpeg4: global headers (they can be in the bitstream or here)
860 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
861 * than extradata_size to avoid prolems if it is read with the bitstream reader.
862 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
863 * - encoding: Set/allocated/freed by libavcodec.
864 * - decoding: Set/allocated/freed by user.
870 * This is the fundamental unit of time (in seconds) in terms
871 * of which frame timestamps are represented. For fixed-fps content,
872 * timebase should be 1/framerate and timestamp increments should be
874 * - encoding: MUST be set by user.
875 * - decoding: Set by libavcodec.
877 AVRational time_base;
881 * picture width / height.
882 * - encoding: MUST be set by user.
883 * - decoding: Set by libavcodec.
884 * Note: For compatibility it is possible to set this instead of
885 * coded_width/height before decoding.
889 #define FF_ASPECT_EXTENDED 15
892 * the number of pictures in a group of pictures, or 0 for intra_only
893 * - encoding: Set by user.
899 * Pixel format, see PIX_FMT_xxx.
900 * - encoding: Set by user.
901 * - decoding: Set by libavcodec.
903 enum PixelFormat pix_fmt;
906 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
907 * has to read frames at native frame rate.
908 * - encoding: Set by user.
914 * If non NULL, 'draw_horiz_band' is called by the libavcodec
915 * decoder to draw a horizontal band. It improves cache usage. Not
916 * all codecs can do that. You must check the codec capabilities
919 * - decoding: Set by user.
920 * @param height the height of the slice
921 * @param y the y position of the slice
922 * @param type 1->top field, 2->bottom field, 3->frame
923 * @param offset offset into the AVFrame.data from which the slice should be read
925 void (*draw_horiz_band)(struct AVCodecContext *s,
926 const AVFrame *src, int offset[4],
927 int y, int type, int height);
930 int sample_rate; ///< samples per second
931 int channels; ///< number of audio channels
934 * audio sample format
935 * - encoding: Set by user.
936 * - decoding: Set by libavcodec.
938 enum SampleFormat sample_fmt; ///< sample format, currently unused
940 /* The following data should not be initialized. */
942 * Samples per packet, initialized when calling 'init'.
945 int frame_number; ///< audio or video frame number
946 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
949 * Number of frames the decoded output will be delayed relative to
951 * - encoding: Set by libavcodec.
956 /* - encoding parameters */
957 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
958 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
962 * - encoding: Set by user.
969 * - encoding: Set by user.
975 * maximum quantizer difference between frames
976 * - encoding: Set by user.
982 * maximum number of B-frames between non-B-frames
983 * Note: The output will be delayed by max_b_frames+1 relative to the input.
984 * - encoding: Set by user.
990 * qscale factor between IP and B-frames
991 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
992 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
993 * - encoding: Set by user.
996 float b_quant_factor;
998 /** obsolete FIXME remove */
1000 #define FF_RC_STRATEGY_XVID 1
1002 int b_frame_strategy;
1006 * - encoding: unused
1007 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1008 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1012 struct AVCodec *codec;
1016 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1017 /* do its best to deliver a chunk with size */
1018 /* below rtp_payload_size, the chunk will start */
1019 /* with a start code on some codecs like H.263. */
1020 /* This doesn't take account of any particular */
1021 /* headers inside the transmitted RTP payload. */
1024 /* The RTP callback: This function is called */
1025 /* every time the encoder has a packet to send. */
1026 /* It depends on the encoder if the data starts */
1027 /* with a Start Code (it should). H.263 does. */
1028 /* mb_nb contains the number of macroblocks */
1029 /* encoded in the RTP payload. */
1030 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1032 /* statistics, used for 2-pass encoding */
1043 * number of bits used for the previously encoded frame
1044 * - encoding: Set by libavcodec.
1045 * - decoding: unused
1050 * Private data of the user, can be used to carry app specific stuff.
1051 * - encoding: Set by user.
1052 * - decoding: Set by user.
1056 char codec_name[32];
1057 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1058 enum CodecID codec_id; /* see CODEC_ID_xxx */
1061 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1062 * This is used to work around some encoder bugs.
1063 * A demuxer should set this to what is stored in the field used to identify the codec.
1064 * If there are multiple such fields in a container then the demuxer should choose the one
1065 * which maximizes the information about the used codec.
1066 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1067 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1068 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1070 * - encoding: Set by user, if not then the default based on codec_id will be used.
1071 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1073 unsigned int codec_tag;
1076 * Work around bugs in encoders which sometimes cannot be detected automatically.
1077 * - encoding: Set by user
1078 * - decoding: Set by user
1080 int workaround_bugs;
1081 #define FF_BUG_AUTODETECT 1 ///< autodetection
1082 #define FF_BUG_OLD_MSMPEG4 2
1083 #define FF_BUG_XVID_ILACE 4
1084 #define FF_BUG_UMP4 8
1085 #define FF_BUG_NO_PADDING 16
1086 #define FF_BUG_AMV 32
1087 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1088 #define FF_BUG_QPEL_CHROMA 64
1089 #define FF_BUG_STD_QPEL 128
1090 #define FF_BUG_QPEL_CHROMA2 256
1091 #define FF_BUG_DIRECT_BLOCKSIZE 512
1092 #define FF_BUG_EDGE 1024
1093 #define FF_BUG_HPEL_CHROMA 2048
1094 #define FF_BUG_DC_CLIP 4096
1095 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1096 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1099 * luma single coefficient elimination threshold
1100 * - encoding: Set by user.
1101 * - decoding: unused
1103 int luma_elim_threshold;
1106 * chroma single coeff elimination threshold
1107 * - encoding: Set by user.
1108 * - decoding: unused
1110 int chroma_elim_threshold;
1113 * strictly follow the standard (MPEG4, ...).
1114 * - encoding: Set by user.
1115 * - decoding: Set by user.
1116 * Setting this to STRICT or higher means the encoder and decoder will
1117 * generally do stupid things. While setting it to inofficial or lower
1118 * will mean the encoder might use things that are not supported by all
1119 * spec compliant decoders. Decoders make no difference between normal,
1120 * inofficial and experimental, that is they always try to decode things
1121 * when they can unless they are explicitly asked to behave stupid
1122 * (=strictly conform to the specs)
1124 int strict_std_compliance;
1125 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1126 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1127 #define FF_COMPLIANCE_NORMAL 0
1128 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1129 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1132 * qscale offset between IP and B-frames
1133 * - encoding: Set by user.
1134 * - decoding: unused
1136 float b_quant_offset;
1139 * Error recognization; higher values will detect more errors but may
1140 * misdetect some more or less valid parts as errors.
1141 * - encoding: unused
1142 * - decoding: Set by user.
1144 int error_recognition;
1145 #define FF_ER_CAREFUL 1
1146 #define FF_ER_COMPLIANT 2
1147 #define FF_ER_AGGRESSIVE 3
1148 #define FF_ER_VERY_AGGRESSIVE 4
1151 * Called at the beginning of each frame to get a buffer for it.
1152 * If pic.reference is set then the frame will be read later by libavcodec.
1153 * avcodec_align_dimensions() should be used to find the required width and
1154 * height, as they normally need to be rounded up to the next multiple of 16.
1155 * - encoding: unused
1156 * - decoding: Set by libavcodec., user can override.
1158 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1161 * Called to release buffers which were allocated with get_buffer.
1162 * A released buffer can be reused in get_buffer().
1163 * pic.data[*] must be set to NULL.
1164 * - encoding: unused
1165 * - decoding: Set by libavcodec., user can override.
1167 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1170 * If 1 the stream has a 1 frame delay during decoding.
1171 * - encoding: Set by libavcodec.
1172 * - decoding: Set by libavcodec.
1177 * number of bytes per packet if constant and known or 0
1178 * Used by some WAV based audio codecs.
1182 int parse_only; /* - decoding only: If true, only parsing is done
1183 (function avcodec_parse_frame()). The frame
1184 data is returned. Only MPEG codecs support this now. */
1187 * 0-> h263 quant 1-> mpeg quant
1188 * - encoding: Set by user.
1189 * - decoding: unused
1194 * pass1 encoding statistics output buffer
1195 * - encoding: Set by libavcodec.
1196 * - decoding: unused
1201 * pass2 encoding statistics input buffer
1202 * Concatenated stuff from stats_out of pass1 should be placed here.
1203 * - encoding: Allocated/set/freed by user.
1204 * - decoding: unused
1209 * ratecontrol qmin qmax limiting method
1210 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1211 * - encoding: Set by user.
1212 * - decoding: unused
1220 * ratecontrol override, see RcOverride
1221 * - encoding: Allocated/set/freed by user.
1222 * - decoding: unused
1224 RcOverride *rc_override;
1225 int rc_override_count;
1228 * rate control equation
1229 * - encoding: Set by user
1230 * - decoding: unused
1236 * - encoding: Set by user.
1237 * - decoding: unused
1243 * - encoding: Set by user.
1244 * - decoding: unused
1249 * decoder bitstream buffer size
1250 * - encoding: Set by user.
1251 * - decoding: unused
1254 float rc_buffer_aggressivity;
1257 * qscale factor between P and I-frames
1258 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1259 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1260 * - encoding: Set by user.
1261 * - decoding: unused
1263 float i_quant_factor;
1266 * qscale offset between P and I-frames
1267 * - encoding: Set by user.
1268 * - decoding: unused
1270 float i_quant_offset;
1273 * initial complexity for pass1 ratecontrol
1274 * - encoding: Set by user.
1275 * - decoding: unused
1277 float rc_initial_cplx;
1280 * DCT algorithm, see FF_DCT_* below
1281 * - encoding: Set by user.
1282 * - decoding: unused
1285 #define FF_DCT_AUTO 0
1286 #define FF_DCT_FASTINT 1
1287 #define FF_DCT_INT 2
1288 #define FF_DCT_MMX 3
1289 #define FF_DCT_MLIB 4
1290 #define FF_DCT_ALTIVEC 5
1291 #define FF_DCT_FAAN 6
1294 * luminance masking (0-> disabled)
1295 * - encoding: Set by user.
1296 * - decoding: unused
1301 * temporary complexity masking (0-> disabled)
1302 * - encoding: Set by user.
1303 * - decoding: unused
1305 float temporal_cplx_masking;
1308 * spatial complexity masking (0-> disabled)
1309 * - encoding: Set by user.
1310 * - decoding: unused
1312 float spatial_cplx_masking;
1315 * p block masking (0-> disabled)
1316 * - encoding: Set by user.
1317 * - decoding: unused
1322 * darkness masking (0-> disabled)
1323 * - encoding: Set by user.
1324 * - decoding: unused
1329 * IDCT algorithm, see FF_IDCT_* below.
1330 * - encoding: Set by user.
1331 * - decoding: Set by user.
1334 #define FF_IDCT_AUTO 0
1335 #define FF_IDCT_INT 1
1336 #define FF_IDCT_SIMPLE 2
1337 #define FF_IDCT_SIMPLEMMX 3
1338 #define FF_IDCT_LIBMPEG2MMX 4
1339 #define FF_IDCT_PS2 5
1340 #define FF_IDCT_MLIB 6
1341 #define FF_IDCT_ARM 7
1342 #define FF_IDCT_ALTIVEC 8
1343 #define FF_IDCT_SH4 9
1344 #define FF_IDCT_SIMPLEARM 10
1345 #define FF_IDCT_H264 11
1346 #define FF_IDCT_VP3 12
1347 #define FF_IDCT_IPP 13
1348 #define FF_IDCT_XVIDMMX 14
1349 #define FF_IDCT_CAVS 15
1350 #define FF_IDCT_SIMPLEARMV5TE 16
1351 #define FF_IDCT_SIMPLEARMV6 17
1352 #define FF_IDCT_SIMPLEVIS 18
1353 #define FF_IDCT_WMV2 19
1354 #define FF_IDCT_FAAN 20
1358 * - encoding: Set by libavcodec.
1359 * - decoding: Set by user (or 0).
1363 * slice offsets in the frame in bytes
1364 * - encoding: Set/allocated by libavcodec.
1365 * - decoding: Set/allocated by user (or NULL).
1370 * error concealment flags
1371 * - encoding: unused
1372 * - decoding: Set by user.
1374 int error_concealment;
1375 #define FF_EC_GUESS_MVS 1
1376 #define FF_EC_DEBLOCK 2
1379 * dsp_mask could be add used to disable unwanted CPU features
1380 * CPU features (i.e. MMX, SSE. ...)
1382 * With the FORCE flag you may instead enable given CPU features.
1383 * (Dangerous: Usable in case of misdetection, improper usage however will
1384 * result into program crash.)
1387 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1388 /* lower 16 bits - CPU features */
1389 #define FF_MM_MMX 0x0001 ///< standard MMX
1390 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1391 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1392 #define FF_MM_SSE 0x0008 ///< SSE functions
1393 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1394 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1395 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1396 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1397 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1400 * bits per sample/pixel from the demuxer (needed for huffyuv).
1401 * - encoding: Set by libavcodec.
1402 * - decoding: Set by user.
1404 int bits_per_coded_sample;
1407 * prediction method (needed for huffyuv)
1408 * - encoding: Set by user.
1409 * - decoding: unused
1411 int prediction_method;
1412 #define FF_PRED_LEFT 0
1413 #define FF_PRED_PLANE 1
1414 #define FF_PRED_MEDIAN 2
1417 * sample aspect ratio (0 if unknown)
1418 * That is the width of a pixel divided by the height of the pixel.
1419 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1420 * - encoding: Set by user.
1421 * - decoding: Set by libavcodec.
1423 AVRational sample_aspect_ratio;
1426 * the picture in the bitstream
1427 * - encoding: Set by libavcodec.
1428 * - decoding: Set by libavcodec.
1430 AVFrame *coded_frame;
1434 * - encoding: Set by user.
1435 * - decoding: Set by user.
1438 #define FF_DEBUG_PICT_INFO 1
1439 #define FF_DEBUG_RC 2
1440 #define FF_DEBUG_BITSTREAM 4
1441 #define FF_DEBUG_MB_TYPE 8
1442 #define FF_DEBUG_QP 16
1443 #define FF_DEBUG_MV 32
1444 #define FF_DEBUG_DCT_COEFF 0x00000040
1445 #define FF_DEBUG_SKIP 0x00000080
1446 #define FF_DEBUG_STARTCODE 0x00000100
1447 #define FF_DEBUG_PTS 0x00000200
1448 #define FF_DEBUG_ER 0x00000400
1449 #define FF_DEBUG_MMCO 0x00000800
1450 #define FF_DEBUG_BUGS 0x00001000
1451 #define FF_DEBUG_VIS_QP 0x00002000
1452 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1453 #define FF_DEBUG_BUFFERS 0x00008000
1457 * - encoding: Set by user.
1458 * - decoding: Set by user.
1461 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1462 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1463 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1467 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1468 * - decoding: unused
1473 * minimum MB quantizer
1474 * - encoding: unused
1475 * - decoding: unused
1480 * maximum MB quantizer
1481 * - encoding: unused
1482 * - decoding: unused
1487 * motion estimation comparison function
1488 * - encoding: Set by user.
1489 * - decoding: unused
1493 * subpixel motion estimation comparison function
1494 * - encoding: Set by user.
1495 * - decoding: unused
1499 * macroblock comparison function (not supported yet)
1500 * - encoding: Set by user.
1501 * - decoding: unused
1505 * interlaced DCT comparison function
1506 * - encoding: Set by user.
1507 * - decoding: unused
1510 #define FF_CMP_SAD 0
1511 #define FF_CMP_SSE 1
1512 #define FF_CMP_SATD 2
1513 #define FF_CMP_DCT 3
1514 #define FF_CMP_PSNR 4
1515 #define FF_CMP_BIT 5
1517 #define FF_CMP_ZERO 7
1518 #define FF_CMP_VSAD 8
1519 #define FF_CMP_VSSE 9
1520 #define FF_CMP_NSSE 10
1521 #define FF_CMP_W53 11
1522 #define FF_CMP_W97 12
1523 #define FF_CMP_DCTMAX 13
1524 #define FF_CMP_DCT264 14
1525 #define FF_CMP_CHROMA 256
1528 * ME diamond size & shape
1529 * - encoding: Set by user.
1530 * - decoding: unused
1535 * amount of previous MV predictors (2a+1 x 2a+1 square)
1536 * - encoding: Set by user.
1537 * - decoding: unused
1539 int last_predictor_count;
1542 * prepass for motion estimation
1543 * - encoding: Set by user.
1544 * - decoding: unused
1549 * motion estimation prepass comparison function
1550 * - encoding: Set by user.
1551 * - decoding: unused
1556 * ME prepass diamond size & shape
1557 * - encoding: Set by user.
1558 * - decoding: unused
1564 * - encoding: Set by user.
1565 * - decoding: unused
1567 int me_subpel_quality;
1570 * callback to negotiate the pixelFormat
1571 * @param fmt is the list of formats which are supported by the codec,
1572 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1573 * The first is always the native one.
1574 * @return the chosen format
1575 * - encoding: unused
1576 * - decoding: Set by user, if not set the native format will be chosen.
1578 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1581 * DTG active format information (additional aspect ratio
1582 * information only used in DVB MPEG-2 transport streams)
1585 * - encoding: unused
1586 * - decoding: Set by decoder.
1588 int dtg_active_format;
1589 #define FF_DTG_AFD_SAME 8
1590 #define FF_DTG_AFD_4_3 9
1591 #define FF_DTG_AFD_16_9 10
1592 #define FF_DTG_AFD_14_9 11
1593 #define FF_DTG_AFD_4_3_SP_14_9 13
1594 #define FF_DTG_AFD_16_9_SP_14_9 14
1595 #define FF_DTG_AFD_SP_4_3 15
1598 * maximum motion estimation search range in subpel units
1599 * If 0 then no limit.
1601 * - encoding: Set by user.
1602 * - decoding: unused
1607 * intra quantizer bias
1608 * - encoding: Set by user.
1609 * - decoding: unused
1611 int intra_quant_bias;
1612 #define FF_DEFAULT_QUANT_BIAS 999999
1615 * inter quantizer bias
1616 * - encoding: Set by user.
1617 * - decoding: unused
1619 int inter_quant_bias;
1623 * - encoding: unused
1624 * - decoding: Which clrtable should be used for 8bit RGB images.
1625 * Tables have to be stored somewhere. FIXME
1630 * internal_buffer count
1631 * Don't touch, used by libavcodec default_get_buffer().
1633 int internal_buffer_count;
1637 * Don't touch, used by libavcodec default_get_buffer().
1639 void *internal_buffer;
1641 #define FF_LAMBDA_SHIFT 7
1642 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1643 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1644 #define FF_LAMBDA_MAX (256*128-1)
1646 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1648 * Global quality for codecs which cannot change it per frame.
1649 * This should be proportional to MPEG-1/2/4 qscale.
1650 * - encoding: Set by user.
1651 * - decoding: unused
1655 #define FF_CODER_TYPE_VLC 0
1656 #define FF_CODER_TYPE_AC 1
1657 #define FF_CODER_TYPE_RAW 2
1658 #define FF_CODER_TYPE_RLE 3
1659 #define FF_CODER_TYPE_DEFLATE 4
1662 * - encoding: Set by user.
1663 * - decoding: unused
1669 * - encoding: Set by user.
1670 * - decoding: unused
1676 * - encoding: unused
1677 * - decoding: Set by user.
1679 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1684 * - encoding: unused
1685 * - decoding: Set by user.
1688 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1689 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1690 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1693 * XVideo Motion Acceleration
1694 * - encoding: forbidden
1695 * - decoding: set by decoder
1697 int xvmc_acceleration;
1700 * macroblock decision mode
1701 * - encoding: Set by user.
1702 * - decoding: unused
1705 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1706 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1707 #define FF_MB_DECISION_RD 2 ///< rate distortion
1710 * custom intra quantization matrix
1711 * - encoding: Set by user, can be NULL.
1712 * - decoding: Set by libavcodec.
1714 uint16_t *intra_matrix;
1717 * custom inter quantization matrix
1718 * - encoding: Set by user, can be NULL.
1719 * - decoding: Set by libavcodec.
1721 uint16_t *inter_matrix;
1724 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1725 * This is used to work around some encoder bugs.
1726 * - encoding: unused
1727 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1729 unsigned int stream_codec_tag;
1732 * scene change detection threshold
1733 * 0 is default, larger means fewer detected scene changes.
1734 * - encoding: Set by user.
1735 * - decoding: unused
1737 int scenechange_threshold;
1740 * minimum Lagrange multipler
1741 * - encoding: Set by user.
1742 * - decoding: unused
1747 * maximum Lagrange multipler
1748 * - encoding: Set by user.
1749 * - decoding: unused
1754 * palette control structure
1755 * - encoding: ??? (no palette-enabled encoder yet)
1756 * - decoding: Set by user.
1758 struct AVPaletteControl *palctrl;
1761 * noise reduction strength
1762 * - encoding: Set by user.
1763 * - decoding: unused
1765 int noise_reduction;
1768 * Called at the beginning of a frame to get cr buffer for it.
1769 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1770 * libavcodec will pass previous buffer in pic, function should return
1771 * same buffer or new buffer with old frame "painted" into it.
1772 * If pic.data[0] == NULL must behave like get_buffer().
1773 * - encoding: unused
1774 * - decoding: Set by libavcodec., user can override
1776 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1779 * Number of bits which should be loaded into the rc buffer before decoding starts.
1780 * - encoding: Set by user.
1781 * - decoding: unused
1783 int rc_initial_buffer_occupancy;
1787 * - encoding: Set by user.
1788 * - decoding: unused
1790 int inter_threshold;
1794 * - encoding: Set by user.
1795 * - decoding: Set by user.
1800 * Simulates errors in the bitstream to test error concealment.
1801 * - encoding: Set by user.
1802 * - decoding: unused
1807 * MP3 antialias algorithm, see FF_AA_* below.
1808 * - encoding: unused
1809 * - decoding: Set by user.
1812 #define FF_AA_AUTO 0
1813 #define FF_AA_FASTINT 1 //not implemented yet
1815 #define FF_AA_FLOAT 3
1817 * quantizer noise shaping
1818 * - encoding: Set by user.
1819 * - decoding: unused
1821 int quantizer_noise_shaping;
1825 * is used to decide how many independent tasks should be passed to execute()
1826 * - encoding: Set by user.
1827 * - decoding: Set by user.
1832 * The codec may call this to execute several independent things.
1833 * It will return only after finishing all tasks.
1834 * The user may replace this with some multithreaded implementation,
1835 * the default implementation will execute the parts serially.
1836 * @param count the number of things to execute
1837 * - encoding: Set by libavcodec, user can override.
1838 * - decoding: Set by libavcodec, user can override.
1840 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void **arg2, int *ret, int count);
1844 * Can be used by execute() to store some per AVCodecContext stuff.
1845 * - encoding: set by execute()
1846 * - decoding: set by execute()
1848 void *thread_opaque;
1851 * Motion estimation threshold below which no motion estimation is
1852 * performed, but instead the user specified motion vectors are used.
1854 * - encoding: Set by user.
1855 * - decoding: unused
1860 * Macroblock threshold below which the user specified macroblock types will be used.
1861 * - encoding: Set by user.
1862 * - decoding: unused
1867 * precision of the intra DC coefficient - 8
1868 * - encoding: Set by user.
1869 * - decoding: unused
1871 int intra_dc_precision;
1874 * noise vs. sse weight for the nsse comparsion function
1875 * - encoding: Set by user.
1876 * - decoding: unused
1881 * Number of macroblock rows at the top which are skipped.
1882 * - encoding: unused
1883 * - decoding: Set by user.
1888 * Number of macroblock rows at the bottom which are skipped.
1889 * - encoding: unused
1890 * - decoding: Set by user.
1896 * - encoding: Set by user.
1897 * - decoding: Set by libavcodec.
1900 #define FF_PROFILE_UNKNOWN -99
1901 #define FF_PROFILE_AAC_MAIN 0
1902 #define FF_PROFILE_AAC_LOW 1
1903 #define FF_PROFILE_AAC_SSR 2
1904 #define FF_PROFILE_AAC_LTP 3
1908 * - encoding: Set by user.
1909 * - decoding: Set by libavcodec.
1912 #define FF_LEVEL_UNKNOWN -99
1915 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1916 * - encoding: unused
1917 * - decoding: Set by user.
1922 * Bitstream width / height, may be different from width/height if lowres
1923 * or other things are used.
1924 * - encoding: unused
1925 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1927 int coded_width, coded_height;
1930 * frame skip threshold
1931 * - encoding: Set by user.
1932 * - decoding: unused
1934 int frame_skip_threshold;
1938 * - encoding: Set by user.
1939 * - decoding: unused
1941 int frame_skip_factor;
1944 * frame skip exponent
1945 * - encoding: Set by user.
1946 * - decoding: unused
1951 * frame skip comparison function
1952 * - encoding: Set by user.
1953 * - decoding: unused
1958 * Border processing masking, raises the quantizer for mbs on the borders
1960 * - encoding: Set by user.
1961 * - decoding: unused
1963 float border_masking;
1966 * minimum MB lagrange multipler
1967 * - encoding: Set by user.
1968 * - decoding: unused
1973 * maximum MB lagrange multipler
1974 * - encoding: Set by user.
1975 * - decoding: unused
1981 * - encoding: Set by user.
1982 * - decoding: unused
1984 int me_penalty_compensation;
1988 * - encoding: unused
1989 * - decoding: Set by user.
1991 enum AVDiscard skip_loop_filter;
1995 * - encoding: unused
1996 * - decoding: Set by user.
1998 enum AVDiscard skip_idct;
2002 * - encoding: unused
2003 * - decoding: Set by user.
2005 enum AVDiscard skip_frame;
2009 * - encoding: Set by user.
2010 * - decoding: unused
2016 * - encoding: Set by user.
2017 * - decoding: unused
2022 * constant rate factor - quality-based VBR - values ~correspond to qps
2023 * - encoding: Set by user.
2024 * - decoding: unused
2029 * constant quantization parameter rate control method
2030 * - encoding: Set by user.
2031 * - decoding: unused
2037 * - encoding: Set by user.
2038 * - decoding: unused
2043 * number of reference frames
2044 * - encoding: Set by user.
2045 * - decoding: unused
2050 * chroma qp offset from luma
2051 * - encoding: Set by user.
2052 * - decoding: unused
2057 * Influences how often B-frames are used.
2058 * - encoding: Set by user.
2059 * - decoding: unused
2064 * trellis RD quantization
2065 * - encoding: Set by user.
2066 * - decoding: unused
2071 * Reduce fluctuations in qp (before curve compression).
2072 * - encoding: Set by user.
2073 * - decoding: unused
2075 float complexityblur;
2078 * in-loop deblocking filter alphac0 parameter
2079 * alpha is in the range -6...6
2080 * - encoding: Set by user.
2081 * - decoding: unused
2086 * in-loop deblocking filter beta parameter
2087 * beta is in the range -6...6
2088 * - encoding: Set by user.
2089 * - decoding: unused
2094 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2095 * - encoding: Set by user.
2096 * - decoding: unused
2099 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2100 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2101 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2102 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2103 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2106 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal)
2107 * - encoding: Set by user.
2108 * - decoding: unused
2113 * Audio cutoff bandwidth (0 means "automatic")
2114 * - encoding: Set by user.
2115 * - decoding: unused
2120 * Multiplied by qscale for each frame and added to scene_change_score.
2121 * - encoding: Set by user.
2122 * - decoding: unused
2124 int scenechange_factor;
2128 * Note: Value depends upon the compare function used for fullpel ME.
2129 * - encoding: Set by user.
2130 * - decoding: unused
2135 * Adjusts sensitivity of b_frame_strategy 1.
2136 * - encoding: Set by user.
2137 * - decoding: unused
2142 * - encoding: Set by user.
2143 * - decoding: unused
2145 int compression_level;
2146 #define FF_COMPRESSION_DEFAULT -1
2149 * Sets whether to use LPC mode - used by FLAC encoder.
2150 * - encoding: Set by user.
2151 * - decoding: unused
2156 * LPC coefficient precision - used by FLAC encoder
2157 * - encoding: Set by user.
2158 * - decoding: unused
2160 int lpc_coeff_precision;
2163 * - encoding: Set by user.
2164 * - decoding: unused
2166 int min_prediction_order;
2169 * - encoding: Set by user.
2170 * - decoding: unused
2172 int max_prediction_order;
2175 * search method for selecting prediction order
2176 * - encoding: Set by user.
2177 * - decoding: unused
2179 int prediction_order_method;
2182 * - encoding: Set by user.
2183 * - decoding: unused
2185 int min_partition_order;
2188 * - encoding: Set by user.
2189 * - decoding: unused
2191 int max_partition_order;
2194 * GOP timecode frame start number, in non drop frame format
2195 * - encoding: Set by user.
2196 * - decoding: unused
2198 int64_t timecode_frame_start;
2201 * Decoder should decode to this many channels if it can (0 for default)
2202 * - encoding: unused
2203 * - decoding: Set by user.
2205 int request_channels;
2208 * Percentage of dynamic range compression to be applied by the decoder.
2209 * The default value is 1.0, corresponding to full compression.
2210 * - encoding: unused
2211 * - decoding: Set by user.
2216 * opaque 64bit number (generally a PTS) that will be reordered and
2217 * output in AVFrame.reordered_opaque
2218 * - encoding: unused
2219 * - decoding: Set by user.
2221 int64_t reordered_opaque;
2224 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2225 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2226 * - encoding: set by user.
2227 * - decoding: set by libavcodec.
2229 int bits_per_raw_sample;
2235 typedef struct AVCodec {
2237 * Name of the codec implementation.
2238 * The name is globally unique among encoders and among decoders (but an
2239 * encoder and a decoder can share the same name).
2240 * This is the primary way to find a codec from the user perspective.
2243 enum CodecType type;
2246 int (*init)(AVCodecContext *);
2247 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2248 int (*close)(AVCodecContext *);
2249 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2250 const uint8_t *buf, int buf_size);
2252 * Codec capabilities.
2256 struct AVCodec *next;
2259 * Will be called when seeking
2261 void (*flush)(AVCodecContext *);
2262 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2263 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2265 * Descriptive name for the codec, meant to be more human readable than \p name.
2266 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2268 const char *long_name;
2269 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2270 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2274 * four components are given, that's all.
2275 * the last component is alpha
2277 typedef struct AVPicture {
2279 int linesize[4]; ///< number of bytes per line
2284 * This structure defines a method for communicating palette changes
2285 * between and demuxer and a decoder.
2287 * @deprecated Use AVPacket to send palette changes instead.
2288 * This is totally broken.
2290 #define AVPALETTE_SIZE 1024
2291 #define AVPALETTE_COUNT 256
2292 typedef struct AVPaletteControl {
2294 /* Demuxer sets this to 1 to indicate the palette has changed;
2295 * decoder resets to 0. */
2296 int palette_changed;
2298 /* 4-byte ARGB palette entries, stored in native byte order; note that
2299 * the individual palette components should be on a 8-bit scale; if
2300 * the palette data comes from an IBM VGA native format, the component
2301 * data is probably 6 bits in size and needs to be scaled. */
2302 unsigned int palette[AVPALETTE_COUNT];
2304 } AVPaletteControl attribute_deprecated;
2306 typedef struct AVSubtitleRect {
2313 uint32_t *rgba_palette;
2317 typedef struct AVSubtitle {
2318 uint16_t format; /* 0 = graphics */
2319 uint32_t start_display_time; /* relative to packet pts, in ms */
2320 uint32_t end_display_time; /* relative to packet pts, in ms */
2322 AVSubtitleRect *rects;
2328 struct ReSampleContext;
2329 struct AVResampleContext;
2331 typedef struct ReSampleContext ReSampleContext;
2333 ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2334 int output_rate, int input_rate);
2335 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2336 void audio_resample_close(ReSampleContext *s);
2338 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2339 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2340 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2341 void av_resample_close(struct AVResampleContext *c);
2344 * Allocate memory for a picture. Call avpicture_free to free it.
2346 * @param picture the picture to be filled in
2347 * @param pix_fmt the format of the picture
2348 * @param width the width of the picture
2349 * @param height the height of the picture
2350 * @return zero if successful, a negative value if not
2352 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2355 * Free a picture previously allocated by avpicture_alloc().
2357 * @param picture the AVPicture to be freed
2359 void avpicture_free(AVPicture *picture);
2362 * Fill in the AVPicture fields.
2363 * The fields of the given AVPicture are filled in by using the 'ptr' address
2364 * which points to the image data buffer. Depending on the specified picture
2365 * format, one or multiple image data pointers and line sizes will be set.
2366 * If a planar format is specified, several pointers will be set pointing to
2367 * the different picture planes and the line sizes of the different planes
2368 * will be stored in the lines_sizes array.
2370 * @param picture AVPicture whose fields are to be filled in
2371 * @param ptr Buffer which will contain or contains the actual image data
2372 * @param pix_fmt The format in which the picture data is stored.
2373 * @param width the width of the image in pixels
2374 * @param height the height of the image in pixels
2375 * @return size of the image data in bytes
2377 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2378 int pix_fmt, int width, int height);
2379 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2380 unsigned char *dest, int dest_size);
2383 * Calculate the size in bytes that a picture of the given width and height
2384 * would occupy if stored in the given picture format.
2386 * @param pix_fmt the given picture format
2387 * @param width the width of the image
2388 * @param height the height of the image
2389 * @return Image data size in bytes
2391 int avpicture_get_size(int pix_fmt, int width, int height);
2392 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2393 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2394 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2395 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2396 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2398 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2399 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2400 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2401 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2402 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2403 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2406 * Computes what kind of losses will occur when converting from one specific
2407 * pixel format to another.
2408 * When converting from one pixel format to another, information loss may occur.
2409 * For example, when converting from RGB24 to GRAY, the color information will
2410 * be lost. Similarly, other losses occur when converting from some formats to
2411 * other formats. These losses can involve loss of chroma, but also loss of
2412 * resolution, loss of color depth, loss due to the color space conversion, loss
2413 * of the alpha bits or loss due to color quantization.
2414 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2415 * which will occur when converting from one pixel format to another.
2417 * @param[in] dst_pix_fmt destination pixel format
2418 * @param[in] src_pix_fmt source pixel format
2419 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2420 * @return Combination of flags informing you what kind of losses will occur.
2422 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2426 * Finds the best pixel format to convert to given a certain source pixel
2427 * format. When converting from one pixel format to another, information loss
2428 * may occur. For example, when converting from RGB24 to GRAY, the color
2429 * information will be lost. Similarly, other losses occur when converting from
2430 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2431 * the given pixel formats should be used to suffer the least amount of loss.
2432 * The pixel formats from which it chooses one, are determined by the
2433 * \p pix_fmt_mask parameter.
2436 * src_pix_fmt = PIX_FMT_YUV420P;
2437 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2438 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2441 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2442 * @param[in] src_pix_fmt source pixel format
2443 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2444 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2445 * @return The best pixel format to convert to or -1 if none was found.
2447 int avcodec_find_best_pix_fmt(int pix_fmt_mask, int src_pix_fmt,
2448 int has_alpha, int *loss_ptr);
2452 * Print in buf the string corresponding to the pixel format with
2453 * number pix_fmt, or an header if pix_fmt is negative.
2455 * @param[in] buf the buffer where to write the string
2456 * @param[in] buf_size the size of buf
2457 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2458 * a negative value to print the corresponding header.
2459 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2461 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2463 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2464 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2467 * Tell if an image really has transparent alpha values.
2468 * @return ored mask of FF_ALPHA_xxx constants
2470 int img_get_alpha_info(const AVPicture *src,
2471 int pix_fmt, int width, int height);
2473 /* deinterlace a picture */
2474 /* deinterlace - if not supported return -1 */
2475 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2476 int pix_fmt, int width, int height);
2478 /* external high level API */
2480 AVCodec *av_codec_next(AVCodec *c);
2483 * Returns the LIBAVCODEC_VERSION_INT constant.
2485 unsigned avcodec_version(void);
2488 * Initializes libavcodec.
2490 * @warning This function \e must be called before any other libavcodec
2493 void avcodec_init(void);
2495 void register_avcodec(AVCodec *format);
2498 * Finds a registered encoder with a matching codec ID.
2500 * @param id CodecID of the requested encoder
2501 * @return An encoder if one was found, NULL otherwise.
2503 AVCodec *avcodec_find_encoder(enum CodecID id);
2506 * Finds a registered encoder with the specified name.
2508 * @param name name of the requested encoder
2509 * @return An encoder if one was found, NULL otherwise.
2511 AVCodec *avcodec_find_encoder_by_name(const char *name);
2514 * Finds a registered decoder with a matching codec ID.
2516 * @param id CodecID of the requested decoder
2517 * @return A decoder if one was found, NULL otherwise.
2519 AVCodec *avcodec_find_decoder(enum CodecID id);
2522 * Finds a registered decoder with the specified name.
2524 * @param name name of the requested decoder
2525 * @return A decoder if one was found, NULL otherwise.
2527 AVCodec *avcodec_find_decoder_by_name(const char *name);
2528 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2531 * Sets the fields of the given AVCodecContext to default values.
2533 * @param s The AVCodecContext of which the fields should be set to default values.
2535 void avcodec_get_context_defaults(AVCodecContext *s);
2537 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2538 * we WILL change its arguments and name a few times! */
2539 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2542 * Allocates an AVCodecContext and sets its fields to default values. The
2543 * resulting struct can be deallocated by simply calling av_free().
2545 * @return An AVCodecContext filled with default values or NULL on failure.
2546 * @see avcodec_get_context_defaults
2548 AVCodecContext *avcodec_alloc_context(void);
2550 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2551 * we WILL change its arguments and name a few times! */
2552 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2555 * Sets the fields of the given AVFrame to default values.
2557 * @param pic The AVFrame of which the fields should be set to default values.
2559 void avcodec_get_frame_defaults(AVFrame *pic);
2562 * Allocates an AVFrame and sets its fields to default values. The resulting
2563 * struct can be deallocated by simply calling av_free().
2565 * @return An AVFrame filled with default values or NULL on failure.
2566 * @see avcodec_get_frame_defaults
2568 AVFrame *avcodec_alloc_frame(void);
2570 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2571 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2572 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2573 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2576 * Checks if the given dimension of a picture is valid, meaning that all
2577 * bytes of the picture can be addressed with a signed int.
2579 * @param[in] w Width of the picture.
2580 * @param[in] h Height of the picture.
2581 * @return Zero if valid, a negative value if invalid.
2583 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2584 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2586 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2587 void avcodec_thread_free(AVCodecContext *s);
2588 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2589 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void **arg, int *ret, int count);
2590 //FIXME func typedef
2593 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2594 * function the context has to be allocated.
2596 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2597 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2598 * retrieving a codec.
2600 * @warning This function is not thread safe!
2603 * avcodec_register_all();
2604 * codec = avcodec_find_decoder(CODEC_ID_H264);
2608 * context = avcodec_alloc_context();
2610 * if (avcodec_open(context, codec) < 0)
2614 * @param avctx The context which will be set up to use the given codec.
2615 * @param codec The codec to use within the context.
2616 * @return zero on success, a negative value on error
2617 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2619 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2622 * @deprecated Use avcodec_decode_audio2() instead.
2624 attribute_deprecated int avcodec_decode_audio(AVCodecContext *avctx, int16_t *samples,
2625 int *frame_size_ptr,
2626 const uint8_t *buf, int buf_size);
2629 * Decodes an audio frame from \p buf into \p samples.
2630 * The avcodec_decode_audio2() function decodes an audio frame from the input
2631 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2632 * audio codec which was coupled with \p avctx using avcodec_open(). The
2633 * resulting decoded frame is stored in output buffer \p samples. If no frame
2634 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2635 * decompressed frame size in \e bytes.
2637 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2638 * output buffer before calling avcodec_decode_audio2().
2640 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2641 * the actual read bytes because some optimized bitstream readers read 32 or 64
2642 * bits at once and could read over the end.
2644 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2645 * no overreading happens for damaged MPEG streams.
2647 * @note You might have to align the input buffer \p buf and output buffer \p
2648 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2649 * necessary at all, on others it won't work at all if not aligned and on others
2650 * it will work but it will have an impact on performance. In practice, the
2651 * bitstream should have 4 byte alignment at minimum and all sample data should
2652 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2653 * the linesize is not a multiple of 16 then there's no sense in aligning the
2654 * start of the buffer to 16.
2656 * @param avctx the codec context
2657 * @param[out] samples the output buffer
2658 * @param[in,out] frame_size_ptr the output buffer size in bytes
2659 * @param[in] buf the input buffer
2660 * @param[in] buf_size the input buffer size in bytes
2661 * @return On error a negative value is returned, otherwise the number of bytes
2662 * used or zero if no frame could be decompressed.
2664 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2665 int *frame_size_ptr,
2666 const uint8_t *buf, int buf_size);
2669 * Decodes a video frame from \p buf into \p picture.
2670 * The avcodec_decode_video() function decodes a video frame from the input
2671 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2672 * video codec which was coupled with \p avctx using avcodec_open(). The
2673 * resulting decoded frame is stored in \p picture.
2675 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2676 * the actual read bytes because some optimized bitstream readers read 32 or 64
2677 * bits at once and could read over the end.
2679 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2680 * no overreading happens for damaged MPEG streams.
2682 * @note You might have to align the input buffer \p buf and output buffer \p
2683 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2684 * necessary at all, on others it won't work at all if not aligned and on others
2685 * it will work but it will have an impact on performance. In practice, the
2686 * bitstream should have 4 byte alignment at minimum and all sample data should
2687 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2688 * the linesize is not a multiple of 16 then there's no sense in aligning the
2689 * start of the buffer to 16.
2691 * @param avctx the codec context
2692 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2693 * @param[in] buf the input buffer
2694 * @param[in] buf_size the size of the input buffer in bytes
2695 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2696 * @return On error a negative value is returned, otherwise the number of bytes
2697 * used or zero if no frame could be decompressed.
2699 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2700 int *got_picture_ptr,
2701 const uint8_t *buf, int buf_size);
2703 /* Decode a subtitle message. Return -1 if error, otherwise return the
2704 * number of bytes used. If no subtitle could be decompressed,
2705 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2706 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
2708 const uint8_t *buf, int buf_size);
2709 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
2711 uint8_t *buf, int buf_size);
2714 * Encodes an audio frame from \p samples into \p buf.
2715 * The avcodec_encode_audio() function encodes an audio frame from the input
2716 * buffer \p samples. To encode it, it makes use of the audio codec which was
2717 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2718 * stored in output buffer \p buf.
2720 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2722 * @param avctx the codec context
2723 * @param[out] buf the output buffer
2724 * @param[in] buf_size the output buffer size
2725 * @param[in] samples the input buffer containing the samples
2726 * The number of samples read from this buffer is frame_size*channels,
2727 * both of which are defined in \p avctx.
2728 * For PCM audio the number of samples read from \p samples is equal to
2729 * \p buf_size * input_sample_size / output_sample_size.
2730 * @return On error a negative value is returned, on success zero or the number
2731 * of bytes used to encode the data read from the input buffer.
2733 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2734 const short *samples);
2737 * Encodes a video frame from \p pict into \p buf.
2738 * The avcodec_encode_video() function encodes a video frame from the input
2739 * \p pict. To encode it, it makes use of the video codec which was coupled with
2740 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2741 * frame are stored in the output buffer \p buf. The input picture should be
2742 * stored using a specific format, namely \c avctx.pix_fmt.
2744 * @param avctx the codec context
2745 * @param[out] buf the output buffer for the bitstream of encoded frame
2746 * @param[in] buf_size the size of the output buffer in bytes
2747 * @param[in] pict the input picture to encode
2748 * @return On error a negative value is returned, on success zero or the number
2749 * of bytes used from the input buffer.
2751 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2752 const AVFrame *pict);
2753 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
2754 const AVSubtitle *sub);
2756 int avcodec_close(AVCodecContext *avctx);
2758 void avcodec_register_all(void);
2761 * Flush buffers, should be called when seeking or when switching to a different stream.
2763 void avcodec_flush_buffers(AVCodecContext *avctx);
2765 void avcodec_default_free_buffers(AVCodecContext *s);
2767 /* misc useful functions */
2770 * Returns a single letter to describe the given picture type \p pict_type.
2772 * @param[in] pict_type the picture type
2773 * @return A single character representing the picture type.
2775 char av_get_pict_type_char(int pict_type);
2778 * Returns codec bits per sample.
2780 * @param[in] codec_id the codec
2781 * @return Number of bits per sample or zero if unknown for the given codec.
2783 int av_get_bits_per_sample(enum CodecID codec_id);
2786 * Returns sample format bits per sample.
2788 * @param[in] sample_fmt the sample format
2789 * @return Number of bits per sample or zero if unknown for the given sample format.
2791 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
2794 typedef struct AVCodecParserContext {
2796 struct AVCodecParser *parser;
2797 int64_t frame_offset; /* offset of the current frame */
2798 int64_t cur_offset; /* current offset
2799 (incremented by each av_parser_parse()) */
2800 int64_t next_frame_offset; /* offset of the next frame */
2802 int pict_type; /* XXX: Put it back in AVCodecContext. */
2803 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
2804 int64_t pts; /* pts of the current frame */
2805 int64_t dts; /* dts of the current frame */
2810 int fetch_timestamp;
2812 #define AV_PARSER_PTS_NB 4
2813 int cur_frame_start_index;
2814 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
2815 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
2816 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
2819 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2821 int64_t offset; ///< byte offset from starting packet start
2822 int64_t cur_frame_end[AV_PARSER_PTS_NB];
2823 } AVCodecParserContext;
2825 typedef struct AVCodecParser {
2826 int codec_ids[5]; /* several codec IDs are permitted */
2828 int (*parser_init)(AVCodecParserContext *s);
2829 int (*parser_parse)(AVCodecParserContext *s,
2830 AVCodecContext *avctx,
2831 const uint8_t **poutbuf, int *poutbuf_size,
2832 const uint8_t *buf, int buf_size);
2833 void (*parser_close)(AVCodecParserContext *s);
2834 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
2835 struct AVCodecParser *next;
2838 AVCodecParser *av_parser_next(AVCodecParser *c);
2840 void av_register_codec_parser(AVCodecParser *parser);
2841 AVCodecParserContext *av_parser_init(int codec_id);
2842 int av_parser_parse(AVCodecParserContext *s,
2843 AVCodecContext *avctx,
2844 uint8_t **poutbuf, int *poutbuf_size,
2845 const uint8_t *buf, int buf_size,
2846 int64_t pts, int64_t dts);
2847 int av_parser_change(AVCodecParserContext *s,
2848 AVCodecContext *avctx,
2849 uint8_t **poutbuf, int *poutbuf_size,
2850 const uint8_t *buf, int buf_size, int keyframe);
2851 void av_parser_close(AVCodecParserContext *s);
2854 typedef struct AVBitStreamFilterContext {
2856 struct AVBitStreamFilter *filter;
2857 AVCodecParserContext *parser;
2858 struct AVBitStreamFilterContext *next;
2859 } AVBitStreamFilterContext;
2862 typedef struct AVBitStreamFilter {
2865 int (*filter)(AVBitStreamFilterContext *bsfc,
2866 AVCodecContext *avctx, const char *args,
2867 uint8_t **poutbuf, int *poutbuf_size,
2868 const uint8_t *buf, int buf_size, int keyframe);
2869 void (*close)(AVBitStreamFilterContext *bsfc);
2870 struct AVBitStreamFilter *next;
2871 } AVBitStreamFilter;
2873 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
2874 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
2875 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
2876 AVCodecContext *avctx, const char *args,
2877 uint8_t **poutbuf, int *poutbuf_size,
2878 const uint8_t *buf, int buf_size, int keyframe);
2879 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
2881 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
2886 * Reallocates the given block if it is not large enough, otherwise it
2891 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
2894 * Copy image 'src' to 'dst'.
2896 void av_picture_copy(AVPicture *dst, const AVPicture *src,
2897 int pix_fmt, int width, int height);
2900 * Crop image top and left side.
2902 int av_picture_crop(AVPicture *dst, const AVPicture *src,
2903 int pix_fmt, int top_band, int left_band);
2908 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
2909 int padtop, int padbottom, int padleft, int padright, int *color);
2911 extern unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
2914 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2916 * @return 0 in case of a successful parsing, a negative value otherwise
2917 * @param[in] str the string to parse: it has to be a string in the format
2918 * <width>x<height> or a valid video frame size abbreviation.
2919 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2921 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2922 * frame height value
2924 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
2927 * Parses \p str and put in \p frame_rate the detected values.
2929 * @return 0 in case of a successful parsing, a negative value otherwise
2930 * @param[in] str the string to parse: it has to be a string in the format
2931 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2932 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2935 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
2938 * Logs a generic warning message about a missing feature.
2939 * @param[in] avc a pointer to an arbitrary struct of which the first field is
2940 * a pointer to an AVClass struct
2941 * @param[in] feature string containing the name of the missing feature
2942 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
2943 * If \p want_sample is non-zero, additional verbage will be added to the log
2944 * message which tells the user how to report samples to the development
2947 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
2949 /* error handling */
2951 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
2952 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
2954 /* Some platforms have E* and errno already negated. */
2955 #define AVERROR(e) (e)
2956 #define AVUNERROR(e) (e)
2958 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
2959 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
2960 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
2961 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
2962 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
2963 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
2964 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
2965 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
2966 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
2968 #endif /* AVCODEC_AVCODEC_H */