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