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     /**
1284      * Some codecs need additional format info. It is stored here.
1285      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1286      * specific codec MUST set it correctly otherwise stream copy breaks.
1287      * In general use of this field by muxers is not recommended.
1288      * - encoding: Set by libavcodec.
1289      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1290      */
1291     int sub_id;
1292
1293     void *priv_data;
1294
1295     /**
1296      * Private context used for internal data.
1297      *
1298      * Unlike priv_data, this is not codec-specific. It is used in general
1299      * libavcodec functions.
1300      */
1301     struct AVCodecInternal *internal;
1302
1303     /**
1304      * Private data of the user, can be used to carry app specific stuff.
1305      * - encoding: Set by user.
1306      * - decoding: Set by user.
1307      */
1308     void *opaque;
1309
1310     /**
1311      * the average bitrate
1312      * - encoding: Set by user; unused for constant quantizer encoding.
1313      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1314      */
1315     int bit_rate;
1316
1317     /**
1318      * number of bits the bitstream is allowed to diverge from the reference.
1319      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1320      * - encoding: Set by user; unused for constant quantizer encoding.
1321      * - decoding: unused
1322      */
1323     int bit_rate_tolerance;
1324
1325     /**
1326      * Global quality for codecs which cannot change it per frame.
1327      * This should be proportional to MPEG-1/2/4 qscale.
1328      * - encoding: Set by user.
1329      * - decoding: unused
1330      */
1331     int global_quality;
1332
1333     /**
1334      * - encoding: Set by user.
1335      * - decoding: unused
1336      */
1337     int compression_level;
1338 #define FF_COMPRESSION_DEFAULT -1
1339
1340     /**
1341      * CODEC_FLAG_*.
1342      * - encoding: Set by user.
1343      * - decoding: Set by user.
1344      */
1345     int flags;
1346
1347     /**
1348      * CODEC_FLAG2_*
1349      * - encoding: Set by user.
1350      * - decoding: Set by user.
1351      */
1352     int flags2;
1353
1354     /**
1355      * some codecs need / can use extradata like Huffman tables.
1356      * mjpeg: Huffman tables
1357      * rv10: additional flags
1358      * mpeg4: global headers (they can be in the bitstream or here)
1359      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1360      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1361      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1362      * - encoding: Set/allocated/freed by libavcodec.
1363      * - decoding: Set/allocated/freed by user.
1364      */
1365     uint8_t *extradata;
1366     int extradata_size;
1367
1368     /**
1369      * This is the fundamental unit of time (in seconds) in terms
1370      * of which frame timestamps are represented. For fixed-fps content,
1371      * timebase should be 1/framerate and timestamp increments should be
1372      * identically 1.
1373      * - encoding: MUST be set by user.
1374      * - decoding: Set by libavcodec.
1375      */
1376     AVRational time_base;
1377
1378     /**
1379      * For some codecs, the time base is closer to the field rate than the frame rate.
1380      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1381      * if no telecine is used ...
1382      *
1383      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1384      */
1385     int ticks_per_frame;
1386
1387     /**
1388      * Encoding: Number of frames delay there will be from the encoder input to
1389      *           the decoder output. (we assume the decoder matches the spec)
1390      * Decoding: Number of frames delay in addition to what a standard decoder
1391      *           as specified in the spec would produce.
1392      *
1393      * Video:
1394      *   Number of frames the decoded output will be delayed relative to the
1395      *   encoded input.
1396      *
1397      * Audio:
1398      *   Number of "priming" samples added to the beginning of the stream
1399      *   during encoding. The decoded output will be delayed by this many
1400      *   samples relative to the input to the encoder. Note that this field is
1401      *   purely informational and does not directly affect the pts output by
1402      *   the encoder, which should always be based on the actual presentation
1403      *   time, including any delay.
1404      *
1405      * - encoding: Set by libavcodec.
1406      * - decoding: Set by libavcodec.
1407      */
1408     int delay;
1409
1410
1411     /* video only */
1412     /**
1413      * picture width / height.
1414      * - encoding: MUST be set by user.
1415      * - decoding: Set by libavcodec.
1416      * Note: For compatibility it is possible to set this instead of
1417      * coded_width/height before decoding.
1418      */
1419     int width, height;
1420
1421     /**
1422      * Bitstream width / height, may be different from width/height if lowres enabled.
1423      * - encoding: unused
1424      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
1425      */
1426     int coded_width, coded_height;
1427
1428 #define FF_ASPECT_EXTENDED 15
1429
1430     /**
1431      * the number of pictures in a group of pictures, or 0 for intra_only
1432      * - encoding: Set by user.
1433      * - decoding: unused
1434      */
1435     int gop_size;
1436
1437     /**
1438      * Pixel format, see PIX_FMT_xxx.
1439      * May be set by the demuxer if known from headers.
1440      * May be overriden by the decoder if it knows better.
1441      * - encoding: Set by user.
1442      * - decoding: Set by user if known, overridden by libavcodec if known
1443      */
1444     enum PixelFormat pix_fmt;
1445
1446     /**
1447      * Motion estimation algorithm used for video coding.
1448      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1449      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1450      * - encoding: MUST be set by user.
1451      * - decoding: unused
1452      */
1453     int me_method;
1454
1455     /**
1456      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1457      * decoder to draw a horizontal band. It improves cache usage. Not
1458      * all codecs can do that. You must check the codec capabilities
1459      * beforehand.
1460      * When multithreading is used, it may be called from multiple threads
1461      * at the same time; threads might draw different parts of the same AVFrame,
1462      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1463      * in order.
1464      * The function is also used by hardware acceleration APIs.
1465      * It is called at least once during frame decoding to pass
1466      * the data needed for hardware render.
1467      * In that mode instead of pixel data, AVFrame points to
1468      * a structure specific to the acceleration API. The application
1469      * reads the structure and can change some fields to indicate progress
1470      * or mark state.
1471      * - encoding: unused
1472      * - decoding: Set by user.
1473      * @param height the height of the slice
1474      * @param y the y position of the slice
1475      * @param type 1->top field, 2->bottom field, 3->frame
1476      * @param offset offset into the AVFrame.data from which the slice should be read
1477      */
1478     void (*draw_horiz_band)(struct AVCodecContext *s,
1479                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1480                             int y, int type, int height);
1481
1482     /**
1483      * callback to negotiate the pixelFormat
1484      * @param fmt is the list of formats which are supported by the codec,
1485      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1486      * The first is always the native one.
1487      * @return the chosen format
1488      * - encoding: unused
1489      * - decoding: Set by user, if not set the native format will be chosen.
1490      */
1491     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1492
1493     /**
1494      * maximum number of B-frames between non-B-frames
1495      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1496      * - encoding: Set by user.
1497      * - decoding: unused
1498      */
1499     int max_b_frames;
1500
1501     /**
1502      * qscale factor between IP and B-frames
1503      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1504      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1505      * - encoding: Set by user.
1506      * - decoding: unused
1507      */
1508     float b_quant_factor;
1509
1510     /** obsolete FIXME remove */
1511     int rc_strategy;
1512 #define FF_RC_STRATEGY_XVID 1
1513
1514     int b_frame_strategy;
1515
1516 #if FF_API_MPV_GLOBAL_OPTS
1517     /**
1518      * luma single coefficient elimination threshold
1519      * - encoding: Set by user.
1520      * - decoding: unused
1521      */
1522     attribute_deprecated int luma_elim_threshold;
1523
1524     /**
1525      * chroma single coeff elimination threshold
1526      * - encoding: Set by user.
1527      * - decoding: unused
1528      */
1529     attribute_deprecated int chroma_elim_threshold;
1530 #endif
1531
1532     /**
1533      * qscale offset between IP and B-frames
1534      * - encoding: Set by user.
1535      * - decoding: unused
1536      */
1537     float b_quant_offset;
1538
1539     /**
1540      * Size of the frame reordering buffer in the decoder.
1541      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1542      * - encoding: Set by libavcodec.
1543      * - decoding: Set by libavcodec.
1544      */
1545     int has_b_frames;
1546
1547     /**
1548      * 0-> h263 quant 1-> mpeg quant
1549      * - encoding: Set by user.
1550      * - decoding: unused
1551      */
1552     int mpeg_quant;
1553
1554     /**
1555      * qscale factor between P and I-frames
1556      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1557      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1558      * - encoding: Set by user.
1559      * - decoding: unused
1560      */
1561     float i_quant_factor;
1562
1563     /**
1564      * qscale offset between P and I-frames
1565      * - encoding: Set by user.
1566      * - decoding: unused
1567      */
1568     float i_quant_offset;
1569
1570     /**
1571      * luminance masking (0-> disabled)
1572      * - encoding: Set by user.
1573      * - decoding: unused
1574      */
1575     float lumi_masking;
1576
1577     /**
1578      * temporary complexity masking (0-> disabled)
1579      * - encoding: Set by user.
1580      * - decoding: unused
1581      */
1582     float temporal_cplx_masking;
1583
1584     /**
1585      * spatial complexity masking (0-> disabled)
1586      * - encoding: Set by user.
1587      * - decoding: unused
1588      */
1589     float spatial_cplx_masking;
1590
1591     /**
1592      * p block masking (0-> disabled)
1593      * - encoding: Set by user.
1594      * - decoding: unused
1595      */
1596     float p_masking;
1597
1598     /**
1599      * darkness masking (0-> disabled)
1600      * - encoding: Set by user.
1601      * - decoding: unused
1602      */
1603     float dark_masking;
1604
1605     /**
1606      * slice count
1607      * - encoding: Set by libavcodec.
1608      * - decoding: Set by user (or 0).
1609      */
1610     int slice_count;
1611     /**
1612      * prediction method (needed for huffyuv)
1613      * - encoding: Set by user.
1614      * - decoding: unused
1615      */
1616      int prediction_method;
1617 #define FF_PRED_LEFT   0
1618 #define FF_PRED_PLANE  1
1619 #define FF_PRED_MEDIAN 2
1620
1621     /**
1622      * slice offsets in the frame in bytes
1623      * - encoding: Set/allocated by libavcodec.
1624      * - decoding: Set/allocated by user (or NULL).
1625      */
1626     int *slice_offset;
1627
1628     /**
1629      * sample aspect ratio (0 if unknown)
1630      * That is the width of a pixel divided by the height of the pixel.
1631      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1632      * - encoding: Set by user.
1633      * - decoding: Set by libavcodec.
1634      */
1635     AVRational sample_aspect_ratio;
1636
1637     /**
1638      * motion estimation comparison function
1639      * - encoding: Set by user.
1640      * - decoding: unused
1641      */
1642     int me_cmp;
1643     /**
1644      * subpixel motion estimation comparison function
1645      * - encoding: Set by user.
1646      * - decoding: unused
1647      */
1648     int me_sub_cmp;
1649     /**
1650      * macroblock comparison function (not supported yet)
1651      * - encoding: Set by user.
1652      * - decoding: unused
1653      */
1654     int mb_cmp;
1655     /**
1656      * interlaced DCT comparison function
1657      * - encoding: Set by user.
1658      * - decoding: unused
1659      */
1660     int ildct_cmp;
1661 #define FF_CMP_SAD    0
1662 #define FF_CMP_SSE    1
1663 #define FF_CMP_SATD   2
1664 #define FF_CMP_DCT    3
1665 #define FF_CMP_PSNR   4
1666 #define FF_CMP_BIT    5
1667 #define FF_CMP_RD     6
1668 #define FF_CMP_ZERO   7
1669 #define FF_CMP_VSAD   8
1670 #define FF_CMP_VSSE   9
1671 #define FF_CMP_NSSE   10
1672 #define FF_CMP_W53    11
1673 #define FF_CMP_W97    12
1674 #define FF_CMP_DCTMAX 13
1675 #define FF_CMP_DCT264 14
1676 #define FF_CMP_CHROMA 256
1677
1678     /**
1679      * ME diamond size & shape
1680      * - encoding: Set by user.
1681      * - decoding: unused
1682      */
1683     int dia_size;
1684
1685     /**
1686      * amount of previous MV predictors (2a+1 x 2a+1 square)
1687      * - encoding: Set by user.
1688      * - decoding: unused
1689      */
1690     int last_predictor_count;
1691
1692     /**
1693      * prepass for motion estimation
1694      * - encoding: Set by user.
1695      * - decoding: unused
1696      */
1697     int pre_me;
1698
1699     /**
1700      * motion estimation prepass comparison function
1701      * - encoding: Set by user.
1702      * - decoding: unused
1703      */
1704     int me_pre_cmp;
1705
1706     /**
1707      * ME prepass diamond size & shape
1708      * - encoding: Set by user.
1709      * - decoding: unused
1710      */
1711     int pre_dia_size;
1712
1713     /**
1714      * subpel ME quality
1715      * - encoding: Set by user.
1716      * - decoding: unused
1717      */
1718     int me_subpel_quality;
1719
1720     /**
1721      * DTG active format information (additional aspect ratio
1722      * information only used in DVB MPEG-2 transport streams)
1723      * 0 if not set.
1724      *
1725      * - encoding: unused
1726      * - decoding: Set by decoder.
1727      */
1728     int dtg_active_format;
1729 #define FF_DTG_AFD_SAME         8
1730 #define FF_DTG_AFD_4_3          9
1731 #define FF_DTG_AFD_16_9         10
1732 #define FF_DTG_AFD_14_9         11
1733 #define FF_DTG_AFD_4_3_SP_14_9  13
1734 #define FF_DTG_AFD_16_9_SP_14_9 14
1735 #define FF_DTG_AFD_SP_4_3       15
1736
1737     /**
1738      * maximum motion estimation search range in subpel units
1739      * If 0 then no limit.
1740      *
1741      * - encoding: Set by user.
1742      * - decoding: unused
1743      */
1744     int me_range;
1745
1746     /**
1747      * intra quantizer bias
1748      * - encoding: Set by user.
1749      * - decoding: unused
1750      */
1751     int intra_quant_bias;
1752 #define FF_DEFAULT_QUANT_BIAS 999999
1753
1754     /**
1755      * inter quantizer bias
1756      * - encoding: Set by user.
1757      * - decoding: unused
1758      */
1759     int inter_quant_bias;
1760
1761 #if FF_API_COLOR_TABLE_ID
1762     /**
1763      * color table ID
1764      * - encoding: unused
1765      * - decoding: Which clrtable should be used for 8bit RGB images.
1766      *             Tables have to be stored somewhere. FIXME
1767      */
1768     attribute_deprecated int color_table_id;
1769 #endif
1770
1771     /**
1772      * slice flags
1773      * - encoding: unused
1774      * - decoding: Set by user.
1775      */
1776     int slice_flags;
1777 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1778 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
1779 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1780
1781     /**
1782      * XVideo Motion Acceleration
1783      * - encoding: forbidden
1784      * - decoding: set by decoder
1785      */
1786     int xvmc_acceleration;
1787
1788     /**
1789      * macroblock decision mode
1790      * - encoding: Set by user.
1791      * - decoding: unused
1792      */
1793     int mb_decision;
1794 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1795 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1796 #define FF_MB_DECISION_RD     2        ///< rate distortion
1797
1798     /**
1799      * custom intra quantization matrix
1800      * - encoding: Set by user, can be NULL.
1801      * - decoding: Set by libavcodec.
1802      */
1803     uint16_t *intra_matrix;
1804
1805     /**
1806      * custom inter quantization matrix
1807      * - encoding: Set by user, can be NULL.
1808      * - decoding: Set by libavcodec.
1809      */
1810     uint16_t *inter_matrix;
1811
1812     /**
1813      * scene change detection threshold
1814      * 0 is default, larger means fewer detected scene changes.
1815      * - encoding: Set by user.
1816      * - decoding: unused
1817      */
1818     int scenechange_threshold;
1819
1820     /**
1821      * noise reduction strength
1822      * - encoding: Set by user.
1823      * - decoding: unused
1824      */
1825     int noise_reduction;
1826
1827 #if FF_API_INTER_THRESHOLD
1828     /**
1829      * @deprecated this field is unused
1830      */
1831     attribute_deprecated int inter_threshold;
1832 #endif
1833
1834 #if FF_API_MPV_GLOBAL_OPTS
1835     /**
1836      * @deprecated use mpegvideo private options instead
1837      */
1838     attribute_deprecated int quantizer_noise_shaping;
1839 #endif
1840
1841     /**
1842      * Motion estimation threshold below which no motion estimation is
1843      * performed, but instead the user specified motion vectors are used.
1844      *
1845      * - encoding: Set by user.
1846      * - decoding: unused
1847      */
1848     int me_threshold;
1849
1850     /**
1851      * Macroblock threshold below which the user specified macroblock types will be used.
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855     int mb_threshold;
1856
1857     /**
1858      * precision of the intra DC coefficient - 8
1859      * - encoding: Set by user.
1860      * - decoding: unused
1861      */
1862     int intra_dc_precision;
1863
1864     /**
1865      * Number of macroblock rows at the top which are skipped.
1866      * - encoding: unused
1867      * - decoding: Set by user.
1868      */
1869     int skip_top;
1870
1871     /**
1872      * Number of macroblock rows at the bottom which are skipped.
1873      * - encoding: unused
1874      * - decoding: Set by user.
1875      */
1876     int skip_bottom;
1877
1878     /**
1879      * Border processing masking, raises the quantizer for mbs on the borders
1880      * of the picture.
1881      * - encoding: Set by user.
1882      * - decoding: unused
1883      */
1884     float border_masking;
1885
1886     /**
1887      * minimum MB lagrange multipler
1888      * - encoding: Set by user.
1889      * - decoding: unused
1890      */
1891     int mb_lmin;
1892
1893     /**
1894      * maximum MB lagrange multipler
1895      * - encoding: Set by user.
1896      * - decoding: unused
1897      */
1898     int mb_lmax;
1899
1900     /**
1901      *
1902      * - encoding: Set by user.
1903      * - decoding: unused
1904      */
1905     int me_penalty_compensation;
1906
1907     /**
1908      *
1909      * - encoding: Set by user.
1910      * - decoding: unused
1911      */
1912     int bidir_refine;
1913
1914     /**
1915      *
1916      * - encoding: Set by user.
1917      * - decoding: unused
1918      */
1919     int brd_scale;
1920
1921     /**
1922      * minimum GOP size
1923      * - encoding: Set by user.
1924      * - decoding: unused
1925      */
1926     int keyint_min;
1927
1928     /**
1929      * number of reference frames
1930      * - encoding: Set by user.
1931      * - decoding: Set by lavc.
1932      */
1933     int refs;
1934
1935     /**
1936      * chroma qp offset from luma
1937      * - encoding: Set by user.
1938      * - decoding: unused
1939      */
1940     int chromaoffset;
1941
1942     /**
1943      * Multiplied by qscale for each frame and added to scene_change_score.
1944      * - encoding: Set by user.
1945      * - decoding: unused
1946      */
1947     int scenechange_factor;
1948
1949     /**
1950      *
1951      * Note: Value depends upon the compare function used for fullpel ME.
1952      * - encoding: Set by user.
1953      * - decoding: unused
1954      */
1955     int mv0_threshold;
1956
1957     /**
1958      * Adjust sensitivity of b_frame_strategy 1.
1959      * - encoding: Set by user.
1960      * - decoding: unused
1961      */
1962     int b_sensitivity;
1963
1964     /**
1965      * Chromaticity coordinates of the source primaries.
1966      * - encoding: Set by user
1967      * - decoding: Set by libavcodec
1968      */
1969     enum AVColorPrimaries color_primaries;
1970
1971     /**
1972      * Color Transfer Characteristic.
1973      * - encoding: Set by user
1974      * - decoding: Set by libavcodec
1975      */
1976     enum AVColorTransferCharacteristic color_trc;
1977
1978     /**
1979      * YUV colorspace type.
1980      * - encoding: Set by user
1981      * - decoding: Set by libavcodec
1982      */
1983     enum AVColorSpace colorspace;
1984
1985     /**
1986      * MPEG vs JPEG YUV range.
1987      * - encoding: Set by user
1988      * - decoding: Set by libavcodec
1989      */
1990     enum AVColorRange color_range;
1991
1992     /**
1993      * This defines the location of chroma samples.
1994      * - encoding: Set by user
1995      * - decoding: Set by libavcodec
1996      */
1997     enum AVChromaLocation chroma_sample_location;
1998
1999     /**
2000      * Number of slices.
2001      * Indicates number of picture subdivisions. Used for parallelized
2002      * decoding.
2003      * - encoding: Set by user
2004      * - decoding: unused
2005      */
2006     int slices;
2007
2008     /** Field order
2009      * - encoding: set by libavcodec
2010      * - decoding: Set by libavcodec
2011      */
2012     enum AVFieldOrder field_order;
2013
2014     /* audio only */
2015     int sample_rate; ///< samples per second
2016     int channels;    ///< number of audio channels
2017
2018     /**
2019      * audio sample format
2020      * - encoding: Set by user.
2021      * - decoding: Set by libavcodec.
2022      */
2023     enum AVSampleFormat sample_fmt;  ///< sample format
2024
2025     /* The following data should not be initialized. */
2026     /**
2027      * Samples per packet, initialized when calling 'init'.
2028      */
2029     int frame_size;
2030     int frame_number;   ///< audio or video frame number
2031
2032     /**
2033      * number of bytes per packet if constant and known or 0
2034      * Used by some WAV based audio codecs.
2035      */
2036     int block_align;
2037
2038     /**
2039      * Audio cutoff bandwidth (0 means "automatic")
2040      * - encoding: Set by user.
2041      * - decoding: unused
2042      */
2043     int cutoff;
2044
2045 #if FF_API_REQUEST_CHANNELS
2046     /**
2047      * Decoder should decode to this many channels if it can (0 for default)
2048      * - encoding: unused
2049      * - decoding: Set by user.
2050      * @deprecated Deprecated in favor of request_channel_layout.
2051      */
2052     int request_channels;
2053 #endif
2054
2055     /**
2056      * Audio channel layout.
2057      * - encoding: set by user.
2058      * - decoding: set by user, may be overwritten by libavcodec.
2059      */
2060     uint64_t channel_layout;
2061
2062     /**
2063      * Request decoder to use this channel layout if it can (0 for default)
2064      * - encoding: unused
2065      * - decoding: Set by user.
2066      */
2067     uint64_t request_channel_layout;
2068
2069     /**
2070      * Type of service that the audio stream conveys.
2071      * - encoding: Set by user.
2072      * - decoding: Set by libavcodec.
2073      */
2074     enum AVAudioServiceType audio_service_type;
2075
2076     /**
2077      * desired sample format
2078      * - encoding: Not used.
2079      * - decoding: Set by user.
2080      * Decoder will decode to this format if it can.
2081      */
2082     enum AVSampleFormat request_sample_fmt;
2083
2084     /**
2085      * Called at the beginning of each frame to get a buffer for it.
2086      *
2087      * The function will set AVFrame.data[], AVFrame.linesize[].
2088      * AVFrame.extended_data[] must also be set, but it should be the same as
2089      * AVFrame.data[] except for planar audio with more channels than can fit
2090      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
2091      * many data pointers as it can hold.
2092      *
2093      * if CODEC_CAP_DR1 is not set then get_buffer() must call
2094      * avcodec_default_get_buffer() instead of providing buffers allocated by
2095      * some other means.
2096      *
2097      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
2098      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
2099      * but if get_buffer() is overridden then alignment considerations should
2100      * be taken into account.
2101      *
2102      * @see avcodec_default_get_buffer()
2103      *
2104      * Video:
2105      *
2106      * If pic.reference is set then the frame will be read later by libavcodec.
2107      * avcodec_align_dimensions2() should be used to find the required width and
2108      * height, as they normally need to be rounded up to the next multiple of 16.
2109      *
2110      * If frame multithreading is used and thread_safe_callbacks is set,
2111      * it may be called from a different thread, but not from more than one at
2112      * once. Does not need to be reentrant.
2113      *
2114      * @see release_buffer(), reget_buffer()
2115      * @see avcodec_align_dimensions2()
2116      *
2117      * Audio:
2118      *
2119      * Decoders request a buffer of a particular size by setting
2120      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
2121      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2122      * to a smaller value in the output frame.
2123      *
2124      * Decoders cannot use the buffer after returning from
2125      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
2126      * is assumed to be released immediately upon return.
2127      *
2128      * As a convenience, av_samples_get_buffer_size() and
2129      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
2130      * functions to find the required data size and to fill data pointers and
2131      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2132      * since all planes must be the same size.
2133      *
2134      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2135      *
2136      * - encoding: unused
2137      * - decoding: Set by libavcodec, user can override.
2138      */
2139     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
2140
2141     /**
2142      * Called to release buffers which were allocated with get_buffer.
2143      * A released buffer can be reused in get_buffer().
2144      * pic.data[*] must be set to NULL.
2145      * May be called from a different thread if frame multithreading is used,
2146      * but not by more than one thread at once, so does not need to be reentrant.
2147      * - encoding: unused
2148      * - decoding: Set by libavcodec, user can override.
2149      */
2150     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
2151
2152     /**
2153      * Called at the beginning of a frame to get cr buffer for it.
2154      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2155      * libavcodec will pass previous buffer in pic, function should return
2156      * same buffer or new buffer with old frame "painted" into it.
2157      * If pic.data[0] == NULL must behave like get_buffer().
2158      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2159      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2160      * some other means.
2161      * - encoding: unused
2162      * - decoding: Set by libavcodec, user can override.
2163      */
2164     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2165
2166
2167     /* - encoding parameters */
2168     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2169     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2170
2171     /**
2172      * minimum quantizer
2173      * - encoding: Set by user.
2174      * - decoding: unused
2175      */
2176     int qmin;
2177
2178     /**
2179      * maximum quantizer
2180      * - encoding: Set by user.
2181      * - decoding: unused
2182      */
2183     int qmax;
2184
2185     /**
2186      * maximum quantizer difference between frames
2187      * - encoding: Set by user.
2188      * - decoding: unused
2189      */
2190     int max_qdiff;
2191
2192     /**
2193      * ratecontrol qmin qmax limiting method
2194      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
2195      * - encoding: Set by user.
2196      * - decoding: unused
2197      */
2198     float rc_qsquish;
2199
2200     float rc_qmod_amp;
2201     int rc_qmod_freq;
2202
2203     /**
2204      * decoder bitstream buffer size
2205      * - encoding: Set by user.
2206      * - decoding: unused
2207      */
2208     int rc_buffer_size;
2209
2210     /**
2211      * ratecontrol override, see RcOverride
2212      * - encoding: Allocated/set/freed by user.
2213      * - decoding: unused
2214      */
2215     int rc_override_count;
2216     RcOverride *rc_override;
2217
2218     /**
2219      * rate control equation
2220      * - encoding: Set by user
2221      * - decoding: unused
2222      */
2223     const char *rc_eq;
2224
2225     /**
2226      * maximum bitrate
2227      * - encoding: Set by user.
2228      * - decoding: unused
2229      */
2230     int rc_max_rate;
2231
2232     /**
2233      * minimum bitrate
2234      * - encoding: Set by user.
2235      * - decoding: unused
2236      */
2237     int rc_min_rate;
2238
2239     float rc_buffer_aggressivity;
2240
2241     /**
2242      * initial complexity for pass1 ratecontrol
2243      * - encoding: Set by user.
2244      * - decoding: unused
2245      */
2246     float rc_initial_cplx;
2247
2248     /**
2249      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2250      * - encoding: Set by user.
2251      * - decoding: unused.
2252      */
2253     float rc_max_available_vbv_use;
2254
2255     /**
2256      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2257      * - encoding: Set by user.
2258      * - decoding: unused.
2259      */
2260     float rc_min_vbv_overflow_use;
2261
2262     /**
2263      * Number of bits which should be loaded into the rc buffer before decoding starts.
2264      * - encoding: Set by user.
2265      * - decoding: unused
2266      */
2267     int rc_initial_buffer_occupancy;
2268
2269 #define FF_CODER_TYPE_VLC       0
2270 #define FF_CODER_TYPE_AC        1
2271 #define FF_CODER_TYPE_RAW       2
2272 #define FF_CODER_TYPE_RLE       3
2273 #define FF_CODER_TYPE_DEFLATE   4
2274     /**
2275      * coder type
2276      * - encoding: Set by user.
2277      * - decoding: unused
2278      */
2279     int coder_type;
2280
2281     /**
2282      * context model
2283      * - encoding: Set by user.
2284      * - decoding: unused
2285      */
2286     int context_model;
2287
2288     /**
2289      * minimum Lagrange multipler
2290      * - encoding: Set by user.
2291      * - decoding: unused
2292      */
2293     int lmin;
2294
2295     /**
2296      * maximum Lagrange multipler
2297      * - encoding: Set by user.
2298      * - decoding: unused
2299      */
2300     int lmax;
2301
2302     /**
2303      * frame skip threshold
2304      * - encoding: Set by user.
2305      * - decoding: unused
2306      */
2307     int frame_skip_threshold;
2308
2309     /**
2310      * frame skip factor
2311      * - encoding: Set by user.
2312      * - decoding: unused
2313      */
2314     int frame_skip_factor;
2315
2316     /**
2317      * frame skip exponent
2318      * - encoding: Set by user.
2319      * - decoding: unused
2320      */
2321     int frame_skip_exp;
2322
2323     /**
2324      * frame skip comparison function
2325      * - encoding: Set by user.
2326      * - decoding: unused
2327      */
2328     int frame_skip_cmp;
2329
2330     /**
2331      * trellis RD quantization
2332      * - encoding: Set by user.
2333      * - decoding: unused
2334      */
2335     int trellis;
2336
2337     /**
2338      * - encoding: Set by user.
2339      * - decoding: unused
2340      */
2341     int min_prediction_order;
2342
2343     /**
2344      * - encoding: Set by user.
2345      * - decoding: unused
2346      */
2347     int max_prediction_order;
2348
2349     /**
2350      * GOP timecode frame start number
2351      * - encoding: Set by user, in non drop frame format
2352      * - decoding: Set by libavcodec (timecode in the 25 bits format, -1 if unset)
2353      */
2354     int64_t timecode_frame_start;
2355
2356     /* The RTP callback: This function is called    */
2357     /* every time the encoder has a packet to send. */
2358     /* It depends on the encoder if the data starts */
2359     /* with a Start Code (it should). H.263 does.   */
2360     /* mb_nb contains the number of macroblocks     */
2361     /* encoded in the RTP payload.                  */
2362     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2363
2364     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2365                             /* do its best to deliver a chunk with size     */
2366                             /* below rtp_payload_size, the chunk will start */
2367                             /* with a start code on some codecs like H.263. */
2368                             /* This doesn't take account of any particular  */
2369                             /* headers inside the transmitted RTP payload.  */
2370
2371     /* statistics, used for 2-pass encoding */
2372     int mv_bits;
2373     int header_bits;
2374     int i_tex_bits;
2375     int p_tex_bits;
2376     int i_count;
2377     int p_count;
2378     int skip_count;
2379     int misc_bits;
2380
2381     /**
2382      * number of bits used for the previously encoded frame
2383      * - encoding: Set by libavcodec.
2384      * - decoding: unused
2385      */
2386     int frame_bits;
2387
2388     /**
2389      * pass1 encoding statistics output buffer
2390      * - encoding: Set by libavcodec.
2391      * - decoding: unused
2392      */
2393     char *stats_out;
2394
2395     /**
2396      * pass2 encoding statistics input buffer
2397      * Concatenated stuff from stats_out of pass1 should be placed here.
2398      * - encoding: Allocated/set/freed by user.
2399      * - decoding: unused
2400      */
2401     char *stats_in;
2402
2403     /**
2404      * Work around bugs in encoders which sometimes cannot be detected automatically.
2405      * - encoding: Set by user
2406      * - decoding: Set by user
2407      */
2408     int workaround_bugs;
2409 #define FF_BUG_AUTODETECT       1  ///< autodetection
2410 #define FF_BUG_OLD_MSMPEG4      2
2411 #define FF_BUG_XVID_ILACE       4
2412 #define FF_BUG_UMP4             8
2413 #define FF_BUG_NO_PADDING       16
2414 #define FF_BUG_AMV              32
2415 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2416 #define FF_BUG_QPEL_CHROMA      64
2417 #define FF_BUG_STD_QPEL         128
2418 #define FF_BUG_QPEL_CHROMA2     256
2419 #define FF_BUG_DIRECT_BLOCKSIZE 512
2420 #define FF_BUG_EDGE             1024
2421 #define FF_BUG_HPEL_CHROMA      2048
2422 #define FF_BUG_DC_CLIP          4096
2423 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2424 #define FF_BUG_TRUNCATED       16384
2425
2426     /**
2427      * strictly follow the standard (MPEG4, ...).
2428      * - encoding: Set by user.
2429      * - decoding: Set by user.
2430      * Setting this to STRICT or higher means the encoder and decoder will
2431      * generally do stupid things, whereas setting it to unofficial or lower
2432      * will mean the encoder might produce output that is not supported by all
2433      * spec-compliant decoders. Decoders don't differentiate between normal,
2434      * unofficial and experimental (that is, they always try to decode things
2435      * when they can) unless they are explicitly asked to behave stupidly
2436      * (=strictly conform to the specs)
2437      */
2438     int strict_std_compliance;
2439 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2440 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2441 #define FF_COMPLIANCE_NORMAL        0
2442 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2443 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2444
2445     /**
2446      * error concealment flags
2447      * - encoding: unused
2448      * - decoding: Set by user.
2449      */
2450     int error_concealment;
2451 #define FF_EC_GUESS_MVS   1
2452 #define FF_EC_DEBLOCK     2
2453
2454     /**
2455      * debug
2456      * - encoding: Set by user.
2457      * - decoding: Set by user.
2458      */
2459     int debug;
2460 #define FF_DEBUG_PICT_INFO   1
2461 #define FF_DEBUG_RC          2
2462 #define FF_DEBUG_BITSTREAM   4
2463 #define FF_DEBUG_MB_TYPE     8
2464 #define FF_DEBUG_QP          16
2465 #define FF_DEBUG_MV          32
2466 #define FF_DEBUG_DCT_COEFF   0x00000040
2467 #define FF_DEBUG_SKIP        0x00000080
2468 #define FF_DEBUG_STARTCODE   0x00000100
2469 #define FF_DEBUG_PTS         0x00000200
2470 #define FF_DEBUG_ER          0x00000400
2471 #define FF_DEBUG_MMCO        0x00000800
2472 #define FF_DEBUG_BUGS        0x00001000
2473 #define FF_DEBUG_VIS_QP      0x00002000
2474 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2475 #define FF_DEBUG_BUFFERS     0x00008000
2476 #define FF_DEBUG_THREADS     0x00010000
2477
2478     /**
2479      * debug
2480      * - encoding: Set by user.
2481      * - decoding: Set by user.
2482      */
2483     int debug_mv;
2484 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
2485 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
2486 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
2487
2488     /**
2489      * Error recognition; may misdetect some more or less valid parts as errors.
2490      * - encoding: unused
2491      * - decoding: Set by user.
2492      */
2493     int err_recognition;
2494 #define AV_EF_CRCCHECK  (1<<0)
2495 #define AV_EF_BITSTREAM (1<<1)
2496 #define AV_EF_BUFFER    (1<<2)
2497 #define AV_EF_EXPLODE   (1<<3)
2498
2499 #define AV_EF_CAREFUL    (1<<16)
2500 #define AV_EF_COMPLIANT  (1<<17)
2501 #define AV_EF_AGGRESSIVE (1<<18)
2502
2503
2504     /**
2505      * opaque 64bit number (generally a PTS) that will be reordered and
2506      * output in AVFrame.reordered_opaque
2507      * @deprecated in favor of pkt_pts
2508      * - encoding: unused
2509      * - decoding: Set by user.
2510      */
2511     int64_t reordered_opaque;
2512
2513     /**
2514      * Hardware accelerator in use
2515      * - encoding: unused.
2516      * - decoding: Set by libavcodec
2517      */
2518     struct AVHWAccel *hwaccel;
2519
2520     /**
2521      * Hardware accelerator context.
2522      * For some hardware accelerators, a global context needs to be
2523      * provided by the user. In that case, this holds display-dependent
2524      * data FFmpeg cannot instantiate itself. Please refer to the
2525      * FFmpeg HW accelerator documentation to know how to fill this
2526      * is. e.g. for VA API, this is a struct vaapi_context.
2527      * - encoding: unused
2528      * - decoding: Set by user
2529      */
2530     void *hwaccel_context;
2531
2532     /**
2533      * error
2534      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
2535      * - decoding: unused
2536      */
2537     uint64_t error[AV_NUM_DATA_POINTERS];
2538
2539     /**
2540      * DCT algorithm, see FF_DCT_* below
2541      * - encoding: Set by user.
2542      * - decoding: unused
2543      */
2544     int dct_algo;
2545 #define FF_DCT_AUTO    0
2546 #define FF_DCT_FASTINT 1
2547 #define FF_DCT_INT     2
2548 #define FF_DCT_MMX     3
2549 #define FF_DCT_ALTIVEC 5
2550 #define FF_DCT_FAAN    6
2551
2552     /**
2553      * IDCT algorithm, see FF_IDCT_* below.
2554      * - encoding: Set by user.
2555      * - decoding: Set by user.
2556      */
2557     int idct_algo;
2558 #define FF_IDCT_AUTO          0
2559 #define FF_IDCT_INT           1
2560 #define FF_IDCT_SIMPLE        2
2561 #define FF_IDCT_SIMPLEMMX     3
2562 #define FF_IDCT_LIBMPEG2MMX   4
2563 #define FF_IDCT_MMI           5
2564 #define FF_IDCT_ARM           7
2565 #define FF_IDCT_ALTIVEC       8
2566 #define FF_IDCT_SH4           9
2567 #define FF_IDCT_SIMPLEARM     10
2568 #define FF_IDCT_H264          11
2569 #define FF_IDCT_VP3           12
2570 #define FF_IDCT_IPP           13
2571 #define FF_IDCT_XVIDMMX       14
2572 #define FF_IDCT_CAVS          15
2573 #define FF_IDCT_SIMPLEARMV5TE 16
2574 #define FF_IDCT_SIMPLEARMV6   17
2575 #define FF_IDCT_SIMPLEVIS     18
2576 #define FF_IDCT_WMV2          19
2577 #define FF_IDCT_FAAN          20
2578 #define FF_IDCT_EA            21
2579 #define FF_IDCT_SIMPLENEON    22
2580 #define FF_IDCT_SIMPLEALPHA   23
2581 #define FF_IDCT_BINK          24
2582
2583     /**
2584      * dsp_mask could be add used to disable unwanted CPU features
2585      * CPU features (i.e. MMX, SSE. ...)
2586      *
2587      * With the FORCE flag you may instead enable given CPU features.
2588      * (Dangerous: Usable in case of misdetection, improper usage however will
2589      * result into program crash.)
2590      */
2591     unsigned dsp_mask;
2592
2593     /**
2594      * bits per sample/pixel from the demuxer (needed for huffyuv).
2595      * - encoding: Set by libavcodec.
2596      * - decoding: Set by user.
2597      */
2598      int bits_per_coded_sample;
2599
2600     /**
2601      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2602      * - encoding: set by user.
2603      * - decoding: set by libavcodec.
2604      */
2605     int bits_per_raw_sample;
2606
2607     /**
2608      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2609      * - encoding: unused
2610      * - decoding: Set by user.
2611      */
2612      int lowres;
2613
2614     /**
2615      * the picture in the bitstream
2616      * - encoding: Set by libavcodec.
2617      * - decoding: Set by libavcodec.
2618      */
2619     AVFrame *coded_frame;
2620
2621     /**
2622      * thread count
2623      * is used to decide how many independent tasks should be passed to execute()
2624      * - encoding: Set by user.
2625      * - decoding: Set by user.
2626      */
2627     int thread_count;
2628
2629     /**
2630      * Which multithreading methods to use.
2631      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2632      * so clients which cannot provide future frames should not use it.
2633      *
2634      * - encoding: Set by user, otherwise the default is used.
2635      * - decoding: Set by user, otherwise the default is used.
2636      */
2637     int thread_type;
2638 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2639 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2640
2641     /**
2642      * Which multithreading methods are in use by the codec.
2643      * - encoding: Set by libavcodec.
2644      * - decoding: Set by libavcodec.
2645      */
2646     int active_thread_type;
2647
2648     /**
2649      * Set by the client if its custom get_buffer() callback can be called
2650      * from another thread, which allows faster multithreaded decoding.
2651      * draw_horiz_band() will be called from other threads regardless of this setting.
2652      * Ignored if the default get_buffer() is used.
2653      * - encoding: Set by user.
2654      * - decoding: Set by user.
2655      */
2656     int thread_safe_callbacks;
2657
2658     /**
2659      * The codec may call this to execute several independent things.
2660      * It will return only after finishing all tasks.
2661      * The user may replace this with some multithreaded implementation,
2662      * the default implementation will execute the parts serially.
2663      * @param count the number of things to execute
2664      * - encoding: Set by libavcodec, user can override.
2665      * - decoding: Set by libavcodec, user can override.
2666      */
2667     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2668
2669     /**
2670      * The codec may call this to execute several independent things.
2671      * It will return only after finishing all tasks.
2672      * The user may replace this with some multithreaded implementation,
2673      * the default implementation will execute the parts serially.
2674      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2675      * @param c context passed also to func
2676      * @param count the number of things to execute
2677      * @param arg2 argument passed unchanged to func
2678      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2679      * @param func function that will be called count times, with jobnr from 0 to count-1.
2680      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2681      *             two instances of func executing at the same time will have the same threadnr.
2682      * @return always 0 currently, but code should handle a future improvement where when any call to func
2683      *         returns < 0 no further calls to func may be done and < 0 is returned.
2684      * - encoding: Set by libavcodec, user can override.
2685      * - decoding: Set by libavcodec, user can override.
2686      */
2687     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2688
2689     /**
2690      * thread opaque
2691      * Can be used by execute() to store some per AVCodecContext stuff.
2692      * - encoding: set by execute()
2693      * - decoding: set by execute()
2694      */
2695     void *thread_opaque;
2696
2697     /**
2698      * noise vs. sse weight for the nsse comparsion function
2699      * - encoding: Set by user.
2700      * - decoding: unused
2701      */
2702      int nsse_weight;
2703
2704     /**
2705      * profile
2706      * - encoding: Set by user.
2707      * - decoding: Set by libavcodec.
2708      */
2709      int profile;
2710 #define FF_PROFILE_UNKNOWN -99
2711 #define FF_PROFILE_RESERVED -100
2712
2713 #define FF_PROFILE_AAC_MAIN 0
2714 #define FF_PROFILE_AAC_LOW  1
2715 #define FF_PROFILE_AAC_SSR  2
2716 #define FF_PROFILE_AAC_LTP  3
2717
2718 #define FF_PROFILE_DTS         20
2719 #define FF_PROFILE_DTS_ES      30
2720 #define FF_PROFILE_DTS_96_24   40
2721 #define FF_PROFILE_DTS_HD_HRA  50
2722 #define FF_PROFILE_DTS_HD_MA   60
2723
2724 #define FF_PROFILE_MPEG2_422    0
2725 #define FF_PROFILE_MPEG2_HIGH   1
2726 #define FF_PROFILE_MPEG2_SS     2
2727 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2728 #define FF_PROFILE_MPEG2_MAIN   4
2729 #define FF_PROFILE_MPEG2_SIMPLE 5
2730
2731 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2732 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2733
2734 #define FF_PROFILE_H264_BASELINE             66
2735 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2736 #define FF_PROFILE_H264_MAIN                 77
2737 #define FF_PROFILE_H264_EXTENDED             88
2738 #define FF_PROFILE_H264_HIGH                 100
2739 #define FF_PROFILE_H264_HIGH_10              110
2740 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2741 #define FF_PROFILE_H264_HIGH_422             122
2742 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2743 #define FF_PROFILE_H264_HIGH_444             144
2744 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2745 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2746 #define FF_PROFILE_H264_CAVLC_444            44
2747
2748 #define FF_PROFILE_VC1_SIMPLE   0
2749 #define FF_PROFILE_VC1_MAIN     1
2750 #define FF_PROFILE_VC1_COMPLEX  2
2751 #define FF_PROFILE_VC1_ADVANCED 3
2752
2753 #define FF_PROFILE_MPEG4_SIMPLE                     0
2754 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2755 #define FF_PROFILE_MPEG4_CORE                       2
2756 #define FF_PROFILE_MPEG4_MAIN                       3
2757 #define FF_PROFILE_MPEG4_N_BIT                      4
2758 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2759 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2760 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2761 #define FF_PROFILE_MPEG4_HYBRID                     8
2762 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2763 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2764 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2765 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2766 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2767 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2768 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2769
2770     /**
2771      * level
2772      * - encoding: Set by user.
2773      * - decoding: Set by libavcodec.
2774      */
2775      int level;
2776 #define FF_LEVEL_UNKNOWN -99
2777
2778     /**
2779      *
2780      * - encoding: unused
2781      * - decoding: Set by user.
2782      */
2783     enum AVDiscard skip_loop_filter;
2784
2785     /**
2786      *
2787      * - encoding: unused
2788      * - decoding: Set by user.
2789      */
2790     enum AVDiscard skip_idct;
2791
2792     /**
2793      *
2794      * - encoding: unused
2795      * - decoding: Set by user.
2796      */
2797     enum AVDiscard skip_frame;
2798
2799     /**
2800      * Header containing style information for text subtitles.
2801      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2802      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2803      * the Format line following. It shouldn't include any Dialogue line.
2804      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2805      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2806      */
2807     uint8_t *subtitle_header;
2808     int subtitle_header_size;
2809
2810     /**
2811      * Simulates errors in the bitstream to test error concealment.
2812      * - encoding: Set by user.
2813      * - decoding: unused
2814      */
2815     int error_rate;
2816
2817     /**
2818      * Current packet as passed into the decoder, to avoid having
2819      * to pass the packet into every function. Currently only valid
2820      * inside lavc and get/release_buffer callbacks.
2821      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2822      * - encoding: unused
2823      */
2824     AVPacket *pkt;
2825
2826     /**
2827      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2828      * Used for compliant TS muxing.
2829      * - encoding: Set by libavcodec.
2830      * - decoding: unused.
2831      */
2832     uint64_t vbv_delay;
2833
2834     /**
2835      * Current statistics for PTS correction.
2836      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2837      * - encoding: unused
2838      */
2839     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2840     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2841     int64_t pts_correction_last_pts;       /// PTS of the last frame
2842     int64_t pts_correction_last_dts;       /// DTS of the last frame
2843 } AVCodecContext;
2844
2845 /**
2846  * AVProfile.
2847  */
2848 typedef struct AVProfile {
2849     int profile;
2850     const char *name; ///< short name for the profile
2851 } AVProfile;
2852
2853 typedef struct AVCodecDefault AVCodecDefault;
2854
2855 /**
2856  * AVCodec.
2857  */
2858 typedef struct AVCodec {
2859     /**
2860      * Name of the codec implementation.
2861      * The name is globally unique among encoders and among decoders (but an
2862      * encoder and a decoder can share the same name).
2863      * This is the primary way to find a codec from the user perspective.
2864      */
2865     const char *name;
2866     /**
2867      * Descriptive name for the codec, meant to be more human readable than name.
2868      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2869      */
2870     const char *long_name;
2871     enum AVMediaType type;
2872     enum CodecID id;
2873     /**
2874      * Codec capabilities.
2875      * see CODEC_CAP_*
2876      */
2877     int capabilities;
2878     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2879     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2880     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2881     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2882     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2883     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2884     const AVClass *priv_class;              ///< AVClass for the private context
2885     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2886
2887     /*****************************************************************
2888      * No fields below this line are part of the public API. They
2889      * may not be used outside of libavcodec and can be changed and
2890      * removed at will.
2891      * New public fields should be added right above.
2892      *****************************************************************
2893      */
2894     int priv_data_size;
2895     struct AVCodec *next;
2896     /**
2897      * @name Frame-level threading support functions
2898      * @{
2899      */
2900     /**
2901      * If defined, called on thread contexts when they are created.
2902      * If the codec allocates writable tables in init(), re-allocate them here.
2903      * priv_data will be set to a copy of the original.
2904      */
2905     int (*init_thread_copy)(AVCodecContext *);
2906     /**
2907      * Copy necessary context variables from a previous thread context to the current one.
2908      * If not defined, the next thread will start automatically; otherwise, the codec
2909      * must call ff_thread_finish_setup().
2910      *
2911      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2912      */
2913     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2914     /** @} */
2915
2916     /**
2917      * Private codec-specific defaults.
2918      */
2919     const AVCodecDefault *defaults;
2920
2921     /**
2922      * Initialize codec static data, called from avcodec_register().
2923      */
2924     void (*init_static_data)(struct AVCodec *codec);
2925
2926     int (*init)(AVCodecContext *);
2927     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2928     /**
2929      * Encode data to an AVPacket.
2930      *
2931      * @param      avctx          codec context
2932      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2933      * @param[in]  frame          AVFrame containing the raw data to be encoded
2934      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2935      *                            non-empty packet was returned in avpkt.
2936      * @return 0 on success, negative error code on failure
2937      */
2938     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2939                    int *got_packet_ptr);
2940     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2941     int (*close)(AVCodecContext *);
2942     /**
2943      * Flush buffers.
2944      * Will be called when seeking
2945      */
2946     void (*flush)(AVCodecContext *);
2947 } AVCodec;
2948
2949 /**
2950  * AVHWAccel.
2951  */
2952 typedef struct AVHWAccel {
2953     /**
2954      * Name of the hardware accelerated codec.
2955      * The name is globally unique among encoders and among decoders (but an
2956      * encoder and a decoder can share the same name).
2957      */
2958     const char *name;
2959
2960     /**
2961      * Type of codec implemented by the hardware accelerator.
2962      *
2963      * See AVMEDIA_TYPE_xxx
2964      */
2965     enum AVMediaType type;
2966
2967     /**
2968      * Codec implemented by the hardware accelerator.
2969      *
2970      * See CODEC_ID_xxx
2971      */
2972     enum CodecID id;
2973
2974     /**
2975      * Supported pixel format.
2976      *
2977      * Only hardware accelerated formats are supported here.
2978      */
2979     enum PixelFormat pix_fmt;
2980
2981     /**
2982      * Hardware accelerated codec capabilities.
2983      * see FF_HWACCEL_CODEC_CAP_*
2984      */
2985     int capabilities;
2986
2987     struct AVHWAccel *next;
2988
2989     /**
2990      * Called at the beginning of each frame or field picture.
2991      *
2992      * Meaningful frame information (codec specific) is guaranteed to
2993      * be parsed at this point. This function is mandatory.
2994      *
2995      * Note that buf can be NULL along with buf_size set to 0.
2996      * Otherwise, this means the whole frame is available at this point.
2997      *
2998      * @param avctx the codec context
2999      * @param buf the frame data buffer base
3000      * @param buf_size the size of the frame in bytes
3001      * @return zero if successful, a negative value otherwise
3002      */
3003     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3004
3005     /**
3006      * Callback for each slice.
3007      *
3008      * Meaningful slice information (codec specific) is guaranteed to
3009      * be parsed at this point. This function is mandatory.
3010      *
3011      * @param avctx the codec context
3012      * @param buf the slice data buffer base
3013      * @param buf_size the size of the slice in bytes
3014      * @return zero if successful, a negative value otherwise
3015      */
3016     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3017
3018     /**
3019      * Called at the end of each frame or field picture.
3020      *
3021      * The whole picture is parsed at this point and can now be sent
3022      * to the hardware accelerator. This function is mandatory.
3023      *
3024      * @param avctx the codec context
3025      * @return zero if successful, a negative value otherwise
3026      */
3027     int (*end_frame)(AVCodecContext *avctx);
3028
3029     /**
3030      * Size of HW accelerator private data.
3031      *
3032      * Private data is allocated with av_mallocz() before
3033      * AVCodecContext.get_buffer() and deallocated after
3034      * AVCodecContext.release_buffer().
3035      */
3036     int priv_data_size;
3037 } AVHWAccel;
3038
3039 /**
3040  * four components are given, that's all.
3041  * the last component is alpha
3042  */
3043 typedef struct AVPicture {
3044     uint8_t *data[AV_NUM_DATA_POINTERS];
3045     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3046 } AVPicture;
3047
3048 #define AVPALETTE_SIZE 1024
3049 #define AVPALETTE_COUNT 256
3050
3051 enum AVSubtitleType {
3052     SUBTITLE_NONE,
3053
3054     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3055
3056     /**
3057      * Plain text, the text field must be set by the decoder and is
3058      * authoritative. ass and pict fields may contain approximations.
3059      */
3060     SUBTITLE_TEXT,
3061
3062     /**
3063      * Formatted text, the ass field must be set by the decoder and is
3064      * authoritative. pict and text fields may contain approximations.
3065      */
3066     SUBTITLE_ASS,
3067 };
3068
3069 typedef struct AVSubtitleRect {
3070     int x;         ///< top left corner  of pict, undefined when pict is not set
3071     int y;         ///< top left corner  of pict, undefined when pict is not set
3072     int w;         ///< width            of pict, undefined when pict is not set
3073     int h;         ///< height           of pict, undefined when pict is not set
3074     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3075
3076     /**
3077      * data+linesize for the bitmap of this subtitle.
3078      * can be set for text/ass as well once they where rendered
3079      */
3080     AVPicture pict;
3081     enum AVSubtitleType type;
3082
3083     char *text;                     ///< 0 terminated plain UTF-8 text
3084
3085     /**
3086      * 0 terminated ASS/SSA compatible event line.
3087      * The pressentation of this is unaffected by the other values in this
3088      * struct.
3089      */
3090     char *ass;
3091 } AVSubtitleRect;
3092
3093 typedef struct AVSubtitle {
3094     uint16_t format; /* 0 = graphics */
3095     uint32_t start_display_time; /* relative to packet pts, in ms */
3096     uint32_t end_display_time; /* relative to packet pts, in ms */
3097     unsigned num_rects;
3098     AVSubtitleRect **rects;
3099     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3100 } AVSubtitle;
3101
3102 /* packet functions */
3103
3104 /**
3105  * @deprecated use NULL instead
3106  */
3107 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3108
3109 /**
3110  * Default packet destructor.
3111  */
3112 void av_destruct_packet(AVPacket *pkt);
3113
3114 /**
3115  * Initialize optional fields of a packet with default values.
3116  *
3117  * @param pkt packet
3118  */
3119 void av_init_packet(AVPacket *pkt);
3120
3121 /**
3122  * Allocate the payload of a packet and initialize its fields with
3123  * default values.
3124  *
3125  * @param pkt packet
3126  * @param size wanted payload size
3127  * @return 0 if OK, AVERROR_xxx otherwise
3128  */
3129 int av_new_packet(AVPacket *pkt, int size);
3130
3131 /**
3132  * Reduce packet size, correctly zeroing padding
3133  *
3134  * @param pkt packet
3135  * @param size new size
3136  */
3137 void av_shrink_packet(AVPacket *pkt, int size);
3138
3139 /**
3140  * Increase packet size, correctly zeroing padding
3141  *
3142  * @param pkt packet
3143  * @param grow_by number of bytes by which to increase the size of the packet
3144  */
3145 int av_grow_packet(AVPacket *pkt, int grow_by);
3146
3147 /**
3148  * @warning This is a hack - the packet memory allocation stuff is broken. The
3149  * packet is allocated if it was not really allocated.
3150  */
3151 int av_dup_packet(AVPacket *pkt);
3152
3153 /**
3154  * Free a packet.
3155  *
3156  * @param pkt packet to free
3157  */
3158 void av_free_packet(AVPacket *pkt);
3159
3160 /**
3161  * Allocate new information of a packet.
3162  *
3163  * @param pkt packet
3164  * @param type side information type
3165  * @param size side information size
3166  * @return pointer to fresh allocated data or NULL otherwise
3167  */
3168 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3169                                  int size);
3170
3171 /**
3172  * Shrink the already allocated side data buffer
3173  *
3174  * @param pkt packet
3175  * @param type side information type
3176  * @param size new side information size
3177  * @return 0 on success, < 0 on failure
3178  */
3179 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3180                                int size);
3181
3182 /**
3183  * Get side information from packet.
3184  *
3185  * @param pkt packet
3186  * @param type desired side information type
3187  * @param size pointer for side information size to store (optional)
3188  * @return pointer to data if present or NULL otherwise
3189  */
3190 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3191                                  int *size);
3192
3193 int av_packet_merge_side_data(AVPacket *pkt);
3194
3195 int av_packet_split_side_data(AVPacket *pkt);
3196
3197
3198 /* resample.c */
3199
3200 struct ReSampleContext;
3201 struct AVResampleContext;
3202
3203 typedef struct ReSampleContext ReSampleContext;
3204
3205 /**
3206  *  Initialize audio resampling context.
3207  *
3208  * @param output_channels  number of output channels
3209  * @param input_channels   number of input channels
3210  * @param output_rate      output sample rate
3211  * @param input_rate       input sample rate
3212  * @param sample_fmt_out   requested output sample format
3213  * @param sample_fmt_in    input sample format
3214  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3215  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3216  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3217                            between the 2 closest, if 0 the closest will be used
3218  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3219  * @return allocated ReSampleContext, NULL if error occurred
3220  */
3221 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3222                                         int output_rate, int input_rate,
3223                                         enum AVSampleFormat sample_fmt_out,
3224                                         enum AVSampleFormat sample_fmt_in,
3225                                         int filter_length, int log2_phase_count,
3226                                         int linear, double cutoff);
3227
3228 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3229
3230 /**
3231  * Free resample context.
3232  *
3233  * @param s a non-NULL pointer to a resample context previously
3234  *          created with av_audio_resample_init()
3235  */
3236 void audio_resample_close(ReSampleContext *s);
3237
3238
3239 /**
3240  * Initialize an audio resampler.
3241  * Note, if either rate is not an integer then simply scale both rates up so they are.
3242  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3243  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3244  * @param linear If 1 then the used FIR filter will be linearly interpolated
3245                  between the 2 closest, if 0 the closest will be used
3246  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3247  */
3248 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3249
3250 /**
3251  * Resample an array of samples using a previously configured context.
3252  * @param src an array of unconsumed samples
3253  * @param consumed the number of samples of src which have been consumed are returned here
3254  * @param src_size the number of unconsumed samples available
3255  * @param dst_size the amount of space in samples available in dst
3256  * @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.
3257  * @return the number of samples written in dst or -1 if an error occurred
3258  */
3259 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3260
3261
3262 /**
3263  * Compensate samplerate/timestamp drift. The compensation is done by changing
3264  * the resampler parameters, so no audible clicks or similar distortions occur
3265  * @param compensation_distance distance in output samples over which the compensation should be performed
3266  * @param sample_delta number of output samples which should be output less
3267  *
3268  * example: av_resample_compensate(c, 10, 500)
3269  * here instead of 510 samples only 500 samples would be output
3270  *
3271  * note, due to rounding the actual compensation might be slightly different,
3272  * especially if the compensation_distance is large and the in_rate used during init is small
3273  */
3274 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3275 void av_resample_close(struct AVResampleContext *c);
3276
3277 /**
3278  * Allocate memory for a picture.  Call avpicture_free() to free it.
3279  *
3280  * @see avpicture_fill()
3281  *
3282  * @param picture the picture to be filled in
3283  * @param pix_fmt the format of the picture
3284  * @param width the width of the picture
3285  * @param height the height of the picture
3286  * @return zero if successful, a negative value if not
3287  */
3288 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3289
3290 /**
3291  * Free a picture previously allocated by avpicture_alloc().
3292  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3293  * itself is not.
3294  *
3295  * @param picture the AVPicture to be freed
3296  */
3297 void avpicture_free(AVPicture *picture);
3298
3299 /**
3300  * Fill in the AVPicture fields.
3301  * The fields of the given AVPicture are filled in by using the 'ptr' address
3302  * which points to the image data buffer. Depending on the specified picture
3303  * format, one or multiple image data pointers and line sizes will be set.
3304  * If a planar format is specified, several pointers will be set pointing to
3305  * the different picture planes and the line sizes of the different planes
3306  * will be stored in the lines_sizes array.
3307  * Call with ptr == NULL to get the required size for the ptr buffer.
3308  *
3309  * To allocate the buffer and fill in the AVPicture fields in one call,
3310  * use avpicture_alloc().
3311  *
3312  * @param picture AVPicture whose fields are to be filled in
3313  * @param ptr Buffer which will contain or contains the actual image data
3314  * @param pix_fmt The format in which the picture data is stored.
3315  * @param width the width of the image in pixels
3316  * @param height the height of the image in pixels
3317  * @return size of the image data in bytes
3318  */
3319 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3320                    enum PixelFormat pix_fmt, int width, int height);
3321
3322 /**
3323  * Copy pixel data from an AVPicture into a buffer.
3324  * The data is stored compactly, without any gaps for alignment or padding
3325  * which may be applied by avpicture_fill().
3326  *
3327  * @see avpicture_get_size()
3328  *
3329  * @param[in] src AVPicture containing image data
3330  * @param[in] pix_fmt The format in which the picture data is stored.
3331  * @param[in] width the width of the image in pixels.
3332  * @param[in] height the height of the image in pixels.
3333  * @param[out] dest A buffer into which picture data will be copied.
3334  * @param[in] dest_size The size of 'dest'.
3335  * @return The number of bytes written to dest, or a negative value (error code) on error.
3336  */
3337 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3338                      unsigned char *dest, int dest_size);
3339
3340 /**
3341  * Calculate the size in bytes that a picture of the given width and height
3342  * would occupy if stored in the given picture format.
3343  * Note that this returns the size of a compact representation as generated
3344  * by avpicture_layout(), which can be smaller than the size required for e.g.
3345  * avpicture_fill().
3346  *
3347  * @param pix_fmt the given picture format
3348  * @param width the width of the image
3349  * @param height the height of the image
3350  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3351  */
3352 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3353 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3354
3355 /**
3356  * Get the name of a codec.
3357  * @return  a static string identifying the codec; never NULL
3358  */
3359 const char *avcodec_get_name(enum CodecID id);
3360
3361 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3362
3363 /**
3364  * Return a value representing the fourCC code associated to the
3365  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3366  * found.
3367  */
3368 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3369
3370 /**
3371  * Put a string representing the codec tag codec_tag in buf.
3372  *
3373  * @param buf_size size in bytes of buf
3374  * @return the length of the string that would have been generated if
3375  * enough space had been available, excluding the trailing null
3376  */
3377 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3378
3379 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3380 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3381 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3382 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3383 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3384 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3385
3386 /**
3387  * Compute what kind of losses will occur when converting from one specific
3388  * pixel format to another.
3389  * When converting from one pixel format to another, information loss may occur.
3390  * For example, when converting from RGB24 to GRAY, the color information will
3391  * be lost. Similarly, other losses occur when converting from some formats to
3392  * other formats. These losses can involve loss of chroma, but also loss of
3393  * resolution, loss of color depth, loss due to the color space conversion, loss
3394  * of the alpha bits or loss due to color quantization.
3395  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3396  * which will occur when converting from one pixel format to another.
3397  *
3398  * @param[in] dst_pix_fmt destination pixel format
3399  * @param[in] src_pix_fmt source pixel format
3400  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3401  * @return Combination of flags informing you what kind of losses will occur
3402  * (maximum loss for an invalid dst_pix_fmt).
3403  */
3404 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3405                              int has_alpha);
3406
3407 /**
3408  * Find the best pixel format to convert to given a certain source pixel
3409  * format.  When converting from one pixel format to another, information loss
3410  * may occur.  For example, when converting from RGB24 to GRAY, the color
3411  * information will be lost. Similarly, other losses occur when converting from
3412  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3413  * the given pixel formats should be used to suffer the least amount of loss.
3414  * The pixel formats from which it chooses one, are determined by the
3415  * pix_fmt_mask parameter.
3416  *
3417  * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3418  *
3419  * @code
3420  * src_pix_fmt = PIX_FMT_YUV420P;
3421  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3422  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3423  * @endcode
3424  *
3425  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3426  * @param[in] src_pix_fmt source pixel format
3427  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3428  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3429  * @return The best pixel format to convert to or -1 if none was found.
3430  */
3431 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3432                               int has_alpha, int *loss_ptr);
3433
3434 /**
3435  * Find the best pixel format to convert to given a certain source pixel
3436  * format and a selection of two destination pixel formats. When converting from
3437  * one pixel format to another, information loss may occur.  For example, when converting
3438  * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3439  * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3440  * the given pixel formats should be used to suffer the least amount of loss.
3441  *
3442  * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3443  * returned.
3444  *
3445  * @code
3446  * src_pix_fmt = PIX_FMT_YUV420P;
3447  * dst_pix_fmt1= PIX_FMT_RGB24;
3448  * dst_pix_fmt2= PIX_FMT_GRAY8;
3449  * dst_pix_fmt3= PIX_FMT_RGB8;
3450  * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3451  * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3452  * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3453  * @endcode
3454  *
3455  * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3456  * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3457  * @param[in] src_pix_fmt Source pixel format
3458  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3459  * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3460  *                               NULL or value of zero means we care about all losses. Out: the loss
3461  *                               that occurs when converting from src to selected dst pixel format.
3462  * @return The best pixel format to convert to or -1 if none was found.
3463  */
3464 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3465                                             enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3466
3467
3468 /* deinterlace a picture */
3469 /* deinterlace - if not supported return -1 */
3470 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3471                           enum PixelFormat pix_fmt, int width, int height);
3472
3473 /* external high level API */
3474
3475 /**
3476  * If c is NULL, returns the first registered codec,
3477  * if c is non-NULL, returns the next registered codec after c,
3478  * or NULL if c is the last one.
3479  */
3480 AVCodec *av_codec_next(AVCodec *c);
3481
3482 /**
3483  * Return the LIBAVCODEC_VERSION_INT constant.
3484  */
3485 unsigned avcodec_version(void);
3486
3487 /**
3488  * Return the libavcodec build-time configuration.
3489  */
3490 const char *avcodec_configuration(void);
3491
3492 /**
3493  * Return the libavcodec license.
3494  */
3495 const char *avcodec_license(void);
3496
3497 /**
3498  * Register the codec codec and initialize libavcodec.
3499  *
3500  * @warning either this function or avcodec_register_all() must be called
3501  * before any other libavcodec functions.
3502  *
3503  * @see avcodec_register_all()
3504  */
3505 void avcodec_register(AVCodec *codec);
3506
3507 /**
3508  * Find a registered encoder with a matching codec ID.
3509  *
3510  * @param id CodecID of the requested encoder
3511  * @return An encoder if one was found, NULL otherwise.
3512  */
3513 AVCodec *avcodec_find_encoder(enum CodecID id);
3514
3515 /**
3516  * Find a registered encoder with the specified name.
3517  *
3518  * @param name name of the requested encoder
3519  * @return An encoder if one was found, NULL otherwise.
3520  */
3521 AVCodec *avcodec_find_encoder_by_name(const char *name);
3522
3523 /**
3524  * Find a registered decoder with a matching codec ID.
3525  *
3526  * @param id CodecID of the requested decoder
3527  * @return A decoder if one was found, NULL otherwise.
3528  */
3529 AVCodec *avcodec_find_decoder(enum CodecID id);
3530
3531 /**
3532  * Find a registered decoder with the specified name.
3533  *
3534  * @param name name of the requested decoder
3535  * @return A decoder if one was found, NULL otherwise.
3536  */
3537 AVCodec *avcodec_find_decoder_by_name(const char *name);
3538 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3539
3540 /**
3541  * Return a name for the specified profile, if available.
3542  *
3543  * @param codec the codec that is searched for the given profile
3544  * @param profile the profile value for which a name is requested
3545  * @return A name for the profile if found, NULL otherwise.
3546  */
3547 const char *av_get_profile_name(const AVCodec *codec, int profile);
3548
3549 #if FF_API_ALLOC_CONTEXT
3550 /**
3551  * Set the fields of the given AVCodecContext to default values.
3552  *
3553  * @param s The AVCodecContext of which the fields should be set to default values.
3554  * @deprecated use avcodec_get_context_defaults3
3555  */
3556 attribute_deprecated
3557 void avcodec_get_context_defaults(AVCodecContext *s);
3558
3559 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3560  *  we WILL change its arguments and name a few times! */
3561 attribute_deprecated
3562 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3563 #endif
3564
3565 /**
3566  * Set the fields of the given AVCodecContext to default values corresponding
3567  * to the given codec (defaults may be codec-dependent).
3568  *
3569  * Do not call this function if a non-NULL codec has been passed
3570  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3571  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3572  * different codec on this AVCodecContext.
3573  */
3574 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3575
3576 #if FF_API_ALLOC_CONTEXT
3577 /**
3578  * Allocate an AVCodecContext and set its fields to default values.  The
3579  * resulting struct can be deallocated by simply calling av_free().
3580  *
3581  * @return An AVCodecContext filled with default values or NULL on failure.
3582  * @see avcodec_get_context_defaults
3583  *
3584  * @deprecated use avcodec_alloc_context3()
3585  */
3586 attribute_deprecated
3587 AVCodecContext *avcodec_alloc_context(void);
3588
3589 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3590  *  we WILL change its arguments and name a few times! */
3591 attribute_deprecated
3592 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3593 #endif
3594
3595 /**
3596  * Allocate an AVCodecContext and set its fields to default values.  The
3597  * resulting struct can be deallocated by calling avcodec_close() on it followed
3598  * by av_free().
3599  *
3600  * @param codec if non-NULL, allocate private data and initialize defaults
3601  *              for the given codec. It is illegal to then call avcodec_open2()
3602  *              with a different codec.
3603  *              If NULL, then the codec-specific defaults won't be initialized,
3604  *              which may result in suboptimal default settings (this is
3605  *              important mainly for encoders, e.g. libx264).
3606  *
3607  * @return An AVCodecContext filled with default values or NULL on failure.
3608  * @see avcodec_get_context_defaults
3609  */
3610 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3611
3612 /**
3613  * Copy the settings of the source AVCodecContext into the destination
3614  * AVCodecContext. The resulting destination codec context will be
3615  * unopened, i.e. you are required to call avcodec_open2() before you
3616  * can use this AVCodecContext to decode/encode video/audio data.
3617  *
3618  * @param dest target codec context, should be initialized with
3619  *             avcodec_alloc_context3(), but otherwise uninitialized
3620  * @param src source codec context
3621  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3622  */
3623 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3624
3625 /**
3626  * Set the fields of the given AVFrame to default values.
3627  *
3628  * @param pic The AVFrame of which the fields should be set to default values.
3629  */
3630 void avcodec_get_frame_defaults(AVFrame *pic);
3631
3632 /**
3633  * Allocate an AVFrame and set its fields to default values.  The resulting
3634  * struct can be deallocated by simply calling av_free().
3635  *
3636  * @return An AVFrame filled with default values or NULL on failure.
3637  * @see avcodec_get_frame_defaults
3638  */
3639 AVFrame *avcodec_alloc_frame(void);
3640
3641 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3642 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3643 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3644
3645 /**
3646  * Return the amount of padding in pixels which the get_buffer callback must
3647  * provide around the edge of the image for codecs which do not have the
3648  * CODEC_FLAG_EMU_EDGE flag.
3649  *
3650  * @return Required padding in pixels.
3651  */
3652 unsigned avcodec_get_edge_width(void);
3653 /**
3654  * Modify width and height values so that they will result in a memory
3655  * buffer that is acceptable for the codec if you do not use any horizontal
3656  * padding.
3657  *
3658  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3659  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3660  * according to avcodec_get_edge_width() before.
3661  */
3662 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3663 /**
3664  * Modify width and height values so that they will result in a memory
3665  * buffer that is acceptable for the codec if you also ensure that all
3666  * line sizes are a multiple of the respective linesize_align[i].
3667  *
3668  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3669  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3670  * according to avcodec_get_edge_width() before.
3671  */
3672 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3673                                int linesize_align[AV_NUM_DATA_POINTERS]);
3674
3675 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3676
3677 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3678 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3679 //FIXME func typedef
3680
3681 #if FF_API_AVCODEC_OPEN
3682 /**
3683  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3684  * function the context has to be allocated.
3685  *
3686  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3687  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3688  * retrieving a codec.
3689  *
3690  * @warning This function is not thread safe!
3691  *
3692  * @code
3693  * avcodec_register_all();
3694  * codec = avcodec_find_decoder(CODEC_ID_H264);
3695  * if (!codec)
3696  *     exit(1);
3697  *
3698  * context = avcodec_alloc_context3(codec);
3699  *
3700  * if (avcodec_open(context, codec) < 0)
3701  *     exit(1);
3702  * @endcode
3703  *
3704  * @param avctx The context which will be set up to use the given codec.
3705  * @param codec The codec to use within the context.
3706  * @return zero on success, a negative value on error
3707  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3708  *
3709  * @deprecated use avcodec_open2
3710  */
3711 attribute_deprecated
3712 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3713 #endif
3714
3715 /**
3716  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3717  * function the context has to be allocated with avcodec_alloc_context3().
3718  *
3719  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3720  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3721  * retrieving a codec.
3722  *
3723  * @warning This function is not thread safe!
3724  *
3725  * @code
3726  * avcodec_register_all();
3727  * av_dict_set(&opts, "b", "2.5M", 0);
3728  * codec = avcodec_find_decoder(CODEC_ID_H264);
3729  * if (!codec)
3730  *     exit(1);
3731  *
3732  * context = avcodec_alloc_context3(codec);
3733  *
3734  * if (avcodec_open2(context, codec, opts) < 0)
3735  *     exit(1);
3736  * @endcode
3737  *
3738  * @param avctx The context to initialize.
3739  * @param codec The codec to open this context for. If a non-NULL codec has been
3740  *              previously passed to avcodec_alloc_context3() or
3741  *              avcodec_get_context_defaults3() for this context, then this
3742  *              parameter MUST be either NULL or equal to the previously passed
3743  *              codec.
3744  * @param options A dictionary filled with AVCodecContext and codec-private options.
3745  *                On return this object will be filled with options that were not found.
3746  *
3747  * @return zero on success, a negative value on error
3748  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3749  *      av_dict_set(), av_opt_find().
3750  */
3751 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3752
3753 #if FF_API_OLD_DECODE_AUDIO
3754 /**
3755  * Wrapper function which calls avcodec_decode_audio4.
3756  *
3757  * @deprecated Use avcodec_decode_audio4 instead.
3758  *
3759  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3760  * Some decoders may support multiple frames in a single AVPacket, such
3761  * decoders would then just decode the first frame. In this case,
3762  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3763  * the remaining data in order to decode the second frame etc.
3764  * If no frame
3765  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3766  * decompressed frame size in bytes.
3767  *
3768  * @warning You must set frame_size_ptr to the allocated size of the
3769  * output buffer before calling avcodec_decode_audio3().
3770  *
3771  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3772  * the actual read bytes because some optimized bitstream readers read 32 or 64
3773  * bits at once and could read over the end.
3774  *
3775  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3776  * no overreading happens for damaged MPEG streams.
3777  *
3778  * @warning You must not provide a custom get_buffer() when using
3779  * avcodec_decode_audio3().  Doing so will override it with
3780  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,
3781  * which does allow the application to provide a custom get_buffer().
3782  *
3783  * @note You might have to align the input buffer avpkt->data and output buffer
3784  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3785  * necessary at all, on others it won't work at all if not aligned and on others
3786  * it will work but it will have an impact on performance.
3787  *
3788  * In practice, avpkt->data should have 4 byte alignment at minimum and
3789  * samples should be 16 byte aligned unless the CPU doesn't need it
3790  * (AltiVec and SSE do).
3791  *
3792  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3793  * between input and output, these need to be fed with avpkt->data=NULL,
3794  * avpkt->size=0 at the end to return the remaining frames.
3795  *
3796  * @param avctx the codec context
3797  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3798  *                     If the sample format is planar, each channel plane will
3799  *                     be the same size, with no padding between channels.
3800  * @param[in,out] frame_size_ptr the output buffer size in bytes
3801  * @param[in] avpkt The input AVPacket containing the input buffer.
3802  *            You can create such packet with av_init_packet() and by then setting
3803  *            data and size, some decoders might in addition need other fields.
3804  *            All decoders are designed to use the least fields possible though.
3805  * @return On error a negative value is returned, otherwise the number of bytes
3806  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3807  */
3808 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3809                          int *frame_size_ptr,
3810                          AVPacket *avpkt);
3811 #endif
3812
3813 /**
3814  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3815  *
3816  * Some decoders may support multiple frames in a single AVPacket. Such
3817  * decoders would then just decode the first frame. In this case,
3818  * avcodec_decode_audio4 has to be called again with an AVPacket containing
3819  * the remaining data in order to decode the second frame, etc...
3820  * Even if no frames are returned, the packet needs to be fed to the decoder
3821  * with remaining data until it is completely consumed or an error occurs.
3822  *
3823  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3824  *          larger than the actual read bytes because some optimized bitstream
3825  *          readers read 32 or 64 bits at once and could read over the end.
3826  *
3827  * @note You might have to align the input buffer. The alignment requirements
3828  *       depend on the CPU and the decoder.
3829  *
3830  * @param      avctx the codec context
3831  * @param[out] frame The AVFrame in which to store decoded audio samples.
3832  *                   Decoders request a buffer of a particular size by setting
3833  *                   AVFrame.nb_samples prior to calling get_buffer(). The
3834  *                   decoder may, however, only utilize part of the buffer by
3835  *                   setting AVFrame.nb_samples to a smaller value in the
3836  *                   output frame.
3837  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3838  *                           non-zero.
3839  * @param[in]  avpkt The input AVPacket containing the input buffer.
3840  *                   At least avpkt->data and avpkt->size should be set. Some
3841  *                   decoders might also require additional fields to be set.
3842  * @return A negative error code is returned if an error occurred during
3843  *         decoding, otherwise the number of bytes consumed from the input
3844  *         AVPacket is returned.
3845  */
3846 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3847                           int *got_frame_ptr, AVPacket *avpkt);
3848
3849 /**
3850  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3851  * Some decoders may support multiple frames in a single AVPacket, such
3852  * decoders would then just decode the first frame.
3853  *
3854  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3855  * the actual read bytes because some optimized bitstream readers read 32 or 64
3856  * bits at once and could read over the end.
3857  *
3858  * @warning The end of the input buffer buf should be set to 0 to ensure that
3859  * no overreading happens for damaged MPEG streams.
3860  *
3861  * @note You might have to align the input buffer avpkt->data.
3862  * The alignment requirements depend on the CPU: on some CPUs it isn't
3863  * necessary at all, on others it won't work at all if not aligned and on others
3864  * it will work but it will have an impact on performance.
3865  *
3866  * In practice, avpkt->data should have 4 byte alignment at minimum.
3867  *
3868  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3869  * between input and output, these need to be fed with avpkt->data=NULL,
3870  * avpkt->size=0 at the end to return the remaining frames.
3871  *
3872  * @param avctx the codec context
3873  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3874  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3875  *             allocate memory for the actual bitmap.
3876  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3877  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3878  *                   decodes and the decoder tells the user once it does not need the data anymore,
3879  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3880  *
3881  * @param[in] avpkt The input AVpacket containing the input buffer.
3882  *            You can create such packet with av_init_packet() and by then setting
3883  *            data and size, some decoders might in addition need other fields like
3884  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3885  *            fields possible.
3886  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3887  * @return On error a negative value is returned, otherwise the number of bytes
3888  * used or zero if no frame could be decompressed.
3889  */
3890 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3891                          int *got_picture_ptr,
3892                          const AVPacket *avpkt);
3893
3894 /**
3895  * Decode a subtitle message.
3896  * Return a negative value on error, otherwise return the number of bytes used.
3897  * If no subtitle could be decompressed, got_sub_ptr is zero.
3898  * Otherwise, the subtitle is stored in *sub.
3899  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3900  * simplicity, because the performance difference is expect to be negligible
3901  * and reusing a get_buffer written for video codecs would probably perform badly
3902  * due to a potentially very different allocation pattern.
3903  *
3904  * @param avctx the codec context
3905  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3906                    freed with avsubtitle_free if *got_sub_ptr is set.
3907  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3908  * @param[in] avpkt The input AVPacket containing the input buffer.
3909  */
3910 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3911                             int *got_sub_ptr,
3912                             AVPacket *avpkt);
3913
3914 /**
3915  * Free all allocated data in the given subtitle struct.
3916  *
3917  * @param sub AVSubtitle to free.
3918  */
3919 void avsubtitle_free(AVSubtitle *sub);
3920
3921 #if FF_API_OLD_ENCODE_AUDIO
3922 /**
3923  * Encode an audio frame from samples into buf.
3924  *
3925  * @deprecated Use avcodec_encode_audio2 instead.
3926  *
3927  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3928  * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3929  * will know how much space is needed because it depends on the value passed
3930  * in buf_size as described below. In that case a lower value can be used.
3931  *
3932  * @param avctx the codec context
3933  * @param[out] buf the output buffer
3934  * @param[in] buf_size the output buffer size
3935  * @param[in] samples the input buffer containing the samples
3936  * The number of samples read from this buffer is frame_size*channels,
3937  * both of which are defined in avctx.
3938  * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3939  * samples read from samples is equal to:
3940  * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3941  * This also implies that av_get_bits_per_sample() must not return 0 for these
3942  * codecs.
3943  * @return On error a negative value is returned, on success zero or the number
3944  * of bytes used to encode the data read from the input buffer.
3945  */
3946 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3947                                               uint8_t *buf, int buf_size,
3948                                               const short *samples);
3949 #endif
3950
3951 /**
3952  * Encode a frame of audio.
3953  *
3954  * Takes input samples from frame and writes the next output packet, if
3955  * available, to avpkt. The output packet does not necessarily contain data for
3956  * the most recent frame, as encoders can delay, split, and combine input frames
3957  * internally as needed.
3958  *
3959  * @param avctx     codec context
3960  * @param avpkt     output AVPacket.
3961  *                  The user can supply an output buffer by setting
3962  *                  avpkt->data and avpkt->size prior to calling the
3963  *                  function, but if the size of the user-provided data is not
3964  *                  large enough, encoding will fail. All other AVPacket fields
3965  *                  will be reset by the encoder using av_init_packet(). If
3966  *                  avpkt->data is NULL, the encoder will allocate it.
3967  *                  The encoder will set avpkt->size to the size of the
3968  *                  output packet.
3969  * @param[in] frame AVFrame containing the raw audio data to be encoded.
3970  *                  May be NULL when flushing an encoder that has the
3971  *                  CODEC_CAP_DELAY capability set.
3972  *                  There are 2 codec capabilities that affect the allowed
3973  *                  values of frame->nb_samples.
3974  *                  If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3975  *                  frame may be smaller than avctx->frame_size, and all other
3976  *                  frames must be equal to avctx->frame_size.
3977  *                  If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3978  *                  can have any number of samples.
3979  *                  If neither is set, frame->nb_samples must be equal to
3980  *                  avctx->frame_size for all frames.
3981  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3982  *                            output packet is non-empty, and to 0 if it is
3983  *                            empty. If the function returns an error, the
3984  *                            packet can be assumed to be invalid, and the
3985  *                            value of got_packet_ptr is undefined and should
3986  *                            not be used.
3987  * @return          0 on success, negative error code on failure
3988  */
3989 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3990                           const AVFrame *frame, int *got_packet_ptr);
3991
3992 /**
3993  * Fill audio frame data and linesize.
3994  * AVFrame extended_data channel pointers are allocated if necessary for
3995  * planar audio.
3996  *
3997  * @param frame       the AVFrame
3998  *                    frame->nb_samples must be set prior to calling the
3999  *                    function. This function fills in frame->data,
4000  *                    frame->extended_data, frame->linesize[0].
4001  * @param nb_channels channel count
4002  * @param sample_fmt  sample format
4003  * @param buf         buffer to use for frame data
4004  * @param buf_size    size of buffer
4005  * @param align       plane size sample alignment
4006  * @return            0 on success, negative error code on failure
4007  */
4008 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4009                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4010                              int buf_size, int align);
4011
4012 #if FF_API_OLD_ENCODE_VIDEO
4013 /**
4014  * @deprecated use avcodec_encode_video2() instead.
4015  *
4016  * Encode a video frame from pict into buf.
4017  * The input picture should be
4018  * stored using a specific format, namely avctx.pix_fmt.
4019  *
4020  * @param avctx the codec context
4021  * @param[out] buf the output buffer for the bitstream of encoded frame
4022  * @param[in] buf_size the size of the output buffer in bytes
4023  * @param[in] pict the input picture to encode
4024  * @return On error a negative value is returned, on success zero or the number
4025  * of bytes used from the output buffer.
4026  */
4027 attribute_deprecated
4028 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4029                          const AVFrame *pict);
4030 #endif
4031
4032 /**
4033  * Encode a frame of video.
4034  *
4035  * Takes input raw video data from frame and writes the next output packet, if
4036  * available, to avpkt. The output packet does not necessarily contain data for
4037  * the most recent frame, as encoders can delay and reorder input frames
4038  * internally as needed.
4039  *
4040  * @param avctx     codec context
4041  * @param avpkt     output AVPacket.
4042  *                  The user can supply an output buffer by setting
4043  *                  avpkt->data and avpkt->size prior to calling the
4044  *                  function, but if the size of the user-provided data is not
4045  *                  large enough, encoding will fail. All other AVPacket fields
4046  *                  will be reset by the encoder using av_init_packet(). If
4047  *                  avpkt->data is NULL, the encoder will allocate it.
4048  *                  The encoder will set avpkt->size to the size of the
4049  *                  output packet. The returned data (if any) belongs to the
4050  *                  caller, he is responsible for freeing it.
4051  * @param[in] frame AVFrame containing the raw video data to be encoded.
4052  *                  May be NULL when flushing an encoder that has the
4053  *                  CODEC_CAP_DELAY capability set.
4054  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4055  *                            output packet is non-empty, and to 0 if it is
4056  *                            empty. If the function returns an error, the
4057  *                            packet can be assumed to be invalid, and the
4058  *                            value of got_packet_ptr is undefined and should
4059  *                            not be used.
4060  * @return          0 on success, negative error code on failure
4061  */
4062 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4063                           const AVFrame *frame, int *got_packet_ptr);
4064
4065 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4066                             const AVSubtitle *sub);
4067
4068 /**
4069  * Close a given AVCodecContext and free all the data associated with it
4070  * (but not the AVCodecContext itself).
4071  *
4072  * Calling this function on an AVCodecContext that hasn't been opened will free
4073  * the codec-specific data allocated in avcodec_alloc_context3() /
4074  * avcodec_get_context_defaults3() with a non-NULL codec. Subsequent calls will
4075  * do nothing.
4076  */
4077 int avcodec_close(AVCodecContext *avctx);
4078
4079 /**
4080  * Register all the codecs, parsers and bitstream filters which were enabled at
4081  * configuration time. If you do not call this function you can select exactly
4082  * which formats you want to support, by using the individual registration
4083  * functions.
4084  *
4085  * @see avcodec_register
4086  * @see av_register_codec_parser
4087  * @see av_register_bitstream_filter
4088  */
4089 void avcodec_register_all(void);
4090
4091 /**
4092  * Flush buffers, should be called when seeking or when switching to a different stream.
4093  */
4094 void avcodec_flush_buffers(AVCodecContext *avctx);
4095
4096 void avcodec_default_free_buffers(AVCodecContext *s);
4097
4098 /* misc useful functions */
4099
4100 /**
4101  * Return codec bits per sample.
4102  *
4103  * @param[in] codec_id the codec
4104  * @return Number of bits per sample or zero if unknown for the given codec.
4105  */
4106 int av_get_bits_per_sample(enum CodecID codec_id);
4107
4108 /**
4109  * Return the PCM codec associated with a sample format.
4110  * @param be  endianness, 0 for little, 1 for big,
4111  *            -1 (or anything else) for native
4112  * @return  CODEC_ID_PCM_* or CODEC_ID_NONE
4113  */
4114 enum CodecID av_get_pcm_codec(enum AVSampleFormat fmt, int be);
4115
4116 /* frame parsing */
4117 typedef struct AVCodecParserContext {
4118     void *priv_data;
4119     struct AVCodecParser *parser;
4120     int64_t frame_offset; /* offset of the current frame */
4121     int64_t cur_offset; /* current offset
4122                            (incremented by each av_parser_parse()) */
4123     int64_t next_frame_offset; /* offset of the next frame */
4124     /* video info */
4125     int pict_type; /* XXX: Put it back in AVCodecContext. */
4126     /**
4127      * This field is used for proper frame duration computation in lavf.
4128      * It signals, how much longer the frame duration of the current frame
4129      * is compared to normal frame duration.
4130      *
4131      * frame_duration = (1 + repeat_pict) * time_base
4132      *
4133      * It is used by codecs like H.264 to display telecined material.
4134      */
4135     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4136     int64_t pts;     /* pts of the current frame */
4137     int64_t dts;     /* dts of the current frame */
4138
4139     /* private data */
4140     int64_t last_pts;
4141     int64_t last_dts;
4142     int fetch_timestamp;
4143
4144 #define AV_PARSER_PTS_NB 4
4145     int cur_frame_start_index;
4146     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4147     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4148     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4149
4150     int flags;
4151 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4152 #define PARSER_FLAG_ONCE                      0x0002
4153 /// Set if the parser has a valid file offset
4154 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4155
4156     int64_t offset;      ///< byte offset from starting packet start
4157     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4158
4159     /**
4160      * Set by parser to 1 for key frames and 0 for non-key frames.
4161      * It is initialized to -1, so if the parser doesn't set this flag,
4162      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4163      * will be used.
4164      */
4165     int key_frame;
4166
4167     /**
4168      * Time difference in stream time base units from the pts of this
4169      * packet to the point at which the output from the decoder has converged
4170      * independent from the availability of previous frames. That is, the
4171      * frames are virtually identical no matter if decoding started from
4172      * the very first frame or from this keyframe.
4173      * Is AV_NOPTS_VALUE if unknown.
4174      * This field is not the display duration of the current frame.
4175      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4176      * set.
4177      *
4178      * The purpose of this field is to allow seeking in streams that have no
4179      * keyframes in the conventional sense. It corresponds to the
4180      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4181      * essential for some types of subtitle streams to ensure that all
4182      * subtitles are correctly displayed after seeking.
4183      */
4184     int64_t convergence_duration;
4185
4186     // Timestamp generation support:
4187     /**
4188      * Synchronization point for start of timestamp generation.
4189      *
4190      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4191      * (default).
4192      *
4193      * For example, this corresponds to presence of H.264 buffering period
4194      * SEI message.
4195      */
4196     int dts_sync_point;
4197
4198     /**
4199      * Offset of the current timestamp against last timestamp sync point in
4200      * units of AVCodecContext.time_base.
4201      *
4202      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4203      * contain a valid timestamp offset.
4204      *
4205      * Note that the timestamp of sync point has usually a nonzero
4206      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4207      * the next frame after timestamp sync point will be usually 1.
4208      *
4209      * For example, this corresponds to H.264 cpb_removal_delay.
4210      */
4211     int dts_ref_dts_delta;
4212
4213     /**
4214      * Presentation delay of current frame in units of AVCodecContext.time_base.
4215      *
4216      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4217      * contain valid non-negative timestamp delta (presentation time of a frame
4218      * must not lie in the past).
4219      *
4220      * This delay represents the difference between decoding and presentation
4221      * time of the frame.
4222      *
4223      * For example, this corresponds to H.264 dpb_output_delay.
4224      */
4225     int pts_dts_delta;
4226
4227     /**
4228      * Position of the packet in file.
4229      *
4230      * Analogous to cur_frame_pts/dts
4231      */
4232     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4233
4234     /**
4235      * Byte position of currently parsed frame in stream.
4236      */
4237     int64_t pos;
4238
4239     /**
4240      * Previous frame byte position.
4241      */
4242     int64_t last_pos;
4243
4244     /**
4245      * Duration of the current frame.
4246      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4247      * For all other types, this is in units of AVCodecContext.time_base.
4248      */
4249     int duration;
4250 } AVCodecParserContext;
4251
4252 typedef struct AVCodecParser {
4253     int codec_ids[5]; /* several codec IDs are permitted */
4254     int priv_data_size;
4255     int (*parser_init)(AVCodecParserContext *s);
4256     int (*parser_parse)(AVCodecParserContext *s,
4257                         AVCodecContext *avctx,
4258                         const uint8_t **poutbuf, int *poutbuf_size,
4259                         const uint8_t *buf, int buf_size);
4260     void (*parser_close)(AVCodecParserContext *s);
4261     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4262     struct AVCodecParser *next;
4263 } AVCodecParser;
4264
4265 AVCodecParser *av_parser_next(AVCodecParser *c);
4266
4267 void av_register_codec_parser(AVCodecParser *parser);
4268 AVCodecParserContext *av_parser_init(int codec_id);
4269
4270 /**
4271  * Parse a packet.
4272  *
4273  * @param s             parser context.
4274  * @param avctx         codec context.
4275  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4276  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4277  * @param buf           input buffer.
4278  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4279  * @param pts           input presentation timestamp.
4280  * @param dts           input decoding timestamp.
4281  * @param pos           input byte position in stream.
4282  * @return the number of bytes of the input bitstream used.
4283  *
4284  * Example:
4285  * @code
4286  *   while(in_len){
4287  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4288  *                                        in_data, in_len,
4289  *                                        pts, dts, pos);
4290  *       in_data += len;
4291  *       in_len  -= len;
4292  *
4293  *       if(size)
4294  *          decode_frame(data, size);
4295  *   }
4296  * @endcode
4297  */
4298 int av_parser_parse2(AVCodecParserContext *s,
4299                      AVCodecContext *avctx,
4300                      uint8_t **poutbuf, int *poutbuf_size,
4301                      const uint8_t *buf, int buf_size,
4302                      int64_t pts, int64_t dts,
4303                      int64_t pos);
4304
4305 int av_parser_change(AVCodecParserContext *s,
4306                      AVCodecContext *avctx,
4307                      uint8_t **poutbuf, int *poutbuf_size,
4308                      const uint8_t *buf, int buf_size, int keyframe);
4309 void av_parser_close(AVCodecParserContext *s);
4310
4311
4312 typedef struct AVBitStreamFilterContext {
4313     void *priv_data;
4314     struct AVBitStreamFilter *filter;
4315     AVCodecParserContext *parser;
4316     struct AVBitStreamFilterContext *next;
4317 } AVBitStreamFilterContext;
4318
4319
4320 typedef struct AVBitStreamFilter {
4321     const char *name;
4322     int priv_data_size;
4323     int (*filter)(AVBitStreamFilterContext *bsfc,
4324                   AVCodecContext *avctx, const char *args,
4325                   uint8_t **poutbuf, int *poutbuf_size,
4326                   const uint8_t *buf, int buf_size, int keyframe);
4327     void (*close)(AVBitStreamFilterContext *bsfc);
4328     struct AVBitStreamFilter *next;
4329 } AVBitStreamFilter;
4330
4331 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4332 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4333 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4334                                AVCodecContext *avctx, const char *args,
4335                                uint8_t **poutbuf, int *poutbuf_size,
4336                                const uint8_t *buf, int buf_size, int keyframe);
4337 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4338
4339 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4340
4341 /* memory */
4342
4343 /**
4344  * Reallocate the given block if it is not large enough, otherwise do nothing.
4345  *
4346  * @see av_realloc
4347  */
4348 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4349
4350 /**
4351  * Allocate a buffer, reusing the given one if large enough.
4352  *
4353  * Contrary to av_fast_realloc the current buffer contents might not be
4354  * preserved and on error the old buffer is freed, thus no special
4355  * handling to avoid memleaks is necessary.
4356  *
4357  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4358  * @param size size of the buffer *ptr points to
4359  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4360  *                 *size 0 if an error occurred.
4361  */
4362 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4363
4364 /**
4365  * Same behaviour av_fast_malloc but the buffer has additional
4366  * FF_INPUT_PADDING_SIZE at the end which will will always be 0.
4367  *
4368  * In addition the whole buffer will initially and after resizes
4369  * be 0-initialized so that no uninitialized data will ever appear.
4370  */
4371 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
4372
4373 /**
4374  * Copy image src to dst. Wraps av_picture_data_copy() above.
4375  */
4376 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4377                      enum PixelFormat pix_fmt, int width, int height);
4378
4379 /**
4380  * Crop image top and left side.
4381  */
4382 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4383                     enum PixelFormat pix_fmt, int top_band, int left_band);
4384
4385 /**
4386  * Pad image.
4387  */
4388 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4389             int padtop, int padbottom, int padleft, int padright, int *color);
4390
4391 /**
4392  * Encode extradata length to a buffer. Used by xiph codecs.
4393  *
4394  * @param s buffer to write to; must be at least (v/255+1) bytes long
4395  * @param v size of extradata in bytes
4396  * @return number of bytes written to the buffer.
4397  */
4398 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4399
4400 /**
4401  * Log a generic warning message about a missing feature. This function is
4402  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4403  * only, and would normally not be used by applications.
4404  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4405  * a pointer to an AVClass struct
4406  * @param[in] feature string containing the name of the missing feature
4407  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4408  * If want_sample is non-zero, additional verbage will be added to the log
4409  * message which tells the user how to report samples to the development
4410  * mailing list.
4411  */
4412 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4413
4414 /**
4415  * Log a generic warning message asking for a sample. This function is
4416  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4417  * only, and would normally not be used by applications.
4418  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4419  * a pointer to an AVClass struct
4420  * @param[in] msg string containing an optional message, or NULL if no message
4421  */
4422 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4423
4424 /**
4425  * Register the hardware accelerator hwaccel.
4426  */
4427 void av_register_hwaccel(AVHWAccel *hwaccel);
4428
4429 /**
4430  * If hwaccel is NULL, returns the first registered hardware accelerator,
4431  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4432  * after hwaccel, or NULL if hwaccel is the last one.
4433  */
4434 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4435
4436
4437 /**
4438  * Lock operation used by lockmgr
4439  */
4440 enum AVLockOp {
4441   AV_LOCK_CREATE,  ///< Create a mutex
4442   AV_LOCK_OBTAIN,  ///< Lock the mutex
4443   AV_LOCK_RELEASE, ///< Unlock the mutex
4444   AV_LOCK_DESTROY, ///< Free mutex resources
4445 };
4446
4447 /**
4448  * Register a user provided lock manager supporting the operations
4449  * specified by AVLockOp. mutex points to a (void *) where the
4450  * lockmgr should store/get a pointer to a user allocated mutex. It's
4451  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4452  *
4453  * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4454  *           callback during the call to av_lockmgr_register().
4455  *           Thus, the application must be prepared to handle that.
4456  *           If cb is set to NULL the lockmgr will be unregistered.
4457  *           Also note that during unregistration the previously registered
4458  *           lockmgr callback may also be invoked.
4459  */
4460 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4461
4462 /**
4463  * Get the type of the given codec.
4464  */
4465 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4466
4467 /**
4468  * Get the AVClass for AVCodecContext. It can be used in combination with
4469  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4470  *
4471  * @see av_opt_find().
4472  */
4473 const AVClass *avcodec_get_class(void);
4474
4475 /**
4476  * Get the AVClass for AVFrame. It can be used in combination with
4477  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4478  *
4479  * @see av_opt_find().
4480  */
4481 const AVClass *avcodec_get_frame_class(void);
4482
4483 /**
4484  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
4485  * with no corresponding avcodec_close()), 0 otherwise.
4486  */
4487 int avcodec_is_open(AVCodecContext *s);
4488
4489 #endif /* AVCODEC_AVCODEC_H */