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