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