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
25 * @file libavcodec/avcodec.h
30 #include "libavutil/avutil.h"
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 21
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,
195 /* various PCM "codecs" */
196 CODEC_ID_PCM_S16LE= 0x10000,
212 CODEC_ID_PCM_S24DAUD,
214 CODEC_ID_PCM_S16LE_PLANAR,
221 /* various ADPCM codecs */
222 CODEC_ID_ADPCM_IMA_QT= 0x11000,
223 CODEC_ID_ADPCM_IMA_WAV,
224 CODEC_ID_ADPCM_IMA_DK3,
225 CODEC_ID_ADPCM_IMA_DK4,
226 CODEC_ID_ADPCM_IMA_WS,
227 CODEC_ID_ADPCM_IMA_SMJPEG,
236 CODEC_ID_ADPCM_YAMAHA,
237 CODEC_ID_ADPCM_SBPRO_4,
238 CODEC_ID_ADPCM_SBPRO_3,
239 CODEC_ID_ADPCM_SBPRO_2,
241 CODEC_ID_ADPCM_IMA_AMV,
242 CODEC_ID_ADPCM_EA_R1,
243 CODEC_ID_ADPCM_EA_R3,
244 CODEC_ID_ADPCM_EA_R2,
245 CODEC_ID_ADPCM_IMA_EA_SEAD,
246 CODEC_ID_ADPCM_IMA_EA_EACS,
247 CODEC_ID_ADPCM_EA_XAS,
248 CODEC_ID_ADPCM_EA_MAXIS_XA,
249 CODEC_ID_ADPCM_IMA_ISS,
252 CODEC_ID_AMR_NB= 0x12000,
255 /* RealAudio codecs*/
256 CODEC_ID_RA_144= 0x13000,
259 /* various DPCM codecs */
260 CODEC_ID_ROQ_DPCM= 0x14000,
261 CODEC_ID_INTERPLAY_DPCM,
266 CODEC_ID_MP2= 0x15000,
267 CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
285 CODEC_ID_WESTWOOD_SND1,
286 CODEC_ID_GSM, ///< as in Berlin toast format
294 CODEC_ID_DSICINAUDIO,
298 CODEC_ID_GSM_MS, /* as found in WAV */
307 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
409 * motion estimation type.
412 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
416 ME_EPZS, ///< enhanced predictive zonal search
417 ME_X1, ///< reserved for experiments
418 ME_HEX, ///< hexagon based search
419 ME_UMH, ///< uneven multi-hexagon search
420 ME_ITER, ///< iterative search
421 ME_TESA, ///< transformed exhaustive search algorithm
425 /* We leave some space between them for extensions (drop some
426 * keyframes for intra-only or drop just some bidir frames). */
427 AVDISCARD_NONE =-16, ///< discard nothing
428 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
429 AVDISCARD_NONREF = 8, ///< discard all non reference
430 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
431 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
432 AVDISCARD_ALL = 48, ///< discard all
435 typedef struct RcOverride{
438 int qscale; // If this is 0 then quality_factor will be used instead.
439 float quality_factor;
442 #define FF_MAX_B_FRAMES 16
445 These flags can be passed in AVCodecContext.flags before initialization.
446 Note: Not everything is supported yet.
449 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
450 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
451 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
452 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
453 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
454 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
456 * The parent program guarantees that the input for B-frames containing
457 * streams is not written to for at least s->max_b_frames+1 frames, if
458 * this is not set the input will be copied.
460 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
461 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
462 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
463 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
464 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
465 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
466 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
467 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
468 location instead of only at frame boundaries. */
469 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
470 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
471 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
472 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
473 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
474 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
475 /* Fx : Flag for h263+ extra options */
476 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
477 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
478 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
479 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
480 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
481 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
482 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
483 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
484 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
485 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
486 #define CODEC_FLAG_CLOSED_GOP 0x80000000
487 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
488 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
489 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
490 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
491 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
492 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
493 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
494 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
495 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
496 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
497 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
498 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
499 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
500 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
501 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
502 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
503 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
504 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
506 /* Unsupported options :
507 * Syntax Arithmetic coding (SAC)
508 * Reference Picture Selection
509 * Independent Segment Decoding */
511 /* codec capabilities */
513 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
515 * Codec uses get_buffer() for allocating buffers.
516 * direct rendering method 1
518 #define CODEC_CAP_DR1 0x0002
519 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
520 #define CODEC_CAP_PARSE_ONLY 0x0004
521 #define CODEC_CAP_TRUNCATED 0x0008
522 /* Codec can export data for HW decoding (XvMC). */
523 #define CODEC_CAP_HWACCEL 0x0010
525 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
526 * If this is not set, the codec is guaranteed to never be fed with NULL data.
528 #define CODEC_CAP_DELAY 0x0020
530 * Codec can be fed a final frame with a smaller size.
531 * This can be used to prevent truncation of the last audio samples.
533 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
535 * Codec can export data for HW decoding (VDPAU).
537 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
539 //The following defines may change, don't expect compatibility if you use them.
540 #define MB_TYPE_INTRA4x4 0x0001
541 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
542 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
543 #define MB_TYPE_16x16 0x0008
544 #define MB_TYPE_16x8 0x0010
545 #define MB_TYPE_8x16 0x0020
546 #define MB_TYPE_8x8 0x0040
547 #define MB_TYPE_INTERLACED 0x0080
548 #define MB_TYPE_DIRECT2 0x0100 //FIXME
549 #define MB_TYPE_ACPRED 0x0200
550 #define MB_TYPE_GMC 0x0400
551 #define MB_TYPE_SKIP 0x0800
552 #define MB_TYPE_P0L0 0x1000
553 #define MB_TYPE_P1L0 0x2000
554 #define MB_TYPE_P0L1 0x4000
555 #define MB_TYPE_P1L1 0x8000
556 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
557 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
558 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
559 #define MB_TYPE_QUANT 0x00010000
560 #define MB_TYPE_CBP 0x00020000
561 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
565 * This specifies the area which should be displayed.
566 * Note there may be multiple such areas for one frame.
568 typedef struct AVPanScan{
571 * - encoding: Set by user.
572 * - decoding: Set by libavcodec.
577 * width and height in 1/16 pel
578 * - encoding: Set by user.
579 * - decoding: Set by libavcodec.
585 * position of the top left corner in 1/16 pel for up to 3 fields/frames
586 * - encoding: Set by user.
587 * - decoding: Set by libavcodec.
589 int16_t position[3][2];
592 #define FF_COMMON_FRAME \
594 * pointer to the picture planes.\
595 * This might be different from the first allocated byte\
602 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
603 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
609 * 1 -> keyframe, 0-> not\
610 * - encoding: Set by libavcodec.\
611 * - decoding: Set by libavcodec.\
616 * Picture type of the frame, see ?_TYPE below.\
617 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
618 * - decoding: Set by libavcodec.\
623 * presentation timestamp in time_base units (time when frame should be shown to user)\
624 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
625 * - encoding: MUST be set by user.\
626 * - decoding: Set by libavcodec.\
631 * picture number in bitstream order\
632 * - encoding: set by\
633 * - decoding: Set by libavcodec.\
635 int coded_picture_number;\
637 * picture number in display order\
638 * - encoding: set by\
639 * - decoding: Set by libavcodec.\
641 int display_picture_number;\
644 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
645 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
646 * - decoding: Set by libavcodec.\
651 * buffer age (1->was last buffer and dint change, 2->..., ...).\
652 * Set to INT_MAX if the buffer has not been used yet.\
653 * - encoding: unused\
654 * - decoding: MUST be set by get_buffer().\
659 * is this picture used as reference\
660 * The values for this are the same as the MpegEncContext.picture_structure\
661 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
662 * Set to 4 for delayed, non-reference frames.\
663 * - encoding: unused\
664 * - decoding: Set by libavcodec. (before get_buffer() call)).\
670 * - encoding: unused\
671 * - decoding: Set by libavcodec.\
673 int8_t *qscale_table;\
676 * - encoding: unused\
677 * - decoding: Set by libavcodec.\
682 * mbskip_table[mb]>=1 if MB didn't change\
683 * stride= mb_width = (width+15)>>4\
684 * - encoding: unused\
685 * - decoding: Set by libavcodec.\
687 uint8_t *mbskip_table;\
690 * motion vector table\
693 * int mv_sample_log2= 4 - motion_subsample_log2;\
694 * int mb_width= (width+15)>>4;\
695 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
696 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
698 * - encoding: Set by user.\
699 * - decoding: Set by libavcodec.\
701 int16_t (*motion_val[2])[2];\
704 * macroblock type table\
705 * mb_type_base + mb_width + 2\
706 * - encoding: Set by user.\
707 * - decoding: Set by libavcodec.\
712 * log2 of the size of the block which a single vector in motion_val represents: \
713 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
714 * - encoding: unused\
715 * - decoding: Set by libavcodec.\
717 uint8_t motion_subsample_log2;\
720 * for some private data of the user\
721 * - encoding: unused\
722 * - decoding: Set by user.\
728 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
729 * - decoding: unused\
734 * type of the buffer (to keep track of who has to deallocate data[*])\
735 * - encoding: Set by the one who allocates it.\
736 * - decoding: Set by the one who allocates it.\
737 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
742 * When decoding, this signals how much the picture must be delayed.\
743 * extra_delay = repeat_pict / (2*fps)\
744 * - encoding: unused\
745 * - decoding: Set by libavcodec.\
755 * The content of the picture is interlaced.\
756 * - encoding: Set by user.\
757 * - decoding: Set by libavcodec. (default 0)\
759 int interlaced_frame;\
762 * If the content is interlaced, is top field displayed first.\
763 * - encoding: Set by user.\
764 * - decoding: Set by libavcodec.\
766 int top_field_first;\
770 * - encoding: Set by user.\
771 * - decoding: Set by libavcodec.\
773 AVPanScan *pan_scan;\
776 * Tell user application that palette has changed from previous frame.\
777 * - encoding: ??? (no palette-enabled encoder yet)\
778 * - decoding: Set by libavcodec. (default 0).\
780 int palette_has_changed;\
783 * codec suggestion on buffer type if != 0\
784 * - encoding: unused\
785 * - decoding: Set by libavcodec. (before get_buffer() call)).\
791 * - encoding: unused\
792 * - decoding: Set by libavcodec.\
797 * motion referece frame index\
798 * - encoding: Set by user.\
799 * - decoding: Set by libavcodec.\
801 int8_t *ref_index[2];\
804 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
805 * output in AVFrame.reordered_opaque\
806 * - encoding: unused\
807 * - decoding: Read by user.\
809 int64_t reordered_opaque;\
812 * hardware accelerator private data (FFmpeg allocated)\
813 * - encoding: unused\
814 * - decoding: Set by libavcodec\
816 void *hwaccel_data_private;\
819 #define FF_QSCALE_TYPE_MPEG1 0
820 #define FF_QSCALE_TYPE_MPEG2 1
821 #define FF_QSCALE_TYPE_H264 2
823 #define FF_BUFFER_TYPE_INTERNAL 1
824 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
825 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
826 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
829 #define FF_I_TYPE 1 ///< Intra
830 #define FF_P_TYPE 2 ///< Predicted
831 #define FF_B_TYPE 3 ///< Bi-dir predicted
832 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
833 #define FF_SI_TYPE 5 ///< Switching Intra
834 #define FF_SP_TYPE 6 ///< Switching Predicted
837 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
838 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
839 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
840 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
844 * New fields can be added to the end of FF_COMMON_FRAME with minor version
846 * Removal, reordering and changes to existing fields require a major
847 * version bump. No fields should be added into AVFrame before or after
849 * sizeof(AVFrame) must not be used outside libav*.
851 typedef struct AVFrame {
856 * main external API structure.
857 * New fields can be added to the end with minor version bumps.
858 * Removal, reordering and changes to existing fields require a major
860 * sizeof(AVCodecContext) must not be used outside libav*.
862 typedef struct AVCodecContext {
864 * information on struct for av_log
865 * - set by avcodec_alloc_context
867 const AVClass *av_class;
869 * the average bitrate
870 * - encoding: Set by user; unused for constant quantizer encoding.
871 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
876 * number of bits the bitstream is allowed to diverge from the reference.
877 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
878 * - encoding: Set by user; unused for constant quantizer encoding.
881 int bit_rate_tolerance;
885 * - encoding: Set by user.
886 * - decoding: Set by user.
891 * Some codecs need additional format info. It is stored here.
892 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
893 * specific codec MUST set it correctly otherwise stream copy breaks.
894 * In general use of this field by muxers is not recommanded.
895 * - encoding: Set by libavcodec.
896 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
901 * Motion estimation algorithm used for video coding.
902 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
903 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
904 * - encoding: MUST be set by user.
910 * some codecs need / can use extradata like Huffman tables.
911 * mjpeg: Huffman tables
912 * rv10: additional flags
913 * mpeg4: global headers (they can be in the bitstream or here)
914 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
915 * than extradata_size to avoid prolems if it is read with the bitstream reader.
916 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
917 * - encoding: Set/allocated/freed by libavcodec.
918 * - decoding: Set/allocated/freed by user.
924 * This is the fundamental unit of time (in seconds) in terms
925 * of which frame timestamps are represented. For fixed-fps content,
926 * timebase should be 1/framerate and timestamp increments should be
928 * - encoding: MUST be set by user.
929 * - decoding: Set by libavcodec.
931 AVRational time_base;
935 * picture width / height.
936 * - encoding: MUST be set by user.
937 * - decoding: Set by libavcodec.
938 * Note: For compatibility it is possible to set this instead of
939 * coded_width/height before decoding.
943 #define FF_ASPECT_EXTENDED 15
946 * the number of pictures in a group of pictures, or 0 for intra_only
947 * - encoding: Set by user.
953 * Pixel format, see PIX_FMT_xxx.
954 * - encoding: Set by user.
955 * - decoding: Set by libavcodec.
957 enum PixelFormat pix_fmt;
960 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
961 * has to read frames at native frame rate.
962 * - encoding: Set by user.
968 * If non NULL, 'draw_horiz_band' is called by the libavcodec
969 * decoder to draw a horizontal band. It improves cache usage. Not
970 * all codecs can do that. You must check the codec capabilities
972 * The function is also used by hardware acceleration APIs.
973 * It is called at least once during frame decoding to pass
974 * the data needed for hardware render.
975 * In that mode instead of pixel data, AVFrame points to
976 * a structure specific to the acceleration API. The application
977 * reads the structure and can change some fields to indicate progress
980 * - decoding: Set by user.
981 * @param height the height of the slice
982 * @param y the y position of the slice
983 * @param type 1->top field, 2->bottom field, 3->frame
984 * @param offset offset into the AVFrame.data from which the slice should be read
986 void (*draw_horiz_band)(struct AVCodecContext *s,
987 const AVFrame *src, int offset[4],
988 int y, int type, int height);
991 int sample_rate; ///< samples per second
992 int channels; ///< number of audio channels
995 * audio sample format
996 * - encoding: Set by user.
997 * - decoding: Set by libavcodec.
999 enum SampleFormat sample_fmt; ///< sample format, currently unused
1001 /* The following data should not be initialized. */
1003 * Samples per packet, initialized when calling 'init'.
1006 int frame_number; ///< audio or video frame number
1007 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1010 * Number of frames the decoded output will be delayed relative to
1011 * the encoded input.
1012 * - encoding: Set by libavcodec.
1013 * - decoding: unused
1017 /* - encoding parameters */
1018 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1019 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1023 * - encoding: Set by user.
1024 * - decoding: unused
1030 * - encoding: Set by user.
1031 * - decoding: unused
1036 * maximum quantizer difference between frames
1037 * - encoding: Set by user.
1038 * - decoding: unused
1043 * maximum number of B-frames between non-B-frames
1044 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1045 * - encoding: Set by user.
1046 * - decoding: unused
1051 * qscale factor between IP and B-frames
1052 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1053 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1054 * - encoding: Set by user.
1055 * - decoding: unused
1057 float b_quant_factor;
1059 /** obsolete FIXME remove */
1061 #define FF_RC_STRATEGY_XVID 1
1063 int b_frame_strategy;
1067 * - encoding: unused
1068 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1069 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1073 struct AVCodec *codec;
1077 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1078 /* do its best to deliver a chunk with size */
1079 /* below rtp_payload_size, the chunk will start */
1080 /* with a start code on some codecs like H.263. */
1081 /* This doesn't take account of any particular */
1082 /* headers inside the transmitted RTP payload. */
1085 /* The RTP callback: This function is called */
1086 /* every time the encoder has a packet to send. */
1087 /* It depends on the encoder if the data starts */
1088 /* with a Start Code (it should). H.263 does. */
1089 /* mb_nb contains the number of macroblocks */
1090 /* encoded in the RTP payload. */
1091 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1093 /* statistics, used for 2-pass encoding */
1104 * number of bits used for the previously encoded frame
1105 * - encoding: Set by libavcodec.
1106 * - decoding: unused
1111 * Private data of the user, can be used to carry app specific stuff.
1112 * - encoding: Set by user.
1113 * - decoding: Set by user.
1117 char codec_name[32];
1118 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1119 enum CodecID codec_id; /* see CODEC_ID_xxx */
1122 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1123 * This is used to work around some encoder bugs.
1124 * A demuxer should set this to what is stored in the field used to identify the codec.
1125 * If there are multiple such fields in a container then the demuxer should choose the one
1126 * which maximizes the information about the used codec.
1127 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1128 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1129 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1131 * - encoding: Set by user, if not then the default based on codec_id will be used.
1132 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1134 unsigned int codec_tag;
1137 * Work around bugs in encoders which sometimes cannot be detected automatically.
1138 * - encoding: Set by user
1139 * - decoding: Set by user
1141 int workaround_bugs;
1142 #define FF_BUG_AUTODETECT 1 ///< autodetection
1143 #define FF_BUG_OLD_MSMPEG4 2
1144 #define FF_BUG_XVID_ILACE 4
1145 #define FF_BUG_UMP4 8
1146 #define FF_BUG_NO_PADDING 16
1147 #define FF_BUG_AMV 32
1148 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1149 #define FF_BUG_QPEL_CHROMA 64
1150 #define FF_BUG_STD_QPEL 128
1151 #define FF_BUG_QPEL_CHROMA2 256
1152 #define FF_BUG_DIRECT_BLOCKSIZE 512
1153 #define FF_BUG_EDGE 1024
1154 #define FF_BUG_HPEL_CHROMA 2048
1155 #define FF_BUG_DC_CLIP 4096
1156 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1157 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1160 * luma single coefficient elimination threshold
1161 * - encoding: Set by user.
1162 * - decoding: unused
1164 int luma_elim_threshold;
1167 * chroma single coeff elimination threshold
1168 * - encoding: Set by user.
1169 * - decoding: unused
1171 int chroma_elim_threshold;
1174 * strictly follow the standard (MPEG4, ...).
1175 * - encoding: Set by user.
1176 * - decoding: Set by user.
1177 * Setting this to STRICT or higher means the encoder and decoder will
1178 * generally do stupid things. While setting it to inofficial or lower
1179 * will mean the encoder might use things that are not supported by all
1180 * spec compliant decoders. Decoders make no difference between normal,
1181 * inofficial and experimental, that is they always try to decode things
1182 * when they can unless they are explicitly asked to behave stupid
1183 * (=strictly conform to the specs)
1185 int strict_std_compliance;
1186 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1187 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1188 #define FF_COMPLIANCE_NORMAL 0
1189 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1190 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1193 * qscale offset between IP and B-frames
1194 * - encoding: Set by user.
1195 * - decoding: unused
1197 float b_quant_offset;
1200 * Error recognization; higher values will detect more errors but may
1201 * misdetect some more or less valid parts as errors.
1202 * - encoding: unused
1203 * - decoding: Set by user.
1205 int error_recognition;
1206 #define FF_ER_CAREFUL 1
1207 #define FF_ER_COMPLIANT 2
1208 #define FF_ER_AGGRESSIVE 3
1209 #define FF_ER_VERY_AGGRESSIVE 4
1212 * Called at the beginning of each frame to get a buffer for it.
1213 * If pic.reference is set then the frame will be read later by libavcodec.
1214 * avcodec_align_dimensions() should be used to find the required width and
1215 * height, as they normally need to be rounded up to the next multiple of 16.
1216 * - encoding: unused
1217 * - decoding: Set by libavcodec., user can override.
1219 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1222 * Called to release buffers which were allocated with get_buffer.
1223 * A released buffer can be reused in get_buffer().
1224 * pic.data[*] must be set to NULL.
1225 * - encoding: unused
1226 * - decoding: Set by libavcodec., user can override.
1228 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1231 * Size of the frame reordering buffer in the decoder.
1232 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1233 * - encoding: Set by libavcodec.
1234 * - decoding: Set by libavcodec.
1239 * number of bytes per packet if constant and known or 0
1240 * Used by some WAV based audio codecs.
1244 int parse_only; /* - decoding only: If true, only parsing is done
1245 (function avcodec_parse_frame()). The frame
1246 data is returned. Only MPEG codecs support this now. */
1249 * 0-> h263 quant 1-> mpeg quant
1250 * - encoding: Set by user.
1251 * - decoding: unused
1256 * pass1 encoding statistics output buffer
1257 * - encoding: Set by libavcodec.
1258 * - decoding: unused
1263 * pass2 encoding statistics input buffer
1264 * Concatenated stuff from stats_out of pass1 should be placed here.
1265 * - encoding: Allocated/set/freed by user.
1266 * - decoding: unused
1271 * ratecontrol qmin qmax limiting method
1272 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1273 * - encoding: Set by user.
1274 * - decoding: unused
1282 * ratecontrol override, see RcOverride
1283 * - encoding: Allocated/set/freed by user.
1284 * - decoding: unused
1286 RcOverride *rc_override;
1287 int rc_override_count;
1290 * rate control equation
1291 * - encoding: Set by user
1292 * - decoding: unused
1298 * - encoding: Set by user.
1299 * - decoding: unused
1305 * - encoding: Set by user.
1306 * - decoding: unused
1311 * decoder bitstream buffer size
1312 * - encoding: Set by user.
1313 * - decoding: unused
1316 float rc_buffer_aggressivity;
1319 * qscale factor between P and I-frames
1320 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1321 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1322 * - encoding: Set by user.
1323 * - decoding: unused
1325 float i_quant_factor;
1328 * qscale offset between P and I-frames
1329 * - encoding: Set by user.
1330 * - decoding: unused
1332 float i_quant_offset;
1335 * initial complexity for pass1 ratecontrol
1336 * - encoding: Set by user.
1337 * - decoding: unused
1339 float rc_initial_cplx;
1342 * DCT algorithm, see FF_DCT_* below
1343 * - encoding: Set by user.
1344 * - decoding: unused
1347 #define FF_DCT_AUTO 0
1348 #define FF_DCT_FASTINT 1
1349 #define FF_DCT_INT 2
1350 #define FF_DCT_MMX 3
1351 #define FF_DCT_MLIB 4
1352 #define FF_DCT_ALTIVEC 5
1353 #define FF_DCT_FAAN 6
1356 * luminance masking (0-> disabled)
1357 * - encoding: Set by user.
1358 * - decoding: unused
1363 * temporary complexity masking (0-> disabled)
1364 * - encoding: Set by user.
1365 * - decoding: unused
1367 float temporal_cplx_masking;
1370 * spatial complexity masking (0-> disabled)
1371 * - encoding: Set by user.
1372 * - decoding: unused
1374 float spatial_cplx_masking;
1377 * p block masking (0-> disabled)
1378 * - encoding: Set by user.
1379 * - decoding: unused
1384 * darkness masking (0-> disabled)
1385 * - encoding: Set by user.
1386 * - decoding: unused
1391 * IDCT algorithm, see FF_IDCT_* below.
1392 * - encoding: Set by user.
1393 * - decoding: Set by user.
1396 #define FF_IDCT_AUTO 0
1397 #define FF_IDCT_INT 1
1398 #define FF_IDCT_SIMPLE 2
1399 #define FF_IDCT_SIMPLEMMX 3
1400 #define FF_IDCT_LIBMPEG2MMX 4
1401 #define FF_IDCT_PS2 5
1402 #define FF_IDCT_MLIB 6
1403 #define FF_IDCT_ARM 7
1404 #define FF_IDCT_ALTIVEC 8
1405 #define FF_IDCT_SH4 9
1406 #define FF_IDCT_SIMPLEARM 10
1407 #define FF_IDCT_H264 11
1408 #define FF_IDCT_VP3 12
1409 #define FF_IDCT_IPP 13
1410 #define FF_IDCT_XVIDMMX 14
1411 #define FF_IDCT_CAVS 15
1412 #define FF_IDCT_SIMPLEARMV5TE 16
1413 #define FF_IDCT_SIMPLEARMV6 17
1414 #define FF_IDCT_SIMPLEVIS 18
1415 #define FF_IDCT_WMV2 19
1416 #define FF_IDCT_FAAN 20
1417 #define FF_IDCT_EA 21
1418 #define FF_IDCT_SIMPLENEON 22
1419 #define FF_IDCT_SIMPLEALPHA 23
1423 * - encoding: Set by libavcodec.
1424 * - decoding: Set by user (or 0).
1428 * slice offsets in the frame in bytes
1429 * - encoding: Set/allocated by libavcodec.
1430 * - decoding: Set/allocated by user (or NULL).
1435 * error concealment flags
1436 * - encoding: unused
1437 * - decoding: Set by user.
1439 int error_concealment;
1440 #define FF_EC_GUESS_MVS 1
1441 #define FF_EC_DEBLOCK 2
1444 * dsp_mask could be add used to disable unwanted CPU features
1445 * CPU features (i.e. MMX, SSE. ...)
1447 * With the FORCE flag you may instead enable given CPU features.
1448 * (Dangerous: Usable in case of misdetection, improper usage however will
1449 * result into program crash.)
1452 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1453 /* lower 16 bits - CPU features */
1454 #define FF_MM_MMX 0x0001 ///< standard MMX
1455 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1456 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1457 #define FF_MM_SSE 0x0008 ///< SSE functions
1458 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1459 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1460 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1461 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1462 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1463 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1466 * bits per sample/pixel from the demuxer (needed for huffyuv).
1467 * - encoding: Set by libavcodec.
1468 * - decoding: Set by user.
1470 int bits_per_coded_sample;
1473 * prediction method (needed for huffyuv)
1474 * - encoding: Set by user.
1475 * - decoding: unused
1477 int prediction_method;
1478 #define FF_PRED_LEFT 0
1479 #define FF_PRED_PLANE 1
1480 #define FF_PRED_MEDIAN 2
1483 * sample aspect ratio (0 if unknown)
1484 * That is the width of a pixel divided by the height of the pixel.
1485 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1486 * - encoding: Set by user.
1487 * - decoding: Set by libavcodec.
1489 AVRational sample_aspect_ratio;
1492 * the picture in the bitstream
1493 * - encoding: Set by libavcodec.
1494 * - decoding: Set by libavcodec.
1496 AVFrame *coded_frame;
1500 * - encoding: Set by user.
1501 * - decoding: Set by user.
1504 #define FF_DEBUG_PICT_INFO 1
1505 #define FF_DEBUG_RC 2
1506 #define FF_DEBUG_BITSTREAM 4
1507 #define FF_DEBUG_MB_TYPE 8
1508 #define FF_DEBUG_QP 16
1509 #define FF_DEBUG_MV 32
1510 #define FF_DEBUG_DCT_COEFF 0x00000040
1511 #define FF_DEBUG_SKIP 0x00000080
1512 #define FF_DEBUG_STARTCODE 0x00000100
1513 #define FF_DEBUG_PTS 0x00000200
1514 #define FF_DEBUG_ER 0x00000400
1515 #define FF_DEBUG_MMCO 0x00000800
1516 #define FF_DEBUG_BUGS 0x00001000
1517 #define FF_DEBUG_VIS_QP 0x00002000
1518 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1519 #define FF_DEBUG_BUFFERS 0x00008000
1523 * - encoding: Set by user.
1524 * - decoding: Set by user.
1527 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1528 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1529 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1533 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1534 * - decoding: unused
1539 * minimum MB quantizer
1540 * - encoding: unused
1541 * - decoding: unused
1546 * maximum MB quantizer
1547 * - encoding: unused
1548 * - decoding: unused
1553 * motion estimation comparison function
1554 * - encoding: Set by user.
1555 * - decoding: unused
1559 * subpixel motion estimation comparison function
1560 * - encoding: Set by user.
1561 * - decoding: unused
1565 * macroblock comparison function (not supported yet)
1566 * - encoding: Set by user.
1567 * - decoding: unused
1571 * interlaced DCT comparison function
1572 * - encoding: Set by user.
1573 * - decoding: unused
1576 #define FF_CMP_SAD 0
1577 #define FF_CMP_SSE 1
1578 #define FF_CMP_SATD 2
1579 #define FF_CMP_DCT 3
1580 #define FF_CMP_PSNR 4
1581 #define FF_CMP_BIT 5
1583 #define FF_CMP_ZERO 7
1584 #define FF_CMP_VSAD 8
1585 #define FF_CMP_VSSE 9
1586 #define FF_CMP_NSSE 10
1587 #define FF_CMP_W53 11
1588 #define FF_CMP_W97 12
1589 #define FF_CMP_DCTMAX 13
1590 #define FF_CMP_DCT264 14
1591 #define FF_CMP_CHROMA 256
1594 * ME diamond size & shape
1595 * - encoding: Set by user.
1596 * - decoding: unused
1601 * amount of previous MV predictors (2a+1 x 2a+1 square)
1602 * - encoding: Set by user.
1603 * - decoding: unused
1605 int last_predictor_count;
1608 * prepass for motion estimation
1609 * - encoding: Set by user.
1610 * - decoding: unused
1615 * motion estimation prepass comparison function
1616 * - encoding: Set by user.
1617 * - decoding: unused
1622 * ME prepass diamond size & shape
1623 * - encoding: Set by user.
1624 * - decoding: unused
1630 * - encoding: Set by user.
1631 * - decoding: unused
1633 int me_subpel_quality;
1636 * callback to negotiate the pixelFormat
1637 * @param fmt is the list of formats which are supported by the codec,
1638 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1639 * The first is always the native one.
1640 * @return the chosen format
1641 * - encoding: unused
1642 * - decoding: Set by user, if not set the native format will be chosen.
1644 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1647 * DTG active format information (additional aspect ratio
1648 * information only used in DVB MPEG-2 transport streams)
1651 * - encoding: unused
1652 * - decoding: Set by decoder.
1654 int dtg_active_format;
1655 #define FF_DTG_AFD_SAME 8
1656 #define FF_DTG_AFD_4_3 9
1657 #define FF_DTG_AFD_16_9 10
1658 #define FF_DTG_AFD_14_9 11
1659 #define FF_DTG_AFD_4_3_SP_14_9 13
1660 #define FF_DTG_AFD_16_9_SP_14_9 14
1661 #define FF_DTG_AFD_SP_4_3 15
1664 * maximum motion estimation search range in subpel units
1665 * If 0 then no limit.
1667 * - encoding: Set by user.
1668 * - decoding: unused
1673 * intra quantizer bias
1674 * - encoding: Set by user.
1675 * - decoding: unused
1677 int intra_quant_bias;
1678 #define FF_DEFAULT_QUANT_BIAS 999999
1681 * inter quantizer bias
1682 * - encoding: Set by user.
1683 * - decoding: unused
1685 int inter_quant_bias;
1689 * - encoding: unused
1690 * - decoding: Which clrtable should be used for 8bit RGB images.
1691 * Tables have to be stored somewhere. FIXME
1696 * internal_buffer count
1697 * Don't touch, used by libavcodec default_get_buffer().
1699 int internal_buffer_count;
1703 * Don't touch, used by libavcodec default_get_buffer().
1705 void *internal_buffer;
1707 #define FF_LAMBDA_SHIFT 7
1708 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1709 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1710 #define FF_LAMBDA_MAX (256*128-1)
1712 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1714 * Global quality for codecs which cannot change it per frame.
1715 * This should be proportional to MPEG-1/2/4 qscale.
1716 * - encoding: Set by user.
1717 * - decoding: unused
1721 #define FF_CODER_TYPE_VLC 0
1722 #define FF_CODER_TYPE_AC 1
1723 #define FF_CODER_TYPE_RAW 2
1724 #define FF_CODER_TYPE_RLE 3
1725 #define FF_CODER_TYPE_DEFLATE 4
1728 * - encoding: Set by user.
1729 * - decoding: unused
1735 * - encoding: Set by user.
1736 * - decoding: unused
1742 * - encoding: unused
1743 * - decoding: Set by user.
1745 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1750 * - encoding: unused
1751 * - decoding: Set by user.
1754 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1755 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1756 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1759 * XVideo Motion Acceleration
1760 * - encoding: forbidden
1761 * - decoding: set by decoder
1763 int xvmc_acceleration;
1766 * macroblock decision mode
1767 * - encoding: Set by user.
1768 * - decoding: unused
1771 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1772 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1773 #define FF_MB_DECISION_RD 2 ///< rate distortion
1776 * custom intra quantization matrix
1777 * - encoding: Set by user, can be NULL.
1778 * - decoding: Set by libavcodec.
1780 uint16_t *intra_matrix;
1783 * custom inter quantization matrix
1784 * - encoding: Set by user, can be NULL.
1785 * - decoding: Set by libavcodec.
1787 uint16_t *inter_matrix;
1790 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1791 * This is used to work around some encoder bugs.
1792 * - encoding: unused
1793 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1795 unsigned int stream_codec_tag;
1798 * scene change detection threshold
1799 * 0 is default, larger means fewer detected scene changes.
1800 * - encoding: Set by user.
1801 * - decoding: unused
1803 int scenechange_threshold;
1806 * minimum Lagrange multipler
1807 * - encoding: Set by user.
1808 * - decoding: unused
1813 * maximum Lagrange multipler
1814 * - encoding: Set by user.
1815 * - decoding: unused
1820 * palette control structure
1821 * - encoding: ??? (no palette-enabled encoder yet)
1822 * - decoding: Set by user.
1824 struct AVPaletteControl *palctrl;
1827 * noise reduction strength
1828 * - encoding: Set by user.
1829 * - decoding: unused
1831 int noise_reduction;
1834 * Called at the beginning of a frame to get cr buffer for it.
1835 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1836 * libavcodec will pass previous buffer in pic, function should return
1837 * same buffer or new buffer with old frame "painted" into it.
1838 * If pic.data[0] == NULL must behave like get_buffer().
1839 * - encoding: unused
1840 * - decoding: Set by libavcodec., user can override
1842 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1845 * Number of bits which should be loaded into the rc buffer before decoding starts.
1846 * - encoding: Set by user.
1847 * - decoding: unused
1849 int rc_initial_buffer_occupancy;
1853 * - encoding: Set by user.
1854 * - decoding: unused
1856 int inter_threshold;
1860 * - encoding: Set by user.
1861 * - decoding: Set by user.
1866 * Simulates errors in the bitstream to test error concealment.
1867 * - encoding: Set by user.
1868 * - decoding: unused
1873 * MP3 antialias algorithm, see FF_AA_* below.
1874 * - encoding: unused
1875 * - decoding: Set by user.
1878 #define FF_AA_AUTO 0
1879 #define FF_AA_FASTINT 1 //not implemented yet
1881 #define FF_AA_FLOAT 3
1883 * quantizer noise shaping
1884 * - encoding: Set by user.
1885 * - decoding: unused
1887 int quantizer_noise_shaping;
1891 * is used to decide how many independent tasks should be passed to execute()
1892 * - encoding: Set by user.
1893 * - decoding: Set by user.
1898 * The codec may call this to execute several independent things.
1899 * It will return only after finishing all tasks.
1900 * The user may replace this with some multithreaded implementation,
1901 * the default implementation will execute the parts serially.
1902 * @param count the number of things to execute
1903 * - encoding: Set by libavcodec, user can override.
1904 * - decoding: Set by libavcodec, user can override.
1906 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1910 * Can be used by execute() to store some per AVCodecContext stuff.
1911 * - encoding: set by execute()
1912 * - decoding: set by execute()
1914 void *thread_opaque;
1917 * Motion estimation threshold below which no motion estimation is
1918 * performed, but instead the user specified motion vectors are used.
1920 * - encoding: Set by user.
1921 * - decoding: unused
1926 * Macroblock threshold below which the user specified macroblock types will be used.
1927 * - encoding: Set by user.
1928 * - decoding: unused
1933 * precision of the intra DC coefficient - 8
1934 * - encoding: Set by user.
1935 * - decoding: unused
1937 int intra_dc_precision;
1940 * noise vs. sse weight for the nsse comparsion function
1941 * - encoding: Set by user.
1942 * - decoding: unused
1947 * Number of macroblock rows at the top which are skipped.
1948 * - encoding: unused
1949 * - decoding: Set by user.
1954 * Number of macroblock rows at the bottom which are skipped.
1955 * - encoding: unused
1956 * - decoding: Set by user.
1962 * - encoding: Set by user.
1963 * - decoding: Set by libavcodec.
1966 #define FF_PROFILE_UNKNOWN -99
1967 #define FF_PROFILE_AAC_MAIN 0
1968 #define FF_PROFILE_AAC_LOW 1
1969 #define FF_PROFILE_AAC_SSR 2
1970 #define FF_PROFILE_AAC_LTP 3
1974 * - encoding: Set by user.
1975 * - decoding: Set by libavcodec.
1978 #define FF_LEVEL_UNKNOWN -99
1981 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1982 * - encoding: unused
1983 * - decoding: Set by user.
1988 * Bitstream width / height, may be different from width/height if lowres
1989 * or other things are used.
1990 * - encoding: unused
1991 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1993 int coded_width, coded_height;
1996 * frame skip threshold
1997 * - encoding: Set by user.
1998 * - decoding: unused
2000 int frame_skip_threshold;
2004 * - encoding: Set by user.
2005 * - decoding: unused
2007 int frame_skip_factor;
2010 * frame skip exponent
2011 * - encoding: Set by user.
2012 * - decoding: unused
2017 * frame skip comparison function
2018 * - encoding: Set by user.
2019 * - decoding: unused
2024 * Border processing masking, raises the quantizer for mbs on the borders
2026 * - encoding: Set by user.
2027 * - decoding: unused
2029 float border_masking;
2032 * minimum MB lagrange multipler
2033 * - encoding: Set by user.
2034 * - decoding: unused
2039 * maximum MB lagrange multipler
2040 * - encoding: Set by user.
2041 * - decoding: unused
2047 * - encoding: Set by user.
2048 * - decoding: unused
2050 int me_penalty_compensation;
2054 * - encoding: unused
2055 * - decoding: Set by user.
2057 enum AVDiscard skip_loop_filter;
2061 * - encoding: unused
2062 * - decoding: Set by user.
2064 enum AVDiscard skip_idct;
2068 * - encoding: unused
2069 * - decoding: Set by user.
2071 enum AVDiscard skip_frame;
2075 * - encoding: Set by user.
2076 * - decoding: unused
2082 * - encoding: Set by user.
2083 * - decoding: unused
2088 * constant rate factor - quality-based VBR - values ~correspond to qps
2089 * - encoding: Set by user.
2090 * - decoding: unused
2095 * constant quantization parameter rate control method
2096 * - encoding: Set by user.
2097 * - decoding: unused
2103 * - encoding: Set by user.
2104 * - decoding: unused
2109 * number of reference frames
2110 * - encoding: Set by user.
2111 * - decoding: Set by lavc.
2116 * chroma qp offset from luma
2117 * - encoding: Set by user.
2118 * - decoding: unused
2123 * Influences how often B-frames are used.
2124 * - encoding: Set by user.
2125 * - decoding: unused
2130 * trellis RD quantization
2131 * - encoding: Set by user.
2132 * - decoding: unused
2137 * Reduce fluctuations in qp (before curve compression).
2138 * - encoding: Set by user.
2139 * - decoding: unused
2141 float complexityblur;
2144 * in-loop deblocking filter alphac0 parameter
2145 * alpha is in the range -6...6
2146 * - encoding: Set by user.
2147 * - decoding: unused
2152 * in-loop deblocking filter beta parameter
2153 * beta is in the range -6...6
2154 * - encoding: Set by user.
2155 * - decoding: unused
2160 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2161 * - encoding: Set by user.
2162 * - decoding: unused
2165 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2166 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2167 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2168 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2169 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2172 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2173 * - encoding: Set by user.
2174 * - decoding: unused
2179 * Audio cutoff bandwidth (0 means "automatic")
2180 * - encoding: Set by user.
2181 * - decoding: unused
2186 * Multiplied by qscale for each frame and added to scene_change_score.
2187 * - encoding: Set by user.
2188 * - decoding: unused
2190 int scenechange_factor;
2194 * Note: Value depends upon the compare function used for fullpel ME.
2195 * - encoding: Set by user.
2196 * - decoding: unused
2201 * Adjusts sensitivity of b_frame_strategy 1.
2202 * - encoding: Set by user.
2203 * - decoding: unused
2208 * - encoding: Set by user.
2209 * - decoding: unused
2211 int compression_level;
2212 #define FF_COMPRESSION_DEFAULT -1
2215 * Sets whether to use LPC mode - used by FLAC encoder.
2216 * - encoding: Set by user.
2217 * - decoding: unused
2222 * LPC coefficient precision - used by FLAC encoder
2223 * - encoding: Set by user.
2224 * - decoding: unused
2226 int lpc_coeff_precision;
2229 * - encoding: Set by user.
2230 * - decoding: unused
2232 int min_prediction_order;
2235 * - encoding: Set by user.
2236 * - decoding: unused
2238 int max_prediction_order;
2241 * search method for selecting prediction order
2242 * - encoding: Set by user.
2243 * - decoding: unused
2245 int prediction_order_method;
2248 * - encoding: Set by user.
2249 * - decoding: unused
2251 int min_partition_order;
2254 * - encoding: Set by user.
2255 * - decoding: unused
2257 int max_partition_order;
2260 * GOP timecode frame start number, in non drop frame format
2261 * - encoding: Set by user.
2262 * - decoding: unused
2264 int64_t timecode_frame_start;
2266 #if LIBAVCODEC_VERSION_MAJOR < 53
2268 * Decoder should decode to this many channels if it can (0 for default)
2269 * - encoding: unused
2270 * - decoding: Set by user.
2271 * @deprecated Deprecated in favor of request_channel_layout.
2273 int request_channels;
2277 * Percentage of dynamic range compression to be applied by the decoder.
2278 * The default value is 1.0, corresponding to full compression.
2279 * - encoding: unused
2280 * - decoding: Set by user.
2285 * opaque 64bit number (generally a PTS) that will be reordered and
2286 * output in AVFrame.reordered_opaque
2287 * - encoding: unused
2288 * - decoding: Set by user.
2290 int64_t reordered_opaque;
2293 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2294 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2295 * - encoding: set by user.
2296 * - decoding: set by libavcodec.
2298 int bits_per_raw_sample;
2301 * Audio channel layout.
2302 * - encoding: set by user.
2303 * - decoding: set by libavcodec.
2305 int64_t channel_layout;
2308 * Request decoder to use this channel layout if it can (0 for default)
2309 * - encoding: unused
2310 * - decoding: Set by user.
2312 int64_t request_channel_layout;
2315 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2316 * - encoding: Set by user.
2317 * - decoding: unused.
2319 float rc_max_available_vbv_use;
2322 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2323 * - encoding: Set by user.
2324 * - decoding: unused.
2326 float rc_min_vbv_overflow_use;
2329 * Hardware accelerator in use
2330 * - encoding: unused.
2331 * - decoding: Set by libavcodec
2333 struct AVHWAccel *hwaccel;
2336 * For some codecs, the time base is closer to the field rate than the frame rate.
2337 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2338 * if no telecine is used ...
2340 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2342 int ticks_per_frame;
2348 typedef struct AVCodec {
2350 * Name of the codec implementation.
2351 * The name is globally unique among encoders and among decoders (but an
2352 * encoder and a decoder can share the same name).
2353 * This is the primary way to find a codec from the user perspective.
2356 enum CodecType type;
2359 int (*init)(AVCodecContext *);
2360 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2361 int (*close)(AVCodecContext *);
2362 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2363 const uint8_t *buf, int buf_size);
2365 * Codec capabilities.
2369 struct AVCodec *next;
2372 * Will be called when seeking
2374 void (*flush)(AVCodecContext *);
2375 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2376 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2378 * Descriptive name for the codec, meant to be more human readable than \p name.
2379 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2381 const char *long_name;
2382 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2383 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2384 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2390 typedef struct AVHWAccel {
2392 * Name of the hardware accelerated codec.
2393 * The name is globally unique among encoders and among decoders (but an
2394 * encoder and a decoder can share the same name).
2399 * Type of codec implemented by the hardware accelerator.
2401 * See CODEC_TYPE_xxx
2403 enum CodecType type;
2406 * Codec implemented by the hardware accelerator.
2413 * Supported pixel format.
2415 * Only hardware accelerated formats are supported here.
2417 enum PixelFormat pix_fmt;
2420 * Hardware accelerated codec capabilities.
2421 * see FF_HWACCEL_CODEC_CAP_*
2425 struct AVHWAccel *next;
2428 * Called at the beginning of each frame or field picture.
2430 * Meaningful frame information (codec specific) is guaranteed to
2431 * be parsed at this point. This function is mandatory.
2433 * Note that \p buf can be NULL along with \p buf_size set to 0.
2434 * Otherwise, this means the whole frame is available at this point.
2436 * @param avctx the codec context
2437 * @param buf the frame data buffer base
2438 * @param buf_size the size of the frame in bytes
2439 * @return zero if successful, a negative value otherwise
2441 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2444 * Callback for each slice.
2446 * Meaningful slice information (codec specific) is guaranteed to
2447 * be parsed at this point. This function is mandatory.
2449 * @param avctx the codec context
2450 * @param buf the slice data buffer base
2451 * @param buf_size the size of the slice in bytes
2452 * @return zero if successful, a negative value otherwise
2454 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2457 * Called at the end of each frame or field picture.
2459 * The whole picture is parsed at this point and can now be sent
2460 * to the hardware accelerator. This function is mandatory.
2462 * @param avctx the codec context
2463 * @return zero if successful, a negative value otherwise
2465 int (*end_frame)(AVCodecContext *avctx);
2468 * Size of HW accelerator private data.
2470 * Private data is allocated with av_mallocz() before
2471 * AVCodecContext.get_buffer() and deallocated after
2472 * AVCodecContext.release_buffer().
2478 * four components are given, that's all.
2479 * the last component is alpha
2481 typedef struct AVPicture {
2483 int linesize[4]; ///< number of bytes per line
2488 * This structure defines a method for communicating palette changes
2489 * between and demuxer and a decoder.
2491 * @deprecated Use AVPacket to send palette changes instead.
2492 * This is totally broken.
2494 #define AVPALETTE_SIZE 1024
2495 #define AVPALETTE_COUNT 256
2496 typedef struct AVPaletteControl {
2498 /* Demuxer sets this to 1 to indicate the palette has changed;
2499 * decoder resets to 0. */
2500 int palette_changed;
2502 /* 4-byte ARGB palette entries, stored in native byte order; note that
2503 * the individual palette components should be on a 8-bit scale; if
2504 * the palette data comes from an IBM VGA native format, the component
2505 * data is probably 6 bits in size and needs to be scaled. */
2506 unsigned int palette[AVPALETTE_COUNT];
2508 } AVPaletteControl attribute_deprecated;
2510 enum AVSubtitleType {
2513 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2516 * Plain text, the text field must be set by the decoder and is
2517 * authoritative. ass and pict fields may contain approximations.
2522 * Formatted text, the ass field must be set by the decoder and is
2523 * authoritative. pict and text fields may contain approximations.
2528 typedef struct AVSubtitleRect {
2529 int x; ///< top left corner of pict, undefined when pict is not set
2530 int y; ///< top left corner of pict, undefined when pict is not set
2531 int w; ///< width of pict, undefined when pict is not set
2532 int h; ///< height of pict, undefined when pict is not set
2533 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2536 * data+linesize for the bitmap of this subtitle.
2537 * can be set for text/ass as well once they where rendered
2540 enum AVSubtitleType type;
2542 char *text; ///< 0 terminated plain UTF-8 text
2545 * 0 terminated ASS/SSA compatible event line.
2546 * The pressentation of this is unaffected by the other values in this
2552 typedef struct AVSubtitle {
2553 uint16_t format; /* 0 = graphics */
2554 uint32_t start_display_time; /* relative to packet pts, in ms */
2555 uint32_t end_display_time; /* relative to packet pts, in ms */
2557 AVSubtitleRect **rects;
2563 struct ReSampleContext;
2564 struct AVResampleContext;
2566 typedef struct ReSampleContext ReSampleContext;
2568 #if LIBAVCODEC_VERSION_MAJOR < 53
2570 * @deprecated Use av_audio_resample_init() instead.
2572 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2573 int output_rate, int input_rate);
2576 * Initializes audio resampling context
2578 * @param output_channels number of output channels
2579 * @param input_channels number of input channels
2580 * @param output_rate output sample rate
2581 * @param input_rate input sample rate
2582 * @param sample_fmt_out requested output sample format
2583 * @param sample_fmt_in input sample format
2584 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2585 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2586 * @param linear If 1 then the used FIR filter will be linearly interpolated
2587 between the 2 closest, if 0 the closest will be used
2588 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2589 * @return allocated ReSampleContext, NULL if error occured
2591 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2592 int output_rate, int input_rate,
2593 enum SampleFormat sample_fmt_out,
2594 enum SampleFormat sample_fmt_in,
2595 int filter_length, int log2_phase_count,
2596 int linear, double cutoff);
2598 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2599 void audio_resample_close(ReSampleContext *s);
2603 * Initializes an audio resampler.
2604 * Note, if either rate is not an integer then simply scale both rates up so they are.
2605 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2606 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2607 * @param linear If 1 then the used FIR filter will be linearly interpolated
2608 between the 2 closest, if 0 the closest will be used
2609 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2611 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2615 * @param src an array of unconsumed samples
2616 * @param consumed the number of samples of src which have been consumed are returned here
2617 * @param src_size the number of unconsumed samples available
2618 * @param dst_size the amount of space in samples available in dst
2619 * @param update_ctx If this is 0 then the context will not be modified, that way several channels can be resampled with the same context.
2620 * @return the number of samples written in dst or -1 if an error occurred
2622 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2626 * Compensates samplerate/timestamp drift. The compensation is done by changing
2627 * the resampler parameters, so no audible clicks or similar distortions occur
2628 * @param compensation_distance distance in output samples over which the compensation should be performed
2629 * @param sample_delta number of output samples which should be output less
2631 * example: av_resample_compensate(c, 10, 500)
2632 * here instead of 510 samples only 500 samples would be output
2634 * note, due to rounding the actual compensation might be slightly different,
2635 * especially if the compensation_distance is large and the in_rate used during init is small
2637 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2638 void av_resample_close(struct AVResampleContext *c);
2641 * Allocate memory for a picture. Call avpicture_free to free it.
2643 * @param picture the picture to be filled in
2644 * @param pix_fmt the format of the picture
2645 * @param width the width of the picture
2646 * @param height the height of the picture
2647 * @return zero if successful, a negative value if not
2649 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2652 * Free a picture previously allocated by avpicture_alloc().
2654 * @param picture the AVPicture to be freed
2656 void avpicture_free(AVPicture *picture);
2659 * Fill in the AVPicture fields.
2660 * The fields of the given AVPicture are filled in by using the 'ptr' address
2661 * which points to the image data buffer. Depending on the specified picture
2662 * format, one or multiple image data pointers and line sizes will be set.
2663 * If a planar format is specified, several pointers will be set pointing to
2664 * the different picture planes and the line sizes of the different planes
2665 * will be stored in the lines_sizes array.
2667 * @param picture AVPicture whose fields are to be filled in
2668 * @param ptr Buffer which will contain or contains the actual image data
2669 * @param pix_fmt The format in which the picture data is stored.
2670 * @param width the width of the image in pixels
2671 * @param height the height of the image in pixels
2672 * @return size of the image data in bytes
2674 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2675 int pix_fmt, int width, int height);
2676 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2677 unsigned char *dest, int dest_size);
2680 * Calculate the size in bytes that a picture of the given width and height
2681 * would occupy if stored in the given picture format.
2683 * @param pix_fmt the given picture format
2684 * @param width the width of the image
2685 * @param height the height of the image
2686 * @return Image data size in bytes
2688 int avpicture_get_size(int pix_fmt, int width, int height);
2689 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2690 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2691 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2692 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2693 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2695 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2696 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2697 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2698 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2699 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2700 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2703 * Computes what kind of losses will occur when converting from one specific
2704 * pixel format to another.
2705 * When converting from one pixel format to another, information loss may occur.
2706 * For example, when converting from RGB24 to GRAY, the color information will
2707 * be lost. Similarly, other losses occur when converting from some formats to
2708 * other formats. These losses can involve loss of chroma, but also loss of
2709 * resolution, loss of color depth, loss due to the color space conversion, loss
2710 * of the alpha bits or loss due to color quantization.
2711 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2712 * which will occur when converting from one pixel format to another.
2714 * @param[in] dst_pix_fmt destination pixel format
2715 * @param[in] src_pix_fmt source pixel format
2716 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2717 * @return Combination of flags informing you what kind of losses will occur.
2719 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2723 * Finds the best pixel format to convert to given a certain source pixel
2724 * format. When converting from one pixel format to another, information loss
2725 * may occur. For example, when converting from RGB24 to GRAY, the color
2726 * information will be lost. Similarly, other losses occur when converting from
2727 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2728 * the given pixel formats should be used to suffer the least amount of loss.
2729 * The pixel formats from which it chooses one, are determined by the
2730 * \p pix_fmt_mask parameter.
2733 * src_pix_fmt = PIX_FMT_YUV420P;
2734 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2735 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2738 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2739 * @param[in] src_pix_fmt source pixel format
2740 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2741 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2742 * @return The best pixel format to convert to or -1 if none was found.
2744 int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2745 int has_alpha, int *loss_ptr);
2749 * Print in buf the string corresponding to the pixel format with
2750 * number pix_fmt, or an header if pix_fmt is negative.
2752 * @param[in] buf the buffer where to write the string
2753 * @param[in] buf_size the size of buf
2754 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2755 * a negative value to print the corresponding header.
2756 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2758 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2760 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2761 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2764 * Tell if an image really has transparent alpha values.
2765 * @return ored mask of FF_ALPHA_xxx constants
2767 int img_get_alpha_info(const AVPicture *src,
2768 int pix_fmt, int width, int height);
2770 /* deinterlace a picture */
2771 /* deinterlace - if not supported return -1 */
2772 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2773 int pix_fmt, int width, int height);
2775 /* external high level API */
2778 * If c is NULL, returns the first registered codec,
2779 * if c is non-NULL, returns the next registered codec after c,
2780 * or NULL if c is the last one.
2782 AVCodec *av_codec_next(AVCodec *c);
2785 * Returns the LIBAVCODEC_VERSION_INT constant.
2787 unsigned avcodec_version(void);
2790 * Initializes libavcodec.
2792 * @warning This function \e must be called before any other libavcodec
2795 void avcodec_init(void);
2797 #if LIBAVCODEC_VERSION_MAJOR < 53
2799 * @deprecated Deprecated in favor of avcodec_register().
2801 attribute_deprecated void register_avcodec(AVCodec *codec);
2805 * Register the codec \p codec and initialize libavcodec.
2807 * @see avcodec_init()
2809 void avcodec_register(AVCodec *codec);
2812 * Finds a registered encoder with a matching codec ID.
2814 * @param id CodecID of the requested encoder
2815 * @return An encoder if one was found, NULL otherwise.
2817 AVCodec *avcodec_find_encoder(enum CodecID id);
2820 * Finds a registered encoder with the specified name.
2822 * @param name name of the requested encoder
2823 * @return An encoder if one was found, NULL otherwise.
2825 AVCodec *avcodec_find_encoder_by_name(const char *name);
2828 * Finds a registered decoder with a matching codec ID.
2830 * @param id CodecID of the requested decoder
2831 * @return A decoder if one was found, NULL otherwise.
2833 AVCodec *avcodec_find_decoder(enum CodecID id);
2836 * Finds a registered decoder with the specified name.
2838 * @param name name of the requested decoder
2839 * @return A decoder if one was found, NULL otherwise.
2841 AVCodec *avcodec_find_decoder_by_name(const char *name);
2842 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2845 * Sets the fields of the given AVCodecContext to default values.
2847 * @param s The AVCodecContext of which the fields should be set to default values.
2849 void avcodec_get_context_defaults(AVCodecContext *s);
2851 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2852 * we WILL change its arguments and name a few times! */
2853 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2856 * Allocates an AVCodecContext and sets its fields to default values. The
2857 * resulting struct can be deallocated by simply calling av_free().
2859 * @return An AVCodecContext filled with default values or NULL on failure.
2860 * @see avcodec_get_context_defaults
2862 AVCodecContext *avcodec_alloc_context(void);
2864 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2865 * we WILL change its arguments and name a few times! */
2866 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2869 * Sets the fields of the given AVFrame to default values.
2871 * @param pic The AVFrame of which the fields should be set to default values.
2873 void avcodec_get_frame_defaults(AVFrame *pic);
2876 * Allocates an AVFrame and sets its fields to default values. The resulting
2877 * struct can be deallocated by simply calling av_free().
2879 * @return An AVFrame filled with default values or NULL on failure.
2880 * @see avcodec_get_frame_defaults
2882 AVFrame *avcodec_alloc_frame(void);
2884 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2885 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2886 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2887 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2890 * Checks if the given dimension of a picture is valid, meaning that all
2891 * bytes of the picture can be addressed with a signed int.
2893 * @param[in] w Width of the picture.
2894 * @param[in] h Height of the picture.
2895 * @return Zero if valid, a negative value if invalid.
2897 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2898 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2900 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2901 void avcodec_thread_free(AVCodecContext *s);
2902 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2903 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2904 //FIXME func typedef
2907 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2908 * function the context has to be allocated.
2910 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2911 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2912 * retrieving a codec.
2914 * @warning This function is not thread safe!
2917 * avcodec_register_all();
2918 * codec = avcodec_find_decoder(CODEC_ID_H264);
2922 * context = avcodec_alloc_context();
2924 * if (avcodec_open(context, codec) < 0)
2928 * @param avctx The context which will be set up to use the given codec.
2929 * @param codec The codec to use within the context.
2930 * @return zero on success, a negative value on error
2931 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2933 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2936 * Decodes an audio frame from \p buf into \p samples.
2937 * The avcodec_decode_audio2() function decodes an audio frame from the input
2938 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2939 * audio codec which was coupled with \p avctx using avcodec_open(). The
2940 * resulting decoded frame is stored in output buffer \p samples. If no frame
2941 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2942 * decompressed frame size in \e bytes.
2944 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2945 * output buffer before calling avcodec_decode_audio2().
2947 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2948 * the actual read bytes because some optimized bitstream readers read 32 or 64
2949 * bits at once and could read over the end.
2951 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2952 * no overreading happens for damaged MPEG streams.
2954 * @note You might have to align the input buffer \p buf and output buffer \p
2955 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2956 * necessary at all, on others it won't work at all if not aligned and on others
2957 * it will work but it will have an impact on performance. In practice, the
2958 * bitstream should have 4 byte alignment at minimum and all sample data should
2959 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2960 * the linesize is not a multiple of 16 then there's no sense in aligning the
2961 * start of the buffer to 16.
2963 * @param avctx the codec context
2964 * @param[out] samples the output buffer
2965 * @param[in,out] frame_size_ptr the output buffer size in bytes
2966 * @param[in] buf the input buffer
2967 * @param[in] buf_size the input buffer size in bytes
2968 * @return On error a negative value is returned, otherwise the number of bytes
2969 * used or zero if no frame could be decompressed.
2971 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2972 int *frame_size_ptr,
2973 const uint8_t *buf, int buf_size);
2976 * Decodes a video frame from \p buf into \p picture.
2977 * The avcodec_decode_video() function decodes a video frame from the input
2978 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2979 * video codec which was coupled with \p avctx using avcodec_open(). The
2980 * resulting decoded frame is stored in \p picture.
2982 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2983 * the actual read bytes because some optimized bitstream readers read 32 or 64
2984 * bits at once and could read over the end.
2986 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2987 * no overreading happens for damaged MPEG streams.
2989 * @note You might have to align the input buffer \p buf and output buffer \p
2990 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2991 * necessary at all, on others it won't work at all if not aligned and on others
2992 * it will work but it will have an impact on performance. In practice, the
2993 * bitstream should have 4 byte alignment at minimum and all sample data should
2994 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2995 * the linesize is not a multiple of 16 then there's no sense in aligning the
2996 * start of the buffer to 16.
2998 * @note Some codecs have a delay between input and output, these need to be
2999 * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
3001 * @param avctx the codec context
3002 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3003 * @param[in] buf the input buffer
3004 * @param[in] buf_size the size of the input buffer in bytes
3005 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3006 * @return On error a negative value is returned, otherwise the number of bytes
3007 * used or zero if no frame could be decompressed.
3009 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3010 int *got_picture_ptr,
3011 const uint8_t *buf, int buf_size);
3013 /* Decode a subtitle message. Return -1 if error, otherwise return the
3014 * number of bytes used. If no subtitle could be decompressed,
3015 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3016 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3018 const uint8_t *buf, int buf_size);
3019 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3021 uint8_t *buf, int buf_size);
3024 * Encodes an audio frame from \p samples into \p buf.
3025 * The avcodec_encode_audio() function encodes an audio frame from the input
3026 * buffer \p samples. To encode it, it makes use of the audio codec which was
3027 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3028 * stored in output buffer \p buf.
3030 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3032 * @param avctx the codec context
3033 * @param[out] buf the output buffer
3034 * @param[in] buf_size the output buffer size
3035 * @param[in] samples the input buffer containing the samples
3036 * The number of samples read from this buffer is frame_size*channels,
3037 * both of which are defined in \p avctx.
3038 * For PCM audio the number of samples read from \p samples is equal to
3039 * \p buf_size * input_sample_size / output_sample_size.
3040 * @return On error a negative value is returned, on success zero or the number
3041 * of bytes used to encode the data read from the input buffer.
3043 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3044 const short *samples);
3047 * Encodes a video frame from \p pict into \p buf.
3048 * The avcodec_encode_video() function encodes a video frame from the input
3049 * \p pict. To encode it, it makes use of the video codec which was coupled with
3050 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
3051 * frame are stored in the output buffer \p buf. The input picture should be
3052 * stored using a specific format, namely \c avctx.pix_fmt.
3054 * @param avctx the codec context
3055 * @param[out] buf the output buffer for the bitstream of encoded frame
3056 * @param[in] buf_size the size of the output buffer in bytes
3057 * @param[in] pict the input picture to encode
3058 * @return On error a negative value is returned, on success zero or the number
3059 * of bytes used from the output buffer.
3061 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3062 const AVFrame *pict);
3063 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3064 const AVSubtitle *sub);
3066 int avcodec_close(AVCodecContext *avctx);
3069 * Register all the codecs, parsers and bitstream filters which were enabled at
3070 * configuration time. If you do not call this function you can select exactly
3071 * which formats you want to support, by using the individual registration
3074 * @see avcodec_register
3075 * @see av_register_codec_parser
3076 * @see av_register_bitstream_filter
3078 void avcodec_register_all(void);
3081 * Flush buffers, should be called when seeking or when switching to a different stream.
3083 void avcodec_flush_buffers(AVCodecContext *avctx);
3085 void avcodec_default_free_buffers(AVCodecContext *s);
3087 /* misc useful functions */
3090 * Returns a single letter to describe the given picture type \p pict_type.
3092 * @param[in] pict_type the picture type
3093 * @return A single character representing the picture type.
3095 char av_get_pict_type_char(int pict_type);
3098 * Returns codec bits per sample.
3100 * @param[in] codec_id the codec
3101 * @return Number of bits per sample or zero if unknown for the given codec.
3103 int av_get_bits_per_sample(enum CodecID codec_id);
3106 * Returns sample format bits per sample.
3108 * @param[in] sample_fmt the sample format
3109 * @return Number of bits per sample or zero if unknown for the given sample format.
3111 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3114 typedef struct AVCodecParserContext {
3116 struct AVCodecParser *parser;
3117 int64_t frame_offset; /* offset of the current frame */
3118 int64_t cur_offset; /* current offset
3119 (incremented by each av_parser_parse()) */
3120 int64_t next_frame_offset; /* offset of the next frame */
3122 int pict_type; /* XXX: Put it back in AVCodecContext. */
3124 * This field is used for proper frame duration computation in lavf.
3125 * It signals, how much longer the frame duration of the current frame
3126 * is compared to normal frame duration.
3128 * frame_duration = (1 + repeat_pict) * time_base
3130 * It is used by codecs like H.264 to display telecined material.
3132 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3133 int64_t pts; /* pts of the current frame */
3134 int64_t dts; /* dts of the current frame */
3139 int fetch_timestamp;
3141 #define AV_PARSER_PTS_NB 4
3142 int cur_frame_start_index;
3143 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3144 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3145 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3148 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3150 int64_t offset; ///< byte offset from starting packet start
3151 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3154 * Set by parser to 1 for key frames and 0 for non-key frames.
3155 * It is initialized to -1, so if the parser doesn't set this flag,
3156 * old-style fallback using FF_I_TYPE picture type as key frames
3162 * Time difference in stream time base units from the pts of this
3163 * packet to the point at which the output from the decoder has converged
3164 * independent from the availability of previous frames. That is, the
3165 * frames are virtually identical no matter if decoding started from
3166 * the very first frame or from this keyframe.
3167 * Is AV_NOPTS_VALUE if unknown.
3168 * This field is not the display duration of the current frame.
3170 * The purpose of this field is to allow seeking in streams that have no
3171 * keyframes in the conventional sense. It corresponds to the
3172 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3173 * essential for some types of subtitle streams to ensure that all
3174 * subtitles are correctly displayed after seeking.
3176 int64_t convergence_duration;
3178 // Timestamp generation support:
3180 * Synchronization point for start of timestamp generation.
3182 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3185 * For example, this corresponds to presence of H.264 buffering period
3191 * Offset of the current timestamp against last timestamp sync point in
3192 * units of AVCodecContext.time_base.
3194 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3195 * contain a valid timestamp offset.
3197 * Note that the timestamp of sync point has usually a nonzero
3198 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3199 * the next frame after timestamp sync point will be usually 1.
3201 * For example, this corresponds to H.264 cpb_removal_delay.
3203 int dts_ref_dts_delta;
3206 * Presentation delay of current frame in units of AVCodecContext.time_base.
3208 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3209 * contain valid non-negative timestamp delta (presentation time of a frame
3210 * must not lie in the past).
3212 * This delay represents the difference between decoding and presentation
3213 * time of the frame.
3215 * For example, this corresponds to H.264 dpb_output_delay.
3220 * Position of the packet in file.
3222 * Analogous to cur_frame_pts/dts
3224 int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3227 * Byte position of currently parsed frame in stream.
3232 * Previous frame byte position.
3235 } AVCodecParserContext;
3237 typedef struct AVCodecParser {
3238 int codec_ids[5]; /* several codec IDs are permitted */
3240 int (*parser_init)(AVCodecParserContext *s);
3241 int (*parser_parse)(AVCodecParserContext *s,
3242 AVCodecContext *avctx,
3243 const uint8_t **poutbuf, int *poutbuf_size,
3244 const uint8_t *buf, int buf_size);
3245 void (*parser_close)(AVCodecParserContext *s);
3246 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3247 struct AVCodecParser *next;
3250 AVCodecParser *av_parser_next(AVCodecParser *c);
3252 void av_register_codec_parser(AVCodecParser *parser);
3253 AVCodecParserContext *av_parser_init(int codec_id);
3255 attribute_deprecated
3256 int av_parser_parse(AVCodecParserContext *s,
3257 AVCodecContext *avctx,
3258 uint8_t **poutbuf, int *poutbuf_size,
3259 const uint8_t *buf, int buf_size,
3260 int64_t pts, int64_t dts);
3265 * @param s parser context.
3266 * @param avctx codec context.
3267 * @param poutbuf set to pointer to parsed buffer or NULL if not yet finished.
3268 * @param poutbuf_size set to size of parsed buffer or zero if not yet finished.
3269 * @param buf input buffer.
3270 * @param buf_size input length, to signal EOF, this should be 0 (so that the last frame can be output).
3271 * @param pts input presentation timestamp.
3272 * @param dts input decoding timestamp.
3273 * @param pos input byte position in stream.
3274 * @return the number of bytes of the input bitstream used.
3279 * len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3286 * decode_frame(data, size);
3290 int av_parser_parse2(AVCodecParserContext *s,
3291 AVCodecContext *avctx,
3292 uint8_t **poutbuf, int *poutbuf_size,
3293 const uint8_t *buf, int buf_size,
3294 int64_t pts, int64_t dts,
3297 int av_parser_change(AVCodecParserContext *s,
3298 AVCodecContext *avctx,
3299 uint8_t **poutbuf, int *poutbuf_size,
3300 const uint8_t *buf, int buf_size, int keyframe);
3301 void av_parser_close(AVCodecParserContext *s);
3304 typedef struct AVBitStreamFilterContext {
3306 struct AVBitStreamFilter *filter;
3307 AVCodecParserContext *parser;
3308 struct AVBitStreamFilterContext *next;
3309 } AVBitStreamFilterContext;
3312 typedef struct AVBitStreamFilter {
3315 int (*filter)(AVBitStreamFilterContext *bsfc,
3316 AVCodecContext *avctx, const char *args,
3317 uint8_t **poutbuf, int *poutbuf_size,
3318 const uint8_t *buf, int buf_size, int keyframe);
3319 void (*close)(AVBitStreamFilterContext *bsfc);
3320 struct AVBitStreamFilter *next;
3321 } AVBitStreamFilter;
3323 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3324 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3325 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3326 AVCodecContext *avctx, const char *args,
3327 uint8_t **poutbuf, int *poutbuf_size,
3328 const uint8_t *buf, int buf_size, int keyframe);
3329 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3331 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3336 * Reallocates the given block if it is not large enough, otherwise it
3341 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3344 * Copy image 'src' to 'dst'.
3346 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3347 int pix_fmt, int width, int height);
3350 * Crop image top and left side.
3352 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3353 int pix_fmt, int top_band, int left_band);
3358 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3359 int padtop, int padbottom, int padleft, int padright, int *color);
3361 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3364 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3366 * @return 0 in case of a successful parsing, a negative value otherwise
3367 * @param[in] str the string to parse: it has to be a string in the format
3368 * <width>x<height> or a valid video frame size abbreviation.
3369 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3371 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3372 * frame height value
3374 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3377 * Parses \p str and put in \p frame_rate the detected values.
3379 * @return 0 in case of a successful parsing, a negative value otherwise
3380 * @param[in] str the string to parse: it has to be a string in the format
3381 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3382 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3385 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3387 /* error handling */
3389 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3390 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3392 /* Some platforms have E* and errno already negated. */
3393 #define AVERROR(e) (e)
3394 #define AVUNERROR(e) (e)
3396 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3397 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3398 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3399 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3400 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3401 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3402 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3403 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3404 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3405 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3408 * Registers the hardware accelerator \p hwaccel.
3410 void av_register_hwaccel(AVHWAccel *hwaccel);
3413 * If hwaccel is NULL, returns the first registered hardware accelerator,
3414 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3415 * after hwaccel, or NULL if hwaccel is the last one.
3417 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3419 #endif /* AVCODEC_AVCODEC_H */