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

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