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