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