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

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