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