git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

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