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