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

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