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

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