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

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