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