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