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