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