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