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