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