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