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