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