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

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