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

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