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