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