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

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