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

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