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