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