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