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

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