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