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