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