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      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1414      * should be associated with a video stream and containts data in the form
1415      * of the AVMasteringDisplayMetadata struct.
1416      */
1417     AV_PKT_DATA_MASTERING_DISPLAY_METADATA
1418 };
1419
1420 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1421
1422 typedef struct AVPacketSideData {
1423     uint8_t *data;
1424     int      size;
1425     enum AVPacketSideDataType type;
1426 } AVPacketSideData;
1427
1428 /**
1429  * This structure stores compressed data. It is typically exported by demuxers
1430  * and then passed as input to decoders, or received as output from encoders and
1431  * then passed to muxers.
1432  *
1433  * For video, it should typically contain one compressed frame. For audio it may
1434  * contain several compressed frames. Encoders are allowed to output empty
1435  * packets, with no compressed data, containing only side data
1436  * (e.g. to update some stream parameters at the end of encoding).
1437  *
1438  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1439  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1440  * without libavcodec and libavformat major bump.
1441  *
1442  * The semantics of data ownership depends on the buf field.
1443  * If it is set, the packet data is dynamically allocated and is
1444  * valid indefinitely until a call to av_packet_unref() reduces the
1445  * reference count to 0.
1446  *
1447  * If the buf field is not set av_packet_ref() would make a copy instead
1448  * of increasing the reference count.
1449  *
1450  * The side data is always allocated with av_malloc(), copied by
1451  * av_packet_ref() and freed by av_packet_unref().
1452  *
1453  * @see av_packet_ref
1454  * @see av_packet_unref
1455  */
1456 typedef struct AVPacket {
1457     /**
1458      * A reference to the reference-counted buffer where the packet data is
1459      * stored.
1460      * May be NULL, then the packet data is not reference-counted.
1461      */
1462     AVBufferRef *buf;
1463     /**
1464      * Presentation timestamp in AVStream->time_base units; the time at which
1465      * the decompressed packet will be presented to the user.
1466      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1467      * pts MUST be larger or equal to dts as presentation cannot happen before
1468      * decompression, unless one wants to view hex dumps. Some formats misuse
1469      * the terms dts and pts/cts to mean something different. Such timestamps
1470      * must be converted to true pts/dts before they are stored in AVPacket.
1471      */
1472     int64_t pts;
1473     /**
1474      * Decompression timestamp in AVStream->time_base units; the time at which
1475      * the packet is decompressed.
1476      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1477      */
1478     int64_t dts;
1479     uint8_t *data;
1480     int   size;
1481     int   stream_index;
1482     /**
1483      * A combination of AV_PKT_FLAG values
1484      */
1485     int   flags;
1486     /**
1487      * Additional packet data that can be provided by the container.
1488      * Packet can contain several types of side information.
1489      */
1490     AVPacketSideData *side_data;
1491     int side_data_elems;
1492
1493     /**
1494      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1495      * Equals next_pts - this_pts in presentation order.
1496      */
1497     int64_t duration;
1498
1499     int64_t pos;                            ///< byte position in stream, -1 if unknown
1500
1501 #if FF_API_CONVERGENCE_DURATION
1502     /**
1503      * @deprecated Same as the duration field, but as int64_t. This was required
1504      * for Matroska subtitles, whose duration values could overflow when the
1505      * duration field was still an int.
1506      */
1507     attribute_deprecated
1508     int64_t convergence_duration;
1509 #endif
1510 } AVPacket;
1511 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1512 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1513
1514 enum AVSideDataParamChangeFlags {
1515     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1516     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1517     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1518     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1519 };
1520 /**
1521  * @}
1522  */
1523
1524 struct AVCodecInternal;
1525
1526 enum AVFieldOrder {
1527     AV_FIELD_UNKNOWN,
1528     AV_FIELD_PROGRESSIVE,
1529     AV_FIELD_TT,          //< Top coded_first, top displayed first
1530     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1531     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1532     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1533 };
1534
1535 /**
1536  * main external API structure.
1537  * New fields can be added to the end with minor version bumps.
1538  * Removal, reordering and changes to existing fields require a major
1539  * version bump.
1540  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1541  * applications.
1542  * sizeof(AVCodecContext) must not be used outside libav*.
1543  */
1544 typedef struct AVCodecContext {
1545     /**
1546      * information on struct for av_log
1547      * - set by avcodec_alloc_context3
1548      */
1549     const AVClass *av_class;
1550     int log_level_offset;
1551
1552     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1553     const struct AVCodec  *codec;
1554 #if FF_API_CODEC_NAME
1555     /**
1556      * @deprecated this field is not used for anything in libavcodec
1557      */
1558     attribute_deprecated
1559     char             codec_name[32];
1560 #endif
1561     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1562
1563     /**
1564      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1565      * This is used to work around some encoder bugs.
1566      * A demuxer should set this to what is stored in the field used to identify the codec.
1567      * If there are multiple such fields in a container then the demuxer should choose the one
1568      * which maximizes the information about the used codec.
1569      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1570      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1571      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1572      * first.
1573      * - encoding: Set by user, if not then the default based on codec_id will be used.
1574      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1575      */
1576     unsigned int codec_tag;
1577
1578 #if FF_API_STREAM_CODEC_TAG
1579     /**
1580      * @deprecated this field is unused
1581      */
1582     attribute_deprecated
1583     unsigned int stream_codec_tag;
1584 #endif
1585
1586     void *priv_data;
1587
1588     /**
1589      * Private context used for internal data.
1590      *
1591      * Unlike priv_data, this is not codec-specific. It is used in general
1592      * libavcodec functions.
1593      */
1594     struct AVCodecInternal *internal;
1595
1596     /**
1597      * Private data of the user, can be used to carry app specific stuff.
1598      * - encoding: Set by user.
1599      * - decoding: Set by user.
1600      */
1601     void *opaque;
1602
1603     /**
1604      * the average bitrate
1605      * - encoding: Set by user; unused for constant quantizer encoding.
1606      * - decoding: Set by user, may be overwritten by libavcodec
1607      *             if this info is available in the stream
1608      */
1609     int64_t bit_rate;
1610
1611     /**
1612      * number of bits the bitstream is allowed to diverge from the reference.
1613      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1614      * - encoding: Set by user; unused for constant quantizer encoding.
1615      * - decoding: unused
1616      */
1617     int bit_rate_tolerance;
1618
1619     /**
1620      * Global quality for codecs which cannot change it per frame.
1621      * This should be proportional to MPEG-1/2/4 qscale.
1622      * - encoding: Set by user.
1623      * - decoding: unused
1624      */
1625     int global_quality;
1626
1627     /**
1628      * - encoding: Set by user.
1629      * - decoding: unused
1630      */
1631     int compression_level;
1632 #define FF_COMPRESSION_DEFAULT -1
1633
1634     /**
1635      * AV_CODEC_FLAG_*.
1636      * - encoding: Set by user.
1637      * - decoding: Set by user.
1638      */
1639     int flags;
1640
1641     /**
1642      * AV_CODEC_FLAG2_*
1643      * - encoding: Set by user.
1644      * - decoding: Set by user.
1645      */
1646     int flags2;
1647
1648     /**
1649      * some codecs need / can use extradata like Huffman tables.
1650      * mjpeg: Huffman tables
1651      * rv10: additional flags
1652      * mpeg4: global headers (they can be in the bitstream or here)
1653      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1654      * than extradata_size to avoid problems if it is read with the bitstream reader.
1655      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1656      * - encoding: Set/allocated/freed by libavcodec.
1657      * - decoding: Set/allocated/freed by user.
1658      */
1659     uint8_t *extradata;
1660     int extradata_size;
1661
1662     /**
1663      * This is the fundamental unit of time (in seconds) in terms
1664      * of which frame timestamps are represented. For fixed-fps content,
1665      * timebase should be 1/framerate and timestamp increments should be
1666      * identically 1.
1667      * This often, but not always is the inverse of the frame rate or field rate
1668      * for video.
1669      * - encoding: MUST be set by user.
1670      * - decoding: the use of this field for decoding is deprecated.
1671      *             Use framerate instead.
1672      */
1673     AVRational time_base;
1674
1675     /**
1676      * For some codecs, the time base is closer to the field rate than the frame rate.
1677      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1678      * if no telecine is used ...
1679      *
1680      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1681      */
1682     int ticks_per_frame;
1683
1684     /**
1685      * Codec delay.
1686      *
1687      * Encoding: Number of frames delay there will be from the encoder input to
1688      *           the decoder output. (we assume the decoder matches the spec)
1689      * Decoding: Number of frames delay in addition to what a standard decoder
1690      *           as specified in the spec would produce.
1691      *
1692      * Video:
1693      *   Number of frames the decoded output will be delayed relative to the
1694      *   encoded input.
1695      *
1696      * Audio:
1697      *   For encoding, this field is unused (see initial_padding).
1698      *
1699      *   For decoding, this is the number of samples the decoder needs to
1700      *   output before the decoder's output is valid. When seeking, you should
1701      *   start decoding this many samples prior to your desired seek point.
1702      *
1703      * - encoding: Set by libavcodec.
1704      * - decoding: Set by libavcodec.
1705      */
1706     int delay;
1707
1708
1709     /* video only */
1710     /**
1711      * picture width / height.
1712      *
1713      * @note Those fields may not match the values of the last
1714      * AVFrame outputted by avcodec_decode_video2 due frame
1715      * reordering.
1716      *
1717      * - encoding: MUST be set by user.
1718      * - decoding: May be set by the user before opening the decoder if known e.g.
1719      *             from the container. Some decoders will require the dimensions
1720      *             to be set by the caller. During decoding, the decoder may
1721      *             overwrite those values as required while parsing the data.
1722      */
1723     int width, height;
1724
1725     /**
1726      * Bitstream width / height, may be different from width/height e.g. when
1727      * the decoded frame is cropped before being output or lowres is enabled.
1728      *
1729      * @note Those field may not match the value of the last
1730      * AVFrame outputted by avcodec_decode_video2 due frame
1731      * reordering.
1732      *
1733      * - encoding: unused
1734      * - decoding: May be set by the user before opening the decoder if known
1735      *             e.g. from the container. During decoding, the decoder may
1736      *             overwrite those values as required while parsing the data.
1737      */
1738     int coded_width, coded_height;
1739
1740 #if FF_API_ASPECT_EXTENDED
1741 #define FF_ASPECT_EXTENDED 15
1742 #endif
1743
1744     /**
1745      * the number of pictures in a group of pictures, or 0 for intra_only
1746      * - encoding: Set by user.
1747      * - decoding: unused
1748      */
1749     int gop_size;
1750
1751     /**
1752      * Pixel format, see AV_PIX_FMT_xxx.
1753      * May be set by the demuxer if known from headers.
1754      * May be overridden by the decoder if it knows better.
1755      *
1756      * @note This field may not match the value of the last
1757      * AVFrame outputted by avcodec_decode_video2 due frame
1758      * reordering.
1759      *
1760      * - encoding: Set by user.
1761      * - decoding: Set by user if known, overridden by libavcodec while
1762      *             parsing the data.
1763      */
1764     enum AVPixelFormat pix_fmt;
1765
1766 #if FF_API_MOTION_EST
1767     /**
1768      * This option does nothing
1769      * @deprecated use codec private options instead
1770      */
1771     attribute_deprecated int me_method;
1772 #endif
1773
1774     /**
1775      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1776      * decoder to draw a horizontal band. It improves cache usage. Not
1777      * all codecs can do that. You must check the codec capabilities
1778      * beforehand.
1779      * When multithreading is used, it may be called from multiple threads
1780      * at the same time; threads might draw different parts of the same AVFrame,
1781      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1782      * in order.
1783      * The function is also used by hardware acceleration APIs.
1784      * It is called at least once during frame decoding to pass
1785      * the data needed for hardware render.
1786      * In that mode instead of pixel data, AVFrame points to
1787      * a structure specific to the acceleration API. The application
1788      * reads the structure and can change some fields to indicate progress
1789      * or mark state.
1790      * - encoding: unused
1791      * - decoding: Set by user.
1792      * @param height the height of the slice
1793      * @param y the y position of the slice
1794      * @param type 1->top field, 2->bottom field, 3->frame
1795      * @param offset offset into the AVFrame.data from which the slice should be read
1796      */
1797     void (*draw_horiz_band)(struct AVCodecContext *s,
1798                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1799                             int y, int type, int height);
1800
1801     /**
1802      * callback to negotiate the pixelFormat
1803      * @param fmt is the list of formats which are supported by the codec,
1804      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1805      * The first is always the native one.
1806      * @note The callback may be called again immediately if initialization for
1807      * the selected (hardware-accelerated) pixel format failed.
1808      * @warning Behavior is undefined if the callback returns a value not
1809      * in the fmt list of formats.
1810      * @return the chosen format
1811      * - encoding: unused
1812      * - decoding: Set by user, if not set the native format will be chosen.
1813      */
1814     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1815
1816     /**
1817      * maximum number of B-frames between non-B-frames
1818      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1819      * - encoding: Set by user.
1820      * - decoding: unused
1821      */
1822     int max_b_frames;
1823
1824     /**
1825      * qscale factor between IP and B-frames
1826      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1827      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1828      * - encoding: Set by user.
1829      * - decoding: unused
1830      */
1831     float b_quant_factor;
1832
1833 #if FF_API_RC_STRATEGY
1834     /** @deprecated use codec private option instead */
1835     attribute_deprecated int rc_strategy;
1836 #define FF_RC_STRATEGY_XVID 1
1837 #endif
1838
1839 #if FF_API_PRIVATE_OPT
1840     /** @deprecated use encoder private options instead */
1841     attribute_deprecated
1842     int b_frame_strategy;
1843 #endif
1844
1845     /**
1846      * qscale offset between IP and B-frames
1847      * - encoding: Set by user.
1848      * - decoding: unused
1849      */
1850     float b_quant_offset;
1851
1852     /**
1853      * Size of the frame reordering buffer in the decoder.
1854      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1855      * - encoding: Set by libavcodec.
1856      * - decoding: Set by libavcodec.
1857      */
1858     int has_b_frames;
1859
1860 #if FF_API_PRIVATE_OPT
1861     /** @deprecated use encoder private options instead */
1862     attribute_deprecated
1863     int mpeg_quant;
1864 #endif
1865
1866     /**
1867      * qscale factor between P and I-frames
1868      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1869      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1870      * - encoding: Set by user.
1871      * - decoding: unused
1872      */
1873     float i_quant_factor;
1874
1875     /**
1876      * qscale offset between P and I-frames
1877      * - encoding: Set by user.
1878      * - decoding: unused
1879      */
1880     float i_quant_offset;
1881
1882     /**
1883      * luminance masking (0-> disabled)
1884      * - encoding: Set by user.
1885      * - decoding: unused
1886      */
1887     float lumi_masking;
1888
1889     /**
1890      * temporary complexity masking (0-> disabled)
1891      * - encoding: Set by user.
1892      * - decoding: unused
1893      */
1894     float temporal_cplx_masking;
1895
1896     /**
1897      * spatial complexity masking (0-> disabled)
1898      * - encoding: Set by user.
1899      * - decoding: unused
1900      */
1901     float spatial_cplx_masking;
1902
1903     /**
1904      * p block masking (0-> disabled)
1905      * - encoding: Set by user.
1906      * - decoding: unused
1907      */
1908     float p_masking;
1909
1910     /**
1911      * darkness masking (0-> disabled)
1912      * - encoding: Set by user.
1913      * - decoding: unused
1914      */
1915     float dark_masking;
1916
1917     /**
1918      * slice count
1919      * - encoding: Set by libavcodec.
1920      * - decoding: Set by user (or 0).
1921      */
1922     int slice_count;
1923
1924 #if FF_API_PRIVATE_OPT
1925     /** @deprecated use encoder private options instead */
1926     attribute_deprecated
1927      int prediction_method;
1928 #define FF_PRED_LEFT   0
1929 #define FF_PRED_PLANE  1
1930 #define FF_PRED_MEDIAN 2
1931 #endif
1932
1933     /**
1934      * slice offsets in the frame in bytes
1935      * - encoding: Set/allocated by libavcodec.
1936      * - decoding: Set/allocated by user (or NULL).
1937      */
1938     int *slice_offset;
1939
1940     /**
1941      * sample aspect ratio (0 if unknown)
1942      * That is the width of a pixel divided by the height of the pixel.
1943      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1944      * - encoding: Set by user.
1945      * - decoding: Set by libavcodec.
1946      */
1947     AVRational sample_aspect_ratio;
1948
1949     /**
1950      * motion estimation comparison function
1951      * - encoding: Set by user.
1952      * - decoding: unused
1953      */
1954     int me_cmp;
1955     /**
1956      * subpixel motion estimation comparison function
1957      * - encoding: Set by user.
1958      * - decoding: unused
1959      */
1960     int me_sub_cmp;
1961     /**
1962      * macroblock comparison function (not supported yet)
1963      * - encoding: Set by user.
1964      * - decoding: unused
1965      */
1966     int mb_cmp;
1967     /**
1968      * interlaced DCT comparison function
1969      * - encoding: Set by user.
1970      * - decoding: unused
1971      */
1972     int ildct_cmp;
1973 #define FF_CMP_SAD    0
1974 #define FF_CMP_SSE    1
1975 #define FF_CMP_SATD   2
1976 #define FF_CMP_DCT    3
1977 #define FF_CMP_PSNR   4
1978 #define FF_CMP_BIT    5
1979 #define FF_CMP_RD     6
1980 #define FF_CMP_ZERO   7
1981 #define FF_CMP_VSAD   8
1982 #define FF_CMP_VSSE   9
1983 #define FF_CMP_NSSE   10
1984 #define FF_CMP_W53    11
1985 #define FF_CMP_W97    12
1986 #define FF_CMP_DCTMAX 13
1987 #define FF_CMP_DCT264 14
1988 #define FF_CMP_CHROMA 256
1989
1990     /**
1991      * ME diamond size & shape
1992      * - encoding: Set by user.
1993      * - decoding: unused
1994      */
1995     int dia_size;
1996
1997     /**
1998      * amount of previous MV predictors (2a+1 x 2a+1 square)
1999      * - encoding: Set by user.
2000      * - decoding: unused
2001      */
2002     int last_predictor_count;
2003
2004 #if FF_API_PRIVATE_OPT
2005     /** @deprecated use encoder private options instead */
2006     attribute_deprecated
2007     int pre_me;
2008 #endif
2009
2010     /**
2011      * motion estimation prepass comparison function
2012      * - encoding: Set by user.
2013      * - decoding: unused
2014      */
2015     int me_pre_cmp;
2016
2017     /**
2018      * ME prepass diamond size & shape
2019      * - encoding: Set by user.
2020      * - decoding: unused
2021      */
2022     int pre_dia_size;
2023
2024     /**
2025      * subpel ME quality
2026      * - encoding: Set by user.
2027      * - decoding: unused
2028      */
2029     int me_subpel_quality;
2030
2031 #if FF_API_AFD
2032     /**
2033      * DTG active format information (additional aspect ratio
2034      * information only used in DVB MPEG-2 transport streams)
2035      * 0 if not set.
2036      *
2037      * - encoding: unused
2038      * - decoding: Set by decoder.
2039      * @deprecated Deprecated in favor of AVSideData
2040      */
2041     attribute_deprecated int dtg_active_format;
2042 #define FF_DTG_AFD_SAME         8
2043 #define FF_DTG_AFD_4_3          9
2044 #define FF_DTG_AFD_16_9         10
2045 #define FF_DTG_AFD_14_9         11
2046 #define FF_DTG_AFD_4_3_SP_14_9  13
2047 #define FF_DTG_AFD_16_9_SP_14_9 14
2048 #define FF_DTG_AFD_SP_4_3       15
2049 #endif /* FF_API_AFD */
2050
2051     /**
2052      * maximum motion estimation search range in subpel units
2053      * If 0 then no limit.
2054      *
2055      * - encoding: Set by user.
2056      * - decoding: unused
2057      */
2058     int me_range;
2059
2060 #if FF_API_QUANT_BIAS
2061     /**
2062      * @deprecated use encoder private option instead
2063      */
2064     attribute_deprecated int intra_quant_bias;
2065 #define FF_DEFAULT_QUANT_BIAS 999999
2066
2067     /**
2068      * @deprecated use encoder private option instead
2069      */
2070     attribute_deprecated int inter_quant_bias;
2071 #endif
2072
2073     /**
2074      * slice flags
2075      * - encoding: unused
2076      * - decoding: Set by user.
2077      */
2078     int slice_flags;
2079 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2080 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2081 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2082
2083 #if FF_API_XVMC
2084     /**
2085      * XVideo Motion Acceleration
2086      * - encoding: forbidden
2087      * - decoding: set by decoder
2088      * @deprecated XvMC doesn't need it anymore.
2089      */
2090     attribute_deprecated int xvmc_acceleration;
2091 #endif /* FF_API_XVMC */
2092
2093     /**
2094      * macroblock decision mode
2095      * - encoding: Set by user.
2096      * - decoding: unused
2097      */
2098     int mb_decision;
2099 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2100 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2101 #define FF_MB_DECISION_RD     2        ///< rate distortion
2102
2103     /**
2104      * custom intra quantization matrix
2105      * - encoding: Set by user, can be NULL.
2106      * - decoding: Set by libavcodec.
2107      */
2108     uint16_t *intra_matrix;
2109
2110     /**
2111      * custom inter quantization matrix
2112      * - encoding: Set by user, can be NULL.
2113      * - decoding: Set by libavcodec.
2114      */
2115     uint16_t *inter_matrix;
2116
2117 #if FF_API_PRIVATE_OPT
2118     /** @deprecated use encoder private options instead */
2119     attribute_deprecated
2120     int scenechange_threshold;
2121
2122     /** @deprecated use encoder private options instead */
2123     attribute_deprecated
2124     int noise_reduction;
2125 #endif
2126
2127 #if FF_API_MPV_OPT
2128     /**
2129      * @deprecated this field is unused
2130      */
2131     attribute_deprecated
2132     int me_threshold;
2133
2134     /**
2135      * @deprecated this field is unused
2136      */
2137     attribute_deprecated
2138     int mb_threshold;
2139 #endif
2140
2141     /**
2142      * precision of the intra DC coefficient - 8
2143      * - encoding: Set by user.
2144      * - decoding: Set by libavcodec
2145      */
2146     int intra_dc_precision;
2147
2148     /**
2149      * Number of macroblock rows at the top which are skipped.
2150      * - encoding: unused
2151      * - decoding: Set by user.
2152      */
2153     int skip_top;
2154
2155     /**
2156      * Number of macroblock rows at the bottom which are skipped.
2157      * - encoding: unused
2158      * - decoding: Set by user.
2159      */
2160     int skip_bottom;
2161
2162 #if FF_API_MPV_OPT
2163     /**
2164      * @deprecated use encoder private options instead
2165      */
2166     attribute_deprecated
2167     float border_masking;
2168 #endif
2169
2170     /**
2171      * minimum MB lagrange multipler
2172      * - encoding: Set by user.
2173      * - decoding: unused
2174      */
2175     int mb_lmin;
2176
2177     /**
2178      * maximum MB lagrange multipler
2179      * - encoding: Set by user.
2180      * - decoding: unused
2181      */
2182     int mb_lmax;
2183
2184 #if FF_API_PRIVATE_OPT
2185     /**
2186      * @deprecated use encoder private options instead
2187      */
2188     attribute_deprecated
2189     int me_penalty_compensation;
2190 #endif
2191
2192     /**
2193      * - encoding: Set by user.
2194      * - decoding: unused
2195      */
2196     int bidir_refine;
2197
2198 #if FF_API_PRIVATE_OPT
2199     /** @deprecated use encoder private options instead */
2200     attribute_deprecated
2201     int brd_scale;
2202 #endif
2203
2204     /**
2205      * minimum GOP size
2206      * - encoding: Set by user.
2207      * - decoding: unused
2208      */
2209     int keyint_min;
2210
2211     /**
2212      * number of reference frames
2213      * - encoding: Set by user.
2214      * - decoding: Set by lavc.
2215      */
2216     int refs;
2217
2218 #if FF_API_PRIVATE_OPT
2219     /** @deprecated use encoder private options instead */
2220     attribute_deprecated
2221     int chromaoffset;
2222 #endif
2223
2224 #if FF_API_UNUSED_MEMBERS
2225     /**
2226      * Multiplied by qscale for each frame and added to scene_change_score.
2227      * - encoding: Set by user.
2228      * - decoding: unused
2229      */
2230     attribute_deprecated int scenechange_factor;
2231 #endif
2232
2233     /**
2234      * Note: Value depends upon the compare function used for fullpel ME.
2235      * - encoding: Set by user.
2236      * - decoding: unused
2237      */
2238     int mv0_threshold;
2239
2240 #if FF_API_PRIVATE_OPT
2241     /** @deprecated use encoder private options instead */
2242     attribute_deprecated
2243     int b_sensitivity;
2244 #endif
2245
2246     /**
2247      * Chromaticity coordinates of the source primaries.
2248      * - encoding: Set by user
2249      * - decoding: Set by libavcodec
2250      */
2251     enum AVColorPrimaries color_primaries;
2252
2253     /**
2254      * Color Transfer Characteristic.
2255      * - encoding: Set by user
2256      * - decoding: Set by libavcodec
2257      */
2258     enum AVColorTransferCharacteristic color_trc;
2259
2260     /**
2261      * YUV colorspace type.
2262      * - encoding: Set by user
2263      * - decoding: Set by libavcodec
2264      */
2265     enum AVColorSpace colorspace;
2266
2267     /**
2268      * MPEG vs JPEG YUV range.
2269      * - encoding: Set by user
2270      * - decoding: Set by libavcodec
2271      */
2272     enum AVColorRange color_range;
2273
2274     /**
2275      * This defines the location of chroma samples.
2276      * - encoding: Set by user
2277      * - decoding: Set by libavcodec
2278      */
2279     enum AVChromaLocation chroma_sample_location;
2280
2281     /**
2282      * Number of slices.
2283      * Indicates number of picture subdivisions. Used for parallelized
2284      * decoding.
2285      * - encoding: Set by user
2286      * - decoding: unused
2287      */
2288     int slices;
2289
2290     /** Field order
2291      * - encoding: set by libavcodec
2292      * - decoding: Set by user.
2293      */
2294     enum AVFieldOrder field_order;
2295
2296     /* audio only */
2297     int sample_rate; ///< samples per second
2298     int channels;    ///< number of audio channels
2299
2300     /**
2301      * audio sample format
2302      * - encoding: Set by user.
2303      * - decoding: Set by libavcodec.
2304      */
2305     enum AVSampleFormat sample_fmt;  ///< sample format
2306
2307     /* The following data should not be initialized. */
2308     /**
2309      * Number of samples per channel in an audio frame.
2310      *
2311      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2312      *   except the last must contain exactly frame_size samples per channel.
2313      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2314      *   frame size is not restricted.
2315      * - decoding: may be set by some decoders to indicate constant frame size
2316      */
2317     int frame_size;
2318
2319     /**
2320      * Frame counter, set by libavcodec.
2321      *
2322      * - decoding: total number of frames returned from the decoder so far.
2323      * - encoding: total number of frames passed to the encoder so far.
2324      *
2325      *   @note the counter is not incremented if encoding/decoding resulted in
2326      *   an error.
2327      */
2328     int frame_number;
2329
2330     /**
2331      * number of bytes per packet if constant and known or 0
2332      * Used by some WAV based audio codecs.
2333      */
2334     int block_align;
2335
2336     /**
2337      * Audio cutoff bandwidth (0 means "automatic")
2338      * - encoding: Set by user.
2339      * - decoding: unused
2340      */
2341     int cutoff;
2342
2343     /**
2344      * Audio channel layout.
2345      * - encoding: set by user.
2346      * - decoding: set by user, may be overwritten by libavcodec.
2347      */
2348     uint64_t channel_layout;
2349
2350     /**
2351      * Request decoder to use this channel layout if it can (0 for default)
2352      * - encoding: unused
2353      * - decoding: Set by user.
2354      */
2355     uint64_t request_channel_layout;
2356
2357     /**
2358      * Type of service that the audio stream conveys.
2359      * - encoding: Set by user.
2360      * - decoding: Set by libavcodec.
2361      */
2362     enum AVAudioServiceType audio_service_type;
2363
2364     /**
2365      * desired sample format
2366      * - encoding: Not used.
2367      * - decoding: Set by user.
2368      * Decoder will decode to this format if it can.
2369      */
2370     enum AVSampleFormat request_sample_fmt;
2371
2372     /**
2373      * This callback is called at the beginning of each frame to get data
2374      * buffer(s) for it. There may be one contiguous buffer for all the data or
2375      * there may be a buffer per each data plane or anything in between. What
2376      * this means is, you may set however many entries in buf[] you feel necessary.
2377      * Each buffer must be reference-counted using the AVBuffer API (see description
2378      * of buf[] below).
2379      *
2380      * The following fields will be set in the frame before this callback is
2381      * called:
2382      * - format
2383      * - width, height (video only)
2384      * - sample_rate, channel_layout, nb_samples (audio only)
2385      * Their values may differ from the corresponding values in
2386      * AVCodecContext. This callback must use the frame values, not the codec
2387      * context values, to calculate the required buffer size.
2388      *
2389      * This callback must fill the following fields in the frame:
2390      * - data[]
2391      * - linesize[]
2392      * - extended_data:
2393      *   * if the data is planar audio with more than 8 channels, then this
2394      *     callback must allocate and fill extended_data to contain all pointers
2395      *     to all data planes. data[] must hold as many pointers as it can.
2396      *     extended_data must be allocated with av_malloc() and will be freed in
2397      *     av_frame_unref().
2398      *   * otherwise exended_data must point to data
2399      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2400      *   the frame's data and extended_data pointers must be contained in these. That
2401      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2402      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2403      *   and av_buffer_ref().
2404      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2405      *   this callback and filled with the extra buffers if there are more
2406      *   buffers than buf[] can hold. extended_buf will be freed in
2407      *   av_frame_unref().
2408      *
2409      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2410      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2411      * some other means.
2412      *
2413      * Each data plane must be aligned to the maximum required by the target
2414      * CPU.
2415      *
2416      * @see avcodec_default_get_buffer2()
2417      *
2418      * Video:
2419      *
2420      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2421      * (read and/or written to if it is writable) later by libavcodec.
2422      *
2423      * avcodec_align_dimensions2() should be used to find the required width and
2424      * height, as they normally need to be rounded up to the next multiple of 16.
2425      *
2426      * Some decoders do not support linesizes changing between frames.
2427      *
2428      * If frame multithreading is used and thread_safe_callbacks is set,
2429      * this callback may be called from a different thread, but not from more
2430      * than one at once. Does not need to be reentrant.
2431      *
2432      * @see avcodec_align_dimensions2()
2433      *
2434      * Audio:
2435      *
2436      * Decoders request a buffer of a particular size by setting
2437      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2438      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2439      * to a smaller value in the output frame.
2440      *
2441      * As a convenience, av_samples_get_buffer_size() and
2442      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2443      * functions to find the required data size and to fill data pointers and
2444      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2445      * since all planes must be the same size.
2446      *
2447      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2448      *
2449      * - encoding: unused
2450      * - decoding: Set by libavcodec, user can override.
2451      */
2452     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2453
2454     /**
2455      * If non-zero, the decoded audio and video frames returned from
2456      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2457      * and are valid indefinitely. The caller must free them with
2458      * av_frame_unref() when they are not needed anymore.
2459      * Otherwise, the decoded frames must not be freed by the caller and are
2460      * only valid until the next decode call.
2461      *
2462      * - encoding: unused
2463      * - decoding: set by the caller before avcodec_open2().
2464      */
2465     int refcounted_frames;
2466
2467     /* - encoding parameters */
2468     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2469     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2470
2471     /**
2472      * minimum quantizer
2473      * - encoding: Set by user.
2474      * - decoding: unused
2475      */
2476     int qmin;
2477
2478     /**
2479      * maximum quantizer
2480      * - encoding: Set by user.
2481      * - decoding: unused
2482      */
2483     int qmax;
2484
2485     /**
2486      * maximum quantizer difference between frames
2487      * - encoding: Set by user.
2488      * - decoding: unused
2489      */
2490     int max_qdiff;
2491
2492 #if FF_API_MPV_OPT
2493     /**
2494      * @deprecated use encoder private options instead
2495      */
2496     attribute_deprecated
2497     float rc_qsquish;
2498
2499     attribute_deprecated
2500     float rc_qmod_amp;
2501     attribute_deprecated
2502     int rc_qmod_freq;
2503 #endif
2504
2505     /**
2506      * decoder bitstream buffer size
2507      * - encoding: Set by user.
2508      * - decoding: unused
2509      */
2510     int rc_buffer_size;
2511
2512     /**
2513      * ratecontrol override, see RcOverride
2514      * - encoding: Allocated/set/freed by user.
2515      * - decoding: unused
2516      */
2517     int rc_override_count;
2518     RcOverride *rc_override;
2519
2520 #if FF_API_MPV_OPT
2521     /**
2522      * @deprecated use encoder private options instead
2523      */
2524     attribute_deprecated
2525     const char *rc_eq;
2526 #endif
2527
2528     /**
2529      * maximum bitrate
2530      * - encoding: Set by user.
2531      * - decoding: Set by user, may be overwritten by libavcodec.
2532      */
2533     int64_t rc_max_rate;
2534
2535     /**
2536      * minimum bitrate
2537      * - encoding: Set by user.
2538      * - decoding: unused
2539      */
2540     int64_t rc_min_rate;
2541
2542 #if FF_API_MPV_OPT
2543     /**
2544      * @deprecated use encoder private options instead
2545      */
2546     attribute_deprecated
2547     float rc_buffer_aggressivity;
2548
2549     attribute_deprecated
2550     float rc_initial_cplx;
2551 #endif
2552
2553     /**
2554      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2555      * - encoding: Set by user.
2556      * - decoding: unused.
2557      */
2558     float rc_max_available_vbv_use;
2559
2560     /**
2561      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2562      * - encoding: Set by user.
2563      * - decoding: unused.
2564      */
2565     float rc_min_vbv_overflow_use;
2566
2567     /**
2568      * Number of bits which should be loaded into the rc buffer before decoding starts.
2569      * - encoding: Set by user.
2570      * - decoding: unused
2571      */
2572     int rc_initial_buffer_occupancy;
2573
2574 #if FF_API_CODER_TYPE
2575 #define FF_CODER_TYPE_VLC       0
2576 #define FF_CODER_TYPE_AC        1
2577 #define FF_CODER_TYPE_RAW       2
2578 #define FF_CODER_TYPE_RLE       3
2579 #if FF_API_UNUSED_MEMBERS
2580 #define FF_CODER_TYPE_DEFLATE   4
2581 #endif /* FF_API_UNUSED_MEMBERS */
2582     /**
2583      * @deprecated use encoder private options instead
2584      */
2585     attribute_deprecated
2586     int coder_type;
2587 #endif /* FF_API_CODER_TYPE */
2588
2589 #if FF_API_PRIVATE_OPT
2590     /** @deprecated use encoder private options instead */
2591     attribute_deprecated
2592     int context_model;
2593 #endif
2594
2595 #if FF_API_MPV_OPT
2596     /**
2597      * @deprecated use encoder private options instead
2598      */
2599     attribute_deprecated
2600     int lmin;
2601
2602     /**
2603      * @deprecated use encoder private options instead
2604      */
2605     attribute_deprecated
2606     int lmax;
2607 #endif
2608
2609 #if FF_API_PRIVATE_OPT
2610     /** @deprecated use encoder private options instead */
2611     attribute_deprecated
2612     int frame_skip_threshold;
2613
2614     /** @deprecated use encoder private options instead */
2615     attribute_deprecated
2616     int frame_skip_factor;
2617
2618     /** @deprecated use encoder private options instead */
2619     attribute_deprecated
2620     int frame_skip_exp;
2621
2622     /** @deprecated use encoder private options instead */
2623     attribute_deprecated
2624     int frame_skip_cmp;
2625 #endif /* FF_API_PRIVATE_OPT */
2626
2627     /**
2628      * trellis RD quantization
2629      * - encoding: Set by user.
2630      * - decoding: unused
2631      */
2632     int trellis;
2633
2634 #if FF_API_PRIVATE_OPT
2635     /** @deprecated use encoder private options instead */
2636     attribute_deprecated
2637     int min_prediction_order;
2638
2639     /** @deprecated use encoder private options instead */
2640     attribute_deprecated
2641     int max_prediction_order;
2642
2643     /** @deprecated use encoder private options instead */
2644     attribute_deprecated
2645     int64_t timecode_frame_start;
2646 #endif
2647
2648 #if FF_API_RTP_CALLBACK
2649     /**
2650      * @deprecated unused
2651      */
2652     /* The RTP callback: This function is called    */
2653     /* every time the encoder has a packet to send. */
2654     /* It depends on the encoder if the data starts */
2655     /* with a Start Code (it should). H.263 does.   */
2656     /* mb_nb contains the number of macroblocks     */
2657     /* encoded in the RTP payload.                  */
2658     attribute_deprecated
2659     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2660 #endif
2661
2662 #if FF_API_PRIVATE_OPT
2663     /** @deprecated use encoder private options instead */
2664     attribute_deprecated
2665     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2666                             /* do its best to deliver a chunk with size     */
2667                             /* below rtp_payload_size, the chunk will start */
2668                             /* with a start code on some codecs like H.263. */
2669                             /* This doesn't take account of any particular  */
2670                             /* headers inside the transmitted RTP payload.  */
2671 #endif
2672
2673 #if FF_API_STAT_BITS
2674     /* statistics, used for 2-pass encoding */
2675     attribute_deprecated
2676     int mv_bits;
2677     attribute_deprecated
2678     int header_bits;
2679     attribute_deprecated
2680     int i_tex_bits;
2681     attribute_deprecated
2682     int p_tex_bits;
2683     attribute_deprecated
2684     int i_count;
2685     attribute_deprecated
2686     int p_count;
2687     attribute_deprecated
2688     int skip_count;
2689     attribute_deprecated
2690     int misc_bits;
2691
2692     /** @deprecated this field is unused */
2693     attribute_deprecated
2694     int frame_bits;
2695 #endif
2696
2697     /**
2698      * pass1 encoding statistics output buffer
2699      * - encoding: Set by libavcodec.
2700      * - decoding: unused
2701      */
2702     char *stats_out;
2703
2704     /**
2705      * pass2 encoding statistics input buffer
2706      * Concatenated stuff from stats_out of pass1 should be placed here.
2707      * - encoding: Allocated/set/freed by user.
2708      * - decoding: unused
2709      */
2710     char *stats_in;
2711
2712     /**
2713      * Work around bugs in encoders which sometimes cannot be detected automatically.
2714      * - encoding: Set by user
2715      * - decoding: Set by user
2716      */
2717     int workaround_bugs;
2718 #define FF_BUG_AUTODETECT       1  ///< autodetection
2719 #if FF_API_OLD_MSMPEG4
2720 #define FF_BUG_OLD_MSMPEG4      2
2721 #endif
2722 #define FF_BUG_XVID_ILACE       4
2723 #define FF_BUG_UMP4             8
2724 #define FF_BUG_NO_PADDING       16
2725 #define FF_BUG_AMV              32
2726 #if FF_API_AC_VLC
2727 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2728 #endif
2729 #define FF_BUG_QPEL_CHROMA      64
2730 #define FF_BUG_STD_QPEL         128
2731 #define FF_BUG_QPEL_CHROMA2     256
2732 #define FF_BUG_DIRECT_BLOCKSIZE 512
2733 #define FF_BUG_EDGE             1024
2734 #define FF_BUG_HPEL_CHROMA      2048
2735 #define FF_BUG_DC_CLIP          4096
2736 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2737 #define FF_BUG_TRUNCATED       16384
2738
2739     /**
2740      * strictly follow the standard (MPEG4, ...).
2741      * - encoding: Set by user.
2742      * - decoding: Set by user.
2743      * Setting this to STRICT or higher means the encoder and decoder will
2744      * generally do stupid things, whereas setting it to unofficial or lower
2745      * will mean the encoder might produce output that is not supported by all
2746      * spec-compliant decoders. Decoders don't differentiate between normal,
2747      * unofficial and experimental (that is, they always try to decode things
2748      * when they can) unless they are explicitly asked to behave stupidly
2749      * (=strictly conform to the specs)
2750      */
2751     int strict_std_compliance;
2752 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2753 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2754 #define FF_COMPLIANCE_NORMAL        0
2755 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2756 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2757
2758     /**
2759      * error concealment flags
2760      * - encoding: unused
2761      * - decoding: Set by user.
2762      */
2763     int error_concealment;
2764 #define FF_EC_GUESS_MVS   1
2765 #define FF_EC_DEBLOCK     2
2766 #define FF_EC_FAVOR_INTER 256
2767
2768     /**
2769      * debug
2770      * - encoding: Set by user.
2771      * - decoding: Set by user.
2772      */
2773     int debug;
2774 #define FF_DEBUG_PICT_INFO   1
2775 #define FF_DEBUG_RC          2
2776 #define FF_DEBUG_BITSTREAM   4
2777 #define FF_DEBUG_MB_TYPE     8
2778 #define FF_DEBUG_QP          16
2779 #if FF_API_DEBUG_MV
2780 /**
2781  * @deprecated this option does nothing
2782  */
2783 #define FF_DEBUG_MV          32
2784 #endif
2785 #define FF_DEBUG_DCT_COEFF   0x00000040
2786 #define FF_DEBUG_SKIP        0x00000080
2787 #define FF_DEBUG_STARTCODE   0x00000100
2788 #if FF_API_UNUSED_MEMBERS
2789 #define FF_DEBUG_PTS         0x00000200
2790 #endif /* FF_API_UNUSED_MEMBERS */
2791 #define FF_DEBUG_ER          0x00000400
2792 #define FF_DEBUG_MMCO        0x00000800
2793 #define FF_DEBUG_BUGS        0x00001000
2794 #if FF_API_DEBUG_MV
2795 #define FF_DEBUG_VIS_QP      0x00002000 ///< only access through AVOptions from outside libavcodec
2796 #define FF_DEBUG_VIS_MB_TYPE 0x00004000 ///< only access through AVOptions from outside libavcodec
2797 #endif
2798 #define FF_DEBUG_BUFFERS     0x00008000
2799 #define FF_DEBUG_THREADS     0x00010000
2800 #define FF_DEBUG_GREEN_MD    0x00800000
2801 #define FF_DEBUG_NOMC        0x01000000
2802
2803 #if FF_API_DEBUG_MV
2804     /**
2805      * debug
2806      * Code outside libavcodec should access this field using AVOptions
2807      * - encoding: Set by user.
2808      * - decoding: Set by user.
2809      */
2810     int debug_mv;
2811 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2812 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2813 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2814 #endif
2815
2816     /**
2817      * Error recognition; may misdetect some more or less valid parts as errors.
2818      * - encoding: unused
2819      * - decoding: Set by user.
2820      */
2821     int err_recognition;
2822
2823 /**
2824  * Verify checksums embedded in the bitstream (could be of either encoded or
2825  * decoded data, depending on the codec) and print an error message on mismatch.
2826  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2827  * decoder returning an error.
2828  */
2829 #define AV_EF_CRCCHECK  (1<<0)
2830 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
2831 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
2832 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
2833
2834 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
2835 #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
2836 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
2837 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
2838
2839
2840     /**
2841      * opaque 64bit number (generally a PTS) that will be reordered and
2842      * output in AVFrame.reordered_opaque
2843      * - encoding: unused
2844      * - decoding: Set by user.
2845      */
2846     int64_t reordered_opaque;
2847
2848     /**
2849      * Hardware accelerator in use
2850      * - encoding: unused.
2851      * - decoding: Set by libavcodec
2852      */
2853     struct AVHWAccel *hwaccel;
2854
2855     /**
2856      * Hardware accelerator context.
2857      * For some hardware accelerators, a global context needs to be
2858      * provided by the user. In that case, this holds display-dependent
2859      * data FFmpeg cannot instantiate itself. Please refer to the
2860      * FFmpeg HW accelerator documentation to know how to fill this
2861      * is. e.g. for VA API, this is a struct vaapi_context.
2862      * - encoding: unused
2863      * - decoding: Set by user
2864      */
2865     void *hwaccel_context;
2866
2867     /**
2868      * error
2869      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2870      * - decoding: unused
2871      */
2872     uint64_t error[AV_NUM_DATA_POINTERS];
2873
2874     /**
2875      * DCT algorithm, see FF_DCT_* below
2876      * - encoding: Set by user.
2877      * - decoding: unused
2878      */
2879     int dct_algo;
2880 #define FF_DCT_AUTO    0
2881 #define FF_DCT_FASTINT 1
2882 #define FF_DCT_INT     2
2883 #define FF_DCT_MMX     3
2884 #define FF_DCT_ALTIVEC 5
2885 #define FF_DCT_FAAN    6
2886
2887     /**
2888      * IDCT algorithm, see FF_IDCT_* below.
2889      * - encoding: Set by user.
2890      * - decoding: Set by user.
2891      */
2892     int idct_algo;
2893 #define FF_IDCT_AUTO          0
2894 #define FF_IDCT_INT           1
2895 #define FF_IDCT_SIMPLE        2
2896 #define FF_IDCT_SIMPLEMMX     3
2897 #define FF_IDCT_ARM           7
2898 #define FF_IDCT_ALTIVEC       8
2899 #if FF_API_ARCH_SH4
2900 #define FF_IDCT_SH4           9
2901 #endif
2902 #define FF_IDCT_SIMPLEARM     10
2903 #if FF_API_UNUSED_MEMBERS
2904 #define FF_IDCT_IPP           13
2905 #endif /* FF_API_UNUSED_MEMBERS */
2906 #define FF_IDCT_XVID          14
2907 #if FF_API_IDCT_XVIDMMX
2908 #define FF_IDCT_XVIDMMX       14
2909 #endif /* FF_API_IDCT_XVIDMMX */
2910 #define FF_IDCT_SIMPLEARMV5TE 16
2911 #define FF_IDCT_SIMPLEARMV6   17
2912 #if FF_API_ARCH_SPARC
2913 #define FF_IDCT_SIMPLEVIS     18
2914 #endif
2915 #define FF_IDCT_FAAN          20
2916 #define FF_IDCT_SIMPLENEON    22
2917 #if FF_API_ARCH_ALPHA
2918 #define FF_IDCT_SIMPLEALPHA   23
2919 #endif
2920 #define FF_IDCT_SIMPLEAUTO    128
2921
2922     /**
2923      * bits per sample/pixel from the demuxer (needed for huffyuv).
2924      * - encoding: Set by libavcodec.
2925      * - decoding: Set by user.
2926      */
2927      int bits_per_coded_sample;
2928
2929     /**
2930      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2931      * - encoding: set by user.
2932      * - decoding: set by libavcodec.
2933      */
2934     int bits_per_raw_sample;
2935
2936 #if FF_API_LOWRES
2937     /**
2938      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2939      * - encoding: unused
2940      * - decoding: Set by user.
2941      * Code outside libavcodec should access this field using:
2942      * av_codec_{get,set}_lowres(avctx)
2943      */
2944      int lowres;
2945 #endif
2946
2947 #if FF_API_CODED_FRAME
2948     /**
2949      * the picture in the bitstream
2950      * - encoding: Set by libavcodec.
2951      * - decoding: unused
2952      *
2953      * @deprecated use the quality factor packet side data instead
2954      */
2955     attribute_deprecated AVFrame *coded_frame;
2956 #endif
2957
2958     /**
2959      * thread count
2960      * is used to decide how many independent tasks should be passed to execute()
2961      * - encoding: Set by user.
2962      * - decoding: Set by user.
2963      */
2964     int thread_count;
2965
2966     /**
2967      * Which multithreading methods to use.
2968      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2969      * so clients which cannot provide future frames should not use it.
2970      *
2971      * - encoding: Set by user, otherwise the default is used.
2972      * - decoding: Set by user, otherwise the default is used.
2973      */
2974     int thread_type;
2975 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2976 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2977
2978     /**
2979      * Which multithreading methods are in use by the codec.
2980      * - encoding: Set by libavcodec.
2981      * - decoding: Set by libavcodec.
2982      */
2983     int active_thread_type;
2984
2985     /**
2986      * Set by the client if its custom get_buffer() callback can be called
2987      * synchronously from another thread, which allows faster multithreaded decoding.
2988      * draw_horiz_band() will be called from other threads regardless of this setting.
2989      * Ignored if the default get_buffer() is used.
2990      * - encoding: Set by user.
2991      * - decoding: Set by user.
2992      */
2993     int thread_safe_callbacks;
2994
2995     /**
2996      * The codec may call this to execute several independent things.
2997      * It will return only after finishing all tasks.
2998      * The user may replace this with some multithreaded implementation,
2999      * the default implementation will execute the parts serially.
3000      * @param count the number of things to execute
3001      * - encoding: Set by libavcodec, user can override.
3002      * - decoding: Set by libavcodec, user can override.
3003      */
3004     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3005
3006     /**
3007      * The codec may call this to execute several independent things.
3008      * It will return only after finishing all tasks.
3009      * The user may replace this with some multithreaded implementation,
3010      * the default implementation will execute the parts serially.
3011      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3012      * @param c context passed also to func
3013      * @param count the number of things to execute
3014      * @param arg2 argument passed unchanged to func
3015      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3016      * @param func function that will be called count times, with jobnr from 0 to count-1.
3017      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3018      *             two instances of func executing at the same time will have the same threadnr.
3019      * @return always 0 currently, but code should handle a future improvement where when any call to func
3020      *         returns < 0 no further calls to func may be done and < 0 is returned.
3021      * - encoding: Set by libavcodec, user can override.
3022      * - decoding: Set by libavcodec, user can override.
3023      */
3024     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3025
3026     /**
3027      * noise vs. sse weight for the nsse comparison function
3028      * - encoding: Set by user.
3029      * - decoding: unused
3030      */
3031      int nsse_weight;
3032
3033     /**
3034      * profile
3035      * - encoding: Set by user.
3036      * - decoding: Set by libavcodec.
3037      */
3038      int profile;
3039 #define FF_PROFILE_UNKNOWN -99
3040 #define FF_PROFILE_RESERVED -100
3041
3042 #define FF_PROFILE_AAC_MAIN 0
3043 #define FF_PROFILE_AAC_LOW  1
3044 #define FF_PROFILE_AAC_SSR  2
3045 #define FF_PROFILE_AAC_LTP  3
3046 #define FF_PROFILE_AAC_HE   4
3047 #define FF_PROFILE_AAC_HE_V2 28
3048 #define FF_PROFILE_AAC_LD   22
3049 #define FF_PROFILE_AAC_ELD  38
3050 #define FF_PROFILE_MPEG2_AAC_LOW 128
3051 #define FF_PROFILE_MPEG2_AAC_HE  131
3052
3053 #define FF_PROFILE_DTS         20
3054 #define FF_PROFILE_DTS_ES      30
3055 #define FF_PROFILE_DTS_96_24   40
3056 #define FF_PROFILE_DTS_HD_HRA  50
3057 #define FF_PROFILE_DTS_HD_MA   60
3058 #define FF_PROFILE_DTS_EXPRESS 70
3059
3060 #define FF_PROFILE_MPEG2_422    0
3061 #define FF_PROFILE_MPEG2_HIGH   1
3062 #define FF_PROFILE_MPEG2_SS     2
3063 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3064 #define FF_PROFILE_MPEG2_MAIN   4
3065 #define FF_PROFILE_MPEG2_SIMPLE 5
3066
3067 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3068 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3069
3070 #define FF_PROFILE_H264_BASELINE             66
3071 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3072 #define FF_PROFILE_H264_MAIN                 77
3073 #define FF_PROFILE_H264_EXTENDED             88
3074 #define FF_PROFILE_H264_HIGH                 100
3075 #define FF_PROFILE_H264_HIGH_10              110
3076 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3077 #define FF_PROFILE_H264_HIGH_422             122
3078 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3079 #define FF_PROFILE_H264_HIGH_444             144
3080 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3081 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3082 #define FF_PROFILE_H264_CAVLC_444            44
3083
3084 #define FF_PROFILE_VC1_SIMPLE   0
3085 #define FF_PROFILE_VC1_MAIN     1
3086 #define FF_PROFILE_VC1_COMPLEX  2
3087 #define FF_PROFILE_VC1_ADVANCED 3
3088
3089 #define FF_PROFILE_MPEG4_SIMPLE                     0
3090 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3091 #define FF_PROFILE_MPEG4_CORE                       2
3092 #define FF_PROFILE_MPEG4_MAIN                       3
3093 #define FF_PROFILE_MPEG4_N_BIT                      4
3094 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3095 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3096 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3097 #define FF_PROFILE_MPEG4_HYBRID                     8
3098 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3099 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3100 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3101 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3102 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3103 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3104 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3105
3106 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   0
3107 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   1
3108 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  2
3109 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3110 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3111
3112 #define FF_PROFILE_VP9_0                            0
3113 #define FF_PROFILE_VP9_1                            1
3114 #define FF_PROFILE_VP9_2                            2
3115 #define FF_PROFILE_VP9_3                            3
3116
3117 #define FF_PROFILE_HEVC_MAIN                        1
3118 #define FF_PROFILE_HEVC_MAIN_10                     2
3119 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3120 #define FF_PROFILE_HEVC_REXT                        4
3121
3122     /**
3123      * level
3124      * - encoding: Set by user.
3125      * - decoding: Set by libavcodec.
3126      */
3127      int level;
3128 #define FF_LEVEL_UNKNOWN -99
3129
3130     /**
3131      * Skip loop filtering for selected frames.
3132      * - encoding: unused
3133      * - decoding: Set by user.
3134      */
3135     enum AVDiscard skip_loop_filter;
3136
3137     /**
3138      * Skip IDCT/dequantization for selected frames.
3139      * - encoding: unused
3140      * - decoding: Set by user.
3141      */
3142     enum AVDiscard skip_idct;
3143
3144     /**
3145      * Skip decoding for selected frames.
3146      * - encoding: unused
3147      * - decoding: Set by user.
3148      */
3149     enum AVDiscard skip_frame;
3150
3151     /**
3152      * Header containing style information for text subtitles.
3153      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3154      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3155      * the Format line following. It shouldn't include any Dialogue line.
3156      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3157      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3158      */
3159     uint8_t *subtitle_header;
3160     int subtitle_header_size;
3161
3162 #if FF_API_ERROR_RATE
3163     /**
3164      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3165      * encoders
3166      */
3167     attribute_deprecated
3168     int error_rate;
3169 #endif
3170
3171 #if FF_API_VBV_DELAY
3172     /**
3173      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3174      * Used for compliant TS muxing.
3175      * - encoding: Set by libavcodec.
3176      * - decoding: unused.
3177      * @deprecated this value is now exported as a part of
3178      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3179      */
3180     attribute_deprecated
3181     uint64_t vbv_delay;
3182 #endif
3183
3184 #if FF_API_SIDEDATA_ONLY_PKT
3185     /**
3186      * Encoding only and set by default. Allow encoders to output packets
3187      * that do not contain any encoded data, only side data.
3188      *
3189      * Some encoders need to output such packets, e.g. to update some stream
3190      * parameters at the end of encoding.
3191      *
3192      * @deprecated this field disables the default behaviour and
3193      *             it is kept only for compatibility.
3194      */
3195     attribute_deprecated
3196     int side_data_only_packets;
3197 #endif
3198
3199     /**
3200      * Audio only. The number of "priming" samples (padding) inserted by the
3201      * encoder at the beginning of the audio. I.e. this number of leading
3202      * decoded samples must be discarded by the caller to get the original audio
3203      * without leading padding.
3204      *
3205      * - decoding: unused
3206      * - encoding: Set by libavcodec. The timestamps on the output packets are
3207      *             adjusted by the encoder so that they always refer to the
3208      *             first sample of the data actually contained in the packet,
3209      *             including any added padding.  E.g. if the timebase is
3210      *             1/samplerate and the timestamp of the first input sample is
3211      *             0, the timestamp of the first output packet will be
3212      *             -initial_padding.
3213      */
3214     int initial_padding;
3215
3216     /**
3217      * - decoding: For codecs that store a framerate value in the compressed
3218      *             bitstream, the decoder may export it here. { 0, 1} when
3219      *             unknown.
3220      * - encoding: unused
3221      */
3222     AVRational framerate;
3223
3224     /**
3225      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3226      * - encoding: unused.
3227      * - decoding: Set by libavcodec before calling get_format()
3228      */
3229     enum AVPixelFormat sw_pix_fmt;
3230
3231     /**
3232      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3233      * Code outside libavcodec should access this field using:
3234      * av_codec_{get,set}_pkt_timebase(avctx)
3235      * - encoding unused.
3236      * - decoding set by user.
3237      */
3238     AVRational pkt_timebase;
3239
3240     /**
3241      * AVCodecDescriptor
3242      * Code outside libavcodec should access this field using:
3243      * av_codec_{get,set}_codec_descriptor(avctx)
3244      * - encoding: unused.
3245      * - decoding: set by libavcodec.
3246      */
3247     const AVCodecDescriptor *codec_descriptor;
3248
3249 #if !FF_API_LOWRES
3250     /**
3251      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3252      * - encoding: unused
3253      * - decoding: Set by user.
3254      * Code outside libavcodec should access this field using:
3255      * av_codec_{get,set}_lowres(avctx)
3256      */
3257      int lowres;
3258 #endif
3259
3260     /**
3261      * Current statistics for PTS correction.
3262      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3263      * - encoding: unused
3264      */
3265     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3266     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3267     int64_t pts_correction_last_pts;       /// PTS of the last frame
3268     int64_t pts_correction_last_dts;       /// DTS of the last frame
3269
3270     /**
3271      * Character encoding of the input subtitles file.
3272      * - decoding: set by user
3273      * - encoding: unused
3274      */
3275     char *sub_charenc;
3276
3277     /**
3278      * Subtitles character encoding mode. Formats or codecs might be adjusting
3279      * this setting (if they are doing the conversion themselves for instance).
3280      * - decoding: set by libavcodec
3281      * - encoding: unused
3282      */
3283     int sub_charenc_mode;
3284 #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)
3285 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3286 #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
3287
3288     /**
3289      * Skip processing alpha if supported by codec.
3290      * Note that if the format uses pre-multiplied alpha (common with VP6,
3291      * and recommended due to better video quality/compression)
3292      * the image will look as if alpha-blended onto a black background.
3293      * However for formats that do not use pre-multiplied alpha
3294      * there might be serious artefacts (though e.g. libswscale currently
3295      * assumes pre-multiplied alpha anyway).
3296      * Code outside libavcodec should access this field using AVOptions
3297      *
3298      * - decoding: set by user
3299      * - encoding: unused
3300      */
3301     int skip_alpha;
3302
3303     /**
3304      * Number of samples to skip after a discontinuity
3305      * - decoding: unused
3306      * - encoding: set by libavcodec
3307      */
3308     int seek_preroll;
3309
3310 #if !FF_API_DEBUG_MV
3311     /**
3312      * debug motion vectors
3313      * Code outside libavcodec should access this field using AVOptions
3314      * - encoding: Set by user.
3315      * - decoding: Set by user.
3316      */
3317     int debug_mv;
3318 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3319 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3320 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3321 #endif
3322
3323     /**
3324      * custom intra quantization matrix
3325      * Code outside libavcodec should access this field using av_codec_g/set_chroma_intra_matrix()
3326      * - encoding: Set by user, can be NULL.
3327      * - decoding: unused.
3328      */
3329     uint16_t *chroma_intra_matrix;
3330
3331     /**
3332      * dump format separator.
3333      * can be ", " or "\n      " or anything else
3334      * Code outside libavcodec should access this field using AVOptions
3335      * (NO direct access).
3336      * - encoding: Set by user.
3337      * - decoding: Set by user.
3338      */
3339     uint8_t *dump_separator;
3340
3341     /**
3342      * ',' separated list of allowed decoders.
3343      * If NULL then all are allowed
3344      * - encoding: unused
3345      * - decoding: set by user through AVOPtions (NO direct access)
3346      */
3347     char *codec_whitelist;
3348
3349     /*
3350      * Properties of the stream that gets decoded
3351      * To be accessed through av_codec_get_properties() (NO direct access)
3352      * - encoding: unused
3353      * - decoding: set by libavcodec
3354      */
3355     unsigned properties;
3356 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3357 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3358
3359     /**
3360      * Additional data associated with the entire coded stream.
3361      *
3362      * - decoding: unused
3363      * - encoding: may be set by libavcodec after avcodec_open2().
3364      */
3365     AVPacketSideData *coded_side_data;
3366     int            nb_coded_side_data;
3367
3368     /**
3369      * Encoding only.
3370      *
3371      * For hardware encoders configured to use a hwaccel pixel format, this
3372      * field should be set by the caller to a reference to the AVHWFramesContext
3373      * describing input frames. AVHWFramesContext.format must be equal to
3374      * AVCodecContext.pix_fmt.
3375      *
3376      * This field should be set before avcodec_open2() is called and is
3377      * afterwards owned and managed by libavcodec.
3378      */
3379     AVBufferRef *hw_frames_ctx;
3380 } AVCodecContext;
3381
3382 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3383 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3384
3385 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3386 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3387
3388 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3389
3390 int  av_codec_get_lowres(const AVCodecContext *avctx);
3391 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3392
3393 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3394 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3395
3396 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3397 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3398
3399 /**
3400  * AVProfile.
3401  */
3402 typedef struct AVProfile {
3403     int profile;
3404     const char *name; ///< short name for the profile
3405 } AVProfile;
3406
3407 typedef struct AVCodecDefault AVCodecDefault;
3408
3409 struct AVSubtitle;
3410
3411 /**
3412  * AVCodec.
3413  */
3414 typedef struct AVCodec {
3415     /**
3416      * Name of the codec implementation.
3417      * The name is globally unique among encoders and among decoders (but an
3418      * encoder and a decoder can share the same name).
3419      * This is the primary way to find a codec from the user perspective.
3420      */
3421     const char *name;
3422     /**
3423      * Descriptive name for the codec, meant to be more human readable than name.
3424      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3425      */
3426     const char *long_name;
3427     enum AVMediaType type;
3428     enum AVCodecID id;
3429     /**
3430      * Codec capabilities.
3431      * see AV_CODEC_CAP_*
3432      */
3433     int capabilities;
3434     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3435     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3436     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3437     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3438     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3439     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder, no direct access, use av_codec_get_max_lowres()
3440     const AVClass *priv_class;              ///< AVClass for the private context
3441     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3442
3443     /*****************************************************************
3444      * No fields below this line are part of the public API. They
3445      * may not be used outside of libavcodec and can be changed and
3446      * removed at will.
3447      * New public fields should be added right above.
3448      *****************************************************************
3449      */
3450     int priv_data_size;
3451     struct AVCodec *next;
3452     /**
3453      * @name Frame-level threading support functions
3454      * @{
3455      */
3456     /**
3457      * If defined, called on thread contexts when they are created.
3458      * If the codec allocates writable tables in init(), re-allocate them here.
3459      * priv_data will be set to a copy of the original.
3460      */
3461     int (*init_thread_copy)(AVCodecContext *);
3462     /**
3463      * Copy necessary context variables from a previous thread context to the current one.
3464      * If not defined, the next thread will start automatically; otherwise, the codec
3465      * must call ff_thread_finish_setup().
3466      *
3467      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3468      */
3469     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3470     /** @} */
3471
3472     /**
3473      * Private codec-specific defaults.
3474      */
3475     const AVCodecDefault *defaults;
3476
3477     /**
3478      * Initialize codec static data, called from avcodec_register().
3479      */
3480     void (*init_static_data)(struct AVCodec *codec);
3481
3482     int (*init)(AVCodecContext *);
3483     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3484                       const struct AVSubtitle *sub);
3485     /**
3486      * Encode data to an AVPacket.
3487      *
3488      * @param      avctx          codec context
3489      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3490      * @param[in]  frame          AVFrame containing the raw data to be encoded
3491      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3492      *                            non-empty packet was returned in avpkt.
3493      * @return 0 on success, negative error code on failure
3494      */
3495     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3496                    int *got_packet_ptr);
3497     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3498     int (*close)(AVCodecContext *);
3499     /**
3500      * Flush buffers.
3501      * Will be called when seeking
3502      */
3503     void (*flush)(AVCodecContext *);
3504     /**
3505      * Internal codec capabilities.
3506      * See FF_CODEC_CAP_* in internal.h
3507      */
3508     int caps_internal;
3509 } AVCodec;
3510
3511 int av_codec_get_max_lowres(const AVCodec *codec);
3512
3513 struct MpegEncContext;
3514
3515 /**
3516  * @defgroup lavc_hwaccel AVHWAccel
3517  * @{
3518  */
3519 typedef struct AVHWAccel {
3520     /**
3521      * Name of the hardware accelerated codec.
3522      * The name is globally unique among encoders and among decoders (but an
3523      * encoder and a decoder can share the same name).
3524      */
3525     const char *name;
3526
3527     /**
3528      * Type of codec implemented by the hardware accelerator.
3529      *
3530      * See AVMEDIA_TYPE_xxx
3531      */
3532     enum AVMediaType type;
3533
3534     /**
3535      * Codec implemented by the hardware accelerator.
3536      *
3537      * See AV_CODEC_ID_xxx
3538      */
3539     enum AVCodecID id;
3540
3541     /**
3542      * Supported pixel format.
3543      *
3544      * Only hardware accelerated formats are supported here.
3545      */
3546     enum AVPixelFormat pix_fmt;
3547
3548     /**
3549      * Hardware accelerated codec capabilities.
3550      * see HWACCEL_CODEC_CAP_*
3551      */
3552     int capabilities;
3553
3554     /*****************************************************************
3555      * No fields below this line are part of the public API. They
3556      * may not be used outside of libavcodec and can be changed and
3557      * removed at will.
3558      * New public fields should be added right above.
3559      *****************************************************************
3560      */
3561     struct AVHWAccel *next;
3562
3563     /**
3564      * Allocate a custom buffer
3565      */
3566     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3567
3568     /**
3569      * Called at the beginning of each frame or field picture.
3570      *
3571      * Meaningful frame information (codec specific) is guaranteed to
3572      * be parsed at this point. This function is mandatory.
3573      *
3574      * Note that buf can be NULL along with buf_size set to 0.
3575      * Otherwise, this means the whole frame is available at this point.
3576      *
3577      * @param avctx the codec context
3578      * @param buf the frame data buffer base
3579      * @param buf_size the size of the frame in bytes
3580      * @return zero if successful, a negative value otherwise
3581      */
3582     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3583
3584     /**
3585      * Callback for each slice.
3586      *
3587      * Meaningful slice information (codec specific) is guaranteed to
3588      * be parsed at this point. This function is mandatory.
3589      * The only exception is XvMC, that works on MB level.
3590      *
3591      * @param avctx the codec context
3592      * @param buf the slice data buffer base
3593      * @param buf_size the size of the slice in bytes
3594      * @return zero if successful, a negative value otherwise
3595      */
3596     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3597
3598     /**
3599      * Called at the end of each frame or field picture.
3600      *
3601      * The whole picture is parsed at this point and can now be sent
3602      * to the hardware accelerator. This function is mandatory.
3603      *
3604      * @param avctx the codec context
3605      * @return zero if successful, a negative value otherwise
3606      */
3607     int (*end_frame)(AVCodecContext *avctx);
3608
3609     /**
3610      * Size of per-frame hardware accelerator private data.
3611      *
3612      * Private data is allocated with av_mallocz() before
3613      * AVCodecContext.get_buffer() and deallocated after
3614      * AVCodecContext.release_buffer().
3615      */
3616     int frame_priv_data_size;
3617
3618     /**
3619      * Called for every Macroblock in a slice.
3620      *
3621      * XvMC uses it to replace the ff_mpv_decode_mb().
3622      * Instead of decoding to raw picture, MB parameters are
3623      * stored in an array provided by the video driver.
3624      *
3625      * @param s the mpeg context
3626      */
3627     void (*decode_mb)(struct MpegEncContext *s);
3628
3629     /**
3630      * Initialize the hwaccel private data.
3631      *
3632      * This will be called from ff_get_format(), after hwaccel and
3633      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3634      * is allocated.
3635      */
3636     int (*init)(AVCodecContext *avctx);
3637
3638     /**
3639      * Uninitialize the hwaccel private data.
3640      *
3641      * This will be called from get_format() or avcodec_close(), after hwaccel
3642      * and hwaccel_context are already uninitialized.
3643      */
3644     int (*uninit)(AVCodecContext *avctx);
3645
3646     /**
3647      * Size of the private data to allocate in
3648      * AVCodecInternal.hwaccel_priv_data.
3649      */
3650     int priv_data_size;
3651 } AVHWAccel;
3652
3653 /**
3654  * Hardware acceleration should be used for decoding even if the codec level
3655  * used is unknown or higher than the maximum supported level reported by the
3656  * hardware driver.
3657  *
3658  * It's generally a good idea to pass this flag unless you have a specific
3659  * reason not to, as hardware tends to under-report supported levels.
3660  */
3661 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3662
3663 /**
3664  * Hardware acceleration can output YUV pixel formats with a different chroma
3665  * sampling than 4:2:0 and/or other than 8 bits per component.
3666  */
3667 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3668
3669 /**
3670  * @}
3671  */
3672
3673 #if FF_API_AVPICTURE
3674 /**
3675  * @defgroup lavc_picture AVPicture
3676  *
3677  * Functions for working with AVPicture
3678  * @{
3679  */
3680
3681 /**
3682  * Picture data structure.
3683  *
3684  * Up to four components can be stored into it, the last component is
3685  * alpha.
3686  * @deprecated use AVFrame or imgutils functions instead
3687  */
3688 typedef struct AVPicture {
3689     attribute_deprecated
3690     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
3691     attribute_deprecated
3692     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3693 } AVPicture;
3694
3695 /**
3696  * @}
3697  */
3698 #endif
3699
3700 enum AVSubtitleType {
3701     SUBTITLE_NONE,
3702
3703     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3704
3705     /**
3706      * Plain text, the text field must be set by the decoder and is
3707      * authoritative. ass and pict fields may contain approximations.
3708      */
3709     SUBTITLE_TEXT,
3710
3711     /**
3712      * Formatted text, the ass field must be set by the decoder and is
3713      * authoritative. pict and text fields may contain approximations.
3714      */
3715     SUBTITLE_ASS,
3716 };
3717
3718 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3719
3720 typedef struct AVSubtitleRect {
3721     int x;         ///< top left corner  of pict, undefined when pict is not set
3722     int y;         ///< top left corner  of pict, undefined when pict is not set
3723     int w;         ///< width            of pict, undefined when pict is not set
3724     int h;         ///< height           of pict, undefined when pict is not set
3725     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3726
3727 #if FF_API_AVPICTURE
3728     /**
3729      * @deprecated unused
3730      */
3731     attribute_deprecated
3732     AVPicture pict;
3733 #endif
3734     /**
3735      * data+linesize for the bitmap of this subtitle.
3736      * Can be set for text/ass as well once they are rendered.
3737      */
3738     uint8_t *data[4];
3739     int linesize[4];
3740
3741     enum AVSubtitleType type;
3742
3743     char *text;                     ///< 0 terminated plain UTF-8 text
3744
3745     /**
3746      * 0 terminated ASS/SSA compatible event line.
3747      * The presentation of this is unaffected by the other values in this
3748      * struct.
3749      */
3750     char *ass;
3751
3752     int flags;
3753 } AVSubtitleRect;
3754
3755 typedef struct AVSubtitle {
3756     uint16_t format; /* 0 = graphics */
3757     uint32_t start_display_time; /* relative to packet pts, in ms */
3758     uint32_t end_display_time; /* relative to packet pts, in ms */
3759     unsigned num_rects;
3760     AVSubtitleRect **rects;
3761     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3762 } AVSubtitle;
3763
3764 /**
3765  * If c is NULL, returns the first registered codec,
3766  * if c is non-NULL, returns the next registered codec after c,
3767  * or NULL if c is the last one.
3768  */
3769 AVCodec *av_codec_next(const AVCodec *c);
3770
3771 /**
3772  * Return the LIBAVCODEC_VERSION_INT constant.
3773  */
3774 unsigned avcodec_version(void);
3775
3776 /**
3777  * Return the libavcodec build-time configuration.
3778  */
3779 const char *avcodec_configuration(void);
3780
3781 /**
3782  * Return the libavcodec license.
3783  */
3784 const char *avcodec_license(void);
3785
3786 /**
3787  * Register the codec codec and initialize libavcodec.
3788  *
3789  * @warning either this function or avcodec_register_all() must be called
3790  * before any other libavcodec functions.
3791  *
3792  * @see avcodec_register_all()
3793  */
3794 void avcodec_register(AVCodec *codec);
3795
3796 /**
3797  * Register all the codecs, parsers and bitstream filters which were enabled at
3798  * configuration time. If you do not call this function you can select exactly
3799  * which formats you want to support, by using the individual registration
3800  * functions.
3801  *
3802  * @see avcodec_register
3803  * @see av_register_codec_parser
3804  * @see av_register_bitstream_filter
3805  */
3806 void avcodec_register_all(void);
3807
3808 /**
3809  * Allocate an AVCodecContext and set its fields to default values. The
3810  * resulting struct should be freed with avcodec_free_context().
3811  *
3812  * @param codec if non-NULL, allocate private data and initialize defaults
3813  *              for the given codec. It is illegal to then call avcodec_open2()
3814  *              with a different codec.
3815  *              If NULL, then the codec-specific defaults won't be initialized,
3816  *              which may result in suboptimal default settings (this is
3817  *              important mainly for encoders, e.g. libx264).
3818  *
3819  * @return An AVCodecContext filled with default values or NULL on failure.
3820  * @see avcodec_get_context_defaults
3821  */
3822 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3823
3824 /**
3825  * Free the codec context and everything associated with it and write NULL to
3826  * the provided pointer.
3827  */
3828 void avcodec_free_context(AVCodecContext **avctx);
3829
3830 /**
3831  * Set the fields of the given AVCodecContext to default values corresponding
3832  * to the given codec (defaults may be codec-dependent).
3833  *
3834  * Do not call this function if a non-NULL codec has been passed
3835  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3836  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3837  * different codec on this AVCodecContext.
3838  */
3839 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3840
3841 /**
3842  * Get the AVClass for AVCodecContext. It can be used in combination with
3843  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3844  *
3845  * @see av_opt_find().
3846  */
3847 const AVClass *avcodec_get_class(void);
3848
3849 /**
3850  * Get the AVClass for AVFrame. It can be used in combination with
3851  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3852  *
3853  * @see av_opt_find().
3854  */
3855 const AVClass *avcodec_get_frame_class(void);
3856
3857 /**
3858  * Get the AVClass for AVSubtitleRect. It can be used in combination with
3859  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3860  *
3861  * @see av_opt_find().
3862  */
3863 const AVClass *avcodec_get_subtitle_rect_class(void);
3864
3865 /**
3866  * Copy the settings of the source AVCodecContext into the destination
3867  * AVCodecContext. The resulting destination codec context will be
3868  * unopened, i.e. you are required to call avcodec_open2() before you
3869  * can use this AVCodecContext to decode/encode video/audio data.
3870  *
3871  * @param dest target codec context, should be initialized with
3872  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
3873  * @param src source codec context
3874  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3875  */
3876 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3877
3878 /**
3879  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3880  * function the context has to be allocated with avcodec_alloc_context3().
3881  *
3882  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3883  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3884  * retrieving a codec.
3885  *
3886  * @warning This function is not thread safe!
3887  *
3888  * @note Always call this function before using decoding routines (such as
3889  * @ref avcodec_decode_video2()).
3890  *
3891  * @code
3892  * avcodec_register_all();
3893  * av_dict_set(&opts, "b", "2.5M", 0);
3894  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3895  * if (!codec)
3896  *     exit(1);
3897  *
3898  * context = avcodec_alloc_context3(codec);
3899  *
3900  * if (avcodec_open2(context, codec, opts) < 0)
3901  *     exit(1);
3902  * @endcode
3903  *
3904  * @param avctx The context to initialize.
3905  * @param codec The codec to open this context for. If a non-NULL codec has been
3906  *              previously passed to avcodec_alloc_context3() or
3907  *              avcodec_get_context_defaults3() for this context, then this
3908  *              parameter MUST be either NULL or equal to the previously passed
3909  *              codec.
3910  * @param options A dictionary filled with AVCodecContext and codec-private options.
3911  *                On return this object will be filled with options that were not found.
3912  *
3913  * @return zero on success, a negative value on error
3914  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3915  *      av_dict_set(), av_opt_find().
3916  */
3917 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3918
3919 /**
3920  * Close a given AVCodecContext and free all the data associated with it
3921  * (but not the AVCodecContext itself).
3922  *
3923  * Calling this function on an AVCodecContext that hasn't been opened will free
3924  * the codec-specific data allocated in avcodec_alloc_context3() /
3925  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
3926  * do nothing.
3927  */
3928 int avcodec_close(AVCodecContext *avctx);
3929
3930 /**
3931  * Free all allocated data in the given subtitle struct.
3932  *
3933  * @param sub AVSubtitle to free.
3934  */
3935 void avsubtitle_free(AVSubtitle *sub);
3936
3937 /**
3938  * @}
3939  */
3940
3941 /**
3942  * @addtogroup lavc_packet
3943  * @{
3944  */
3945
3946 /**
3947  * Allocate an AVPacket and set its fields to default values.  The resulting
3948  * struct must be freed using av_packet_free().
3949  *
3950  * @return An AVPacket filled with default values or NULL on failure.
3951  *
3952  * @note this only allocates the AVPacket itself, not the data buffers. Those
3953  * must be allocated through other means such as av_new_packet.
3954  *
3955  * @see av_new_packet
3956  */
3957 AVPacket *av_packet_alloc(void);
3958
3959 /**
3960  * Create a new packet that references the same data as src.
3961  *
3962  * This is a shortcut for av_packet_alloc()+av_packet_ref().
3963  *
3964  * @return newly created AVPacket on success, NULL on error.
3965  *
3966  * @see av_packet_alloc
3967  * @see av_packet_ref
3968  */
3969 AVPacket *av_packet_clone(AVPacket *src);
3970
3971 /**
3972  * Free the packet, if the packet is reference counted, it will be
3973  * unreferenced first.
3974  *
3975  * @param packet packet to be freed. The pointer will be set to NULL.
3976  * @note passing NULL is a no-op.
3977  */
3978 void av_packet_free(AVPacket **pkt);
3979
3980 /**
3981  * Initialize optional fields of a packet with default values.
3982  *
3983  * Note, this does not touch the data and size members, which have to be
3984  * initialized separately.
3985  *
3986  * @param pkt packet
3987  */
3988 void av_init_packet(AVPacket *pkt);
3989
3990 /**
3991  * Allocate the payload of a packet and initialize its fields with
3992  * default values.
3993  *
3994  * @param pkt packet
3995  * @param size wanted payload size
3996  * @return 0 if OK, AVERROR_xxx otherwise
3997  */
3998 int av_new_packet(AVPacket *pkt, int size);
3999
4000 /**
4001  * Reduce packet size, correctly zeroing padding
4002  *
4003  * @param pkt packet
4004  * @param size new size
4005  */
4006 void av_shrink_packet(AVPacket *pkt, int size);
4007
4008 /**
4009  * Increase packet size, correctly zeroing padding
4010  *
4011  * @param pkt packet
4012  * @param grow_by number of bytes by which to increase the size of the packet
4013  */
4014 int av_grow_packet(AVPacket *pkt, int grow_by);
4015
4016 /**
4017  * Initialize a reference-counted packet from av_malloc()ed data.
4018  *
4019  * @param pkt packet to be initialized. This function will set the data, size,
4020  *        buf and destruct fields, all others are left untouched.
4021  * @param data Data allocated by av_malloc() to be used as packet data. If this
4022  *        function returns successfully, the data is owned by the underlying AVBuffer.
4023  *        The caller may not access the data through other means.
4024  * @param size size of data in bytes, without the padding. I.e. the full buffer
4025  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4026  *
4027  * @return 0 on success, a negative AVERROR on error
4028  */
4029 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4030
4031 #if FF_API_AVPACKET_OLD_API
4032 /**
4033  * @warning This is a hack - the packet memory allocation stuff is broken. The
4034  * packet is allocated if it was not really allocated.
4035  *
4036  * @deprecated Use av_packet_ref
4037  */
4038 attribute_deprecated
4039 int av_dup_packet(AVPacket *pkt);
4040 /**
4041  * Copy packet, including contents
4042  *
4043  * @return 0 on success, negative AVERROR on fail
4044  */
4045 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4046
4047 /**
4048  * Copy packet side data
4049  *
4050  * @return 0 on success, negative AVERROR on fail
4051  */
4052 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4053
4054 /**
4055  * Free a packet.
4056  *
4057  * @deprecated Use av_packet_unref
4058  *
4059  * @param pkt packet to free
4060  */
4061 attribute_deprecated
4062 void av_free_packet(AVPacket *pkt);
4063 #endif
4064 /**
4065  * Allocate new information of a packet.
4066  *
4067  * @param pkt packet
4068  * @param type side information type
4069  * @param size side information size
4070  * @return pointer to fresh allocated data or NULL otherwise
4071  */
4072 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4073                                  int size);
4074
4075 /**
4076  * Wrap an existing array as a packet side data.
4077  *
4078  * @param pkt packet
4079  * @param type side information type
4080  * @param data the side data array. It must be allocated with the av_malloc()
4081  *             family of functions. The ownership of the data is transferred to
4082  *             pkt.
4083  * @param size side information size
4084  * @return a non-negative number on success, a negative AVERROR code on
4085  *         failure. On failure, the packet is unchanged and the data remains
4086  *         owned by the caller.
4087  */
4088 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4089                             uint8_t *data, size_t size);
4090
4091 /**
4092  * Shrink the already allocated side data buffer
4093  *
4094  * @param pkt packet
4095  * @param type side information type
4096  * @param size new side information size
4097  * @return 0 on success, < 0 on failure
4098  */
4099 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4100                                int size);
4101
4102 /**
4103  * Get side information from packet.
4104  *
4105  * @param pkt packet
4106  * @param type desired side information type
4107  * @param size pointer for side information size to store (optional)
4108  * @return pointer to data if present or NULL otherwise
4109  */
4110 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4111                                  int *size);
4112
4113 int av_packet_merge_side_data(AVPacket *pkt);
4114
4115 int av_packet_split_side_data(AVPacket *pkt);
4116
4117 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4118
4119 /**
4120  * Pack a dictionary for use in side_data.
4121  *
4122  * @param dict The dictionary to pack.
4123  * @param size pointer to store the size of the returned data
4124  * @return pointer to data if successful, NULL otherwise
4125  */
4126 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4127 /**
4128  * Unpack a dictionary from side_data.
4129  *
4130  * @param data data from side_data
4131  * @param size size of the data
4132  * @param dict the metadata storage dictionary
4133  * @return 0 on success, < 0 on failure
4134  */
4135 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4136
4137
4138 /**
4139  * Convenience function to free all the side data stored.
4140  * All the other fields stay untouched.
4141  *
4142  * @param pkt packet
4143  */
4144 void av_packet_free_side_data(AVPacket *pkt);
4145
4146 /**
4147  * Setup a new reference to the data described by a given packet
4148  *
4149  * If src is reference-counted, setup dst as a new reference to the
4150  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4151  * data from src into it.
4152  *
4153  * All the other fields are copied from src.
4154  *
4155  * @see av_packet_unref
4156  *
4157  * @param dst Destination packet
4158  * @param src Source packet
4159  *
4160  * @return 0 on success, a negative AVERROR on error.
4161  */
4162 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4163
4164 /**
4165  * Wipe the packet.
4166  *
4167  * Unreference the buffer referenced by the packet and reset the
4168  * remaining packet fields to their default values.
4169  *
4170  * @param pkt The packet to be unreferenced.
4171  */
4172 void av_packet_unref(AVPacket *pkt);
4173
4174 /**
4175  * Move every field in src to dst and reset src.
4176  *
4177  * @see av_packet_unref
4178  *
4179  * @param src Source packet, will be reset
4180  * @param dst Destination packet
4181  */
4182 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4183
4184 /**
4185  * Copy only "properties" fields from src to dst.
4186  *
4187  * Properties for the purpose of this function are all the fields
4188  * beside those related to the packet data (buf, data, size)
4189  *
4190  * @param dst Destination packet
4191  * @param src Source packet
4192  *
4193  * @return 0 on success AVERROR on failure.
4194  */
4195 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4196
4197 /**
4198  * Convert valid timing fields (timestamps / durations) in a packet from one
4199  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4200  * ignored.
4201  *
4202  * @param pkt packet on which the conversion will be performed
4203  * @param tb_src source timebase, in which the timing fields in pkt are
4204  *               expressed
4205  * @param tb_dst destination timebase, to which the timing fields will be
4206  *               converted
4207  */
4208 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4209
4210 /**
4211  * @}
4212  */
4213
4214 /**
4215  * @addtogroup lavc_decoding
4216  * @{
4217  */
4218
4219 /**
4220  * Find a registered decoder with a matching codec ID.
4221  *
4222  * @param id AVCodecID of the requested decoder
4223  * @return A decoder if one was found, NULL otherwise.
4224  */
4225 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4226
4227 /**
4228  * Find a registered decoder with the specified name.
4229  *
4230  * @param name name of the requested decoder
4231  * @return A decoder if one was found, NULL otherwise.
4232  */
4233 AVCodec *avcodec_find_decoder_by_name(const char *name);
4234
4235 /**
4236  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4237  * it can be called by custom get_buffer2() implementations for decoders without
4238  * AV_CODEC_CAP_DR1 set.
4239  */
4240 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4241
4242 #if FF_API_EMU_EDGE
4243 /**
4244  * Return the amount of padding in pixels which the get_buffer callback must
4245  * provide around the edge of the image for codecs which do not have the
4246  * CODEC_FLAG_EMU_EDGE flag.
4247  *
4248  * @return Required padding in pixels.
4249  *
4250  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4251  * needed
4252  */
4253 attribute_deprecated
4254 unsigned avcodec_get_edge_width(void);
4255 #endif
4256
4257 /**
4258  * Modify width and height values so that they will result in a memory
4259  * buffer that is acceptable for the codec if you do not use any horizontal
4260  * padding.
4261  *
4262  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4263  */
4264 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4265
4266 /**
4267  * Modify width and height values so that they will result in a memory
4268  * buffer that is acceptable for the codec if you also ensure that all
4269  * line sizes are a multiple of the respective linesize_align[i].
4270  *
4271  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4272  */
4273 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4274                                int linesize_align[AV_NUM_DATA_POINTERS]);
4275
4276 /**
4277  * Converts AVChromaLocation to swscale x/y chroma position.
4278  *
4279  * The positions represent the chroma (0,0) position in a coordinates system
4280  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4281  *
4282  * @param xpos  horizontal chroma sample position
4283  * @param ypos  vertical   chroma sample position
4284  */
4285 int avcodec_enum_to_chroma_pos(int *xpos, int *ypos, enum AVChromaLocation pos);
4286
4287 /**
4288  * Converts swscale x/y chroma position to AVChromaLocation.
4289  *
4290  * The positions represent the chroma (0,0) position in a coordinates system
4291  * with luma (0,0) representing the origin and luma(1,1) representing 256,256
4292  *
4293  * @param xpos  horizontal chroma sample position
4294  * @param ypos  vertical   chroma sample position
4295  */
4296 enum AVChromaLocation avcodec_chroma_pos_to_enum(int xpos, int ypos);
4297
4298 /**
4299  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4300  *
4301  * Some decoders may support multiple frames in a single AVPacket. Such
4302  * decoders would then just decode the first frame and the return value would be
4303  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4304  * called again with an AVPacket containing the remaining data in order to
4305  * decode the second frame, etc...  Even if no frames are returned, the packet
4306  * needs to be fed to the decoder with remaining data until it is completely
4307  * consumed or an error occurs.
4308  *
4309  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4310  * and output. This means that for some packets they will not immediately
4311  * produce decoded output and need to be flushed at the end of decoding to get
4312  * all the decoded data. Flushing is done by calling this function with packets
4313  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4314  * returning samples. It is safe to flush even those decoders that are not
4315  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4316  *
4317  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4318  *          larger than the actual read bytes because some optimized bitstream
4319  *          readers read 32 or 64 bits at once and could read over the end.
4320  *
4321  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4322  * before packets may be fed to the decoder.
4323  *
4324  * @param      avctx the codec context
4325  * @param[out] frame The AVFrame in which to store decoded audio samples.
4326  *                   The decoder will allocate a buffer for the decoded frame by
4327  *                   calling the AVCodecContext.get_buffer2() callback.
4328  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
4329  *                   reference counted and the returned reference belongs to the
4330  *                   caller. The caller must release the frame using av_frame_unref()
4331  *                   when the frame is no longer needed. The caller may safely write
4332  *                   to the frame if av_frame_is_writable() returns 1.
4333  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
4334  *                   reference belongs to the decoder and is valid only until the
4335  *                   next call to this function or until closing or flushing the
4336  *                   decoder. The caller may not write to it.
4337  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4338  *                           non-zero. Note that this field being set to zero
4339  *                           does not mean that an error has occurred. For
4340  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
4341  *                           call is guaranteed to produce a frame.
4342  * @param[in]  avpkt The input AVPacket containing the input buffer.
4343  *                   At least avpkt->data and avpkt->size should be set. Some
4344  *                   decoders might also require additional fields to be set.
4345  * @return A negative error code is returned if an error occurred during
4346  *         decoding, otherwise the number of bytes consumed from the input
4347  *         AVPacket is returned.
4348  */
4349 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4350                           int *got_frame_ptr, const AVPacket *avpkt);
4351
4352 /**
4353  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4354  * Some decoders may support multiple frames in a single AVPacket, such
4355  * decoders would then just decode the first frame.
4356  *
4357  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4358  * the actual read bytes because some optimized bitstream readers read 32 or 64
4359  * bits at once and could read over the end.
4360  *
4361  * @warning The end of the input buffer buf should be set to 0 to ensure that
4362  * no overreading happens for damaged MPEG streams.
4363  *
4364  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4365  * between input and output, these need to be fed with avpkt->data=NULL,
4366  * avpkt->size=0 at the end to return the remaining frames.
4367  *
4368  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4369  * before packets may be fed to the decoder.
4370  *
4371  * @param avctx the codec context
4372  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4373  *             Use av_frame_alloc() to get an AVFrame. The codec will
4374  *             allocate memory for the actual bitmap by calling the
4375  *             AVCodecContext.get_buffer2() callback.
4376  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
4377  *             reference counted and the returned reference belongs to the
4378  *             caller. The caller must release the frame using av_frame_unref()
4379  *             when the frame is no longer needed. The caller may safely write
4380  *             to the frame if av_frame_is_writable() returns 1.
4381  *             When AVCodecContext.refcounted_frames is set to 0, the returned
4382  *             reference belongs to the decoder and is valid only until the
4383  *             next call to this function or until closing or flushing the
4384  *             decoder. The caller may not write to it.
4385  *
4386  * @param[in] avpkt The input AVPacket containing the input buffer.
4387  *            You can create such packet with av_init_packet() and by then setting
4388  *            data and size, some decoders might in addition need other fields like
4389  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4390  *            fields possible.
4391  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4392  * @return On error a negative value is returned, otherwise the number of bytes
4393  * used or zero if no frame could be decompressed.
4394  */
4395 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4396                          int *got_picture_ptr,
4397                          const AVPacket *avpkt);
4398
4399 /**
4400  * Decode a subtitle message.
4401  * Return a negative value on error, otherwise return the number of bytes used.
4402  * If no subtitle could be decompressed, got_sub_ptr is zero.
4403  * Otherwise, the subtitle is stored in *sub.
4404  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4405  * simplicity, because the performance difference is expect to be negligible
4406  * and reusing a get_buffer written for video codecs would probably perform badly
4407  * due to a potentially very different allocation pattern.
4408  *
4409  * Some decoders (those marked with CODEC_CAP_DELAY) have a delay between input
4410  * and output. This means that for some packets they will not immediately
4411  * produce decoded output and need to be flushed at the end of decoding to get
4412  * all the decoded data. Flushing is done by calling this function with packets
4413  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4414  * returning subtitles. It is safe to flush even those decoders that are not
4415  * marked with CODEC_CAP_DELAY, then no subtitles will be returned.
4416  *
4417  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4418  * before packets may be fed to the decoder.
4419  *
4420  * @param avctx the codec context
4421  * @param[out] sub The Preallocated AVSubtitle in which the decoded subtitle will be stored,
4422  *                 must be freed with avsubtitle_free if *got_sub_ptr is set.
4423  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4424  * @param[in] avpkt The input AVPacket containing the input buffer.
4425  */
4426 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4427                             int *got_sub_ptr,
4428                             AVPacket *avpkt);
4429
4430 /**
4431  * @defgroup lavc_parsing Frame parsing
4432  * @{
4433  */
4434
4435 enum AVPictureStructure {
4436     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
4437     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
4438     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4439     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
4440 };
4441
4442 typedef struct AVCodecParserContext {
4443     void *priv_data;
4444     struct AVCodecParser *parser;
4445     int64_t frame_offset; /* offset of the current frame */
4446     int64_t cur_offset; /* current offset
4447                            (incremented by each av_parser_parse()) */
4448     int64_t next_frame_offset; /* offset of the next frame */
4449     /* video info */
4450     int pict_type; /* XXX: Put it back in AVCodecContext. */
4451     /**
4452      * This field is used for proper frame duration computation in lavf.
4453      * It signals, how much longer the frame duration of the current frame
4454      * is compared to normal frame duration.
4455      *
4456      * frame_duration = (1 + repeat_pict) * time_base
4457      *
4458      * It is used by codecs like H.264 to display telecined material.
4459      */
4460     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4461     int64_t pts;     /* pts of the current frame */
4462     int64_t dts;     /* dts of the current frame */
4463
4464     /* private data */
4465     int64_t last_pts;
4466     int64_t last_dts;
4467     int fetch_timestamp;
4468
4469 #define AV_PARSER_PTS_NB 4
4470     int cur_frame_start_index;
4471     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4472     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4473     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4474
4475     int flags;
4476 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4477 #define PARSER_FLAG_ONCE                      0x0002
4478 /// Set if the parser has a valid file offset
4479 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4480 #define PARSER_FLAG_USE_CODEC_TS              0x1000
4481
4482     int64_t offset;      ///< byte offset from starting packet start
4483     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4484
4485     /**
4486      * Set by parser to 1 for key frames and 0 for non-key frames.
4487      * It is initialized to -1, so if the parser doesn't set this flag,
4488      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4489      * will be used.
4490      */
4491     int key_frame;
4492
4493 #if FF_API_CONVERGENCE_DURATION
4494     /**
4495      * @deprecated unused
4496      */
4497     attribute_deprecated
4498     int64_t convergence_duration;
4499 #endif
4500
4501     // Timestamp generation support:
4502     /**
4503      * Synchronization point for start of timestamp generation.
4504      *
4505      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4506      * (default).
4507      *
4508      * For example, this corresponds to presence of H.264 buffering period
4509      * SEI message.
4510      */
4511     int dts_sync_point;
4512
4513     /**
4514      * Offset of the current timestamp against last timestamp sync point in
4515      * units of AVCodecContext.time_base.
4516      *
4517      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4518      * contain a valid timestamp offset.
4519      *
4520      * Note that the timestamp of sync point has usually a nonzero
4521      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4522      * the next frame after timestamp sync point will be usually 1.
4523      *
4524      * For example, this corresponds to H.264 cpb_removal_delay.
4525      */
4526     int dts_ref_dts_delta;
4527
4528     /**
4529      * Presentation delay of current frame in units of AVCodecContext.time_base.
4530      *
4531      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4532      * contain valid non-negative timestamp delta (presentation time of a frame
4533      * must not lie in the past).
4534      *
4535      * This delay represents the difference between decoding and presentation
4536      * time of the frame.
4537      *
4538      * For example, this corresponds to H.264 dpb_output_delay.
4539      */
4540     int pts_dts_delta;
4541
4542     /**
4543      * Position of the packet in file.
4544      *
4545      * Analogous to cur_frame_pts/dts
4546      */
4547     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4548
4549     /**
4550      * Byte position of currently parsed frame in stream.
4551      */
4552     int64_t pos;
4553
4554     /**
4555      * Previous frame byte position.
4556      */
4557     int64_t last_pos;
4558
4559     /**
4560      * Duration of the current frame.
4561      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4562      * For all other types, this is in units of AVCodecContext.time_base.
4563      */
4564     int duration;
4565
4566     enum AVFieldOrder field_order;
4567
4568     /**
4569      * Indicate whether a picture is coded as a frame, top field or bottom field.
4570      *
4571      * For example, H.264 field_pic_flag equal to 0 corresponds to
4572      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4573      * equal to 1 and bottom_field_flag equal to 0 corresponds to
4574      * AV_PICTURE_STRUCTURE_TOP_FIELD.
4575      */
4576     enum AVPictureStructure picture_structure;
4577
4578     /**
4579      * Picture number incremented in presentation or output order.
4580      * This field may be reinitialized at the first picture of a new sequence.
4581      *
4582      * For example, this corresponds to H.264 PicOrderCnt.
4583      */
4584     int output_picture_number;
4585
4586     /**
4587      * Dimensions of the decoded video intended for presentation.
4588      */
4589     int width;
4590     int height;
4591
4592     /**
4593      * Dimensions of the coded video.
4594      */
4595     int coded_width;
4596     int coded_height;
4597
4598     /**
4599      * The format of the coded data, corresponds to enum AVPixelFormat for video
4600      * and for enum AVSampleFormat for audio.
4601      *
4602      * Note that a decoder can have considerable freedom in how exactly it
4603      * decodes the data, so the format reported here might be different from the
4604      * one returned by a decoder.
4605      */
4606     int format;
4607 } AVCodecParserContext;
4608
4609 typedef struct AVCodecParser {
4610     int codec_ids[5]; /* several codec IDs are permitted */
4611     int priv_data_size;
4612     int (*parser_init)(AVCodecParserContext *s);
4613     /* This callback never returns an error, a negative value means that
4614      * the frame start was in a previous packet. */
4615     int (*parser_parse)(AVCodecParserContext *s,
4616                         AVCodecContext *avctx,
4617                         const uint8_t **poutbuf, int *poutbuf_size,
4618                         const uint8_t *buf, int buf_size);
4619     void (*parser_close)(AVCodecParserContext *s);
4620     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4621     struct AVCodecParser *next;
4622 } AVCodecParser;
4623
4624 AVCodecParser *av_parser_next(const AVCodecParser *c);
4625
4626 void av_register_codec_parser(AVCodecParser *parser);
4627 AVCodecParserContext *av_parser_init(int codec_id);
4628
4629 /**
4630  * Parse a packet.
4631  *
4632  * @param s             parser context.
4633  * @param avctx         codec context.
4634  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4635  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4636  * @param buf           input buffer.
4637  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4638  * @param pts           input presentation timestamp.
4639  * @param dts           input decoding timestamp.
4640  * @param pos           input byte position in stream.
4641  * @return the number of bytes of the input bitstream used.
4642  *
4643  * Example:
4644  * @code
4645  *   while(in_len){
4646  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4647  *                                        in_data, in_len,
4648  *                                        pts, dts, pos);
4649  *       in_data += len;
4650  *       in_len  -= len;
4651  *
4652  *       if(size)
4653  *          decode_frame(data, size);
4654  *   }
4655  * @endcode
4656  */
4657 int av_parser_parse2(AVCodecParserContext *s,
4658                      AVCodecContext *avctx,
4659                      uint8_t **poutbuf, int *poutbuf_size,
4660                      const uint8_t *buf, int buf_size,
4661                      int64_t pts, int64_t dts,
4662                      int64_t pos);
4663
4664 /**
4665  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4666  * @deprecated use AVBitStreamFilter
4667  */
4668 int av_parser_change(AVCodecParserContext *s,
4669                      AVCodecContext *avctx,
4670                      uint8_t **poutbuf, int *poutbuf_size,
4671                      const uint8_t *buf, int buf_size, int keyframe);
4672 void av_parser_close(AVCodecParserContext *s);
4673
4674 /**
4675  * @}
4676  * @}
4677  */
4678
4679 /**
4680  * @addtogroup lavc_encoding
4681  * @{
4682  */
4683
4684 /**
4685  * Find a registered encoder with a matching codec ID.
4686  *
4687  * @param id AVCodecID of the requested encoder
4688  * @return An encoder if one was found, NULL otherwise.
4689  */
4690 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4691
4692 /**
4693  * Find a registered encoder with the specified name.
4694  *
4695  * @param name name of the requested encoder
4696  * @return An encoder if one was found, NULL otherwise.
4697  */
4698 AVCodec *avcodec_find_encoder_by_name(const char *name);
4699
4700 /**
4701  * Encode a frame of audio.
4702  *
4703  * Takes input samples from frame and writes the next output packet, if
4704  * available, to avpkt. The output packet does not necessarily contain data for
4705  * the most recent frame, as encoders can delay, split, and combine input frames
4706  * internally as needed.
4707  *
4708  * @param avctx     codec context
4709  * @param avpkt     output AVPacket.
4710  *                  The user can supply an output buffer by setting
4711  *                  avpkt->data and avpkt->size prior to calling the
4712  *                  function, but if the size of the user-provided data is not
4713  *                  large enough, encoding will fail. If avpkt->data and
4714  *                  avpkt->size are set, avpkt->destruct must also be set. All
4715  *                  other AVPacket fields will be reset by the encoder using
4716  *                  av_init_packet(). If avpkt->data is NULL, the encoder will
4717  *                  allocate it. The encoder will set avpkt->size to the size
4718  *                  of the output packet.
4719  *
4720  *                  If this function fails or produces no output, avpkt will be
4721  *                  freed using av_packet_unref().
4722  * @param[in] frame AVFrame containing the raw audio data to be encoded.
4723  *                  May be NULL when flushing an encoder that has the
4724  *                  AV_CODEC_CAP_DELAY capability set.
4725  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4726  *                  can have any number of samples.
4727  *                  If it is not set, frame->nb_samples must be equal to
4728  *                  avctx->frame_size for all frames except the last.
4729  *                  The final frame may be smaller than avctx->frame_size.
4730  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4731  *                            output packet is non-empty, and to 0 if it is
4732  *                            empty. If the function returns an error, the
4733  *                            packet can be assumed to be invalid, and the
4734  *                            value of got_packet_ptr is undefined and should
4735  *                            not be used.
4736  * @return          0 on success, negative error code on failure
4737  */
4738 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4739                           const AVFrame *frame, int *got_packet_ptr);
4740
4741 /**
4742  * Encode a frame of video.
4743  *
4744  * Takes input raw video data from frame and writes the next output packet, if
4745  * available, to avpkt. The output packet does not necessarily contain data for
4746  * the most recent frame, as encoders can delay and reorder input frames
4747  * internally as needed.
4748  *
4749  * @param avctx     codec context
4750  * @param avpkt     output AVPacket.
4751  *                  The user can supply an output buffer by setting
4752  *                  avpkt->data and avpkt->size prior to calling the
4753  *                  function, but if the size of the user-provided data is not
4754  *                  large enough, encoding will fail. All other AVPacket fields
4755  *                  will be reset by the encoder using av_init_packet(). If
4756  *                  avpkt->data is NULL, the encoder will allocate it.
4757  *                  The encoder will set avpkt->size to the size of the
4758  *                  output packet. The returned data (if any) belongs to the
4759  *                  caller, he is responsible for freeing it.
4760  *
4761  *                  If this function fails or produces no output, avpkt will be
4762  *                  freed using av_packet_unref().
4763  * @param[in] frame AVFrame containing the raw video data to be encoded.
4764  *                  May be NULL when flushing an encoder that has the
4765  *                  AV_CODEC_CAP_DELAY capability set.
4766  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4767  *                            output packet is non-empty, and to 0 if it is
4768  *                            empty. If the function returns an error, the
4769  *                            packet can be assumed to be invalid, and the
4770  *                            value of got_packet_ptr is undefined and should
4771  *                            not be used.
4772  * @return          0 on success, negative error code on failure
4773  */
4774 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4775                           const AVFrame *frame, int *got_packet_ptr);
4776
4777 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4778                             const AVSubtitle *sub);
4779
4780
4781 /**
4782  * @}
4783  */
4784
4785 #if FF_API_AVCODEC_RESAMPLE
4786 /**
4787  * @defgroup lavc_resample Audio resampling
4788  * @ingroup libavc
4789  * @deprecated use libswresample instead
4790  *
4791  * @{
4792  */
4793 struct ReSampleContext;
4794 struct AVResampleContext;
4795
4796 typedef struct ReSampleContext ReSampleContext;
4797
4798 /**
4799  *  Initialize audio resampling context.
4800  *
4801  * @param output_channels  number of output channels
4802  * @param input_channels   number of input channels
4803  * @param output_rate      output sample rate
4804  * @param input_rate       input sample rate
4805  * @param sample_fmt_out   requested output sample format
4806  * @param sample_fmt_in    input sample format
4807  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
4808  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4809  * @param linear           if 1 then the used FIR filter will be linearly interpolated
4810                            between the 2 closest, if 0 the closest will be used
4811  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
4812  * @return allocated ReSampleContext, NULL if error occurred
4813  */
4814 attribute_deprecated
4815 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
4816                                         int output_rate, int input_rate,
4817                                         enum AVSampleFormat sample_fmt_out,
4818                                         enum AVSampleFormat sample_fmt_in,
4819                                         int filter_length, int log2_phase_count,
4820                                         int linear, double cutoff);
4821
4822 attribute_deprecated
4823 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
4824
4825 /**
4826  * Free resample context.
4827  *
4828  * @param s a non-NULL pointer to a resample context previously
4829  *          created with av_audio_resample_init()
4830  */
4831 attribute_deprecated
4832 void audio_resample_close(ReSampleContext *s);
4833
4834
4835 /**
4836  * Initialize an audio resampler.
4837  * Note, if either rate is not an integer then simply scale both rates up so they are.
4838  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
4839  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
4840  * @param linear If 1 then the used FIR filter will be linearly interpolated
4841                  between the 2 closest, if 0 the closest will be used
4842  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
4843  */
4844 attribute_deprecated
4845 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
4846
4847 /**
4848  * Resample an array of samples using a previously configured context.
4849  * @param src an array of unconsumed samples
4850  * @param consumed the number of samples of src which have been consumed are returned here
4851  * @param src_size the number of unconsumed samples available
4852  * @param dst_size the amount of space in samples available in dst
4853  * @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.
4854  * @return the number of samples written in dst or -1 if an error occurred
4855  */
4856 attribute_deprecated
4857 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
4858
4859
4860 /**
4861  * Compensate samplerate/timestamp drift. The compensation is done by changing
4862  * the resampler parameters, so no audible clicks or similar distortions occur
4863  * @param compensation_distance distance in output samples over which the compensation should be performed
4864  * @param sample_delta number of output samples which should be output less
4865  *
4866  * example: av_resample_compensate(c, 10, 500)
4867  * here instead of 510 samples only 500 samples would be output
4868  *
4869  * note, due to rounding the actual compensation might be slightly different,
4870  * especially if the compensation_distance is large and the in_rate used during init is small
4871  */
4872 attribute_deprecated
4873 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
4874 attribute_deprecated
4875 void av_resample_close(struct AVResampleContext *c);
4876
4877 /**
4878  * @}
4879  */
4880 #endif
4881
4882 #if FF_API_AVPICTURE
4883 /**
4884  * @addtogroup lavc_picture
4885  * @{
4886  */
4887
4888 /**
4889  * @deprecated unused
4890  */
4891 attribute_deprecated
4892 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4893
4894 /**
4895  * @deprecated unused
4896  */
4897 attribute_deprecated
4898 void avpicture_free(AVPicture *picture);
4899
4900 /**
4901  * @deprecated use av_image_fill_arrays() instead.
4902  */
4903 attribute_deprecated
4904 int avpicture_fill(AVPicture *picture, const uint8_t *ptr,
4905                    enum AVPixelFormat pix_fmt, int width, int height);
4906
4907 /**
4908  * @deprecated use av_image_copy_to_buffer() instead.
4909  */
4910 attribute_deprecated
4911 int avpicture_layout(const AVPicture *src, enum AVPixelFormat pix_fmt,
4912                      int width, int height,
4913                      unsigned char *dest, int dest_size);
4914
4915 /**
4916  * @deprecated use av_image_get_buffer_size() instead.
4917  */
4918 attribute_deprecated
4919 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4920
4921 /**
4922  * @deprecated av_image_copy() instead.
4923  */
4924 attribute_deprecated
4925 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4926                      enum AVPixelFormat pix_fmt, int width, int height);
4927
4928 /**
4929  * @deprecated unused
4930  */
4931 attribute_deprecated
4932 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4933                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
4934
4935 /**
4936  * @deprecated unused
4937  */
4938 attribute_deprecated
4939 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4940             int padtop, int padbottom, int padleft, int padright, int *color);
4941
4942 /**
4943  * @}
4944  */
4945 #endif
4946
4947 /**
4948  * @defgroup lavc_misc Utility functions
4949  * @ingroup libavc
4950  *
4951  * Miscellaneous utility functions related to both encoding and decoding
4952  * (or neither).
4953  * @{
4954  */
4955
4956 /**
4957  * @defgroup lavc_misc_pixfmt Pixel formats
4958  *
4959  * Functions for working with pixel formats.
4960  * @{
4961  */
4962
4963 /**
4964  * Utility function to access log2_chroma_w log2_chroma_h from
4965  * the pixel format AVPixFmtDescriptor.
4966  *
4967  * This function asserts that pix_fmt is valid. See av_pix_fmt_get_chroma_sub_sample
4968  * for one that returns a failure code and continues in case of invalid
4969  * pix_fmts.
4970  *
4971  * @param[in]  pix_fmt the pixel format
4972  * @param[out] h_shift store log2_chroma_w
4973  * @param[out] v_shift store log2_chroma_h
4974  *
4975  * @see av_pix_fmt_get_chroma_sub_sample
4976  */
4977
4978 void avcodec_get_chroma_sub_sample(enum AVPixelFormat pix_fmt, int *h_shift, int *v_shift);
4979
4980 /**
4981  * Return a value representing the fourCC code associated to the
4982  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4983  * found.
4984  */
4985 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4986
4987 /**
4988  * @deprecated see av_get_pix_fmt_loss()
4989  */
4990 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4991                              int has_alpha);
4992
4993 /**
4994  * Find the best pixel format to convert to given a certain source pixel
4995  * format.  When converting from one pixel format to another, information loss
4996  * may occur.  For example, when converting from RGB24 to GRAY, the color
4997  * information will be lost. Similarly, other losses occur when converting from
4998  * some formats to other formats. avcodec_find_best_pix_fmt_of_2() searches which of
4999  * the given pixel formats should be used to suffer the least amount of loss.
5000  * The pixel formats from which it chooses one, are determined by the
5001  * pix_fmt_list parameter.
5002  *
5003  *
5004  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
5005  * @param[in] src_pix_fmt source pixel format
5006  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
5007  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
5008  * @return The best pixel format to convert to or -1 if none was found.
5009  */
5010 enum AVPixelFormat avcodec_find_best_pix_fmt_of_list(const enum AVPixelFormat *pix_fmt_list,
5011                                             enum AVPixelFormat src_pix_fmt,
5012                                             int has_alpha, int *loss_ptr);
5013
5014 /**
5015  * @deprecated see av_find_best_pix_fmt_of_2()
5016  */
5017 enum AVPixelFormat avcodec_find_best_pix_fmt_of_2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5018                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5019
5020 attribute_deprecated
5021 #if AV_HAVE_INCOMPATIBLE_LIBAV_ABI
5022 enum AVPixelFormat avcodec_find_best_pix_fmt2(const enum AVPixelFormat *pix_fmt_list,
5023                                               enum AVPixelFormat src_pix_fmt,
5024                                               int has_alpha, int *loss_ptr);
5025 #else
5026 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat dst_pix_fmt1, enum AVPixelFormat dst_pix_fmt2,
5027                                             enum AVPixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
5028 #endif
5029
5030
5031 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
5032
5033 /**
5034  * @}
5035  */
5036
5037 #if FF_API_SET_DIMENSIONS
5038 /**
5039  * @deprecated this function is not supposed to be used from outside of lavc
5040  */
5041 attribute_deprecated
5042 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
5043 #endif
5044
5045 /**
5046  * Put a string representing the codec tag codec_tag in buf.
5047  *
5048  * @param buf       buffer to place codec tag in
5049  * @param buf_size size in bytes of buf
5050  * @param codec_tag codec tag to assign
5051  * @return the length of the string that would have been generated if
5052  * enough space had been available, excluding the trailing null
5053  */
5054 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
5055
5056 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
5057
5058 /**
5059  * Return a name for the specified profile, if available.
5060  *
5061  * @param codec the codec that is searched for the given profile
5062  * @param profile the profile value for which a name is requested
5063  * @return A name for the profile if found, NULL otherwise.
5064  */
5065 const char *av_get_profile_name(const AVCodec *codec, int profile);
5066
5067 /**
5068  * Return a name for the specified profile, if available.
5069  *
5070  * @param codec_id the ID of the codec to which the requested profile belongs
5071  * @param profile the profile value for which a name is requested
5072  * @return A name for the profile if found, NULL otherwise.
5073  *
5074  * @note unlike av_get_profile_name(), which searches a list of profiles
5075  *       supported by a specific decoder or encoder implementation, this
5076  *       function searches the list of profiles from the AVCodecDescriptor
5077  */
5078 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
5079
5080 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
5081 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
5082 //FIXME func typedef
5083
5084 /**
5085  * Fill AVFrame audio data and linesize pointers.
5086  *
5087  * The buffer buf must be a preallocated buffer with a size big enough
5088  * to contain the specified samples amount. The filled AVFrame data
5089  * pointers will point to this buffer.
5090  *
5091  * AVFrame extended_data channel pointers are allocated if necessary for
5092  * planar audio.
5093  *
5094  * @param frame       the AVFrame
5095  *                    frame->nb_samples must be set prior to calling the
5096  *                    function. This function fills in frame->data,
5097  *                    frame->extended_data, frame->linesize[0].
5098  * @param nb_channels channel count
5099  * @param sample_fmt  sample format
5100  * @param buf         buffer to use for frame data
5101  * @param buf_size    size of buffer
5102  * @param align       plane size sample alignment (0 = default)
5103  * @return            >=0 on success, negative error code on failure
5104  * @todo return the size in bytes required to store the samples in
5105  * case of success, at the next libavutil bump
5106  */
5107 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
5108                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
5109                              int buf_size, int align);
5110
5111 /**
5112  * Reset the internal decoder state / flush internal buffers. Should be called
5113  * e.g. when seeking or when switching to a different stream.
5114  *
5115  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5116  * this invalidates the frames previously returned from the decoder. When
5117  * refcounted frames are used, the decoder just releases any references it might
5118  * keep internally, but the caller's reference remains valid.
5119  */
5120 void avcodec_flush_buffers(AVCodecContext *avctx);
5121
5122 /**
5123  * Return codec bits per sample.
5124  *
5125  * @param[in] codec_id the codec
5126  * @return Number of bits per sample or zero if unknown for the given codec.
5127  */
5128 int av_get_bits_per_sample(enum AVCodecID codec_id);
5129
5130 /**
5131  * Return the PCM codec associated with a sample format.
5132  * @param be  endianness, 0 for little, 1 for big,
5133  *            -1 (or anything else) for native
5134  * @return  AV_CODEC_ID_PCM_* or AV_CODEC_ID_NONE
5135  */
5136 enum AVCodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
5137
5138 /**
5139  * Return codec bits per sample.
5140  * Only return non-zero if the bits per sample is exactly correct, not an
5141  * approximation.
5142  *
5143  * @param[in] codec_id the codec
5144  * @return Number of bits per sample or zero if unknown for the given codec.
5145  */
5146 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5147
5148 /**
5149  * Return audio frame duration.
5150  *
5151  * @param avctx        codec context
5152  * @param frame_bytes  size of the frame, or 0 if unknown
5153  * @return             frame duration, in samples, if known. 0 if not able to
5154  *                     determine.
5155  */
5156 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5157
5158
5159 typedef struct AVBitStreamFilterContext {
5160     void *priv_data;
5161     struct AVBitStreamFilter *filter;
5162     AVCodecParserContext *parser;
5163     struct AVBitStreamFilterContext *next;
5164     /**
5165      * Internal default arguments, used if NULL is passed to av_bitstream_filter_filter().
5166      * Not for access by library users.
5167      */
5168     char *args;
5169 } AVBitStreamFilterContext;
5170
5171
5172 typedef struct AVBitStreamFilter {
5173     const char *name;
5174     int priv_data_size;
5175     int (*filter)(AVBitStreamFilterContext *bsfc,
5176                   AVCodecContext *avctx, const char *args,
5177                   uint8_t **poutbuf, int *poutbuf_size,
5178                   const uint8_t *buf, int buf_size, int keyframe);
5179     void (*close)(AVBitStreamFilterContext *bsfc);
5180     struct AVBitStreamFilter *next;
5181 } AVBitStreamFilter;
5182
5183 /**
5184  * Register a bitstream filter.
5185  *
5186  * The filter will be accessible to the application code through
5187  * av_bitstream_filter_next() or can be directly initialized with
5188  * av_bitstream_filter_init().
5189  *
5190  * @see avcodec_register_all()
5191  */
5192 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5193
5194 /**
5195  * Create and initialize a bitstream filter context given a bitstream
5196  * filter name.
5197  *
5198  * The returned context must be freed with av_bitstream_filter_close().
5199  *
5200  * @param name    the name of the bitstream filter
5201  * @return a bitstream filter context if a matching filter was found
5202  * and successfully initialized, NULL otherwise
5203  */
5204 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5205
5206 /**
5207  * Filter bitstream.
5208  *
5209  * This function filters the buffer buf with size buf_size, and places the
5210  * filtered buffer in the buffer pointed to by poutbuf.
5211  *
5212  * The output buffer must be freed by the caller.
5213  *
5214  * @param bsfc            bitstream filter context created by av_bitstream_filter_init()
5215  * @param avctx           AVCodecContext accessed by the filter, may be NULL.
5216  *                        If specified, this must point to the encoder context of the
5217  *                        output stream the packet is sent to.
5218  * @param args            arguments which specify the filter configuration, may be NULL
5219  * @param poutbuf         pointer which is updated to point to the filtered buffer
5220  * @param poutbuf_size    pointer which is updated to the filtered buffer size in bytes
5221  * @param buf             buffer containing the data to filter
5222  * @param buf_size        size in bytes of buf
5223  * @param keyframe        set to non-zero if the buffer to filter corresponds to a key-frame packet data
5224  * @return >= 0 in case of success, or a negative error code in case of failure
5225  *
5226  * If the return value is positive, an output buffer is allocated and
5227  * is available in *poutbuf, and is distinct from the input buffer.
5228  *
5229  * If the return value is 0, the output buffer is not allocated and
5230  * should be considered identical to the input buffer, or in case
5231  * *poutbuf was set it points to the input buffer (not necessarily to
5232  * its starting address).
5233  */
5234 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5235                                AVCodecContext *avctx, const char *args,
5236                                uint8_t **poutbuf, int *poutbuf_size,
5237                                const uint8_t *buf, int buf_size, int keyframe);
5238
5239 /**
5240  * Release bitstream filter context.
5241  *
5242  * @param bsf the bitstream filter context created with
5243  * av_bitstream_filter_init(), can be NULL
5244  */
5245 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5246
5247 /**
5248  * If f is NULL, return the first registered bitstream filter,
5249  * if f is non-NULL, return the next registered bitstream filter
5250  * after f, or NULL if f is the last one.
5251  *
5252  * This function can be used to iterate over all registered bitstream
5253  * filters.
5254  */
5255 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5256
5257 /* memory */
5258
5259 /**
5260  * Same behaviour av_fast_malloc but the buffer has additional
5261  * AV_INPUT_BUFFER_PADDING_SIZE at the end which will always be 0.
5262  *
5263  * In addition the whole buffer will initially and after resizes
5264  * be 0-initialized so that no uninitialized data will ever appear.
5265  */
5266 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5267
5268 /**
5269  * Same behaviour av_fast_padded_malloc except that buffer will always
5270  * be 0-initialized after call.
5271  */
5272 void av_fast_padded_mallocz(void *ptr, unsigned int *size, size_t min_size);
5273
5274 /**
5275  * Encode extradata length to a buffer. Used by xiph codecs.
5276  *
5277  * @param s buffer to write to; must be at least (v/255+1) bytes long
5278  * @param v size of extradata in bytes
5279  * @return number of bytes written to the buffer.
5280  */
5281 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5282
5283 #if FF_API_MISSING_SAMPLE
5284 /**
5285  * Log a generic warning message about a missing feature. This function is
5286  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5287  * only, and would normally not be used by applications.
5288  * @param[in] avc a pointer to an arbitrary struct of which the first field is
5289  * a pointer to an AVClass struct
5290  * @param[in] feature string containing the name of the missing feature
5291  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
5292  * If want_sample is non-zero, additional verbage will be added to the log
5293  * message which tells the user how to report samples to the development
5294  * mailing list.
5295  * @deprecated Use avpriv_report_missing_feature() instead.
5296  */
5297 attribute_deprecated
5298 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
5299
5300 /**
5301  * Log a generic warning message asking for a sample. This function is
5302  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
5303  * only, and would normally not be used by applications.
5304  * @param[in] avc a pointer to an arbitrary struct of which the first field is
5305  * a pointer to an AVClass struct
5306  * @param[in] msg string containing an optional message, or NULL if no message
5307  * @deprecated Use avpriv_request_sample() instead.
5308  */
5309 attribute_deprecated
5310 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
5311 #endif /* FF_API_MISSING_SAMPLE */
5312
5313 /**
5314  * Register the hardware accelerator hwaccel.
5315  */
5316 void av_register_hwaccel(AVHWAccel *hwaccel);
5317
5318 /**
5319  * If hwaccel is NULL, returns the first registered hardware accelerator,
5320  * if hwaccel is non-NULL, returns the next registered hardware accelerator
5321  * after hwaccel, or NULL if hwaccel is the last one.
5322  */
5323 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5324
5325
5326 /**
5327  * Lock operation used by lockmgr
5328  */
5329 enum AVLockOp {
5330   AV_LOCK_CREATE,  ///< Create a mutex
5331   AV_LOCK_OBTAIN,  ///< Lock the mutex
5332   AV_LOCK_RELEASE, ///< Unlock the mutex
5333   AV_LOCK_DESTROY, ///< Free mutex resources
5334 };
5335
5336 /**
5337  * Register a user provided lock manager supporting the operations
5338  * specified by AVLockOp. The "mutex" argument to the function points
5339  * to a (void *) where the lockmgr should store/get a pointer to a user
5340  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5341  * value left by the last call for all other ops. If the lock manager is
5342  * unable to perform the op then it should leave the mutex in the same
5343  * state as when it was called and return a non-zero value. However,
5344  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5345  * have been successfully destroyed. If av_lockmgr_register succeeds
5346  * it will return a non-negative value, if it fails it will return a
5347  * negative value and destroy all mutex and unregister all callbacks.
5348  * av_lockmgr_register is not thread-safe, it must be called from a
5349  * single thread before any calls which make use of locking are used.
5350  *
5351  * @param cb User defined callback. av_lockmgr_register invokes calls
5352  *           to this callback and the previously registered callback.
5353  *           The callback will be used to create more than one mutex
5354  *           each of which must be backed by its own underlying locking
5355  *           mechanism (i.e. do not use a single static object to
5356  *           implement your lock manager). If cb is set to NULL the
5357  *           lockmgr will be unregistered.
5358  */
5359 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5360
5361 /**
5362  * Get the type of the given codec.
5363  */
5364 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5365
5366 /**
5367  * Get the name of a codec.
5368  * @return  a static string identifying the codec; never NULL
5369  */
5370 const char *avcodec_get_name(enum AVCodecID id);
5371
5372 /**
5373  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5374  * with no corresponding avcodec_close()), 0 otherwise.
5375  */
5376 int avcodec_is_open(AVCodecContext *s);
5377
5378 /**
5379  * @return a non-zero number if codec is an encoder, zero otherwise
5380  */
5381 int av_codec_is_encoder(const AVCodec *codec);
5382
5383 /**
5384  * @return a non-zero number if codec is a decoder, zero otherwise
5385  */
5386 int av_codec_is_decoder(const AVCodec *codec);
5387
5388 /**
5389  * @return descriptor for given codec ID or NULL if no descriptor exists.
5390  */
5391 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5392
5393 /**
5394  * Iterate over all codec descriptors known to libavcodec.
5395  *
5396  * @param prev previous descriptor. NULL to get the first descriptor.
5397  *
5398  * @return next descriptor or NULL after the last descriptor
5399  */
5400 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5401
5402 /**
5403  * @return codec descriptor with the given name or NULL if no such descriptor
5404  *         exists.
5405  */
5406 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5407
5408 /**
5409  * Allocate a CPB properties structure and initialize its fields to default
5410  * values.
5411  *
5412  * @param size if non-NULL, the size of the allocated struct will be written
5413  *             here. This is useful for embedding it in side data.
5414  *
5415  * @return the newly allocated struct or NULL on failure
5416  */
5417 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5418
5419 /**
5420  * @}
5421  */
5422
5423 #endif /* AVCODEC_AVCODEC_H */