git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of Libav.
   5  *
   6  * Libav 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  * Libav 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 Libav; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVCODEC_AVCODEC_H
  22 #define AVCODEC_AVCODEC_H
  23
  24 /**
  25  * @file
  26  * @ingroup libavc
  27  * Libavcodec external API header
  28  */
  29
  30 #include <errno.h>
  31 #include "libavutil/samplefmt.h"
  32 #include "libavutil/attributes.h"
  33 #include "libavutil/avutil.h"
  34 #include "libavutil/buffer.h"
  35 #include "libavutil/cpu.h"
  36 #include "libavutil/dict.h"
  37 #include "libavutil/frame.h"
  38 #include "libavutil/log.h"
  39 #include "libavutil/pixfmt.h"
  40 #include "libavutil/rational.h"
  41
  42 #include "version.h"
  43
  44 #if FF_API_FAST_MALLOC
  45 // to provide fast_*alloc
  46 #include "libavutil/mem.h"
  47 #endif
  48
  49 /**
  50  * @defgroup libavc Encoding/Decoding Library
  51  * @{
  52  *
  53  * @defgroup lavc_decoding Decoding
  54  * @{
  55  * @}
  56  *
  57  * @defgroup lavc_encoding Encoding
  58  * @{
  59  * @}
  60  *
  61  * @defgroup lavc_codec Codecs
  62  * @{
  63  * @defgroup lavc_codec_native Native Codecs
  64  * @{
  65  * @}
  66  * @defgroup lavc_codec_wrappers External library wrappers
  67  * @{
  68  * @}
  69  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
  70  * @{
  71  * @}
  72  * @}
  73  * @defgroup lavc_internal Internal
  74  * @{
  75  * @}
  76  * @}
  77  *
  78  */
  79
  80 /**
  81  * @defgroup lavc_core Core functions/structures.
  82  * @ingroup libavc
  83  *
  84  * Basic definitions, functions for querying libavcodec capabilities,
  85  * allocating core structures, etc.
  86  * @{
  87  */
  88
  89
  90 /**
  91  * Identify the syntax and semantics of the bitstream.
  92  * The principle is roughly:
  93  * Two decoders with the same ID can decode the same streams.
  94  * Two encoders with the same ID can encode compatible streams.
  95  * There may be slight deviations from the principle due to implementation
  96  * details.
  97  *
  98  * If you add a codec ID to this list, add it so that
  99  * 1. no value of a existing codec ID changes (that would break ABI),
 100  * 2. it is as close as possible to similar codecs.
 101  *
 102  * After adding new codec IDs, do not forget to add an entry to the codec
 103  * descriptor list and bump libavcodec minor version.
 104  */
 105 enum AVCodecID {
 106     AV_CODEC_ID_NONE,
 107
 108     /* video codecs */
 109     AV_CODEC_ID_MPEG1VIDEO,
 110     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
 111 #if FF_API_XVMC
 112     AV_CODEC_ID_MPEG2VIDEO_XVMC,
 113 #endif /* FF_API_XVMC */
 114     AV_CODEC_ID_H261,
 115     AV_CODEC_ID_H263,
 116     AV_CODEC_ID_RV10,
 117     AV_CODEC_ID_RV20,
 118     AV_CODEC_ID_MJPEG,
 119     AV_CODEC_ID_MJPEGB,
 120     AV_CODEC_ID_LJPEG,
 121     AV_CODEC_ID_SP5X,
 122     AV_CODEC_ID_JPEGLS,
 123     AV_CODEC_ID_MPEG4,
 124     AV_CODEC_ID_RAWVIDEO,
 125     AV_CODEC_ID_MSMPEG4V1,
 126     AV_CODEC_ID_MSMPEG4V2,
 127     AV_CODEC_ID_MSMPEG4V3,
 128     AV_CODEC_ID_WMV1,
 129     AV_CODEC_ID_WMV2,
 130     AV_CODEC_ID_H263P,
 131     AV_CODEC_ID_H263I,
 132     AV_CODEC_ID_FLV1,
 133     AV_CODEC_ID_SVQ1,
 134     AV_CODEC_ID_SVQ3,
 135     AV_CODEC_ID_DVVIDEO,
 136     AV_CODEC_ID_HUFFYUV,
 137     AV_CODEC_ID_CYUV,
 138     AV_CODEC_ID_H264,
 139     AV_CODEC_ID_INDEO3,
 140     AV_CODEC_ID_VP3,
 141     AV_CODEC_ID_THEORA,
 142     AV_CODEC_ID_ASV1,
 143     AV_CODEC_ID_ASV2,
 144     AV_CODEC_ID_FFV1,
 145     AV_CODEC_ID_4XM,
 146     AV_CODEC_ID_VCR1,
 147     AV_CODEC_ID_CLJR,
 148     AV_CODEC_ID_MDEC,
 149     AV_CODEC_ID_ROQ,
 150     AV_CODEC_ID_INTERPLAY_VIDEO,
 151     AV_CODEC_ID_XAN_WC3,
 152     AV_CODEC_ID_XAN_WC4,
 153     AV_CODEC_ID_RPZA,
 154     AV_CODEC_ID_CINEPAK,
 155     AV_CODEC_ID_WS_VQA,
 156     AV_CODEC_ID_MSRLE,
 157     AV_CODEC_ID_MSVIDEO1,
 158     AV_CODEC_ID_IDCIN,
 159     AV_CODEC_ID_8BPS,
 160     AV_CODEC_ID_SMC,
 161     AV_CODEC_ID_FLIC,
 162     AV_CODEC_ID_TRUEMOTION1,
 163     AV_CODEC_ID_VMDVIDEO,
 164     AV_CODEC_ID_MSZH,
 165     AV_CODEC_ID_ZLIB,
 166     AV_CODEC_ID_QTRLE,
 167     AV_CODEC_ID_TSCC,
 168     AV_CODEC_ID_ULTI,
 169     AV_CODEC_ID_QDRAW,
 170     AV_CODEC_ID_VIXL,
 171     AV_CODEC_ID_QPEG,
 172     AV_CODEC_ID_PNG,
 173     AV_CODEC_ID_PPM,
 174     AV_CODEC_ID_PBM,
 175     AV_CODEC_ID_PGM,
 176     AV_CODEC_ID_PGMYUV,
 177     AV_CODEC_ID_PAM,
 178     AV_CODEC_ID_FFVHUFF,
 179     AV_CODEC_ID_RV30,
 180     AV_CODEC_ID_RV40,
 181     AV_CODEC_ID_VC1,
 182     AV_CODEC_ID_WMV3,
 183     AV_CODEC_ID_LOCO,
 184     AV_CODEC_ID_WNV1,
 185     AV_CODEC_ID_AASC,
 186     AV_CODEC_ID_INDEO2,
 187     AV_CODEC_ID_FRAPS,
 188     AV_CODEC_ID_TRUEMOTION2,
 189     AV_CODEC_ID_BMP,
 190     AV_CODEC_ID_CSCD,
 191     AV_CODEC_ID_MMVIDEO,
 192     AV_CODEC_ID_ZMBV,
 193     AV_CODEC_ID_AVS,
 194     AV_CODEC_ID_SMACKVIDEO,
 195     AV_CODEC_ID_NUV,
 196     AV_CODEC_ID_KMVC,
 197     AV_CODEC_ID_FLASHSV,
 198     AV_CODEC_ID_CAVS,
 199     AV_CODEC_ID_JPEG2000,
 200     AV_CODEC_ID_VMNC,
 201     AV_CODEC_ID_VP5,
 202     AV_CODEC_ID_VP6,
 203     AV_CODEC_ID_VP6F,
 204     AV_CODEC_ID_TARGA,
 205     AV_CODEC_ID_DSICINVIDEO,
 206     AV_CODEC_ID_TIERTEXSEQVIDEO,
 207     AV_CODEC_ID_TIFF,
 208     AV_CODEC_ID_GIF,
 209     AV_CODEC_ID_DXA,
 210     AV_CODEC_ID_DNXHD,
 211     AV_CODEC_ID_THP,
 212     AV_CODEC_ID_SGI,
 213     AV_CODEC_ID_C93,
 214     AV_CODEC_ID_BETHSOFTVID,
 215     AV_CODEC_ID_PTX,
 216     AV_CODEC_ID_TXD,
 217     AV_CODEC_ID_VP6A,
 218     AV_CODEC_ID_AMV,
 219     AV_CODEC_ID_VB,
 220     AV_CODEC_ID_PCX,
 221     AV_CODEC_ID_SUNRAST,
 222     AV_CODEC_ID_INDEO4,
 223     AV_CODEC_ID_INDEO5,
 224     AV_CODEC_ID_MIMIC,
 225     AV_CODEC_ID_RL2,
 226     AV_CODEC_ID_ESCAPE124,
 227     AV_CODEC_ID_DIRAC,
 228     AV_CODEC_ID_BFI,
 229     AV_CODEC_ID_CMV,
 230     AV_CODEC_ID_MOTIONPIXELS,
 231     AV_CODEC_ID_TGV,
 232     AV_CODEC_ID_TGQ,
 233     AV_CODEC_ID_TQI,
 234     AV_CODEC_ID_AURA,
 235     AV_CODEC_ID_AURA2,
 236     AV_CODEC_ID_V210X,
 237     AV_CODEC_ID_TMV,
 238     AV_CODEC_ID_V210,
 239     AV_CODEC_ID_DPX,
 240     AV_CODEC_ID_MAD,
 241     AV_CODEC_ID_FRWU,
 242     AV_CODEC_ID_FLASHSV2,
 243     AV_CODEC_ID_CDGRAPHICS,
 244     AV_CODEC_ID_R210,
 245     AV_CODEC_ID_ANM,
 246     AV_CODEC_ID_BINKVIDEO,
 247     AV_CODEC_ID_IFF_ILBM,
 248     AV_CODEC_ID_IFF_BYTERUN1,
 249     AV_CODEC_ID_KGV1,
 250     AV_CODEC_ID_YOP,
 251     AV_CODEC_ID_VP8,
 252     AV_CODEC_ID_PICTOR,
 253     AV_CODEC_ID_ANSI,
 254     AV_CODEC_ID_A64_MULTI,
 255     AV_CODEC_ID_A64_MULTI5,
 256     AV_CODEC_ID_R10K,
 257     AV_CODEC_ID_MXPEG,
 258     AV_CODEC_ID_LAGARITH,
 259     AV_CODEC_ID_PRORES,
 260     AV_CODEC_ID_JV,
 261     AV_CODEC_ID_DFA,
 262     AV_CODEC_ID_WMV3IMAGE,
 263     AV_CODEC_ID_VC1IMAGE,
 264     AV_CODEC_ID_UTVIDEO,
 265     AV_CODEC_ID_BMV_VIDEO,
 266     AV_CODEC_ID_VBLE,
 267     AV_CODEC_ID_DXTORY,
 268     AV_CODEC_ID_V410,
 269     AV_CODEC_ID_XWD,
 270     AV_CODEC_ID_CDXL,
 271     AV_CODEC_ID_XBM,
 272     AV_CODEC_ID_ZEROCODEC,
 273     AV_CODEC_ID_MSS1,
 274     AV_CODEC_ID_MSA1,
 275     AV_CODEC_ID_TSCC2,
 276     AV_CODEC_ID_MTS2,
 277     AV_CODEC_ID_CLLC,
 278     AV_CODEC_ID_MSS2,
 279     AV_CODEC_ID_VP9,
 280     AV_CODEC_ID_AIC,
 281     AV_CODEC_ID_ESCAPE130,
 282     AV_CODEC_ID_G2M,
 283     AV_CODEC_ID_WEBP,
 284     AV_CODEC_ID_HNM4_VIDEO,
 285     AV_CODEC_ID_HEVC,
 286     AV_CODEC_ID_FIC,
 287     AV_CODEC_ID_ALIAS_PIX,
 288     AV_CODEC_ID_BRENDER_PIX,
 289     AV_CODEC_ID_PAF_VIDEO,
 290     AV_CODEC_ID_EXR,
 291     AV_CODEC_ID_VP7,
 292     AV_CODEC_ID_SANM,
 293     AV_CODEC_ID_SGIRLE,
 294
 295     /* various PCM "codecs" */
 296     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
 297     AV_CODEC_ID_PCM_S16LE = 0x10000,
 298     AV_CODEC_ID_PCM_S16BE,
 299     AV_CODEC_ID_PCM_U16LE,
 300     AV_CODEC_ID_PCM_U16BE,
 301     AV_CODEC_ID_PCM_S8,
 302     AV_CODEC_ID_PCM_U8,
 303     AV_CODEC_ID_PCM_MULAW,
 304     AV_CODEC_ID_PCM_ALAW,
 305     AV_CODEC_ID_PCM_S32LE,
 306     AV_CODEC_ID_PCM_S32BE,
 307     AV_CODEC_ID_PCM_U32LE,
 308     AV_CODEC_ID_PCM_U32BE,
 309     AV_CODEC_ID_PCM_S24LE,
 310     AV_CODEC_ID_PCM_S24BE,
 311     AV_CODEC_ID_PCM_U24LE,
 312     AV_CODEC_ID_PCM_U24BE,
 313     AV_CODEC_ID_PCM_S24DAUD,
 314     AV_CODEC_ID_PCM_ZORK,
 315     AV_CODEC_ID_PCM_S16LE_PLANAR,
 316     AV_CODEC_ID_PCM_DVD,
 317     AV_CODEC_ID_PCM_F32BE,
 318     AV_CODEC_ID_PCM_F32LE,
 319     AV_CODEC_ID_PCM_F64BE,
 320     AV_CODEC_ID_PCM_F64LE,
 321     AV_CODEC_ID_PCM_BLURAY,
 322     AV_CODEC_ID_PCM_LXF,
 323     AV_CODEC_ID_S302M,
 324     AV_CODEC_ID_PCM_S8_PLANAR,
 325     AV_CODEC_ID_PCM_S24LE_PLANAR,
 326     AV_CODEC_ID_PCM_S32LE_PLANAR,
 327
 328     /* various ADPCM codecs */
 329     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
 330     AV_CODEC_ID_ADPCM_IMA_WAV,
 331     AV_CODEC_ID_ADPCM_IMA_DK3,
 332     AV_CODEC_ID_ADPCM_IMA_DK4,
 333     AV_CODEC_ID_ADPCM_IMA_WS,
 334     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
 335     AV_CODEC_ID_ADPCM_MS,
 336     AV_CODEC_ID_ADPCM_4XM,
 337     AV_CODEC_ID_ADPCM_XA,
 338     AV_CODEC_ID_ADPCM_ADX,
 339     AV_CODEC_ID_ADPCM_EA,
 340     AV_CODEC_ID_ADPCM_G726,
 341     AV_CODEC_ID_ADPCM_CT,
 342     AV_CODEC_ID_ADPCM_SWF,
 343     AV_CODEC_ID_ADPCM_YAMAHA,
 344     AV_CODEC_ID_ADPCM_SBPRO_4,
 345     AV_CODEC_ID_ADPCM_SBPRO_3,
 346     AV_CODEC_ID_ADPCM_SBPRO_2,
 347     AV_CODEC_ID_ADPCM_THP,
 348     AV_CODEC_ID_ADPCM_IMA_AMV,
 349     AV_CODEC_ID_ADPCM_EA_R1,
 350     AV_CODEC_ID_ADPCM_EA_R3,
 351     AV_CODEC_ID_ADPCM_EA_R2,
 352     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
 353     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
 354     AV_CODEC_ID_ADPCM_EA_XAS,
 355     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
 356     AV_CODEC_ID_ADPCM_IMA_ISS,
 357     AV_CODEC_ID_ADPCM_G722,
 358     AV_CODEC_ID_ADPCM_IMA_APC,
 359     AV_CODEC_ID_ADPCM_VIMA,
 360
 361     /* AMR */
 362     AV_CODEC_ID_AMR_NB = 0x12000,
 363     AV_CODEC_ID_AMR_WB,
 364
 365     /* RealAudio codecs*/
 366     AV_CODEC_ID_RA_144 = 0x13000,
 367     AV_CODEC_ID_RA_288,
 368
 369     /* various DPCM codecs */
 370     AV_CODEC_ID_ROQ_DPCM = 0x14000,
 371     AV_CODEC_ID_INTERPLAY_DPCM,
 372     AV_CODEC_ID_XAN_DPCM,
 373     AV_CODEC_ID_SOL_DPCM,
 374
 375     /* audio codecs */
 376     AV_CODEC_ID_MP2 = 0x15000,
 377     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
 378     AV_CODEC_ID_AAC,
 379     AV_CODEC_ID_AC3,
 380     AV_CODEC_ID_DTS,
 381     AV_CODEC_ID_VORBIS,
 382     AV_CODEC_ID_DVAUDIO,
 383     AV_CODEC_ID_WMAV1,
 384     AV_CODEC_ID_WMAV2,
 385     AV_CODEC_ID_MACE3,
 386     AV_CODEC_ID_MACE6,
 387     AV_CODEC_ID_VMDAUDIO,
 388     AV_CODEC_ID_FLAC,
 389     AV_CODEC_ID_MP3ADU,
 390     AV_CODEC_ID_MP3ON4,
 391     AV_CODEC_ID_SHORTEN,
 392     AV_CODEC_ID_ALAC,
 393     AV_CODEC_ID_WESTWOOD_SND1,
 394     AV_CODEC_ID_GSM, ///< as in Berlin toast format
 395     AV_CODEC_ID_QDM2,
 396     AV_CODEC_ID_COOK,
 397     AV_CODEC_ID_TRUESPEECH,
 398     AV_CODEC_ID_TTA,
 399     AV_CODEC_ID_SMACKAUDIO,
 400     AV_CODEC_ID_QCELP,
 401     AV_CODEC_ID_WAVPACK,
 402     AV_CODEC_ID_DSICINAUDIO,
 403     AV_CODEC_ID_IMC,
 404     AV_CODEC_ID_MUSEPACK7,
 405     AV_CODEC_ID_MLP,
 406     AV_CODEC_ID_GSM_MS, /* as found in WAV */
 407     AV_CODEC_ID_ATRAC3,
 408 #if FF_API_VOXWARE
 409     AV_CODEC_ID_VOXWARE,
 410 #endif
 411     AV_CODEC_ID_APE,
 412     AV_CODEC_ID_NELLYMOSER,
 413     AV_CODEC_ID_MUSEPACK8,
 414     AV_CODEC_ID_SPEEX,
 415     AV_CODEC_ID_WMAVOICE,
 416     AV_CODEC_ID_WMAPRO,
 417     AV_CODEC_ID_WMALOSSLESS,
 418     AV_CODEC_ID_ATRAC3P,
 419     AV_CODEC_ID_EAC3,
 420     AV_CODEC_ID_SIPR,
 421     AV_CODEC_ID_MP1,
 422     AV_CODEC_ID_TWINVQ,
 423     AV_CODEC_ID_TRUEHD,
 424     AV_CODEC_ID_MP4ALS,
 425     AV_CODEC_ID_ATRAC1,
 426     AV_CODEC_ID_BINKAUDIO_RDFT,
 427     AV_CODEC_ID_BINKAUDIO_DCT,
 428     AV_CODEC_ID_AAC_LATM,
 429     AV_CODEC_ID_QDMC,
 430     AV_CODEC_ID_CELT,
 431     AV_CODEC_ID_G723_1,
 432     AV_CODEC_ID_G729,
 433     AV_CODEC_ID_8SVX_EXP,
 434     AV_CODEC_ID_8SVX_FIB,
 435     AV_CODEC_ID_BMV_AUDIO,
 436     AV_CODEC_ID_RALF,
 437     AV_CODEC_ID_IAC,
 438     AV_CODEC_ID_ILBC,
 439     AV_CODEC_ID_OPUS,
 440     AV_CODEC_ID_COMFORT_NOISE,
 441     AV_CODEC_ID_TAK,
 442     AV_CODEC_ID_METASOUND,
 443     AV_CODEC_ID_PAF_AUDIO,
 444
 445     /* subtitle codecs */
 446     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
 447     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
 448     AV_CODEC_ID_DVB_SUBTITLE,
 449     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
 450     AV_CODEC_ID_XSUB,
 451     AV_CODEC_ID_SSA,
 452     AV_CODEC_ID_MOV_TEXT,
 453     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
 454     AV_CODEC_ID_DVB_TELETEXT,
 455     AV_CODEC_ID_SRT,
 456
 457     /* other specific kind of codecs (generally used for attachments) */
 458     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
 459     AV_CODEC_ID_TTF = 0x18000,
 460
 461     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
 462
 463     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 464                                 * stream (only used by libavformat) */
 465     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
 466                                 * stream (only used by libavformat) */
 467     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
 468 };
 469
 470 /**
 471  * This struct describes the properties of a single codec described by an
 472  * AVCodecID.
 473  * @see avcodec_get_descriptor()
 474  */
 475 typedef struct AVCodecDescriptor {
 476     enum AVCodecID     id;
 477     enum AVMediaType type;
 478     /**
 479      * Name of the codec described by this descriptor. It is non-empty and
 480      * unique for each codec descriptor. It should contain alphanumeric
 481      * characters and '_' only.
 482      */
 483     const char      *name;
 484     /**
 485      * A more descriptive name for this codec. May be NULL.
 486      */
 487     const char *long_name;
 488     /**
 489      * Codec properties, a combination of AV_CODEC_PROP_* flags.
 490      */
 491     int             props;
 492 } AVCodecDescriptor;
 493
 494 /**
 495  * Codec uses only intra compression.
 496  * Video codecs only.
 497  */
 498 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
 499 /**
 500  * Codec supports lossy compression. Audio and video codecs only.
 501  * @note a codec may support both lossy and lossless
 502  * compression modes
 503  */
 504 #define AV_CODEC_PROP_LOSSY         (1 << 1)
 505 /**
 506  * Codec supports lossless compression. Audio and video codecs only.
 507  */
 508 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
 509
 510 /**
 511  * @ingroup lavc_decoding
 512  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 513  * This is mainly needed because some optimized bitstream readers read
 514  * 32 or 64 bit at once and could read over the end.<br>
 515  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 516  * MPEG bitstreams could cause overread and segfault.
 517  */
 518 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 519
 520 /**
 521  * @ingroup lavc_encoding
 522  * minimum encoding buffer size
 523  * Used to avoid some checks during header writing.
 524  */
 525 #define FF_MIN_BUFFER_SIZE 16384
 526
 527
 528 /**
 529  * @ingroup lavc_encoding
 530  * motion estimation type.
 531  */
 532 enum Motion_Est_ID {
 533     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 534     ME_FULL,
 535     ME_LOG,
 536     ME_PHODS,
 537     ME_EPZS,        ///< enhanced predictive zonal search
 538     ME_X1,          ///< reserved for experiments
 539     ME_HEX,         ///< hexagon based search
 540     ME_UMH,         ///< uneven multi-hexagon search
 541     ME_TESA,        ///< transformed exhaustive search algorithm
 542 };
 543
 544 /**
 545  * @ingroup lavc_decoding
 546  */
 547 enum AVDiscard{
 548     /* We leave some space between them for extensions (drop some
 549      * keyframes for intra-only or drop just some bidir frames). */
 550     AVDISCARD_NONE    =-16, ///< discard nothing
 551     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
 552     AVDISCARD_NONREF  =  8, ///< discard all non reference
 553     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
 554     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
 555     AVDISCARD_ALL     = 48, ///< discard all
 556 };
 557
 558 enum AVColorPrimaries{
 559     AVCOL_PRI_BT709       = 1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
 560     AVCOL_PRI_UNSPECIFIED = 2,
 561     AVCOL_PRI_BT470M      = 4,
 562     AVCOL_PRI_BT470BG     = 5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
 563     AVCOL_PRI_SMPTE170M   = 6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
 564     AVCOL_PRI_SMPTE240M   = 7, ///< functionally identical to above
 565     AVCOL_PRI_FILM        = 8,
 566     AVCOL_PRI_BT2020      = 9, ///< ITU-R BT2020
 567     AVCOL_PRI_NB             , ///< Not part of ABI
 568 };
 569
 570 enum AVColorTransferCharacteristic{
 571     AVCOL_TRC_BT709        =  1, ///< also ITU-R BT1361
 572     AVCOL_TRC_UNSPECIFIED  =  2,
 573     AVCOL_TRC_GAMMA22      =  4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
 574     AVCOL_TRC_GAMMA28      =  5, ///< also ITU-R BT470BG
 575     AVCOL_TRC_SMPTE170M    =  6, ///< also ITU-R BT601-6 525 or 625 / ITU-R BT1358 525 or 625 / ITU-R BT1700 NTSC
 576     AVCOL_TRC_SMPTE240M    =  7,
 577     AVCOL_TRC_LINEAR       =  8, ///< "Linear transfer characteristics"
 578     AVCOL_TRC_LOG          =  9, ///< "Logarithmic transfer characteristic (100:1 range)"
 579     AVCOL_TRC_LOG_SQRT     = 10, ///< "Logarithmic transfer characteristic (100 * Sqrt( 10 ) : 1 range)"
 580     AVCOL_TRC_IEC61966_2_4 = 11, ///< IEC 61966-2-4
 581     AVCOL_TRC_BT1361_ECG   = 12, ///< ITU-R BT1361 Extended Colour Gamut
 582     AVCOL_TRC_IEC61966_2_1 = 13, ///< IEC 61966-2-1 (sRGB or sYCC)
 583     AVCOL_TRC_BT2020_10    = 14, ///< ITU-R BT2020 for 10 bit system
 584     AVCOL_TRC_BT2020_12    = 15, ///< ITU-R BT2020 for 12 bit system
 585     AVCOL_TRC_NB               , ///< Not part of ABI
 586 };
 587
 588 enum AVColorSpace{
 589     AVCOL_SPC_RGB         =  0,
 590     AVCOL_SPC_BT709       =  1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
 591     AVCOL_SPC_UNSPECIFIED =  2,
 592     AVCOL_SPC_FCC         =  4,
 593     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
 594     AVCOL_SPC_SMPTE170M   =  6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
 595     AVCOL_SPC_SMPTE240M   =  7,
 596     AVCOL_SPC_YCOCG       =  8, ///< Used by Dirac / VC-2 and H.264 FRext, see ITU-T SG16
 597     AVCOL_SPC_BT2020_NCL  =  9, ///< ITU-R BT2020 non-constant luminance system
 598     AVCOL_SPC_BT2020_CL   = 10, ///< ITU-R BT2020 constant luminance system
 599     AVCOL_SPC_NB              , ///< Not part of ABI
 600 };
 601
 602 enum AVColorRange{
 603     AVCOL_RANGE_UNSPECIFIED = 0,
 604     AVCOL_RANGE_MPEG        = 1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
 605     AVCOL_RANGE_JPEG        = 2, ///< the normal     2^n-1   "JPEG" YUV ranges
 606     AVCOL_RANGE_NB             , ///< Not part of ABI
 607 };
 608
 609 /**
 610  *  X   X      3 4 X      X are luma samples,
 611  *             1 2        1-6 are possible chroma positions
 612  *  X   X      5 6 X      0 is undefined/unknown position
 613  */
 614 enum AVChromaLocation{
 615     AVCHROMA_LOC_UNSPECIFIED = 0,
 616     AVCHROMA_LOC_LEFT        = 1, ///< mpeg2/4, h264 default
 617     AVCHROMA_LOC_CENTER      = 2, ///< mpeg1, jpeg, h263
 618     AVCHROMA_LOC_TOPLEFT     = 3, ///< DV
 619     AVCHROMA_LOC_TOP         = 4,
 620     AVCHROMA_LOC_BOTTOMLEFT  = 5,
 621     AVCHROMA_LOC_BOTTOM      = 6,
 622     AVCHROMA_LOC_NB             , ///< Not part of ABI
 623 };
 624
 625 enum AVAudioServiceType {
 626     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
 627     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
 628     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
 629     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
 630     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
 631     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
 632     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
 633     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
 634     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
 635     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
 636 };
 637
 638 /**
 639  * @ingroup lavc_encoding
 640  */
 641 typedef struct RcOverride{
 642     int start_frame;
 643     int end_frame;
 644     int qscale; // If this is 0 then quality_factor will be used instead.
 645     float quality_factor;
 646 } RcOverride;
 647
 648 #if FF_API_MAX_BFRAMES
 649 /**
 650  * @deprecated there is no libavcodec-wide limit on the number of B-frames
 651  */
 652 #define FF_MAX_B_FRAMES 16
 653 #endif
 654
 655 /* encoding support
 656    These flags can be passed in AVCodecContext.flags before initialization.
 657    Note: Not everything is supported yet.
 658 */
 659
 660 /**
 661  * Allow decoders to produce frames with data planes that are not aligned
 662  * to CPU requirements (e.g. due to cropping).
 663  */
 664 #define CODEC_FLAG_UNALIGNED 0x0001
 665 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 666 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 667 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
 668 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 669 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 670 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 671 /**
 672  * The parent program guarantees that the input for B-frames containing
 673  * streams is not written to for at least s->max_b_frames+1 frames, if
 674  * this is not set the input will be copied.
 675  */
 676 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 677 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 678 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 679 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 680 #if FF_API_EMU_EDGE
 681 /**
 682  * @deprecated edges are not used/required anymore. I.e. this flag is now always
 683  * set.
 684  */
 685 #define CODEC_FLAG_EMU_EDGE        0x4000
 686 #endif
 687 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 688 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 689                                                   location instead of only at frame boundaries. */
 690 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 691 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 692 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 693 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 694 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 695 /* Fx : Flag for h263+ extra options */
 696 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 697 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 698 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 699 #define CODEC_FLAG_CLOSED_GOP     0x80000000
 700 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 701 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 702 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 703 #define CODEC_FLAG2_IGNORE_CROP   0x00010000 ///< Discard cropping information from SPS.
 704
 705 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 706
 707 /* Unsupported options :
 708  *              Syntax Arithmetic coding (SAC)
 709  *              Reference Picture Selection
 710  *              Independent Segment Decoding */
 711 /* /Fx */
 712 /* codec capabilities */
 713
 714 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
 715 /**
 716  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
 717  * If not set, it might not use get_buffer() at all or use operations that
 718  * assume the buffer was allocated by avcodec_default_get_buffer.
 719  */
 720 #define CODEC_CAP_DR1             0x0002
 721 #define CODEC_CAP_TRUNCATED       0x0008
 722 #if FF_API_XVMC
 723 /* Codec can export data for HW decoding (XvMC). */
 724 #define CODEC_CAP_HWACCEL         0x0010
 725 #endif /* FF_API_XVMC */
 726 /**
 727  * Encoder or decoder requires flushing with NULL input at the end in order to
 728  * give the complete and correct output.
 729  *
 730  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
 731  *       with NULL data. The user can still send NULL data to the public encode
 732  *       or decode function, but libavcodec will not pass it along to the codec
 733  *       unless this flag is set.
 734  *
 735  * Decoders:
 736  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
 737  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
 738  * returns frames.
 739  *
 740  * Encoders:
 741  * The encoder needs to be fed with NULL data at the end of encoding until the
 742  * encoder no longer returns data.
 743  *
 744  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
 745  *       flag also means that the encoder must set the pts and duration for
 746  *       each output packet. If this flag is not set, the pts and duration will
 747  *       be determined by libavcodec from the input frame.
 748  */
 749 #define CODEC_CAP_DELAY           0x0020
 750 /**
 751  * Codec can be fed a final frame with a smaller size.
 752  * This can be used to prevent truncation of the last audio samples.
 753  */
 754 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
 755 #if FF_API_CAP_VDPAU
 756 /**
 757  * Codec can export data for HW decoding (VDPAU).
 758  */
 759 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
 760 #endif
 761 /**
 762  * Codec can output multiple frames per AVPacket
 763  * Normally demuxers return one frame at a time, demuxers which do not do
 764  * are connected to a parser to split what they return into proper frames.
 765  * This flag is reserved to the very rare category of codecs which have a
 766  * bitstream that cannot be split into frames without timeconsuming
 767  * operations like full decoding. Demuxers carring such bitstreams thus
 768  * may return multiple frames in a packet. This has many disadvantages like
 769  * prohibiting stream copy in many cases thus it should only be considered
 770  * as a last resort.
 771  */
 772 #define CODEC_CAP_SUBFRAMES        0x0100
 773 /**
 774  * Codec is experimental and is thus avoided in favor of non experimental
 775  * encoders
 776  */
 777 #define CODEC_CAP_EXPERIMENTAL     0x0200
 778 /**
 779  * Codec should fill in channel configuration and samplerate instead of container
 780  */
 781 #define CODEC_CAP_CHANNEL_CONF     0x0400
 782 #if FF_API_NEG_LINESIZES
 783 /**
 784  * @deprecated no codecs use this capability
 785  */
 786 #define CODEC_CAP_NEG_LINESIZES    0x0800
 787 #endif
 788 /**
 789  * Codec supports frame-level multithreading.
 790  */
 791 #define CODEC_CAP_FRAME_THREADS    0x1000
 792 /**
 793  * Codec supports slice-based (or partition-based) multithreading.
 794  */
 795 #define CODEC_CAP_SLICE_THREADS    0x2000
 796 /**
 797  * Codec supports changed parameters at any point.
 798  */
 799 #define CODEC_CAP_PARAM_CHANGE     0x4000
 800 /**
 801  * Codec supports avctx->thread_count == 0 (auto).
 802  */
 803 #define CODEC_CAP_AUTO_THREADS     0x8000
 804 /**
 805  * Audio encoder supports receiving a different number of samples in each call.
 806  */
 807 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
 808
 809 #if FF_API_MB_TYPE
 810 //The following defines may change, don't expect compatibility if you use them.
 811 #define MB_TYPE_INTRA4x4   0x0001
 812 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 813 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
 814 #define MB_TYPE_16x16      0x0008
 815 #define MB_TYPE_16x8       0x0010
 816 #define MB_TYPE_8x16       0x0020
 817 #define MB_TYPE_8x8        0x0040
 818 #define MB_TYPE_INTERLACED 0x0080
 819 #define MB_TYPE_DIRECT2    0x0100 //FIXME
 820 #define MB_TYPE_ACPRED     0x0200
 821 #define MB_TYPE_GMC        0x0400
 822 #define MB_TYPE_SKIP       0x0800
 823 #define MB_TYPE_P0L0       0x1000
 824 #define MB_TYPE_P1L0       0x2000
 825 #define MB_TYPE_P0L1       0x4000
 826 #define MB_TYPE_P1L1       0x8000
 827 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 828 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 829 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 830 #define MB_TYPE_QUANT      0x00010000
 831 #define MB_TYPE_CBP        0x00020000
 832 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 833 #endif
 834
 835 /**
 836  * Pan Scan area.
 837  * This specifies the area which should be displayed.
 838  * Note there may be multiple such areas for one frame.
 839  */
 840 typedef struct AVPanScan{
 841     /**
 842      * id
 843      * - encoding: Set by user.
 844      * - decoding: Set by libavcodec.
 845      */
 846     int id;
 847
 848     /**
 849      * width and height in 1/16 pel
 850      * - encoding: Set by user.
 851      * - decoding: Set by libavcodec.
 852      */
 853     int width;
 854     int height;
 855
 856     /**
 857      * position of the top left corner in 1/16 pel for up to 3 fields/frames
 858      * - encoding: Set by user.
 859      * - decoding: Set by libavcodec.
 860      */
 861     int16_t position[3][2];
 862 }AVPanScan;
 863
 864 #if FF_API_QSCALE_TYPE
 865 #define FF_QSCALE_TYPE_MPEG1 0
 866 #define FF_QSCALE_TYPE_MPEG2 1
 867 #define FF_QSCALE_TYPE_H264  2
 868 #define FF_QSCALE_TYPE_VP56  3
 869 #endif
 870
 871 #if FF_API_GET_BUFFER
 872 #define FF_BUFFER_TYPE_INTERNAL 1
 873 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 874 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 875 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
 876
 877 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 878 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 879 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 880 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
 881 #endif
 882
 883 /**
 884  * The decoder will keep a reference to the frame and may reuse it later.
 885  */
 886 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
 887
 888 /**
 889  * @defgroup lavc_packet AVPacket
 890  *
 891  * Types and functions for working with AVPacket.
 892  * @{
 893  */
 894 enum AVPacketSideDataType {
 895     AV_PKT_DATA_PALETTE,
 896     AV_PKT_DATA_NEW_EXTRADATA,
 897
 898     /**
 899      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
 900      * @code
 901      * u32le param_flags
 902      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
 903      *     s32le channel_count
 904      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
 905      *     u64le channel_layout
 906      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
 907      *     s32le sample_rate
 908      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
 909      *     s32le width
 910      *     s32le height
 911      * @endcode
 912      */
 913     AV_PKT_DATA_PARAM_CHANGE,
 914
 915     /**
 916      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
 917      * structures with info about macroblocks relevant to splitting the
 918      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
 919      * That is, it does not necessarily contain info about all macroblocks,
 920      * as long as the distance between macroblocks in the info is smaller
 921      * than the target payload size.
 922      * Each MB info structure is 12 bytes, and is laid out as follows:
 923      * @code
 924      * u32le bit offset from the start of the packet
 925      * u8    current quantizer at the start of the macroblock
 926      * u8    GOB number
 927      * u16le macroblock address within the GOB
 928      * u8    horizontal MV predictor
 929      * u8    vertical MV predictor
 930      * u8    horizontal MV predictor for block number 3
 931      * u8    vertical MV predictor for block number 3
 932      * @endcode
 933      */
 934     AV_PKT_DATA_H263_MB_INFO,
 935
 936     /**
 937      * This side data should be associated with an audio stream and contains
 938      * ReplayGain information in form of the AVReplayGain struct.
 939      */
 940     AV_PKT_DATA_REPLAYGAIN,
 941 };
 942
 943 typedef struct AVPacketSideData {
 944     uint8_t *data;
 945     int      size;
 946     enum AVPacketSideDataType type;
 947 } AVPacketSideData;
 948
 949 /**
 950  * This structure stores compressed data. It is typically exported by demuxers
 951  * and then passed as input to decoders, or received as output from encoders and
 952  * then passed to muxers.
 953  *
 954  * For video, it should typically contain one compressed frame. For audio it may
 955  * contain several compressed frames.
 956  *
 957  * AVPacket is one of the few structs in Libav, whose size is a part of public
 958  * ABI. Thus it may be allocated on stack and no new fields can be added to it
 959  * without libavcodec and libavformat major bump.
 960  *
 961  * The semantics of data ownership depends on the buf or destruct (deprecated)
 962  * fields. If either is set, the packet data is dynamically allocated and is
 963  * valid indefinitely until av_free_packet() is called (which in turn calls
 964  * av_buffer_unref()/the destruct callback to free the data). If neither is set,
 965  * the packet data is typically backed by some static buffer somewhere and is
 966  * only valid for a limited time (e.g. until the next read call when demuxing).
 967  *
 968  * The side data is always allocated with av_malloc() and is freed in
 969  * av_free_packet().
 970  */
 971 typedef struct AVPacket {
 972     /**
 973      * A reference to the reference-counted buffer where the packet data is
 974      * stored.
 975      * May be NULL, then the packet data is not reference-counted.
 976      */
 977     AVBufferRef *buf;
 978     /**
 979      * Presentation timestamp in AVStream->time_base units; the time at which
 980      * the decompressed packet will be presented to the user.
 981      * Can be AV_NOPTS_VALUE if it is not stored in the file.
 982      * pts MUST be larger or equal to dts as presentation cannot happen before
 983      * decompression, unless one wants to view hex dumps. Some formats misuse
 984      * the terms dts and pts/cts to mean something different. Such timestamps
 985      * must be converted to true pts/dts before they are stored in AVPacket.
 986      */
 987     int64_t pts;
 988     /**
 989      * Decompression timestamp in AVStream->time_base units; the time at which
 990      * the packet is decompressed.
 991      * Can be AV_NOPTS_VALUE if it is not stored in the file.
 992      */
 993     int64_t dts;
 994     uint8_t *data;
 995     int   size;
 996     int   stream_index;
 997     /**
 998      * A combination of AV_PKT_FLAG values
 999      */
1000     int   flags;
1001     /**
1002      * Additional packet data that can be provided by the container.
1003      * Packet can contain several types of side information.
1004      */
1005     AVPacketSideData *side_data;
1006     int side_data_elems;
1007
1008     /**
1009      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1010      * Equals next_pts - this_pts in presentation order.
1011      */
1012     int   duration;
1013 #if FF_API_DESTRUCT_PACKET
1014     attribute_deprecated
1015     void  (*destruct)(struct AVPacket *);
1016     attribute_deprecated
1017     void  *priv;
1018 #endif
1019     int64_t pos;                            ///< byte position in stream, -1 if unknown
1020
1021     /**
1022      * Time difference in AVStream->time_base units from the pts of this
1023      * packet to the point at which the output from the decoder has converged
1024      * independent from the availability of previous frames. That is, the
1025      * frames are virtually identical no matter if decoding started from
1026      * the very first frame or from this keyframe.
1027      * Is AV_NOPTS_VALUE if unknown.
1028      * This field is not the display duration of the current packet.
1029      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
1030      * set.
1031      *
1032      * The purpose of this field is to allow seeking in streams that have no
1033      * keyframes in the conventional sense. It corresponds to the
1034      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
1035      * essential for some types of subtitle streams to ensure that all
1036      * subtitles are correctly displayed after seeking.
1037      */
1038     int64_t convergence_duration;
1039 } AVPacket;
1040 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1041 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1042
1043 enum AVSideDataParamChangeFlags {
1044     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1045     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1046     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1047     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1048 };
1049 /**
1050  * @}
1051  */
1052
1053 struct AVCodecInternal;
1054
1055 enum AVFieldOrder {
1056     AV_FIELD_UNKNOWN,
1057     AV_FIELD_PROGRESSIVE,
1058     AV_FIELD_TT,          //< Top coded_first, top displayed first
1059     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1060     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1061     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1062 };
1063
1064 /**
1065  * main external API structure.
1066  * New fields can be added to the end with minor version bumps.
1067  * Removal, reordering and changes to existing fields require a major
1068  * version bump.
1069  * sizeof(AVCodecContext) must not be used outside libav*.
1070  */
1071 typedef struct AVCodecContext {
1072     /**
1073      * information on struct for av_log
1074      * - set by avcodec_alloc_context3
1075      */
1076     const AVClass *av_class;
1077     int log_level_offset;
1078
1079     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1080     const struct AVCodec  *codec;
1081     char             codec_name[32];
1082     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1083
1084     /**
1085      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1086      * This is used to work around some encoder bugs.
1087      * A demuxer should set this to what is stored in the field used to identify the codec.
1088      * If there are multiple such fields in a container then the demuxer should choose the one
1089      * which maximizes the information about the used codec.
1090      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1091      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1092      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1093      * first.
1094      * - encoding: Set by user, if not then the default based on codec_id will be used.
1095      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1096      */
1097     unsigned int codec_tag;
1098
1099     /**
1100      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1101      * This is used to work around some encoder bugs.
1102      * - encoding: unused
1103      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1104      */
1105     unsigned int stream_codec_tag;
1106
1107     void *priv_data;
1108
1109     /**
1110      * Private context used for internal data.
1111      *
1112      * Unlike priv_data, this is not codec-specific. It is used in general
1113      * libavcodec functions.
1114      */
1115     struct AVCodecInternal *internal;
1116
1117     /**
1118      * Private data of the user, can be used to carry app specific stuff.
1119      * - encoding: Set by user.
1120      * - decoding: Set by user.
1121      */
1122     void *opaque;
1123
1124     /**
1125      * the average bitrate
1126      * - encoding: Set by user; unused for constant quantizer encoding.
1127      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1128      */
1129     int bit_rate;
1130
1131     /**
1132      * number of bits the bitstream is allowed to diverge from the reference.
1133      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1134      * - encoding: Set by user; unused for constant quantizer encoding.
1135      * - decoding: unused
1136      */
1137     int bit_rate_tolerance;
1138
1139     /**
1140      * Global quality for codecs which cannot change it per frame.
1141      * This should be proportional to MPEG-1/2/4 qscale.
1142      * - encoding: Set by user.
1143      * - decoding: unused
1144      */
1145     int global_quality;
1146
1147     /**
1148      * - encoding: Set by user.
1149      * - decoding: unused
1150      */
1151     int compression_level;
1152 #define FF_COMPRESSION_DEFAULT -1
1153
1154     /**
1155      * CODEC_FLAG_*.
1156      * - encoding: Set by user.
1157      * - decoding: Set by user.
1158      */
1159     int flags;
1160
1161     /**
1162      * CODEC_FLAG2_*
1163      * - encoding: Set by user.
1164      * - decoding: Set by user.
1165      */
1166     int flags2;
1167
1168     /**
1169      * some codecs need / can use extradata like Huffman tables.
1170      * mjpeg: Huffman tables
1171      * rv10: additional flags
1172      * mpeg4: global headers (they can be in the bitstream or here)
1173      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1174      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1175      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1176      * - encoding: Set/allocated/freed by libavcodec.
1177      * - decoding: Set/allocated/freed by user.
1178      */
1179     uint8_t *extradata;
1180     int extradata_size;
1181
1182     /**
1183      * This is the fundamental unit of time (in seconds) in terms
1184      * of which frame timestamps are represented. For fixed-fps content,
1185      * timebase should be 1/framerate and timestamp increments should be
1186      * identically 1.
1187      * - encoding: MUST be set by user.
1188      * - decoding: Set by libavcodec.
1189      */
1190     AVRational time_base;
1191
1192     /**
1193      * For some codecs, the time base is closer to the field rate than the frame rate.
1194      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1195      * if no telecine is used ...
1196      *
1197      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1198      */
1199     int ticks_per_frame;
1200
1201     /**
1202      * Codec delay.
1203      *
1204      * Video:
1205      *   Number of frames the decoded output will be delayed relative to the
1206      *   encoded input.
1207      *
1208      * Audio:
1209      *   For encoding, this is the number of "priming" samples added to the
1210      *   beginning of the stream. The decoded output will be delayed by this
1211      *   many samples relative to the input to the encoder. Note that this
1212      *   field is purely informational and does not directly affect the pts
1213      *   output by the encoder, which should always be based on the actual
1214      *   presentation time, including any delay.
1215      *   For decoding, this is the number of samples the decoder needs to
1216      *   output before the decoder's output is valid. When seeking, you should
1217      *   start decoding this many samples prior to your desired seek point.
1218      *
1219      * - encoding: Set by libavcodec.
1220      * - decoding: Set by libavcodec.
1221      */
1222     int delay;
1223
1224
1225     /* video only */
1226     /**
1227      * picture width / height.
1228      * - encoding: MUST be set by user.
1229      * - decoding: May be set by the user before opening the decoder if known e.g.
1230      *             from the container. Some decoders will require the dimensions
1231      *             to be set by the caller. During decoding, the decoder may
1232      *             overwrite those values as required.
1233      */
1234     int width, height;
1235
1236     /**
1237      * Bitstream width / height, may be different from width/height e.g. when
1238      * the decoded frame is cropped before being output.
1239      * - encoding: unused
1240      * - decoding: May be set by the user before opening the decoder if known
1241      *             e.g. from the container. During decoding, the decoder may
1242      *             overwrite those values as required.
1243      */
1244     int coded_width, coded_height;
1245
1246 #if FF_API_ASPECT_EXTENDED
1247 #define FF_ASPECT_EXTENDED 15
1248 #endif
1249
1250     /**
1251      * the number of pictures in a group of pictures, or 0 for intra_only
1252      * - encoding: Set by user.
1253      * - decoding: unused
1254      */
1255     int gop_size;
1256
1257     /**
1258      * Pixel format, see AV_PIX_FMT_xxx.
1259      * May be set by the demuxer if known from headers.
1260      * May be overriden by the decoder if it knows better.
1261      * - encoding: Set by user.
1262      * - decoding: Set by user if known, overridden by libavcodec if known
1263      */
1264     enum AVPixelFormat pix_fmt;
1265
1266     /**
1267      * Motion estimation algorithm used for video coding.
1268      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1269      * 8 (umh), 10 (tesa) [7, 8, 10 are x264 specific]
1270      * - encoding: MUST be set by user.
1271      * - decoding: unused
1272      */
1273     int me_method;
1274
1275     /**
1276      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1277      * decoder to draw a horizontal band. It improves cache usage. Not
1278      * all codecs can do that. You must check the codec capabilities
1279      * beforehand.
1280      * When multithreading is used, it may be called from multiple threads
1281      * at the same time; threads might draw different parts of the same AVFrame,
1282      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1283      * in order.
1284      * The function is also used by hardware acceleration APIs.
1285      * It is called at least once during frame decoding to pass
1286      * the data needed for hardware render.
1287      * In that mode instead of pixel data, AVFrame points to
1288      * a structure specific to the acceleration API. The application
1289      * reads the structure and can change some fields to indicate progress
1290      * or mark state.
1291      * - encoding: unused
1292      * - decoding: Set by user.
1293      * @param height the height of the slice
1294      * @param y the y position of the slice
1295      * @param type 1->top field, 2->bottom field, 3->frame
1296      * @param offset offset into the AVFrame.data from which the slice should be read
1297      */
1298     void (*draw_horiz_band)(struct AVCodecContext *s,
1299                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1300                             int y, int type, int height);
1301
1302     /**
1303      * callback to negotiate the pixelFormat
1304      * @param fmt is the list of formats which are supported by the codec,
1305      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1306      * The first is always the native one.
1307      * @return the chosen format
1308      * - encoding: unused
1309      * - decoding: Set by user, if not set the native format will be chosen.
1310      */
1311     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1312
1313     /**
1314      * maximum number of B-frames between non-B-frames
1315      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1316      * - encoding: Set by user.
1317      * - decoding: unused
1318      */
1319     int max_b_frames;
1320
1321     /**
1322      * qscale factor between IP and B-frames
1323      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1324      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1325      * - encoding: Set by user.
1326      * - decoding: unused
1327      */
1328     float b_quant_factor;
1329
1330     /** obsolete FIXME remove */
1331     int rc_strategy;
1332 #define FF_RC_STRATEGY_XVID 1
1333
1334     int b_frame_strategy;
1335
1336     /**
1337      * qscale offset between IP and B-frames
1338      * - encoding: Set by user.
1339      * - decoding: unused
1340      */
1341     float b_quant_offset;
1342
1343     /**
1344      * Size of the frame reordering buffer in the decoder.
1345      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1346      * - encoding: Set by libavcodec.
1347      * - decoding: Set by libavcodec.
1348      */
1349     int has_b_frames;
1350
1351     /**
1352      * 0-> h263 quant 1-> mpeg quant
1353      * - encoding: Set by user.
1354      * - decoding: unused
1355      */
1356     int mpeg_quant;
1357
1358     /**
1359      * qscale factor between P and I-frames
1360      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1361      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1362      * - encoding: Set by user.
1363      * - decoding: unused
1364      */
1365     float i_quant_factor;
1366
1367     /**
1368      * qscale offset between P and I-frames
1369      * - encoding: Set by user.
1370      * - decoding: unused
1371      */
1372     float i_quant_offset;
1373
1374     /**
1375      * luminance masking (0-> disabled)
1376      * - encoding: Set by user.
1377      * - decoding: unused
1378      */
1379     float lumi_masking;
1380
1381     /**
1382      * temporary complexity masking (0-> disabled)
1383      * - encoding: Set by user.
1384      * - decoding: unused
1385      */
1386     float temporal_cplx_masking;
1387
1388     /**
1389      * spatial complexity masking (0-> disabled)
1390      * - encoding: Set by user.
1391      * - decoding: unused
1392      */
1393     float spatial_cplx_masking;
1394
1395     /**
1396      * p block masking (0-> disabled)
1397      * - encoding: Set by user.
1398      * - decoding: unused
1399      */
1400     float p_masking;
1401
1402     /**
1403      * darkness masking (0-> disabled)
1404      * - encoding: Set by user.
1405      * - decoding: unused
1406      */
1407     float dark_masking;
1408
1409     /**
1410      * slice count
1411      * - encoding: Set by libavcodec.
1412      * - decoding: Set by user (or 0).
1413      */
1414     int slice_count;
1415     /**
1416      * prediction method (needed for huffyuv)
1417      * - encoding: Set by user.
1418      * - decoding: unused
1419      */
1420      int prediction_method;
1421 #define FF_PRED_LEFT   0
1422 #define FF_PRED_PLANE  1
1423 #define FF_PRED_MEDIAN 2
1424
1425     /**
1426      * slice offsets in the frame in bytes
1427      * - encoding: Set/allocated by libavcodec.
1428      * - decoding: Set/allocated by user (or NULL).
1429      */
1430     int *slice_offset;
1431
1432     /**
1433      * sample aspect ratio (0 if unknown)
1434      * That is the width of a pixel divided by the height of the pixel.
1435      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1436      * - encoding: Set by user.
1437      * - decoding: Set by libavcodec.
1438      */
1439     AVRational sample_aspect_ratio;
1440
1441     /**
1442      * motion estimation comparison function
1443      * - encoding: Set by user.
1444      * - decoding: unused
1445      */
1446     int me_cmp;
1447     /**
1448      * subpixel motion estimation comparison function
1449      * - encoding: Set by user.
1450      * - decoding: unused
1451      */
1452     int me_sub_cmp;
1453     /**
1454      * macroblock comparison function (not supported yet)
1455      * - encoding: Set by user.
1456      * - decoding: unused
1457      */
1458     int mb_cmp;
1459     /**
1460      * interlaced DCT comparison function
1461      * - encoding: Set by user.
1462      * - decoding: unused
1463      */
1464     int ildct_cmp;
1465 #define FF_CMP_SAD    0
1466 #define FF_CMP_SSE    1
1467 #define FF_CMP_SATD   2
1468 #define FF_CMP_DCT    3
1469 #define FF_CMP_PSNR   4
1470 #define FF_CMP_BIT    5
1471 #define FF_CMP_RD     6
1472 #define FF_CMP_ZERO   7
1473 #define FF_CMP_VSAD   8
1474 #define FF_CMP_VSSE   9
1475 #define FF_CMP_NSSE   10
1476 #define FF_CMP_DCTMAX 13
1477 #define FF_CMP_DCT264 14
1478 #define FF_CMP_CHROMA 256
1479
1480     /**
1481      * ME diamond size & shape
1482      * - encoding: Set by user.
1483      * - decoding: unused
1484      */
1485     int dia_size;
1486
1487     /**
1488      * amount of previous MV predictors (2a+1 x 2a+1 square)
1489      * - encoding: Set by user.
1490      * - decoding: unused
1491      */
1492     int last_predictor_count;
1493
1494     /**
1495      * prepass for motion estimation
1496      * - encoding: Set by user.
1497      * - decoding: unused
1498      */
1499     int pre_me;
1500
1501     /**
1502      * motion estimation prepass comparison function
1503      * - encoding: Set by user.
1504      * - decoding: unused
1505      */
1506     int me_pre_cmp;
1507
1508     /**
1509      * ME prepass diamond size & shape
1510      * - encoding: Set by user.
1511      * - decoding: unused
1512      */
1513     int pre_dia_size;
1514
1515     /**
1516      * subpel ME quality
1517      * - encoding: Set by user.
1518      * - decoding: unused
1519      */
1520     int me_subpel_quality;
1521
1522     /**
1523      * DTG active format information (additional aspect ratio
1524      * information only used in DVB MPEG-2 transport streams)
1525      * 0 if not set.
1526      *
1527      * - encoding: unused
1528      * - decoding: Set by decoder.
1529      */
1530     int dtg_active_format;
1531 #define FF_DTG_AFD_SAME         8
1532 #define FF_DTG_AFD_4_3          9
1533 #define FF_DTG_AFD_16_9         10
1534 #define FF_DTG_AFD_14_9         11
1535 #define FF_DTG_AFD_4_3_SP_14_9  13
1536 #define FF_DTG_AFD_16_9_SP_14_9 14
1537 #define FF_DTG_AFD_SP_4_3       15
1538
1539     /**
1540      * maximum motion estimation search range in subpel units
1541      * If 0 then no limit.
1542      *
1543      * - encoding: Set by user.
1544      * - decoding: unused
1545      */
1546     int me_range;
1547
1548     /**
1549      * intra quantizer bias
1550      * - encoding: Set by user.
1551      * - decoding: unused
1552      */
1553     int intra_quant_bias;
1554 #define FF_DEFAULT_QUANT_BIAS 999999
1555
1556     /**
1557      * inter quantizer bias
1558      * - encoding: Set by user.
1559      * - decoding: unused
1560      */
1561     int inter_quant_bias;
1562
1563     /**
1564      * slice flags
1565      * - encoding: unused
1566      * - decoding: Set by user.
1567      */
1568     int slice_flags;
1569 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1570 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1571 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1572
1573 #if FF_API_XVMC
1574     /**
1575      * XVideo Motion Acceleration
1576      * - encoding: forbidden
1577      * - decoding: set by decoder
1578      * @deprecated XvMC support is slated for removal.
1579      */
1580     attribute_deprecated int xvmc_acceleration;
1581 #endif /* FF_API_XVMC */
1582
1583     /**
1584      * macroblock decision mode
1585      * - encoding: Set by user.
1586      * - decoding: unused
1587      */
1588     int mb_decision;
1589 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1590 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1591 #define FF_MB_DECISION_RD     2        ///< rate distortion
1592
1593     /**
1594      * custom intra quantization matrix
1595      * - encoding: Set by user, can be NULL.
1596      * - decoding: Set by libavcodec.
1597      */
1598     uint16_t *intra_matrix;
1599
1600     /**
1601      * custom inter quantization matrix
1602      * - encoding: Set by user, can be NULL.
1603      * - decoding: Set by libavcodec.
1604      */
1605     uint16_t *inter_matrix;
1606
1607     /**
1608      * scene change detection threshold
1609      * 0 is default, larger means fewer detected scene changes.
1610      * - encoding: Set by user.
1611      * - decoding: unused
1612      */
1613     int scenechange_threshold;
1614
1615     /**
1616      * noise reduction strength
1617      * - encoding: Set by user.
1618      * - decoding: unused
1619      */
1620     int noise_reduction;
1621
1622     /**
1623      * Motion estimation threshold below which no motion estimation is
1624      * performed, but instead the user specified motion vectors are used.
1625      *
1626      * - encoding: Set by user.
1627      * - decoding: unused
1628      */
1629     int me_threshold;
1630
1631     /**
1632      * Macroblock threshold below which the user specified macroblock types will be used.
1633      * - encoding: Set by user.
1634      * - decoding: unused
1635      */
1636     int mb_threshold;
1637
1638     /**
1639      * precision of the intra DC coefficient - 8
1640      * - encoding: Set by user.
1641      * - decoding: unused
1642      */
1643     int intra_dc_precision;
1644
1645     /**
1646      * Number of macroblock rows at the top which are skipped.
1647      * - encoding: unused
1648      * - decoding: Set by user.
1649      */
1650     int skip_top;
1651
1652     /**
1653      * Number of macroblock rows at the bottom which are skipped.
1654      * - encoding: unused
1655      * - decoding: Set by user.
1656      */
1657     int skip_bottom;
1658
1659     /**
1660      * Border processing masking, raises the quantizer for mbs on the borders
1661      * of the picture.
1662      * - encoding: Set by user.
1663      * - decoding: unused
1664      */
1665     float border_masking;
1666
1667     /**
1668      * minimum MB lagrange multipler
1669      * - encoding: Set by user.
1670      * - decoding: unused
1671      */
1672     int mb_lmin;
1673
1674     /**
1675      * maximum MB lagrange multipler
1676      * - encoding: Set by user.
1677      * - decoding: unused
1678      */
1679     int mb_lmax;
1680
1681     /**
1682      *
1683      * - encoding: Set by user.
1684      * - decoding: unused
1685      */
1686     int me_penalty_compensation;
1687
1688     /**
1689      *
1690      * - encoding: Set by user.
1691      * - decoding: unused
1692      */
1693     int bidir_refine;
1694
1695     /**
1696      *
1697      * - encoding: Set by user.
1698      * - decoding: unused
1699      */
1700     int brd_scale;
1701
1702     /**
1703      * minimum GOP size
1704      * - encoding: Set by user.
1705      * - decoding: unused
1706      */
1707     int keyint_min;
1708
1709     /**
1710      * number of reference frames
1711      * - encoding: Set by user.
1712      * - decoding: Set by lavc.
1713      */
1714     int refs;
1715
1716     /**
1717      * chroma qp offset from luma
1718      * - encoding: Set by user.
1719      * - decoding: unused
1720      */
1721     int chromaoffset;
1722
1723     /**
1724      * Multiplied by qscale for each frame and added to scene_change_score.
1725      * - encoding: Set by user.
1726      * - decoding: unused
1727      */
1728     int scenechange_factor;
1729
1730     /**
1731      *
1732      * Note: Value depends upon the compare function used for fullpel ME.
1733      * - encoding: Set by user.
1734      * - decoding: unused
1735      */
1736     int mv0_threshold;
1737
1738     /**
1739      * Adjust sensitivity of b_frame_strategy 1.
1740      * - encoding: Set by user.
1741      * - decoding: unused
1742      */
1743     int b_sensitivity;
1744
1745     /**
1746      * Chromaticity coordinates of the source primaries.
1747      * - encoding: Set by user
1748      * - decoding: Set by libavcodec
1749      */
1750     enum AVColorPrimaries color_primaries;
1751
1752     /**
1753      * Color Transfer Characteristic.
1754      * - encoding: Set by user
1755      * - decoding: Set by libavcodec
1756      */
1757     enum AVColorTransferCharacteristic color_trc;
1758
1759     /**
1760      * YUV colorspace type.
1761      * - encoding: Set by user
1762      * - decoding: Set by libavcodec
1763      */
1764     enum AVColorSpace colorspace;
1765
1766     /**
1767      * MPEG vs JPEG YUV range.
1768      * - encoding: Set by user
1769      * - decoding: Set by libavcodec
1770      */
1771     enum AVColorRange color_range;
1772
1773     /**
1774      * This defines the location of chroma samples.
1775      * - encoding: Set by user
1776      * - decoding: Set by libavcodec
1777      */
1778     enum AVChromaLocation chroma_sample_location;
1779
1780     /**
1781      * Number of slices.
1782      * Indicates number of picture subdivisions. Used for parallelized
1783      * decoding.
1784      * - encoding: Set by user
1785      * - decoding: unused
1786      */
1787     int slices;
1788
1789     /** Field order
1790      * - encoding: set by libavcodec
1791      * - decoding: Set by libavcodec
1792      */
1793     enum AVFieldOrder field_order;
1794
1795     /* audio only */
1796     int sample_rate; ///< samples per second
1797     int channels;    ///< number of audio channels
1798
1799     /**
1800      * audio sample format
1801      * - encoding: Set by user.
1802      * - decoding: Set by libavcodec.
1803      */
1804     enum AVSampleFormat sample_fmt;  ///< sample format
1805
1806     /* The following data should not be initialized. */
1807     /**
1808      * Number of samples per channel in an audio frame.
1809      *
1810      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
1811      *   except the last must contain exactly frame_size samples per channel.
1812      *   May be 0 when the codec has CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
1813      *   frame size is not restricted.
1814      * - decoding: may be set by some decoders to indicate constant frame size
1815      */
1816     int frame_size;
1817
1818     /**
1819      * Frame counter, set by libavcodec.
1820      *
1821      * - decoding: total number of frames returned from the decoder so far.
1822      * - encoding: total number of frames passed to the encoder so far.
1823      *
1824      *   @note the counter is not incremented if encoding/decoding resulted in
1825      *   an error.
1826      */
1827     int frame_number;
1828
1829     /**
1830      * number of bytes per packet if constant and known or 0
1831      * Used by some WAV based audio codecs.
1832      */
1833     int block_align;
1834
1835     /**
1836      * Audio cutoff bandwidth (0 means "automatic")
1837      * - encoding: Set by user.
1838      * - decoding: unused
1839      */
1840     int cutoff;
1841
1842 #if FF_API_REQUEST_CHANNELS
1843     /**
1844      * Decoder should decode to this many channels if it can (0 for default)
1845      * - encoding: unused
1846      * - decoding: Set by user.
1847      * @deprecated Deprecated in favor of request_channel_layout.
1848      */
1849     attribute_deprecated int request_channels;
1850 #endif
1851
1852     /**
1853      * Audio channel layout.
1854      * - encoding: set by user.
1855      * - decoding: set by libavcodec.
1856      */
1857     uint64_t channel_layout;
1858
1859     /**
1860      * Request decoder to use this channel layout if it can (0 for default)
1861      * - encoding: unused
1862      * - decoding: Set by user.
1863      */
1864     uint64_t request_channel_layout;
1865
1866     /**
1867      * Type of service that the audio stream conveys.
1868      * - encoding: Set by user.
1869      * - decoding: Set by libavcodec.
1870      */
1871     enum AVAudioServiceType audio_service_type;
1872
1873     /**
1874      * Used to request a sample format from the decoder.
1875      * - encoding: unused.
1876      * - decoding: Set by user.
1877      */
1878     enum AVSampleFormat request_sample_fmt;
1879
1880 #if FF_API_GET_BUFFER
1881     /**
1882      * Called at the beginning of each frame to get a buffer for it.
1883      *
1884      * The function will set AVFrame.data[], AVFrame.linesize[].
1885      * AVFrame.extended_data[] must also be set, but it should be the same as
1886      * AVFrame.data[] except for planar audio with more channels than can fit
1887      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1888      * many data pointers as it can hold.
1889      *
1890      * if CODEC_CAP_DR1 is not set then get_buffer() must call
1891      * avcodec_default_get_buffer() instead of providing buffers allocated by
1892      * some other means.
1893      *
1894      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1895      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1896      * but if get_buffer() is overridden then alignment considerations should
1897      * be taken into account.
1898      *
1899      * @see avcodec_default_get_buffer()
1900      *
1901      * Video:
1902      *
1903      * If pic.reference is set then the frame will be read later by libavcodec.
1904      * avcodec_align_dimensions2() should be used to find the required width and
1905      * height, as they normally need to be rounded up to the next multiple of 16.
1906      *
1907      * If frame multithreading is used and thread_safe_callbacks is set,
1908      * it may be called from a different thread, but not from more than one at
1909      * once. Does not need to be reentrant.
1910      *
1911      * @see release_buffer(), reget_buffer()
1912      * @see avcodec_align_dimensions2()
1913      *
1914      * Audio:
1915      *
1916      * Decoders request a buffer of a particular size by setting
1917      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1918      * however, utilize only part of the buffer by setting AVFrame.nb_samples
1919      * to a smaller value in the output frame.
1920      *
1921      * Decoders cannot use the buffer after returning from
1922      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1923      * is assumed to be released immediately upon return. In some rare cases,
1924      * a decoder may need to call get_buffer() more than once in a single
1925      * call to avcodec_decode_audio4(). In that case, when get_buffer() is
1926      * called again after it has already been called once, the previously
1927      * acquired buffer is assumed to be released at that time and may not be
1928      * reused by the decoder.
1929      *
1930      * As a convenience, av_samples_get_buffer_size() and
1931      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1932      * functions to find the required data size and to fill data pointers and
1933      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1934      * since all planes must be the same size.
1935      *
1936      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1937      *
1938      * - encoding: unused
1939      * - decoding: Set by libavcodec, user can override.
1940      *
1941      * @deprecated use get_buffer2()
1942      */
1943     attribute_deprecated
1944     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1945
1946     /**
1947      * Called to release buffers which were allocated with get_buffer.
1948      * A released buffer can be reused in get_buffer().
1949      * pic.data[*] must be set to NULL.
1950      * May be called from a different thread if frame multithreading is used,
1951      * but not by more than one thread at once, so does not need to be reentrant.
1952      * - encoding: unused
1953      * - decoding: Set by libavcodec, user can override.
1954      *
1955      * @deprecated custom freeing callbacks should be set from get_buffer2()
1956      */
1957     attribute_deprecated
1958     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1959
1960     /**
1961      * Called at the beginning of a frame to get cr buffer for it.
1962      * Buffer type (size, hints) must be the same. libavcodec won't check it.
1963      * libavcodec will pass previous buffer in pic, function should return
1964      * same buffer or new buffer with old frame "painted" into it.
1965      * If pic.data[0] == NULL must behave like get_buffer().
1966      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
1967      * avcodec_default_reget_buffer() instead of providing buffers allocated by
1968      * some other means.
1969      * - encoding: unused
1970      * - decoding: Set by libavcodec, user can override.
1971      */
1972     attribute_deprecated
1973     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
1974 #endif
1975
1976     /**
1977      * This callback is called at the beginning of each frame to get data
1978      * buffer(s) for it. There may be one contiguous buffer for all the data or
1979      * there may be a buffer per each data plane or anything in between. What
1980      * this means is, you may set however many entries in buf[] you feel necessary.
1981      * Each buffer must be reference-counted using the AVBuffer API (see description
1982      * of buf[] below).
1983      *
1984      * The following fields will be set in the frame before this callback is
1985      * called:
1986      * - format
1987      * - width, height (video only)
1988      * - sample_rate, channel_layout, nb_samples (audio only)
1989      * Their values may differ from the corresponding values in
1990      * AVCodecContext. This callback must use the frame values, not the codec
1991      * context values, to calculate the required buffer size.
1992      *
1993      * This callback must fill the following fields in the frame:
1994      * - data[]
1995      * - linesize[]
1996      * - extended_data:
1997      *   * if the data is planar audio with more than 8 channels, then this
1998      *     callback must allocate and fill extended_data to contain all pointers
1999      *     to all data planes. data[] must hold as many pointers as it can.
2000      *     extended_data must be allocated with av_malloc() and will be freed in
2001      *     av_frame_unref().
2002      *   * otherwise exended_data must point to data
2003      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2004      *   the frame's data and extended_data pointers must be contained in these. That
2005      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2006      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2007      *   and av_buffer_ref().
2008      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2009      *   this callback and filled with the extra buffers if there are more
2010      *   buffers than buf[] can hold. extended_buf will be freed in
2011      *   av_frame_unref().
2012      *
2013      * If CODEC_CAP_DR1 is not set then get_buffer2() must call
2014      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2015      * some other means.
2016      *
2017      * Each data plane must be aligned to the maximum required by the target
2018      * CPU.
2019      *
2020      * @see avcodec_default_get_buffer2()
2021      *
2022      * Video:
2023      *
2024      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2025      * (read and/or written to if it is writable) later by libavcodec.
2026      *
2027      * avcodec_align_dimensions2() should be used to find the required width and
2028      * height, as they normally need to be rounded up to the next multiple of 16.
2029      *
2030      * If frame multithreading is used and thread_safe_callbacks is set,
2031      * this callback may be called from a different thread, but not from more
2032      * than one at once. Does not need to be reentrant.
2033      *
2034      * @see avcodec_align_dimensions2()
2035      *
2036      * Audio:
2037      *
2038      * Decoders request a buffer of a particular size by setting
2039      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2040      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2041      * to a smaller value in the output frame.
2042      *
2043      * As a convenience, av_samples_get_buffer_size() and
2044      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2045      * functions to find the required data size and to fill data pointers and
2046      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2047      * since all planes must be the same size.
2048      *
2049      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2050      *
2051      * - encoding: unused
2052      * - decoding: Set by libavcodec, user can override.
2053      */
2054     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2055
2056     /**
2057      * If non-zero, the decoded audio and video frames returned from
2058      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2059      * and are valid indefinitely. The caller must free them with
2060      * av_frame_unref() when they are not needed anymore.
2061      * Otherwise, the decoded frames must not be freed by the caller and are
2062      * only valid until the next decode call.
2063      *
2064      * - encoding: unused
2065      * - decoding: set by the caller before avcodec_open2().
2066      */
2067     int refcounted_frames;
2068
2069     /* - encoding parameters */
2070     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2071     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2072
2073     /**
2074      * minimum quantizer
2075      * - encoding: Set by user.
2076      * - decoding: unused
2077      */
2078     int qmin;
2079
2080     /**
2081      * maximum quantizer
2082      * - encoding: Set by user.
2083      * - decoding: unused
2084      */
2085     int qmax;
2086
2087     /**
2088      * maximum quantizer difference between frames
2089      * - encoding: Set by user.
2090      * - decoding: unused
2091      */
2092     int max_qdiff;
2093
2094     /**
2095      * ratecontrol qmin qmax limiting method
2096      * 0-> clipping, 1-> use a nice continuous function to limit qscale wthin qmin/qmax.
2097      * - encoding: Set by user.
2098      * - decoding: unused
2099      */
2100     float rc_qsquish;
2101
2102     float rc_qmod_amp;
2103     int rc_qmod_freq;
2104
2105     /**
2106      * decoder bitstream buffer size
2107      * - encoding: Set by user.
2108      * - decoding: unused
2109      */
2110     int rc_buffer_size;
2111
2112     /**
2113      * ratecontrol override, see RcOverride
2114      * - encoding: Allocated/set/freed by user.
2115      * - decoding: unused
2116      */
2117     int rc_override_count;
2118     RcOverride *rc_override;
2119
2120     /**
2121      * rate control equation
2122      * - encoding: Set by user
2123      * - decoding: unused
2124      */
2125     const char *rc_eq;
2126
2127     /**
2128      * maximum bitrate
2129      * - encoding: Set by user.
2130      * - decoding: unused
2131      */
2132     int rc_max_rate;
2133
2134     /**
2135      * minimum bitrate
2136      * - encoding: Set by user.
2137      * - decoding: unused
2138      */
2139     int rc_min_rate;
2140
2141     float rc_buffer_aggressivity;
2142
2143     /**
2144      * initial complexity for pass1 ratecontrol
2145      * - encoding: Set by user.
2146      * - decoding: unused
2147      */
2148     float rc_initial_cplx;
2149
2150     /**
2151      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2152      * - encoding: Set by user.
2153      * - decoding: unused.
2154      */
2155     float rc_max_available_vbv_use;
2156
2157     /**
2158      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2159      * - encoding: Set by user.
2160      * - decoding: unused.
2161      */
2162     float rc_min_vbv_overflow_use;
2163
2164     /**
2165      * Number of bits which should be loaded into the rc buffer before decoding starts.
2166      * - encoding: Set by user.
2167      * - decoding: unused
2168      */
2169     int rc_initial_buffer_occupancy;
2170
2171 #define FF_CODER_TYPE_VLC       0
2172 #define FF_CODER_TYPE_AC        1
2173 #define FF_CODER_TYPE_RAW       2
2174 #define FF_CODER_TYPE_RLE       3
2175 #define FF_CODER_TYPE_DEFLATE   4
2176     /**
2177      * coder type
2178      * - encoding: Set by user.
2179      * - decoding: unused
2180      */
2181     int coder_type;
2182
2183     /**
2184      * context model
2185      * - encoding: Set by user.
2186      * - decoding: unused
2187      */
2188     int context_model;
2189
2190     /**
2191      * minimum Lagrange multipler
2192      * - encoding: Set by user.
2193      * - decoding: unused
2194      */
2195     int lmin;
2196
2197     /**
2198      * maximum Lagrange multipler
2199      * - encoding: Set by user.
2200      * - decoding: unused
2201      */
2202     int lmax;
2203
2204     /**
2205      * frame skip threshold
2206      * - encoding: Set by user.
2207      * - decoding: unused
2208      */
2209     int frame_skip_threshold;
2210
2211     /**
2212      * frame skip factor
2213      * - encoding: Set by user.
2214      * - decoding: unused
2215      */
2216     int frame_skip_factor;
2217
2218     /**
2219      * frame skip exponent
2220      * - encoding: Set by user.
2221      * - decoding: unused
2222      */
2223     int frame_skip_exp;
2224
2225     /**
2226      * frame skip comparison function
2227      * - encoding: Set by user.
2228      * - decoding: unused
2229      */
2230     int frame_skip_cmp;
2231
2232     /**
2233      * trellis RD quantization
2234      * - encoding: Set by user.
2235      * - decoding: unused
2236      */
2237     int trellis;
2238
2239     /**
2240      * - encoding: Set by user.
2241      * - decoding: unused
2242      */
2243     int min_prediction_order;
2244
2245     /**
2246      * - encoding: Set by user.
2247      * - decoding: unused
2248      */
2249     int max_prediction_order;
2250
2251     /**
2252      * GOP timecode frame start number, in non drop frame format
2253      * - encoding: Set by user.
2254      * - decoding: unused
2255      */
2256     int64_t timecode_frame_start;
2257
2258     /* The RTP callback: This function is called    */
2259     /* every time the encoder has a packet to send. */
2260     /* It depends on the encoder if the data starts */
2261     /* with a Start Code (it should). H.263 does.   */
2262     /* mb_nb contains the number of macroblocks     */
2263     /* encoded in the RTP payload.                  */
2264     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2265
2266     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2267                             /* do its best to deliver a chunk with size     */
2268                             /* below rtp_payload_size, the chunk will start */
2269                             /* with a start code on some codecs like H.263. */
2270                             /* This doesn't take account of any particular  */
2271                             /* headers inside the transmitted RTP payload.  */
2272
2273     /* statistics, used for 2-pass encoding */
2274     int mv_bits;
2275     int header_bits;
2276     int i_tex_bits;
2277     int p_tex_bits;
2278     int i_count;
2279     int p_count;
2280     int skip_count;
2281     int misc_bits;
2282
2283     /**
2284      * number of bits used for the previously encoded frame
2285      * - encoding: Set by libavcodec.
2286      * - decoding: unused
2287      */
2288     int frame_bits;
2289
2290     /**
2291      * pass1 encoding statistics output buffer
2292      * - encoding: Set by libavcodec.
2293      * - decoding: unused
2294      */
2295     char *stats_out;
2296
2297     /**
2298      * pass2 encoding statistics input buffer
2299      * Concatenated stuff from stats_out of pass1 should be placed here.
2300      * - encoding: Allocated/set/freed by user.
2301      * - decoding: unused
2302      */
2303     char *stats_in;
2304
2305     /**
2306      * Work around bugs in encoders which sometimes cannot be detected automatically.
2307      * - encoding: Set by user
2308      * - decoding: Set by user
2309      */
2310     int workaround_bugs;
2311 #define FF_BUG_AUTODETECT       1  ///< autodetection
2312 #if FF_API_OLD_MSMPEG4
2313 #define FF_BUG_OLD_MSMPEG4      2
2314 #endif
2315 #define FF_BUG_XVID_ILACE       4
2316 #define FF_BUG_UMP4             8
2317 #define FF_BUG_NO_PADDING       16
2318 #define FF_BUG_AMV              32
2319 #if FF_API_AC_VLC
2320 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2321 #endif
2322 #define FF_BUG_QPEL_CHROMA      64
2323 #define FF_BUG_STD_QPEL         128
2324 #define FF_BUG_QPEL_CHROMA2     256
2325 #define FF_BUG_DIRECT_BLOCKSIZE 512
2326 #define FF_BUG_EDGE             1024
2327 #define FF_BUG_HPEL_CHROMA      2048
2328 #define FF_BUG_DC_CLIP          4096
2329 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2330 #define FF_BUG_TRUNCATED       16384
2331
2332     /**
2333      * strictly follow the standard (MPEG4, ...).
2334      * - encoding: Set by user.
2335      * - decoding: Set by user.
2336      * Setting this to STRICT or higher means the encoder and decoder will
2337      * generally do stupid things, whereas setting it to unofficial or lower
2338      * will mean the encoder might produce output that is not supported by all
2339      * spec-compliant decoders. Decoders don't differentiate between normal,
2340      * unofficial and experimental (that is, they always try to decode things
2341      * when they can) unless they are explicitly asked to behave stupidly
2342      * (=strictly conform to the specs)
2343      */
2344     int strict_std_compliance;
2345 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2346 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2347 #define FF_COMPLIANCE_NORMAL        0
2348 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2349 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2350
2351     /**
2352      * error concealment flags
2353      * - encoding: unused
2354      * - decoding: Set by user.
2355      */
2356     int error_concealment;
2357 #define FF_EC_GUESS_MVS   1
2358 #define FF_EC_DEBLOCK     2
2359
2360     /**
2361      * debug
2362      * - encoding: Set by user.
2363      * - decoding: Set by user.
2364      */
2365     int debug;
2366 #define FF_DEBUG_PICT_INFO   1
2367 #define FF_DEBUG_RC          2
2368 #define FF_DEBUG_BITSTREAM   4
2369 #define FF_DEBUG_MB_TYPE     8
2370 #define FF_DEBUG_QP          16
2371 #if FF_API_DEBUG_MV
2372 /**
2373  * @deprecated this option does nothing
2374  */
2375 #define FF_DEBUG_MV          32
2376 #endif
2377 #define FF_DEBUG_DCT_COEFF   0x00000040
2378 #define FF_DEBUG_SKIP        0x00000080
2379 #define FF_DEBUG_STARTCODE   0x00000100
2380 #define FF_DEBUG_PTS         0x00000200
2381 #define FF_DEBUG_ER          0x00000400
2382 #define FF_DEBUG_MMCO        0x00000800
2383 #define FF_DEBUG_BUGS        0x00001000
2384 #if FF_API_DEBUG_MV
2385 #define FF_DEBUG_VIS_QP      0x00002000
2386 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2387 #endif
2388 #define FF_DEBUG_BUFFERS     0x00008000
2389 #define FF_DEBUG_THREADS     0x00010000
2390
2391 #if FF_API_DEBUG_MV
2392     /**
2393      * @deprecated this option does not have any effect
2394      */
2395     attribute_deprecated
2396     int debug_mv;
2397 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2398 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2399 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2400 #endif
2401
2402     /**
2403      * Error recognition; may misdetect some more or less valid parts as errors.
2404      * - encoding: unused
2405      * - decoding: Set by user.
2406      */
2407     int err_recognition;
2408
2409 /**
2410  * Verify checksums embedded in the bitstream (could be of either encoded or
2411  * decoded data, depending on the codec) and print an error message on mismatch.
2412  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2413  * decoder returning an error.
2414  */
2415 #define AV_EF_CRCCHECK  (1<<0)
2416 #define AV_EF_BITSTREAM (1<<1)
2417 #define AV_EF_BUFFER    (1<<2)
2418 #define AV_EF_EXPLODE   (1<<3)
2419
2420     /**
2421      * opaque 64bit number (generally a PTS) that will be reordered and
2422      * output in AVFrame.reordered_opaque
2423      * @deprecated in favor of pkt_pts
2424      * - encoding: unused
2425      * - decoding: Set by user.
2426      */
2427     int64_t reordered_opaque;
2428
2429     /**
2430      * Hardware accelerator in use
2431      * - encoding: unused.
2432      * - decoding: Set by libavcodec
2433      */
2434     struct AVHWAccel *hwaccel;
2435
2436     /**
2437      * Hardware accelerator context.
2438      * For some hardware accelerators, a global context needs to be
2439      * provided by the user. In that case, this holds display-dependent
2440      * data Libav cannot instantiate itself. Please refer to the
2441      * Libav HW accelerator documentation to know how to fill this
2442      * is. e.g. for VA API, this is a struct vaapi_context.
2443      * - encoding: unused
2444      * - decoding: Set by user
2445      */
2446     void *hwaccel_context;
2447
2448     /**
2449      * error
2450      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2451      * - decoding: unused
2452      */
2453     uint64_t error[AV_NUM_DATA_POINTERS];
2454
2455     /**
2456      * DCT algorithm, see FF_DCT_* below
2457      * - encoding: Set by user.
2458      * - decoding: unused
2459      */
2460     int dct_algo;
2461 #define FF_DCT_AUTO    0
2462 #define FF_DCT_FASTINT 1
2463 #define FF_DCT_INT     2
2464 #define FF_DCT_MMX     3
2465 #define FF_DCT_ALTIVEC 5
2466 #define FF_DCT_FAAN    6
2467
2468     /**
2469      * IDCT algorithm, see FF_IDCT_* below.
2470      * - encoding: Set by user.
2471      * - decoding: Set by user.
2472      */
2473     int idct_algo;
2474 #define FF_IDCT_AUTO          0
2475 #define FF_IDCT_INT           1
2476 #define FF_IDCT_SIMPLE        2
2477 #define FF_IDCT_SIMPLEMMX     3
2478 #define FF_IDCT_ARM           7
2479 #define FF_IDCT_ALTIVEC       8
2480 #if FF_API_ARCH_SH4
2481 #define FF_IDCT_SH4           9
2482 #endif
2483 #define FF_IDCT_SIMPLEARM     10
2484 #define FF_IDCT_IPP           13
2485 #define FF_IDCT_XVIDMMX       14
2486 #define FF_IDCT_SIMPLEARMV5TE 16
2487 #define FF_IDCT_SIMPLEARMV6   17
2488 #if FF_API_ARCH_SPARC
2489 #define FF_IDCT_SIMPLEVIS     18
2490 #endif
2491 #define FF_IDCT_FAAN          20
2492 #define FF_IDCT_SIMPLENEON    22
2493 #if FF_API_ARCH_ALPHA
2494 #define FF_IDCT_SIMPLEALPHA   23
2495 #endif
2496
2497     /**
2498      * bits per sample/pixel from the demuxer (needed for huffyuv).
2499      * - encoding: Set by libavcodec.
2500      * - decoding: Set by user.
2501      */
2502      int bits_per_coded_sample;
2503
2504     /**
2505      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2506      * - encoding: set by user.
2507      * - decoding: set by libavcodec.
2508      */
2509     int bits_per_raw_sample;
2510
2511 #if FF_API_LOWRES
2512     /**
2513      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2514      * - encoding: unused
2515      * - decoding: Set by user.
2516      *
2517      * @deprecated use decoder private options instead
2518      */
2519     attribute_deprecated int lowres;
2520 #endif
2521
2522     /**
2523      * the picture in the bitstream
2524      * - encoding: Set by libavcodec.
2525      * - decoding: unused
2526      */
2527     AVFrame *coded_frame;
2528
2529     /**
2530      * thread count
2531      * is used to decide how many independent tasks should be passed to execute()
2532      * - encoding: Set by user.
2533      * - decoding: Set by user.
2534      */
2535     int thread_count;
2536
2537     /**
2538      * Which multithreading methods to use.
2539      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2540      * so clients which cannot provide future frames should not use it.
2541      *
2542      * - encoding: Set by user, otherwise the default is used.
2543      * - decoding: Set by user, otherwise the default is used.
2544      */
2545     int thread_type;
2546 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2547 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2548
2549     /**
2550      * Which multithreading methods are in use by the codec.
2551      * - encoding: Set by libavcodec.
2552      * - decoding: Set by libavcodec.
2553      */
2554     int active_thread_type;
2555
2556     /**
2557      * Set by the client if its custom get_buffer() callback can be called
2558      * synchronously from another thread, which allows faster multithreaded decoding.
2559      * draw_horiz_band() will be called from other threads regardless of this setting.
2560      * Ignored if the default get_buffer() is used.
2561      * - encoding: Set by user.
2562      * - decoding: Set by user.
2563      */
2564     int thread_safe_callbacks;
2565
2566     /**
2567      * The codec may call this to execute several independent things.
2568      * It will return only after finishing all tasks.
2569      * The user may replace this with some multithreaded implementation,
2570      * the default implementation will execute the parts serially.
2571      * @param count the number of things to execute
2572      * - encoding: Set by libavcodec, user can override.
2573      * - decoding: Set by libavcodec, user can override.
2574      */
2575     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2576
2577     /**
2578      * The codec may call this to execute several independent things.
2579      * It will return only after finishing all tasks.
2580      * The user may replace this with some multithreaded implementation,
2581      * the default implementation will execute the parts serially.
2582      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2583      * @param c context passed also to func
2584      * @param count the number of things to execute
2585      * @param arg2 argument passed unchanged to func
2586      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2587      * @param func function that will be called count times, with jobnr from 0 to count-1.
2588      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2589      *             two instances of func executing at the same time will have the same threadnr.
2590      * @return always 0 currently, but code should handle a future improvement where when any call to func
2591      *         returns < 0 no further calls to func may be done and < 0 is returned.
2592      * - encoding: Set by libavcodec, user can override.
2593      * - decoding: Set by libavcodec, user can override.
2594      */
2595     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2596
2597 #if FF_API_THREAD_OPAQUE
2598     /**
2599      * @deprecated this field should not be used from outside of lavc
2600      */
2601     attribute_deprecated
2602     void *thread_opaque;
2603 #endif
2604
2605     /**
2606      * noise vs. sse weight for the nsse comparsion function
2607      * - encoding: Set by user.
2608      * - decoding: unused
2609      */
2610      int nsse_weight;
2611
2612     /**
2613      * profile
2614      * - encoding: Set by user.
2615      * - decoding: Set by libavcodec.
2616      */
2617      int profile;
2618 #define FF_PROFILE_UNKNOWN -99
2619 #define FF_PROFILE_RESERVED -100
2620
2621 #define FF_PROFILE_AAC_MAIN 0
2622 #define FF_PROFILE_AAC_LOW  1
2623 #define FF_PROFILE_AAC_SSR  2
2624 #define FF_PROFILE_AAC_LTP  3
2625 #define FF_PROFILE_AAC_HE   4
2626 #define FF_PROFILE_AAC_HE_V2 28
2627 #define FF_PROFILE_AAC_LD   22
2628 #define FF_PROFILE_AAC_ELD  38
2629 #define FF_PROFILE_MPEG2_AAC_LOW 128
2630 #define FF_PROFILE_MPEG2_AAC_HE  131
2631
2632 #define FF_PROFILE_DTS         20
2633 #define FF_PROFILE_DTS_ES      30
2634 #define FF_PROFILE_DTS_96_24   40
2635 #define FF_PROFILE_DTS_HD_HRA  50
2636 #define FF_PROFILE_DTS_HD_MA   60
2637
2638 #define FF_PROFILE_MPEG2_422    0
2639 #define FF_PROFILE_MPEG2_HIGH   1
2640 #define FF_PROFILE_MPEG2_SS     2
2641 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2642 #define FF_PROFILE_MPEG2_MAIN   4
2643 #define FF_PROFILE_MPEG2_SIMPLE 5
2644
2645 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2646 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2647
2648 #define FF_PROFILE_H264_BASELINE             66
2649 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2650 #define FF_PROFILE_H264_MAIN                 77
2651 #define FF_PROFILE_H264_EXTENDED             88
2652 #define FF_PROFILE_H264_HIGH                 100
2653 #define FF_PROFILE_H264_HIGH_10              110
2654 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2655 #define FF_PROFILE_H264_HIGH_422             122
2656 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2657 #define FF_PROFILE_H264_HIGH_444             144
2658 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2659 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2660 #define FF_PROFILE_H264_CAVLC_444            44
2661
2662 #define FF_PROFILE_VC1_SIMPLE   0
2663 #define FF_PROFILE_VC1_MAIN     1
2664 #define FF_PROFILE_VC1_COMPLEX  2
2665 #define FF_PROFILE_VC1_ADVANCED 3
2666
2667 #define FF_PROFILE_MPEG4_SIMPLE                     0
2668 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2669 #define FF_PROFILE_MPEG4_CORE                       2
2670 #define FF_PROFILE_MPEG4_MAIN                       3
2671 #define FF_PROFILE_MPEG4_N_BIT                      4
2672 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2673 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2674 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2675 #define FF_PROFILE_MPEG4_HYBRID                     8
2676 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2677 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2678 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2679 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2680 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2681 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2682 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2683
2684 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   0
2685 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   1
2686 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  2
2687 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2688 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2689
2690
2691 #define FF_PROFILE_HEVC_MAIN                        1
2692 #define FF_PROFILE_HEVC_MAIN_10                     2
2693 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2694
2695     /**
2696      * level
2697      * - encoding: Set by user.
2698      * - decoding: Set by libavcodec.
2699      */
2700      int level;
2701 #define FF_LEVEL_UNKNOWN -99
2702
2703     /**
2704      *
2705      * - encoding: unused
2706      * - decoding: Set by user.
2707      */
2708     enum AVDiscard skip_loop_filter;
2709
2710     /**
2711      *
2712      * - encoding: unused
2713      * - decoding: Set by user.
2714      */
2715     enum AVDiscard skip_idct;
2716
2717     /**
2718      *
2719      * - encoding: unused
2720      * - decoding: Set by user.
2721      */
2722     enum AVDiscard skip_frame;
2723
2724     /**
2725      * Header containing style information for text subtitles.
2726      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2727      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2728      * the Format line following. It shouldn't include any Dialogue line.
2729      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2730      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2731      */
2732     uint8_t *subtitle_header;
2733     int subtitle_header_size;
2734
2735 #if FF_API_ERROR_RATE
2736     /**
2737      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
2738      * encoders
2739      */
2740     attribute_deprecated
2741     int error_rate;
2742 #endif
2743
2744 #if FF_API_CODEC_PKT
2745     /**
2746      * @deprecated this field is not supposed to be accessed from outside lavc
2747      */
2748     attribute_deprecated
2749     AVPacket *pkt;
2750 #endif
2751
2752     /**
2753      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2754      * Used for compliant TS muxing.
2755      * - encoding: Set by libavcodec.
2756      * - decoding: unused.
2757      */
2758     uint64_t vbv_delay;
2759 } AVCodecContext;
2760
2761 /**
2762  * AVProfile.
2763  */
2764 typedef struct AVProfile {
2765     int profile;
2766     const char *name; ///< short name for the profile
2767 } AVProfile;
2768
2769 typedef struct AVCodecDefault AVCodecDefault;
2770
2771 struct AVSubtitle;
2772
2773 /**
2774  * AVCodec.
2775  */
2776 typedef struct AVCodec {
2777     /**
2778      * Name of the codec implementation.
2779      * The name is globally unique among encoders and among decoders (but an
2780      * encoder and a decoder can share the same name).
2781      * This is the primary way to find a codec from the user perspective.
2782      */
2783     const char *name;
2784     /**
2785      * Descriptive name for the codec, meant to be more human readable than name.
2786      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2787      */
2788     const char *long_name;
2789     enum AVMediaType type;
2790     enum AVCodecID id;
2791     /**
2792      * Codec capabilities.
2793      * see CODEC_CAP_*
2794      */
2795     int capabilities;
2796     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2797     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2798     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2799     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2800     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2801 #if FF_API_LOWRES
2802     attribute_deprecated uint8_t max_lowres; ///< maximum value for lowres supported by the decoder
2803 #endif
2804     const AVClass *priv_class;              ///< AVClass for the private context
2805     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2806
2807     /*****************************************************************
2808      * No fields below this line are part of the public API. They
2809      * may not be used outside of libavcodec and can be changed and
2810      * removed at will.
2811      * New public fields should be added right above.
2812      *****************************************************************
2813      */
2814     int priv_data_size;
2815     struct AVCodec *next;
2816     /**
2817      * @name Frame-level threading support functions
2818      * @{
2819      */
2820     /**
2821      * If defined, called on thread contexts when they are created.
2822      * If the codec allocates writable tables in init(), re-allocate them here.
2823      * priv_data will be set to a copy of the original.
2824      */
2825     int (*init_thread_copy)(AVCodecContext *);
2826     /**
2827      * Copy necessary context variables from a previous thread context to the current one.
2828      * If not defined, the next thread will start automatically; otherwise, the codec
2829      * must call ff_thread_finish_setup().
2830      *
2831      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2832      */
2833     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2834     /** @} */
2835
2836     /**
2837      * Private codec-specific defaults.
2838      */
2839     const AVCodecDefault *defaults;
2840
2841     /**
2842      * Initialize codec static data, called from avcodec_register().
2843      */
2844     void (*init_static_data)(struct AVCodec *codec);
2845
2846     int (*init)(AVCodecContext *);
2847     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
2848                       const struct AVSubtitle *sub);
2849     /**
2850      * Encode data to an AVPacket.
2851      *
2852      * @param      avctx          codec context
2853      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2854      * @param[in]  frame          AVFrame containing the raw data to be encoded
2855      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2856      *                            non-empty packet was returned in avpkt.
2857      * @return 0 on success, negative error code on failure
2858      */
2859     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2860                    int *got_packet_ptr);
2861     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2862     int (*close)(AVCodecContext *);
2863     /**
2864      * Flush buffers.
2865      * Will be called when seeking
2866      */
2867     void (*flush)(AVCodecContext *);
2868 } AVCodec;
2869
2870 /**
2871  * AVHWAccel.
2872  */
2873 typedef struct AVHWAccel {
2874     /**
2875      * Name of the hardware accelerated codec.
2876      * The name is globally unique among encoders and among decoders (but an
2877      * encoder and a decoder can share the same name).
2878      */
2879     const char *name;
2880
2881     /**
2882      * Type of codec implemented by the hardware accelerator.
2883      *
2884      * See AVMEDIA_TYPE_xxx
2885      */
2886     enum AVMediaType type;
2887
2888     /**
2889      * Codec implemented by the hardware accelerator.
2890      *
2891      * See AV_CODEC_ID_xxx
2892      */
2893     enum AVCodecID id;
2894
2895     /**
2896      * Supported pixel format.
2897      *
2898      * Only hardware accelerated formats are supported here.
2899      */
2900     enum AVPixelFormat pix_fmt;
2901
2902     /**
2903      * Hardware accelerated codec capabilities.
2904      * see FF_HWACCEL_CODEC_CAP_*
2905      */
2906     int capabilities;
2907
2908     struct AVHWAccel *next;
2909
2910     /**
2911      * Called at the beginning of each frame or field picture.
2912      *
2913      * Meaningful frame information (codec specific) is guaranteed to
2914      * be parsed at this point. This function is mandatory.
2915      *
2916      * Note that buf can be NULL along with buf_size set to 0.
2917      * Otherwise, this means the whole frame is available at this point.
2918      *
2919      * @param avctx the codec context
2920      * @param buf the frame data buffer base
2921      * @param buf_size the size of the frame in bytes
2922      * @return zero if successful, a negative value otherwise
2923      */
2924     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2925
2926     /**
2927      * Callback for each slice.
2928      *
2929      * Meaningful slice information (codec specific) is guaranteed to
2930      * be parsed at this point. This function is mandatory.
2931      *
2932      * @param avctx the codec context
2933      * @param buf the slice data buffer base
2934      * @param buf_size the size of the slice in bytes
2935      * @return zero if successful, a negative value otherwise
2936      */
2937     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2938
2939     /**
2940      * Called at the end of each frame or field picture.
2941      *
2942      * The whole picture is parsed at this point and can now be sent
2943      * to the hardware accelerator. This function is mandatory.
2944      *
2945      * @param avctx the codec context
2946      * @return zero if successful, a negative value otherwise
2947      */
2948     int (*end_frame)(AVCodecContext *avctx);
2949
2950     /**
2951      * Size of HW accelerator private data.
2952      *
2953      * Private data is allocated with av_mallocz() before
2954      * AVCodecContext.get_buffer() and deallocated after
2955      * AVCodecContext.release_buffer().
2956      */
2957     int priv_data_size;
2958 } AVHWAccel;
2959
2960 /**
2961  * @defgroup lavc_picture AVPicture
2962  *
2963  * Functions for working with AVPicture
2964  * @{
2965  */
2966
2967 /**
2968  * four components are given, that's all.
2969  * the last component is alpha
2970  */
2971 typedef struct AVPicture {
2972     uint8_t *data[AV_NUM_DATA_POINTERS];
2973     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
2974 } AVPicture;
2975
2976 /**
2977  * @}
2978  */
2979
2980 #define AVPALETTE_SIZE 1024
2981 #define AVPALETTE_COUNT 256
2982
2983 enum AVSubtitleType {
2984     SUBTITLE_NONE,
2985
2986     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2987
2988     /**
2989      * Plain text, the text field must be set by the decoder and is
2990      * authoritative. ass and pict fields may contain approximations.
2991      */
2992     SUBTITLE_TEXT,
2993
2994     /**
2995      * Formatted text, the ass field must be set by the decoder and is
2996      * authoritative. pict and text fields may contain approximations.
2997      */
2998     SUBTITLE_ASS,
2999 };
3000
3001 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3002
3003 typedef struct AVSubtitleRect {
3004     int x;         ///< top left corner  of pict, undefined when pict is not set
3005     int y;         ///< top left corner  of pict, undefined when pict is not set
3006     int w;         ///< width            of pict, undefined when pict is not set
3007     int h;         ///< height           of pict, undefined when pict is not set
3008     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3009
3010     /**
3011      * data+linesize for the bitmap of this subtitle.
3012      * can be set for text/ass as well once they where rendered
3013      */
3014     AVPicture pict;
3015     enum AVSubtitleType type;
3016
3017     char *text;                     ///< 0 terminated plain UTF-8 text
3018
3019     /**
3020      * 0 terminated ASS/SSA compatible event line.
3021      * The pressentation of this is unaffected by the other values in this
3022      * struct.
3023      */
3024     char *ass;
3025     int flags;
3026 } AVSubtitleRect;
3027
3028 typedef struct AVSubtitle {
3029     uint16_t format; /* 0 = graphics */
3030     uint32_t start_display_time; /* relative to packet pts, in ms */
3031     uint32_t end_display_time; /* relative to packet pts, in ms */
3032     unsigned num_rects;
3033     AVSubtitleRect **rects;
3034     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3035 } AVSubtitle;
3036
3037 /**
3038  * If c is NULL, returns the first registered codec,
3039  * if c is non-NULL, returns the next registered codec after c,
3040  * or NULL if c is the last one.
3041  */
3042 AVCodec *av_codec_next(const AVCodec *c);
3043
3044 /**
3045  * Return the LIBAVCODEC_VERSION_INT constant.
3046  */
3047 unsigned avcodec_version(void);
3048
3049 /**
3050  * Return the libavcodec build-time configuration.
3051  */
3052 const char *avcodec_configuration(void);
3053
3054 /**
3055  * Return the libavcodec license.
3056  */
3057 const char *avcodec_license(void);
3058
3059 /**
3060  * Register the codec codec and initialize libavcodec.
3061  *
3062  * @warning either this function or avcodec_register_all() must be called
3063  * before any other libavcodec functions.
3064  *
3065  * @see avcodec_register_all()
3066  */
3067 void avcodec_register(AVCodec *codec);
3068
3069 /**
3070  * Register all the codecs, parsers and bitstream filters which were enabled at
3071  * configuration time. If you do not call this function you can select exactly
3072  * which formats you want to support, by using the individual registration
3073  * functions.
3074  *
3075  * @see avcodec_register
3076  * @see av_register_codec_parser
3077  * @see av_register_bitstream_filter
3078  */
3079 void avcodec_register_all(void);
3080
3081 /**
3082  * Allocate an AVCodecContext and set its fields to default values.  The
3083  * resulting struct can be deallocated by calling avcodec_close() on it followed
3084  * by av_free().
3085  *
3086  * @param codec if non-NULL, allocate private data and initialize defaults
3087  *              for the given codec. It is illegal to then call avcodec_open2()
3088  *              with a different codec.
3089  *              If NULL, then the codec-specific defaults won't be initialized,
3090  *              which may result in suboptimal default settings (this is
3091  *              important mainly for encoders, e.g. libx264).
3092  *
3093  * @return An AVCodecContext filled with default values or NULL on failure.
3094  * @see avcodec_get_context_defaults
3095  */
3096 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3097
3098 /**
3099  * Set the fields of the given AVCodecContext to default values corresponding
3100  * to the given codec (defaults may be codec-dependent).
3101  *
3102  * Do not call this function if a non-NULL codec has been passed
3103  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3104  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3105  * different codec on this AVCodecContext.
3106  */
3107 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3108
3109 /**
3110  * Get the AVClass for AVCodecContext. It can be used in combination with
3111  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3112  *
3113  * @see av_opt_find().
3114  */
3115 const AVClass *avcodec_get_class(void);
3116
3117 /**
3118  * Copy the settings of the source AVCodecContext into the destination
3119  * AVCodecContext. The resulting destination codec context will be
3120  * unopened, i.e. you are required to call avcodec_open2() before you
3121  * can use this AVCodecContext to decode/encode video/audio data.
3122  *
3123  * @param dest target codec context, should be initialized with
3124  *             avcodec_alloc_context3(), but otherwise uninitialized
3125  * @param src source codec context
3126  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3127  */
3128 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3129
3130 #if FF_API_AVFRAME_LAVC
3131 /**
3132  * @deprecated use av_frame_alloc()
3133  */
3134 attribute_deprecated
3135 AVFrame *avcodec_alloc_frame(void);
3136
3137 /**
3138  * Set the fields of the given AVFrame to default values.
3139  *
3140  * @param frame The AVFrame of which the fields should be set to default values.
3141  *
3142  * @deprecated use av_frame_unref()
3143  */
3144 attribute_deprecated
3145 void avcodec_get_frame_defaults(AVFrame *frame);
3146
3147 /**
3148  * Free the frame and any dynamically allocated objects in it,
3149  * e.g. extended_data.
3150  *
3151  * @param frame frame to be freed. The pointer will be set to NULL.
3152  *
3153  * @warning this function does NOT free the data buffers themselves
3154  * (it does not know how, since they might have been allocated with
3155  *  a custom get_buffer()).
3156  *
3157  * @deprecated use av_frame_free()
3158  */
3159 attribute_deprecated
3160 void avcodec_free_frame(AVFrame **frame);
3161 #endif
3162
3163 /**
3164  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3165  * function the context has to be allocated with avcodec_alloc_context3().
3166  *
3167  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3168  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3169  * retrieving a codec.
3170  *
3171  * @warning This function is not thread safe!
3172  *
3173  * @code
3174  * avcodec_register_all();
3175  * av_dict_set(&opts, "b", "2.5M", 0);
3176  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3177  * if (!codec)
3178  *     exit(1);
3179  *
3180  * context = avcodec_alloc_context3(codec);
3181  *
3182  * if (avcodec_open2(context, codec, opts) < 0)
3183  *     exit(1);
3184  * @endcode
3185  *
3186  * @param avctx The context to initialize.
3187  * @param codec The codec to open this context for. If a non-NULL codec has been
3188  *              previously passed to avcodec_alloc_context3() or
3189  *              avcodec_get_context_defaults3() for this context, then this
3190  *              parameter MUST be either NULL or equal to the previously passed
3191  *              codec.
3192  * @param options A dictionary filled with AVCodecContext and codec-private options.
3193  *                On return this object will be filled with options that were not found.
3194  *
3195  * @return zero on success, a negative value on error
3196  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3197  *      av_dict_set(), av_opt_find().
3198  */
3199 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3200
3201 /**
3202  * Close a given AVCodecContext and free all the data associated with it
3203  * (but not the AVCodecContext itself).
3204  *
3205  * Calling this function on an AVCodecContext that hasn't been opened will free
3206  * the codec-specific data allocated in avcodec_alloc_context3() /
3207  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3208  * do nothing.
3209  */
3210 int avcodec_close(AVCodecContext *avctx);
3211
3212 /**
3213  * Free all allocated data in the given subtitle struct.
3214  *
3215  * @param sub AVSubtitle to free.
3216  */
3217 void avsubtitle_free(AVSubtitle *sub);
3218
3219 /**
3220  * @}
3221  */
3222
3223 /**
3224  * @addtogroup lavc_packet
3225  * @{
3226  */
3227
3228 #if FF_API_DESTRUCT_PACKET
3229 /**
3230  * Default packet destructor.
3231  * @deprecated use the AVBuffer API instead
3232  */
3233 attribute_deprecated
3234 void av_destruct_packet(AVPacket *pkt);
3235 #endif
3236
3237 /**
3238  * Initialize optional fields of a packet with default values.
3239  *
3240  * Note, this does not touch the data and size members, which have to be
3241  * initialized separately.
3242  *
3243  * @param pkt packet
3244  */
3245 void av_init_packet(AVPacket *pkt);
3246
3247 /**
3248  * Allocate the payload of a packet and initialize its fields with
3249  * default values.
3250  *
3251  * @param pkt packet
3252  * @param size wanted payload size
3253  * @return 0 if OK, AVERROR_xxx otherwise
3254  */
3255 int av_new_packet(AVPacket *pkt, int size);
3256
3257 /**
3258  * Reduce packet size, correctly zeroing padding
3259  *
3260  * @param pkt packet
3261  * @param size new size
3262  */
3263 void av_shrink_packet(AVPacket *pkt, int size);
3264
3265 /**
3266  * Increase packet size, correctly zeroing padding
3267  *
3268  * @param pkt packet
3269  * @param grow_by number of bytes by which to increase the size of the packet
3270  */
3271 int av_grow_packet(AVPacket *pkt, int grow_by);
3272
3273 /**
3274  * Initialize a reference-counted packet from av_malloc()ed data.
3275  *
3276  * @param pkt packet to be initialized. This function will set the data, size,
3277  *        buf and destruct fields, all others are left untouched.
3278  * @param data Data allocated by av_malloc() to be used as packet data. If this
3279  *        function returns successfully, the data is owned by the underlying AVBuffer.
3280  *        The caller may not access the data through other means.
3281  * @param size size of data in bytes, without the padding. I.e. the full buffer
3282  *        size is assumed to be size + FF_INPUT_BUFFER_PADDING_SIZE.
3283  *
3284  * @return 0 on success, a negative AVERROR on error
3285  */
3286 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3287
3288 /**
3289  * @warning This is a hack - the packet memory allocation stuff is broken. The
3290  * packet is allocated if it was not really allocated.
3291  */
3292 int av_dup_packet(AVPacket *pkt);
3293
3294 /**
3295  * Free a packet.
3296  *
3297  * @param pkt packet to free
3298  */
3299 void av_free_packet(AVPacket *pkt);
3300
3301 /**
3302  * Allocate new information of a packet.
3303  *
3304  * @param pkt packet
3305  * @param type side information type
3306  * @param size side information size
3307  * @return pointer to fresh allocated data or NULL otherwise
3308  */
3309 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3310                                  int size);
3311
3312 /**
3313  * Shrink the already allocated side data buffer
3314  *
3315  * @param pkt packet
3316  * @param type side information type
3317  * @param size new side information size
3318  * @return 0 on success, < 0 on failure
3319  */
3320 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3321                                int size);
3322
3323 /**
3324  * Get side information from packet.
3325  *
3326  * @param pkt packet
3327  * @param type desired side information type
3328  * @param size pointer for side information size to store (optional)
3329  * @return pointer to data if present or NULL otherwise
3330  */
3331 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3332                                  int *size);
3333
3334 /**
3335  * Convenience function to free all the side data stored.
3336  * All the other fields stay untouched.
3337  *
3338  * @param pkt packet
3339  */
3340 void av_packet_free_side_data(AVPacket *pkt);
3341
3342 /**
3343  * Setup a new reference to the data described by a given packet
3344  *
3345  * If src is reference-counted, setup dst as a new reference to the
3346  * buffer in src. Otherwise allocate a new buffer in dst and copy the
3347  * data from src into it.
3348  *
3349  * All the other fields are copied from src.
3350  *
3351  * @see av_packet_unref
3352  *
3353  * @param dst Destination packet
3354  * @param src Source packet
3355  *
3356  * @return 0 on success, a negative AVERROR on error.
3357  */
3358 int av_packet_ref(AVPacket *dst, AVPacket *src);
3359
3360 /**
3361  * Wipe the packet.
3362  *
3363  * Unreference the buffer referenced by the packet and reset the
3364  * remaining packet fields to their default values.
3365  *
3366  * @param pkt The packet to be unreferenced.
3367  */
3368 void av_packet_unref(AVPacket *pkt);
3369
3370 /**
3371  * Move every field in src to dst and reset src.
3372  *
3373  * @see av_packet_unref
3374  *
3375  * @param src Source packet, will be reset
3376  * @param dst Destination packet
3377  */
3378 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
3379
3380 /**
3381  * Copy only "properties" fields from src to dst.
3382  *
3383  * Properties for the purpose of this function are all the fields
3384  * beside those related to the packet data (buf, data, size)
3385  *
3386  * @param dst Destination packet
3387  * @param src Source packet
3388  *
3389  * @return 0 on success AVERROR on failure.
3390  *
3391  */
3392 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
3393
3394 /**
3395  * @}
3396  */
3397
3398 /**
3399  * @addtogroup lavc_decoding
3400  * @{
3401  */
3402
3403 /**
3404  * Find a registered decoder with a matching codec ID.
3405  *
3406  * @param id AVCodecID of the requested decoder
3407  * @return A decoder if one was found, NULL otherwise.
3408  */
3409 AVCodec *avcodec_find_decoder(enum AVCodecID id);
3410
3411 /**
3412  * Find a registered decoder with the specified name.
3413  *
3414  * @param name name of the requested decoder
3415  * @return A decoder if one was found, NULL otherwise.
3416  */
3417 AVCodec *avcodec_find_decoder_by_name(const char *name);
3418
3419 #if FF_API_GET_BUFFER
3420 attribute_deprecated int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3421 attribute_deprecated void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3422 attribute_deprecated int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3423 #endif
3424
3425 /**
3426  * The default callback for AVCodecContext.get_buffer2(). It is made public so
3427  * it can be called by custom get_buffer2() implementations for decoders without
3428  * CODEC_CAP_DR1 set.
3429  */
3430 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
3431
3432 #if FF_API_EMU_EDGE
3433 /**
3434  * Return the amount of padding in pixels which the get_buffer callback must
3435  * provide around the edge of the image for codecs which do not have the
3436  * CODEC_FLAG_EMU_EDGE flag.
3437  *
3438  * @return Required padding in pixels.
3439  *
3440  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
3441  * needed
3442  */
3443 attribute_deprecated
3444 unsigned avcodec_get_edge_width(void);
3445 #endif
3446
3447 /**
3448  * Modify width and height values so that they will result in a memory
3449  * buffer that is acceptable for the codec if you do not use any horizontal
3450  * padding.
3451  *
3452  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3453  */
3454 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3455
3456 /**
3457  * Modify width and height values so that they will result in a memory
3458  * buffer that is acceptable for the codec if you also ensure that all
3459  * line sizes are a multiple of the respective linesize_align[i].
3460  *
3461  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3462  */
3463 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3464                                int linesize_align[AV_NUM_DATA_POINTERS]);
3465
3466 /**
3467  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3468  *
3469  * Some decoders may support multiple frames in a single AVPacket. Such
3470  * decoders would then just decode the first frame and the return value would be
3471  * less than the packet size. In this case, avcodec_decode_audio4 has to be
3472  * called again with an AVPacket containing the remaining data in order to
3473  * decode the second frame, etc...  Even if no frames are returned, the packet
3474  * needs to be fed to the decoder with remaining data until it is completely
3475  * consumed or an error occurs.
3476  *
3477  * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
3478  * and output. This means that for some packets they will not immediately
3479  * produce decoded output and need to be flushed at the end of decoding to get
3480  * all the decoded data. Flushing is done by calling this function with packets
3481  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
3482  * returning samples. It is safe to flush even those decoders that are not
3483  * marked with CODEC_CAP_DELAY, then no samples will be returned.
3484  *
3485  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3486  *          larger than the actual read bytes because some optimized bitstream
3487  *          readers read 32 or 64 bits at once and could read over the end.
3488  *
3489  * @param      avctx the codec context
3490  * @param[out] frame The AVFrame in which to store decoded audio samples.
3491  *                   The decoder will allocate a buffer for the decoded frame by
3492  *                   calling the AVCodecContext.get_buffer2() callback.
3493  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
3494  *                   reference counted and the returned reference belongs to the
3495  *                   caller. The caller must release the frame using av_frame_unref()
3496  *                   when the frame is no longer needed. The caller may safely write
3497  *                   to the frame if av_frame_is_writable() returns 1.
3498  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
3499  *                   reference belongs to the decoder and is valid only until the
3500  *                   next call to this function or until closing or flushing the
3501  *                   decoder. The caller may not write to it.
3502  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3503  *                           non-zero. Note that this field being set to zero
3504  *                           does not mean that an error has occurred. For
3505  *                           decoders with CODEC_CAP_DELAY set, no given decode
3506  *                           call is guaranteed to produce a frame.
3507  * @param[in]  avpkt The input AVPacket containing the input buffer.
3508  *                   At least avpkt->data and avpkt->size should be set. Some
3509  *                   decoders might also require additional fields to be set.
3510  * @return A negative error code is returned if an error occurred during
3511  *         decoding, otherwise the number of bytes consumed from the input
3512  *         AVPacket is returned.
3513  */
3514 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3515                           int *got_frame_ptr, AVPacket *avpkt);
3516
3517 /**
3518  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3519  * Some decoders may support multiple frames in a single AVPacket, such
3520  * decoders would then just decode the first frame.
3521  *
3522  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3523  * the actual read bytes because some optimized bitstream readers read 32 or 64
3524  * bits at once and could read over the end.
3525  *
3526  * @warning The end of the input buffer buf should be set to 0 to ensure that
3527  * no overreading happens for damaged MPEG streams.
3528  *
3529  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3530  * between input and output, these need to be fed with avpkt->data=NULL,
3531  * avpkt->size=0 at the end to return the remaining frames.
3532  *
3533  * @param avctx the codec context
3534  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3535  *             Use av_frame_alloc() to get an AVFrame. The codec will
3536  *             allocate memory for the actual bitmap by calling the
3537  *             AVCodecContext.get_buffer2() callback.
3538  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
3539  *             reference counted and the returned reference belongs to the
3540  *             caller. The caller must release the frame using av_frame_unref()
3541  *             when the frame is no longer needed. The caller may safely write
3542  *             to the frame if av_frame_is_writable() returns 1.
3543  *             When AVCodecContext.refcounted_frames is set to 0, the returned
3544  *             reference belongs to the decoder and is valid only until the
3545  *             next call to this function or until closing or flushing the
3546  *             decoder. The caller may not write to it.
3547  *
3548  * @param[in] avpkt The input AVpacket containing the input buffer.
3549  *            You can create such packet with av_init_packet() and by then setting
3550  *            data and size, some decoders might in addition need other fields like
3551  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3552  *            fields possible.
3553  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3554  * @return On error a negative value is returned, otherwise the number of bytes
3555  * used or zero if no frame could be decompressed.
3556  */
3557 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3558                          int *got_picture_ptr,
3559                          AVPacket *avpkt);
3560
3561 /**
3562  * Decode a subtitle message.
3563  * Return a negative value on error, otherwise return the number of bytes used.
3564  * If no subtitle could be decompressed, got_sub_ptr is zero.
3565  * Otherwise, the subtitle is stored in *sub.
3566  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3567  * simplicity, because the performance difference is expect to be negligible
3568  * and reusing a get_buffer written for video codecs would probably perform badly
3569  * due to a potentially very different allocation pattern.
3570  *
3571  * @param avctx the codec context
3572  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3573                    freed with avsubtitle_free if *got_sub_ptr is set.
3574  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3575  * @param[in] avpkt The input AVPacket containing the input buffer.
3576  */
3577 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3578                             int *got_sub_ptr,
3579                             AVPacket *avpkt);
3580
3581 /**
3582  * @defgroup lavc_parsing Frame parsing
3583  * @{
3584  */
3585
3586 enum AVPictureStructure {
3587     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
3588     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
3589     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
3590     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
3591 };
3592
3593 typedef struct AVCodecParserContext {
3594     void *priv_data;
3595     struct AVCodecParser *parser;
3596     int64_t frame_offset; /* offset of the current frame */
3597     int64_t cur_offset; /* current offset
3598                            (incremented by each av_parser_parse()) */
3599     int64_t next_frame_offset; /* offset of the next frame */
3600     /* video info */
3601     int pict_type; /* XXX: Put it back in AVCodecContext. */
3602     /**
3603      * This field is used for proper frame duration computation in lavf.
3604      * It signals, how much longer the frame duration of the current frame
3605      * is compared to normal frame duration.
3606      *
3607      * frame_duration = (1 + repeat_pict) * time_base
3608      *
3609      * It is used by codecs like H.264 to display telecined material.
3610      */
3611     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3612     int64_t pts;     /* pts of the current frame */
3613     int64_t dts;     /* dts of the current frame */
3614
3615     /* private data */
3616     int64_t last_pts;
3617     int64_t last_dts;
3618     int fetch_timestamp;
3619
3620 #define AV_PARSER_PTS_NB 4
3621     int cur_frame_start_index;
3622     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3623     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3624     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3625
3626     int flags;
3627 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3628 #define PARSER_FLAG_ONCE                      0x0002
3629 /// Set if the parser has a valid file offset
3630 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
3631
3632     int64_t offset;      ///< byte offset from starting packet start
3633     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3634
3635     /**
3636      * Set by parser to 1 for key frames and 0 for non-key frames.
3637      * It is initialized to -1, so if the parser doesn't set this flag,
3638      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3639      * will be used.
3640      */
3641     int key_frame;
3642
3643     /**
3644      * Time difference in stream time base units from the pts of this
3645      * packet to the point at which the output from the decoder has converged
3646      * independent from the availability of previous frames. That is, the
3647      * frames are virtually identical no matter if decoding started from
3648      * the very first frame or from this keyframe.
3649      * Is AV_NOPTS_VALUE if unknown.
3650      * This field is not the display duration of the current frame.
3651      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3652      * set.
3653      *
3654      * The purpose of this field is to allow seeking in streams that have no
3655      * keyframes in the conventional sense. It corresponds to the
3656      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3657      * essential for some types of subtitle streams to ensure that all
3658      * subtitles are correctly displayed after seeking.
3659      */
3660     int64_t convergence_duration;
3661
3662     // Timestamp generation support:
3663     /**
3664      * Synchronization point for start of timestamp generation.
3665      *
3666      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3667      * (default).
3668      *
3669      * For example, this corresponds to presence of H.264 buffering period
3670      * SEI message.
3671      */
3672     int dts_sync_point;
3673
3674     /**
3675      * Offset of the current timestamp against last timestamp sync point in
3676      * units of AVCodecContext.time_base.
3677      *
3678      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3679      * contain a valid timestamp offset.
3680      *
3681      * Note that the timestamp of sync point has usually a nonzero
3682      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3683      * the next frame after timestamp sync point will be usually 1.
3684      *
3685      * For example, this corresponds to H.264 cpb_removal_delay.
3686      */
3687     int dts_ref_dts_delta;
3688
3689     /**
3690      * Presentation delay of current frame in units of AVCodecContext.time_base.
3691      *
3692      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3693      * contain valid non-negative timestamp delta (presentation time of a frame
3694      * must not lie in the past).
3695      *
3696      * This delay represents the difference between decoding and presentation
3697      * time of the frame.
3698      *
3699      * For example, this corresponds to H.264 dpb_output_delay.
3700      */
3701     int pts_dts_delta;
3702
3703     /**
3704      * Position of the packet in file.
3705      *
3706      * Analogous to cur_frame_pts/dts
3707      */
3708     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3709
3710     /**
3711      * Byte position of currently parsed frame in stream.
3712      */
3713     int64_t pos;
3714
3715     /**
3716      * Previous frame byte position.
3717      */
3718     int64_t last_pos;
3719
3720     /**
3721      * Duration of the current frame.
3722      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
3723      * For all other types, this is in units of AVCodecContext.time_base.
3724      */
3725     int duration;
3726
3727     enum AVFieldOrder field_order;
3728
3729     /**
3730      * Indicate whether a picture is coded as a frame, top field or bottom field.
3731      *
3732      * For example, H.264 field_pic_flag equal to 0 corresponds to
3733      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
3734      * equal to 1 and bottom_field_flag equal to 0 corresponds to
3735      * AV_PICTURE_STRUCTURE_TOP_FIELD.
3736      */
3737     enum AVPictureStructure picture_structure;
3738
3739     /**
3740      * Picture number incremented in presentation or output order.
3741      * This field may be reinitialized at the first picture of a new sequence.
3742      *
3743      * For example, this corresponds to H.264 PicOrderCnt.
3744      */
3745     int output_picture_number;
3746 } AVCodecParserContext;
3747
3748 typedef struct AVCodecParser {
3749     int codec_ids[5]; /* several codec IDs are permitted */
3750     int priv_data_size;
3751     int (*parser_init)(AVCodecParserContext *s);
3752     int (*parser_parse)(AVCodecParserContext *s,
3753                         AVCodecContext *avctx,
3754                         const uint8_t **poutbuf, int *poutbuf_size,
3755                         const uint8_t *buf, int buf_size);
3756     void (*parser_close)(AVCodecParserContext *s);
3757     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3758     struct AVCodecParser *next;
3759 } AVCodecParser;
3760
3761 AVCodecParser *av_parser_next(AVCodecParser *c);
3762
3763 void av_register_codec_parser(AVCodecParser *parser);
3764 AVCodecParserContext *av_parser_init(int codec_id);
3765
3766 /**
3767  * Parse a packet.
3768  *
3769  * @param s             parser context.
3770  * @param avctx         codec context.
3771  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3772  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3773  * @param buf           input buffer.
3774  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
3775  * @param pts           input presentation timestamp.
3776  * @param dts           input decoding timestamp.
3777  * @param pos           input byte position in stream.
3778  * @return the number of bytes of the input bitstream used.
3779  *
3780  * Example:
3781  * @code
3782  *   while(in_len){
3783  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
3784  *                                        in_data, in_len,
3785  *                                        pts, dts, pos);
3786  *       in_data += len;
3787  *       in_len  -= len;
3788  *
3789  *       if(size)
3790  *          decode_frame(data, size);
3791  *   }
3792  * @endcode
3793  */
3794 int av_parser_parse2(AVCodecParserContext *s,
3795                      AVCodecContext *avctx,
3796                      uint8_t **poutbuf, int *poutbuf_size,
3797                      const uint8_t *buf, int buf_size,
3798                      int64_t pts, int64_t dts,
3799                      int64_t pos);
3800
3801 /**
3802  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
3803  * @deprecated use AVBitstreamFilter
3804  */
3805 int av_parser_change(AVCodecParserContext *s,
3806                      AVCodecContext *avctx,
3807                      uint8_t **poutbuf, int *poutbuf_size,
3808                      const uint8_t *buf, int buf_size, int keyframe);
3809 void av_parser_close(AVCodecParserContext *s);
3810
3811 /**
3812  * @}
3813  * @}
3814  */
3815
3816 /**
3817  * @addtogroup lavc_encoding
3818  * @{
3819  */
3820
3821 /**
3822  * Find a registered encoder with a matching codec ID.
3823  *
3824  * @param id AVCodecID of the requested encoder
3825  * @return An encoder if one was found, NULL otherwise.
3826  */
3827 AVCodec *avcodec_find_encoder(enum AVCodecID id);
3828
3829 /**
3830  * Find a registered encoder with the specified name.
3831  *
3832  * @param name name of the requested encoder
3833  * @return An encoder if one was found, NULL otherwise.
3834  */
3835 AVCodec *avcodec_find_encoder_by_name(const char *name);
3836
3837 /**
3838  * Encode a frame of audio.
3839  *
3840  * Takes input samples from frame and writes the next output packet, if
3841  * available, to avpkt. The output packet does not necessarily contain data for
3842  * the most recent frame, as encoders can delay, split, and combine input frames
3843  * internally as needed.
3844  *
3845  * @param avctx     codec context
3846  * @param avpkt     output AVPacket.
3847  *                  The user can supply an output buffer by setting
3848  *                  avpkt->data and avpkt->size prior to calling the
3849  *                  function, but if the size of the user-provided data is not
3850  *                  large enough, encoding will fail. All other AVPacket fields
3851  *                  will be reset by the encoder using av_init_packet(). If
3852  *                  avpkt->data is NULL, the encoder will allocate it.
3853  *                  The encoder will set avpkt->size to the size of the
3854  *                  output packet.
3855  *
3856  *                  If this function fails or produces no output, avpkt will be
3857  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
3858  *                  called to free the user supplied buffer).
3859  * @param[in] frame AVFrame containing the raw audio data to be encoded.
3860  *                  May be NULL when flushing an encoder that has the
3861  *                  CODEC_CAP_DELAY capability set.
3862  *                  If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3863  *                  can have any number of samples.
3864  *                  If it is not set, frame->nb_samples must be equal to
3865  *                  avctx->frame_size for all frames except the last.
3866  *                  The final frame may be smaller than avctx->frame_size.
3867  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3868  *                            output packet is non-empty, and to 0 if it is
3869  *                            empty. If the function returns an error, the
3870  *                            packet can be assumed to be invalid, and the
3871  *                            value of got_packet_ptr is undefined and should
3872  *                            not be used.
3873  * @return          0 on success, negative error code on failure
3874  */
3875 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3876                           const AVFrame *frame, int *got_packet_ptr);
3877
3878 /**
3879  * Encode a frame of video.
3880  *
3881  * Takes input raw video data from frame and writes the next output packet, if
3882  * available, to avpkt. The output packet does not necessarily contain data for
3883  * the most recent frame, as encoders can delay and reorder input frames
3884  * internally as needed.
3885  *
3886  * @param avctx     codec context
3887  * @param avpkt     output AVPacket.
3888  *                  The user can supply an output buffer by setting
3889  *                  avpkt->data and avpkt->size prior to calling the
3890  *                  function, but if the size of the user-provided data is not
3891  *                  large enough, encoding will fail. All other AVPacket fields
3892  *                  will be reset by the encoder using av_init_packet(). If
3893  *                  avpkt->data is NULL, the encoder will allocate it.
3894  *                  The encoder will set avpkt->size to the size of the
3895  *                  output packet. The returned data (if any) belongs to the
3896  *                  caller, he is responsible for freeing it.
3897  *
3898  *                  If this function fails or produces no output, avpkt will be
3899  *                  freed using av_free_packet() (i.e. avpkt->destruct will be
3900  *                  called to free the user supplied buffer).
3901  * @param[in] frame AVFrame containing the raw video data to be encoded.
3902  *                  May be NULL when flushing an encoder that has the
3903  *                  CODEC_CAP_DELAY capability set.
3904  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3905  *                            output packet is non-empty, and to 0 if it is
3906  *                            empty. If the function returns an error, the
3907  *                            packet can be assumed to be invalid, and the
3908  *                            value of got_packet_ptr is undefined and should
3909  *                            not be used.
3910  * @return          0 on success, negative error code on failure
3911  */
3912 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
3913                           const AVFrame *frame, int *got_packet_ptr);
3914
3915 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3916                             const AVSubtitle *sub);
3917
3918
3919 /**
3920  * @}
3921  */
3922
3923 /**
3924  * @addtogroup lavc_picture
3925  * @{
3926  */
3927
3928 /**
3929  * Allocate memory for a picture.  Call avpicture_free() to free it.
3930  *
3931  * @see avpicture_fill()
3932  *
3933  * @param picture the picture to be filled in
3934  * @param pix_fmt the format of the picture
3935  * @param width the width of the picture
3936  * @param height the height of the picture
3937  * @return zero if successful, a negative value if not
3938  */
3939 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
3940
3941 /**
3942  * Free a picture previously allocated by avpicture_alloc().
3943  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3944  * itself is not.
3945  *
3946  * @param picture the AVPicture to be freed
3947  */
3948 void avpicture_free(AVPicture *picture);
3949
3950 /**
3951  * Fill in the AVPicture fields.
3952  * The fields of the given AVPicture are filled in by using the 'ptr' address
3953  * which points to the image data buffer. Depending on the specified picture
3954  * format, one or multiple image data pointers and line sizes will be set.
3955  * If a planar format is specified, several pointers will be set pointing to
3956  * the different picture planes and the line sizes of the different planes
3957  * will be stored in the lines_sizes array.
3958  * Call with ptr == NULL to get the required size for the ptr buffer.
3959  *
3960  * To allocate the buffer and fill in the AVPicture fields in one call,
3961  * use avpicture_alloc().
3962  *
3963  * @param picture AVPicture whose fields are to be filled in
3964  * @param ptr Buffer which will contain or contains the actual image data
3965  * @param pix_fmt The format in which the picture data is stored.
3966  * @param width the width of the image in pixels
3967  * @param height the height of the image in pixels
3968  * @return size of the image data in bytes
3969  */
3970 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3971                    enum AVPixelFormat pix_fmt, int width, int height);
3972
3973 /**
3974  * Copy pixel data from an AVPicture into a buffer.
3975  * The data is stored compactly, without any gaps for alignment or padding
3976  * which may be applied by avpicture_fill().
3977  *
3978  * @see avpicture_get_size()
3979  *
3980  * @param[in] src AVPicture containing image data
3981  * @param[in] pix_fmt The format in which the picture data is stored.
3982  * @param[in] width the width of the image in pixels.
3983  * @param[in] height the height of the image in pixels.
3984  * @param[out] dest A buffer into which picture data will be copied.
3985  * @param[in] dest_size The size of 'dest'.
3986  * @return The number of bytes written to dest, or a negative value (error code) on error.
3987  */
3988 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
3989                      int width, int height,
3990                      unsigned char *dest, int dest_size);
3991
3992 /**
3993  * Calculate the size in bytes that a picture of the given width and height
3994  * would occupy if stored in the given picture format.
3995  * Note that this returns the size of a compact representation as generated
3996  * by avpicture_layout(), which can be smaller than the size required for e.g.
3997  * avpicture_fill().
3998  *
3999  * @param pix_fmt the given picture format
4000  * @param width the width of the image
4001  * @param height the height of the image
4002  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
4003  */
4004 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4005
4006 #if FF_API_DEINTERLACE
4007 /**
4008  *  deinterlace - if not supported return -1
4009  *
4010  * @deprecated - use yadif (in libavfilter) instead
4011  */
4012 attribute_deprecated
4013 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
4014                           enum AVPixelFormat pix_fmt, int width, int height);
4015 #endif
4016 /**
4017  * Copy image src to dst. Wraps av_picture_data_copy() above.
4018  */
4019 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4020                      enum AVPixelFormat pix_fmt, int width, int height);
4021
4022 /**
4023  * Crop image top and left side.
4024  */
4025 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4026                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
4027
4028 /**
4029  * Pad image.
4030  */
4031 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4032             int padtop, int padbottom, int padleft, int padright, int *color);
4033
4034 /**
4035  * @}
4036  */
4037
4038 /**
4039  * @defgroup lavc_misc Utility functions
4040  * @ingroup libavc
4041  *
4042  * Miscellaneous utility functions related to both encoding and decoding
4043  * (or neither).
4044  * @{
4045  */
4046
4047 /**
4048  * @defgroup lavc_misc_pixfmt Pixel formats
4049  *
4050  * Functions for working with pixel formats.
4051  * @{
4052  */
4053
4054 /**
4055  * @deprecated Use av_pix_fmt_get_chroma_sub_sample
4056  */
4057
4058 void attribute_deprecated avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4059
4060 /**
4061  * Return a value representing the fourCC code associated to the
4062  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4063  * found.
4064  */
4065 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4066
4067 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
4068 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
4069 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
4070 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
4071 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
4072 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4073
4074 /**
4075  * Compute what kind of losses will occur when converting from one specific
4076  * pixel format to another.
4077  * When converting from one pixel format to another, information loss may occur.
4078  * For example, when converting from RGB24 to GRAY, the color information will
4079  * be lost. Similarly, other losses occur when converting from some formats to
4080  * other formats. These losses can involve loss of chroma, but also loss of
4081  * resolution, loss of color depth, loss due to the color space conversion, loss
4082  * of the alpha bits or loss due to color quantization.
4083  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4084  * which will occur when converting from one pixel format to another.
4085  *
4086  * @param[in] dst_pix_fmt destination pixel format
4087  * @param[in] src_pix_fmt source pixel format
4088  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4089  * @return Combination of flags informing you what kind of losses will occur.
4090  */
4091 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4092                              int has_alpha);
4093
4094 /**
4095  * Find the best pixel format to convert to given a certain source pixel
4096  * format.  When converting from one pixel format to another, information loss
4097  * may occur.  For example, when converting from RGB24 to GRAY, the color
4098  * information will be lost. Similarly, other losses occur when converting from
4099  * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4100  * the given pixel formats should be used to suffer the least amount of loss.
4101  * The pixel formats from which it chooses one, are determined by the
4102  * pix_fmt_list parameter.
4103  *
4104  *
4105  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4106  * @param[in] src_pix_fmt source pixel format
4107  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4108  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4109  * @return The best pixel format to convert to or -1 if none was found.
4110  */
4111 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4112                                               enum AVPixelFormat src_pix_fmt,
4113                                               int has_alpha, int *loss_ptr);
4114
4115 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4116
4117 /**
4118  * @}
4119  */
4120
4121 #if FF_API_SET_DIMENSIONS
4122 /**
4123  * @deprecated this function is not supposed to be used from outside of lavc
4124  */
4125 attribute_deprecated
4126 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
4127 #endif
4128
4129 /**
4130  * Put a string representing the codec tag codec_tag in buf.
4131  *
4132  * @param buf       buffer to place codec tag in
4133  * @param buf_size size in bytes of buf
4134  * @param codec_tag codec tag to assign
4135  * @return the length of the string that would have been generated if
4136  * enough space had been available, excluding the trailing null
4137  */
4138 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4139
4140 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4141
4142 /**
4143  * Return a name for the specified profile, if available.
4144  *
4145  * @param codec the codec that is searched for the given profile
4146  * @param profile the profile value for which a name is requested
4147  * @return A name for the profile if found, NULL otherwise.
4148  */
4149 const char *av_get_profile_name(const AVCodec *codec, int profile);
4150
4151 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4152 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4153 //FIXME func typedef
4154
4155 /**
4156  * Fill audio frame data and linesize.
4157  * AVFrame extended_data channel pointers are allocated if necessary for
4158  * planar audio.
4159  *
4160  * @param frame       the AVFrame
4161  *                    frame->nb_samples must be set prior to calling the
4162  *                    function. This function fills in frame->data,
4163  *                    frame->extended_data, frame->linesize[0].
4164  * @param nb_channels channel count
4165  * @param sample_fmt  sample format
4166  * @param buf         buffer to use for frame data
4167  * @param buf_size    size of buffer
4168  * @param align       plane size sample alignment (0 = default)
4169  * @return            0 on success, negative error code on failure
4170  */
4171 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4172                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4173                              int buf_size, int align);
4174
4175 /**
4176  * Reset the internal decoder state / flush internal buffers. Should be called
4177  * e.g. when seeking or when switching to a different stream.
4178  *
4179  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
4180  * this invalidates the frames previously returned from the decoder. When
4181  * refcounted frames are used, the decoder just releases any references it might
4182  * keep internally, but the caller's reference remains valid.
4183  */
4184 void avcodec_flush_buffers(AVCodecContext *avctx);
4185
4186 /**
4187  * Return codec bits per sample.
4188  *
4189  * @param[in] codec_id the codec
4190  * @return Number of bits per sample or zero if unknown for the given codec.
4191  */
4192 int av_get_bits_per_sample(enum AVCodecID codec_id);
4193
4194 /**
4195  * Return codec bits per sample.
4196  * Only return non-zero if the bits per sample is exactly correct, not an
4197  * approximation.
4198  *
4199  * @param[in] codec_id the codec
4200  * @return Number of bits per sample or zero if unknown for the given codec.
4201  */
4202 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
4203
4204 /**
4205  * Return audio frame duration.
4206  *
4207  * @param avctx        codec context
4208  * @param frame_bytes  size of the frame, or 0 if unknown
4209  * @return             frame duration, in samples, if known. 0 if not able to
4210  *                     determine.
4211  */
4212 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
4213
4214
4215 typedef struct AVBitStreamFilterContext {
4216     void *priv_data;
4217     struct AVBitStreamFilter *filter;
4218     AVCodecParserContext *parser;
4219     struct AVBitStreamFilterContext *next;
4220 } AVBitStreamFilterContext;
4221
4222
4223 typedef struct AVBitStreamFilter {
4224     const char *name;
4225     int priv_data_size;
4226     int (*filter)(AVBitStreamFilterContext *bsfc,
4227                   AVCodecContext *avctx, const char *args,
4228                   uint8_t **poutbuf, int *poutbuf_size,
4229                   const uint8_t *buf, int buf_size, int keyframe);
4230     void (*close)(AVBitStreamFilterContext *bsfc);
4231     struct AVBitStreamFilter *next;
4232 } AVBitStreamFilter;
4233
4234 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4235 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4236 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4237                                AVCodecContext *avctx, const char *args,
4238                                uint8_t **poutbuf, int *poutbuf_size,
4239                                const uint8_t *buf, int buf_size, int keyframe);
4240 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4241
4242 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4243
4244 /* memory */
4245
4246 /**
4247  * Allocate a buffer with padding, reusing the given one if large enough.
4248  *
4249  * Same behaviour av_fast_malloc but the buffer has additional
4250  * FF_INPUT_PADDING_SIZE at the end which will always memset to 0.
4251  *
4252  */
4253 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4254
4255 /**
4256  * Encode extradata length to a buffer. Used by xiph codecs.
4257  *
4258  * @param s buffer to write to; must be at least (v/255+1) bytes long
4259  * @param v size of extradata in bytes
4260  * @return number of bytes written to the buffer.
4261  */
4262 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4263
4264 #if FF_API_MISSING_SAMPLE
4265 /**
4266  * Log a generic warning message about a missing feature. This function is
4267  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4268  * only, and would normally not be used by applications.
4269  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4270  * a pointer to an AVClass struct
4271  * @param[in] feature string containing the name of the missing feature
4272  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4273  * If want_sample is non-zero, additional verbage will be added to the log
4274  * message which tells the user how to report samples to the development
4275  * mailing list.
4276  * @deprecated Use avpriv_report_missing_feature() instead.
4277  */
4278 attribute_deprecated
4279 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4280
4281 /**
4282  * Log a generic warning message asking for a sample. This function is
4283  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4284  * only, and would normally not be used by applications.
4285  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4286  * a pointer to an AVClass struct
4287  * @param[in] msg string containing an optional message, or NULL if no message
4288  * @deprecated Use avpriv_request_sample() instead.
4289  */
4290 attribute_deprecated
4291 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4292 #endif /* FF_API_MISSING_SAMPLE */
4293
4294 /**
4295  * Register the hardware accelerator hwaccel.
4296  */
4297 void av_register_hwaccel(AVHWAccel *hwaccel);
4298
4299 /**
4300  * If hwaccel is NULL, returns the first registered hardware accelerator,
4301  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4302  * after hwaccel, or NULL if hwaccel is the last one.
4303  */
4304 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4305
4306
4307 /**
4308  * Lock operation used by lockmgr
4309  */
4310 enum AVLockOp {
4311   AV_LOCK_CREATE,  ///< Create a mutex
4312   AV_LOCK_OBTAIN,  ///< Lock the mutex
4313   AV_LOCK_RELEASE, ///< Unlock the mutex
4314   AV_LOCK_DESTROY, ///< Free mutex resources
4315 };
4316
4317 /**
4318  * Register a user provided lock manager supporting the operations
4319  * specified by AVLockOp. mutex points to a (void *) where the
4320  * lockmgr should store/get a pointer to a user allocated mutex. It's
4321  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4322  *
4323  * @param cb User defined callback. Note: Libav may invoke calls to this
4324  *           callback during the call to av_lockmgr_register().
4325  *           Thus, the application must be prepared to handle that.
4326  *           If cb is set to NULL the lockmgr will be unregistered.
4327  *           Also note that during unregistration the previously registered
4328  *           lockmgr callback may also be invoked.
4329  */
4330 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4331
4332 /**
4333  * Get the type of the given codec.
4334  */
4335 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
4336
4337 /**
4338  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4339  * with no corresponding avcodec_close()), 0 otherwise.
4340  */
4341 int avcodec_is_open(AVCodecContext *s);
4342
4343 /**
4344  * @return a non-zero number if codec is an encoder, zero otherwise
4345  */
4346 int av_codec_is_encoder(const AVCodec *codec);
4347
4348 /**
4349  * @return a non-zero number if codec is a decoder, zero otherwise
4350  */
4351 int av_codec_is_decoder(const AVCodec *codec);
4352
4353 /**
4354  * @return descriptor for given codec ID or NULL if no descriptor exists.
4355  */
4356 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
4357
4358 /**
4359  * Iterate over all codec descriptors known to libavcodec.
4360  *
4361  * @param prev previous descriptor. NULL to get the first descriptor.
4362  *
4363  * @return next descriptor or NULL after the last descriptor
4364  */
4365 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
4366
4367 /**
4368  * @return codec descriptor with the given name or NULL if no such descriptor
4369  *         exists.
4370  */
4371 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
4372
4373 /**
4374  * @}
4375  */
4376
4377 #endif /* AVCODEC_AVCODEC_H */