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