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