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