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