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