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