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