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