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
32 #define LIBAVCODEC_VERSION_MAJOR 52
33 #define LIBAVCODEC_VERSION_MINOR 20
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,
313 /* subtitle codecs */
314 CODEC_ID_DVD_SUBTITLE= 0x17000,
315 CODEC_ID_DVB_SUBTITLE,
316 CODEC_ID_TEXT, ///< raw UTF-8 text
321 /* other specific kind of codecs (generally used for attachments) */
322 CODEC_ID_TTF= 0x18000,
324 CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
326 CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
327 * stream (only used by libavformat) */
331 CODEC_TYPE_UNKNOWN = -1,
336 CODEC_TYPE_ATTACHMENT,
341 * all in native-endian format
344 SAMPLE_FMT_NONE = -1,
345 SAMPLE_FMT_U8, ///< unsigned 8 bits
346 SAMPLE_FMT_S16, ///< signed 16 bits
347 SAMPLE_FMT_S32, ///< signed 32 bits
348 SAMPLE_FMT_FLT, ///< float
349 SAMPLE_FMT_DBL, ///< double
350 SAMPLE_FMT_NB ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
353 /* Audio channel masks */
354 #define CH_FRONT_LEFT 0x00000001
355 #define CH_FRONT_RIGHT 0x00000002
356 #define CH_FRONT_CENTER 0x00000004
357 #define CH_LOW_FREQUENCY 0x00000008
358 #define CH_BACK_LEFT 0x00000010
359 #define CH_BACK_RIGHT 0x00000020
360 #define CH_FRONT_LEFT_OF_CENTER 0x00000040
361 #define CH_FRONT_RIGHT_OF_CENTER 0x00000080
362 #define CH_BACK_CENTER 0x00000100
363 #define CH_SIDE_LEFT 0x00000200
364 #define CH_SIDE_RIGHT 0x00000400
365 #define CH_TOP_CENTER 0x00000800
366 #define CH_TOP_FRONT_LEFT 0x00001000
367 #define CH_TOP_FRONT_CENTER 0x00002000
368 #define CH_TOP_FRONT_RIGHT 0x00004000
369 #define CH_TOP_BACK_LEFT 0x00008000
370 #define CH_TOP_BACK_CENTER 0x00010000
371 #define CH_TOP_BACK_RIGHT 0x00020000
372 #define CH_STEREO_LEFT 0x20000000 ///< Stereo downmix.
373 #define CH_STEREO_RIGHT 0x40000000 ///< See CH_STEREO_LEFT.
375 /* Audio channel convenience macros */
376 #define CH_LAYOUT_MONO (CH_FRONT_CENTER)
377 #define CH_LAYOUT_STEREO (CH_FRONT_LEFT|CH_FRONT_RIGHT)
378 #define CH_LAYOUT_SURROUND (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
379 #define CH_LAYOUT_QUAD (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
380 #define CH_LAYOUT_5POINT0 (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
381 #define CH_LAYOUT_5POINT1 (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
382 #define CH_LAYOUT_7POINT1 (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
383 #define CH_LAYOUT_7POINT1_WIDE (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
384 CH_BACK_LEFT|CH_BACK_RIGHT|\
385 CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
386 #define CH_LAYOUT_STEREO_DOWNMIX (CH_STEREO_LEFT|CH_STEREO_RIGHT)
389 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
392 * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
393 * This is mainly needed because some optimized bitstream readers read
394 * 32 or 64 bit at once and could read over the end.<br>
395 * Note: If the first 23 bits of the additional bytes are not 0, then damaged
396 * MPEG bitstreams could cause overread and segfault.
398 #define FF_INPUT_BUFFER_PADDING_SIZE 8
401 * minimum encoding buffer size
402 * Used to avoid some checks during header writing.
404 #define FF_MIN_BUFFER_SIZE 16384
408 * motion estimation type.
411 ME_ZERO = 1, ///< no search, that is use 0,0 vector whenever one is needed
415 ME_EPZS, ///< enhanced predictive zonal search
416 ME_X1, ///< reserved for experiments
417 ME_HEX, ///< hexagon based search
418 ME_UMH, ///< uneven multi-hexagon search
419 ME_ITER, ///< iterative search
420 ME_TESA, ///< transformed exhaustive search algorithm
424 /* We leave some space between them for extensions (drop some
425 * keyframes for intra-only or drop just some bidir frames). */
426 AVDISCARD_NONE =-16, ///< discard nothing
427 AVDISCARD_DEFAULT= 0, ///< discard useless packets like 0 size packets in avi
428 AVDISCARD_NONREF = 8, ///< discard all non reference
429 AVDISCARD_BIDIR = 16, ///< discard all bidirectional frames
430 AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
431 AVDISCARD_ALL = 48, ///< discard all
434 typedef struct RcOverride{
437 int qscale; // If this is 0 then quality_factor will be used instead.
438 float quality_factor;
441 #define FF_MAX_B_FRAMES 16
444 These flags can be passed in AVCodecContext.flags before initialization.
445 Note: Not everything is supported yet.
448 #define CODEC_FLAG_QSCALE 0x0002 ///< Use fixed qscale.
449 #define CODEC_FLAG_4MV 0x0004 ///< 4 MV per MB allowed / advanced prediction for H.263.
450 #define CODEC_FLAG_QPEL 0x0010 ///< Use qpel MC.
451 #define CODEC_FLAG_GMC 0x0020 ///< Use GMC.
452 #define CODEC_FLAG_MV0 0x0040 ///< Always try a MB with MV=<0,0>.
453 #define CODEC_FLAG_PART 0x0080 ///< Use data partitioning.
455 * The parent program guarantees that the input for B-frames containing
456 * streams is not written to for at least s->max_b_frames+1 frames, if
457 * this is not set the input will be copied.
459 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
460 #define CODEC_FLAG_PASS1 0x0200 ///< Use internal 2pass ratecontrol in first pass mode.
461 #define CODEC_FLAG_PASS2 0x0400 ///< Use internal 2pass ratecontrol in second pass mode.
462 #define CODEC_FLAG_EXTERN_HUFF 0x1000 ///< Use external Huffman table (for MJPEG).
463 #define CODEC_FLAG_GRAY 0x2000 ///< Only decode/encode grayscale.
464 #define CODEC_FLAG_EMU_EDGE 0x4000 ///< Don't draw edges.
465 #define CODEC_FLAG_PSNR 0x8000 ///< error[?] variables will be set during encoding.
466 #define CODEC_FLAG_TRUNCATED 0x00010000 /** Input bitstream might be truncated at a random
467 location instead of only at frame boundaries. */
468 #define CODEC_FLAG_NORMALIZE_AQP 0x00020000 ///< Normalize adaptive quantization.
469 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
470 #define CODEC_FLAG_LOW_DELAY 0x00080000 ///< Force low delay.
471 #define CODEC_FLAG_ALT_SCAN 0x00100000 ///< Use alternate scan.
472 #define CODEC_FLAG_GLOBAL_HEADER 0x00400000 ///< Place global headers in extradata instead of every keyframe.
473 #define CODEC_FLAG_BITEXACT 0x00800000 ///< Use only bitexact stuff (except (I)DCT).
474 /* Fx : Flag for h263+ extra options */
475 #define CODEC_FLAG_AC_PRED 0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
476 #define CODEC_FLAG_H263P_UMV 0x02000000 ///< unlimited motion vector
477 #define CODEC_FLAG_CBP_RD 0x04000000 ///< Use rate distortion optimization for cbp.
478 #define CODEC_FLAG_QP_RD 0x08000000 ///< Use rate distortion optimization for qp selectioon.
479 #define CODEC_FLAG_H263P_AIV 0x00000008 ///< H.263 alternative inter VLC
480 #define CODEC_FLAG_OBMC 0x00000001 ///< OBMC
481 #define CODEC_FLAG_LOOP_FILTER 0x00000800 ///< loop filter
482 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
483 #define CODEC_FLAG_INTERLACED_ME 0x20000000 ///< interlaced motion estimation
484 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
485 #define CODEC_FLAG_CLOSED_GOP 0x80000000
486 #define CODEC_FLAG2_FAST 0x00000001 ///< Allow non spec compliant speedup tricks.
487 #define CODEC_FLAG2_STRICT_GOP 0x00000002 ///< Strictly enforce GOP size.
488 #define CODEC_FLAG2_NO_OUTPUT 0x00000004 ///< Skip bitstream encoding.
489 #define CODEC_FLAG2_LOCAL_HEADER 0x00000008 ///< Place global headers at every keyframe instead of in extradata.
490 #define CODEC_FLAG2_BPYRAMID 0x00000010 ///< H.264 allow B-frames to be used as references.
491 #define CODEC_FLAG2_WPRED 0x00000020 ///< H.264 weighted biprediction for B-frames
492 #define CODEC_FLAG2_MIXED_REFS 0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
493 #define CODEC_FLAG2_8X8DCT 0x00000080 ///< H.264 high profile 8x8 transform
494 #define CODEC_FLAG2_FASTPSKIP 0x00000100 ///< H.264 fast pskip
495 #define CODEC_FLAG2_AUD 0x00000200 ///< H.264 access unit delimiters
496 #define CODEC_FLAG2_BRDO 0x00000400 ///< B-frame rate-distortion optimization
497 #define CODEC_FLAG2_INTRA_VLC 0x00000800 ///< Use MPEG-2 intra VLC table.
498 #define CODEC_FLAG2_MEMC_ONLY 0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
499 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
500 #define CODEC_FLAG2_SKIP_RD 0x00004000 ///< RD optimal MB level residual skipping
501 #define CODEC_FLAG2_CHUNKS 0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
502 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
503 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
505 /* Unsupported options :
506 * Syntax Arithmetic coding (SAC)
507 * Reference Picture Selection
508 * Independent Segment Decoding */
510 /* codec capabilities */
512 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
514 * Codec uses get_buffer() for allocating buffers.
515 * direct rendering method 1
517 #define CODEC_CAP_DR1 0x0002
518 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
519 #define CODEC_CAP_PARSE_ONLY 0x0004
520 #define CODEC_CAP_TRUNCATED 0x0008
521 /* Codec can export data for HW decoding (XvMC). */
522 #define CODEC_CAP_HWACCEL 0x0010
524 * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
525 * If this is not set, the codec is guaranteed to never be fed with NULL data.
527 #define CODEC_CAP_DELAY 0x0020
529 * Codec can be fed a final frame with a smaller size.
530 * This can be used to prevent truncation of the last audio samples.
532 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
534 * Codec can export data for HW decoding (VDPAU).
536 #define CODEC_CAP_HWACCEL_VDPAU 0x0080
538 //The following defines may change, don't expect compatibility if you use them.
539 #define MB_TYPE_INTRA4x4 0x0001
540 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
541 #define MB_TYPE_INTRA_PCM 0x0004 //FIXME H.264-specific
542 #define MB_TYPE_16x16 0x0008
543 #define MB_TYPE_16x8 0x0010
544 #define MB_TYPE_8x16 0x0020
545 #define MB_TYPE_8x8 0x0040
546 #define MB_TYPE_INTERLACED 0x0080
547 #define MB_TYPE_DIRECT2 0x0100 //FIXME
548 #define MB_TYPE_ACPRED 0x0200
549 #define MB_TYPE_GMC 0x0400
550 #define MB_TYPE_SKIP 0x0800
551 #define MB_TYPE_P0L0 0x1000
552 #define MB_TYPE_P1L0 0x2000
553 #define MB_TYPE_P0L1 0x4000
554 #define MB_TYPE_P1L1 0x8000
555 #define MB_TYPE_L0 (MB_TYPE_P0L0 | MB_TYPE_P1L0)
556 #define MB_TYPE_L1 (MB_TYPE_P0L1 | MB_TYPE_P1L1)
557 #define MB_TYPE_L0L1 (MB_TYPE_L0 | MB_TYPE_L1)
558 #define MB_TYPE_QUANT 0x00010000
559 #define MB_TYPE_CBP 0x00020000
560 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
564 * This specifies the area which should be displayed.
565 * Note there may be multiple such areas for one frame.
567 typedef struct AVPanScan{
570 * - encoding: Set by user.
571 * - decoding: Set by libavcodec.
576 * width and height in 1/16 pel
577 * - encoding: Set by user.
578 * - decoding: Set by libavcodec.
584 * position of the top left corner in 1/16 pel for up to 3 fields/frames
585 * - encoding: Set by user.
586 * - decoding: Set by libavcodec.
588 int16_t position[3][2];
591 #define FF_COMMON_FRAME \
593 * pointer to the picture planes.\
594 * This might be different from the first allocated byte\
601 * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
602 * This isn't used by libavcodec unless the default get/release_buffer() is used.\
608 * 1 -> keyframe, 0-> not\
609 * - encoding: Set by libavcodec.\
610 * - decoding: Set by libavcodec.\
615 * Picture type of the frame, see ?_TYPE below.\
616 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
617 * - decoding: Set by libavcodec.\
622 * presentation timestamp in time_base units (time when frame should be shown to user)\
623 * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
624 * - encoding: MUST be set by user.\
625 * - decoding: Set by libavcodec.\
630 * picture number in bitstream order\
631 * - encoding: set by\
632 * - decoding: Set by libavcodec.\
634 int coded_picture_number;\
636 * picture number in display order\
637 * - encoding: set by\
638 * - decoding: Set by libavcodec.\
640 int display_picture_number;\
643 * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
644 * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
645 * - decoding: Set by libavcodec.\
650 * buffer age (1->was last buffer and dint change, 2->..., ...).\
651 * Set to INT_MAX if the buffer has not been used yet.\
652 * - encoding: unused\
653 * - decoding: MUST be set by get_buffer().\
658 * is this picture used as reference\
659 * The values for this are the same as the MpegEncContext.picture_structure\
660 * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
661 * Set to 4 for delayed, non-reference frames.\
662 * - encoding: unused\
663 * - decoding: Set by libavcodec. (before get_buffer() call)).\
669 * - encoding: unused\
670 * - decoding: Set by libavcodec.\
672 int8_t *qscale_table;\
675 * - encoding: unused\
676 * - decoding: Set by libavcodec.\
681 * mbskip_table[mb]>=1 if MB didn't change\
682 * stride= mb_width = (width+15)>>4\
683 * - encoding: unused\
684 * - decoding: Set by libavcodec.\
686 uint8_t *mbskip_table;\
689 * motion vector table\
692 * int mv_sample_log2= 4 - motion_subsample_log2;\
693 * int mb_width= (width+15)>>4;\
694 * int mv_stride= (mb_width << mv_sample_log2) + 1;\
695 * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
697 * - encoding: Set by user.\
698 * - decoding: Set by libavcodec.\
700 int16_t (*motion_val[2])[2];\
703 * macroblock type table\
704 * mb_type_base + mb_width + 2\
705 * - encoding: Set by user.\
706 * - decoding: Set by libavcodec.\
711 * log2 of the size of the block which a single vector in motion_val represents: \
712 * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
713 * - encoding: unused\
714 * - decoding: Set by libavcodec.\
716 uint8_t motion_subsample_log2;\
719 * for some private data of the user\
720 * - encoding: unused\
721 * - decoding: Set by user.\
727 * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
728 * - decoding: unused\
733 * type of the buffer (to keep track of who has to deallocate data[*])\
734 * - encoding: Set by the one who allocates it.\
735 * - decoding: Set by the one who allocates it.\
736 * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
741 * When decoding, this signals how much the picture must be delayed.\
742 * extra_delay = repeat_pict / (2*fps)\
743 * - encoding: unused\
744 * - decoding: Set by libavcodec.\
754 * The content of the picture is interlaced.\
755 * - encoding: Set by user.\
756 * - decoding: Set by libavcodec. (default 0)\
758 int interlaced_frame;\
761 * If the content is interlaced, is top field displayed first.\
762 * - encoding: Set by user.\
763 * - decoding: Set by libavcodec.\
765 int top_field_first;\
769 * - encoding: Set by user.\
770 * - decoding: Set by libavcodec.\
772 AVPanScan *pan_scan;\
775 * Tell user application that palette has changed from previous frame.\
776 * - encoding: ??? (no palette-enabled encoder yet)\
777 * - decoding: Set by libavcodec. (default 0).\
779 int palette_has_changed;\
782 * codec suggestion on buffer type if != 0\
783 * - encoding: unused\
784 * - decoding: Set by libavcodec. (before get_buffer() call)).\
790 * - encoding: unused\
791 * - decoding: Set by libavcodec.\
796 * motion referece frame index\
797 * - encoding: Set by user.\
798 * - decoding: Set by libavcodec.\
800 int8_t *ref_index[2];\
803 * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
804 * output in AVFrame.reordered_opaque\
805 * - encoding: unused\
806 * - decoding: Read by user.\
808 int64_t reordered_opaque;\
811 #define FF_QSCALE_TYPE_MPEG1 0
812 #define FF_QSCALE_TYPE_MPEG2 1
813 #define FF_QSCALE_TYPE_H264 2
815 #define FF_BUFFER_TYPE_INTERNAL 1
816 #define FF_BUFFER_TYPE_USER 2 ///< direct rendering buffers (image is (de)allocated by user)
817 #define FF_BUFFER_TYPE_SHARED 4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
818 #define FF_BUFFER_TYPE_COPY 8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
821 #define FF_I_TYPE 1 ///< Intra
822 #define FF_P_TYPE 2 ///< Predicted
823 #define FF_B_TYPE 3 ///< Bi-dir predicted
824 #define FF_S_TYPE 4 ///< S(GMC)-VOP MPEG4
825 #define FF_SI_TYPE 5 ///< Switching Intra
826 #define FF_SP_TYPE 6 ///< Switching Predicted
829 #define FF_BUFFER_HINTS_VALID 0x01 // Buffer hints value is meaningful (if 0 ignore).
830 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
831 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
832 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
836 * New fields can be added to the end of FF_COMMON_FRAME with minor version
838 * Removal, reordering and changes to existing fields require a major
839 * version bump. No fields should be added into AVFrame before or after
841 * sizeof(AVFrame) must not be used outside libav*.
843 typedef struct AVFrame {
848 * main external API structure.
849 * New fields can be added to the end with minor version bumps.
850 * Removal, reordering and changes to existing fields require a major
852 * sizeof(AVCodecContext) must not be used outside libav*.
854 typedef struct AVCodecContext {
856 * information on struct for av_log
857 * - set by avcodec_alloc_context
859 const AVClass *av_class;
861 * the average bitrate
862 * - encoding: Set by user; unused for constant quantizer encoding.
863 * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
868 * number of bits the bitstream is allowed to diverge from the reference.
869 * the reference can be CBR (for CBR pass1) or VBR (for pass2)
870 * - encoding: Set by user; unused for constant quantizer encoding.
873 int bit_rate_tolerance;
877 * - encoding: Set by user.
878 * - decoding: Set by user.
883 * Some codecs need additional format info. It is stored here.
884 * If any muxer uses this then ALL demuxers/parsers AND encoders for the
885 * specific codec MUST set it correctly otherwise stream copy breaks.
886 * In general use of this field by muxers is not recommanded.
887 * - encoding: Set by libavcodec.
888 * - decoding: Set by libavcodec. (FIXME: Is this OK?)
893 * Motion estimation algorithm used for video coding.
894 * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
895 * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
896 * - encoding: MUST be set by user.
902 * some codecs need / can use extradata like Huffman tables.
903 * mjpeg: Huffman tables
904 * rv10: additional flags
905 * mpeg4: global headers (they can be in the bitstream or here)
906 * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
907 * than extradata_size to avoid prolems if it is read with the bitstream reader.
908 * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
909 * - encoding: Set/allocated/freed by libavcodec.
910 * - decoding: Set/allocated/freed by user.
916 * This is the fundamental unit of time (in seconds) in terms
917 * of which frame timestamps are represented. For fixed-fps content,
918 * timebase should be 1/framerate and timestamp increments should be
920 * - encoding: MUST be set by user.
921 * - decoding: Set by libavcodec.
923 AVRational time_base;
927 * picture width / height.
928 * - encoding: MUST be set by user.
929 * - decoding: Set by libavcodec.
930 * Note: For compatibility it is possible to set this instead of
931 * coded_width/height before decoding.
935 #define FF_ASPECT_EXTENDED 15
938 * the number of pictures in a group of pictures, or 0 for intra_only
939 * - encoding: Set by user.
945 * Pixel format, see PIX_FMT_xxx.
946 * - encoding: Set by user.
947 * - decoding: Set by libavcodec.
949 enum PixelFormat pix_fmt;
952 * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
953 * has to read frames at native frame rate.
954 * - encoding: Set by user.
960 * If non NULL, 'draw_horiz_band' is called by the libavcodec
961 * decoder to draw a horizontal band. It improves cache usage. Not
962 * all codecs can do that. You must check the codec capabilities
964 * The function is also used by hardware acceleration APIs.
965 * It is called at least once during frame decoding to pass
966 * the data needed for hardware render.
967 * In that mode instead of pixel data, AVFrame points to
968 * a structure specific to the acceleration API. The application
969 * reads the structure and can change some fields to indicate progress
972 * - decoding: Set by user.
973 * @param height the height of the slice
974 * @param y the y position of the slice
975 * @param type 1->top field, 2->bottom field, 3->frame
976 * @param offset offset into the AVFrame.data from which the slice should be read
978 void (*draw_horiz_band)(struct AVCodecContext *s,
979 const AVFrame *src, int offset[4],
980 int y, int type, int height);
983 int sample_rate; ///< samples per second
984 int channels; ///< number of audio channels
987 * audio sample format
988 * - encoding: Set by user.
989 * - decoding: Set by libavcodec.
991 enum SampleFormat sample_fmt; ///< sample format, currently unused
993 /* The following data should not be initialized. */
995 * Samples per packet, initialized when calling 'init'.
998 int frame_number; ///< audio or video frame number
999 int real_pict_num; ///< Returns the real picture number of previous encoded frame.
1002 * Number of frames the decoded output will be delayed relative to
1003 * the encoded input.
1004 * - encoding: Set by libavcodec.
1005 * - decoding: unused
1009 /* - encoding parameters */
1010 float qcompress; ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1011 float qblur; ///< amount of qscale smoothing over time (0.0-1.0)
1015 * - encoding: Set by user.
1016 * - decoding: unused
1022 * - encoding: Set by user.
1023 * - decoding: unused
1028 * maximum quantizer difference between frames
1029 * - encoding: Set by user.
1030 * - decoding: unused
1035 * maximum number of B-frames between non-B-frames
1036 * Note: The output will be delayed by max_b_frames+1 relative to the input.
1037 * - encoding: Set by user.
1038 * - decoding: unused
1043 * qscale factor between IP and B-frames
1044 * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1045 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1046 * - encoding: Set by user.
1047 * - decoding: unused
1049 float b_quant_factor;
1051 /** obsolete FIXME remove */
1053 #define FF_RC_STRATEGY_XVID 1
1055 int b_frame_strategy;
1059 * - encoding: unused
1060 * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1061 * @deprecated Deprecated in favor of skip_idct and skip_frame.
1065 struct AVCodec *codec;
1069 int rtp_payload_size; /* The size of the RTP payload: the coder will */
1070 /* do its best to deliver a chunk with size */
1071 /* below rtp_payload_size, the chunk will start */
1072 /* with a start code on some codecs like H.263. */
1073 /* This doesn't take account of any particular */
1074 /* headers inside the transmitted RTP payload. */
1077 /* The RTP callback: This function is called */
1078 /* every time the encoder has a packet to send. */
1079 /* It depends on the encoder if the data starts */
1080 /* with a Start Code (it should). H.263 does. */
1081 /* mb_nb contains the number of macroblocks */
1082 /* encoded in the RTP payload. */
1083 void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1085 /* statistics, used for 2-pass encoding */
1096 * number of bits used for the previously encoded frame
1097 * - encoding: Set by libavcodec.
1098 * - decoding: unused
1103 * Private data of the user, can be used to carry app specific stuff.
1104 * - encoding: Set by user.
1105 * - decoding: Set by user.
1109 char codec_name[32];
1110 enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1111 enum CodecID codec_id; /* see CODEC_ID_xxx */
1114 * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1115 * This is used to work around some encoder bugs.
1116 * A demuxer should set this to what is stored in the field used to identify the codec.
1117 * If there are multiple such fields in a container then the demuxer should choose the one
1118 * which maximizes the information about the used codec.
1119 * If the codec tag field in a container is larger then 32 bits then the demuxer should
1120 * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1121 * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1123 * - encoding: Set by user, if not then the default based on codec_id will be used.
1124 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1126 unsigned int codec_tag;
1129 * Work around bugs in encoders which sometimes cannot be detected automatically.
1130 * - encoding: Set by user
1131 * - decoding: Set by user
1133 int workaround_bugs;
1134 #define FF_BUG_AUTODETECT 1 ///< autodetection
1135 #define FF_BUG_OLD_MSMPEG4 2
1136 #define FF_BUG_XVID_ILACE 4
1137 #define FF_BUG_UMP4 8
1138 #define FF_BUG_NO_PADDING 16
1139 #define FF_BUG_AMV 32
1140 #define FF_BUG_AC_VLC 0 ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1141 #define FF_BUG_QPEL_CHROMA 64
1142 #define FF_BUG_STD_QPEL 128
1143 #define FF_BUG_QPEL_CHROMA2 256
1144 #define FF_BUG_DIRECT_BLOCKSIZE 512
1145 #define FF_BUG_EDGE 1024
1146 #define FF_BUG_HPEL_CHROMA 2048
1147 #define FF_BUG_DC_CLIP 4096
1148 #define FF_BUG_MS 8192 ///< Work around various bugs in Microsoft's broken decoders.
1149 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1152 * luma single coefficient elimination threshold
1153 * - encoding: Set by user.
1154 * - decoding: unused
1156 int luma_elim_threshold;
1159 * chroma single coeff elimination threshold
1160 * - encoding: Set by user.
1161 * - decoding: unused
1163 int chroma_elim_threshold;
1166 * strictly follow the standard (MPEG4, ...).
1167 * - encoding: Set by user.
1168 * - decoding: Set by user.
1169 * Setting this to STRICT or higher means the encoder and decoder will
1170 * generally do stupid things. While setting it to inofficial or lower
1171 * will mean the encoder might use things that are not supported by all
1172 * spec compliant decoders. Decoders make no difference between normal,
1173 * inofficial and experimental, that is they always try to decode things
1174 * when they can unless they are explicitly asked to behave stupid
1175 * (=strictly conform to the specs)
1177 int strict_std_compliance;
1178 #define FF_COMPLIANCE_VERY_STRICT 2 ///< Strictly conform to a older more strict version of the spec or reference software.
1179 #define FF_COMPLIANCE_STRICT 1 ///< Strictly conform to all the things in the spec no matter what consequences.
1180 #define FF_COMPLIANCE_NORMAL 0
1181 #define FF_COMPLIANCE_INOFFICIAL -1 ///< Allow inofficial extensions.
1182 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1185 * qscale offset between IP and B-frames
1186 * - encoding: Set by user.
1187 * - decoding: unused
1189 float b_quant_offset;
1192 * Error recognization; higher values will detect more errors but may
1193 * misdetect some more or less valid parts as errors.
1194 * - encoding: unused
1195 * - decoding: Set by user.
1197 int error_recognition;
1198 #define FF_ER_CAREFUL 1
1199 #define FF_ER_COMPLIANT 2
1200 #define FF_ER_AGGRESSIVE 3
1201 #define FF_ER_VERY_AGGRESSIVE 4
1204 * Called at the beginning of each frame to get a buffer for it.
1205 * If pic.reference is set then the frame will be read later by libavcodec.
1206 * avcodec_align_dimensions() should be used to find the required width and
1207 * height, as they normally need to be rounded up to the next multiple of 16.
1208 * - encoding: unused
1209 * - decoding: Set by libavcodec., user can override.
1211 int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1214 * Called to release buffers which were allocated with get_buffer.
1215 * A released buffer can be reused in get_buffer().
1216 * pic.data[*] must be set to NULL.
1217 * - encoding: unused
1218 * - decoding: Set by libavcodec., user can override.
1220 void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1223 * Size of the frame reordering buffer in the decoder.
1224 * For MPEG-2 it is 1 IPB or 0 low delay IP.
1225 * - encoding: Set by libavcodec.
1226 * - decoding: Set by libavcodec.
1231 * number of bytes per packet if constant and known or 0
1232 * Used by some WAV based audio codecs.
1236 int parse_only; /* - decoding only: If true, only parsing is done
1237 (function avcodec_parse_frame()). The frame
1238 data is returned. Only MPEG codecs support this now. */
1241 * 0-> h263 quant 1-> mpeg quant
1242 * - encoding: Set by user.
1243 * - decoding: unused
1248 * pass1 encoding statistics output buffer
1249 * - encoding: Set by libavcodec.
1250 * - decoding: unused
1255 * pass2 encoding statistics input buffer
1256 * Concatenated stuff from stats_out of pass1 should be placed here.
1257 * - encoding: Allocated/set/freed by user.
1258 * - decoding: unused
1263 * ratecontrol qmin qmax limiting method
1264 * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1265 * - encoding: Set by user.
1266 * - decoding: unused
1274 * ratecontrol override, see RcOverride
1275 * - encoding: Allocated/set/freed by user.
1276 * - decoding: unused
1278 RcOverride *rc_override;
1279 int rc_override_count;
1282 * rate control equation
1283 * - encoding: Set by user
1284 * - decoding: unused
1290 * - encoding: Set by user.
1291 * - decoding: unused
1297 * - encoding: Set by user.
1298 * - decoding: unused
1303 * decoder bitstream buffer size
1304 * - encoding: Set by user.
1305 * - decoding: unused
1308 float rc_buffer_aggressivity;
1311 * qscale factor between P and I-frames
1312 * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1313 * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1314 * - encoding: Set by user.
1315 * - decoding: unused
1317 float i_quant_factor;
1320 * qscale offset between P and I-frames
1321 * - encoding: Set by user.
1322 * - decoding: unused
1324 float i_quant_offset;
1327 * initial complexity for pass1 ratecontrol
1328 * - encoding: Set by user.
1329 * - decoding: unused
1331 float rc_initial_cplx;
1334 * DCT algorithm, see FF_DCT_* below
1335 * - encoding: Set by user.
1336 * - decoding: unused
1339 #define FF_DCT_AUTO 0
1340 #define FF_DCT_FASTINT 1
1341 #define FF_DCT_INT 2
1342 #define FF_DCT_MMX 3
1343 #define FF_DCT_MLIB 4
1344 #define FF_DCT_ALTIVEC 5
1345 #define FF_DCT_FAAN 6
1348 * luminance masking (0-> disabled)
1349 * - encoding: Set by user.
1350 * - decoding: unused
1355 * temporary complexity masking (0-> disabled)
1356 * - encoding: Set by user.
1357 * - decoding: unused
1359 float temporal_cplx_masking;
1362 * spatial complexity masking (0-> disabled)
1363 * - encoding: Set by user.
1364 * - decoding: unused
1366 float spatial_cplx_masking;
1369 * p block masking (0-> disabled)
1370 * - encoding: Set by user.
1371 * - decoding: unused
1376 * darkness masking (0-> disabled)
1377 * - encoding: Set by user.
1378 * - decoding: unused
1383 * IDCT algorithm, see FF_IDCT_* below.
1384 * - encoding: Set by user.
1385 * - decoding: Set by user.
1388 #define FF_IDCT_AUTO 0
1389 #define FF_IDCT_INT 1
1390 #define FF_IDCT_SIMPLE 2
1391 #define FF_IDCT_SIMPLEMMX 3
1392 #define FF_IDCT_LIBMPEG2MMX 4
1393 #define FF_IDCT_PS2 5
1394 #define FF_IDCT_MLIB 6
1395 #define FF_IDCT_ARM 7
1396 #define FF_IDCT_ALTIVEC 8
1397 #define FF_IDCT_SH4 9
1398 #define FF_IDCT_SIMPLEARM 10
1399 #define FF_IDCT_H264 11
1400 #define FF_IDCT_VP3 12
1401 #define FF_IDCT_IPP 13
1402 #define FF_IDCT_XVIDMMX 14
1403 #define FF_IDCT_CAVS 15
1404 #define FF_IDCT_SIMPLEARMV5TE 16
1405 #define FF_IDCT_SIMPLEARMV6 17
1406 #define FF_IDCT_SIMPLEVIS 18
1407 #define FF_IDCT_WMV2 19
1408 #define FF_IDCT_FAAN 20
1409 #define FF_IDCT_EA 21
1410 #define FF_IDCT_SIMPLENEON 22
1411 #define FF_IDCT_SIMPLEALPHA 23
1415 * - encoding: Set by libavcodec.
1416 * - decoding: Set by user (or 0).
1420 * slice offsets in the frame in bytes
1421 * - encoding: Set/allocated by libavcodec.
1422 * - decoding: Set/allocated by user (or NULL).
1427 * error concealment flags
1428 * - encoding: unused
1429 * - decoding: Set by user.
1431 int error_concealment;
1432 #define FF_EC_GUESS_MVS 1
1433 #define FF_EC_DEBLOCK 2
1436 * dsp_mask could be add used to disable unwanted CPU features
1437 * CPU features (i.e. MMX, SSE. ...)
1439 * With the FORCE flag you may instead enable given CPU features.
1440 * (Dangerous: Usable in case of misdetection, improper usage however will
1441 * result into program crash.)
1444 #define FF_MM_FORCE 0x80000000 /* Force usage of selected flags (OR) */
1445 /* lower 16 bits - CPU features */
1446 #define FF_MM_MMX 0x0001 ///< standard MMX
1447 #define FF_MM_3DNOW 0x0004 ///< AMD 3DNOW
1448 #define FF_MM_MMXEXT 0x0002 ///< SSE integer functions or AMD MMX ext
1449 #define FF_MM_SSE 0x0008 ///< SSE functions
1450 #define FF_MM_SSE2 0x0010 ///< PIV SSE2 functions
1451 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1452 #define FF_MM_SSE3 0x0040 ///< Prescott SSE3 functions
1453 #define FF_MM_SSSE3 0x0080 ///< Conroe SSSE3 functions
1454 #define FF_MM_IWMMXT 0x0100 ///< XScale IWMMXT
1455 #define FF_MM_ALTIVEC 0x0001 ///< standard AltiVec
1458 * bits per sample/pixel from the demuxer (needed for huffyuv).
1459 * - encoding: Set by libavcodec.
1460 * - decoding: Set by user.
1462 int bits_per_coded_sample;
1465 * prediction method (needed for huffyuv)
1466 * - encoding: Set by user.
1467 * - decoding: unused
1469 int prediction_method;
1470 #define FF_PRED_LEFT 0
1471 #define FF_PRED_PLANE 1
1472 #define FF_PRED_MEDIAN 2
1475 * sample aspect ratio (0 if unknown)
1476 * That is the width of a pixel divided by the height of the pixel.
1477 * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1478 * - encoding: Set by user.
1479 * - decoding: Set by libavcodec.
1481 AVRational sample_aspect_ratio;
1484 * the picture in the bitstream
1485 * - encoding: Set by libavcodec.
1486 * - decoding: Set by libavcodec.
1488 AVFrame *coded_frame;
1492 * - encoding: Set by user.
1493 * - decoding: Set by user.
1496 #define FF_DEBUG_PICT_INFO 1
1497 #define FF_DEBUG_RC 2
1498 #define FF_DEBUG_BITSTREAM 4
1499 #define FF_DEBUG_MB_TYPE 8
1500 #define FF_DEBUG_QP 16
1501 #define FF_DEBUG_MV 32
1502 #define FF_DEBUG_DCT_COEFF 0x00000040
1503 #define FF_DEBUG_SKIP 0x00000080
1504 #define FF_DEBUG_STARTCODE 0x00000100
1505 #define FF_DEBUG_PTS 0x00000200
1506 #define FF_DEBUG_ER 0x00000400
1507 #define FF_DEBUG_MMCO 0x00000800
1508 #define FF_DEBUG_BUGS 0x00001000
1509 #define FF_DEBUG_VIS_QP 0x00002000
1510 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1511 #define FF_DEBUG_BUFFERS 0x00008000
1515 * - encoding: Set by user.
1516 * - decoding: Set by user.
1519 #define FF_DEBUG_VIS_MV_P_FOR 0x00000001 //visualize forward predicted MVs of P frames
1520 #define FF_DEBUG_VIS_MV_B_FOR 0x00000002 //visualize forward predicted MVs of B frames
1521 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1525 * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1526 * - decoding: unused
1531 * minimum MB quantizer
1532 * - encoding: unused
1533 * - decoding: unused
1538 * maximum MB quantizer
1539 * - encoding: unused
1540 * - decoding: unused
1545 * motion estimation comparison function
1546 * - encoding: Set by user.
1547 * - decoding: unused
1551 * subpixel motion estimation comparison function
1552 * - encoding: Set by user.
1553 * - decoding: unused
1557 * macroblock comparison function (not supported yet)
1558 * - encoding: Set by user.
1559 * - decoding: unused
1563 * interlaced DCT comparison function
1564 * - encoding: Set by user.
1565 * - decoding: unused
1568 #define FF_CMP_SAD 0
1569 #define FF_CMP_SSE 1
1570 #define FF_CMP_SATD 2
1571 #define FF_CMP_DCT 3
1572 #define FF_CMP_PSNR 4
1573 #define FF_CMP_BIT 5
1575 #define FF_CMP_ZERO 7
1576 #define FF_CMP_VSAD 8
1577 #define FF_CMP_VSSE 9
1578 #define FF_CMP_NSSE 10
1579 #define FF_CMP_W53 11
1580 #define FF_CMP_W97 12
1581 #define FF_CMP_DCTMAX 13
1582 #define FF_CMP_DCT264 14
1583 #define FF_CMP_CHROMA 256
1586 * ME diamond size & shape
1587 * - encoding: Set by user.
1588 * - decoding: unused
1593 * amount of previous MV predictors (2a+1 x 2a+1 square)
1594 * - encoding: Set by user.
1595 * - decoding: unused
1597 int last_predictor_count;
1600 * prepass for motion estimation
1601 * - encoding: Set by user.
1602 * - decoding: unused
1607 * motion estimation prepass comparison function
1608 * - encoding: Set by user.
1609 * - decoding: unused
1614 * ME prepass diamond size & shape
1615 * - encoding: Set by user.
1616 * - decoding: unused
1622 * - encoding: Set by user.
1623 * - decoding: unused
1625 int me_subpel_quality;
1628 * callback to negotiate the pixelFormat
1629 * @param fmt is the list of formats which are supported by the codec,
1630 * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1631 * The first is always the native one.
1632 * @return the chosen format
1633 * - encoding: unused
1634 * - decoding: Set by user, if not set the native format will be chosen.
1636 enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1639 * DTG active format information (additional aspect ratio
1640 * information only used in DVB MPEG-2 transport streams)
1643 * - encoding: unused
1644 * - decoding: Set by decoder.
1646 int dtg_active_format;
1647 #define FF_DTG_AFD_SAME 8
1648 #define FF_DTG_AFD_4_3 9
1649 #define FF_DTG_AFD_16_9 10
1650 #define FF_DTG_AFD_14_9 11
1651 #define FF_DTG_AFD_4_3_SP_14_9 13
1652 #define FF_DTG_AFD_16_9_SP_14_9 14
1653 #define FF_DTG_AFD_SP_4_3 15
1656 * maximum motion estimation search range in subpel units
1657 * If 0 then no limit.
1659 * - encoding: Set by user.
1660 * - decoding: unused
1665 * intra quantizer bias
1666 * - encoding: Set by user.
1667 * - decoding: unused
1669 int intra_quant_bias;
1670 #define FF_DEFAULT_QUANT_BIAS 999999
1673 * inter quantizer bias
1674 * - encoding: Set by user.
1675 * - decoding: unused
1677 int inter_quant_bias;
1681 * - encoding: unused
1682 * - decoding: Which clrtable should be used for 8bit RGB images.
1683 * Tables have to be stored somewhere. FIXME
1688 * internal_buffer count
1689 * Don't touch, used by libavcodec default_get_buffer().
1691 int internal_buffer_count;
1695 * Don't touch, used by libavcodec default_get_buffer().
1697 void *internal_buffer;
1699 #define FF_LAMBDA_SHIFT 7
1700 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1701 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1702 #define FF_LAMBDA_MAX (256*128-1)
1704 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1706 * Global quality for codecs which cannot change it per frame.
1707 * This should be proportional to MPEG-1/2/4 qscale.
1708 * - encoding: Set by user.
1709 * - decoding: unused
1713 #define FF_CODER_TYPE_VLC 0
1714 #define FF_CODER_TYPE_AC 1
1715 #define FF_CODER_TYPE_RAW 2
1716 #define FF_CODER_TYPE_RLE 3
1717 #define FF_CODER_TYPE_DEFLATE 4
1720 * - encoding: Set by user.
1721 * - decoding: unused
1727 * - encoding: Set by user.
1728 * - decoding: unused
1734 * - encoding: unused
1735 * - decoding: Set by user.
1737 uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1742 * - encoding: unused
1743 * - decoding: Set by user.
1746 #define SLICE_FLAG_CODED_ORDER 0x0001 ///< draw_horiz_band() is called in coded order instead of display
1747 #define SLICE_FLAG_ALLOW_FIELD 0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1748 #define SLICE_FLAG_ALLOW_PLANE 0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1751 * XVideo Motion Acceleration
1752 * - encoding: forbidden
1753 * - decoding: set by decoder
1755 int xvmc_acceleration;
1758 * macroblock decision mode
1759 * - encoding: Set by user.
1760 * - decoding: unused
1763 #define FF_MB_DECISION_SIMPLE 0 ///< uses mb_cmp
1764 #define FF_MB_DECISION_BITS 1 ///< chooses the one which needs the fewest bits
1765 #define FF_MB_DECISION_RD 2 ///< rate distortion
1768 * custom intra quantization matrix
1769 * - encoding: Set by user, can be NULL.
1770 * - decoding: Set by libavcodec.
1772 uint16_t *intra_matrix;
1775 * custom inter quantization matrix
1776 * - encoding: Set by user, can be NULL.
1777 * - decoding: Set by libavcodec.
1779 uint16_t *inter_matrix;
1782 * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1783 * This is used to work around some encoder bugs.
1784 * - encoding: unused
1785 * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1787 unsigned int stream_codec_tag;
1790 * scene change detection threshold
1791 * 0 is default, larger means fewer detected scene changes.
1792 * - encoding: Set by user.
1793 * - decoding: unused
1795 int scenechange_threshold;
1798 * minimum Lagrange multipler
1799 * - encoding: Set by user.
1800 * - decoding: unused
1805 * maximum Lagrange multipler
1806 * - encoding: Set by user.
1807 * - decoding: unused
1812 * palette control structure
1813 * - encoding: ??? (no palette-enabled encoder yet)
1814 * - decoding: Set by user.
1816 struct AVPaletteControl *palctrl;
1819 * noise reduction strength
1820 * - encoding: Set by user.
1821 * - decoding: unused
1823 int noise_reduction;
1826 * Called at the beginning of a frame to get cr buffer for it.
1827 * Buffer type (size, hints) must be the same. libavcodec won't check it.
1828 * libavcodec will pass previous buffer in pic, function should return
1829 * same buffer or new buffer with old frame "painted" into it.
1830 * If pic.data[0] == NULL must behave like get_buffer().
1831 * - encoding: unused
1832 * - decoding: Set by libavcodec., user can override
1834 int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1837 * Number of bits which should be loaded into the rc buffer before decoding starts.
1838 * - encoding: Set by user.
1839 * - decoding: unused
1841 int rc_initial_buffer_occupancy;
1845 * - encoding: Set by user.
1846 * - decoding: unused
1848 int inter_threshold;
1852 * - encoding: Set by user.
1853 * - decoding: Set by user.
1858 * Simulates errors in the bitstream to test error concealment.
1859 * - encoding: Set by user.
1860 * - decoding: unused
1865 * MP3 antialias algorithm, see FF_AA_* below.
1866 * - encoding: unused
1867 * - decoding: Set by user.
1870 #define FF_AA_AUTO 0
1871 #define FF_AA_FASTINT 1 //not implemented yet
1873 #define FF_AA_FLOAT 3
1875 * quantizer noise shaping
1876 * - encoding: Set by user.
1877 * - decoding: unused
1879 int quantizer_noise_shaping;
1883 * is used to decide how many independent tasks should be passed to execute()
1884 * - encoding: Set by user.
1885 * - decoding: Set by user.
1890 * The codec may call this to execute several independent things.
1891 * It will return only after finishing all tasks.
1892 * The user may replace this with some multithreaded implementation,
1893 * the default implementation will execute the parts serially.
1894 * @param count the number of things to execute
1895 * - encoding: Set by libavcodec, user can override.
1896 * - decoding: Set by libavcodec, user can override.
1898 int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1902 * Can be used by execute() to store some per AVCodecContext stuff.
1903 * - encoding: set by execute()
1904 * - decoding: set by execute()
1906 void *thread_opaque;
1909 * Motion estimation threshold below which no motion estimation is
1910 * performed, but instead the user specified motion vectors are used.
1912 * - encoding: Set by user.
1913 * - decoding: unused
1918 * Macroblock threshold below which the user specified macroblock types will be used.
1919 * - encoding: Set by user.
1920 * - decoding: unused
1925 * precision of the intra DC coefficient - 8
1926 * - encoding: Set by user.
1927 * - decoding: unused
1929 int intra_dc_precision;
1932 * noise vs. sse weight for the nsse comparsion function
1933 * - encoding: Set by user.
1934 * - decoding: unused
1939 * Number of macroblock rows at the top which are skipped.
1940 * - encoding: unused
1941 * - decoding: Set by user.
1946 * Number of macroblock rows at the bottom which are skipped.
1947 * - encoding: unused
1948 * - decoding: Set by user.
1954 * - encoding: Set by user.
1955 * - decoding: Set by libavcodec.
1958 #define FF_PROFILE_UNKNOWN -99
1959 #define FF_PROFILE_AAC_MAIN 0
1960 #define FF_PROFILE_AAC_LOW 1
1961 #define FF_PROFILE_AAC_SSR 2
1962 #define FF_PROFILE_AAC_LTP 3
1966 * - encoding: Set by user.
1967 * - decoding: Set by libavcodec.
1970 #define FF_LEVEL_UNKNOWN -99
1973 * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1974 * - encoding: unused
1975 * - decoding: Set by user.
1980 * Bitstream width / height, may be different from width/height if lowres
1981 * or other things are used.
1982 * - encoding: unused
1983 * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1985 int coded_width, coded_height;
1988 * frame skip threshold
1989 * - encoding: Set by user.
1990 * - decoding: unused
1992 int frame_skip_threshold;
1996 * - encoding: Set by user.
1997 * - decoding: unused
1999 int frame_skip_factor;
2002 * frame skip exponent
2003 * - encoding: Set by user.
2004 * - decoding: unused
2009 * frame skip comparison function
2010 * - encoding: Set by user.
2011 * - decoding: unused
2016 * Border processing masking, raises the quantizer for mbs on the borders
2018 * - encoding: Set by user.
2019 * - decoding: unused
2021 float border_masking;
2024 * minimum MB lagrange multipler
2025 * - encoding: Set by user.
2026 * - decoding: unused
2031 * maximum MB lagrange multipler
2032 * - encoding: Set by user.
2033 * - decoding: unused
2039 * - encoding: Set by user.
2040 * - decoding: unused
2042 int me_penalty_compensation;
2046 * - encoding: unused
2047 * - decoding: Set by user.
2049 enum AVDiscard skip_loop_filter;
2053 * - encoding: unused
2054 * - decoding: Set by user.
2056 enum AVDiscard skip_idct;
2060 * - encoding: unused
2061 * - decoding: Set by user.
2063 enum AVDiscard skip_frame;
2067 * - encoding: Set by user.
2068 * - decoding: unused
2074 * - encoding: Set by user.
2075 * - decoding: unused
2080 * constant rate factor - quality-based VBR - values ~correspond to qps
2081 * - encoding: Set by user.
2082 * - decoding: unused
2087 * constant quantization parameter rate control method
2088 * - encoding: Set by user.
2089 * - decoding: unused
2095 * - encoding: Set by user.
2096 * - decoding: unused
2101 * number of reference frames
2102 * - encoding: Set by user.
2103 * - decoding: Set by lavc.
2108 * chroma qp offset from luma
2109 * - encoding: Set by user.
2110 * - decoding: unused
2115 * Influences how often B-frames are used.
2116 * - encoding: Set by user.
2117 * - decoding: unused
2122 * trellis RD quantization
2123 * - encoding: Set by user.
2124 * - decoding: unused
2129 * Reduce fluctuations in qp (before curve compression).
2130 * - encoding: Set by user.
2131 * - decoding: unused
2133 float complexityblur;
2136 * in-loop deblocking filter alphac0 parameter
2137 * alpha is in the range -6...6
2138 * - encoding: Set by user.
2139 * - decoding: unused
2144 * in-loop deblocking filter beta parameter
2145 * beta is in the range -6...6
2146 * - encoding: Set by user.
2147 * - decoding: unused
2152 * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2153 * - encoding: Set by user.
2154 * - decoding: unused
2157 #define X264_PART_I4X4 0x001 /* Analyze i4x4 */
2158 #define X264_PART_I8X8 0x002 /* Analyze i8x8 (requires 8x8 transform) */
2159 #define X264_PART_P8X8 0x010 /* Analyze p16x8, p8x16 and p8x8 */
2160 #define X264_PART_P4X4 0x020 /* Analyze p8x4, p4x8, p4x4 */
2161 #define X264_PART_B8X8 0x100 /* Analyze b16x8, b8x16 and b8x8 */
2164 * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2165 * - encoding: Set by user.
2166 * - decoding: unused
2171 * Audio cutoff bandwidth (0 means "automatic")
2172 * - encoding: Set by user.
2173 * - decoding: unused
2178 * Multiplied by qscale for each frame and added to scene_change_score.
2179 * - encoding: Set by user.
2180 * - decoding: unused
2182 int scenechange_factor;
2186 * Note: Value depends upon the compare function used for fullpel ME.
2187 * - encoding: Set by user.
2188 * - decoding: unused
2193 * Adjusts sensitivity of b_frame_strategy 1.
2194 * - encoding: Set by user.
2195 * - decoding: unused
2200 * - encoding: Set by user.
2201 * - decoding: unused
2203 int compression_level;
2204 #define FF_COMPRESSION_DEFAULT -1
2207 * Sets whether to use LPC mode - used by FLAC encoder.
2208 * - encoding: Set by user.
2209 * - decoding: unused
2214 * LPC coefficient precision - used by FLAC encoder
2215 * - encoding: Set by user.
2216 * - decoding: unused
2218 int lpc_coeff_precision;
2221 * - encoding: Set by user.
2222 * - decoding: unused
2224 int min_prediction_order;
2227 * - encoding: Set by user.
2228 * - decoding: unused
2230 int max_prediction_order;
2233 * search method for selecting prediction order
2234 * - encoding: Set by user.
2235 * - decoding: unused
2237 int prediction_order_method;
2240 * - encoding: Set by user.
2241 * - decoding: unused
2243 int min_partition_order;
2246 * - encoding: Set by user.
2247 * - decoding: unused
2249 int max_partition_order;
2252 * GOP timecode frame start number, in non drop frame format
2253 * - encoding: Set by user.
2254 * - decoding: unused
2256 int64_t timecode_frame_start;
2258 #if LIBAVCODEC_VERSION_MAJOR < 53
2260 * Decoder should decode to this many channels if it can (0 for default)
2261 * - encoding: unused
2262 * - decoding: Set by user.
2263 * @deprecated Deprecated in favor of request_channel_layout.
2265 int request_channels;
2269 * Percentage of dynamic range compression to be applied by the decoder.
2270 * The default value is 1.0, corresponding to full compression.
2271 * - encoding: unused
2272 * - decoding: Set by user.
2277 * opaque 64bit number (generally a PTS) that will be reordered and
2278 * output in AVFrame.reordered_opaque
2279 * - encoding: unused
2280 * - decoding: Set by user.
2282 int64_t reordered_opaque;
2285 * Bits per sample/pixel of internal libavcodec pixel/sample format.
2286 * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2287 * - encoding: set by user.
2288 * - decoding: set by libavcodec.
2290 int bits_per_raw_sample;
2293 * Audio channel layout.
2294 * - encoding: set by user.
2295 * - decoding: set by libavcodec.
2297 int64_t channel_layout;
2300 * Request decoder to use this channel layout if it can (0 for default)
2301 * - encoding: unused
2302 * - decoding: Set by user.
2304 int64_t request_channel_layout;
2307 * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2308 * - encoding: Set by user.
2309 * - decoding: unused.
2311 float rc_max_available_vbv_use;
2314 * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2315 * - encoding: Set by user.
2316 * - decoding: unused.
2318 float rc_min_vbv_overflow_use;
2321 * Hardware accelerator in use
2322 * - encoding: unused.
2323 * - decoding: Set by libavcodec
2325 struct AVHWAccel *hwaccel;
2328 * For some codecs, the time base is closer to the field rate than the frame rate.
2329 * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2330 * if no telecine is used ...
2332 * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2334 int ticks_per_frame;
2340 typedef struct AVCodec {
2342 * Name of the codec implementation.
2343 * The name is globally unique among encoders and among decoders (but an
2344 * encoder and a decoder can share the same name).
2345 * This is the primary way to find a codec from the user perspective.
2348 enum CodecType type;
2351 int (*init)(AVCodecContext *);
2352 int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2353 int (*close)(AVCodecContext *);
2354 int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2355 const uint8_t *buf, int buf_size);
2357 * Codec capabilities.
2361 struct AVCodec *next;
2364 * Will be called when seeking
2366 void (*flush)(AVCodecContext *);
2367 const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2368 const enum PixelFormat *pix_fmts; ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2370 * Descriptive name for the codec, meant to be more human readable than \p name.
2371 * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2373 const char *long_name;
2374 const int *supported_samplerates; ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2375 const enum SampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2376 const int64_t *channel_layouts; ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2382 typedef struct AVHWAccel {
2384 * Name of the hardware accelerated codec.
2385 * The name is globally unique among encoders and among decoders (but an
2386 * encoder and a decoder can share the same name).
2391 * Type of codec implemented by the hardware accelerator.
2393 * See CODEC_TYPE_xxx
2395 enum CodecType type;
2398 * Codec implemented by the hardware accelerator.
2405 * Supported pixel format.
2407 * Only hardware accelerated formats are supported here.
2409 enum PixelFormat pix_fmt;
2412 * Hardware accelerated codec capabilities.
2413 * see FF_HWACCEL_CODEC_CAP_*
2417 struct AVHWAccel *next;
2420 * Called at the beginning of each frame or field picture.
2422 * Meaningful frame information (codec specific) is guaranteed to
2423 * be parsed at this point. This function is mandatory.
2425 * Note that \p buf can be NULL along with \p buf_size set to 0.
2426 * Otherwise, this means the whole frame is available at this point.
2428 * @param avctx the codec context
2429 * @param buf the frame data buffer base
2430 * @param buf_size the size of the frame in bytes
2431 * @return zero if successful, a negative value otherwise
2433 int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2436 * Callback for each slice.
2438 * Meaningful slice information (codec specific) is guaranteed to
2439 * be parsed at this point. This function is mandatory.
2441 * @param avctx the codec context
2442 * @param buf the slice data buffer base
2443 * @param buf_size the size of the slice in bytes
2444 * @return zero if successful, a negative value otherwise
2446 int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2449 * Called at the end of each frame or field picture.
2451 * The whole picture is parsed at this point and can now be sent
2452 * to the hardware accelerator. This function is mandatory.
2454 * @param avctx the codec context
2455 * @return zero if successful, a negative value otherwise
2457 int (*end_frame)(AVCodecContext *avctx);
2461 * four components are given, that's all.
2462 * the last component is alpha
2464 typedef struct AVPicture {
2466 int linesize[4]; ///< number of bytes per line
2471 * This structure defines a method for communicating palette changes
2472 * between and demuxer and a decoder.
2474 * @deprecated Use AVPacket to send palette changes instead.
2475 * This is totally broken.
2477 #define AVPALETTE_SIZE 1024
2478 #define AVPALETTE_COUNT 256
2479 typedef struct AVPaletteControl {
2481 /* Demuxer sets this to 1 to indicate the palette has changed;
2482 * decoder resets to 0. */
2483 int palette_changed;
2485 /* 4-byte ARGB palette entries, stored in native byte order; note that
2486 * the individual palette components should be on a 8-bit scale; if
2487 * the palette data comes from an IBM VGA native format, the component
2488 * data is probably 6 bits in size and needs to be scaled. */
2489 unsigned int palette[AVPALETTE_COUNT];
2491 } AVPaletteControl attribute_deprecated;
2493 enum AVSubtitleType {
2496 SUBTITLE_BITMAP, ///< A bitmap, pict will be set
2499 * Plain text, the text field must be set by the decoder and is
2500 * authoritative. ass and pict fields may contain approximations.
2505 * Formatted text, the ass field must be set by the decoder and is
2506 * authoritative. pict and text fields may contain approximations.
2511 typedef struct AVSubtitleRect {
2512 int x; ///< top left corner of pict, undefined when pict is not set
2513 int y; ///< top left corner of pict, undefined when pict is not set
2514 int w; ///< width of pict, undefined when pict is not set
2515 int h; ///< height of pict, undefined when pict is not set
2516 int nb_colors; ///< number of colors in pict, undefined when pict is not set
2519 * data+linesize for the bitmap of this subtitle.
2520 * can be set for text/ass as well once they where rendered
2523 enum AVSubtitleType type;
2525 char *text; ///< 0 terminated plain UTF-8 text
2528 * 0 terminated ASS/SSA compatible event line.
2529 * The pressentation of this is unaffected by the other values in this
2535 typedef struct AVSubtitle {
2536 uint16_t format; /* 0 = graphics */
2537 uint32_t start_display_time; /* relative to packet pts, in ms */
2538 uint32_t end_display_time; /* relative to packet pts, in ms */
2540 AVSubtitleRect **rects;
2546 struct ReSampleContext;
2547 struct AVResampleContext;
2549 typedef struct ReSampleContext ReSampleContext;
2551 #if LIBAVCODEC_VERSION_MAJOR < 53
2553 * @deprecated Use av_audio_resample_init() instead.
2555 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2556 int output_rate, int input_rate);
2559 * Initializes audio resampling context
2561 * @param output_channels number of output channels
2562 * @param input_channels number of input channels
2563 * @param output_rate output sample rate
2564 * @param input_rate input sample rate
2565 * @param sample_fmt_out requested output sample format
2566 * @param sample_fmt_in input sample format
2567 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2568 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2569 * @param linear If 1 then the used FIR filter will be linearly interpolated
2570 between the 2 closest, if 0 the closest will be used
2571 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2572 * @return allocated ReSampleContext, NULL if error occured
2574 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2575 int output_rate, int input_rate,
2576 enum SampleFormat sample_fmt_out,
2577 enum SampleFormat sample_fmt_in,
2578 int filter_length, int log2_phase_count,
2579 int linear, double cutoff);
2581 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2582 void audio_resample_close(ReSampleContext *s);
2586 * Initializes an audio resampler.
2587 * Note, if either rate is not an integer then simply scale both rates up so they are.
2588 * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2589 * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2590 * @param linear If 1 then the used FIR filter will be linearly interpolated
2591 between the 2 closest, if 0 the closest will be used
2592 * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2594 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2598 * @param src an array of unconsumed samples
2599 * @param consumed the number of samples of src which have been consumed are returned here
2600 * @param src_size the number of unconsumed samples available
2601 * @param dst_size the amount of space in samples available in dst
2602 * @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.
2603 * @return the number of samples written in dst or -1 if an error occurred
2605 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2609 * Compensates samplerate/timestamp drift. The compensation is done by changing
2610 * the resampler parameters, so no audible clicks or similar distortions occur
2611 * @param compensation_distance distance in output samples over which the compensation should be performed
2612 * @param sample_delta number of output samples which should be output less
2614 * example: av_resample_compensate(c, 10, 500)
2615 * here instead of 510 samples only 500 samples would be output
2617 * note, due to rounding the actual compensation might be slightly different,
2618 * especially if the compensation_distance is large and the in_rate used during init is small
2620 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2621 void av_resample_close(struct AVResampleContext *c);
2624 * Allocate memory for a picture. Call avpicture_free to free it.
2626 * @param picture the picture to be filled in
2627 * @param pix_fmt the format of the picture
2628 * @param width the width of the picture
2629 * @param height the height of the picture
2630 * @return zero if successful, a negative value if not
2632 int avpicture_alloc(AVPicture *picture, int pix_fmt, int width, int height);
2635 * Free a picture previously allocated by avpicture_alloc().
2637 * @param picture the AVPicture to be freed
2639 void avpicture_free(AVPicture *picture);
2642 * Fill in the AVPicture fields.
2643 * The fields of the given AVPicture are filled in by using the 'ptr' address
2644 * which points to the image data buffer. Depending on the specified picture
2645 * format, one or multiple image data pointers and line sizes will be set.
2646 * If a planar format is specified, several pointers will be set pointing to
2647 * the different picture planes and the line sizes of the different planes
2648 * will be stored in the lines_sizes array.
2650 * @param picture AVPicture whose fields are to be filled in
2651 * @param ptr Buffer which will contain or contains the actual image data
2652 * @param pix_fmt The format in which the picture data is stored.
2653 * @param width the width of the image in pixels
2654 * @param height the height of the image in pixels
2655 * @return size of the image data in bytes
2657 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2658 int pix_fmt, int width, int height);
2659 int avpicture_layout(const AVPicture* src, int pix_fmt, int width, int height,
2660 unsigned char *dest, int dest_size);
2663 * Calculate the size in bytes that a picture of the given width and height
2664 * would occupy if stored in the given picture format.
2666 * @param pix_fmt the given picture format
2667 * @param width the width of the image
2668 * @param height the height of the image
2669 * @return Image data size in bytes
2671 int avpicture_get_size(int pix_fmt, int width, int height);
2672 void avcodec_get_chroma_sub_sample(int pix_fmt, int *h_shift, int *v_shift);
2673 const char *avcodec_get_pix_fmt_name(int pix_fmt);
2674 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2675 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2676 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2678 #define FF_LOSS_RESOLUTION 0x0001 /**< loss due to resolution change */
2679 #define FF_LOSS_DEPTH 0x0002 /**< loss due to color depth change */
2680 #define FF_LOSS_COLORSPACE 0x0004 /**< loss due to color space conversion */
2681 #define FF_LOSS_ALPHA 0x0008 /**< loss of alpha bits */
2682 #define FF_LOSS_COLORQUANT 0x0010 /**< loss due to color quantization */
2683 #define FF_LOSS_CHROMA 0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2686 * Computes what kind of losses will occur when converting from one specific
2687 * pixel format to another.
2688 * When converting from one pixel format to another, information loss may occur.
2689 * For example, when converting from RGB24 to GRAY, the color information will
2690 * be lost. Similarly, other losses occur when converting from some formats to
2691 * other formats. These losses can involve loss of chroma, but also loss of
2692 * resolution, loss of color depth, loss due to the color space conversion, loss
2693 * of the alpha bits or loss due to color quantization.
2694 * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2695 * which will occur when converting from one pixel format to another.
2697 * @param[in] dst_pix_fmt destination pixel format
2698 * @param[in] src_pix_fmt source pixel format
2699 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2700 * @return Combination of flags informing you what kind of losses will occur.
2702 int avcodec_get_pix_fmt_loss(int dst_pix_fmt, int src_pix_fmt,
2706 * Finds the best pixel format to convert to given a certain source pixel
2707 * format. When converting from one pixel format to another, information loss
2708 * may occur. For example, when converting from RGB24 to GRAY, the color
2709 * information will be lost. Similarly, other losses occur when converting from
2710 * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2711 * the given pixel formats should be used to suffer the least amount of loss.
2712 * The pixel formats from which it chooses one, are determined by the
2713 * \p pix_fmt_mask parameter.
2716 * src_pix_fmt = PIX_FMT_YUV420P;
2717 * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2718 * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2721 * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2722 * @param[in] src_pix_fmt source pixel format
2723 * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2724 * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2725 * @return The best pixel format to convert to or -1 if none was found.
2727 int avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, int src_pix_fmt,
2728 int has_alpha, int *loss_ptr);
2732 * Print in buf the string corresponding to the pixel format with
2733 * number pix_fmt, or an header if pix_fmt is negative.
2735 * @param[in] buf the buffer where to write the string
2736 * @param[in] buf_size the size of buf
2737 * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2738 * a negative value to print the corresponding header.
2739 * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2741 void avcodec_pix_fmt_string (char *buf, int buf_size, int pix_fmt);
2743 #define FF_ALPHA_TRANSP 0x0001 /* image has some totally transparent pixels */
2744 #define FF_ALPHA_SEMI_TRANSP 0x0002 /* image has some transparent pixels */
2747 * Tell if an image really has transparent alpha values.
2748 * @return ored mask of FF_ALPHA_xxx constants
2750 int img_get_alpha_info(const AVPicture *src,
2751 int pix_fmt, int width, int height);
2753 /* deinterlace a picture */
2754 /* deinterlace - if not supported return -1 */
2755 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2756 int pix_fmt, int width, int height);
2758 /* external high level API */
2761 * If c is NULL, returns the first registered codec,
2762 * if c is non-NULL, returns the next registered codec after c,
2763 * or NULL if c is the last one.
2765 AVCodec *av_codec_next(AVCodec *c);
2768 * Returns the LIBAVCODEC_VERSION_INT constant.
2770 unsigned avcodec_version(void);
2773 * Initializes libavcodec.
2775 * @warning This function \e must be called before any other libavcodec
2778 void avcodec_init(void);
2780 #if LIBAVCODEC_VERSION_MAJOR < 53
2782 * @deprecated Deprecated in favor of avcodec_register().
2784 attribute_deprecated void register_avcodec(AVCodec *codec);
2788 * Register the codec \p codec and initialize libavcodec.
2790 * @see avcodec_init()
2792 void avcodec_register(AVCodec *codec);
2795 * Finds a registered encoder with a matching codec ID.
2797 * @param id CodecID of the requested encoder
2798 * @return An encoder if one was found, NULL otherwise.
2800 AVCodec *avcodec_find_encoder(enum CodecID id);
2803 * Finds a registered encoder with the specified name.
2805 * @param name name of the requested encoder
2806 * @return An encoder if one was found, NULL otherwise.
2808 AVCodec *avcodec_find_encoder_by_name(const char *name);
2811 * Finds a registered decoder with a matching codec ID.
2813 * @param id CodecID of the requested decoder
2814 * @return A decoder if one was found, NULL otherwise.
2816 AVCodec *avcodec_find_decoder(enum CodecID id);
2819 * Finds a registered decoder with the specified name.
2821 * @param name name of the requested decoder
2822 * @return A decoder if one was found, NULL otherwise.
2824 AVCodec *avcodec_find_decoder_by_name(const char *name);
2825 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2828 * Sets the fields of the given AVCodecContext to default values.
2830 * @param s The AVCodecContext of which the fields should be set to default values.
2832 void avcodec_get_context_defaults(AVCodecContext *s);
2834 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2835 * we WILL change its arguments and name a few times! */
2836 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2839 * Allocates an AVCodecContext and sets its fields to default values. The
2840 * resulting struct can be deallocated by simply calling av_free().
2842 * @return An AVCodecContext filled with default values or NULL on failure.
2843 * @see avcodec_get_context_defaults
2845 AVCodecContext *avcodec_alloc_context(void);
2847 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2848 * we WILL change its arguments and name a few times! */
2849 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2852 * Sets the fields of the given AVFrame to default values.
2854 * @param pic The AVFrame of which the fields should be set to default values.
2856 void avcodec_get_frame_defaults(AVFrame *pic);
2859 * Allocates an AVFrame and sets its fields to default values. The resulting
2860 * struct can be deallocated by simply calling av_free().
2862 * @return An AVFrame filled with default values or NULL on failure.
2863 * @see avcodec_get_frame_defaults
2865 AVFrame *avcodec_alloc_frame(void);
2867 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2868 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2869 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2870 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2873 * Checks if the given dimension of a picture is valid, meaning that all
2874 * bytes of the picture can be addressed with a signed int.
2876 * @param[in] w Width of the picture.
2877 * @param[in] h Height of the picture.
2878 * @return Zero if valid, a negative value if invalid.
2880 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2881 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2883 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2884 void avcodec_thread_free(AVCodecContext *s);
2885 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2886 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2887 //FIXME func typedef
2890 * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2891 * function the context has to be allocated.
2893 * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2894 * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2895 * retrieving a codec.
2897 * @warning This function is not thread safe!
2900 * avcodec_register_all();
2901 * codec = avcodec_find_decoder(CODEC_ID_H264);
2905 * context = avcodec_alloc_context();
2907 * if (avcodec_open(context, codec) < 0)
2911 * @param avctx The context which will be set up to use the given codec.
2912 * @param codec The codec to use within the context.
2913 * @return zero on success, a negative value on error
2914 * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
2916 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
2919 * Decodes an audio frame from \p buf into \p samples.
2920 * The avcodec_decode_audio2() function decodes an audio frame from the input
2921 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2922 * audio codec which was coupled with \p avctx using avcodec_open(). The
2923 * resulting decoded frame is stored in output buffer \p samples. If no frame
2924 * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
2925 * decompressed frame size in \e bytes.
2927 * @warning You \e must set \p frame_size_ptr to the allocated size of the
2928 * output buffer before calling avcodec_decode_audio2().
2930 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2931 * the actual read bytes because some optimized bitstream readers read 32 or 64
2932 * bits at once and could read over the end.
2934 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2935 * no overreading happens for damaged MPEG streams.
2937 * @note You might have to align the input buffer \p buf and output buffer \p
2938 * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
2939 * necessary at all, on others it won't work at all if not aligned and on others
2940 * it will work but it will have an impact on performance. In practice, the
2941 * bitstream should have 4 byte alignment at minimum and all sample data should
2942 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2943 * the linesize is not a multiple of 16 then there's no sense in aligning the
2944 * start of the buffer to 16.
2946 * @param avctx the codec context
2947 * @param[out] samples the output buffer
2948 * @param[in,out] frame_size_ptr the output buffer size in bytes
2949 * @param[in] buf the input buffer
2950 * @param[in] buf_size the input buffer size in bytes
2951 * @return On error a negative value is returned, otherwise the number of bytes
2952 * used or zero if no frame could be decompressed.
2954 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
2955 int *frame_size_ptr,
2956 const uint8_t *buf, int buf_size);
2959 * Decodes a video frame from \p buf into \p picture.
2960 * The avcodec_decode_video() function decodes a video frame from the input
2961 * buffer \p buf of size \p buf_size. To decode it, it makes use of the
2962 * video codec which was coupled with \p avctx using avcodec_open(). The
2963 * resulting decoded frame is stored in \p picture.
2965 * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
2966 * the actual read bytes because some optimized bitstream readers read 32 or 64
2967 * bits at once and could read over the end.
2969 * @warning The end of the input buffer \p buf should be set to 0 to ensure that
2970 * no overreading happens for damaged MPEG streams.
2972 * @note You might have to align the input buffer \p buf and output buffer \p
2973 * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
2974 * necessary at all, on others it won't work at all if not aligned and on others
2975 * it will work but it will have an impact on performance. In practice, the
2976 * bitstream should have 4 byte alignment at minimum and all sample data should
2977 * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
2978 * the linesize is not a multiple of 16 then there's no sense in aligning the
2979 * start of the buffer to 16.
2981 * @note Some codecs have a delay between input and output, these need to be
2982 * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
2984 * @param avctx the codec context
2985 * @param[out] picture The AVFrame in which the decoded video frame will be stored.
2986 * @param[in] buf the input buffer
2987 * @param[in] buf_size the size of the input buffer in bytes
2988 * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
2989 * @return On error a negative value is returned, otherwise the number of bytes
2990 * used or zero if no frame could be decompressed.
2992 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
2993 int *got_picture_ptr,
2994 const uint8_t *buf, int buf_size);
2996 /* Decode a subtitle message. Return -1 if error, otherwise return the
2997 * number of bytes used. If no subtitle could be decompressed,
2998 * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
2999 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3001 const uint8_t *buf, int buf_size);
3002 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3004 uint8_t *buf, int buf_size);
3007 * Encodes an audio frame from \p samples into \p buf.
3008 * The avcodec_encode_audio() function encodes an audio frame from the input
3009 * buffer \p samples. To encode it, it makes use of the audio codec which was
3010 * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3011 * stored in output buffer \p buf.
3013 * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3015 * @param avctx the codec context
3016 * @param[out] buf the output buffer
3017 * @param[in] buf_size the output buffer size
3018 * @param[in] samples the input buffer containing the samples
3019 * The number of samples read from this buffer is frame_size*channels,
3020 * both of which are defined in \p avctx.
3021 * For PCM audio the number of samples read from \p samples is equal to
3022 * \p buf_size * input_sample_size / output_sample_size.
3023 * @return On error a negative value is returned, on success zero or the number
3024 * of bytes used to encode the data read from the input buffer.
3026 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3027 const short *samples);
3030 * Encodes a video frame from \p pict into \p buf.
3031 * The avcodec_encode_video() function encodes a video frame from the input
3032 * \p pict. To encode it, it makes use of the video codec which was coupled with
3033 * \p avctx using avcodec_open(). The resulting encoded bytes representing the
3034 * frame are stored in the output buffer \p buf. The input picture should be
3035 * stored using a specific format, namely \c avctx.pix_fmt.
3037 * @param avctx the codec context
3038 * @param[out] buf the output buffer for the bitstream of encoded frame
3039 * @param[in] buf_size the size of the output buffer in bytes
3040 * @param[in] pict the input picture to encode
3041 * @return On error a negative value is returned, on success zero or the number
3042 * of bytes used from the output buffer.
3044 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3045 const AVFrame *pict);
3046 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3047 const AVSubtitle *sub);
3049 int avcodec_close(AVCodecContext *avctx);
3052 * Register all the codecs, parsers and bitstream filters which were enabled at
3053 * configuration time. If you do not call this function you can select exactly
3054 * which formats you want to support, by using the individual registration
3057 * @see avcodec_register
3058 * @see av_register_codec_parser
3059 * @see av_register_bitstream_filter
3061 void avcodec_register_all(void);
3064 * Flush buffers, should be called when seeking or when switching to a different stream.
3066 void avcodec_flush_buffers(AVCodecContext *avctx);
3068 void avcodec_default_free_buffers(AVCodecContext *s);
3070 /* misc useful functions */
3073 * Returns a single letter to describe the given picture type \p pict_type.
3075 * @param[in] pict_type the picture type
3076 * @return A single character representing the picture type.
3078 char av_get_pict_type_char(int pict_type);
3081 * Returns codec bits per sample.
3083 * @param[in] codec_id the codec
3084 * @return Number of bits per sample or zero if unknown for the given codec.
3086 int av_get_bits_per_sample(enum CodecID codec_id);
3089 * Returns sample format bits per sample.
3091 * @param[in] sample_fmt the sample format
3092 * @return Number of bits per sample or zero if unknown for the given sample format.
3094 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3097 typedef struct AVCodecParserContext {
3099 struct AVCodecParser *parser;
3100 int64_t frame_offset; /* offset of the current frame */
3101 int64_t cur_offset; /* current offset
3102 (incremented by each av_parser_parse()) */
3103 int64_t next_frame_offset; /* offset of the next frame */
3105 int pict_type; /* XXX: Put it back in AVCodecContext. */
3107 * This field is used for proper frame duration computation in lavf.
3108 * It signals, how much longer the frame duration of the current frame
3109 * is compared to normal frame duration.
3111 * frame_duration = (1 + repeat_pict) * time_base
3113 * It is used by codecs like H.264 to display telecined material.
3115 int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3116 int64_t pts; /* pts of the current frame */
3117 int64_t dts; /* dts of the current frame */
3122 int fetch_timestamp;
3124 #define AV_PARSER_PTS_NB 4
3125 int cur_frame_start_index;
3126 int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3127 int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3128 int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3131 #define PARSER_FLAG_COMPLETE_FRAMES 0x0001
3133 int64_t offset; ///< byte offset from starting packet start
3134 int64_t cur_frame_end[AV_PARSER_PTS_NB];
3137 * Set by parser to 1 for key frames and 0 for non-key frames.
3138 * It is initialized to -1, so if the parser doesn't set this flag,
3139 * old-style fallback using FF_I_TYPE picture type as key frames
3145 * Time difference in stream time base units from the pts of this
3146 * packet to the point at which the output from the decoder has converged
3147 * independent from the availability of previous frames. That is, the
3148 * frames are virtually identical no matter if decoding started from
3149 * the very first frame or from this keyframe.
3150 * Is AV_NOPTS_VALUE if unknown.
3151 * This field is not the display duration of the current frame.
3153 * The purpose of this field is to allow seeking in streams that have no
3154 * keyframes in the conventional sense. It corresponds to the
3155 * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3156 * essential for some types of subtitle streams to ensure that all
3157 * subtitles are correctly displayed after seeking.
3159 int64_t convergence_duration;
3161 // Timestamp generation support:
3163 * Synchronization point for start of timestamp generation.
3165 * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3168 * For example, this corresponds to presence of H.264 buffering period
3174 * Offset of the current timestamp against last timestamp sync point in
3175 * units of AVCodecContext.time_base.
3177 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3178 * contain a valid timestamp offset.
3180 * Note that the timestamp of sync point has usually a nonzero
3181 * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3182 * the next frame after timestamp sync point will be usually 1.
3184 * For example, this corresponds to H.264 cpb_removal_delay.
3186 int dts_ref_dts_delta;
3189 * Presentation delay of current frame in units of AVCodecContext.time_base.
3191 * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3192 * contain valid non-negative timestamp delta (presentation time of a frame
3193 * must not lie in the past).
3195 * This delay represents the difference between decoding and presentation
3196 * time of the frame.
3198 * For example, this corresponds to H.264 dpb_output_delay.
3201 } AVCodecParserContext;
3203 typedef struct AVCodecParser {
3204 int codec_ids[5]; /* several codec IDs are permitted */
3206 int (*parser_init)(AVCodecParserContext *s);
3207 int (*parser_parse)(AVCodecParserContext *s,
3208 AVCodecContext *avctx,
3209 const uint8_t **poutbuf, int *poutbuf_size,
3210 const uint8_t *buf, int buf_size);
3211 void (*parser_close)(AVCodecParserContext *s);
3212 int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3213 struct AVCodecParser *next;
3216 AVCodecParser *av_parser_next(AVCodecParser *c);
3218 void av_register_codec_parser(AVCodecParser *parser);
3219 AVCodecParserContext *av_parser_init(int codec_id);
3220 int av_parser_parse(AVCodecParserContext *s,
3221 AVCodecContext *avctx,
3222 uint8_t **poutbuf, int *poutbuf_size,
3223 const uint8_t *buf, int buf_size,
3224 int64_t pts, int64_t dts);
3225 int av_parser_change(AVCodecParserContext *s,
3226 AVCodecContext *avctx,
3227 uint8_t **poutbuf, int *poutbuf_size,
3228 const uint8_t *buf, int buf_size, int keyframe);
3229 void av_parser_close(AVCodecParserContext *s);
3232 typedef struct AVBitStreamFilterContext {
3234 struct AVBitStreamFilter *filter;
3235 AVCodecParserContext *parser;
3236 struct AVBitStreamFilterContext *next;
3237 } AVBitStreamFilterContext;
3240 typedef struct AVBitStreamFilter {
3243 int (*filter)(AVBitStreamFilterContext *bsfc,
3244 AVCodecContext *avctx, const char *args,
3245 uint8_t **poutbuf, int *poutbuf_size,
3246 const uint8_t *buf, int buf_size, int keyframe);
3247 void (*close)(AVBitStreamFilterContext *bsfc);
3248 struct AVBitStreamFilter *next;
3249 } AVBitStreamFilter;
3251 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3252 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3253 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3254 AVCodecContext *avctx, const char *args,
3255 uint8_t **poutbuf, int *poutbuf_size,
3256 const uint8_t *buf, int buf_size, int keyframe);
3257 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3259 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3264 * Reallocates the given block if it is not large enough, otherwise it
3269 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3272 * Copy image 'src' to 'dst'.
3274 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3275 int pix_fmt, int width, int height);
3278 * Crop image top and left side.
3280 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3281 int pix_fmt, int top_band, int left_band);
3286 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, int pix_fmt,
3287 int padtop, int padbottom, int padleft, int padright, int *color);
3289 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3292 * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3294 * @return 0 in case of a successful parsing, a negative value otherwise
3295 * @param[in] str the string to parse: it has to be a string in the format
3296 * <width>x<height> or a valid video frame size abbreviation.
3297 * @param[in,out] width_ptr pointer to the variable which will contain the detected
3299 * @param[in,out] height_ptr pointer to the variable which will contain the detected
3300 * frame height value
3302 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3305 * Parses \p str and put in \p frame_rate the detected values.
3307 * @return 0 in case of a successful parsing, a negative value otherwise
3308 * @param[in] str the string to parse: it has to be a string in the format
3309 * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3310 * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3313 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3315 /* error handling */
3317 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3318 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3320 /* Some platforms have E* and errno already negated. */
3321 #define AVERROR(e) (e)
3322 #define AVUNERROR(e) (e)
3324 #define AVERROR_UNKNOWN AVERROR(EINVAL) /**< unknown error */
3325 #define AVERROR_IO AVERROR(EIO) /**< I/O error */
3326 #define AVERROR_NUMEXPECTED AVERROR(EDOM) /**< Number syntax expected in filename. */
3327 #define AVERROR_INVALIDDATA AVERROR(EINVAL) /**< invalid data found */
3328 #define AVERROR_NOMEM AVERROR(ENOMEM) /**< not enough memory */
3329 #define AVERROR_NOFMT AVERROR(EILSEQ) /**< unknown format */
3330 #define AVERROR_NOTSUPP AVERROR(ENOSYS) /**< Operation not supported. */
3331 #define AVERROR_NOENT AVERROR(ENOENT) /**< No such file or directory. */
3332 #define AVERROR_EOF AVERROR(EPIPE) /**< End of file. */
3333 #define AVERROR_PATCHWELCOME -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3336 * Registers the hardware accelerator \p hwaccel.
3338 void av_register_hwaccel(AVHWAccel *hwaccel);
3341 * If hwaccel is NULL, returns the first registered hardware accelerator,
3342 * if hwaccel is non-NULL, returns the next registered hardware accelerator
3343 * after hwaccel, or NULL if hwaccel is the last one.
3345 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3347 #endif /* AVCODEC_AVCODEC_H */