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