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

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