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