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

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