libavcodec/avcodec.h

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  */
  20
  21 #ifndef AVCODEC_AVCODEC_H
  22 #define AVCODEC_AVCODEC_H
  23
  24 /**
  25  * @file libavcodec/avcodec.h
  26  * external API header
  27  */
  28
  29 #include <errno.h>
  30 #include "libavutil/avutil.h"
  31
  32 #define LIBAVCODEC_VERSION_MAJOR 52
  33 #define LIBAVCODEC_VERSION_MINOR 23
  34 #define LIBAVCODEC_VERSION_MICRO  0
  35
  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
  43
  44 #define LIBAVCODEC_IDENT        "Lavc" AV_STRINGIFY(LIBAVCODEC_VERSION)
  45
  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}
  49
  50 /**
  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
  56  * details.
  57  *
  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.
  61  */
  62 enum CodecID {
  63     CODEC_ID_NONE,
  64
  65     /* video codecs */
  66     CODEC_ID_MPEG1VIDEO,
  67     CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
  68     CODEC_ID_MPEG2VIDEO_XVMC,
  69     CODEC_ID_H261,
  70     CODEC_ID_H263,
  71     CODEC_ID_RV10,
  72     CODEC_ID_RV20,
  73     CODEC_ID_MJPEG,
  74     CODEC_ID_MJPEGB,
  75     CODEC_ID_LJPEG,
  76     CODEC_ID_SP5X,
  77     CODEC_ID_JPEGLS,
  78     CODEC_ID_MPEG4,
  79     CODEC_ID_RAWVIDEO,
  80     CODEC_ID_MSMPEG4V1,
  81     CODEC_ID_MSMPEG4V2,
  82     CODEC_ID_MSMPEG4V3,
  83     CODEC_ID_WMV1,
  84     CODEC_ID_WMV2,
  85     CODEC_ID_H263P,
  86     CODEC_ID_H263I,
  87     CODEC_ID_FLV1,
  88     CODEC_ID_SVQ1,
  89     CODEC_ID_SVQ3,
  90     CODEC_ID_DVVIDEO,
  91     CODEC_ID_HUFFYUV,
  92     CODEC_ID_CYUV,
  93     CODEC_ID_H264,
  94     CODEC_ID_INDEO3,
  95     CODEC_ID_VP3,
  96     CODEC_ID_THEORA,
  97     CODEC_ID_ASV1,
  98     CODEC_ID_ASV2,
  99     CODEC_ID_FFV1,
 100     CODEC_ID_4XM,
 101     CODEC_ID_VCR1,
 102     CODEC_ID_CLJR,
 103     CODEC_ID_MDEC,
 104     CODEC_ID_ROQ,
 105     CODEC_ID_INTERPLAY_VIDEO,
 106     CODEC_ID_XAN_WC3,
 107     CODEC_ID_XAN_WC4,
 108     CODEC_ID_RPZA,
 109     CODEC_ID_CINEPAK,
 110     CODEC_ID_WS_VQA,
 111     CODEC_ID_MSRLE,
 112     CODEC_ID_MSVIDEO1,
 113     CODEC_ID_IDCIN,
 114     CODEC_ID_8BPS,
 115     CODEC_ID_SMC,
 116     CODEC_ID_FLIC,
 117     CODEC_ID_TRUEMOTION1,
 118     CODEC_ID_VMDVIDEO,
 119     CODEC_ID_MSZH,
 120     CODEC_ID_ZLIB,
 121     CODEC_ID_QTRLE,
 122     CODEC_ID_SNOW,
 123     CODEC_ID_TSCC,
 124     CODEC_ID_ULTI,
 125     CODEC_ID_QDRAW,
 126     CODEC_ID_VIXL,
 127     CODEC_ID_QPEG,
 128     CODEC_ID_XVID,
 129     CODEC_ID_PNG,
 130     CODEC_ID_PPM,
 131     CODEC_ID_PBM,
 132     CODEC_ID_PGM,
 133     CODEC_ID_PGMYUV,
 134     CODEC_ID_PAM,
 135     CODEC_ID_FFVHUFF,
 136     CODEC_ID_RV30,
 137     CODEC_ID_RV40,
 138     CODEC_ID_VC1,
 139     CODEC_ID_WMV3,
 140     CODEC_ID_LOCO,
 141     CODEC_ID_WNV1,
 142     CODEC_ID_AASC,
 143     CODEC_ID_INDEO2,
 144     CODEC_ID_FRAPS,
 145     CODEC_ID_TRUEMOTION2,
 146     CODEC_ID_BMP,
 147     CODEC_ID_CSCD,
 148     CODEC_ID_MMVIDEO,
 149     CODEC_ID_ZMBV,
 150     CODEC_ID_AVS,
 151     CODEC_ID_SMACKVIDEO,
 152     CODEC_ID_NUV,
 153     CODEC_ID_KMVC,
 154     CODEC_ID_FLASHSV,
 155     CODEC_ID_CAVS,
 156     CODEC_ID_JPEG2000,
 157     CODEC_ID_VMNC,
 158     CODEC_ID_VP5,
 159     CODEC_ID_VP6,
 160     CODEC_ID_VP6F,
 161     CODEC_ID_TARGA,
 162     CODEC_ID_DSICINVIDEO,
 163     CODEC_ID_TIERTEXSEQVIDEO,
 164     CODEC_ID_TIFF,
 165     CODEC_ID_GIF,
 166     CODEC_ID_FFH264,
 167     CODEC_ID_DXA,
 168     CODEC_ID_DNXHD,
 169     CODEC_ID_THP,
 170     CODEC_ID_SGI,
 171     CODEC_ID_C93,
 172     CODEC_ID_BETHSOFTVID,
 173     CODEC_ID_PTX,
 174     CODEC_ID_TXD,
 175     CODEC_ID_VP6A,
 176     CODEC_ID_AMV,
 177     CODEC_ID_VB,
 178     CODEC_ID_PCX,
 179     CODEC_ID_SUNRAST,
 180     CODEC_ID_INDEO4,
 181     CODEC_ID_INDEO5,
 182     CODEC_ID_MIMIC,
 183     CODEC_ID_RL2,
 184     CODEC_ID_8SVX_EXP,
 185     CODEC_ID_8SVX_FIB,
 186     CODEC_ID_ESCAPE124,
 187     CODEC_ID_DIRAC,
 188     CODEC_ID_BFI,
 189     CODEC_ID_CMV,
 190     CODEC_ID_MOTIONPIXELS,
 191     CODEC_ID_TGV,
 192     CODEC_ID_TGQ,
 193     CODEC_ID_TQI,
 194     CODEC_ID_AURA,
 195     CODEC_ID_AURA2,
 196
 197     /* various PCM "codecs" */
 198     CODEC_ID_PCM_S16LE= 0x10000,
 199     CODEC_ID_PCM_S16BE,
 200     CODEC_ID_PCM_U16LE,
 201     CODEC_ID_PCM_U16BE,
 202     CODEC_ID_PCM_S8,
 203     CODEC_ID_PCM_U8,
 204     CODEC_ID_PCM_MULAW,
 205     CODEC_ID_PCM_ALAW,
 206     CODEC_ID_PCM_S32LE,
 207     CODEC_ID_PCM_S32BE,
 208     CODEC_ID_PCM_U32LE,
 209     CODEC_ID_PCM_U32BE,
 210     CODEC_ID_PCM_S24LE,
 211     CODEC_ID_PCM_S24BE,
 212     CODEC_ID_PCM_U24LE,
 213     CODEC_ID_PCM_U24BE,
 214     CODEC_ID_PCM_S24DAUD,
 215     CODEC_ID_PCM_ZORK,
 216     CODEC_ID_PCM_S16LE_PLANAR,
 217     CODEC_ID_PCM_DVD,
 218     CODEC_ID_PCM_F32BE,
 219     CODEC_ID_PCM_F32LE,
 220     CODEC_ID_PCM_F64BE,
 221     CODEC_ID_PCM_F64LE,
 222
 223     /* various ADPCM codecs */
 224     CODEC_ID_ADPCM_IMA_QT= 0x11000,
 225     CODEC_ID_ADPCM_IMA_WAV,
 226     CODEC_ID_ADPCM_IMA_DK3,
 227     CODEC_ID_ADPCM_IMA_DK4,
 228     CODEC_ID_ADPCM_IMA_WS,
 229     CODEC_ID_ADPCM_IMA_SMJPEG,
 230     CODEC_ID_ADPCM_MS,
 231     CODEC_ID_ADPCM_4XM,
 232     CODEC_ID_ADPCM_XA,
 233     CODEC_ID_ADPCM_ADX,
 234     CODEC_ID_ADPCM_EA,
 235     CODEC_ID_ADPCM_G726,
 236     CODEC_ID_ADPCM_CT,
 237     CODEC_ID_ADPCM_SWF,
 238     CODEC_ID_ADPCM_YAMAHA,
 239     CODEC_ID_ADPCM_SBPRO_4,
 240     CODEC_ID_ADPCM_SBPRO_3,
 241     CODEC_ID_ADPCM_SBPRO_2,
 242     CODEC_ID_ADPCM_THP,
 243     CODEC_ID_ADPCM_IMA_AMV,
 244     CODEC_ID_ADPCM_EA_R1,
 245     CODEC_ID_ADPCM_EA_R3,
 246     CODEC_ID_ADPCM_EA_R2,
 247     CODEC_ID_ADPCM_IMA_EA_SEAD,
 248     CODEC_ID_ADPCM_IMA_EA_EACS,
 249     CODEC_ID_ADPCM_EA_XAS,
 250     CODEC_ID_ADPCM_EA_MAXIS_XA,
 251     CODEC_ID_ADPCM_IMA_ISS,
 252
 253     /* AMR */
 254     CODEC_ID_AMR_NB= 0x12000,
 255     CODEC_ID_AMR_WB,
 256
 257     /* RealAudio codecs*/
 258     CODEC_ID_RA_144= 0x13000,
 259     CODEC_ID_RA_288,
 260
 261     /* various DPCM codecs */
 262     CODEC_ID_ROQ_DPCM= 0x14000,
 263     CODEC_ID_INTERPLAY_DPCM,
 264     CODEC_ID_XAN_DPCM,
 265     CODEC_ID_SOL_DPCM,
 266
 267     /* audio codecs */
 268     CODEC_ID_MP2= 0x15000,
 269     CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
 270     CODEC_ID_AAC,
 271     CODEC_ID_AC3,
 272     CODEC_ID_DTS,
 273     CODEC_ID_VORBIS,
 274     CODEC_ID_DVAUDIO,
 275     CODEC_ID_WMAV1,
 276     CODEC_ID_WMAV2,
 277     CODEC_ID_MACE3,
 278     CODEC_ID_MACE6,
 279     CODEC_ID_VMDAUDIO,
 280     CODEC_ID_SONIC,
 281     CODEC_ID_SONIC_LS,
 282     CODEC_ID_FLAC,
 283     CODEC_ID_MP3ADU,
 284     CODEC_ID_MP3ON4,
 285     CODEC_ID_SHORTEN,
 286     CODEC_ID_ALAC,
 287     CODEC_ID_WESTWOOD_SND1,
 288     CODEC_ID_GSM, ///< as in Berlin toast format
 289     CODEC_ID_QDM2,
 290     CODEC_ID_COOK,
 291     CODEC_ID_TRUESPEECH,
 292     CODEC_ID_TTA,
 293     CODEC_ID_SMACKAUDIO,
 294     CODEC_ID_QCELP,
 295     CODEC_ID_WAVPACK,
 296     CODEC_ID_DSICINAUDIO,
 297     CODEC_ID_IMC,
 298     CODEC_ID_MUSEPACK7,
 299     CODEC_ID_MLP,
 300     CODEC_ID_GSM_MS, /* as found in WAV */
 301     CODEC_ID_ATRAC3,
 302     CODEC_ID_VOXWARE,
 303     CODEC_ID_APE,
 304     CODEC_ID_NELLYMOSER,
 305     CODEC_ID_MUSEPACK8,
 306     CODEC_ID_SPEEX,
 307     CODEC_ID_WMAVOICE,
 308     CODEC_ID_WMAPRO,
 309     CODEC_ID_WMALOSSLESS,
 310     CODEC_ID_ATRAC3P,
 311     CODEC_ID_EAC3,
 312     CODEC_ID_SIPR,
 313     CODEC_ID_MP1,
 314     CODEC_ID_TWINVQ,
 315     CODEC_ID_TRUEHD,
 316
 317     /* subtitle codecs */
 318     CODEC_ID_DVD_SUBTITLE= 0x17000,
 319     CODEC_ID_DVB_SUBTITLE,
 320     CODEC_ID_TEXT,  ///< raw UTF-8 text
 321     CODEC_ID_XSUB,
 322     CODEC_ID_SSA,
 323     CODEC_ID_MOV_TEXT,
 324
 325     /* other specific kind of codecs (generally used for attachments) */
 326     CODEC_ID_TTF= 0x18000,
 327
 328     CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
 329
 330     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 331                                 * stream (only used by libavformat) */
 332 };
 333
 334 enum CodecType {
 335     CODEC_TYPE_UNKNOWN = -1,
 336     CODEC_TYPE_VIDEO,
 337     CODEC_TYPE_AUDIO,
 338     CODEC_TYPE_DATA,
 339     CODEC_TYPE_SUBTITLE,
 340     CODEC_TYPE_ATTACHMENT,
 341     CODEC_TYPE_NB
 342 };
 343
 344 /**
 345  * all in native-endian format
 346  */
 347 enum SampleFormat {
 348     SAMPLE_FMT_NONE = -1,
 349     SAMPLE_FMT_U8,              ///< unsigned 8 bits
 350     SAMPLE_FMT_S16,             ///< signed 16 bits
 351     SAMPLE_FMT_S32,             ///< signed 32 bits
 352     SAMPLE_FMT_FLT,             ///< float
 353     SAMPLE_FMT_DBL,             ///< double
 354     SAMPLE_FMT_NB               ///< Number of sample formats. DO NOT USE if dynamically linking to libavcodec
 355 };
 356
 357 /* Audio channel masks */
 358 #define CH_FRONT_LEFT             0x00000001
 359 #define CH_FRONT_RIGHT            0x00000002
 360 #define CH_FRONT_CENTER           0x00000004
 361 #define CH_LOW_FREQUENCY          0x00000008
 362 #define CH_BACK_LEFT              0x00000010
 363 #define CH_BACK_RIGHT             0x00000020
 364 #define CH_FRONT_LEFT_OF_CENTER   0x00000040
 365 #define CH_FRONT_RIGHT_OF_CENTER  0x00000080
 366 #define CH_BACK_CENTER            0x00000100
 367 #define CH_SIDE_LEFT              0x00000200
 368 #define CH_SIDE_RIGHT             0x00000400
 369 #define CH_TOP_CENTER             0x00000800
 370 #define CH_TOP_FRONT_LEFT         0x00001000
 371 #define CH_TOP_FRONT_CENTER       0x00002000
 372 #define CH_TOP_FRONT_RIGHT        0x00004000
 373 #define CH_TOP_BACK_LEFT          0x00008000
 374 #define CH_TOP_BACK_CENTER        0x00010000
 375 #define CH_TOP_BACK_RIGHT         0x00020000
 376 #define CH_STEREO_LEFT            0x20000000  ///< Stereo downmix.
 377 #define CH_STEREO_RIGHT           0x40000000  ///< See CH_STEREO_LEFT.
 378
 379 /* Audio channel convenience macros */
 380 #define CH_LAYOUT_MONO              (CH_FRONT_CENTER)
 381 #define CH_LAYOUT_STEREO            (CH_FRONT_LEFT|CH_FRONT_RIGHT)
 382 #define CH_LAYOUT_SURROUND          (CH_LAYOUT_STEREO|CH_FRONT_CENTER)
 383 #define CH_LAYOUT_QUAD              (CH_LAYOUT_STEREO|CH_BACK_LEFT|CH_BACK_RIGHT)
 384 #define CH_LAYOUT_5POINT0           (CH_LAYOUT_SURROUND|CH_SIDE_LEFT|CH_SIDE_RIGHT)
 385 #define CH_LAYOUT_5POINT1           (CH_LAYOUT_5POINT0|CH_LOW_FREQUENCY)
 386 #define CH_LAYOUT_7POINT1           (CH_LAYOUT_5POINT1|CH_BACK_LEFT|CH_BACK_RIGHT)
 387 #define CH_LAYOUT_7POINT1_WIDE      (CH_LAYOUT_SURROUND|CH_LOW_FREQUENCY|\
 388                                           CH_BACK_LEFT|CH_BACK_RIGHT|\
 389                                           CH_FRONT_LEFT_OF_CENTER|CH_FRONT_RIGHT_OF_CENTER)
 390 #define CH_LAYOUT_STEREO_DOWNMIX    (CH_STEREO_LEFT|CH_STEREO_RIGHT)
 391
 392 /* in bytes */
 393 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
 394
 395 /**
 396  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 397  * This is mainly needed because some optimized bitstream readers read
 398  * 32 or 64 bit at once and could read over the end.<br>
 399  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 400  * MPEG bitstreams could cause overread and segfault.
 401  */
 402 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 403
 404 /**
 405  * minimum encoding buffer size
 406  * Used to avoid some checks during header writing.
 407  */
 408 #define FF_MIN_BUFFER_SIZE 16384
 409
 410
 411 /**
 412  * motion estimation type.
 413  */
 414 enum Motion_Est_ID {
 415     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 416     ME_FULL,
 417     ME_LOG,
 418     ME_PHODS,
 419     ME_EPZS,        ///< enhanced predictive zonal search
 420     ME_X1,          ///< reserved for experiments
 421     ME_HEX,         ///< hexagon based search
 422     ME_UMH,         ///< uneven multi-hexagon search
 423     ME_ITER,        ///< iterative search
 424     ME_TESA,        ///< transformed exhaustive search algorithm
 425 };
 426
 427 enum AVDiscard{
 428     /* We leave some space between them for extensions (drop some
 429      * keyframes for intra-only or drop just some bidir frames). */
 430     AVDISCARD_NONE   =-16, ///< discard nothing
 431     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
 432     AVDISCARD_NONREF =  8, ///< discard all non reference
 433     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
 434     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
 435     AVDISCARD_ALL    = 48, ///< discard all
 436 };
 437
 438 typedef struct RcOverride{
 439     int start_frame;
 440     int end_frame;
 441     int qscale; // If this is 0 then quality_factor will be used instead.
 442     float quality_factor;
 443 } RcOverride;
 444
 445 #define FF_MAX_B_FRAMES 16
 446
 447 /* encoding support
 448    These flags can be passed in AVCodecContext.flags before initialization.
 449    Note: Not everything is supported yet.
 450 */
 451
 452 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 453 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 454 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 455 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 456 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 457 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
 458 /**
 459  * The parent program guarantees that the input for B-frames containing
 460  * streams is not written to for at least s->max_b_frames+1 frames, if
 461  * this is not set the input will be copied.
 462  */
 463 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 464 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 465 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 466 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
 467 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 468 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
 469 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 470 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 471                                                   location instead of only at frame boundaries. */
 472 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 473 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 474 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 475 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
 476 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 477 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 478 /* Fx : Flag for h263+ extra options */
 479 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 480 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
 481 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
 482 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
 483 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
 484 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 485 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 486 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 487 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 488 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
 489 #define CODEC_FLAG_CLOSED_GOP     0x80000000
 490 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 491 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
 492 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 493 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 494 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
 495 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
 496 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
 497 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
 498 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
 499 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
 500 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
 501 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
 502 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
 503 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
 504 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
 505 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 506 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
 507 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
 508
 509 /* Unsupported options :
 510  *              Syntax Arithmetic coding (SAC)
 511  *              Reference Picture Selection
 512  *              Independent Segment Decoding */
 513 /* /Fx */
 514 /* codec capabilities */
 515
 516 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
 517 /**
 518  * Codec uses get_buffer() for allocating buffers.
 519  * direct rendering method 1
 520  */
 521 #define CODEC_CAP_DR1             0x0002
 522 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
 523 #define CODEC_CAP_PARSE_ONLY      0x0004
 524 #define CODEC_CAP_TRUNCATED       0x0008
 525 /* Codec can export data for HW decoding (XvMC). */
 526 #define CODEC_CAP_HWACCEL         0x0010
 527 /**
 528  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 529  * If this is not set, the codec is guaranteed to never be fed with NULL data.
 530  */
 531 #define CODEC_CAP_DELAY           0x0020
 532 /**
 533  * Codec can be fed a final frame with a smaller size.
 534  * This can be used to prevent truncation of the last audio samples.
 535  */
 536 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
 537 /**
 538  * Codec can export data for HW decoding (VDPAU).
 539  */
 540 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
 541
 542 //The following defines may change, don't expect compatibility if you use them.
 543 #define MB_TYPE_INTRA4x4   0x0001
 544 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 545 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
 546 #define MB_TYPE_16x16      0x0008
 547 #define MB_TYPE_16x8       0x0010
 548 #define MB_TYPE_8x16       0x0020
 549 #define MB_TYPE_8x8        0x0040
 550 #define MB_TYPE_INTERLACED 0x0080
 551 #define MB_TYPE_DIRECT2    0x0100 //FIXME
 552 #define MB_TYPE_ACPRED     0x0200
 553 #define MB_TYPE_GMC        0x0400
 554 #define MB_TYPE_SKIP       0x0800
 555 #define MB_TYPE_P0L0       0x1000
 556 #define MB_TYPE_P1L0       0x2000
 557 #define MB_TYPE_P0L1       0x4000
 558 #define MB_TYPE_P1L1       0x8000
 559 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 560 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 561 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 562 #define MB_TYPE_QUANT      0x00010000
 563 #define MB_TYPE_CBP        0x00020000
 564 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 565
 566 /**
 567  * Pan Scan area.
 568  * This specifies the area which should be displayed.
 569  * Note there may be multiple such areas for one frame.
 570  */
 571 typedef struct AVPanScan{
 572     /**
 573      * id
 574      * - encoding: Set by user.
 575      * - decoding: Set by libavcodec.
 576      */
 577     int id;
 578
 579     /**
 580      * width and height in 1/16 pel
 581      * - encoding: Set by user.
 582      * - decoding: Set by libavcodec.
 583      */
 584     int width;
 585     int height;
 586
 587     /**
 588      * position of the top left corner in 1/16 pel for up to 3 fields/frames
 589      * - encoding: Set by user.
 590      * - decoding: Set by libavcodec.
 591      */
 592     int16_t position[3][2];
 593 }AVPanScan;
 594
 595 #define FF_COMMON_FRAME \
 596     /**\
 597      * pointer to the picture planes.\
 598      * This might be different from the first allocated byte\
 599      * - encoding: \
 600      * - decoding: \
 601      */\
 602     uint8_t *data[4];\
 603     int linesize[4];\
 604     /**\
 605      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.\
 606      * This isn't used by libavcodec unless the default get/release_buffer() is used.\
 607      * - encoding: \
 608      * - decoding: \
 609      */\
 610     uint8_t *base[4];\
 611     /**\
 612      * 1 -> keyframe, 0-> not\
 613      * - encoding: Set by libavcodec.\
 614      * - decoding: Set by libavcodec.\
 615      */\
 616     int key_frame;\
 617 \
 618     /**\
 619      * Picture type of the frame, see ?_TYPE below.\
 620      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 621      * - decoding: Set by libavcodec.\
 622      */\
 623     int pict_type;\
 624 \
 625     /**\
 626      * presentation timestamp in time_base units (time when frame should be shown to user)\
 627      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.\
 628      * - encoding: MUST be set by user.\
 629      * - decoding: Set by libavcodec.\
 630      */\
 631     int64_t pts;\
 632 \
 633     /**\
 634      * picture number in bitstream order\
 635      * - encoding: set by\
 636      * - decoding: Set by libavcodec.\
 637      */\
 638     int coded_picture_number;\
 639     /**\
 640      * picture number in display order\
 641      * - encoding: set by\
 642      * - decoding: Set by libavcodec.\
 643      */\
 644     int display_picture_number;\
 645 \
 646     /**\
 647      * quality (between 1 (good) and FF_LAMBDA_MAX (bad)) \
 648      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).\
 649      * - decoding: Set by libavcodec.\
 650      */\
 651     int quality; \
 652 \
 653     /**\
 654      * buffer age (1->was last buffer and dint change, 2->..., ...).\
 655      * Set to INT_MAX if the buffer has not been used yet.\
 656      * - encoding: unused\
 657      * - decoding: MUST be set by get_buffer().\
 658      */\
 659     int age;\
 660 \
 661     /**\
 662      * is this picture used as reference\
 663      * The values for this are the same as the MpegEncContext.picture_structure\
 664      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.\
 665      * Set to 4 for delayed, non-reference frames.\
 666      * - encoding: unused\
 667      * - decoding: Set by libavcodec. (before get_buffer() call)).\
 668      */\
 669     int reference;\
 670 \
 671     /**\
 672      * QP table\
 673      * - encoding: unused\
 674      * - decoding: Set by libavcodec.\
 675      */\
 676     int8_t *qscale_table;\
 677     /**\
 678      * QP store stride\
 679      * - encoding: unused\
 680      * - decoding: Set by libavcodec.\
 681      */\
 682     int qstride;\
 683 \
 684     /**\
 685      * mbskip_table[mb]>=1 if MB didn't change\
 686      * stride= mb_width = (width+15)>>4\
 687      * - encoding: unused\
 688      * - decoding: Set by libavcodec.\
 689      */\
 690     uint8_t *mbskip_table;\
 691 \
 692     /**\
 693      * motion vector table\
 694      * @code\
 695      * example:\
 696      * int mv_sample_log2= 4 - motion_subsample_log2;\
 697      * int mb_width= (width+15)>>4;\
 698      * int mv_stride= (mb_width << mv_sample_log2) + 1;\
 699      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];\
 700      * @endcode\
 701      * - encoding: Set by user.\
 702      * - decoding: Set by libavcodec.\
 703      */\
 704     int16_t (*motion_val[2])[2];\
 705 \
 706     /**\
 707      * macroblock type table\
 708      * mb_type_base + mb_width + 2\
 709      * - encoding: Set by user.\
 710      * - decoding: Set by libavcodec.\
 711      */\
 712     uint32_t *mb_type;\
 713 \
 714     /**\
 715      * log2 of the size of the block which a single vector in motion_val represents: \
 716      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)\
 717      * - encoding: unused\
 718      * - decoding: Set by libavcodec.\
 719      */\
 720     uint8_t motion_subsample_log2;\
 721 \
 722     /**\
 723      * for some private data of the user\
 724      * - encoding: unused\
 725      * - decoding: Set by user.\
 726      */\
 727     void *opaque;\
 728 \
 729     /**\
 730      * error\
 731      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.\
 732      * - decoding: unused\
 733      */\
 734     uint64_t error[4];\
 735 \
 736     /**\
 737      * type of the buffer (to keep track of who has to deallocate data[*])\
 738      * - encoding: Set by the one who allocates it.\
 739      * - decoding: Set by the one who allocates it.\
 740      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.\
 741      */\
 742     int type;\
 743     \
 744     /**\
 745      * When decoding, this signals how much the picture must be delayed.\
 746      * extra_delay = repeat_pict / (2*fps)\
 747      * - encoding: unused\
 748      * - decoding: Set by libavcodec.\
 749      */\
 750     int repeat_pict;\
 751     \
 752     /**\
 753      * \
 754      */\
 755     int qscale_type;\
 756     \
 757     /**\
 758      * The content of the picture is interlaced.\
 759      * - encoding: Set by user.\
 760      * - decoding: Set by libavcodec. (default 0)\
 761      */\
 762     int interlaced_frame;\
 763     \
 764     /**\
 765      * If the content is interlaced, is top field displayed first.\
 766      * - encoding: Set by user.\
 767      * - decoding: Set by libavcodec.\
 768      */\
 769     int top_field_first;\
 770     \
 771     /**\
 772      * Pan scan.\
 773      * - encoding: Set by user.\
 774      * - decoding: Set by libavcodec.\
 775      */\
 776     AVPanScan *pan_scan;\
 777     \
 778     /**\
 779      * Tell user application that palette has changed from previous frame.\
 780      * - encoding: ??? (no palette-enabled encoder yet)\
 781      * - decoding: Set by libavcodec. (default 0).\
 782      */\
 783     int palette_has_changed;\
 784     \
 785     /**\
 786      * codec suggestion on buffer type if != 0\
 787      * - encoding: unused\
 788      * - decoding: Set by libavcodec. (before get_buffer() call)).\
 789      */\
 790     int buffer_hints;\
 791 \
 792     /**\
 793      * DCT coefficients\
 794      * - encoding: unused\
 795      * - decoding: Set by libavcodec.\
 796      */\
 797     short *dct_coeff;\
 798 \
 799     /**\
 800      * motion referece frame index\
 801      * - encoding: Set by user.\
 802      * - decoding: Set by libavcodec.\
 803      */\
 804     int8_t *ref_index[2];\
 805 \
 806     /**\
 807      * reordered opaque 64bit number (generally a PTS) from AVCodecContext.reordered_opaque\
 808      * output in AVFrame.reordered_opaque\
 809      * - encoding: unused\
 810      * - decoding: Read by user.\
 811      */\
 812     int64_t reordered_opaque;\
 813 \
 814     /**\
 815      * hardware accelerator private data (FFmpeg allocated)\
 816      * - encoding: unused\
 817      * - decoding: Set by libavcodec\
 818      */\
 819     void *hwaccel_picture_private;\
 820
 821
 822 #define FF_QSCALE_TYPE_MPEG1 0
 823 #define FF_QSCALE_TYPE_MPEG2 1
 824 #define FF_QSCALE_TYPE_H264  2
 825
 826 #define FF_BUFFER_TYPE_INTERNAL 1
 827 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 828 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 829 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
 830
 831
 832 #define FF_I_TYPE  1 ///< Intra
 833 #define FF_P_TYPE  2 ///< Predicted
 834 #define FF_B_TYPE  3 ///< Bi-dir predicted
 835 #define FF_S_TYPE  4 ///< S(GMC)-VOP MPEG4
 836 #define FF_SI_TYPE 5 ///< Switching Intra
 837 #define FF_SP_TYPE 6 ///< Switching Predicted
 838 #define FF_BI_TYPE 7
 839
 840 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 841 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 842 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 843 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
 844
 845 /**
 846  * Audio Video Frame.
 847  * New fields can be added to the end of FF_COMMON_FRAME with minor version
 848  * bumps.
 849  * Removal, reordering and changes to existing fields require a major
 850  * version bump. No fields should be added into AVFrame before or after
 851  * FF_COMMON_FRAME!
 852  * sizeof(AVFrame) must not be used outside libav*.
 853  */
 854 typedef struct AVFrame {
 855     FF_COMMON_FRAME
 856 } AVFrame;
 857
 858 /**
 859  * main external API structure.
 860  * New fields can be added to the end with minor version bumps.
 861  * Removal, reordering and changes to existing fields require a major
 862  * version bump.
 863  * sizeof(AVCodecContext) must not be used outside libav*.
 864  */
 865 typedef struct AVCodecContext {
 866     /**
 867      * information on struct for av_log
 868      * - set by avcodec_alloc_context
 869      */
 870     const AVClass *av_class;
 871     /**
 872      * the average bitrate
 873      * - encoding: Set by user; unused for constant quantizer encoding.
 874      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
 875      */
 876     int bit_rate;
 877
 878     /**
 879      * number of bits the bitstream is allowed to diverge from the reference.
 880      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
 881      * - encoding: Set by user; unused for constant quantizer encoding.
 882      * - decoding: unused
 883      */
 884     int bit_rate_tolerance;
 885
 886     /**
 887      * CODEC_FLAG_*.
 888      * - encoding: Set by user.
 889      * - decoding: Set by user.
 890      */
 891     int flags;
 892
 893     /**
 894      * Some codecs need additional format info. It is stored here.
 895      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
 896      * specific codec MUST set it correctly otherwise stream copy breaks.
 897      * In general use of this field by muxers is not recommanded.
 898      * - encoding: Set by libavcodec.
 899      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
 900      */
 901     int sub_id;
 902
 903     /**
 904      * Motion estimation algorithm used for video coding.
 905      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
 906      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
 907      * - encoding: MUST be set by user.
 908      * - decoding: unused
 909      */
 910     int me_method;
 911
 912     /**
 913      * some codecs need / can use extradata like Huffman tables.
 914      * mjpeg: Huffman tables
 915      * rv10: additional flags
 916      * mpeg4: global headers (they can be in the bitstream or here)
 917      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
 918      * than extradata_size to avoid prolems if it is read with the bitstream reader.
 919      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
 920      * - encoding: Set/allocated/freed by libavcodec.
 921      * - decoding: Set/allocated/freed by user.
 922      */
 923     uint8_t *extradata;
 924     int extradata_size;
 925
 926     /**
 927      * This is the fundamental unit of time (in seconds) in terms
 928      * of which frame timestamps are represented. For fixed-fps content,
 929      * timebase should be 1/framerate and timestamp increments should be
 930      * identically 1.
 931      * - encoding: MUST be set by user.
 932      * - decoding: Set by libavcodec.
 933      */
 934     AVRational time_base;
 935
 936     /* video only */
 937     /**
 938      * picture width / height.
 939      * - encoding: MUST be set by user.
 940      * - decoding: Set by libavcodec.
 941      * Note: For compatibility it is possible to set this instead of
 942      * coded_width/height before decoding.
 943      */
 944     int width, height;
 945
 946 #define FF_ASPECT_EXTENDED 15
 947
 948     /**
 949      * the number of pictures in a group of pictures, or 0 for intra_only
 950      * - encoding: Set by user.
 951      * - decoding: unused
 952      */
 953     int gop_size;
 954
 955     /**
 956      * Pixel format, see PIX_FMT_xxx.
 957      * - encoding: Set by user.
 958      * - decoding: Set by libavcodec.
 959      */
 960     enum PixelFormat pix_fmt;
 961
 962     /**
 963      * Frame rate emulation. If not zero, the lower layer (i.e. format handler)
 964      * has to read frames at native frame rate.
 965      * - encoding: Set by user.
 966      * - decoding: unused
 967      */
 968     int rate_emu;
 969
 970     /**
 971      * If non NULL, 'draw_horiz_band' is called by the libavcodec
 972      * decoder to draw a horizontal band. It improves cache usage. Not
 973      * all codecs can do that. You must check the codec capabilities
 974      * beforehand.
 975      * The function is also used by hardware acceleration APIs.
 976      * It is called at least once during frame decoding to pass
 977      * the data needed for hardware render.
 978      * In that mode instead of pixel data, AVFrame points to
 979      * a structure specific to the acceleration API. The application
 980      * reads the structure and can change some fields to indicate progress
 981      * or mark state.
 982      * - encoding: unused
 983      * - decoding: Set by user.
 984      * @param height the height of the slice
 985      * @param y the y position of the slice
 986      * @param type 1->top field, 2->bottom field, 3->frame
 987      * @param offset offset into the AVFrame.data from which the slice should be read
 988      */
 989     void (*draw_horiz_band)(struct AVCodecContext *s,
 990                             const AVFrame *src, int offset[4],
 991                             int y, int type, int height);
 992
 993     /* audio only */
 994     int sample_rate; ///< samples per second
 995     int channels;    ///< number of audio channels
 996
 997     /**
 998      * audio sample format
 999      * - encoding: Set by user.
1000      * - decoding: Set by libavcodec.
1001      */
1002     enum SampleFormat sample_fmt;  ///< sample format, currently unused
1003
1004     /* The following data should not be initialized. */
1005     /**
1006      * Samples per packet, initialized when calling 'init'.
1007      */
1008     int frame_size;
1009     int frame_number;   ///< audio or video frame number
1010     int real_pict_num;  ///< Returns the real picture number of previous encoded frame.
1011
1012     /**
1013      * Number of frames the decoded output will be delayed relative to
1014      * the encoded input.
1015      * - encoding: Set by libavcodec.
1016      * - decoding: unused
1017      */
1018     int delay;
1019
1020     /* - encoding parameters */
1021     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1022     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1023
1024     /**
1025      * minimum quantizer
1026      * - encoding: Set by user.
1027      * - decoding: unused
1028      */
1029     int qmin;
1030
1031     /**
1032      * maximum quantizer
1033      * - encoding: Set by user.
1034      * - decoding: unused
1035      */
1036     int qmax;
1037
1038     /**
1039      * maximum quantizer difference between frames
1040      * - encoding: Set by user.
1041      * - decoding: unused
1042      */
1043     int max_qdiff;
1044
1045     /**
1046      * maximum number of B-frames between non-B-frames
1047      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1048      * - encoding: Set by user.
1049      * - decoding: unused
1050      */
1051     int max_b_frames;
1052
1053     /**
1054      * qscale factor between IP and B-frames
1055      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1056      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1057      * - encoding: Set by user.
1058      * - decoding: unused
1059      */
1060     float b_quant_factor;
1061
1062     /** obsolete FIXME remove */
1063     int rc_strategy;
1064 #define FF_RC_STRATEGY_XVID 1
1065
1066     int b_frame_strategy;
1067
1068     /**
1069      * hurry up amount
1070      * - encoding: unused
1071      * - decoding: Set by user. 1-> Skip B-frames, 2-> Skip IDCT/dequant too, 5-> Skip everything except header
1072      * @deprecated Deprecated in favor of skip_idct and skip_frame.
1073      */
1074     int hurry_up;
1075
1076     struct AVCodec *codec;
1077
1078     void *priv_data;
1079
1080     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1081                             /* do its best to deliver a chunk with size     */
1082                             /* below rtp_payload_size, the chunk will start */
1083                             /* with a start code on some codecs like H.263. */
1084                             /* This doesn't take account of any particular  */
1085                             /* headers inside the transmitted RTP payload.  */
1086
1087
1088     /* The RTP callback: This function is called    */
1089     /* every time the encoder has a packet to send. */
1090     /* It depends on the encoder if the data starts */
1091     /* with a Start Code (it should). H.263 does.   */
1092     /* mb_nb contains the number of macroblocks     */
1093     /* encoded in the RTP payload.                  */
1094     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1095
1096     /* statistics, used for 2-pass encoding */
1097     int mv_bits;
1098     int header_bits;
1099     int i_tex_bits;
1100     int p_tex_bits;
1101     int i_count;
1102     int p_count;
1103     int skip_count;
1104     int misc_bits;
1105
1106     /**
1107      * number of bits used for the previously encoded frame
1108      * - encoding: Set by libavcodec.
1109      * - decoding: unused
1110      */
1111     int frame_bits;
1112
1113     /**
1114      * Private data of the user, can be used to carry app specific stuff.
1115      * - encoding: Set by user.
1116      * - decoding: Set by user.
1117      */
1118     void *opaque;
1119
1120     char codec_name[32];
1121     enum CodecType codec_type; /* see CODEC_TYPE_xxx */
1122     enum CodecID codec_id; /* see CODEC_ID_xxx */
1123
1124     /**
1125      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1126      * This is used to work around some encoder bugs.
1127      * A demuxer should set this to what is stored in the field used to identify the codec.
1128      * If there are multiple such fields in a container then the demuxer should choose the one
1129      * which maximizes the information about the used codec.
1130      * If the codec tag field in a container is larger then 32 bits then the demuxer should
1131      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1132      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1133      * first.
1134      * - encoding: Set by user, if not then the default based on codec_id will be used.
1135      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1136      */
1137     unsigned int codec_tag;
1138
1139     /**
1140      * Work around bugs in encoders which sometimes cannot be detected automatically.
1141      * - encoding: Set by user
1142      * - decoding: Set by user
1143      */
1144     int workaround_bugs;
1145 #define FF_BUG_AUTODETECT       1  ///< autodetection
1146 #define FF_BUG_OLD_MSMPEG4      2
1147 #define FF_BUG_XVID_ILACE       4
1148 #define FF_BUG_UMP4             8
1149 #define FF_BUG_NO_PADDING       16
1150 #define FF_BUG_AMV              32
1151 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1152 #define FF_BUG_QPEL_CHROMA      64
1153 #define FF_BUG_STD_QPEL         128
1154 #define FF_BUG_QPEL_CHROMA2     256
1155 #define FF_BUG_DIRECT_BLOCKSIZE 512
1156 #define FF_BUG_EDGE             1024
1157 #define FF_BUG_HPEL_CHROMA      2048
1158 #define FF_BUG_DC_CLIP          4096
1159 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1160 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1161
1162     /**
1163      * luma single coefficient elimination threshold
1164      * - encoding: Set by user.
1165      * - decoding: unused
1166      */
1167     int luma_elim_threshold;
1168
1169     /**
1170      * chroma single coeff elimination threshold
1171      * - encoding: Set by user.
1172      * - decoding: unused
1173      */
1174     int chroma_elim_threshold;
1175
1176     /**
1177      * strictly follow the standard (MPEG4, ...).
1178      * - encoding: Set by user.
1179      * - decoding: Set by user.
1180      * Setting this to STRICT or higher means the encoder and decoder will
1181      * generally do stupid things. While setting it to inofficial or lower
1182      * will mean the encoder might use things that are not supported by all
1183      * spec compliant decoders. Decoders make no difference between normal,
1184      * inofficial and experimental, that is they always try to decode things
1185      * when they can unless they are explicitly asked to behave stupid
1186      * (=strictly conform to the specs)
1187      */
1188     int strict_std_compliance;
1189 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to a older more strict version of the spec or reference software.
1190 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1191 #define FF_COMPLIANCE_NORMAL        0
1192 #define FF_COMPLIANCE_INOFFICIAL   -1 ///< Allow inofficial extensions.
1193 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1194
1195     /**
1196      * qscale offset between IP and B-frames
1197      * - encoding: Set by user.
1198      * - decoding: unused
1199      */
1200     float b_quant_offset;
1201
1202     /**
1203      * Error recognization; higher values will detect more errors but may
1204      * misdetect some more or less valid parts as errors.
1205      * - encoding: unused
1206      * - decoding: Set by user.
1207      */
1208     int error_recognition;
1209 #define FF_ER_CAREFUL         1
1210 #define FF_ER_COMPLIANT       2
1211 #define FF_ER_AGGRESSIVE      3
1212 #define FF_ER_VERY_AGGRESSIVE 4
1213
1214     /**
1215      * Called at the beginning of each frame to get a buffer for it.
1216      * If pic.reference is set then the frame will be read later by libavcodec.
1217      * avcodec_align_dimensions() should be used to find the required width and
1218      * height, as they normally need to be rounded up to the next multiple of 16.
1219      * - encoding: unused
1220      * - decoding: Set by libavcodec., user can override.
1221      */
1222     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1223
1224     /**
1225      * Called to release buffers which were allocated with get_buffer.
1226      * A released buffer can be reused in get_buffer().
1227      * pic.data[*] must be set to NULL.
1228      * - encoding: unused
1229      * - decoding: Set by libavcodec., user can override.
1230      */
1231     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1232
1233     /**
1234      * Size of the frame reordering buffer in the decoder.
1235      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1236      * - encoding: Set by libavcodec.
1237      * - decoding: Set by libavcodec.
1238      */
1239     int has_b_frames;
1240
1241     /**
1242      * number of bytes per packet if constant and known or 0
1243      * Used by some WAV based audio codecs.
1244      */
1245     int block_align;
1246
1247     int parse_only; /* - decoding only: If true, only parsing is done
1248                        (function avcodec_parse_frame()). The frame
1249                        data is returned. Only MPEG codecs support this now. */
1250
1251     /**
1252      * 0-> h263 quant 1-> mpeg quant
1253      * - encoding: Set by user.
1254      * - decoding: unused
1255      */
1256     int mpeg_quant;
1257
1258     /**
1259      * pass1 encoding statistics output buffer
1260      * - encoding: Set by libavcodec.
1261      * - decoding: unused
1262      */
1263     char *stats_out;
1264
1265     /**
1266      * pass2 encoding statistics input buffer
1267      * Concatenated stuff from stats_out of pass1 should be placed here.
1268      * - encoding: Allocated/set/freed by user.
1269      * - decoding: unused
1270      */
1271     char *stats_in;
1272
1273     /**
1274      * ratecontrol qmin qmax limiting method
1275      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1276      * - encoding: Set by user.
1277      * - decoding: unused
1278      */
1279     float rc_qsquish;
1280
1281     float rc_qmod_amp;
1282     int rc_qmod_freq;
1283
1284     /**
1285      * ratecontrol override, see RcOverride
1286      * - encoding: Allocated/set/freed by user.
1287      * - decoding: unused
1288      */
1289     RcOverride *rc_override;
1290     int rc_override_count;
1291
1292     /**
1293      * rate control equation
1294      * - encoding: Set by user
1295      * - decoding: unused
1296      */
1297     const char *rc_eq;
1298
1299     /**
1300      * maximum bitrate
1301      * - encoding: Set by user.
1302      * - decoding: unused
1303      */
1304     int rc_max_rate;
1305
1306     /**
1307      * minimum bitrate
1308      * - encoding: Set by user.
1309      * - decoding: unused
1310      */
1311     int rc_min_rate;
1312
1313     /**
1314      * decoder bitstream buffer size
1315      * - encoding: Set by user.
1316      * - decoding: unused
1317      */
1318     int rc_buffer_size;
1319     float rc_buffer_aggressivity;
1320
1321     /**
1322      * qscale factor between P and I-frames
1323      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1324      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1325      * - encoding: Set by user.
1326      * - decoding: unused
1327      */
1328     float i_quant_factor;
1329
1330     /**
1331      * qscale offset between P and I-frames
1332      * - encoding: Set by user.
1333      * - decoding: unused
1334      */
1335     float i_quant_offset;
1336
1337     /**
1338      * initial complexity for pass1 ratecontrol
1339      * - encoding: Set by user.
1340      * - decoding: unused
1341      */
1342     float rc_initial_cplx;
1343
1344     /**
1345      * DCT algorithm, see FF_DCT_* below
1346      * - encoding: Set by user.
1347      * - decoding: unused
1348      */
1349     int dct_algo;
1350 #define FF_DCT_AUTO    0
1351 #define FF_DCT_FASTINT 1
1352 #define FF_DCT_INT     2
1353 #define FF_DCT_MMX     3
1354 #define FF_DCT_MLIB    4
1355 #define FF_DCT_ALTIVEC 5
1356 #define FF_DCT_FAAN    6
1357
1358     /**
1359      * luminance masking (0-> disabled)
1360      * - encoding: Set by user.
1361      * - decoding: unused
1362      */
1363     float lumi_masking;
1364
1365     /**
1366      * temporary complexity masking (0-> disabled)
1367      * - encoding: Set by user.
1368      * - decoding: unused
1369      */
1370     float temporal_cplx_masking;
1371
1372     /**
1373      * spatial complexity masking (0-> disabled)
1374      * - encoding: Set by user.
1375      * - decoding: unused
1376      */
1377     float spatial_cplx_masking;
1378
1379     /**
1380      * p block masking (0-> disabled)
1381      * - encoding: Set by user.
1382      * - decoding: unused
1383      */
1384     float p_masking;
1385
1386     /**
1387      * darkness masking (0-> disabled)
1388      * - encoding: Set by user.
1389      * - decoding: unused
1390      */
1391     float dark_masking;
1392
1393     /**
1394      * IDCT algorithm, see FF_IDCT_* below.
1395      * - encoding: Set by user.
1396      * - decoding: Set by user.
1397      */
1398     int idct_algo;
1399 #define FF_IDCT_AUTO          0
1400 #define FF_IDCT_INT           1
1401 #define FF_IDCT_SIMPLE        2
1402 #define FF_IDCT_SIMPLEMMX     3
1403 #define FF_IDCT_LIBMPEG2MMX   4
1404 #define FF_IDCT_PS2           5
1405 #define FF_IDCT_MLIB          6
1406 #define FF_IDCT_ARM           7
1407 #define FF_IDCT_ALTIVEC       8
1408 #define FF_IDCT_SH4           9
1409 #define FF_IDCT_SIMPLEARM     10
1410 #define FF_IDCT_H264          11
1411 #define FF_IDCT_VP3           12
1412 #define FF_IDCT_IPP           13
1413 #define FF_IDCT_XVIDMMX       14
1414 #define FF_IDCT_CAVS          15
1415 #define FF_IDCT_SIMPLEARMV5TE 16
1416 #define FF_IDCT_SIMPLEARMV6   17
1417 #define FF_IDCT_SIMPLEVIS     18
1418 #define FF_IDCT_WMV2          19
1419 #define FF_IDCT_FAAN          20
1420 #define FF_IDCT_EA            21
1421 #define FF_IDCT_SIMPLENEON    22
1422 #define FF_IDCT_SIMPLEALPHA   23
1423
1424     /**
1425      * slice count
1426      * - encoding: Set by libavcodec.
1427      * - decoding: Set by user (or 0).
1428      */
1429     int slice_count;
1430     /**
1431      * slice offsets in the frame in bytes
1432      * - encoding: Set/allocated by libavcodec.
1433      * - decoding: Set/allocated by user (or NULL).
1434      */
1435     int *slice_offset;
1436
1437     /**
1438      * error concealment flags
1439      * - encoding: unused
1440      * - decoding: Set by user.
1441      */
1442     int error_concealment;
1443 #define FF_EC_GUESS_MVS   1
1444 #define FF_EC_DEBLOCK     2
1445
1446     /**
1447      * dsp_mask could be add used to disable unwanted CPU features
1448      * CPU features (i.e. MMX, SSE. ...)
1449      *
1450      * With the FORCE flag you may instead enable given CPU features.
1451      * (Dangerous: Usable in case of misdetection, improper usage however will
1452      * result into program crash.)
1453      */
1454     unsigned dsp_mask;
1455 #define FF_MM_FORCE    0x80000000 /* Force usage of selected flags (OR) */
1456     /* lower 16 bits - CPU features */
1457 #define FF_MM_MMX      0x0001 ///< standard MMX
1458 #define FF_MM_3DNOW    0x0004 ///< AMD 3DNOW
1459 #define FF_MM_MMXEXT   0x0002 ///< SSE integer functions or AMD MMX ext
1460 #define FF_MM_SSE      0x0008 ///< SSE functions
1461 #define FF_MM_SSE2     0x0010 ///< PIV SSE2 functions
1462 #define FF_MM_3DNOWEXT 0x0020 ///< AMD 3DNowExt
1463 #define FF_MM_SSE3     0x0040 ///< Prescott SSE3 functions
1464 #define FF_MM_SSSE3    0x0080 ///< Conroe SSSE3 functions
1465 #define FF_MM_SSE4     0x0100 ///< Penryn SSE4.1 functions
1466 #define FF_MM_SSE42    0x0200 ///< Nehalem SSE4.2 functions
1467 #define FF_MM_IWMMXT   0x0100 ///< XScale IWMMXT
1468 #define FF_MM_ALTIVEC  0x0001 ///< standard AltiVec
1469
1470     /**
1471      * bits per sample/pixel from the demuxer (needed for huffyuv).
1472      * - encoding: Set by libavcodec.
1473      * - decoding: Set by user.
1474      */
1475      int bits_per_coded_sample;
1476
1477     /**
1478      * prediction method (needed for huffyuv)
1479      * - encoding: Set by user.
1480      * - decoding: unused
1481      */
1482      int prediction_method;
1483 #define FF_PRED_LEFT   0
1484 #define FF_PRED_PLANE  1
1485 #define FF_PRED_MEDIAN 2
1486
1487     /**
1488      * sample aspect ratio (0 if unknown)
1489      * That is the width of a pixel divided by the height of the pixel.
1490      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1491      * - encoding: Set by user.
1492      * - decoding: Set by libavcodec.
1493      */
1494     AVRational sample_aspect_ratio;
1495
1496     /**
1497      * the picture in the bitstream
1498      * - encoding: Set by libavcodec.
1499      * - decoding: Set by libavcodec.
1500      */
1501     AVFrame *coded_frame;
1502
1503     /**
1504      * debug
1505      * - encoding: Set by user.
1506      * - decoding: Set by user.
1507      */
1508     int debug;
1509 #define FF_DEBUG_PICT_INFO   1
1510 #define FF_DEBUG_RC          2
1511 #define FF_DEBUG_BITSTREAM   4
1512 #define FF_DEBUG_MB_TYPE     8
1513 #define FF_DEBUG_QP          16
1514 #define FF_DEBUG_MV          32
1515 #define FF_DEBUG_DCT_COEFF   0x00000040
1516 #define FF_DEBUG_SKIP        0x00000080
1517 #define FF_DEBUG_STARTCODE   0x00000100
1518 #define FF_DEBUG_PTS         0x00000200
1519 #define FF_DEBUG_ER          0x00000400
1520 #define FF_DEBUG_MMCO        0x00000800
1521 #define FF_DEBUG_BUGS        0x00001000
1522 #define FF_DEBUG_VIS_QP      0x00002000
1523 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1524 #define FF_DEBUG_BUFFERS     0x00008000
1525
1526     /**
1527      * debug
1528      * - encoding: Set by user.
1529      * - decoding: Set by user.
1530      */
1531     int debug_mv;
1532 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1533 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1534 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1535
1536     /**
1537      * error
1538      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1539      * - decoding: unused
1540      */
1541     uint64_t error[4];
1542
1543     /**
1544      * minimum MB quantizer
1545      * - encoding: unused
1546      * - decoding: unused
1547      */
1548     int mb_qmin;
1549
1550     /**
1551      * maximum MB quantizer
1552      * - encoding: unused
1553      * - decoding: unused
1554      */
1555     int mb_qmax;
1556
1557     /**
1558      * motion estimation comparison function
1559      * - encoding: Set by user.
1560      * - decoding: unused
1561      */
1562     int me_cmp;
1563     /**
1564      * subpixel motion estimation comparison function
1565      * - encoding: Set by user.
1566      * - decoding: unused
1567      */
1568     int me_sub_cmp;
1569     /**
1570      * macroblock comparison function (not supported yet)
1571      * - encoding: Set by user.
1572      * - decoding: unused
1573      */
1574     int mb_cmp;
1575     /**
1576      * interlaced DCT comparison function
1577      * - encoding: Set by user.
1578      * - decoding: unused
1579      */
1580     int ildct_cmp;
1581 #define FF_CMP_SAD    0
1582 #define FF_CMP_SSE    1
1583 #define FF_CMP_SATD   2
1584 #define FF_CMP_DCT    3
1585 #define FF_CMP_PSNR   4
1586 #define FF_CMP_BIT    5
1587 #define FF_CMP_RD     6
1588 #define FF_CMP_ZERO   7
1589 #define FF_CMP_VSAD   8
1590 #define FF_CMP_VSSE   9
1591 #define FF_CMP_NSSE   10
1592 #define FF_CMP_W53    11
1593 #define FF_CMP_W97    12
1594 #define FF_CMP_DCTMAX 13
1595 #define FF_CMP_DCT264 14
1596 #define FF_CMP_CHROMA 256
1597
1598     /**
1599      * ME diamond size & shape
1600      * - encoding: Set by user.
1601      * - decoding: unused
1602      */
1603     int dia_size;
1604
1605     /**
1606      * amount of previous MV predictors (2a+1 x 2a+1 square)
1607      * - encoding: Set by user.
1608      * - decoding: unused
1609      */
1610     int last_predictor_count;
1611
1612     /**
1613      * prepass for motion estimation
1614      * - encoding: Set by user.
1615      * - decoding: unused
1616      */
1617     int pre_me;
1618
1619     /**
1620      * motion estimation prepass comparison function
1621      * - encoding: Set by user.
1622      * - decoding: unused
1623      */
1624     int me_pre_cmp;
1625
1626     /**
1627      * ME prepass diamond size & shape
1628      * - encoding: Set by user.
1629      * - decoding: unused
1630      */
1631     int pre_dia_size;
1632
1633     /**
1634      * subpel ME quality
1635      * - encoding: Set by user.
1636      * - decoding: unused
1637      */
1638     int me_subpel_quality;
1639
1640     /**
1641      * callback to negotiate the pixelFormat
1642      * @param fmt is the list of formats which are supported by the codec,
1643      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1644      * The first is always the native one.
1645      * @return the chosen format
1646      * - encoding: unused
1647      * - decoding: Set by user, if not set the native format will be chosen.
1648      */
1649     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1650
1651     /**
1652      * DTG active format information (additional aspect ratio
1653      * information only used in DVB MPEG-2 transport streams)
1654      * 0 if not set.
1655      *
1656      * - encoding: unused
1657      * - decoding: Set by decoder.
1658      */
1659     int dtg_active_format;
1660 #define FF_DTG_AFD_SAME         8
1661 #define FF_DTG_AFD_4_3          9
1662 #define FF_DTG_AFD_16_9         10
1663 #define FF_DTG_AFD_14_9         11
1664 #define FF_DTG_AFD_4_3_SP_14_9  13
1665 #define FF_DTG_AFD_16_9_SP_14_9 14
1666 #define FF_DTG_AFD_SP_4_3       15
1667
1668     /**
1669      * maximum motion estimation search range in subpel units
1670      * If 0 then no limit.
1671      *
1672      * - encoding: Set by user.
1673      * - decoding: unused
1674      */
1675     int me_range;
1676
1677     /**
1678      * intra quantizer bias
1679      * - encoding: Set by user.
1680      * - decoding: unused
1681      */
1682     int intra_quant_bias;
1683 #define FF_DEFAULT_QUANT_BIAS 999999
1684
1685     /**
1686      * inter quantizer bias
1687      * - encoding: Set by user.
1688      * - decoding: unused
1689      */
1690     int inter_quant_bias;
1691
1692     /**
1693      * color table ID
1694      * - encoding: unused
1695      * - decoding: Which clrtable should be used for 8bit RGB images.
1696      *             Tables have to be stored somewhere. FIXME
1697      */
1698     int color_table_id;
1699
1700     /**
1701      * internal_buffer count
1702      * Don't touch, used by libavcodec default_get_buffer().
1703      */
1704     int internal_buffer_count;
1705
1706     /**
1707      * internal_buffers
1708      * Don't touch, used by libavcodec default_get_buffer().
1709      */
1710     void *internal_buffer;
1711
1712 #define FF_LAMBDA_SHIFT 7
1713 #define FF_LAMBDA_SCALE (1<<FF_LAMBDA_SHIFT)
1714 #define FF_QP2LAMBDA 118 ///< factor to convert from H.263 QP to lambda
1715 #define FF_LAMBDA_MAX (256*128-1)
1716
1717 #define FF_QUALITY_SCALE FF_LAMBDA_SCALE //FIXME maybe remove
1718     /**
1719      * Global quality for codecs which cannot change it per frame.
1720      * This should be proportional to MPEG-1/2/4 qscale.
1721      * - encoding: Set by user.
1722      * - decoding: unused
1723      */
1724     int global_quality;
1725
1726 #define FF_CODER_TYPE_VLC       0
1727 #define FF_CODER_TYPE_AC        1
1728 #define FF_CODER_TYPE_RAW       2
1729 #define FF_CODER_TYPE_RLE       3
1730 #define FF_CODER_TYPE_DEFLATE   4
1731     /**
1732      * coder type
1733      * - encoding: Set by user.
1734      * - decoding: unused
1735      */
1736     int coder_type;
1737
1738     /**
1739      * context model
1740      * - encoding: Set by user.
1741      * - decoding: unused
1742      */
1743     int context_model;
1744 #if 0
1745     /**
1746      *
1747      * - encoding: unused
1748      * - decoding: Set by user.
1749      */
1750     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
1751 #endif
1752
1753     /**
1754      * slice flags
1755      * - encoding: unused
1756      * - decoding: Set by user.
1757      */
1758     int slice_flags;
1759 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1760 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1761 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1762
1763     /**
1764      * XVideo Motion Acceleration
1765      * - encoding: forbidden
1766      * - decoding: set by decoder
1767      */
1768     int xvmc_acceleration;
1769
1770     /**
1771      * macroblock decision mode
1772      * - encoding: Set by user.
1773      * - decoding: unused
1774      */
1775     int mb_decision;
1776 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1777 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1778 #define FF_MB_DECISION_RD     2        ///< rate distortion
1779
1780     /**
1781      * custom intra quantization matrix
1782      * - encoding: Set by user, can be NULL.
1783      * - decoding: Set by libavcodec.
1784      */
1785     uint16_t *intra_matrix;
1786
1787     /**
1788      * custom inter quantization matrix
1789      * - encoding: Set by user, can be NULL.
1790      * - decoding: Set by libavcodec.
1791      */
1792     uint16_t *inter_matrix;
1793
1794     /**
1795      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1796      * This is used to work around some encoder bugs.
1797      * - encoding: unused
1798      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1799      */
1800     unsigned int stream_codec_tag;
1801
1802     /**
1803      * scene change detection threshold
1804      * 0 is default, larger means fewer detected scene changes.
1805      * - encoding: Set by user.
1806      * - decoding: unused
1807      */
1808     int scenechange_threshold;
1809
1810     /**
1811      * minimum Lagrange multipler
1812      * - encoding: Set by user.
1813      * - decoding: unused
1814      */
1815     int lmin;
1816
1817     /**
1818      * maximum Lagrange multipler
1819      * - encoding: Set by user.
1820      * - decoding: unused
1821      */
1822     int lmax;
1823
1824     /**
1825      * palette control structure
1826      * - encoding: ??? (no palette-enabled encoder yet)
1827      * - decoding: Set by user.
1828      */
1829     struct AVPaletteControl *palctrl;
1830
1831     /**
1832      * noise reduction strength
1833      * - encoding: Set by user.
1834      * - decoding: unused
1835      */
1836     int noise_reduction;
1837
1838     /**
1839      * Called at the beginning of a frame to get cr buffer for it.
1840      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1841      * libavcodec will pass previous buffer in pic, function should return
1842      * same buffer or new buffer with old frame "painted" into it.
1843      * If pic.data[0] == NULL must behave like get_buffer().
1844      * - encoding: unused
1845      * - decoding: Set by libavcodec., user can override
1846      */
1847     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1848
1849     /**
1850      * Number of bits which should be loaded into the rc buffer before decoding starts.
1851      * - encoding: Set by user.
1852      * - decoding: unused
1853      */
1854     int rc_initial_buffer_occupancy;
1855
1856     /**
1857      *
1858      * - encoding: Set by user.
1859      * - decoding: unused
1860      */
1861     int inter_threshold;
1862
1863     /**
1864      * CODEC_FLAG2_*
1865      * - encoding: Set by user.
1866      * - decoding: Set by user.
1867      */
1868     int flags2;
1869
1870     /**
1871      * Simulates errors in the bitstream to test error concealment.
1872      * - encoding: Set by user.
1873      * - decoding: unused
1874      */
1875     int error_rate;
1876
1877     /**
1878      * MP3 antialias algorithm, see FF_AA_* below.
1879      * - encoding: unused
1880      * - decoding: Set by user.
1881      */
1882     int antialias_algo;
1883 #define FF_AA_AUTO    0
1884 #define FF_AA_FASTINT 1 //not implemented yet
1885 #define FF_AA_INT     2
1886 #define FF_AA_FLOAT   3
1887     /**
1888      * quantizer noise shaping
1889      * - encoding: Set by user.
1890      * - decoding: unused
1891      */
1892     int quantizer_noise_shaping;
1893
1894     /**
1895      * thread count
1896      * is used to decide how many independent tasks should be passed to execute()
1897      * - encoding: Set by user.
1898      * - decoding: Set by user.
1899      */
1900     int thread_count;
1901
1902     /**
1903      * The codec may call this to execute several independent things.
1904      * It will return only after finishing all tasks.
1905      * The user may replace this with some multithreaded implementation,
1906      * the default implementation will execute the parts serially.
1907      * @param count the number of things to execute
1908      * - encoding: Set by libavcodec, user can override.
1909      * - decoding: Set by libavcodec, user can override.
1910      */
1911     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
1912
1913     /**
1914      * thread opaque
1915      * Can be used by execute() to store some per AVCodecContext stuff.
1916      * - encoding: set by execute()
1917      * - decoding: set by execute()
1918      */
1919     void *thread_opaque;
1920
1921     /**
1922      * Motion estimation threshold below which no motion estimation is
1923      * performed, but instead the user specified motion vectors are used.
1924      *
1925      * - encoding: Set by user.
1926      * - decoding: unused
1927      */
1928      int me_threshold;
1929
1930     /**
1931      * Macroblock threshold below which the user specified macroblock types will be used.
1932      * - encoding: Set by user.
1933      * - decoding: unused
1934      */
1935      int mb_threshold;
1936
1937     /**
1938      * precision of the intra DC coefficient - 8
1939      * - encoding: Set by user.
1940      * - decoding: unused
1941      */
1942      int intra_dc_precision;
1943
1944     /**
1945      * noise vs. sse weight for the nsse comparsion function
1946      * - encoding: Set by user.
1947      * - decoding: unused
1948      */
1949      int nsse_weight;
1950
1951     /**
1952      * Number of macroblock rows at the top which are skipped.
1953      * - encoding: unused
1954      * - decoding: Set by user.
1955      */
1956      int skip_top;
1957
1958     /**
1959      * Number of macroblock rows at the bottom which are skipped.
1960      * - encoding: unused
1961      * - decoding: Set by user.
1962      */
1963      int skip_bottom;
1964
1965     /**
1966      * profile
1967      * - encoding: Set by user.
1968      * - decoding: Set by libavcodec.
1969      */
1970      int profile;
1971 #define FF_PROFILE_UNKNOWN -99
1972 #define FF_PROFILE_AAC_MAIN 0
1973 #define FF_PROFILE_AAC_LOW  1
1974 #define FF_PROFILE_AAC_SSR  2
1975 #define FF_PROFILE_AAC_LTP  3
1976
1977     /**
1978      * level
1979      * - encoding: Set by user.
1980      * - decoding: Set by libavcodec.
1981      */
1982      int level;
1983 #define FF_LEVEL_UNKNOWN -99
1984
1985     /**
1986      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
1987      * - encoding: unused
1988      * - decoding: Set by user.
1989      */
1990      int lowres;
1991
1992     /**
1993      * Bitstream width / height, may be different from width/height if lowres
1994      * or other things are used.
1995      * - encoding: unused
1996      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1997      */
1998     int coded_width, coded_height;
1999
2000     /**
2001      * frame skip threshold
2002      * - encoding: Set by user.
2003      * - decoding: unused
2004      */
2005     int frame_skip_threshold;
2006
2007     /**
2008      * frame skip factor
2009      * - encoding: Set by user.
2010      * - decoding: unused
2011      */
2012     int frame_skip_factor;
2013
2014     /**
2015      * frame skip exponent
2016      * - encoding: Set by user.
2017      * - decoding: unused
2018      */
2019     int frame_skip_exp;
2020
2021     /**
2022      * frame skip comparison function
2023      * - encoding: Set by user.
2024      * - decoding: unused
2025      */
2026     int frame_skip_cmp;
2027
2028     /**
2029      * Border processing masking, raises the quantizer for mbs on the borders
2030      * of the picture.
2031      * - encoding: Set by user.
2032      * - decoding: unused
2033      */
2034     float border_masking;
2035
2036     /**
2037      * minimum MB lagrange multipler
2038      * - encoding: Set by user.
2039      * - decoding: unused
2040      */
2041     int mb_lmin;
2042
2043     /**
2044      * maximum MB lagrange multipler
2045      * - encoding: Set by user.
2046      * - decoding: unused
2047      */
2048     int mb_lmax;
2049
2050     /**
2051      *
2052      * - encoding: Set by user.
2053      * - decoding: unused
2054      */
2055     int me_penalty_compensation;
2056
2057     /**
2058      *
2059      * - encoding: unused
2060      * - decoding: Set by user.
2061      */
2062     enum AVDiscard skip_loop_filter;
2063
2064     /**
2065      *
2066      * - encoding: unused
2067      * - decoding: Set by user.
2068      */
2069     enum AVDiscard skip_idct;
2070
2071     /**
2072      *
2073      * - encoding: unused
2074      * - decoding: Set by user.
2075      */
2076     enum AVDiscard skip_frame;
2077
2078     /**
2079      *
2080      * - encoding: Set by user.
2081      * - decoding: unused
2082      */
2083     int bidir_refine;
2084
2085     /**
2086      *
2087      * - encoding: Set by user.
2088      * - decoding: unused
2089      */
2090     int brd_scale;
2091
2092     /**
2093      * constant rate factor - quality-based VBR - values ~correspond to qps
2094      * - encoding: Set by user.
2095      * - decoding: unused
2096      */
2097     float crf;
2098
2099     /**
2100      * constant quantization parameter rate control method
2101      * - encoding: Set by user.
2102      * - decoding: unused
2103      */
2104     int cqp;
2105
2106     /**
2107      * minimum GOP size
2108      * - encoding: Set by user.
2109      * - decoding: unused
2110      */
2111     int keyint_min;
2112
2113     /**
2114      * number of reference frames
2115      * - encoding: Set by user.
2116      * - decoding: Set by lavc.
2117      */
2118     int refs;
2119
2120     /**
2121      * chroma qp offset from luma
2122      * - encoding: Set by user.
2123      * - decoding: unused
2124      */
2125     int chromaoffset;
2126
2127     /**
2128      * Influences how often B-frames are used.
2129      * - encoding: Set by user.
2130      * - decoding: unused
2131      */
2132     int bframebias;
2133
2134     /**
2135      * trellis RD quantization
2136      * - encoding: Set by user.
2137      * - decoding: unused
2138      */
2139     int trellis;
2140
2141     /**
2142      * Reduce fluctuations in qp (before curve compression).
2143      * - encoding: Set by user.
2144      * - decoding: unused
2145      */
2146     float complexityblur;
2147
2148     /**
2149      * in-loop deblocking filter alphac0 parameter
2150      * alpha is in the range -6...6
2151      * - encoding: Set by user.
2152      * - decoding: unused
2153      */
2154     int deblockalpha;
2155
2156     /**
2157      * in-loop deblocking filter beta parameter
2158      * beta is in the range -6...6
2159      * - encoding: Set by user.
2160      * - decoding: unused
2161      */
2162     int deblockbeta;
2163
2164     /**
2165      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2166      * - encoding: Set by user.
2167      * - decoding: unused
2168      */
2169     int partitions;
2170 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2171 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2172 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2173 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2174 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2175
2176     /**
2177      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2178      * - encoding: Set by user.
2179      * - decoding: unused
2180      */
2181     int directpred;
2182
2183     /**
2184      * Audio cutoff bandwidth (0 means "automatic")
2185      * - encoding: Set by user.
2186      * - decoding: unused
2187      */
2188     int cutoff;
2189
2190     /**
2191      * Multiplied by qscale for each frame and added to scene_change_score.
2192      * - encoding: Set by user.
2193      * - decoding: unused
2194      */
2195     int scenechange_factor;
2196
2197     /**
2198      *
2199      * Note: Value depends upon the compare function used for fullpel ME.
2200      * - encoding: Set by user.
2201      * - decoding: unused
2202      */
2203     int mv0_threshold;
2204
2205     /**
2206      * Adjusts sensitivity of b_frame_strategy 1.
2207      * - encoding: Set by user.
2208      * - decoding: unused
2209      */
2210     int b_sensitivity;
2211
2212     /**
2213      * - encoding: Set by user.
2214      * - decoding: unused
2215      */
2216     int compression_level;
2217 #define FF_COMPRESSION_DEFAULT -1
2218
2219     /**
2220      * Sets whether to use LPC mode - used by FLAC encoder.
2221      * - encoding: Set by user.
2222      * - decoding: unused
2223      */
2224     int use_lpc;
2225
2226     /**
2227      * LPC coefficient precision - used by FLAC encoder
2228      * - encoding: Set by user.
2229      * - decoding: unused
2230      */
2231     int lpc_coeff_precision;
2232
2233     /**
2234      * - encoding: Set by user.
2235      * - decoding: unused
2236      */
2237     int min_prediction_order;
2238
2239     /**
2240      * - encoding: Set by user.
2241      * - decoding: unused
2242      */
2243     int max_prediction_order;
2244
2245     /**
2246      * search method for selecting prediction order
2247      * - encoding: Set by user.
2248      * - decoding: unused
2249      */
2250     int prediction_order_method;
2251
2252     /**
2253      * - encoding: Set by user.
2254      * - decoding: unused
2255      */
2256     int min_partition_order;
2257
2258     /**
2259      * - encoding: Set by user.
2260      * - decoding: unused
2261      */
2262     int max_partition_order;
2263
2264     /**
2265      * GOP timecode frame start number, in non drop frame format
2266      * - encoding: Set by user.
2267      * - decoding: unused
2268      */
2269     int64_t timecode_frame_start;
2270
2271 #if LIBAVCODEC_VERSION_MAJOR < 53
2272     /**
2273      * Decoder should decode to this many channels if it can (0 for default)
2274      * - encoding: unused
2275      * - decoding: Set by user.
2276      * @deprecated Deprecated in favor of request_channel_layout.
2277      */
2278     int request_channels;
2279 #endif
2280
2281     /**
2282      * Percentage of dynamic range compression to be applied by the decoder.
2283      * The default value is 1.0, corresponding to full compression.
2284      * - encoding: unused
2285      * - decoding: Set by user.
2286      */
2287     float drc_scale;
2288
2289     /**
2290      * opaque 64bit number (generally a PTS) that will be reordered and
2291      * output in AVFrame.reordered_opaque
2292      * - encoding: unused
2293      * - decoding: Set by user.
2294      */
2295     int64_t reordered_opaque;
2296
2297     /**
2298      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2299      * This field is applicable only when sample_fmt is SAMPLE_FMT_S32.
2300      * - encoding: set by user.
2301      * - decoding: set by libavcodec.
2302      */
2303     int bits_per_raw_sample;
2304
2305     /**
2306      * Audio channel layout.
2307      * - encoding: set by user.
2308      * - decoding: set by libavcodec.
2309      */
2310     int64_t channel_layout;
2311
2312     /**
2313      * Request decoder to use this channel layout if it can (0 for default)
2314      * - encoding: unused
2315      * - decoding: Set by user.
2316      */
2317     int64_t request_channel_layout;
2318
2319     /**
2320      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2321      * - encoding: Set by user.
2322      * - decoding: unused.
2323      */
2324     float rc_max_available_vbv_use;
2325
2326     /**
2327      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2328      * - encoding: Set by user.
2329      * - decoding: unused.
2330      */
2331     float rc_min_vbv_overflow_use;
2332
2333     /**
2334      * Hardware accelerator in use
2335      * - encoding: unused.
2336      * - decoding: Set by libavcodec
2337      */
2338     struct AVHWAccel *hwaccel;
2339
2340     /**
2341      * For some codecs, the time base is closer to the field rate than the frame rate.
2342      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2343      * if no telecine is used ...
2344      *
2345      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2346      */
2347     int ticks_per_frame;
2348
2349     /**
2350      * Hardware accelerator context.
2351      * For some hardware accelerators, a global context needs to be
2352      * provided by the user. In that case, this holds display-dependent
2353      * data FFmpeg cannot instantiate itself. Please refer to the
2354      * FFmpeg HW accelerator documentation to know how to fill this
2355      * is. e.g. for VA API, this is a struct vaapi_context.
2356      * - encoding: unused
2357      * - decoding: Set by user
2358      */
2359     void *hwaccel_context;
2360 } AVCodecContext;
2361
2362 /**
2363  * AVCodec.
2364  */
2365 typedef struct AVCodec {
2366     /**
2367      * Name of the codec implementation.
2368      * The name is globally unique among encoders and among decoders (but an
2369      * encoder and a decoder can share the same name).
2370      * This is the primary way to find a codec from the user perspective.
2371      */
2372     const char *name;
2373     enum CodecType type;
2374     enum CodecID id;
2375     int priv_data_size;
2376     int (*init)(AVCodecContext *);
2377     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2378     int (*close)(AVCodecContext *);
2379     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size,
2380                   const uint8_t *buf, int buf_size);
2381     /**
2382      * Codec capabilities.
2383      * see CODEC_CAP_*
2384      */
2385     int capabilities;
2386     struct AVCodec *next;
2387     /**
2388      * Flush buffers.
2389      * Will be called when seeking
2390      */
2391     void (*flush)(AVCodecContext *);
2392     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2393     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2394     /**
2395      * Descriptive name for the codec, meant to be more human readable than \p name.
2396      * You \e should use the NULL_IF_CONFIG_SMALL() macro to define it.
2397      */
2398     const char *long_name;
2399     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2400     const enum SampleFormat *sample_fmts;   ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2401     const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2402 } AVCodec;
2403
2404 /**
2405  * AVHWAccel.
2406  */
2407 typedef struct AVHWAccel {
2408     /**
2409      * Name of the hardware accelerated codec.
2410      * The name is globally unique among encoders and among decoders (but an
2411      * encoder and a decoder can share the same name).
2412      */
2413     const char *name;
2414
2415     /**
2416      * Type of codec implemented by the hardware accelerator.
2417      *
2418      * See CODEC_TYPE_xxx
2419      */
2420     enum CodecType type;
2421
2422     /**
2423      * Codec implemented by the hardware accelerator.
2424      *
2425      * See CODEC_ID_xxx
2426      */
2427     enum CodecID id;
2428
2429     /**
2430      * Supported pixel format.
2431      *
2432      * Only hardware accelerated formats are supported here.
2433      */
2434     enum PixelFormat pix_fmt;
2435
2436     /**
2437      * Hardware accelerated codec capabilities.
2438      * see FF_HWACCEL_CODEC_CAP_*
2439      */
2440     int capabilities;
2441
2442     struct AVHWAccel *next;
2443
2444     /**
2445      * Called at the beginning of each frame or field picture.
2446      *
2447      * Meaningful frame information (codec specific) is guaranteed to
2448      * be parsed at this point. This function is mandatory.
2449      *
2450      * Note that \p buf can be NULL along with \p buf_size set to 0.
2451      * Otherwise, this means the whole frame is available at this point.
2452      *
2453      * @param avctx the codec context
2454      * @param buf the frame data buffer base
2455      * @param buf_size the size of the frame in bytes
2456      * @return zero if successful, a negative value otherwise
2457      */
2458     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2459
2460     /**
2461      * Callback for each slice.
2462      *
2463      * Meaningful slice information (codec specific) is guaranteed to
2464      * be parsed at this point. This function is mandatory.
2465      *
2466      * @param avctx the codec context
2467      * @param buf the slice data buffer base
2468      * @param buf_size the size of the slice in bytes
2469      * @return zero if successful, a negative value otherwise
2470      */
2471     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2472
2473     /**
2474      * Called at the end of each frame or field picture.
2475      *
2476      * The whole picture is parsed at this point and can now be sent
2477      * to the hardware accelerator. This function is mandatory.
2478      *
2479      * @param avctx the codec context
2480      * @return zero if successful, a negative value otherwise
2481      */
2482     int (*end_frame)(AVCodecContext *avctx);
2483
2484     /**
2485      * Size of HW accelerator private data.
2486      *
2487      * Private data is allocated with av_mallocz() before
2488      * AVCodecContext.get_buffer() and deallocated after
2489      * AVCodecContext.release_buffer().
2490      */
2491     int priv_data_size;
2492 } AVHWAccel;
2493
2494 /**
2495  * four components are given, that's all.
2496  * the last component is alpha
2497  */
2498 typedef struct AVPicture {
2499     uint8_t *data[4];
2500     int linesize[4];       ///< number of bytes per line
2501 } AVPicture;
2502
2503 #if LIBAVCODEC_VERSION_MAJOR < 53
2504 /**
2505  * AVPaletteControl
2506  * This structure defines a method for communicating palette changes
2507  * between and demuxer and a decoder.
2508  *
2509  * @deprecated Use AVPacket to send palette changes instead.
2510  * This is totally broken.
2511  */
2512 #define AVPALETTE_SIZE 1024
2513 #define AVPALETTE_COUNT 256
2514 typedef struct AVPaletteControl {
2515
2516     /* Demuxer sets this to 1 to indicate the palette has changed;
2517      * decoder resets to 0. */
2518     int palette_changed;
2519
2520     /* 4-byte ARGB palette entries, stored in native byte order; note that
2521      * the individual palette components should be on a 8-bit scale; if
2522      * the palette data comes from an IBM VGA native format, the component
2523      * data is probably 6 bits in size and needs to be scaled. */
2524     unsigned int palette[AVPALETTE_COUNT];
2525
2526 } AVPaletteControl attribute_deprecated;
2527 #endif
2528
2529 typedef struct AVPacket {
2530     /**
2531      * Presentation timestamp in time_base units; the time at which the
2532      * decompressed packet will be presented to the user.
2533      * Can be AV_NOPTS_VALUE if it is not stored in the file.
2534      * pts MUST be larger or equal to dts as presentation cannot happen before
2535      * decompression, unless one wants to view hex dumps. Some formats misuse
2536      * the terms dts and pts/cts to mean something different. Such timestamps
2537      * must be converted to true pts/dts before they are stored in AVPacket.
2538      */
2539     int64_t pts;
2540     /**
2541      * Decompression timestamp in time_base units; the time at which the
2542      * packet is decompressed.
2543      * Can be AV_NOPTS_VALUE if it is not stored in the file.
2544      */
2545     int64_t dts;
2546     uint8_t *data;
2547     int   size;
2548     int   stream_index;
2549     int   flags;
2550     /**
2551      * Duration of this packet in time_base units, 0 if unknown.
2552      * Equals next_pts - this_pts in presentation order.
2553      */
2554     int   duration;
2555     void  (*destruct)(struct AVPacket *);
2556     void  *priv;
2557     int64_t pos;                            ///< byte position in stream, -1 if unknown
2558
2559     /**
2560      * Time difference in stream time base units from the pts of this
2561      * packet to the point at which the output from the decoder has converged
2562      * independent from the availability of previous frames. That is, the
2563      * frames are virtually identical no matter if decoding started from
2564      * the very first frame or from this keyframe.
2565      * Is AV_NOPTS_VALUE if unknown.
2566      * This field is not the display duration of the current packet.
2567      *
2568      * The purpose of this field is to allow seeking in streams that have no
2569      * keyframes in the conventional sense. It corresponds to the
2570      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
2571      * essential for some types of subtitle streams to ensure that all
2572      * subtitles are correctly displayed after seeking.
2573      */
2574     int64_t convergence_duration;
2575 } AVPacket;
2576 #define PKT_FLAG_KEY   0x0001
2577
2578 enum AVSubtitleType {
2579     SUBTITLE_NONE,
2580
2581     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2582
2583     /**
2584      * Plain text, the text field must be set by the decoder and is
2585      * authoritative. ass and pict fields may contain approximations.
2586      */
2587     SUBTITLE_TEXT,
2588
2589     /**
2590      * Formatted text, the ass field must be set by the decoder and is
2591      * authoritative. pict and text fields may contain approximations.
2592      */
2593     SUBTITLE_ASS,
2594 };
2595
2596 typedef struct AVSubtitleRect {
2597     int x;         ///< top left corner  of pict, undefined when pict is not set
2598     int y;         ///< top left corner  of pict, undefined when pict is not set
2599     int w;         ///< width            of pict, undefined when pict is not set
2600     int h;         ///< height           of pict, undefined when pict is not set
2601     int nb_colors; ///< number of colors in pict, undefined when pict is not set
2602
2603     /**
2604      * data+linesize for the bitmap of this subtitle.
2605      * can be set for text/ass as well once they where rendered
2606      */
2607     AVPicture pict;
2608     enum AVSubtitleType type;
2609
2610     char *text;                     ///< 0 terminated plain UTF-8 text
2611
2612     /**
2613      * 0 terminated ASS/SSA compatible event line.
2614      * The pressentation of this is unaffected by the other values in this
2615      * struct.
2616      */
2617     char *ass;
2618 } AVSubtitleRect;
2619
2620 typedef struct AVSubtitle {
2621     uint16_t format; /* 0 = graphics */
2622     uint32_t start_display_time; /* relative to packet pts, in ms */
2623     uint32_t end_display_time; /* relative to packet pts, in ms */
2624     unsigned num_rects;
2625     AVSubtitleRect **rects;
2626 } AVSubtitle;
2627
2628
2629 /* resample.c */
2630
2631 struct ReSampleContext;
2632 struct AVResampleContext;
2633
2634 typedef struct ReSampleContext ReSampleContext;
2635
2636 #if LIBAVCODEC_VERSION_MAJOR < 53
2637 /**
2638  * @deprecated Use av_audio_resample_init() instead.
2639  */
2640 attribute_deprecated ReSampleContext *audio_resample_init(int output_channels, int input_channels,
2641                                                           int output_rate, int input_rate);
2642 #endif
2643 /**
2644  *  Initializes audio resampling context
2645  *
2646  * @param output_channels  number of output channels
2647  * @param input_channels   number of input channels
2648  * @param output_rate      output sample rate
2649  * @param input_rate       input sample rate
2650  * @param sample_fmt_out   requested output sample format
2651  * @param sample_fmt_in    input sample format
2652  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff freq
2653  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2654  * @param linear           If 1 then the used FIR filter will be linearly interpolated
2655                            between the 2 closest, if 0 the closest will be used
2656  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
2657  * @return allocated ReSampleContext, NULL if error occured
2658  */
2659 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
2660                                         int output_rate, int input_rate,
2661                                         enum SampleFormat sample_fmt_out,
2662                                         enum SampleFormat sample_fmt_in,
2663                                         int filter_length, int log2_phase_count,
2664                                         int linear, double cutoff);
2665
2666 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
2667 void audio_resample_close(ReSampleContext *s);
2668
2669
2670 /**
2671  * Initializes an audio resampler.
2672  * Note, if either rate is not an integer then simply scale both rates up so they are.
2673  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
2674  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
2675  * @param linear If 1 then the used FIR filter will be linearly interpolated
2676                  between the 2 closest, if 0 the closest will be used
2677  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
2678  */
2679 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
2680
2681 /**
2682  * resamples.
2683  * @param src an array of unconsumed samples
2684  * @param consumed the number of samples of src which have been consumed are returned here
2685  * @param src_size the number of unconsumed samples available
2686  * @param dst_size the amount of space in samples available in dst
2687  * @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.
2688  * @return the number of samples written in dst or -1 if an error occurred
2689  */
2690 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
2691
2692
2693 /**
2694  * Compensates samplerate/timestamp drift. The compensation is done by changing
2695  * the resampler parameters, so no audible clicks or similar distortions occur
2696  * @param compensation_distance distance in output samples over which the compensation should be performed
2697  * @param sample_delta number of output samples which should be output less
2698  *
2699  * example: av_resample_compensate(c, 10, 500)
2700  * here instead of 510 samples only 500 samples would be output
2701  *
2702  * note, due to rounding the actual compensation might be slightly different,
2703  * especially if the compensation_distance is large and the in_rate used during init is small
2704  */
2705 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
2706 void av_resample_close(struct AVResampleContext *c);
2707
2708 /**
2709  * Allocate memory for a picture.  Call avpicture_free to free it.
2710  *
2711  * @param picture the picture to be filled in
2712  * @param pix_fmt the format of the picture
2713  * @param width the width of the picture
2714  * @param height the height of the picture
2715  * @return zero if successful, a negative value if not
2716  */
2717 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
2718
2719 /**
2720  * Free a picture previously allocated by avpicture_alloc().
2721  *
2722  * @param picture the AVPicture to be freed
2723  */
2724 void avpicture_free(AVPicture *picture);
2725
2726 /**
2727  * Fill in the AVPicture fields.
2728  * The fields of the given AVPicture are filled in by using the 'ptr' address
2729  * which points to the image data buffer. Depending on the specified picture
2730  * format, one or multiple image data pointers and line sizes will be set.
2731  * If a planar format is specified, several pointers will be set pointing to
2732  * the different picture planes and the line sizes of the different planes
2733  * will be stored in the lines_sizes array.
2734  * Call with ptr == NULL to get the required size for the ptr buffer.
2735  *
2736  * @param picture AVPicture whose fields are to be filled in
2737  * @param ptr Buffer which will contain or contains the actual image data
2738  * @param pix_fmt The format in which the picture data is stored.
2739  * @param width the width of the image in pixels
2740  * @param height the height of the image in pixels
2741  * @return size of the image data in bytes
2742  */
2743 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
2744                    int pix_fmt, int width, int height);
2745 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
2746                      unsigned char *dest, int dest_size);
2747
2748 /**
2749  * Calculate the size in bytes that a picture of the given width and height
2750  * would occupy if stored in the given picture format.
2751  * Note that this returns the size of a compact representation as generated
2752  * by avpicture_layout, which can be smaller than the size required for e.g.
2753  * avpicture_fill.
2754  *
2755  * @param pix_fmt the given picture format
2756  * @param width the width of the image
2757  * @param height the height of the image
2758  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
2759  */
2760 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
2761 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
2762 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
2763 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
2764
2765 /**
2766  * Returns the pixel format corresponding to the name \p name.
2767  *
2768  * If there is no pixel format with name \p name, then looks for a
2769  * pixel format with the name corresponding to the native endian
2770  * format of \p name.
2771  * For example in a little-endian system, first looks for "gray16",
2772  * then for "gray16le".
2773  *
2774  * Finally if no pixel format has been found, returns \c PIX_FMT_NONE.
2775  */
2776 enum PixelFormat avcodec_get_pix_fmt(const char* name);
2777 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat p);
2778
2779 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
2780 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
2781 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
2782 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
2783 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
2784 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
2785
2786 /**
2787  * Computes what kind of losses will occur when converting from one specific
2788  * pixel format to another.
2789  * When converting from one pixel format to another, information loss may occur.
2790  * For example, when converting from RGB24 to GRAY, the color information will
2791  * be lost. Similarly, other losses occur when converting from some formats to
2792  * other formats. These losses can involve loss of chroma, but also loss of
2793  * resolution, loss of color depth, loss due to the color space conversion, loss
2794  * of the alpha bits or loss due to color quantization.
2795  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
2796  * which will occur when converting from one pixel format to another.
2797  *
2798  * @param[in] dst_pix_fmt destination pixel format
2799  * @param[in] src_pix_fmt source pixel format
2800  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2801  * @return Combination of flags informing you what kind of losses will occur.
2802  */
2803 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
2804                              int has_alpha);
2805
2806 /**
2807  * Finds the best pixel format to convert to given a certain source pixel
2808  * format.  When converting from one pixel format to another, information loss
2809  * may occur.  For example, when converting from RGB24 to GRAY, the color
2810  * information will be lost. Similarly, other losses occur when converting from
2811  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
2812  * the given pixel formats should be used to suffer the least amount of loss.
2813  * The pixel formats from which it chooses one, are determined by the
2814  * \p pix_fmt_mask parameter.
2815  *
2816  * @code
2817  * src_pix_fmt = PIX_FMT_YUV420P;
2818  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
2819  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
2820  * @endcode
2821  *
2822  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
2823  * @param[in] src_pix_fmt source pixel format
2824  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
2825  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
2826  * @return The best pixel format to convert to or -1 if none was found.
2827  */
2828 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
2829                               int has_alpha, int *loss_ptr);
2830
2831
2832 /**
2833  * Print in buf the string corresponding to the pixel format with
2834  * number pix_fmt, or an header if pix_fmt is negative.
2835  *
2836  * @param[in] buf the buffer where to write the string
2837  * @param[in] buf_size the size of buf
2838  * @param[in] pix_fmt the number of the pixel format to print the corresponding info string, or
2839  * a negative value to print the corresponding header.
2840  * Meaningful values for obtaining a pixel format info vary from 0 to PIX_FMT_NB -1.
2841  */
2842 void avcodec_pix_fmt_string (char *buf, int buf_size, enum PixelFormat pix_fmt);
2843
2844 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
2845 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
2846
2847 /**
2848  * Tell if an image really has transparent alpha values.
2849  * @return ored mask of FF_ALPHA_xxx constants
2850  */
2851 int img_get_alpha_info(const AVPicture *src,
2852                        enum PixelFormat pix_fmt, int width, int height);
2853
2854 /* deinterlace a picture */
2855 /* deinterlace - if not supported return -1 */
2856 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
2857                           enum PixelFormat pix_fmt, int width, int height);
2858
2859 /* external high level API */
2860
2861 /**
2862  * If c is NULL, returns the first registered codec,
2863  * if c is non-NULL, returns the next registered codec after c,
2864  * or NULL if c is the last one.
2865  */
2866 AVCodec *av_codec_next(AVCodec *c);
2867
2868 /**
2869  * Returns the LIBAVCODEC_VERSION_INT constant.
2870  */
2871 unsigned avcodec_version(void);
2872
2873 /**
2874  * Initializes libavcodec.
2875  *
2876  * @warning This function \e must be called before any other libavcodec
2877  * function.
2878  */
2879 void avcodec_init(void);
2880
2881 #if LIBAVCODEC_VERSION_MAJOR < 53
2882 /**
2883  * @deprecated Deprecated in favor of avcodec_register().
2884  */
2885 attribute_deprecated void register_avcodec(AVCodec *codec);
2886 #endif
2887
2888 /**
2889  * Register the codec \p codec and initialize libavcodec.
2890  *
2891  * @see avcodec_init()
2892  */
2893 void avcodec_register(AVCodec *codec);
2894
2895 /**
2896  * Finds a registered encoder with a matching codec ID.
2897  *
2898  * @param id CodecID of the requested encoder
2899  * @return An encoder if one was found, NULL otherwise.
2900  */
2901 AVCodec *avcodec_find_encoder(enum CodecID id);
2902
2903 /**
2904  * Finds a registered encoder with the specified name.
2905  *
2906  * @param name name of the requested encoder
2907  * @return An encoder if one was found, NULL otherwise.
2908  */
2909 AVCodec *avcodec_find_encoder_by_name(const char *name);
2910
2911 /**
2912  * Finds a registered decoder with a matching codec ID.
2913  *
2914  * @param id CodecID of the requested decoder
2915  * @return A decoder if one was found, NULL otherwise.
2916  */
2917 AVCodec *avcodec_find_decoder(enum CodecID id);
2918
2919 /**
2920  * Finds a registered decoder with the specified name.
2921  *
2922  * @param name name of the requested decoder
2923  * @return A decoder if one was found, NULL otherwise.
2924  */
2925 AVCodec *avcodec_find_decoder_by_name(const char *name);
2926 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
2927
2928 /**
2929  * Sets the fields of the given AVCodecContext to default values.
2930  *
2931  * @param s The AVCodecContext of which the fields should be set to default values.
2932  */
2933 void avcodec_get_context_defaults(AVCodecContext *s);
2934
2935 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2936  *  we WILL change its arguments and name a few times! */
2937 void avcodec_get_context_defaults2(AVCodecContext *s, enum CodecType);
2938
2939 /**
2940  * Allocates an AVCodecContext and sets its fields to default values.  The
2941  * resulting struct can be deallocated by simply calling av_free().
2942  *
2943  * @return An AVCodecContext filled with default values or NULL on failure.
2944  * @see avcodec_get_context_defaults
2945  */
2946 AVCodecContext *avcodec_alloc_context(void);
2947
2948 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
2949  *  we WILL change its arguments and name a few times! */
2950 AVCodecContext *avcodec_alloc_context2(enum CodecType);
2951
2952 /**
2953  * Sets the fields of the given AVFrame to default values.
2954  *
2955  * @param pic The AVFrame of which the fields should be set to default values.
2956  */
2957 void avcodec_get_frame_defaults(AVFrame *pic);
2958
2959 /**
2960  * Allocates an AVFrame and sets its fields to default values.  The resulting
2961  * struct can be deallocated by simply calling av_free().
2962  *
2963  * @return An AVFrame filled with default values or NULL on failure.
2964  * @see avcodec_get_frame_defaults
2965  */
2966 AVFrame *avcodec_alloc_frame(void);
2967
2968 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
2969 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
2970 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
2971 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
2972
2973 /**
2974  * Checks if the given dimension of a picture is valid, meaning that all
2975  * bytes of the picture can be addressed with a signed int.
2976  *
2977  * @param[in] w Width of the picture.
2978  * @param[in] h Height of the picture.
2979  * @return Zero if valid, a negative value if invalid.
2980  */
2981 int avcodec_check_dimensions(void *av_log_ctx, unsigned int w, unsigned int h);
2982 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
2983
2984 int avcodec_thread_init(AVCodecContext *s, int thread_count);
2985 void avcodec_thread_free(AVCodecContext *s);
2986 int avcodec_thread_execute(AVCodecContext *s, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2987 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
2988 //FIXME func typedef
2989
2990 /**
2991  * Initializes the AVCodecContext to use the given AVCodec. Prior to using this
2992  * function the context has to be allocated.
2993  *
2994  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
2995  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
2996  * retrieving a codec.
2997  *
2998  * @warning This function is not thread safe!
2999  *
3000  * @code
3001  * avcodec_register_all();
3002  * codec = avcodec_find_decoder(CODEC_ID_H264);
3003  * if (!codec)
3004  *     exit(1);
3005  *
3006  * context = avcodec_alloc_context();
3007  *
3008  * if (avcodec_open(context, codec) < 0)
3009  *     exit(1);
3010  * @endcode
3011  *
3012  * @param avctx The context which will be set up to use the given codec.
3013  * @param codec The codec to use within the context.
3014  * @return zero on success, a negative value on error
3015  * @see avcodec_alloc_context, avcodec_find_decoder, avcodec_find_encoder
3016  */
3017 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3018
3019 /**
3020  * Decodes an audio frame from \p buf into \p samples.
3021  * The avcodec_decode_audio2() function decodes an audio frame from the input
3022  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
3023  * audio codec which was coupled with \p avctx using avcodec_open(). The
3024  * resulting decoded frame is stored in output buffer \p samples.  If no frame
3025  * could be decompressed, \p frame_size_ptr is zero. Otherwise, it is the
3026  * decompressed frame size in \e bytes.
3027  *
3028  * @warning You \e must set \p frame_size_ptr to the allocated size of the
3029  * output buffer before calling avcodec_decode_audio2().
3030  *
3031  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3032  * the actual read bytes because some optimized bitstream readers read 32 or 64
3033  * bits at once and could read over the end.
3034  *
3035  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
3036  * no overreading happens for damaged MPEG streams.
3037  *
3038  * @note You might have to align the input buffer \p buf and output buffer \p
3039  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3040  * necessary at all, on others it won't work at all if not aligned and on others
3041  * it will work but it will have an impact on performance. In practice, the
3042  * bitstream should have 4 byte alignment at minimum and all sample data should
3043  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3044  * the linesize is not a multiple of 16 then there's no sense in aligning the
3045  * start of the buffer to 16.
3046  *
3047  * @param avctx the codec context
3048  * @param[out] samples the output buffer
3049  * @param[in,out] frame_size_ptr the output buffer size in bytes
3050  * @param[in] buf the input buffer
3051  * @param[in] buf_size the input buffer size in bytes
3052  * @return On error a negative value is returned, otherwise the number of bytes
3053  * used or zero if no frame could be decompressed.
3054  */
3055 int avcodec_decode_audio2(AVCodecContext *avctx, int16_t *samples,
3056                          int *frame_size_ptr,
3057                          const uint8_t *buf, int buf_size);
3058
3059 /**
3060  * Decodes a video frame from \p buf into \p picture.
3061  * The avcodec_decode_video() function decodes a video frame from the input
3062  * buffer \p buf of size \p buf_size. To decode it, it makes use of the
3063  * video codec which was coupled with \p avctx using avcodec_open(). The
3064  * resulting decoded frame is stored in \p picture.
3065  *
3066  * @warning The input buffer must be \c FF_INPUT_BUFFER_PADDING_SIZE larger than
3067  * the actual read bytes because some optimized bitstream readers read 32 or 64
3068  * bits at once and could read over the end.
3069  *
3070  * @warning The end of the input buffer \p buf should be set to 0 to ensure that
3071  * no overreading happens for damaged MPEG streams.
3072  *
3073  * @note You might have to align the input buffer \p buf and output buffer \p
3074  * samples. The alignment requirements depend on the CPU: on some CPUs it isn't
3075  * necessary at all, on others it won't work at all if not aligned and on others
3076  * it will work but it will have an impact on performance. In practice, the
3077  * bitstream should have 4 byte alignment at minimum and all sample data should
3078  * be 16 byte aligned unless the CPU doesn't need it (AltiVec and SSE do). If
3079  * the linesize is not a multiple of 16 then there's no sense in aligning the
3080  * start of the buffer to 16.
3081  *
3082  * @note Some codecs have a delay between input and output, these need to be
3083  * feeded with buf=NULL, buf_size=0 at the end to return the remaining frames.
3084  *
3085  * @param avctx the codec context
3086  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3087  * @param[in] buf the input buffer
3088  * @param[in] buf_size the size of the input buffer in bytes
3089  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3090  * @return On error a negative value is returned, otherwise the number of bytes
3091  * used or zero if no frame could be decompressed.
3092  */
3093 int avcodec_decode_video(AVCodecContext *avctx, AVFrame *picture,
3094                          int *got_picture_ptr,
3095                          const uint8_t *buf, int buf_size);
3096
3097 /* Decode a subtitle message. Return -1 if error, otherwise return the
3098  * number of bytes used. If no subtitle could be decompressed,
3099  * got_sub_ptr is zero. Otherwise, the subtitle is stored in *sub. */
3100 int avcodec_decode_subtitle(AVCodecContext *avctx, AVSubtitle *sub,
3101                             int *got_sub_ptr,
3102                             const uint8_t *buf, int buf_size);
3103 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3104                         int *data_size_ptr,
3105                         uint8_t *buf, int buf_size);
3106
3107 /**
3108  * Encodes an audio frame from \p samples into \p buf.
3109  * The avcodec_encode_audio() function encodes an audio frame from the input
3110  * buffer \p samples. To encode it, it makes use of the audio codec which was
3111  * coupled with \p avctx using avcodec_open(). The resulting encoded frame is
3112  * stored in output buffer \p buf.
3113  *
3114  * @note The output buffer should be at least \c FF_MIN_BUFFER_SIZE bytes large.
3115  *
3116  * @param avctx the codec context
3117  * @param[out] buf the output buffer
3118  * @param[in] buf_size the output buffer size
3119  * @param[in] samples the input buffer containing the samples
3120  * The number of samples read from this buffer is frame_size*channels,
3121  * both of which are defined in \p avctx.
3122  * For PCM audio the number of samples read from \p samples is equal to
3123  * \p buf_size * input_sample_size / output_sample_size.
3124  * @return On error a negative value is returned, on success zero or the number
3125  * of bytes used to encode the data read from the input buffer.
3126  */
3127 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3128                          const short *samples);
3129
3130 /**
3131  * Encodes a video frame from \p pict into \p buf.
3132  * The avcodec_encode_video() function encodes a video frame from the input
3133  * \p pict. To encode it, it makes use of the video codec which was coupled with
3134  * \p avctx using avcodec_open(). The resulting encoded bytes representing the
3135  * frame are stored in the output buffer \p buf. The input picture should be
3136  * stored using a specific format, namely \c avctx.pix_fmt.
3137  *
3138  * @param avctx the codec context
3139  * @param[out] buf the output buffer for the bitstream of encoded frame
3140  * @param[in] buf_size the size of the output buffer in bytes
3141  * @param[in] pict the input picture to encode
3142  * @return On error a negative value is returned, on success zero or the number
3143  * of bytes used from the output buffer.
3144  */
3145 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3146                          const AVFrame *pict);
3147 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3148                             const AVSubtitle *sub);
3149
3150 int avcodec_close(AVCodecContext *avctx);
3151
3152 /**
3153  * Register all the codecs, parsers and bitstream filters which were enabled at
3154  * configuration time. If you do not call this function you can select exactly
3155  * which formats you want to support, by using the individual registration
3156  * functions.
3157  *
3158  * @see avcodec_register
3159  * @see av_register_codec_parser
3160  * @see av_register_bitstream_filter
3161  */
3162 void avcodec_register_all(void);
3163
3164 /**
3165  * Flush buffers, should be called when seeking or when switching to a different stream.
3166  */
3167 void avcodec_flush_buffers(AVCodecContext *avctx);
3168
3169 void avcodec_default_free_buffers(AVCodecContext *s);
3170
3171 /* misc useful functions */
3172
3173 /**
3174  * Returns a single letter to describe the given picture type \p pict_type.
3175  *
3176  * @param[in] pict_type the picture type
3177  * @return A single character representing the picture type.
3178  */
3179 char av_get_pict_type_char(int pict_type);
3180
3181 /**
3182  * Returns codec bits per sample.
3183  *
3184  * @param[in] codec_id the codec
3185  * @return Number of bits per sample or zero if unknown for the given codec.
3186  */
3187 int av_get_bits_per_sample(enum CodecID codec_id);
3188
3189 /**
3190  * Returns sample format bits per sample.
3191  *
3192  * @param[in] sample_fmt the sample format
3193  * @return Number of bits per sample or zero if unknown for the given sample format.
3194  */
3195 int av_get_bits_per_sample_format(enum SampleFormat sample_fmt);
3196
3197 /* frame parsing */
3198 typedef struct AVCodecParserContext {
3199     void *priv_data;
3200     struct AVCodecParser *parser;
3201     int64_t frame_offset; /* offset of the current frame */
3202     int64_t cur_offset; /* current offset
3203                            (incremented by each av_parser_parse()) */
3204     int64_t next_frame_offset; /* offset of the next frame */
3205     /* video info */
3206     int pict_type; /* XXX: Put it back in AVCodecContext. */
3207     /**
3208      * This field is used for proper frame duration computation in lavf.
3209      * It signals, how much longer the frame duration of the current frame
3210      * is compared to normal frame duration.
3211      *
3212      * frame_duration = (1 + repeat_pict) * time_base
3213      *
3214      * It is used by codecs like H.264 to display telecined material.
3215      */
3216     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3217     int64_t pts;     /* pts of the current frame */
3218     int64_t dts;     /* dts of the current frame */
3219
3220     /* private data */
3221     int64_t last_pts;
3222     int64_t last_dts;
3223     int fetch_timestamp;
3224
3225 #define AV_PARSER_PTS_NB 4
3226     int cur_frame_start_index;
3227     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3228     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3229     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3230
3231     int flags;
3232 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3233
3234     int64_t offset;      ///< byte offset from starting packet start
3235     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3236
3237     /*!
3238      * Set by parser to 1 for key frames and 0 for non-key frames.
3239      * It is initialized to -1, so if the parser doesn't set this flag,
3240      * old-style fallback using FF_I_TYPE picture type as key frames
3241      * will be used.
3242      */
3243     int key_frame;
3244
3245     /**
3246      * Time difference in stream time base units from the pts of this
3247      * packet to the point at which the output from the decoder has converged
3248      * independent from the availability of previous frames. That is, the
3249      * frames are virtually identical no matter if decoding started from
3250      * the very first frame or from this keyframe.
3251      * Is AV_NOPTS_VALUE if unknown.
3252      * This field is not the display duration of the current frame.
3253      *
3254      * The purpose of this field is to allow seeking in streams that have no
3255      * keyframes in the conventional sense. It corresponds to the
3256      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3257      * essential for some types of subtitle streams to ensure that all
3258      * subtitles are correctly displayed after seeking.
3259      */
3260     int64_t convergence_duration;
3261
3262     // Timestamp generation support:
3263     /**
3264      * Synchronization point for start of timestamp generation.
3265      *
3266      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3267      * (default).
3268      *
3269      * For example, this corresponds to presence of H.264 buffering period
3270      * SEI message.
3271      */
3272     int dts_sync_point;
3273
3274     /**
3275      * Offset of the current timestamp against last timestamp sync point in
3276      * units of AVCodecContext.time_base.
3277      *
3278      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3279      * contain a valid timestamp offset.
3280      *
3281      * Note that the timestamp of sync point has usually a nonzero
3282      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3283      * the next frame after timestamp sync point will be usually 1.
3284      *
3285      * For example, this corresponds to H.264 cpb_removal_delay.
3286      */
3287     int dts_ref_dts_delta;
3288
3289     /**
3290      * Presentation delay of current frame in units of AVCodecContext.time_base.
3291      *
3292      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3293      * contain valid non-negative timestamp delta (presentation time of a frame
3294      * must not lie in the past).
3295      *
3296      * This delay represents the difference between decoding and presentation
3297      * time of the frame.
3298      *
3299      * For example, this corresponds to H.264 dpb_output_delay.
3300      */
3301     int pts_dts_delta;
3302
3303     /**
3304      * Position of the packet in file.
3305      *
3306      * Analogous to cur_frame_pts/dts
3307      */
3308     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3309
3310     /**
3311      * Byte position of currently parsed frame in stream.
3312      */
3313     int64_t pos;
3314
3315     /**
3316      * Previous frame byte position.
3317      */
3318     int64_t last_pos;
3319 } AVCodecParserContext;
3320
3321 typedef struct AVCodecParser {
3322     int codec_ids[5]; /* several codec IDs are permitted */
3323     int priv_data_size;
3324     int (*parser_init)(AVCodecParserContext *s);
3325     int (*parser_parse)(AVCodecParserContext *s,
3326                         AVCodecContext *avctx,
3327                         const uint8_t **poutbuf, int *poutbuf_size,
3328                         const uint8_t *buf, int buf_size);
3329     void (*parser_close)(AVCodecParserContext *s);
3330     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3331     struct AVCodecParser *next;
3332 } AVCodecParser;
3333
3334 AVCodecParser *av_parser_next(AVCodecParser *c);
3335
3336 void av_register_codec_parser(AVCodecParser *parser);
3337 AVCodecParserContext *av_parser_init(int codec_id);
3338
3339 #if LIBAVCODEC_VERSION_MAJOR < 53
3340 attribute_deprecated
3341 int av_parser_parse(AVCodecParserContext *s,
3342                     AVCodecContext *avctx,
3343                     uint8_t **poutbuf, int *poutbuf_size,
3344                     const uint8_t *buf, int buf_size,
3345                     int64_t pts, int64_t dts);
3346 #endif
3347
3348 /**
3349  * Parse a packet.
3350  *
3351  * @param s             parser context.
3352  * @param avctx         codec context.
3353  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3354  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3355  * @param buf           input buffer.
3356  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3357  * @param pts           input presentation timestamp.
3358  * @param dts           input decoding timestamp.
3359  * @param pos           input byte position in stream.
3360  * @return the number of bytes of the input bitstream used.
3361  *
3362  * Example:
3363  * @code
3364  *   while(in_len){
3365  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3366  *                                        in_data, in_len,
3367  *                                        pts, dts, pos);
3368  *       in_data += len;
3369  *       in_len  -= len;
3370  *
3371  *       if(size)
3372  *          decode_frame(data, size);
3373  *   }
3374  * @endcode
3375  */
3376 int av_parser_parse2(AVCodecParserContext *s,
3377                      AVCodecContext *avctx,
3378                      uint8_t **poutbuf, int *poutbuf_size,
3379                      const uint8_t *buf, int buf_size,
3380                      int64_t pts, int64_t dts,
3381                      int64_t pos);
3382
3383 int av_parser_change(AVCodecParserContext *s,
3384                      AVCodecContext *avctx,
3385                      uint8_t **poutbuf, int *poutbuf_size,
3386                      const uint8_t *buf, int buf_size, int keyframe);
3387 void av_parser_close(AVCodecParserContext *s);
3388
3389
3390 typedef struct AVBitStreamFilterContext {
3391     void *priv_data;
3392     struct AVBitStreamFilter *filter;
3393     AVCodecParserContext *parser;
3394     struct AVBitStreamFilterContext *next;
3395 } AVBitStreamFilterContext;
3396
3397
3398 typedef struct AVBitStreamFilter {
3399     const char *name;
3400     int priv_data_size;
3401     int (*filter)(AVBitStreamFilterContext *bsfc,
3402                   AVCodecContext *avctx, const char *args,
3403                   uint8_t **poutbuf, int *poutbuf_size,
3404                   const uint8_t *buf, int buf_size, int keyframe);
3405     void (*close)(AVBitStreamFilterContext *bsfc);
3406     struct AVBitStreamFilter *next;
3407 } AVBitStreamFilter;
3408
3409 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
3410 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
3411 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
3412                                AVCodecContext *avctx, const char *args,
3413                                uint8_t **poutbuf, int *poutbuf_size,
3414                                const uint8_t *buf, int buf_size, int keyframe);
3415 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
3416
3417 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
3418
3419 /* memory */
3420
3421 /**
3422  * Reallocates the given block if it is not large enough, otherwise it
3423  * does nothing.
3424  *
3425  * @see av_realloc
3426  */
3427 void *av_fast_realloc(void *ptr, unsigned int *size, unsigned int min_size);
3428
3429 /**
3430  * Copy image 'src' to 'dst'.
3431  */
3432 void av_picture_copy(AVPicture *dst, const AVPicture *src,
3433                      enum PixelFormat pix_fmt, int width, int height);
3434
3435 /**
3436  * Crop image top and left side.
3437  */
3438 int av_picture_crop(AVPicture *dst, const AVPicture *src,
3439                     enum PixelFormat pix_fmt, int top_band, int left_band);
3440
3441 /**
3442  * Pad image.
3443  */
3444 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
3445             int padtop, int padbottom, int padleft, int padright, int *color);
3446
3447 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
3448
3449 /**
3450  * Parses \p str and put in \p width_ptr and \p height_ptr the detected values.
3451  *
3452  * @return 0 in case of a successful parsing, a negative value otherwise
3453  * @param[in] str the string to parse: it has to be a string in the format
3454  * <width>x<height> or a valid video frame size abbreviation.
3455  * @param[in,out] width_ptr pointer to the variable which will contain the detected
3456  * frame width value
3457  * @param[in,out] height_ptr pointer to the variable which will contain the detected
3458  * frame height value
3459  */
3460 int av_parse_video_frame_size(int *width_ptr, int *height_ptr, const char *str);
3461
3462 /**
3463  * Parses \p str and put in \p frame_rate the detected values.
3464  *
3465  * @return 0 in case of a successful parsing, a negative value otherwise
3466  * @param[in] str the string to parse: it has to be a string in the format
3467  * <frame_rate_num>/<frame_rate_den>, a float number or a valid video rate abbreviation
3468  * @param[in,out] frame_rate pointer to the AVRational which will contain the detected
3469  * frame rate
3470  */
3471 int av_parse_video_frame_rate(AVRational *frame_rate, const char *str);
3472
3473 /* error handling */
3474 #if EINVAL > 0
3475 #define AVERROR(e) (-(e)) /**< Returns a negative error code from a POSIX error code, to return from library functions. */
3476 #define AVUNERROR(e) (-(e)) /**< Returns a POSIX error code from a library function error return value. */
3477 #else
3478 /* Some platforms have E* and errno already negated. */
3479 #define AVERROR(e) (e)
3480 #define AVUNERROR(e) (e)
3481 #endif
3482 #define AVERROR_UNKNOWN     AVERROR(EINVAL)  /**< unknown error */
3483 #define AVERROR_IO          AVERROR(EIO)     /**< I/O error */
3484 #define AVERROR_NUMEXPECTED AVERROR(EDOM)    /**< Number syntax expected in filename. */
3485 #define AVERROR_INVALIDDATA AVERROR(EINVAL)  /**< invalid data found */
3486 #define AVERROR_NOMEM       AVERROR(ENOMEM)  /**< not enough memory */
3487 #define AVERROR_NOFMT       AVERROR(EILSEQ)  /**< unknown format */
3488 #define AVERROR_NOTSUPP     AVERROR(ENOSYS)  /**< Operation not supported. */
3489 #define AVERROR_NOENT       AVERROR(ENOENT)  /**< No such file or directory. */
3490 #define AVERROR_EOF         AVERROR(EPIPE)   /**< End of file. */
3491 #define AVERROR_PATCHWELCOME    -MKTAG('P','A','W','E') /**< Not yet implemented in FFmpeg. Patches welcome. */
3492
3493 /**
3494  * Registers the hardware accelerator \p hwaccel.
3495  */
3496 void av_register_hwaccel(AVHWAccel *hwaccel);
3497
3498 /**
3499  * If hwaccel is NULL, returns the first registered hardware accelerator,
3500  * if hwaccel is non-NULL, returns the next registered hardware accelerator
3501  * after hwaccel, or NULL if hwaccel is the last one.
3502  */
3503 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
3504
3505 #endif /* AVCODEC_AVCODEC_H */