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