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

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