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