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