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