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