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 3
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 CODEC_ID_MPEGVIDEO_VDPAU
,
198 /* various PCM "codecs" */
199 CODEC_ID_PCM_S16LE
= 0x10000,
215 CODEC_ID_PCM_S24DAUD
,
217 CODEC_ID_PCM_S16LE_PLANAR
,
224 /* various ADPCM codecs */
225 CODEC_ID_ADPCM_IMA_QT
= 0x11000,
226 CODEC_ID_ADPCM_IMA_WAV
,
227 CODEC_ID_ADPCM_IMA_DK3
,
228 CODEC_ID_ADPCM_IMA_DK4
,
229 CODEC_ID_ADPCM_IMA_WS
,
230 CODEC_ID_ADPCM_IMA_SMJPEG
,
239 CODEC_ID_ADPCM_YAMAHA
,
240 CODEC_ID_ADPCM_SBPRO_4
,
241 CODEC_ID_ADPCM_SBPRO_3
,
242 CODEC_ID_ADPCM_SBPRO_2
,
244 CODEC_ID_ADPCM_IMA_AMV
,
245 CODEC_ID_ADPCM_EA_R1
,
246 CODEC_ID_ADPCM_EA_R3
,
247 CODEC_ID_ADPCM_EA_R2
,
248 CODEC_ID_ADPCM_IMA_EA_SEAD
,
249 CODEC_ID_ADPCM_IMA_EA_EACS
,
250 CODEC_ID_ADPCM_EA_XAS
,
251 CODEC_ID_ADPCM_EA_MAXIS_XA
,
254 CODEC_ID_AMR_NB
= 0x12000,
257 /* RealAudio codecs*/
258 CODEC_ID_RA_144
= 0x13000,
261 /* various DPCM codecs */
262 CODEC_ID_ROQ_DPCM
= 0x14000,
263 CODEC_ID_INTERPLAY_DPCM
,
268 CODEC_ID_MP2
= 0x15000,
269 CODEC_ID_MP3
, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
287 CODEC_ID_WESTWOOD_SND1
,
288 CODEC_ID_GSM
, ///< as in Berlin toast format
296 CODEC_ID_DSICINAUDIO
,
300 CODEC_ID_GSM_MS
, /* as found in WAV */
309 CODEC_ID_WMALOSSLESS
,
314 /* subtitle codecs */
315 CODEC_ID_DVD_SUBTITLE
= 0x17000,
316 CODEC_ID_DVB_SUBTITLE
,
317 CODEC_ID_TEXT
, ///< raw UTF-8 text
322 /* other specific kind of codecs (generally used for attachments) */
323 CODEC_ID_TTF
= 0x18000,
325 CODEC_ID_PROBE
= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
327 CODEC_ID_MPEG2TS
= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
328 * stream (only used by libavformat) */
332 CODEC_TYPE_UNKNOWN
= -1,
337 CODEC_TYPE_ATTACHMENT
,
342 * all in native-endian format
345 SAMPLE_FMT_NONE
= -1,
346 SAMPLE_FMT_U8
, ///< unsigned 8 bits
347 SAMPLE_FMT_S16
, ///< signed 16 bits
348 SAMPLE_FMT_S32
, ///< signed 32 bits
349 SAMPLE_FMT_FLT
, ///< float
350 SAMPLE_FMT_DBL
, ///< double
351 SAMPLE_FMT_NB
///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
354 /* Audio channel masks */
355 #define CH_FRONT_LEFT 0x00000001
356 #define CH_FRONT_RIGHT 0x00000002
357 #define CH_FRONT_CENTER 0x00000004
358 #define CH_LOW_FREQUENCY 0x00000008
359 #define CH_BACK_LEFT 0x00000010
360 #define CH_BACK_RIGHT 0x00000020
361 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
362 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
363 #define CH_BACK_CENTER 0x00000100
364 #define CH_SIDE_LEFT 0x00000200
365 #define CH_SIDE_RIGHT 0x00000400
366 #define CH_TOP_CENTER 0x00000800
367 #define CH_TOP_FRONT_LEFT 0x00001000
368 #define CH_TOP_FRONT_CENTER 0x00002000
369 #define CH_TOP_FRONT_RIGHT 0x00004000
370 #define CH_TOP_BACK_LEFT 0x00008000
371 #define CH_TOP_BACK_CENTER 0x00010000
372 #define CH_TOP_BACK_RIGHT 0x00020000
373 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
374 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
376 /* Audio channel convenience macros */
377 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
378 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
379 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
380 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
381 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
382 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
383 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
384 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
385 CH_BACK_LEFT|CH_BACK_RIGHT|\
386 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
387 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
390 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
393 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
394 * This is mainly needed because some optimized bitstream readers read
395 * 32 or 64 bit at once and could read over the end.<br>
396 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
397 * MPEG bitstreams could cause overread and segfault.
399 #define FF_INPUT_BUFFER_PADDING_SIZE 8
402 * minimum encoding buffer size
403 * Used to avoid some checks during header writing.
405 #define FF_MIN_BUFFER_SIZE 16384
408 * motion estimation type.
411 ME_ZERO
= 1, ///< no search, that is use 0,0 vector whenever one is needed
415 ME_EPZS
, ///< enhanced predictive zonal search
416 ME_X1
, ///< reserved for experiments
417 ME_HEX
, ///< hexagon based search
418 ME_UMH
, ///< uneven multi-hexagon search
419 ME_ITER
, ///< iterative search
420 ME_TESA
, ///< transformed exhaustive search algorithm
424 /* We leave some space between them for extensions (drop some
425 * keyframes for intra-only or drop just some bidir frames). */
426 AVDISCARD_NONE
=-16, ///< discard nothing
427 AVDISCARD_DEFAULT
= 0, ///< discard useless packets like 0 size packets in avi
428 AVDISCARD_NONREF
= 8, ///< discard all non reference
429 AVDISCARD_BIDIR
= 16, ///< discard all bidirectional frames
430 AVDISCARD_NONKEY
= 32, ///< discard all frames except keyframes
431 AVDISCARD_ALL
= 48, ///< discard all
434 typedef struct RcOverride
{
437 int qscale
; // If this is 0 then quality_factor will be used instead.
438 float quality_factor
;
441 #define FF_MAX_B_FRAMES 16
444 These flags can be passed in AVCodecContext.flags before initialization.
445 Note: Not everything is supported yet.
448 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
449 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
450 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
451 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
452 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
453 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
455 * The parent program guarantees that the input for B-frames containing
456 * streams is not written to for at least s->max_b_frames+1 frames, if
457 * this is not set the input will be copied.
459 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
460 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
461 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
462 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
463 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
464 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
465 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
466 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
467 location instead of only at frame boundaries. */
468 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
469 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
470 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
471 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
472 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
473 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
474 /* Fx : Flag for h263+ extra options */
475 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
476 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
477 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
478 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
479 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
480 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
481 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
482 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
483 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
484 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
485 #define CODEC_FLAG_CLOSED_GOP 0x80000000
486 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
487 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
488 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
489 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
490 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
491 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
492 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
493 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
494 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
495 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
496 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
497 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
498 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
499 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
500 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
501 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
502 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
503 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
505 /* Unsupported options :
506 * Syntax Arithmetic coding (SAC)
507 * Reference Picture Selection
508 * Independent Segment Decoding */
510 /* codec capabilities */
512 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
514 * Codec uses get_buffer() for allocating buffers.
515 * direct rendering method 1
517 #define CODEC_CAP_DR1 0x0002
518 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
519 #define CODEC_CAP_PARSE_ONLY 0x0004
520 #define CODEC_CAP_TRUNCATED 0x0008
521 /* Codec can export data for HW decoding (XvMC). */
522 #define CODEC_CAP_HWACCEL 0x0010
524 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
525 * If this is not set, the codec is guaranteed to never be fed with NULL data.
527 #define CODEC_CAP_DELAY 0x0020
529 * Codec can be fed a final frame with a smaller size.
530 * This can be used to prevent truncation of the last audio samples.
532 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
533 /* Codec can export data for HW decoding (VDPAU). */
534 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
536 //The following defines may change, don't expect compatibility if you use them.
537 #define MB_TYPE_INTRA4x4 0x0001
538 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
539 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
540 #define MB_TYPE_16x16 0x0008
541 #define MB_TYPE_16x8 0x0010
542 #define MB_TYPE_8x16 0x0020
543 #define MB_TYPE_8x8 0x0040
544 #define MB_TYPE_INTERLACED 0x0080
545 #define MB_TYPE_DIRECT2 0x0100 //FIXME
546 #define MB_TYPE_ACPRED 0x0200
547 #define MB_TYPE_GMC 0x0400
548 #define MB_TYPE_SKIP 0x0800
549 #define MB_TYPE_P0L0 0x1000
550 #define MB_TYPE_P1L0 0x2000
551 #define MB_TYPE_P0L1 0x4000
552 #define MB_TYPE_P1L1 0x8000
553 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
554 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
555 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
556 #define MB_TYPE_QUANT 0x00010000
557 #define MB_TYPE_CBP 0x00020000
558 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
562 * This specifies the area which should be displayed.
563 * Note there may be multiple such areas for one frame.
565 typedef struct AVPanScan
{
568 * - encoding: Set by user.
569 * - decoding: Set by libavcodec.
574 * width and height in 1/16 pel
575 * - encoding: Set by user.
576 * - decoding: Set by libavcodec.
582 * position of the top left corner in 1/16 pel for up to 3 fields/frames
583 * - encoding: Set by user.
584 * - decoding: Set by libavcodec.
586 int16_t position
[3][2];
589 #define FF_COMMON_FRAME \
591 * pointer to the picture planes.\
592 * This might be different from the first allocated byte\
599 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
600 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
606 * 1 -> keyframe, 0-> not\
607 * - encoding: Set by libavcodec.\
608 * - decoding: Set by libavcodec.\
613 * Picture type of the frame, see ?_TYPE below.\
614 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
615 * - decoding: Set by libavcodec.\
620 * presentation timestamp in time_base units (time when frame should be shown to user)\
621 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
622 * - encoding: MUST be set by user.\
623 * - decoding: Set by libavcodec.\
628 * picture number in bitstream order\
629 * - encoding: set by\
630 * - decoding: Set by libavcodec.\
632 int coded_picture_number;\
634 * picture number in display order\
635 * - encoding: set by\
636 * - decoding: Set by libavcodec.\
638 int display_picture_number;\
641 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
642 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
643 * - decoding: Set by libavcodec.\
648 * buffer age (1->was last buffer and dint change, 2->..., ...).\
649 * Set to INT_MAX if the buffer has not been used yet.\
650 * - encoding: unused\
651 * - decoding: MUST be set by get_buffer().\
656 * is this picture used as reference\
657 * The values for this are the same as the MpegEncContext.picture_structure\
658 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
659 * - encoding: unused\
660 * - decoding: Set by libavcodec. (before get_buffer() call)).\
666 * - encoding: unused\
667 * - decoding: Set by libavcodec.\
669 int8_t *qscale_table;\
672 * - encoding: unused\
673 * - decoding: Set by libavcodec.\
678 * mbskip_table[mb]>=1 if MB didn't change\
679 * stride= mb_width = (width+15)>>4\
680 * - encoding: unused\
681 * - decoding: Set by libavcodec.\
683 uint8_t *mbskip_table;\
686 * motion vector table\
689 * int mv_sample_log2= 4 - motion_subsample_log2;\
690 * int mb_width= (width+15)>>4;\
691 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
692 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
694 * - encoding: Set by user.\
695 * - decoding: Set by libavcodec.\
697 int16_t (*motion_val[2])[2];\
700 * macroblock type table\
701 * mb_type_base + mb_width + 2\
702 * - encoding: Set by user.\
703 * - decoding: Set by libavcodec.\
708 * log2 of the size of the block which a single vector in motion_val represents: \
709 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
710 * - encoding: unused\
711 * - decoding: Set by libavcodec.\
713 uint8_t motion_subsample_log2;\
716 * for some private data of the user\
717 * - encoding: unused\
718 * - decoding: Set by user.\
724 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
725 * - decoding: unused\
730 * type of the buffer (to keep track of who has to deallocate data[*])\
731 * - encoding: Set by the one who allocates it.\
732 * - decoding: Set by the one who allocates it.\
733 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
738 * When decoding, this signals how much the picture must be delayed.\
739 * extra_delay = repeat_pict / (2*fps)\
740 * - encoding: unused\
741 * - decoding: Set by libavcodec.\
751 * The content of the picture is interlaced.\
752 * - encoding: Set by user.\
753 * - decoding: Set by libavcodec. (default 0)\
755 int interlaced_frame;\
758 * If the content is interlaced, is top field displayed first.\
759 * - encoding: Set by user.\
760 * - decoding: Set by libavcodec.\
762 int top_field_first;\
766 * - encoding: Set by user.\
767 * - decoding: Set by libavcodec.\
769 AVPanScan *pan_scan;\
772 * Tell user application that palette has changed from previous frame.\
773 * - encoding: ??? (no palette-enabled encoder yet)\
774 * - decoding: Set by libavcodec. (default 0).\
776 int palette_has_changed;\
779 * codec suggestion on buffer type if != 0\
780 * - encoding: unused\
781 * - decoding: Set by libavcodec. (before get_buffer() call)).\
787 * - encoding: unused\
788 * - decoding: Set by libavcodec.\
793 * motion referece frame index\
794 * - encoding: Set by user.\
795 * - decoding: Set by libavcodec.\
797 int8_t *ref_index[2];\
800 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
801 * output in AVFrame.reordered_opaque\
802 * - encoding: unused\
803 * - decoding: Read by user.\
805 int64_t reordered_opaque;\
808 #define FF_QSCALE_TYPE_MPEG1 0
809 #define FF_QSCALE_TYPE_MPEG2 1
810 #define FF_QSCALE_TYPE_H264 2
812 #define FF_BUFFER_TYPE_INTERNAL 1
813 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
814 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
815 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
818 #define FF_I_TYPE 1 ///< Intra
819 #define FF_P_TYPE 2 ///< Predicted
820 #define FF_B_TYPE 3 ///< Bi-dir predicted
821 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
822 #define FF_SI_TYPE 5 ///< Switching Intra
823 #define FF_SP_TYPE 6 ///< Switching Predicted
826 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
827 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
828 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
829 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
833 * New fields can be added to the end of FF_COMMON_FRAME with minor version
835 * Removal, reordering and changes to existing fields require a major
836 * version bump. No fields should be added into AVFrame before or after
838 * sizeof(AVFrame) must not be used outside libav*.
840 typedef struct AVFrame
{
845 * main external API structure.
846 * New fields can be added to the end with minor version bumps.
847 * Removal, reordering and changes to existing fields require a major
849 * sizeof(AVCodecContext) must not be used outside libav*.
851 typedef struct AVCodecContext
{
853 * information on struct for av_log
854 * - set by avcodec_alloc_context
856 const AVClass
*av_class
;
858 * the average bitrate
859 * - encoding: Set by user; unused for constant quantizer encoding.
860 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
865 * number of bits the bitstream is allowed to diverge from the reference.
866 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
867 * - encoding: Set by user; unused for constant quantizer encoding.
870 int bit_rate_tolerance
;
874 * - encoding: Set by user.
875 * - decoding: Set by user.
880 * Some codecs need additional format info. It is stored here.
881 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
882 * specific codec MUST set it correctly otherwise stream copy breaks.
883 * In general use of this field by muxers is not recommanded.
884 * - encoding: Set by libavcodec.
885 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
890 * Motion estimation algorithm used for video coding.
891 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
892 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
893 * - encoding: MUST be set by user.
899 * some codecs need / can use extradata like Huffman tables.
900 * mjpeg: Huffman tables
901 * rv10: additional flags
902 * mpeg4: global headers (they can be in the bitstream or here)
903 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
904 * than extradata_size to avoid prolems if it is read with the bitstream reader.
905 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
906 * - encoding: Set/allocated/freed by libavcodec.
907 * - decoding: Set/allocated/freed by user.
913 * This is the fundamental unit of time (in seconds) in terms
914 * of which frame timestamps are represented. For fixed-fps content,
915 * timebase should be 1/framerate and timestamp increments should be
917 * - encoding: MUST be set by user.
918 * - decoding: Set by libavcodec.
920 AVRational time_base
;
924 * picture width / height.
925 * - encoding: MUST be set by user.
926 * - decoding: Set by libavcodec.
927 * Note: For compatibility it is possible to set this instead of
928 * coded_width/height before decoding.
932 #define FF_ASPECT_EXTENDED 15
935 * the number of pictures in a group of pictures, or 0 for intra_only
936 * - encoding: Set by user.
942 * Pixel format, see PIX_FMT_xxx.
943 * - encoding: Set by user.
944 * - decoding: Set by libavcodec.
946 enum PixelFormat pix_fmt
;
949 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
950 * has to read frames at native frame rate.
951 * - encoding: Set by user.
957 * If non NULL, 'draw_horiz_band' is called by the libavcodec
958 * decoder to draw a horizontal band. It improves cache usage. Not
959 * all codecs can do that. You must check the codec capabilities
962 * - decoding: Set by user.
963 * @param height the height of the slice
964 * @param y the y position of the slice
965 * @param type 1->top field, 2->bottom field, 3->frame
966 * @param offset offset into the AVFrame.data from which the slice should be read
968 void (*draw_horiz_band
)(struct AVCodecContext
*s
,
969 const AVFrame
*src
, int offset
[4],
970 int y
, int type
, int height
);
973 int sample_rate
; ///< samples per second
974 int channels
; ///< number of audio channels
977 * audio sample format
978 * - encoding: Set by user.
979 * - decoding: Set by libavcodec.
981 enum SampleFormat sample_fmt
; ///< sample format, currently unused
983 /* The following data should not be initialized. */
985 * Samples per packet, initialized when calling 'init'.
988 int frame_number
; ///< audio or video frame number
989 int real_pict_num
; ///< Returns the real picture number of previous encoded frame.
992 * Number of frames the decoded output will be delayed relative to
994 * - encoding: Set by libavcodec.
999 /* - encoding parameters */
1000 float qcompress
; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1001 float qblur
; ///< amount of qscale smoothing over time (0.0-1.0)
1005 * - encoding: Set by user.
1006 * - decoding: unused
1012 * - encoding: Set by user.
1013 * - decoding: unused
1018 * maximum quantizer difference between frames
1019 * - encoding: Set by user.
1020 * - decoding: unused
1025 * maximum number of B-frames between non-B-frames
1026 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1027 * - encoding: Set by user.
1028 * - decoding: unused
1033 * qscale factor between IP and B-frames
1034 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1035 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1036 * - encoding: Set by user.
1037 * - decoding: unused
1039 float b_quant_factor
;
1041 /** obsolete FIXME remove */
1043 #define FF_RC_STRATEGY_XVID 1
1045 int b_frame_strategy
;
1049 * - encoding: unused
1050 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1051 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1055 struct AVCodec
*codec
;
1059 int rtp_payload_size
; /* The size of the RTP payload: the coder will */
1060 /* do its best to deliver a chunk with size */
1061 /* below rtp_payload_size, the chunk will start */
1062 /* with a start code on some codecs like H.263. */
1063 /* This doesn't take account of any particular */
1064 /* headers inside the transmitted RTP payload. */
1067 /* The RTP callback: This function is called */
1068 /* every time the encoder has a packet to send. */
1069 /* It depends on the encoder if the data starts */
1070 /* with a Start Code (it should). H.263 does. */
1071 /* mb_nb contains the number of macroblocks */
1072 /* encoded in the RTP payload. */
1073 void (*rtp_callback
)(struct AVCodecContext
*avctx
, void *data
, int size
, int mb_nb
);
1075 /* statistics, used for 2-pass encoding */
1086 * number of bits used for the previously encoded frame
1087 * - encoding: Set by libavcodec.
1088 * - decoding: unused
1093 * Private data of the user, can be used to carry app specific stuff.
1094 * - encoding: Set by user.
1095 * - decoding: Set by user.
1099 char codec_name
[32];
1100 enum CodecType codec_type
; /* see CODEC_TYPE_xxx */
1101 enum CodecID codec_id
; /* see CODEC_ID_xxx */
1104 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1105 * This is used to work around some encoder bugs.
1106 * A demuxer should set this to what is stored in the field used to identify the codec.
1107 * If there are multiple such fields in a container then the demuxer should choose the one
1108 * which maximizes the information about the used codec.
1109 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1110 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1111 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1113 * - encoding: Set by user, if not then the default based on codec_id will be used.
1114 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1116 unsigned int codec_tag
;
1119 * Work around bugs in encoders which sometimes cannot be detected automatically.
1120 * - encoding: Set by user
1121 * - decoding: Set by user
1123 int workaround_bugs
;
1124 #define FF_BUG_AUTODETECT 1 ///< autodetection
1125 #define FF_BUG_OLD_MSMPEG4 2
1126 #define FF_BUG_XVID_ILACE 4
1127 #define FF_BUG_UMP4 8
1128 #define FF_BUG_NO_PADDING 16
1129 #define FF_BUG_AMV 32
1130 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1131 #define FF_BUG_QPEL_CHROMA 64
1132 #define FF_BUG_STD_QPEL 128
1133 #define FF_BUG_QPEL_CHROMA2 256
1134 #define FF_BUG_DIRECT_BLOCKSIZE 512
1135 #define FF_BUG_EDGE 1024
1136 #define FF_BUG_HPEL_CHROMA 2048
1137 #define FF_BUG_DC_CLIP 4096
1138 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1139 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1142 * luma single coefficient elimination threshold
1143 * - encoding: Set by user.
1144 * - decoding: unused
1146 int luma_elim_threshold
;
1149 * chroma single coeff elimination threshold
1150 * - encoding: Set by user.
1151 * - decoding: unused
1153 int chroma_elim_threshold
;
1156 * strictly follow the standard (MPEG4, ...).
1157 * - encoding: Set by user.
1158 * - decoding: Set by user.
1159 * Setting this to STRICT or higher means the encoder and decoder will
1160 * generally do stupid things. While setting it to inofficial or lower
1161 * will mean the encoder might use things that are not supported by all
1162 * spec compliant decoders. Decoders make no difference between normal,
1163 * inofficial and experimental, that is they always try to decode things
1164 * when they can unless they are explicitly asked to behave stupid
1165 * (=strictly conform to the specs)
1167 int strict_std_compliance
;
1168 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1169 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1170 #define FF_COMPLIANCE_NORMAL 0
1171 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1172 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1175 * qscale offset between IP and B-frames
1176 * - encoding: Set by user.
1177 * - decoding: unused
1179 float b_quant_offset
;
1182 * Error recognization; higher values will detect more errors but may
1183 * misdetect some more or less valid parts as errors.
1184 * - encoding: unused
1185 * - decoding: Set by user.
1187 int error_recognition
;
1188 #define FF_ER_CAREFUL 1
1189 #define FF_ER_COMPLIANT 2
1190 #define FF_ER_AGGRESSIVE 3
1191 #define FF_ER_VERY_AGGRESSIVE 4
1194 * Called at the beginning of each frame to get a buffer for it.
1195 * If pic.reference is set then the frame will be read later by libavcodec.
1196 * avcodec_align_dimensions() should be used to find the required width and
1197 * height, as they normally need to be rounded up to the next multiple of 16.
1198 * - encoding: unused
1199 * - decoding: Set by libavcodec., user can override.
1201 int (*get_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1204 * Called to release buffers which were allocated with get_buffer.
1205 * A released buffer can be reused in get_buffer().
1206 * pic.data[*] must be set to NULL.
1207 * - encoding: unused
1208 * - decoding: Set by libavcodec., user can override.
1210 void (*release_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1213 * If 1 the stream has a 1 frame delay during decoding.
1214 * - encoding: Set by libavcodec.
1215 * - decoding: Set by libavcodec.
1220 * number of bytes per packet if constant and known or 0
1221 * Used by some WAV based audio codecs.
1225 int parse_only
; /* - decoding only: If true, only parsing is done
1226 (function avcodec_parse_frame()). The frame
1227 data is returned. Only MPEG codecs support this now. */
1230 * 0-> h263 quant 1-> mpeg quant
1231 * - encoding: Set by user.
1232 * - decoding: unused
1237 * pass1 encoding statistics output buffer
1238 * - encoding: Set by libavcodec.
1239 * - decoding: unused
1244 * pass2 encoding statistics input buffer
1245 * Concatenated stuff from stats_out of pass1 should be placed here.
1246 * - encoding: Allocated/set/freed by user.
1247 * - decoding: unused
1252 * ratecontrol qmin qmax limiting method
1253 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1254 * - encoding: Set by user.
1255 * - decoding: unused
1263 * ratecontrol override, see RcOverride
1264 * - encoding: Allocated/set/freed by user.
1265 * - decoding: unused
1267 RcOverride
*rc_override
;
1268 int rc_override_count
;
1271 * rate control equation
1272 * - encoding: Set by user
1273 * - decoding: unused
1279 * - encoding: Set by user.
1280 * - decoding: unused
1286 * - encoding: Set by user.
1287 * - decoding: unused
1292 * decoder bitstream buffer size
1293 * - encoding: Set by user.
1294 * - decoding: unused
1297 float rc_buffer_aggressivity
;
1300 * qscale factor between P and I-frames
1301 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1302 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1303 * - encoding: Set by user.
1304 * - decoding: unused
1306 float i_quant_factor
;
1309 * qscale offset between P and I-frames
1310 * - encoding: Set by user.
1311 * - decoding: unused
1313 float i_quant_offset
;
1316 * initial complexity for pass1 ratecontrol
1317 * - encoding: Set by user.
1318 * - decoding: unused
1320 float rc_initial_cplx
;
1323 * DCT algorithm, see FF_DCT_* below
1324 * - encoding: Set by user.
1325 * - decoding: unused
1328 #define FF_DCT_AUTO 0
1329 #define FF_DCT_FASTINT 1
1330 #define FF_DCT_INT 2
1331 #define FF_DCT_MMX 3
1332 #define FF_DCT_MLIB 4
1333 #define FF_DCT_ALTIVEC 5
1334 #define FF_DCT_FAAN 6
1337 * luminance masking (0-> disabled)
1338 * - encoding: Set by user.
1339 * - decoding: unused
1344 * temporary complexity masking (0-> disabled)
1345 * - encoding: Set by user.
1346 * - decoding: unused
1348 float temporal_cplx_masking
;
1351 * spatial complexity masking (0-> disabled)
1352 * - encoding: Set by user.
1353 * - decoding: unused
1355 float spatial_cplx_masking
;
1358 * p block masking (0-> disabled)
1359 * - encoding: Set by user.
1360 * - decoding: unused
1365 * darkness masking (0-> disabled)
1366 * - encoding: Set by user.
1367 * - decoding: unused
1372 * IDCT algorithm, see FF_IDCT_* below.
1373 * - encoding: Set by user.
1374 * - decoding: Set by user.
1377 #define FF_IDCT_AUTO 0
1378 #define FF_IDCT_INT 1
1379 #define FF_IDCT_SIMPLE 2
1380 #define FF_IDCT_SIMPLEMMX 3
1381 #define FF_IDCT_LIBMPEG2MMX 4
1382 #define FF_IDCT_PS2 5
1383 #define FF_IDCT_MLIB 6
1384 #define FF_IDCT_ARM 7
1385 #define FF_IDCT_ALTIVEC 8
1386 #define FF_IDCT_SH4 9
1387 #define FF_IDCT_SIMPLEARM 10
1388 #define FF_IDCT_H264 11
1389 #define FF_IDCT_VP3 12
1390 #define FF_IDCT_IPP 13
1391 #define FF_IDCT_XVIDMMX 14
1392 #define FF_IDCT_CAVS 15
1393 #define FF_IDCT_SIMPLEARMV5TE 16
1394 #define FF_IDCT_SIMPLEARMV6 17
1395 #define FF_IDCT_SIMPLEVIS 18
1396 #define FF_IDCT_WMV2 19
1397 #define FF_IDCT_FAAN 20
1398 #define FF_IDCT_EA 21
1402 * - encoding: Set by libavcodec.
1403 * - decoding: Set by user (or 0).
1407 * slice offsets in the frame in bytes
1408 * - encoding: Set/allocated by libavcodec.
1409 * - decoding: Set/allocated by user (or NULL).
1414 * error concealment flags
1415 * - encoding: unused
1416 * - decoding: Set by user.
1418 int error_concealment
;
1419 #define FF_EC_GUESS_MVS 1
1420 #define FF_EC_DEBLOCK 2
1423 * dsp_mask could be add used to disable unwanted CPU features
1424 * CPU features (i.e. MMX, SSE. ...)
1426 * With the FORCE flag you may instead enable given CPU features.
1427 * (Dangerous: Usable in case of misdetection, improper usage however will
1428 * result into program crash.)
1431 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1432 /* lower 16 bits - CPU features */
1433 #define FF_MM_MMX 0x0001 ///< standard MMX
1434 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1435 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1436 #define FF_MM_SSE 0x0008 ///< SSE functions
1437 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1438 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1439 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1440 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1441 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1442 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1445 * bits per sample/pixel from the demuxer (needed for huffyuv).
1446 * - encoding: Set by libavcodec.
1447 * - decoding: Set by user.
1449 int bits_per_coded_sample
;
1452 * prediction method (needed for huffyuv)
1453 * - encoding: Set by user.
1454 * - decoding: unused
1456 int prediction_method
;
1457 #define FF_PRED_LEFT 0
1458 #define FF_PRED_PLANE 1
1459 #define FF_PRED_MEDIAN 2
1462 * sample aspect ratio (0 if unknown)
1463 * That is the width of a pixel divided by the height of the pixel.
1464 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1465 * - encoding: Set by user.
1466 * - decoding: Set by libavcodec.
1468 AVRational sample_aspect_ratio
;
1471 * the picture in the bitstream
1472 * - encoding: Set by libavcodec.
1473 * - decoding: Set by libavcodec.
1475 AVFrame
*coded_frame
;
1479 * - encoding: Set by user.
1480 * - decoding: Set by user.
1483 #define FF_DEBUG_PICT_INFO 1
1484 #define FF_DEBUG_RC 2
1485 #define FF_DEBUG_BITSTREAM 4
1486 #define FF_DEBUG_MB_TYPE 8
1487 #define FF_DEBUG_QP 16
1488 #define FF_DEBUG_MV 32
1489 #define FF_DEBUG_DCT_COEFF 0x00000040
1490 #define FF_DEBUG_SKIP 0x00000080
1491 #define FF_DEBUG_STARTCODE 0x00000100
1492 #define FF_DEBUG_PTS 0x00000200
1493 #define FF_DEBUG_ER 0x00000400
1494 #define FF_DEBUG_MMCO 0x00000800
1495 #define FF_DEBUG_BUGS 0x00001000
1496 #define FF_DEBUG_VIS_QP 0x00002000
1497 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1498 #define FF_DEBUG_BUFFERS 0x00008000
1502 * - encoding: Set by user.
1503 * - decoding: Set by user.
1506 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1507 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1508 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1512 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1513 * - decoding: unused
1518 * minimum MB quantizer
1519 * - encoding: unused
1520 * - decoding: unused
1525 * maximum MB quantizer
1526 * - encoding: unused
1527 * - decoding: unused
1532 * motion estimation comparison function
1533 * - encoding: Set by user.
1534 * - decoding: unused
1538 * subpixel motion estimation comparison function
1539 * - encoding: Set by user.
1540 * - decoding: unused
1544 * macroblock comparison function (not supported yet)
1545 * - encoding: Set by user.
1546 * - decoding: unused
1550 * interlaced DCT comparison function
1551 * - encoding: Set by user.
1552 * - decoding: unused
1555 #define FF_CMP_SAD 0
1556 #define FF_CMP_SSE 1
1557 #define FF_CMP_SATD 2
1558 #define FF_CMP_DCT 3
1559 #define FF_CMP_PSNR 4
1560 #define FF_CMP_BIT 5
1562 #define FF_CMP_ZERO 7
1563 #define FF_CMP_VSAD 8
1564 #define FF_CMP_VSSE 9
1565 #define FF_CMP_NSSE 10
1566 #define FF_CMP_W53 11
1567 #define FF_CMP_W97 12
1568 #define FF_CMP_DCTMAX 13
1569 #define FF_CMP_DCT264 14
1570 #define FF_CMP_CHROMA 256
1573 * ME diamond size & shape
1574 * - encoding: Set by user.
1575 * - decoding: unused
1580 * amount of previous MV predictors (2a+1 x 2a+1 square)
1581 * - encoding: Set by user.
1582 * - decoding: unused
1584 int last_predictor_count
;
1587 * prepass for motion estimation
1588 * - encoding: Set by user.
1589 * - decoding: unused
1594 * motion estimation prepass comparison function
1595 * - encoding: Set by user.
1596 * - decoding: unused
1601 * ME prepass diamond size & shape
1602 * - encoding: Set by user.
1603 * - decoding: unused
1609 * - encoding: Set by user.
1610 * - decoding: unused
1612 int me_subpel_quality
;
1615 * callback to negotiate the pixelFormat
1616 * @param fmt is the list of formats which are supported by the codec,
1617 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1618 * The first is always the native one.
1619 * @return the chosen format
1620 * - encoding: unused
1621 * - decoding: Set by user, if not set the native format will be chosen.
1623 enum PixelFormat (*get_format
)(struct AVCodecContext
*s
, const enum PixelFormat
* fmt
);
1626 * DTG active format information (additional aspect ratio
1627 * information only used in DVB MPEG-2 transport streams)
1630 * - encoding: unused
1631 * - decoding: Set by decoder.
1633 int dtg_active_format
;
1634 #define FF_DTG_AFD_SAME 8
1635 #define FF_DTG_AFD_4_3 9
1636 #define FF_DTG_AFD_16_9 10
1637 #define FF_DTG_AFD_14_9 11
1638 #define FF_DTG_AFD_4_3_SP_14_9 13
1639 #define FF_DTG_AFD_16_9_SP_14_9 14
1640 #define FF_DTG_AFD_SP_4_3 15
1643 * maximum motion estimation search range in subpel units
1644 * If 0 then no limit.
1646 * - encoding: Set by user.
1647 * - decoding: unused
1652 * intra quantizer bias
1653 * - encoding: Set by user.
1654 * - decoding: unused
1656 int intra_quant_bias
;
1657 #define FF_DEFAULT_QUANT_BIAS 999999
1660 * inter quantizer bias
1661 * - encoding: Set by user.
1662 * - decoding: unused
1664 int inter_quant_bias
;
1668 * - encoding: unused
1669 * - decoding: Which clrtable should be used for 8bit RGB images.
1670 * Tables have to be stored somewhere. FIXME
1675 * internal_buffer count
1676 * Don't touch, used by libavcodec default_get_buffer().
1678 int internal_buffer_count
;
1682 * Don't touch, used by libavcodec default_get_buffer().
1684 void *internal_buffer
;
1686 #define FF_LAMBDA_SHIFT 7
1687 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1688 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1689 #define FF_LAMBDA_MAX (256*128-1)
1691 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1693 * Global quality for codecs which cannot change it per frame.
1694 * This should be proportional to MPEG-1/2/4 qscale.
1695 * - encoding: Set by user.
1696 * - decoding: unused
1700 #define FF_CODER_TYPE_VLC 0
1701 #define FF_CODER_TYPE_AC 1
1702 #define FF_CODER_TYPE_RAW 2
1703 #define FF_CODER_TYPE_RLE 3
1704 #define FF_CODER_TYPE_DEFLATE 4
1707 * - encoding: Set by user.
1708 * - decoding: unused
1714 * - encoding: Set by user.
1715 * - decoding: unused
1721 * - encoding: unused
1722 * - decoding: Set by user.
1724 uint8_t * (*realloc
)(struct AVCodecContext
*s
, uint8_t *buf
, int buf_size
);
1729 * - encoding: unused
1730 * - decoding: Set by user.
1733 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1734 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1735 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1738 * XVideo Motion Acceleration
1739 * - encoding: forbidden
1740 * - decoding: set by decoder
1742 int xvmc_acceleration
;
1745 * VDPAU Acceleration
1746 * - encoding: forbidden
1747 * - decoding: set by decoder
1749 int vdpau_acceleration
;
1752 * macroblock decision mode
1753 * - encoding: Set by user.
1754 * - decoding: unused
1757 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1758 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1759 #define FF_MB_DECISION_RD 2 ///< rate distortion
1762 * custom intra quantization matrix
1763 * - encoding: Set by user, can be NULL.
1764 * - decoding: Set by libavcodec.
1766 uint16_t *intra_matrix
;
1769 * custom inter quantization matrix
1770 * - encoding: Set by user, can be NULL.
1771 * - decoding: Set by libavcodec.
1773 uint16_t *inter_matrix
;
1776 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1777 * This is used to work around some encoder bugs.
1778 * - encoding: unused
1779 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1781 unsigned int stream_codec_tag
;
1784 * scene change detection threshold
1785 * 0 is default, larger means fewer detected scene changes.
1786 * - encoding: Set by user.
1787 * - decoding: unused
1789 int scenechange_threshold
;
1792 * minimum Lagrange multipler
1793 * - encoding: Set by user.
1794 * - decoding: unused
1799 * maximum Lagrange multipler
1800 * - encoding: Set by user.
1801 * - decoding: unused
1806 * palette control structure
1807 * - encoding: ??? (no palette-enabled encoder yet)
1808 * - decoding: Set by user.
1810 struct AVPaletteControl
*palctrl
;
1813 * noise reduction strength
1814 * - encoding: Set by user.
1815 * - decoding: unused
1817 int noise_reduction
;
1820 * Called at the beginning of a frame to get cr buffer for it.
1821 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1822 * libavcodec will pass previous buffer in pic, function should return
1823 * same buffer or new buffer with old frame "painted" into it.
1824 * If pic.data[0] == NULL must behave like get_buffer().
1825 * - encoding: unused
1826 * - decoding: Set by libavcodec., user can override
1828 int (*reget_buffer
)(struct AVCodecContext
*c
, AVFrame
*pic
);
1831 * Number of bits which should be loaded into the rc buffer before decoding starts.
1832 * - encoding: Set by user.
1833 * - decoding: unused
1835 int rc_initial_buffer_occupancy
;
1839 * - encoding: Set by user.
1840 * - decoding: unused
1842 int inter_threshold
;
1846 * - encoding: Set by user.
1847 * - decoding: Set by user.
1852 * Simulates errors in the bitstream to test error concealment.
1853 * - encoding: Set by user.
1854 * - decoding: unused
1859 * MP3 antialias algorithm, see FF_AA_* below.
1860 * - encoding: unused
1861 * - decoding: Set by user.
1864 #define FF_AA_AUTO 0
1865 #define FF_AA_FASTINT 1 //not implemented yet
1867 #define FF_AA_FLOAT 3
1869 * quantizer noise shaping
1870 * - encoding: Set by user.
1871 * - decoding: unused
1873 int quantizer_noise_shaping
;
1877 * is used to decide how many independent tasks should be passed to execute()
1878 * - encoding: Set by user.
1879 * - decoding: Set by user.
1884 * The codec may call this to execute several independent things.
1885 * It will return only after finishing all tasks.
1886 * The user may replace this with some multithreaded implementation,
1887 * the default implementation will execute the parts serially.
1888 * @param count the number of things to execute
1889 * - encoding: Set by libavcodec, user can override.
1890 * - decoding: Set by libavcodec, user can override.
1892 int (*execute
)(struct AVCodecContext
*c
, int (*func
)(struct AVCodecContext
*c2
, void *arg
), void *arg2
, int *ret
, int count
, int size
);
1896 * Can be used by execute() to store some per AVCodecContext stuff.
1897 * - encoding: set by execute()
1898 * - decoding: set by execute()
1900 void *thread_opaque
;
1903 * Motion estimation threshold below which no motion estimation is
1904 * performed, but instead the user specified motion vectors are used.
1906 * - encoding: Set by user.
1907 * - decoding: unused
1912 * Macroblock threshold below which the user specified macroblock types will be used.
1913 * - encoding: Set by user.
1914 * - decoding: unused
1919 * precision of the intra DC coefficient - 8
1920 * - encoding: Set by user.
1921 * - decoding: unused
1923 int intra_dc_precision
;
1926 * noise vs. sse weight for the nsse comparsion function
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * Number of macroblock rows at the top which are skipped.
1934 * - encoding: unused
1935 * - decoding: Set by user.
1940 * Number of macroblock rows at the bottom which are skipped.
1941 * - encoding: unused
1942 * - decoding: Set by user.
1948 * - encoding: Set by user.
1949 * - decoding: Set by libavcodec.
1952 #define FF_PROFILE_UNKNOWN -99
1953 #define FF_PROFILE_AAC_MAIN 0
1954 #define FF_PROFILE_AAC_LOW 1
1955 #define FF_PROFILE_AAC_SSR 2
1956 #define FF_PROFILE_AAC_LTP 3
1960 * - encoding: Set by user.
1961 * - decoding: Set by libavcodec.
1964 #define FF_LEVEL_UNKNOWN -99
1967 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1968 * - encoding: unused
1969 * - decoding: Set by user.
1974 * Bitstream width / height, may be different from width/height if lowres
1975 * or other things are used.
1976 * - encoding: unused
1977 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1979 int coded_width
, coded_height
;
1982 * frame skip threshold
1983 * - encoding: Set by user.
1984 * - decoding: unused
1986 int frame_skip_threshold
;
1990 * - encoding: Set by user.
1991 * - decoding: unused
1993 int frame_skip_factor
;
1996 * frame skip exponent
1997 * - encoding: Set by user.
1998 * - decoding: unused
2003 * frame skip comparison function
2004 * - encoding: Set by user.
2005 * - decoding: unused
2010 * Border processing masking, raises the quantizer for mbs on the borders
2012 * - encoding: Set by user.
2013 * - decoding: unused
2015 float border_masking
;
2018 * minimum MB lagrange multipler
2019 * - encoding: Set by user.
2020 * - decoding: unused
2025 * maximum MB lagrange multipler
2026 * - encoding: Set by user.
2027 * - decoding: unused
2033 * - encoding: Set by user.
2034 * - decoding: unused
2036 int me_penalty_compensation
;
2040 * - encoding: unused
2041 * - decoding: Set by user.
2043 enum AVDiscard skip_loop_filter
;
2047 * - encoding: unused
2048 * - decoding: Set by user.
2050 enum AVDiscard skip_idct
;
2054 * - encoding: unused
2055 * - decoding: Set by user.
2057 enum AVDiscard skip_frame
;
2061 * - encoding: Set by user.
2062 * - decoding: unused
2068 * - encoding: Set by user.
2069 * - decoding: unused
2074 * constant rate factor - quality-based VBR - values ~correspond to qps
2075 * - encoding: Set by user.
2076 * - decoding: unused
2081 * constant quantization parameter rate control method
2082 * - encoding: Set by user.
2083 * - decoding: unused
2089 * - encoding: Set by user.
2090 * - decoding: unused
2095 * number of reference frames
2096 * - encoding: Set by user.
2097 * - decoding: unused
2102 * chroma qp offset from luma
2103 * - encoding: Set by user.
2104 * - decoding: unused
2109 * Influences how often B-frames are used.
2110 * - encoding: Set by user.
2111 * - decoding: unused
2116 * trellis RD quantization
2117 * - encoding: Set by user.
2118 * - decoding: unused
2123 * Reduce fluctuations in qp (before curve compression).
2124 * - encoding: Set by user.
2125 * - decoding: unused
2127 float complexityblur
;
2130 * in-loop deblocking filter alphac0 parameter
2131 * alpha is in the range -6...6
2132 * - encoding: Set by user.
2133 * - decoding: unused
2138 * in-loop deblocking filter beta parameter
2139 * beta is in the range -6...6
2140 * - encoding: Set by user.
2141 * - decoding: unused
2146 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2147 * - encoding: Set by user.
2148 * - decoding: unused
2151 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2152 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2153 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2154 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2155 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2158 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2159 * - encoding: Set by user.
2160 * - decoding: unused
2165 * Audio cutoff bandwidth (0 means "automatic")
2166 * - encoding: Set by user.
2167 * - decoding: unused
2172 * Multiplied by qscale for each frame and added to scene_change_score.
2173 * - encoding: Set by user.
2174 * - decoding: unused
2176 int scenechange_factor
;
2180 * Note: Value depends upon the compare function used for fullpel ME.
2181 * - encoding: Set by user.
2182 * - decoding: unused
2187 * Adjusts sensitivity of b_frame_strategy 1.
2188 * - encoding: Set by user.
2189 * - decoding: unused
2194 * - encoding: Set by user.
2195 * - decoding: unused
2197 int compression_level
;
2198 #define FF_COMPRESSION_DEFAULT -1
2201 * Sets whether to use LPC mode - used by FLAC encoder.
2202 * - encoding: Set by user.
2203 * - decoding: unused
2208 * LPC coefficient precision - used by FLAC encoder
2209 * - encoding: Set by user.
2210 * - decoding: unused
2212 int lpc_coeff_precision
;
2215 * - encoding: Set by user.
2216 * - decoding: unused
2218 int min_prediction_order
;
2221 * - encoding: Set by user.
2222 * - decoding: unused
2224 int max_prediction_order
;
2227 * search method for selecting prediction order
2228 * - encoding: Set by user.
2229 * - decoding: unused
2231 int prediction_order_method
;
2234 * - encoding: Set by user.
2235 * - decoding: unused
2237 int min_partition_order
;
2240 * - encoding: Set by user.
2241 * - decoding: unused
2243 int max_partition_order
;
2246 * GOP timecode frame start number, in non drop frame format
2247 * - encoding: Set by user.
2248 * - decoding: unused
2250 int64_t timecode_frame_start
;
2252 #if LIBAVCODEC_VERSION_MAJOR < 53
2254 * Decoder should decode to this many channels if it can (0 for default)
2255 * - encoding: unused
2256 * - decoding: Set by user.
2257 * @deprecated Deprecated in favor of request_channel_layout.
2259 int request_channels
;
2263 * Percentage of dynamic range compression to be applied by the decoder.
2264 * The default value is 1.0, corresponding to full compression.
2265 * - encoding: unused
2266 * - decoding: Set by user.
2271 * opaque 64bit number (generally a PTS) that will be reordered and
2272 * output in AVFrame.reordered_opaque
2273 * - encoding: unused
2274 * - decoding: Set by user.
2276 int64_t reordered_opaque
;
2279 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2280 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2281 * - encoding: set by user.
2282 * - decoding: set by libavcodec.
2284 int bits_per_raw_sample
;
2287 * Audio channel layout.
2288 * - encoding: set by user.
2289 * - decoding: set by libavcodec.
2291 int64_t channel_layout
;
2294 * Request decoder to use this channel layout if it can (0 for default)
2295 * - encoding: unused
2296 * - decoding: Set by user.
2298 int64_t request_channel_layout
;
2304 typedef struct AVCodec
{
2306 * Name of the codec implementation.
2307 * The name is globally unique among encoders and among decoders (but an
2308 * encoder and a decoder can share the same name).
2309 * This is the primary way to find a codec from the user perspective.
2312 enum CodecType type
;
2315 int (*init
)(AVCodecContext
*);
2316 int (*encode
)(AVCodecContext
*, uint8_t *buf
, int buf_size
, void *data
);
2317 int (*close
)(AVCodecContext
*);
2318 int (*decode
)(AVCodecContext
*, void *outdata
, int *outdata_size
,
2319 const uint8_t *buf
, int buf_size
);
2321 * Codec capabilities.
2325 struct AVCodec
*next
;
2328 * Will be called when seeking
2330 void (*flush
)(AVCodecContext
*);
2331 const AVRational
*supported_framerates
; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2332 const enum PixelFormat
*pix_fmts
; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2334 * Descriptive name for the codec, meant to be more human readable than \p name.
2335 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2337 const char *long_name
;
2338 const int *supported_samplerates
; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2339 const enum SampleFormat
*sample_fmts
; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2340 const int64_t *channel_layouts
; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2344 * four components are given, that's all.
2345 * the last component is alpha
2347 typedef struct AVPicture
{
2349 int linesize
[4]; ///< number of bytes per line
2354 * This structure defines a method for communicating palette changes
2355 * between and demuxer and a decoder.
2357 * @deprecated Use AVPacket to send palette changes instead.
2358 * This is totally broken.
2360 #define AVPALETTE_SIZE 1024
2361 #define AVPALETTE_COUNT 256
2362 typedef struct AVPaletteControl
{
2364 /* Demuxer sets this to 1 to indicate the palette has changed;
2365 * decoder resets to 0. */
2366 int palette_changed
;
2368 /* 4-byte ARGB palette entries, stored in native byte order; note that
2369 * the individual palette components should be on a 8-bit scale; if
2370 * the palette data comes from an IBM VGA native format, the component
2371 * data is probably 6 bits in size and needs to be scaled. */
2372 unsigned int palette
[AVPALETTE_COUNT
];
2374 } AVPaletteControl attribute_deprecated
;
2376 typedef struct AVSubtitleRect
{
2383 uint32_t *rgba_palette
;
2387 typedef struct AVSubtitle
{
2388 uint16_t format
; /* 0 = graphics */
2389 uint32_t start_display_time
; /* relative to packet pts, in ms */
2390 uint32_t end_display_time
; /* relative to packet pts, in ms */
2392 AVSubtitleRect
*rects
;
2398 struct ReSampleContext
;
2399 struct AVResampleContext
;
2401 typedef struct ReSampleContext ReSampleContext
;
2403 ReSampleContext
*audio_resample_init(int output_channels
, int input_channels
,
2404 int output_rate
, int input_rate
);
2405 int audio_resample(ReSampleContext
*s
, short *output
, short *input
, int nb_samples
);
2406 void audio_resample_close(ReSampleContext
*s
);
2408 struct AVResampleContext
*av_resample_init(int out_rate
, int in_rate
, int filter_length
, int log2_phase_count
, int linear
, double cutoff
);
2409 int av_resample(struct AVResampleContext
*c
, short *dst
, short *src
, int *consumed
, int src_size
, int dst_size
, int update_ctx
);
2410 void av_resample_compensate(struct AVResampleContext
*c
, int sample_delta
, int compensation_distance
);
2411 void av_resample_close(struct AVResampleContext
*c
);
2414 * Allocate memory for a picture. Call avpicture_free to free it.
2416 * @param picture the picture to be filled in
2417 * @param pix_fmt the format of the picture
2418 * @param width the width of the picture
2419 * @param height the height of the picture
2420 * @return zero if successful, a negative value if not
2422 int avpicture_alloc(AVPicture
*picture
, int pix_fmt
, int width
, int height
);
2425 * Free a picture previously allocated by avpicture_alloc().
2427 * @param picture the AVPicture to be freed
2429 void avpicture_free(AVPicture
*picture
);
2432 * Fill in the AVPicture fields.
2433 * The fields of the given AVPicture are filled in by using the 'ptr' address
2434 * which points to the image data buffer. Depending on the specified picture
2435 * format, one or multiple image data pointers and line sizes will be set.
2436 * If a planar format is specified, several pointers will be set pointing to
2437 * the different picture planes and the line sizes of the different planes
2438 * will be stored in the lines_sizes array.
2440 * @param picture AVPicture whose fields are to be filled in
2441 * @param ptr Buffer which will contain or contains the actual image data
2442 * @param pix_fmt The format in which the picture data is stored.
2443 * @param width the width of the image in pixels
2444 * @param height the height of the image in pixels
2445 * @return size of the image data in bytes
2447 int avpicture_fill(AVPicture
*picture
, uint8_t *ptr
,
2448 int pix_fmt
, int width
, int height
);
2449 int avpicture_layout(const AVPicture
* src
, int pix_fmt
, int width
, int height
,
2450 unsigned char *dest
, int dest_size
);
2453 * Calculate the size in bytes that a picture of the given width and height
2454 * would occupy if stored in the given picture format.
2456 * @param pix_fmt the given picture format
2457 * @param width the width of the image
2458 * @param height the height of the image
2459 * @return Image data size in bytes
2461 int avpicture_get_size(int pix_fmt
, int width
, int height
);
2462 void avcodec_get_chroma_sub_sample(int pix_fmt
, int *h_shift
, int *v_shift
);
2463 const char *avcodec_get_pix_fmt_name(int pix_fmt
);
2464 void avcodec_set_dimensions(AVCodecContext
*s
, int width
, int height
);
2465 enum PixelFormat
avcodec_get_pix_fmt(const char* name
);
2466 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p
);
2468 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2469 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2470 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2471 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2472 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2473 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2476 * Computes what kind of losses will occur when converting from one specific
2477 * pixel format to another.
2478 * When converting from one pixel format to another, information loss may occur.
2479 * For example, when converting from RGB24 to GRAY, the color information will
2480 * be lost. Similarly, other losses occur when converting from some formats to
2481 * other formats. These losses can involve loss of chroma, but also loss of
2482 * resolution, loss of color depth, loss due to the color space conversion, loss
2483 * of the alpha bits or loss due to color quantization.
2484 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2485 * which will occur when converting from one pixel format to another.
2487 * @param[in] dst_pix_fmt destination pixel format
2488 * @param[in] src_pix_fmt source pixel format
2489 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2490 * @return Combination of flags informing you what kind of losses will occur.
2492 int avcodec_get_pix_fmt_loss(int dst_pix_fmt
, int src_pix_fmt
,
2496 * Finds the best pixel format to convert to given a certain source pixel
2497 * format. When converting from one pixel format to another, information loss
2498 * may occur. For example, when converting from RGB24 to GRAY, the color
2499 * information will be lost. Similarly, other losses occur when converting from
2500 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2501 * the given pixel formats should be used to suffer the least amount of loss.
2502 * The pixel formats from which it chooses one, are determined by the
2503 * \p pix_fmt_mask parameter.
2506 * src_pix_fmt = PIX_FMT_YUV420P;
2507 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2508 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2511 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2512 * @param[in] src_pix_fmt source pixel format
2513 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2514 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2515 * @return The best pixel format to convert to or -1 if none was found.
2517 int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask
, int src_pix_fmt
,
2518 int has_alpha
, int *loss_ptr
);
2522 * Print in buf the string corresponding to the pixel format with
2523 * number pix_fmt, or an header if pix_fmt is negative.
2525 * @param[in] buf the buffer where to write the string
2526 * @param[in] buf_size the size of buf
2527 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2528 * a negative value to print the corresponding header.
2529 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2531 void avcodec_pix_fmt_string (char *buf
, int buf_size
, int pix_fmt
);
2533 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2534 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2537 * Tell if an image really has transparent alpha values.
2538 * @return ored mask of FF_ALPHA_xxx constants
2540 int img_get_alpha_info(const AVPicture
*src
,
2541 int pix_fmt
, int width
, int height
);
2543 /* deinterlace a picture */
2544 /* deinterlace - if not supported return -1 */
2545 int avpicture_deinterlace(AVPicture
*dst
, const AVPicture
*src
,
2546 int pix_fmt
, int width
, int height
);
2548 /* external high level API */
2550 AVCodec
*av_codec_next(AVCodec
*c
);
2553 * Returns the LIBAVCODEC_VERSION_INT constant.
2555 unsigned avcodec_version(void);
2558 * Initializes libavcodec.
2560 * @warning This function \e must be called before any other libavcodec
2563 void avcodec_init(void);
2565 void register_avcodec(AVCodec
*format
);
2568 * Finds a registered encoder with a matching codec ID.
2570 * @param id CodecID of the requested encoder
2571 * @return An encoder if one was found, NULL otherwise.
2573 AVCodec
*avcodec_find_encoder(enum CodecID id
);
2576 * Finds a registered encoder with the specified name.
2578 * @param name name of the requested encoder
2579 * @return An encoder if one was found, NULL otherwise.
2581 AVCodec
*avcodec_find_encoder_by_name(const char *name
);
2584 * Finds a registered decoder with a matching codec ID.
2586 * @param id CodecID of the requested decoder
2587 * @return A decoder if one was found, NULL otherwise.
2589 AVCodec
*avcodec_find_decoder(enum CodecID id
);
2592 * Finds a registered decoder with the specified name.
2594 * @param name name of the requested decoder
2595 * @return A decoder if one was found, NULL otherwise.
2597 AVCodec
*avcodec_find_decoder_by_name(const char *name
);
2598 void avcodec_string(char *buf
, int buf_size
, AVCodecContext
*enc
, int encode
);
2601 * Sets the fields of the given AVCodecContext to default values.
2603 * @param s The AVCodecContext of which the fields should be set to default values.
2605 void avcodec_get_context_defaults(AVCodecContext
*s
);
2607 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2608 * we WILL change its arguments and name a few times! */
2609 void avcodec_get_context_defaults2(AVCodecContext
*s
, enum CodecType
);
2612 * Allocates an AVCodecContext and sets its fields to default values. The
2613 * resulting struct can be deallocated by simply calling av_free().
2615 * @return An AVCodecContext filled with default values or NULL on failure.
2616 * @see avcodec_get_context_defaults
2618 AVCodecContext
*avcodec_alloc_context(void);
2620 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2621 * we WILL change its arguments and name a few times! */
2622 AVCodecContext
*avcodec_alloc_context2(enum CodecType
);
2625 * Sets the fields of the given AVFrame to default values.
2627 * @param pic The AVFrame of which the fields should be set to default values.
2629 void avcodec_get_frame_defaults(AVFrame
*pic
);
2632 * Allocates an AVFrame and sets its fields to default values. The resulting
2633 * struct can be deallocated by simply calling av_free().
2635 * @return An AVFrame filled with default values or NULL on failure.
2636 * @see avcodec_get_frame_defaults
2638 AVFrame
*avcodec_alloc_frame(void);
2640 int avcodec_default_get_buffer(AVCodecContext
*s
, AVFrame
*pic
);
2641 void avcodec_default_release_buffer(AVCodecContext
*s
, AVFrame
*pic
);
2642 int avcodec_default_reget_buffer(AVCodecContext
*s
, AVFrame
*pic
);
2643 void avcodec_align_dimensions(AVCodecContext
*s
, int *width
, int *height
);
2646 * Checks if the given dimension of a picture is valid, meaning that all
2647 * bytes of the picture can be addressed with a signed int.
2649 * @param[in] w Width of the picture.
2650 * @param[in] h Height of the picture.
2651 * @return Zero if valid, a negative value if invalid.
2653 int avcodec_check_dimensions(void *av_log_ctx
, unsigned int w
, unsigned int h
);
2654 enum PixelFormat
avcodec_default_get_format(struct AVCodecContext
*s
, const enum PixelFormat
* fmt
);
2656 int avcodec_thread_init(AVCodecContext
*s
, int thread_count
);
2657 void avcodec_thread_free(AVCodecContext
*s
);
2658 int avcodec_thread_execute(AVCodecContext
*s
, int (*func
)(AVCodecContext
*c2
, void *arg2
),void *arg
, int *ret
, int count
, int size
);
2659 int avcodec_default_execute(AVCodecContext
*c
, int (*func
)(AVCodecContext
*c2
, void *arg2
),void *arg
, int *ret
, int count
, int size
);
2660 //FIXME func typedef
2663 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2664 * function the context has to be allocated.
2666 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2667 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2668 * retrieving a codec.
2670 * @warning This function is not thread safe!
2673 * avcodec_register_all();
2674 * codec = avcodec_find_decoder(CODEC_ID_H264);
2678 * context = avcodec_alloc_context();
2680 * if (avcodec_open(context, codec) < 0)
2684 * @param avctx The context which will be set up to use the given codec.
2685 * @param codec The codec to use within the context.
2686 * @return zero on success, a negative value on error
2687 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2689 int avcodec_open(AVCodecContext
*avctx
, AVCodec
*codec
);
2692 * Decodes an audio frame from \p buf into \p samples.
2693 * The avcodec_decode_audio2() function decodes an audio frame from the input
2694 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2695 * audio codec which was coupled with \p avctx using avcodec_open(). The
2696 * resulting decoded frame is stored in output buffer \p samples. If no frame
2697 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2698 * decompressed frame size in \e bytes.
2700 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2701 * output buffer before calling avcodec_decode_audio2().
2703 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2704 * the actual read bytes because some optimized bitstream readers read 32 or 64
2705 * bits at once and could read over the end.
2707 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2708 * no overreading happens for damaged MPEG streams.
2710 * @note You might have to align the input buffer \p buf and output buffer \p
2711 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2712 * necessary at all, on others it won't work at all if not aligned and on others
2713 * it will work but it will have an impact on performance. In practice, the
2714 * bitstream should have 4 byte alignment at minimum and all sample data should
2715 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2716 * the linesize is not a multiple of 16 then there's no sense in aligning the
2717 * start of the buffer to 16.
2719 * @param avctx the codec context
2720 * @param[out] samples the output buffer
2721 * @param[in,out] frame_size_ptr the output buffer size in bytes
2722 * @param[in] buf the input buffer
2723 * @param[in] buf_size the input buffer size in bytes
2724 * @return On error a negative value is returned, otherwise the number of bytes
2725 * used or zero if no frame could be decompressed.
2727 int avcodec_decode_audio2(AVCodecContext
*avctx
, int16_t *samples
,
2728 int *frame_size_ptr
,
2729 const uint8_t *buf
, int buf_size
);
2732 * Decodes a video frame from \p buf into \p picture.
2733 * The avcodec_decode_video() function decodes a video frame from the input
2734 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2735 * video codec which was coupled with \p avctx using avcodec_open(). The
2736 * resulting decoded frame is stored in \p picture.
2738 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2739 * the actual read bytes because some optimized bitstream readers read 32 or 64
2740 * bits at once and could read over the end.
2742 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2743 * no overreading happens for damaged MPEG streams.
2745 * @note You might have to align the input buffer \p buf and output buffer \p
2746 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2747 * necessary at all, on others it won't work at all if not aligned and on others
2748 * it will work but it will have an impact on performance. In practice, the
2749 * bitstream should have 4 byte alignment at minimum and all sample data should
2750 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2751 * the linesize is not a multiple of 16 then there's no sense in aligning the
2752 * start of the buffer to 16.
2754 * @param avctx the codec context
2755 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2756 * @param[in] buf the input buffer
2757 * @param[in] buf_size the size of the input buffer in bytes
2758 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2759 * @return On error a negative value is returned, otherwise the number of bytes
2760 * used or zero if no frame could be decompressed.
2762 int avcodec_decode_video(AVCodecContext
*avctx
, AVFrame
*picture
,
2763 int *got_picture_ptr
,
2764 const uint8_t *buf
, int buf_size
);
2766 /* Decode a subtitle message. Return -1 if error, otherwise return the
2767 * number of bytes used. If no subtitle could be decompressed,
2768 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2769 int avcodec_decode_subtitle(AVCodecContext
*avctx
, AVSubtitle
*sub
,
2771 const uint8_t *buf
, int buf_size
);
2772 int avcodec_parse_frame(AVCodecContext
*avctx
, uint8_t **pdata
,
2774 uint8_t *buf
, int buf_size
);
2777 * Encodes an audio frame from \p samples into \p buf.
2778 * The avcodec_encode_audio() function encodes an audio frame from the input
2779 * buffer \p samples. To encode it, it makes use of the audio codec which was
2780 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
2781 * stored in output buffer \p buf.
2783 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
2785 * @param avctx the codec context
2786 * @param[out] buf the output buffer
2787 * @param[in] buf_size the output buffer size
2788 * @param[in] samples the input buffer containing the samples
2789 * The number of samples read from this buffer is frame_size*channels,
2790 * both of which are defined in \p avctx.
2791 * For PCM audio the number of samples read from \p samples is equal to
2792 * \p buf_size * input_sample_size / output_sample_size.
2793 * @return On error a negative value is returned, on success zero or the number
2794 * of bytes used to encode the data read from the input buffer.
2796 int avcodec_encode_audio(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
2797 const short *samples
);
2800 * Encodes a video frame from \p pict into \p buf.
2801 * The avcodec_encode_video() function encodes a video frame from the input
2802 * \p pict. To encode it, it makes use of the video codec which was coupled with
2803 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
2804 * frame are stored in the output buffer \p buf. The input picture should be
2805 * stored using a specific format, namely \c avctx.pix_fmt.
2807 * @param avctx the codec context
2808 * @param[out] buf the output buffer for the bitstream of encoded frame
2809 * @param[in] buf_size the size of the output buffer in bytes
2810 * @param[in] pict the input picture to encode
2811 * @return On error a negative value is returned, on success zero or the number
2812 * of bytes used from the input buffer.
2814 int avcodec_encode_video(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
2815 const AVFrame
*pict
);
2816 int avcodec_encode_subtitle(AVCodecContext
*avctx
, uint8_t *buf
, int buf_size
,
2817 const AVSubtitle
*sub
);
2819 int avcodec_close(AVCodecContext
*avctx
);
2821 void avcodec_register_all(void);
2824 * Flush buffers, should be called when seeking or when switching to a different stream.
2826 void avcodec_flush_buffers(AVCodecContext
*avctx
);
2828 void avcodec_default_free_buffers(AVCodecContext
*s
);
2830 /* misc useful functions */
2833 * Returns a single letter to describe the given picture type \p pict_type.
2835 * @param[in] pict_type the picture type
2836 * @return A single character representing the picture type.
2838 char av_get_pict_type_char(int pict_type
);
2841 * Returns codec bits per sample.
2843 * @param[in] codec_id the codec
2844 * @return Number of bits per sample or zero if unknown for the given codec.
2846 int av_get_bits_per_sample(enum CodecID codec_id
);
2849 * Returns sample format bits per sample.
2851 * @param[in] sample_fmt the sample format
2852 * @return Number of bits per sample or zero if unknown for the given sample format.
2854 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt
);
2857 typedef struct AVCodecParserContext
{
2859 struct AVCodecParser
*parser
;
2860 int64_t frame_offset
; /* offset of the current frame */
2861 int64_t cur_offset
; /* current offset
2862 (incremented by each av_parser_parse()) */
2863 int64_t next_frame_offset
; /* offset of the next frame */
2865 int pict_type
; /* XXX: Put it back in AVCodecContext. */
2866 int repeat_pict
; /* XXX: Put it back in AVCodecContext. */
2867 int64_t pts
; /* pts of the current frame */
2868 int64_t dts
; /* dts of the current frame */
2873 int fetch_timestamp
;
2875 #define AV_PARSER_PTS_NB 4
2876 int cur_frame_start_index
;
2877 int64_t cur_frame_offset
[AV_PARSER_PTS_NB
];
2878 int64_t cur_frame_pts
[AV_PARSER_PTS_NB
];
2879 int64_t cur_frame_dts
[AV_PARSER_PTS_NB
];
2882 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
2884 int64_t offset
; ///< byte offset from starting packet start
2885 int64_t cur_frame_end
[AV_PARSER_PTS_NB
];
2886 } AVCodecParserContext
;
2888 typedef struct AVCodecParser
{
2889 int codec_ids
[5]; /* several codec IDs are permitted */
2891 int (*parser_init
)(AVCodecParserContext
*s
);
2892 int (*parser_parse
)(AVCodecParserContext
*s
,
2893 AVCodecContext
*avctx
,
2894 const uint8_t **poutbuf
, int *poutbuf_size
,
2895 const uint8_t *buf
, int buf_size
);
2896 void (*parser_close
)(AVCodecParserContext
*s
);
2897 int (*split
)(AVCodecContext
*avctx
, const uint8_t *buf
, int buf_size
);
2898 struct AVCodecParser
*next
;
2901 AVCodecParser
*av_parser_next(AVCodecParser
*c
);
2903 void av_register_codec_parser(AVCodecParser
*parser
);
2904 AVCodecParserContext
*av_parser_init(int codec_id
);
2905 int av_parser_parse(AVCodecParserContext
*s
,
2906 AVCodecContext
*avctx
,
2907 uint8_t **poutbuf
, int *poutbuf_size
,
2908 const uint8_t *buf
, int buf_size
,
2909 int64_t pts
, int64_t dts
);
2910 int av_parser_change(AVCodecParserContext
*s
,
2911 AVCodecContext
*avctx
,
2912 uint8_t **poutbuf
, int *poutbuf_size
,
2913 const uint8_t *buf
, int buf_size
, int keyframe
);
2914 void av_parser_close(AVCodecParserContext
*s
);
2917 typedef struct AVBitStreamFilterContext
{
2919 struct AVBitStreamFilter
*filter
;
2920 AVCodecParserContext
*parser
;
2921 struct AVBitStreamFilterContext
*next
;
2922 } AVBitStreamFilterContext
;
2925 typedef struct AVBitStreamFilter
{
2928 int (*filter
)(AVBitStreamFilterContext
*bsfc
,
2929 AVCodecContext
*avctx
, const char *args
,
2930 uint8_t **poutbuf
, int *poutbuf_size
,
2931 const uint8_t *buf
, int buf_size
, int keyframe
);
2932 void (*close
)(AVBitStreamFilterContext
*bsfc
);
2933 struct AVBitStreamFilter
*next
;
2934 } AVBitStreamFilter
;
2936 void av_register_bitstream_filter(AVBitStreamFilter
*bsf
);
2937 AVBitStreamFilterContext
*av_bitstream_filter_init(const char *name
);
2938 int av_bitstream_filter_filter(AVBitStreamFilterContext
*bsfc
,
2939 AVCodecContext
*avctx
, const char *args
,
2940 uint8_t **poutbuf
, int *poutbuf_size
,
2941 const uint8_t *buf
, int buf_size
, int keyframe
);
2942 void av_bitstream_filter_close(AVBitStreamFilterContext
*bsf
);
2944 AVBitStreamFilter
*av_bitstream_filter_next(AVBitStreamFilter
*f
);
2949 * Reallocates the given block if it is not large enough, otherwise it
2954 void *av_fast_realloc(void *ptr
, unsigned int *size
, unsigned int min_size
);
2957 * Copy image 'src' to 'dst'.
2959 void av_picture_copy(AVPicture
*dst
, const AVPicture
*src
,
2960 int pix_fmt
, int width
, int height
);
2963 * Crop image top and left side.
2965 int av_picture_crop(AVPicture
*dst
, const AVPicture
*src
,
2966 int pix_fmt
, int top_band
, int left_band
);
2971 int av_picture_pad(AVPicture
*dst
, const AVPicture
*src
, int height
, int width
, int pix_fmt
,
2972 int padtop
, int padbottom
, int padleft
, int padright
, int *color
);
2974 extern unsigned int av_xiphlacing(unsigned char *s
, unsigned int v
);
2977 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
2979 * @return 0 in case of a successful parsing, a negative value otherwise
2980 * @param[in] str the string to parse: it has to be a string in the format
2981 * <width>x<height> or a valid video frame size abbreviation.
2982 * @param[in,out] width_ptr pointer to the variable which will contain the detected
2984 * @param[in,out] height_ptr pointer to the variable which will contain the detected
2985 * frame height value
2987 int av_parse_video_frame_size(int *width_ptr
, int *height_ptr
, const char *str
);
2990 * Parses \p str and put in \p frame_rate the detected values.
2992 * @return 0 in case of a successful parsing, a negative value otherwise
2993 * @param[in] str the string to parse: it has to be a string in the format
2994 * <frame_rate_nom>/<frame_rate_den>, a float number or a valid video rate abbreviation
2995 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
2998 int av_parse_video_frame_rate(AVRational
*frame_rate
, const char *str
);
3001 * Logs a generic warning message about a missing feature.
3002 * @param[in] avc a pointer to an arbitrary struct of which the first field is
3003 * a pointer to an AVClass struct
3004 * @param[in] feature string containing the name of the missing feature
3005 * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
3006 * If \p want_sample is non-zero, additional verbage will be added to the log
3007 * message which tells the user how to report samples to the development
3010 void av_log_missing_feature(void *avc
, const char *feature
, int want_sample
);
3012 /* error handling */
3014 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3015 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3017 /* Some platforms have E* and errno already negated. */
3018 #define AVERROR(e) (e)
3019 #define AVUNERROR(e) (e)
3021 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3022 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3023 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3024 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3025 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3026 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3027 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3028 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3029 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3031 #endif /* AVCODEC_AVCODEC_H */