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