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