git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

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