git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

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