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