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

   1 /*
   2  * copyright (c) 2001 Fabrice Bellard
   3  *
   4  * This file is part of FFmpeg.
   5  *
   6  * FFmpeg is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU Lesser General Public
   8  * License as published by the Free Software Foundation; either
   9  * version 2.1 of the License, or (at your option) any later version.
  10  *
  11  * FFmpeg is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * Lesser General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Lesser General Public
  17  * License along with FFmpeg; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
  19  */
  20
  21 #ifndef AVCODEC_AVCODEC_H
  22 #define AVCODEC_AVCODEC_H
  23
  24 /**
  25  * @file
  26  * external API header
  27  */
  28
  29 #include <errno.h>
  30 #include "libavutil/samplefmt.h"
  31 #include "libavutil/avutil.h"
  32 #include "libavutil/cpu.h"
  33 #include "libavutil/dict.h"
  34 #include "libavutil/log.h"
  35 #include "libavutil/pixfmt.h"
  36 #include "libavutil/rational.h"
  37
  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     CODEC_ID_G729 = 0x15800,
 348     CODEC_ID_G723_1= 0x15801,
 349
 350     /* subtitle codecs */
 351     CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
 352     CODEC_ID_DVD_SUBTITLE= 0x17000,
 353     CODEC_ID_DVB_SUBTITLE,
 354     CODEC_ID_TEXT,  ///< raw UTF-8 text
 355     CODEC_ID_XSUB,
 356     CODEC_ID_SSA,
 357     CODEC_ID_MOV_TEXT,
 358     CODEC_ID_HDMV_PGS_SUBTITLE,
 359     CODEC_ID_DVB_TELETEXT,
 360     CODEC_ID_SRT,
 361     CODEC_ID_MICRODVD,
 362
 363     /* other specific kind of codecs (generally used for attachments) */
 364     CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
 365     CODEC_ID_TTF= 0x18000,
 366     CODEC_ID_BINTEXT,
 367     CODEC_ID_XBIN,
 368     CODEC_ID_IDF,
 369
 370     CODEC_ID_PROBE= 0x19000, ///< codec_id is not known (like CODEC_ID_NONE) but lavf should attempt to identify it
 371
 372     CODEC_ID_MPEG2TS= 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 373                                 * stream (only used by libavformat) */
 374     CODEC_ID_FFMETADATA=0x21000,   ///< Dummy codec for streams containing only metadata information.
 375 };
 376
 377 #if FF_API_OLD_SAMPLE_FMT
 378 #define SampleFormat AVSampleFormat
 379
 380 #define SAMPLE_FMT_NONE AV_SAMPLE_FMT_NONE
 381 #define SAMPLE_FMT_U8   AV_SAMPLE_FMT_U8
 382 #define SAMPLE_FMT_S16  AV_SAMPLE_FMT_S16
 383 #define SAMPLE_FMT_S32  AV_SAMPLE_FMT_S32
 384 #define SAMPLE_FMT_FLT  AV_SAMPLE_FMT_FLT
 385 #define SAMPLE_FMT_DBL  AV_SAMPLE_FMT_DBL
 386 #define SAMPLE_FMT_NB   AV_SAMPLE_FMT_NB
 387 #endif
 388
 389 #if FF_API_OLD_AUDIOCONVERT
 390 #include "libavutil/audioconvert.h"
 391
 392 /* Audio channel masks */
 393 #define CH_FRONT_LEFT            AV_CH_FRONT_LEFT
 394 #define CH_FRONT_RIGHT           AV_CH_FRONT_RIGHT
 395 #define CH_FRONT_CENTER          AV_CH_FRONT_CENTER
 396 #define CH_LOW_FREQUENCY         AV_CH_LOW_FREQUENCY
 397 #define CH_BACK_LEFT             AV_CH_BACK_LEFT
 398 #define CH_BACK_RIGHT            AV_CH_BACK_RIGHT
 399 #define CH_FRONT_LEFT_OF_CENTER  AV_CH_FRONT_LEFT_OF_CENTER
 400 #define CH_FRONT_RIGHT_OF_CENTER AV_CH_FRONT_RIGHT_OF_CENTER
 401 #define CH_BACK_CENTER           AV_CH_BACK_CENTER
 402 #define CH_SIDE_LEFT             AV_CH_SIDE_LEFT
 403 #define CH_SIDE_RIGHT            AV_CH_SIDE_RIGHT
 404 #define CH_TOP_CENTER            AV_CH_TOP_CENTER
 405 #define CH_TOP_FRONT_LEFT        AV_CH_TOP_FRONT_LEFT
 406 #define CH_TOP_FRONT_CENTER      AV_CH_TOP_FRONT_CENTER
 407 #define CH_TOP_FRONT_RIGHT       AV_CH_TOP_FRONT_RIGHT
 408 #define CH_TOP_BACK_LEFT         AV_CH_TOP_BACK_LEFT
 409 #define CH_TOP_BACK_CENTER       AV_CH_TOP_BACK_CENTER
 410 #define CH_TOP_BACK_RIGHT        AV_CH_TOP_BACK_RIGHT
 411 #define CH_STEREO_LEFT           AV_CH_STEREO_LEFT
 412 #define CH_STEREO_RIGHT          AV_CH_STEREO_RIGHT
 413
 414 /** Channel mask value used for AVCodecContext.request_channel_layout
 415     to indicate that the user requests the channel order of the decoder output
 416     to be the native codec channel order. */
 417 #define CH_LAYOUT_NATIVE         AV_CH_LAYOUT_NATIVE
 418
 419 /* Audio channel convenience macros */
 420 #define CH_LAYOUT_MONO           AV_CH_LAYOUT_MONO
 421 #define CH_LAYOUT_STEREO         AV_CH_LAYOUT_STEREO
 422 #define CH_LAYOUT_2_1            AV_CH_LAYOUT_2_1
 423 #define CH_LAYOUT_SURROUND       AV_CH_LAYOUT_SURROUND
 424 #define CH_LAYOUT_4POINT0        AV_CH_LAYOUT_4POINT0
 425 #define CH_LAYOUT_2_2            AV_CH_LAYOUT_2_2
 426 #define CH_LAYOUT_QUAD           AV_CH_LAYOUT_QUAD
 427 #define CH_LAYOUT_5POINT0        AV_CH_LAYOUT_5POINT0
 428 #define CH_LAYOUT_5POINT1        AV_CH_LAYOUT_5POINT1
 429 #define CH_LAYOUT_5POINT0_BACK   AV_CH_LAYOUT_5POINT0_BACK
 430 #define CH_LAYOUT_5POINT1_BACK   AV_CH_LAYOUT_5POINT1_BACK
 431 #define CH_LAYOUT_7POINT0        AV_CH_LAYOUT_7POINT0
 432 #define CH_LAYOUT_7POINT1        AV_CH_LAYOUT_7POINT1
 433 #define CH_LAYOUT_7POINT1_WIDE   AV_CH_LAYOUT_7POINT1_WIDE
 434 #define CH_LAYOUT_STEREO_DOWNMIX AV_CH_LAYOUT_STEREO_DOWNMIX
 435 #endif
 436
 437 /* in bytes */
 438 #define AVCODEC_MAX_AUDIO_FRAME_SIZE 192000 // 1 second of 48khz 32bit audio
 439
 440 /**
 441  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 442  * This is mainly needed because some optimized bitstream readers read
 443  * 32 or 64 bit at once and could read over the end.<br>
 444  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 445  * MPEG bitstreams could cause overread and segfault.
 446  */
 447 #define FF_INPUT_BUFFER_PADDING_SIZE 16
 448
 449 /**
 450  * minimum encoding buffer size
 451  * Used to avoid some checks during header writing.
 452  */
 453 #define FF_MIN_BUFFER_SIZE 16384
 454
 455
 456 /**
 457  * motion estimation type.
 458  */
 459 enum Motion_Est_ID {
 460     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 461     ME_FULL,
 462     ME_LOG,
 463     ME_PHODS,
 464     ME_EPZS,        ///< enhanced predictive zonal search
 465     ME_X1,          ///< reserved for experiments
 466     ME_HEX,         ///< hexagon based search
 467     ME_UMH,         ///< uneven multi-hexagon search
 468     ME_ITER,        ///< iterative search
 469     ME_TESA,        ///< transformed exhaustive search algorithm
 470 };
 471
 472 enum AVDiscard{
 473     /* We leave some space between them for extensions (drop some
 474      * keyframes for intra-only or drop just some bidir frames). */
 475     AVDISCARD_NONE   =-16, ///< discard nothing
 476     AVDISCARD_DEFAULT=  0, ///< discard useless packets like 0 size packets in avi
 477     AVDISCARD_NONREF =  8, ///< discard all non reference
 478     AVDISCARD_BIDIR  = 16, ///< discard all bidirectional frames
 479     AVDISCARD_NONKEY = 32, ///< discard all frames except keyframes
 480     AVDISCARD_ALL    = 48, ///< discard all
 481 };
 482
 483 enum AVColorPrimaries{
 484     AVCOL_PRI_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 / SMPTE RP177 Annex B
 485     AVCOL_PRI_UNSPECIFIED=2,
 486     AVCOL_PRI_BT470M     =4,
 487     AVCOL_PRI_BT470BG    =5, ///< also ITU-R BT601-6 625 / ITU-R BT1358 625 / ITU-R BT1700 625 PAL & SECAM
 488     AVCOL_PRI_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC
 489     AVCOL_PRI_SMPTE240M  =7, ///< functionally identical to above
 490     AVCOL_PRI_FILM       =8,
 491     AVCOL_PRI_NB           , ///< Not part of ABI
 492 };
 493
 494 enum AVColorTransferCharacteristic{
 495     AVCOL_TRC_BT709      =1, ///< also ITU-R BT1361
 496     AVCOL_TRC_UNSPECIFIED=2,
 497     AVCOL_TRC_GAMMA22    =4, ///< also ITU-R BT470M / ITU-R BT1700 625 PAL & SECAM
 498     AVCOL_TRC_GAMMA28    =5, ///< also ITU-R BT470BG
 499     AVCOL_TRC_NB           , ///< Not part of ABI
 500 };
 501
 502 enum AVColorSpace{
 503     AVCOL_SPC_RGB        =0,
 504     AVCOL_SPC_BT709      =1, ///< also ITU-R BT1361 / IEC 61966-2-4 xvYCC709 / SMPTE RP177 Annex B
 505     AVCOL_SPC_UNSPECIFIED=2,
 506     AVCOL_SPC_FCC        =4,
 507     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
 508     AVCOL_SPC_SMPTE170M  =6, ///< also ITU-R BT601-6 525 / ITU-R BT1358 525 / ITU-R BT1700 NTSC / functionally identical to above
 509     AVCOL_SPC_SMPTE240M  =7,
 510     AVCOL_SPC_NB           , ///< Not part of ABI
 511 };
 512
 513 enum AVColorRange{
 514     AVCOL_RANGE_UNSPECIFIED=0,
 515     AVCOL_RANGE_MPEG       =1, ///< the normal 219*2^(n-8) "MPEG" YUV ranges
 516     AVCOL_RANGE_JPEG       =2, ///< the normal     2^n-1   "JPEG" YUV ranges
 517     AVCOL_RANGE_NB           , ///< Not part of ABI
 518 };
 519
 520 /**
 521  *  X   X      3 4 X      X are luma samples,
 522  *             1 2        1-6 are possible chroma positions
 523  *  X   X      5 6 X      0 is undefined/unknown position
 524  */
 525 enum AVChromaLocation{
 526     AVCHROMA_LOC_UNSPECIFIED=0,
 527     AVCHROMA_LOC_LEFT       =1, ///< mpeg2/4, h264 default
 528     AVCHROMA_LOC_CENTER     =2, ///< mpeg1, jpeg, h263
 529     AVCHROMA_LOC_TOPLEFT    =3, ///< DV
 530     AVCHROMA_LOC_TOP        =4,
 531     AVCHROMA_LOC_BOTTOMLEFT =5,
 532     AVCHROMA_LOC_BOTTOM     =6,
 533     AVCHROMA_LOC_NB           , ///< Not part of ABI
 534 };
 535
 536 #if FF_API_FLAC_GLOBAL_OPTS
 537 /**
 538  * LPC analysis type
 539  */
 540 attribute_deprecated enum AVLPCType {
 541     AV_LPC_TYPE_DEFAULT     = -1, ///< use the codec default LPC type
 542     AV_LPC_TYPE_NONE        =  0, ///< do not use LPC prediction or use all zero coefficients
 543     AV_LPC_TYPE_FIXED       =  1, ///< fixed LPC coefficients
 544     AV_LPC_TYPE_LEVINSON    =  2, ///< Levinson-Durbin recursion
 545     AV_LPC_TYPE_CHOLESKY    =  3, ///< Cholesky factorization
 546     AV_LPC_TYPE_NB              , ///< Not part of ABI
 547 };
 548 #endif
 549
 550 enum AVAudioServiceType {
 551     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
 552     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
 553     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
 554     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
 555     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
 556     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
 557     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
 558     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
 559     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
 560     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
 561 };
 562
 563 typedef struct RcOverride{
 564     int start_frame;
 565     int end_frame;
 566     int qscale; // If this is 0 then quality_factor will be used instead.
 567     float quality_factor;
 568 } RcOverride;
 569
 570 #define FF_MAX_B_FRAMES 16
 571
 572 /* encoding support
 573    These flags can be passed in AVCodecContext.flags before initialization.
 574    Note: Not everything is supported yet.
 575 */
 576
 577 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 578 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 579 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 580 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 581 #define CODEC_FLAG_MV0    0x0040  ///< Always try a MB with MV=<0,0>.
 582 /**
 583  * The parent program guarantees that the input for B-frames containing
 584  * streams is not written to for at least s->max_b_frames+1 frames, if
 585  * this is not set the input will be copied.
 586  */
 587 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 588 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 589 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 590 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 591 #define CODEC_FLAG_EMU_EDGE        0x4000   ///< Don't draw edges.
 592 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 593 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 594                                                   location instead of only at frame boundaries. */
 595 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000 ///< Normalize adaptive quantization.
 596 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 597 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 598 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 599 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 600 /* Fx : Flag for h263+ extra options */
 601 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 602 #define CODEC_FLAG_CBP_RD         0x04000000 ///< Use rate distortion optimization for cbp.
 603 #define CODEC_FLAG_QP_RD          0x08000000 ///< Use rate distortion optimization for qp selectioon.
 604 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 605 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 606 #define CODEC_FLAG_CLOSED_GOP     0x80000000
 607 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 608 #define CODEC_FLAG2_STRICT_GOP    0x00000002 ///< Strictly enforce GOP size.
 609 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 610 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 611 #define CODEC_FLAG2_SKIP_RD       0x00004000 ///< RD optimal MB level residual skipping
 612 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 613 #define CODEC_FLAG2_SHOW_ALL      0x00400000 ///< Show all frames before the first keyframe
 614 /**
 615  * @defgroup deprecated_flags Deprecated codec flags
 616  * Use corresponding private codec options instead.
 617  * @{
 618  */
 619 #if FF_API_MPEGVIDEO_GLOBAL_OPTS
 620 #define CODEC_FLAG_OBMC           0x00000001 ///< OBMC
 621 #define CODEC_FLAG_H263P_AIV      0x00000008 ///< H.263 alternative inter VLC
 622 #define CODEC_FLAG_PART   0x0080  ///< Use data partitioning.
 623 #define CODEC_FLAG_ALT_SCAN       0x00100000 ///< Use alternate scan.
 624 #define CODEC_FLAG_H263P_UMV      0x02000000 ///< unlimited motion vector
 625 #define CODEC_FLAG_H263P_SLICE_STRUCT 0x10000000
 626 #define CODEC_FLAG_SVCD_SCAN_OFFSET 0x40000000 ///< Will reserve space for SVCD scan offset user data.
 627 #define CODEC_FLAG2_INTRA_VLC     0x00000800 ///< Use MPEG-2 intra VLC table.
 628 #define CODEC_FLAG2_DROP_FRAME_TIMECODE 0x00002000 ///< timecode is in drop frame format.
 629 #define CODEC_FLAG2_NON_LINEAR_QUANT 0x00010000 ///< Use MPEG-2 nonlinear quantizer.
 630 #endif
 631 #if FF_API_MJPEG_GLOBAL_OPTS
 632 #define CODEC_FLAG_EXTERN_HUFF     0x1000   ///< Use external Huffman table (for MJPEG).
 633 #endif
 634 #if FF_API_X264_GLOBAL_OPTS
 635 #define CODEC_FLAG2_BPYRAMID      0x00000010 ///< H.264 allow B-frames to be used as references.
 636 #define CODEC_FLAG2_WPRED         0x00000020 ///< H.264 weighted biprediction for B-frames
 637 #define CODEC_FLAG2_MIXED_REFS    0x00000040 ///< H.264 one reference per partition, as opposed to one reference per macroblock
 638 #define CODEC_FLAG2_8X8DCT        0x00000080 ///< H.264 high profile 8x8 transform
 639 #define CODEC_FLAG2_FASTPSKIP     0x00000100 ///< H.264 fast pskip
 640 #define CODEC_FLAG2_AUD           0x00000200 ///< H.264 access unit delimiters
 641 #define CODEC_FLAG2_BRDO          0x00000400 ///< B-frame rate-distortion optimization
 642 #define CODEC_FLAG2_MBTREE        0x00040000 ///< Use macroblock tree ratecontrol (x264 only)
 643 #define CODEC_FLAG2_PSY           0x00080000 ///< Use psycho visual optimizations.
 644 #define CODEC_FLAG2_SSIM          0x00100000 ///< Compute SSIM during encoding, error[] values are undefined.
 645 #define CODEC_FLAG2_INTRA_REFRESH 0x00200000 ///< Use periodic insertion of intra blocks instead of keyframes.
 646 #endif
 647 #if FF_API_SNOW_GLOBAL_OPTS
 648 #define CODEC_FLAG2_MEMC_ONLY     0x00001000 ///< Only do ME/MC (I frames -> ref, P frame -> ME+MC).
 649 #endif
 650 #if FF_API_LAME_GLOBAL_OPTS
 651 #define CODEC_FLAG2_BIT_RESERVOIR 0x00020000 ///< Use a bit reservoir when encoding if possible
 652 #endif
 653 /**
 654  * @}
 655  */
 656
 657 /* Unsupported options :
 658  *              Syntax Arithmetic coding (SAC)
 659  *              Reference Picture Selection
 660  *              Independent Segment Decoding */
 661 /* /Fx */
 662 /* codec capabilities */
 663
 664 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
 665 /**
 666  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
 667  * If not set, it might not use get_buffer() at all or use operations that
 668  * assume the buffer was allocated by avcodec_default_get_buffer.
 669  */
 670 #define CODEC_CAP_DR1             0x0002
 671 /* If 'parse_only' field is true, then avcodec_parse_frame() can be used. */
 672 #define CODEC_CAP_PARSE_ONLY      0x0004
 673 #define CODEC_CAP_TRUNCATED       0x0008
 674 /* Codec can export data for HW decoding (XvMC). */
 675 #define CODEC_CAP_HWACCEL         0x0010
 676 /**
 677  * Codec has a nonzero delay and needs to be fed with NULL at the end to get the delayed data.
 678  * If this is not set, the codec is guaranteed to never be fed with NULL data.
 679  */
 680 #define CODEC_CAP_DELAY           0x0020
 681 /**
 682  * Codec can be fed a final frame with a smaller size.
 683  * This can be used to prevent truncation of the last audio samples.
 684  */
 685 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
 686 /**
 687  * Codec can export data for HW decoding (VDPAU).
 688  */
 689 #define CODEC_CAP_HWACCEL_VDPAU    0x0080
 690 /**
 691  * Codec can output multiple frames per AVPacket
 692  * Normally demuxers return one frame at a time, demuxers which do not do
 693  * are connected to a parser to split what they return into proper frames.
 694  * This flag is reserved to the very rare category of codecs which have a
 695  * bitstream that cannot be split into frames without timeconsuming
 696  * operations like full decoding. Demuxers carring such bitstreams thus
 697  * may return multiple frames in a packet. This has many disadvantages like
 698  * prohibiting stream copy in many cases thus it should only be considered
 699  * as a last resort.
 700  */
 701 #define CODEC_CAP_SUBFRAMES        0x0100
 702 /**
 703  * Codec is experimental and is thus avoided in favor of non experimental
 704  * encoders
 705  */
 706 #define CODEC_CAP_EXPERIMENTAL     0x0200
 707 /**
 708  * Codec should fill in channel configuration and samplerate instead of container
 709  */
 710 #define CODEC_CAP_CHANNEL_CONF     0x0400
 711
 712 /**
 713  * Codec is able to deal with negative linesizes
 714  */
 715 #define CODEC_CAP_NEG_LINESIZES    0x0800
 716
 717 /**
 718  * Codec supports frame-level multithreading.
 719  */
 720 #define CODEC_CAP_FRAME_THREADS    0x1000
 721 /**
 722  * Codec supports slice-based (or partition-based) multithreading.
 723  */
 724 #define CODEC_CAP_SLICE_THREADS    0x2000
 725 /**
 726  * Codec is lossless.
 727  */
 728 #define CODEC_CAP_LOSSLESS         0x80000000
 729
 730 //The following defines may change, don't expect compatibility if you use them.
 731 #define MB_TYPE_INTRA4x4   0x0001
 732 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
 733 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
 734 #define MB_TYPE_16x16      0x0008
 735 #define MB_TYPE_16x8       0x0010
 736 #define MB_TYPE_8x16       0x0020
 737 #define MB_TYPE_8x8        0x0040
 738 #define MB_TYPE_INTERLACED 0x0080
 739 #define MB_TYPE_DIRECT2    0x0100 //FIXME
 740 #define MB_TYPE_ACPRED     0x0200
 741 #define MB_TYPE_GMC        0x0400
 742 #define MB_TYPE_SKIP       0x0800
 743 #define MB_TYPE_P0L0       0x1000
 744 #define MB_TYPE_P1L0       0x2000
 745 #define MB_TYPE_P0L1       0x4000
 746 #define MB_TYPE_P1L1       0x8000
 747 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
 748 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
 749 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
 750 #define MB_TYPE_QUANT      0x00010000
 751 #define MB_TYPE_CBP        0x00020000
 752 //Note bits 24-31 are reserved for codec specific use (h264 ref0, mpeg1 0mv, ...)
 753
 754 /**
 755  * Pan Scan area.
 756  * This specifies the area which should be displayed.
 757  * Note there may be multiple such areas for one frame.
 758  */
 759 typedef struct AVPanScan{
 760     /**
 761      * id
 762      * - encoding: Set by user.
 763      * - decoding: Set by libavcodec.
 764      */
 765     int id;
 766
 767     /**
 768      * width and height in 1/16 pel
 769      * - encoding: Set by user.
 770      * - decoding: Set by libavcodec.
 771      */
 772     int width;
 773     int height;
 774
 775     /**
 776      * position of the top left corner in 1/16 pel for up to 3 fields/frames
 777      * - encoding: Set by user.
 778      * - decoding: Set by libavcodec.
 779      */
 780     int16_t position[3][2];
 781 }AVPanScan;
 782
 783 #define FF_QSCALE_TYPE_MPEG1 0
 784 #define FF_QSCALE_TYPE_MPEG2 1
 785 #define FF_QSCALE_TYPE_H264  2
 786 #define FF_QSCALE_TYPE_VP56  3
 787
 788 #define FF_BUFFER_TYPE_INTERNAL 1
 789 #define FF_BUFFER_TYPE_USER     2 ///< direct rendering buffers (image is (de)allocated by user)
 790 #define FF_BUFFER_TYPE_SHARED   4 ///< Buffer from somewhere else; don't deallocate image (data/base), all other tables are not shared.
 791 #define FF_BUFFER_TYPE_COPY     8 ///< Just a (modified) copy of some other buffer, don't deallocate anything.
 792
 793 #if FF_API_OLD_FF_PICT_TYPES
 794 /* DEPRECATED, directly use the AV_PICTURE_TYPE_* enum values */
 795 #define FF_I_TYPE  AV_PICTURE_TYPE_I  ///< Intra
 796 #define FF_P_TYPE  AV_PICTURE_TYPE_P  ///< Predicted
 797 #define FF_B_TYPE  AV_PICTURE_TYPE_B  ///< Bi-dir predicted
 798 #define FF_S_TYPE  AV_PICTURE_TYPE_S  ///< S(GMC)-VOP MPEG4
 799 #define FF_SI_TYPE AV_PICTURE_TYPE_SI ///< Switching Intra
 800 #define FF_SP_TYPE AV_PICTURE_TYPE_SP ///< Switching Predicted
 801 #define FF_BI_TYPE AV_PICTURE_TYPE_BI
 802 #endif
 803
 804 #define FF_BUFFER_HINTS_VALID    0x01 // Buffer hints value is meaningful (if 0 ignore).
 805 #define FF_BUFFER_HINTS_READABLE 0x02 // Codec will read from buffer.
 806 #define FF_BUFFER_HINTS_PRESERVE 0x04 // User must not alter buffer content.
 807 #define FF_BUFFER_HINTS_REUSABLE 0x08 // Codec will reuse the buffer (update).
 808
 809 enum AVPacketSideDataType {
 810     AV_PKT_DATA_PALETTE,
 811 };
 812
 813 typedef struct AVPacket {
 814     /**
 815      * Presentation timestamp in AVStream->time_base units; the time at which
 816      * the decompressed packet will be presented to the user.
 817      * Can be AV_NOPTS_VALUE if it is not stored in the file.
 818      * pts MUST be larger or equal to dts as presentation cannot happen before
 819      * decompression, unless one wants to view hex dumps. Some formats misuse
 820      * the terms dts and pts/cts to mean something different. Such timestamps
 821      * must be converted to true pts/dts before they are stored in AVPacket.
 822      */
 823     int64_t pts;
 824     /**
 825      * Decompression timestamp in AVStream->time_base units; the time at which
 826      * the packet is decompressed.
 827      * Can be AV_NOPTS_VALUE if it is not stored in the file.
 828      */
 829     int64_t dts;
 830     uint8_t *data;
 831     int   size;
 832     int   stream_index;
 833     /**
 834      * A combination of AV_PKT_FLAG values
 835      */
 836     int   flags;
 837     /**
 838      * Additional packet data that can be provided by the container.
 839      * Packet can contain several types of side information.
 840      */
 841     struct {
 842         uint8_t *data;
 843         int      size;
 844         enum AVPacketSideDataType type;
 845     } *side_data;
 846     int side_data_elems;
 847
 848     /**
 849      * Duration of this packet in AVStream->time_base units, 0 if unknown.
 850      * Equals next_pts - this_pts in presentation order.
 851      */
 852     int   duration;
 853     void  (*destruct)(struct AVPacket *);
 854     void  *priv;
 855     int64_t pos;                            ///< byte position in stream, -1 if unknown
 856
 857     /**
 858      * Time difference in AVStream->time_base units from the pts of this
 859      * packet to the point at which the output from the decoder has converged
 860      * independent from the availability of previous frames. That is, the
 861      * frames are virtually identical no matter if decoding started from
 862      * the very first frame or from this keyframe.
 863      * Is AV_NOPTS_VALUE if unknown.
 864      * This field is not the display duration of the current packet.
 865      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
 866      * set.
 867      *
 868      * The purpose of this field is to allow seeking in streams that have no
 869      * keyframes in the conventional sense. It corresponds to the
 870      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
 871      * essential for some types of subtitle streams to ensure that all
 872      * subtitles are correctly displayed after seeking.
 873      */
 874     int64_t convergence_duration;
 875 } AVPacket;
 876 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
 877 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
 878
 879 /**
 880  * Audio Video Frame.
 881  * New fields can be added to the end of AVFRAME with minor version
 882  * bumps. Removal, reordering and changes to existing fields require
 883  * a major version bump.
 884  * sizeof(AVFrame) must not be used outside libav*.
 885  */
 886 typedef struct AVFrame {
 887     /**
 888      * pointer to the picture planes.
 889      * This might be different from the first allocated byte
 890      * - encoding:
 891      * - decoding:
 892      */
 893     uint8_t *data[4];
 894     int linesize[4];
 895     /**
 896      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
 897      * This isn't used by libavcodec unless the default get/release_buffer() is used.
 898      * - encoding:
 899      * - decoding:
 900      */
 901     uint8_t *base[4];
 902     /**
 903      * 1 -> keyframe, 0-> not
 904      * - encoding: Set by libavcodec.
 905      * - decoding: Set by libavcodec.
 906      */
 907     int key_frame;
 908
 909     /**
 910      * Picture type of the frame, see ?_TYPE below.
 911      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
 912      * - decoding: Set by libavcodec.
 913      */
 914     enum AVPictureType pict_type;
 915
 916     /**
 917      * presentation timestamp in time_base units (time when frame should be shown to user)
 918      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
 919      * - encoding: MUST be set by user.
 920      * - decoding: Set by libavcodec.
 921      */
 922     int64_t pts;
 923
 924     /**
 925      * picture number in bitstream order
 926      * - encoding: set by
 927      * - decoding: Set by libavcodec.
 928      */
 929     int coded_picture_number;
 930     /**
 931      * picture number in display order
 932      * - encoding: set by
 933      * - decoding: Set by libavcodec.
 934      */
 935     int display_picture_number;
 936
 937     /**
 938      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
 939      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
 940      * - decoding: Set by libavcodec.
 941      */
 942     int quality;
 943
 944     /**
 945      * buffer age (1->was last buffer and dint change, 2->..., ...).
 946      * Set to INT_MAX if the buffer has not been used yet.
 947      * - encoding: unused
 948      * - decoding: MUST be set by get_buffer().
 949      */
 950     int age;
 951
 952     /**
 953      * is this picture used as reference
 954      * The values for this are the same as the MpegEncContext.picture_structure
 955      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
 956      * Set to 4 for delayed, non-reference frames.
 957      * - encoding: unused
 958      * - decoding: Set by libavcodec. (before get_buffer() call)).
 959      */
 960     int reference;
 961
 962     /**
 963      * QP table
 964      * - encoding: unused
 965      * - decoding: Set by libavcodec.
 966      */
 967     int8_t *qscale_table;
 968     /**
 969      * QP store stride
 970      * - encoding: unused
 971      * - decoding: Set by libavcodec.
 972      */
 973     int qstride;
 974
 975     /**
 976      * mbskip_table[mb]>=1 if MB didn't change
 977      * stride= mb_width = (width+15)>>4
 978      * - encoding: unused
 979      * - decoding: Set by libavcodec.
 980      */
 981     uint8_t *mbskip_table;
 982
 983     /**
 984      * motion vector table
 985      * @code
 986      * example:
 987      * int mv_sample_log2= 4 - motion_subsample_log2;
 988      * int mb_width= (width+15)>>4;
 989      * int mv_stride= (mb_width << mv_sample_log2) + 1;
 990      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
 991      * @endcode
 992      * - encoding: Set by user.
 993      * - decoding: Set by libavcodec.
 994      */
 995     int16_t (*motion_val[2])[2];
 996
 997     /**
 998      * macroblock type table
 999      * mb_type_base + mb_width + 2
1000      * - encoding: Set by user.
1001      * - decoding: Set by libavcodec.
1002      */
1003     uint32_t *mb_type;
1004
1005     /**
1006      * log2 of the size of the block which a single vector in motion_val represents:
1007      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
1008      * - encoding: unused
1009      * - decoding: Set by libavcodec.
1010      */
1011     uint8_t motion_subsample_log2;
1012
1013     /**
1014      * for some private data of the user
1015      * - encoding: unused
1016      * - decoding: Set by user.
1017      */
1018     void *opaque;
1019
1020     /**
1021      * error
1022      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1023      * - decoding: unused
1024      */
1025     uint64_t error[4];
1026
1027     /**
1028      * type of the buffer (to keep track of who has to deallocate data[*])
1029      * - encoding: Set by the one who allocates it.
1030      * - decoding: Set by the one who allocates it.
1031      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1032      */
1033     int type;
1034
1035     /**
1036      * When decoding, this signals how much the picture must be delayed.
1037      * extra_delay = repeat_pict / (2*fps)
1038      * - encoding: unused
1039      * - decoding: Set by libavcodec.
1040      */
1041     int repeat_pict;
1042
1043     /**
1044      *
1045      */
1046     int qscale_type;
1047
1048     /**
1049      * The content of the picture is interlaced.
1050      * - encoding: Set by user.
1051      * - decoding: Set by libavcodec. (default 0)
1052      */
1053     int interlaced_frame;
1054
1055     /**
1056      * If the content is interlaced, is top field displayed first.
1057      * - encoding: Set by user.
1058      * - decoding: Set by libavcodec.
1059      */
1060     int top_field_first;
1061
1062     /**
1063      * Pan scan.
1064      * - encoding: Set by user.
1065      * - decoding: Set by libavcodec.
1066      */
1067     AVPanScan *pan_scan;
1068
1069     /**
1070      * Tell user application that palette has changed from previous frame.
1071      * - encoding: ??? (no palette-enabled encoder yet)
1072      * - decoding: Set by libavcodec. (default 0).
1073      */
1074     int palette_has_changed;
1075
1076     /**
1077      * codec suggestion on buffer type if != 0
1078      * - encoding: unused
1079      * - decoding: Set by libavcodec. (before get_buffer() call)).
1080      */
1081     int buffer_hints;
1082
1083     /**
1084      * DCT coefficients
1085      * - encoding: unused
1086      * - decoding: Set by libavcodec.
1087      */
1088     short *dct_coeff;
1089
1090     /**
1091      * motion reference frame index
1092      * the order in which these are stored can depend on the codec.
1093      * - encoding: Set by user.
1094      * - decoding: Set by libavcodec.
1095      */
1096     int8_t *ref_index[2];
1097
1098     /**
1099      * reordered opaque 64bit (generally an integer or a double precision float
1100      * PTS but can be anything).
1101      * The user sets AVCodecContext.reordered_opaque to represent the input at
1102      * that time,
1103      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1104      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1105      * @deprecated in favor of pkt_pts
1106      * - encoding: unused
1107      * - decoding: Read by user.
1108      */
1109     int64_t reordered_opaque;
1110
1111     /**
1112      * hardware accelerator private data (FFmpeg-allocated)
1113      * - encoding: unused
1114      * - decoding: Set by libavcodec
1115      */
1116     void *hwaccel_picture_private;
1117
1118     /**
1119      * reordered pts from the last AVPacket that has been input into the decoder
1120      * - encoding: unused
1121      * - decoding: Read by user.
1122      */
1123     int64_t pkt_pts;
1124
1125     /**
1126      * dts from the last AVPacket that has been input into the decoder
1127      * - encoding: unused
1128      * - decoding: Read by user.
1129      */
1130     int64_t pkt_dts;
1131
1132     /**
1133      * the AVCodecContext which ff_thread_get_buffer() was last called on
1134      * - encoding: Set by libavcodec.
1135      * - decoding: Set by libavcodec.
1136      */
1137     struct AVCodecContext *owner;
1138
1139     /**
1140      * used by multithreading to store frame-specific info
1141      * - encoding: Set by libavcodec.
1142      * - decoding: Set by libavcodec.
1143      */
1144     void *thread_opaque;
1145
1146     /**
1147      * frame timestamp estimated using various heuristics, in stream time base
1148      * - encoding: unused
1149      * - decoding: set by libavcodec, read by user.
1150      */
1151     int64_t best_effort_timestamp;
1152
1153     /**
1154      * reordered pos from the last AVPacket that has been input into the decoder
1155      * - encoding: unused
1156      * - decoding: Read by user.
1157      */
1158     int64_t pkt_pos;
1159
1160     /**
1161      * reordered sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1162      * - encoding: unused
1163      * - decoding: Read by user.
1164      */
1165     AVRational sample_aspect_ratio;
1166
1167     /**
1168      * width and height of the video frame
1169      * - encoding: unused
1170      * - decoding: Read by user.
1171      */
1172     int width, height;
1173
1174     /**
1175      * format of the frame, -1 if unknown or unset
1176      * It should be cast to the corresponding enum (enum PixelFormat
1177      * for video, enum AVSampleFormat for audio)
1178      * - encoding: unused
1179      * - decoding: Read by user.
1180      */
1181     int format;
1182
1183 } AVFrame;
1184
1185 /**
1186  * main external API structure.
1187  * New fields can be added to the end with minor version bumps.
1188  * Removal, reordering and changes to existing fields require a major
1189  * version bump.
1190  * Please use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1191  * applications.
1192  * sizeof(AVCodecContext) must not be used outside libav*.
1193  */
1194 typedef struct AVCodecContext {
1195     /**
1196      * information on struct for av_log
1197      * - set by avcodec_alloc_context
1198      */
1199     const AVClass *av_class;
1200     /**
1201      * the average bitrate
1202      * - encoding: Set by user; unused for constant quantizer encoding.
1203      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1204      */
1205     int bit_rate;
1206
1207     /**
1208      * number of bits the bitstream is allowed to diverge from the reference.
1209      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1210      * - encoding: Set by user; unused for constant quantizer encoding.
1211      * - decoding: unused
1212      */
1213     int bit_rate_tolerance;
1214
1215     /**
1216      * CODEC_FLAG_*.
1217      * - encoding: Set by user.
1218      * - decoding: Set by user.
1219      */
1220     int flags;
1221
1222     /**
1223      * Some codecs need additional format info. It is stored here.
1224      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1225      * specific codec MUST set it correctly otherwise stream copy breaks.
1226      * In general use of this field by muxers is not recommanded.
1227      * - encoding: Set by libavcodec.
1228      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1229      */
1230     int sub_id;
1231
1232     /**
1233      * Motion estimation algorithm used for video coding.
1234      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1235      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1236      * - encoding: MUST be set by user.
1237      * - decoding: unused
1238      */
1239     int me_method;
1240
1241     /**
1242      * some codecs need / can use extradata like Huffman tables.
1243      * mjpeg: Huffman tables
1244      * rv10: additional flags
1245      * mpeg4: global headers (they can be in the bitstream or here)
1246      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1247      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1248      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1249      * - encoding: Set/allocated/freed by libavcodec.
1250      * - decoding: Set/allocated/freed by user.
1251      */
1252     uint8_t *extradata;
1253     int extradata_size;
1254
1255     /**
1256      * This is the fundamental unit of time (in seconds) in terms
1257      * of which frame timestamps are represented. For fixed-fps content,
1258      * timebase should be 1/framerate and timestamp increments should be
1259      * identically 1.
1260      * - encoding: MUST be set by user.
1261      * - decoding: Set by libavcodec.
1262      */
1263     AVRational time_base;
1264
1265     /* video only */
1266     /**
1267      * picture width / height.
1268      * - encoding: MUST be set by user.
1269      * - decoding: Set by libavcodec.
1270      * Note: For compatibility it is possible to set this instead of
1271      * coded_width/height before decoding.
1272      */
1273     int width, height;
1274
1275 #define FF_ASPECT_EXTENDED 15
1276
1277     /**
1278      * the number of pictures in a group of pictures, or 0 for intra_only
1279      * - encoding: Set by user.
1280      * - decoding: unused
1281      */
1282     int gop_size;
1283
1284     /**
1285      * Pixel format, see PIX_FMT_xxx.
1286      * May be set by the demuxer if known from headers.
1287      * May be overriden by the decoder if it knows better.
1288      * - encoding: Set by user.
1289      * - decoding: Set by user if known, overridden by libavcodec if known
1290      */
1291     enum PixelFormat pix_fmt;
1292
1293     /**
1294      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1295      * decoder to draw a horizontal band. It improves cache usage. Not
1296      * all codecs can do that. You must check the codec capabilities
1297      * beforehand.
1298      * When multithreading is used, it may be called from multiple threads
1299      * at the same time; threads might draw different parts of the same AVFrame,
1300      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1301      * in order.
1302      * The function is also used by hardware acceleration APIs.
1303      * It is called at least once during frame decoding to pass
1304      * the data needed for hardware render.
1305      * In that mode instead of pixel data, AVFrame points to
1306      * a structure specific to the acceleration API. The application
1307      * reads the structure and can change some fields to indicate progress
1308      * or mark state.
1309      * - encoding: unused
1310      * - decoding: Set by user.
1311      * @param height the height of the slice
1312      * @param y the y position of the slice
1313      * @param type 1->top field, 2->bottom field, 3->frame
1314      * @param offset offset into the AVFrame.data from which the slice should be read
1315      */
1316     void (*draw_horiz_band)(struct AVCodecContext *s,
1317                             const AVFrame *src, int offset[4],
1318                             int y, int type, int height);
1319
1320     /* audio only */
1321     int sample_rate; ///< samples per second
1322     int channels;    ///< number of audio channels
1323
1324     /**
1325      * audio sample format
1326      * - encoding: Set by user.
1327      * - decoding: Set by libavcodec.
1328      */
1329     enum AVSampleFormat sample_fmt;  ///< sample format
1330
1331     /* The following data should not be initialized. */
1332     /**
1333      * Samples per packet, initialized when calling 'init'.
1334      */
1335     int frame_size;
1336     int frame_number;   ///< audio or video frame number
1337
1338     /**
1339      * Number of frames the decoded output will be delayed relative to
1340      * the encoded input.
1341      * - encoding: Set by libavcodec.
1342      * - decoding: unused
1343      */
1344     int delay;
1345
1346     /* - encoding parameters */
1347     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1348     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1349
1350     /**
1351      * minimum quantizer
1352      * - encoding: Set by user.
1353      * - decoding: unused
1354      */
1355     int qmin;
1356
1357     /**
1358      * maximum quantizer
1359      * - encoding: Set by user.
1360      * - decoding: unused
1361      */
1362     int qmax;
1363
1364     /**
1365      * maximum quantizer difference between frames
1366      * - encoding: Set by user.
1367      * - decoding: unused
1368      */
1369     int max_qdiff;
1370
1371     /**
1372      * maximum number of B-frames between non-B-frames
1373      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1374      * - encoding: Set by user.
1375      * - decoding: unused
1376      */
1377     int max_b_frames;
1378
1379     /**
1380      * qscale factor between IP and B-frames
1381      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1382      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1383      * - encoding: Set by user.
1384      * - decoding: unused
1385      */
1386     float b_quant_factor;
1387
1388     /** obsolete FIXME remove */
1389     int rc_strategy;
1390 #define FF_RC_STRATEGY_XVID 1
1391
1392     int b_frame_strategy;
1393
1394     struct AVCodec *codec;
1395
1396     void *priv_data;
1397
1398     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1399                             /* do its best to deliver a chunk with size     */
1400                             /* below rtp_payload_size, the chunk will start */
1401                             /* with a start code on some codecs like H.263. */
1402                             /* This doesn't take account of any particular  */
1403                             /* headers inside the transmitted RTP payload.  */
1404
1405
1406     /* The RTP callback: This function is called    */
1407     /* every time the encoder has a packet to send. */
1408     /* It depends on the encoder if the data starts */
1409     /* with a Start Code (it should). H.263 does.   */
1410     /* mb_nb contains the number of macroblocks     */
1411     /* encoded in the RTP payload.                  */
1412     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1413
1414     /* statistics, used for 2-pass encoding */
1415     int mv_bits;
1416     int header_bits;
1417     int i_tex_bits;
1418     int p_tex_bits;
1419     int i_count;
1420     int p_count;
1421     int skip_count;
1422     int misc_bits;
1423
1424     /**
1425      * number of bits used for the previously encoded frame
1426      * - encoding: Set by libavcodec.
1427      * - decoding: unused
1428      */
1429     int frame_bits;
1430
1431     /**
1432      * Private data of the user, can be used to carry app specific stuff.
1433      * - encoding: Set by user.
1434      * - decoding: Set by user.
1435      */
1436     void *opaque;
1437
1438     char codec_name[32];
1439     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1440     enum CodecID codec_id; /* see CODEC_ID_xxx */
1441
1442     /**
1443      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1444      * This is used to work around some encoder bugs.
1445      * A demuxer should set this to what is stored in the field used to identify the codec.
1446      * If there are multiple such fields in a container then the demuxer should choose the one
1447      * which maximizes the information about the used codec.
1448      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1449      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1450      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1451      * first.
1452      * - encoding: Set by user, if not then the default based on codec_id will be used.
1453      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1454      */
1455     unsigned int codec_tag;
1456
1457     /**
1458      * Work around bugs in encoders which sometimes cannot be detected automatically.
1459      * - encoding: Set by user
1460      * - decoding: Set by user
1461      */
1462     int workaround_bugs;
1463 #define FF_BUG_AUTODETECT       1  ///< autodetection
1464 #define FF_BUG_OLD_MSMPEG4      2
1465 #define FF_BUG_XVID_ILACE       4
1466 #define FF_BUG_UMP4             8
1467 #define FF_BUG_NO_PADDING       16
1468 #define FF_BUG_AMV              32
1469 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1470 #define FF_BUG_QPEL_CHROMA      64
1471 #define FF_BUG_STD_QPEL         128
1472 #define FF_BUG_QPEL_CHROMA2     256
1473 #define FF_BUG_DIRECT_BLOCKSIZE 512
1474 #define FF_BUG_EDGE             1024
1475 #define FF_BUG_HPEL_CHROMA      2048
1476 #define FF_BUG_DC_CLIP          4096
1477 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1478 #define FF_BUG_TRUNCATED       16384
1479 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1480
1481     /**
1482      * luma single coefficient elimination threshold
1483      * - encoding: Set by user.
1484      * - decoding: unused
1485      */
1486     int luma_elim_threshold;
1487
1488     /**
1489      * chroma single coeff elimination threshold
1490      * - encoding: Set by user.
1491      * - decoding: unused
1492      */
1493     int chroma_elim_threshold;
1494
1495     /**
1496      * strictly follow the standard (MPEG4, ...).
1497      * - encoding: Set by user.
1498      * - decoding: Set by user.
1499      * Setting this to STRICT or higher means the encoder and decoder will
1500      * generally do stupid things, whereas setting it to unofficial or lower
1501      * will mean the encoder might produce output that is not supported by all
1502      * spec-compliant decoders. Decoders don't differentiate between normal,
1503      * unofficial and experimental (that is, they always try to decode things
1504      * when they can) unless they are explicitly asked to behave stupidly
1505      * (=strictly conform to the specs)
1506      */
1507     int strict_std_compliance;
1508 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1509 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1510 #define FF_COMPLIANCE_NORMAL        0
1511 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1512 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1513
1514     /**
1515      * qscale offset between IP and B-frames
1516      * - encoding: Set by user.
1517      * - decoding: unused
1518      */
1519     float b_quant_offset;
1520
1521 #if FF_API_ER
1522     /**
1523      * Error recognition; higher values will detect more errors but may
1524      * misdetect some more or less valid parts as errors.
1525      * - encoding: unused
1526      * - decoding: Set by user.
1527      */
1528     attribute_deprecated int error_recognition;
1529 #define FF_ER_CAREFUL         1
1530 #define FF_ER_COMPLIANT       2
1531 #define FF_ER_AGGRESSIVE      3
1532 #define FF_ER_VERY_AGGRESSIVE 4
1533 #define FF_ER_EXPLODE         5
1534 #endif /* FF_API_ER */
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      * Error recognition; may misdetect some more or less valid parts as errors.
2963      * - encoding: unused
2964      * - decoding: Set by user.
2965      */
2966 #if FF_API_ER
2967     int error_recognition2;
2968 #else
2969     int error_recognition;
2970 #endif /* FF_API_ER */
2971 #define AV_ER_CRCCHECK   (1<<0)
2972 #define AV_ER_BITSTREAM  (1<<1)
2973 #define AV_ER_AGGRESSIVE (1<<2)
2974 #define AV_ER_EXPLODE    (1<<3)
2975
2976     /**
2977      * Current statistics for PTS correction.
2978      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2979      * - encoding: unused
2980      */
2981     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2982     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2983     int64_t pts_correction_last_pts;       /// PTS of the last frame
2984     int64_t pts_correction_last_dts;       /// DTS of the last frame
2985
2986
2987 } AVCodecContext;
2988
2989 /**
2990  * AVProfile.
2991  */
2992 typedef struct AVProfile {
2993     int profile;
2994     const char *name; ///< short name for the profile
2995 } AVProfile;
2996
2997 typedef struct AVCodecDefault AVCodecDefault;
2998
2999 /**
3000  * AVCodec.
3001  */
3002 typedef struct AVCodec {
3003     /**
3004      * Name of the codec implementation.
3005      * The name is globally unique among encoders and among decoders (but an
3006      * encoder and a decoder can share the same name).
3007      * This is the primary way to find a codec from the user perspective.
3008      */
3009     const char *name;
3010     enum AVMediaType type;
3011     enum CodecID id;
3012     int priv_data_size;
3013     int (*init)(AVCodecContext *);
3014     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
3015     int (*close)(AVCodecContext *);
3016     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3017     /**
3018      * Codec capabilities.
3019      * see CODEC_CAP_*
3020      */
3021     int capabilities;
3022     struct AVCodec *next;
3023     /**
3024      * Flush buffers.
3025      * Will be called when seeking
3026      */
3027     void (*flush)(AVCodecContext *);
3028     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3029     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3030     /**
3031      * Descriptive name for the codec, meant to be more human readable than name.
3032      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3033      */
3034     const char *long_name;
3035     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3036     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3037     const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3038     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3039     const AVClass *priv_class;              ///< AVClass for the private context
3040     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3041
3042     /**
3043      * @name Frame-level threading support functions
3044      * @{
3045      */
3046     /**
3047      * If defined, called on thread contexts when they are created.
3048      * If the codec allocates writable tables in init(), re-allocate them here.
3049      * priv_data will be set to a copy of the original.
3050      */
3051     int (*init_thread_copy)(AVCodecContext *);
3052     /**
3053      * Copy necessary context variables from a previous thread context to the current one.
3054      * If not defined, the next thread will start automatically; otherwise, the codec
3055      * must call ff_thread_finish_setup().
3056      *
3057      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3058      */
3059     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3060     /** @} */
3061
3062     /**
3063      * Private codec-specific defaults.
3064      */
3065     const AVCodecDefault *defaults;
3066
3067     /**
3068      * Initialize codec static data, called from avcodec_register().
3069      */
3070     void (*init_static_data)(struct AVCodec *codec);
3071 } AVCodec;
3072
3073 /**
3074  * AVHWAccel.
3075  */
3076 typedef struct AVHWAccel {
3077     /**
3078      * Name of the hardware accelerated codec.
3079      * The name is globally unique among encoders and among decoders (but an
3080      * encoder and a decoder can share the same name).
3081      */
3082     const char *name;
3083
3084     /**
3085      * Type of codec implemented by the hardware accelerator.
3086      *
3087      * See AVMEDIA_TYPE_xxx
3088      */
3089     enum AVMediaType type;
3090
3091     /**
3092      * Codec implemented by the hardware accelerator.
3093      *
3094      * See CODEC_ID_xxx
3095      */
3096     enum CodecID id;
3097
3098     /**
3099      * Supported pixel format.
3100      *
3101      * Only hardware accelerated formats are supported here.
3102      */
3103     enum PixelFormat pix_fmt;
3104
3105     /**
3106      * Hardware accelerated codec capabilities.
3107      * see FF_HWACCEL_CODEC_CAP_*
3108      */
3109     int capabilities;
3110
3111     struct AVHWAccel *next;
3112
3113     /**
3114      * Called at the beginning of each frame or field picture.
3115      *
3116      * Meaningful frame information (codec specific) is guaranteed to
3117      * be parsed at this point. This function is mandatory.
3118      *
3119      * Note that buf can be NULL along with buf_size set to 0.
3120      * Otherwise, this means the whole frame is available at this point.
3121      *
3122      * @param avctx the codec context
3123      * @param buf the frame data buffer base
3124      * @param buf_size the size of the frame in bytes
3125      * @return zero if successful, a negative value otherwise
3126      */
3127     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3128
3129     /**
3130      * Callback for each slice.
3131      *
3132      * Meaningful slice information (codec specific) is guaranteed to
3133      * be parsed at this point. This function is mandatory.
3134      *
3135      * @param avctx the codec context
3136      * @param buf the slice data buffer base
3137      * @param buf_size the size of the slice in bytes
3138      * @return zero if successful, a negative value otherwise
3139      */
3140     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3141
3142     /**
3143      * Called at the end of each frame or field picture.
3144      *
3145      * The whole picture is parsed at this point and can now be sent
3146      * to the hardware accelerator. This function is mandatory.
3147      *
3148      * @param avctx the codec context
3149      * @return zero if successful, a negative value otherwise
3150      */
3151     int (*end_frame)(AVCodecContext *avctx);
3152
3153     /**
3154      * Size of HW accelerator private data.
3155      *
3156      * Private data is allocated with av_mallocz() before
3157      * AVCodecContext.get_buffer() and deallocated after
3158      * AVCodecContext.release_buffer().
3159      */
3160     int priv_data_size;
3161 } AVHWAccel;
3162
3163 /**
3164  * four components are given, that's all.
3165  * the last component is alpha
3166  */
3167 typedef struct AVPicture {
3168     uint8_t *data[4];
3169     int linesize[4];       ///< number of bytes per line
3170 } AVPicture;
3171
3172 #define AVPALETTE_SIZE 1024
3173 #define AVPALETTE_COUNT 256
3174 #if FF_API_PALETTE_CONTROL
3175 /**
3176  * AVPaletteControl
3177  * This structure defines a method for communicating palette changes
3178  * between and demuxer and a decoder.
3179  *
3180  * @deprecated Use AVPacket to send palette changes instead.
3181  * This is totally broken.
3182  */
3183 typedef struct AVPaletteControl {
3184
3185     /* Demuxer sets this to 1 to indicate the palette has changed;
3186      * decoder resets to 0. */
3187     int palette_changed;
3188
3189     /* 4-byte ARGB palette entries, stored in native byte order; note that
3190      * the individual palette components should be on a 8-bit scale; if
3191      * the palette data comes from an IBM VGA native format, the component
3192      * data is probably 6 bits in size and needs to be scaled. */
3193     unsigned int palette[AVPALETTE_COUNT];
3194
3195 } AVPaletteControl attribute_deprecated;
3196 #endif
3197
3198 enum AVSubtitleType {
3199     SUBTITLE_NONE,
3200
3201     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3202
3203     /**
3204      * Plain text, the text field must be set by the decoder and is
3205      * authoritative. ass and pict fields may contain approximations.
3206      */
3207     SUBTITLE_TEXT,
3208
3209     /**
3210      * Formatted text, the ass field must be set by the decoder and is
3211      * authoritative. pict and text fields may contain approximations.
3212      */
3213     SUBTITLE_ASS,
3214 };
3215
3216 typedef struct AVSubtitleRect {
3217     int x;         ///< top left corner  of pict, undefined when pict is not set
3218     int y;         ///< top left corner  of pict, undefined when pict is not set
3219     int w;         ///< width            of pict, undefined when pict is not set
3220     int h;         ///< height           of pict, undefined when pict is not set
3221     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3222
3223     /**
3224      * data+linesize for the bitmap of this subtitle.
3225      * can be set for text/ass as well once they where rendered
3226      */
3227     AVPicture pict;
3228     enum AVSubtitleType type;
3229
3230     char *text;                     ///< 0 terminated plain UTF-8 text
3231
3232     /**
3233      * 0 terminated ASS/SSA compatible event line.
3234      * The pressentation of this is unaffected by the other values in this
3235      * struct.
3236      */
3237     char *ass;
3238 } AVSubtitleRect;
3239
3240 typedef struct AVSubtitle {
3241     uint16_t format; /* 0 = graphics */
3242     uint32_t start_display_time; /* relative to packet pts, in ms */
3243     uint32_t end_display_time; /* relative to packet pts, in ms */
3244     unsigned num_rects;
3245     AVSubtitleRect **rects;
3246     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3247 } AVSubtitle;
3248
3249 /* packet functions */
3250
3251 /**
3252  * @deprecated use NULL instead
3253  */
3254 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3255
3256 /**
3257  * Default packet destructor.
3258  */
3259 void av_destruct_packet(AVPacket *pkt);
3260
3261 /**
3262  * Initialize optional fields of a packet with default values.
3263  *
3264  * @param pkt packet
3265  */
3266 void av_init_packet(AVPacket *pkt);
3267
3268 /**
3269  * Allocate the payload of a packet and initialize its fields with
3270  * default values.
3271  *
3272  * @param pkt packet
3273  * @param size wanted payload size
3274  * @return 0 if OK, AVERROR_xxx otherwise
3275  */
3276 int av_new_packet(AVPacket *pkt, int size);
3277
3278 /**
3279  * Reduce packet size, correctly zeroing padding
3280  *
3281  * @param pkt packet
3282  * @param size new size
3283  */
3284 void av_shrink_packet(AVPacket *pkt, int size);
3285
3286 /**
3287  * Increase packet size, correctly zeroing padding
3288  *
3289  * @param pkt packet
3290  * @param grow_by number of bytes by which to increase the size of the packet
3291  */
3292 int av_grow_packet(AVPacket *pkt, int grow_by);
3293
3294 /**
3295  * @warning This is a hack - the packet memory allocation stuff is broken. The
3296  * packet is allocated if it was not really allocated.
3297  */
3298 int av_dup_packet(AVPacket *pkt);
3299
3300 /**
3301  * Free a packet.
3302  *
3303  * @param pkt packet to free
3304  */
3305 void av_free_packet(AVPacket *pkt);
3306
3307 /**
3308  * Allocate new information of a packet.
3309  *
3310  * @param pkt packet
3311  * @param type side information type
3312  * @param size side information size
3313  * @return pointer to fresh allocated data or NULL otherwise
3314  */
3315 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3316                                  int size);
3317
3318 /**
3319  * Get side information from packet.
3320  *
3321  * @param pkt packet
3322  * @param type desired side information type
3323  * @param size pointer for side information size to store (optional)
3324  * @return pointer to data if present or NULL otherwise
3325  */
3326 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3327                                  int *size);
3328
3329 int av_packet_merge_side_data(AVPacket *pkt);
3330
3331 int av_packet_split_side_data(AVPacket *pkt);
3332
3333
3334 /* resample.c */
3335
3336 struct ReSampleContext;
3337 struct AVResampleContext;
3338
3339 typedef struct ReSampleContext ReSampleContext;
3340
3341 /**
3342  *  Initialize audio resampling context.
3343  *
3344  * @param output_channels  number of output channels
3345  * @param input_channels   number of input channels
3346  * @param output_rate      output sample rate
3347  * @param input_rate       input sample rate
3348  * @param sample_fmt_out   requested output sample format
3349  * @param sample_fmt_in    input sample format
3350  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3351  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3352  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3353                            between the 2 closest, if 0 the closest will be used
3354  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3355  * @return allocated ReSampleContext, NULL if error occured
3356  */
3357 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3358                                         int output_rate, int input_rate,
3359                                         enum AVSampleFormat sample_fmt_out,
3360                                         enum AVSampleFormat sample_fmt_in,
3361                                         int filter_length, int log2_phase_count,
3362                                         int linear, double cutoff);
3363
3364 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3365
3366 /**
3367  * Free resample context.
3368  *
3369  * @param s a non-NULL pointer to a resample context previously
3370  *          created with av_audio_resample_init()
3371  */
3372 void audio_resample_close(ReSampleContext *s);
3373
3374
3375 /**
3376  * Initialize an audio resampler.
3377  * Note, if either rate is not an integer then simply scale both rates up so they are.
3378  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3379  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3380  * @param linear If 1 then the used FIR filter will be linearly interpolated
3381                  between the 2 closest, if 0 the closest will be used
3382  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3383  */
3384 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3385
3386 /**
3387  * Resample an array of samples using a previously configured context.
3388  * @param src an array of unconsumed samples
3389  * @param consumed the number of samples of src which have been consumed are returned here
3390  * @param src_size the number of unconsumed samples available
3391  * @param dst_size the amount of space in samples available in dst
3392  * @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.
3393  * @return the number of samples written in dst or -1 if an error occurred
3394  */
3395 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3396
3397
3398 /**
3399  * Compensate samplerate/timestamp drift. The compensation is done by changing
3400  * the resampler parameters, so no audible clicks or similar distortions occur
3401  * @param compensation_distance distance in output samples over which the compensation should be performed
3402  * @param sample_delta number of output samples which should be output less
3403  *
3404  * example: av_resample_compensate(c, 10, 500)
3405  * here instead of 510 samples only 500 samples would be output
3406  *
3407  * note, due to rounding the actual compensation might be slightly different,
3408  * especially if the compensation_distance is large and the in_rate used during init is small
3409  */
3410 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3411 void av_resample_close(struct AVResampleContext *c);
3412
3413 /**
3414  * Allocate memory for a picture.  Call avpicture_free() to free it.
3415  *
3416  * @see avpicture_fill()
3417  *
3418  * @param picture the picture to be filled in
3419  * @param pix_fmt the format of the picture
3420  * @param width the width of the picture
3421  * @param height the height of the picture
3422  * @return zero if successful, a negative value if not
3423  */
3424 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3425
3426 /**
3427  * Free a picture previously allocated by avpicture_alloc().
3428  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3429  * itself is not.
3430  *
3431  * @param picture the AVPicture to be freed
3432  */
3433 void avpicture_free(AVPicture *picture);
3434
3435 /**
3436  * Fill in the AVPicture fields.
3437  * The fields of the given AVPicture are filled in by using the 'ptr' address
3438  * which points to the image data buffer. Depending on the specified picture
3439  * format, one or multiple image data pointers and line sizes will be set.
3440  * If a planar format is specified, several pointers will be set pointing to
3441  * the different picture planes and the line sizes of the different planes
3442  * will be stored in the lines_sizes array.
3443  * Call with ptr == NULL to get the required size for the ptr buffer.
3444  *
3445  * To allocate the buffer and fill in the AVPicture fields in one call,
3446  * use avpicture_alloc().
3447  *
3448  * @param picture AVPicture whose fields are to be filled in
3449  * @param ptr Buffer which will contain or contains the actual image data
3450  * @param pix_fmt The format in which the picture data is stored.
3451  * @param width the width of the image in pixels
3452  * @param height the height of the image in pixels
3453  * @return size of the image data in bytes
3454  */
3455 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3456                    enum PixelFormat pix_fmt, int width, int height);
3457
3458 /**
3459  * Copy pixel data from an AVPicture into a buffer.
3460  * The data is stored compactly, without any gaps for alignment or padding
3461  * which may be applied by avpicture_fill().
3462  *
3463  * @see avpicture_get_size()
3464  *
3465  * @param[in] src AVPicture containing image data
3466  * @param[in] pix_fmt The format in which the picture data is stored.
3467  * @param[in] width the width of the image in pixels.
3468  * @param[in] height the height of the image in pixels.
3469  * @param[out] dest A buffer into which picture data will be copied.
3470  * @param[in] dest_size The size of 'dest'.
3471  * @return The number of bytes written to dest, or a negative value (error code) on error.
3472  */
3473 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3474                      unsigned char *dest, int dest_size);
3475
3476 /**
3477  * Calculate the size in bytes that a picture of the given width and height
3478  * would occupy if stored in the given picture format.
3479  * Note that this returns the size of a compact representation as generated
3480  * by avpicture_layout(), which can be smaller than the size required for e.g.
3481  * avpicture_fill().
3482  *
3483  * @param pix_fmt the given picture format
3484  * @param width the width of the image
3485  * @param height the height of the image
3486  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3487  */
3488 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3489 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3490
3491 /**
3492  * Get the name of a codec.
3493  * @return  a static string identifying the codec; never NULL
3494  */
3495 const char *avcodec_get_name(enum CodecID id);
3496
3497 #if FF_API_GET_PIX_FMT_NAME
3498 /**
3499  * Return the short name for a pixel format.
3500  *
3501  * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3502  * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3503  */
3504 attribute_deprecated
3505 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3506 #endif
3507
3508 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3509
3510 /**
3511  * Return a value representing the fourCC code associated to the
3512  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3513  * found.
3514  */
3515 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3516
3517 /**
3518  * Put a string representing the codec tag codec_tag in buf.
3519  *
3520  * @param buf_size size in bytes of buf
3521  * @return the length of the string that would have been generated if
3522  * enough space had been available, excluding the trailing null
3523  */
3524 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3525
3526 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3527 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3528 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3529 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3530 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3531 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3532
3533 /**
3534  * Compute what kind of losses will occur when converting from one specific
3535  * pixel format to another.
3536  * When converting from one pixel format to another, information loss may occur.
3537  * For example, when converting from RGB24 to GRAY, the color information will
3538  * be lost. Similarly, other losses occur when converting from some formats to
3539  * other formats. These losses can involve loss of chroma, but also loss of
3540  * resolution, loss of color depth, loss due to the color space conversion, loss
3541  * of the alpha bits or loss due to color quantization.
3542  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3543  * which will occur when converting from one pixel format to another.
3544  *
3545  * @param[in] dst_pix_fmt destination pixel format
3546  * @param[in] src_pix_fmt source pixel format
3547  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3548  * @return Combination of flags informing you what kind of losses will occur
3549  * (maximum loss for an invalid dst_pix_fmt).
3550  */
3551 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3552                              int has_alpha);
3553
3554 /**
3555  * Find the best pixel format to convert to given a certain source pixel
3556  * format.  When converting from one pixel format to another, information loss
3557  * may occur.  For example, when converting from RGB24 to GRAY, the color
3558  * information will be lost. Similarly, other losses occur when converting from
3559  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3560  * the given pixel formats should be used to suffer the least amount of loss.
3561  * The pixel formats from which it chooses one, are determined by the
3562  * pix_fmt_mask parameter.
3563  *
3564  * Note, only the first 64 pixel formats will fit in pix_fmt_mask.
3565  *
3566  * @code
3567  * src_pix_fmt = PIX_FMT_YUV420P;
3568  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) | (1 << PIX_FMT_RGB24);
3569  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3570  * @endcode
3571  *
3572  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3573  * @param[in] src_pix_fmt source pixel format
3574  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3575  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3576  * @return The best pixel format to convert to or -1 if none was found.
3577  */
3578 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3579                               int has_alpha, int *loss_ptr);
3580
3581 /**
3582  * Find the best pixel format to convert to given a certain source pixel
3583  * format and a selection of two destination pixel formats. When converting from
3584  * one pixel format to another, information loss may occur.  For example, when converting
3585  * from RGB24 to GRAY, the color information will be lost. Similarly, other losses occur when
3586  * converting from some formats to other formats. avcodec_find_best_pix_fmt2() selects which of
3587  * the given pixel formats should be used to suffer the least amount of loss.
3588  *
3589  * If one of the destination formats is PIX_FMT_NONE the other pixel format (if valid) will be
3590  * returned.
3591  *
3592  * @code
3593  * src_pix_fmt = PIX_FMT_YUV420P;
3594  * dst_pix_fmt1= PIX_FMT_RGB24;
3595  * dst_pix_fmt2= PIX_FMT_GRAY8;
3596  * dst_pix_fmt3= PIX_FMT_RGB8;
3597  * loss= FF_LOSS_CHROMA; // don't care about chroma loss, so chroma loss will be ignored.
3598  * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt1, dst_pix_fmt2, src_pix_fmt, alpha, &loss);
3599  * dst_pix_fmt = avcodec_find_best_pix_fmt2(dst_pix_fmt, dst_pix_fmt3, src_pix_fmt, alpha, &loss);
3600  * @endcode
3601  *
3602  * @param[in] dst_pix_fmt1 One of the two destination pixel formats to choose from
3603  * @param[in] dst_pix_fmt2 The other of the two destination pixel formats to choose from
3604  * @param[in] src_pix_fmt Source pixel format
3605  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3606  * @param[in, out] loss_ptr Combination of loss flags. In: selects which of the losses to ignore, i.e.
3607  *                               NULL or value of zero means we care about all losses. Out: the loss
3608  *                               that occurs when converting from src to selected dst pixel format.
3609  * @return The best pixel format to convert to or -1 if none was found.
3610  */
3611 enum PixelFormat avcodec_find_best_pix_fmt2(enum PixelFormat dst_pix_fmt1, enum PixelFormat dst_pix_fmt2,
3612                                             enum PixelFormat src_pix_fmt, int has_alpha, int *loss_ptr);
3613
3614 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3615 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3616
3617 /**
3618  * Tell if an image really has transparent alpha values.
3619  * @return ored mask of FF_ALPHA_xxx constants
3620  */
3621 int img_get_alpha_info(const AVPicture *src,
3622                        enum PixelFormat pix_fmt, int width, int height);
3623
3624 /* deinterlace a picture */
3625 /* deinterlace - if not supported return -1 */
3626 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3627                           enum PixelFormat pix_fmt, int width, int height);
3628
3629 /* external high level API */
3630
3631 /**
3632  * If c is NULL, returns the first registered codec,
3633  * if c is non-NULL, returns the next registered codec after c,
3634  * or NULL if c is the last one.
3635  */
3636 AVCodec *av_codec_next(AVCodec *c);
3637
3638 /**
3639  * Return the LIBAVCODEC_VERSION_INT constant.
3640  */
3641 unsigned avcodec_version(void);
3642
3643 /**
3644  * Return the libavcodec build-time configuration.
3645  */
3646 const char *avcodec_configuration(void);
3647
3648 /**
3649  * Return the libavcodec license.
3650  */
3651 const char *avcodec_license(void);
3652
3653 #if FF_API_AVCODEC_INIT
3654 /**
3655  * @deprecated this function is called automatically from avcodec_register()
3656  * and avcodec_register_all(), there is no need to call it manually
3657  */
3658 attribute_deprecated
3659 void avcodec_init(void);
3660 #endif
3661
3662 /**
3663  * Register the codec codec and initialize libavcodec.
3664  *
3665  * @warning either this function or avcodec_register_all() must be called
3666  * before any other libavcodec functions.
3667  *
3668  * @see avcodec_register_all()
3669  */
3670 void avcodec_register(AVCodec *codec);
3671
3672 /**
3673  * Find a registered encoder with a matching codec ID.
3674  *
3675  * @param id CodecID of the requested encoder
3676  * @return An encoder if one was found, NULL otherwise.
3677  */
3678 AVCodec *avcodec_find_encoder(enum CodecID id);
3679
3680 /**
3681  * Find a registered encoder with the specified name.
3682  *
3683  * @param name name of the requested encoder
3684  * @return An encoder if one was found, NULL otherwise.
3685  */
3686 AVCodec *avcodec_find_encoder_by_name(const char *name);
3687
3688 /**
3689  * Find a registered decoder with a matching codec ID.
3690  *
3691  * @param id CodecID of the requested decoder
3692  * @return A decoder if one was found, NULL otherwise.
3693  */
3694 AVCodec *avcodec_find_decoder(enum CodecID id);
3695
3696 /**
3697  * Find a registered decoder with the specified name.
3698  *
3699  * @param name name of the requested decoder
3700  * @return A decoder if one was found, NULL otherwise.
3701  */
3702 AVCodec *avcodec_find_decoder_by_name(const char *name);
3703 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3704
3705 /**
3706  * Return a name for the specified profile, if available.
3707  *
3708  * @param codec the codec that is searched for the given profile
3709  * @param profile the profile value for which a name is requested
3710  * @return A name for the profile if found, NULL otherwise.
3711  */
3712 const char *av_get_profile_name(const AVCodec *codec, int profile);
3713
3714 /**
3715  * Set the fields of the given AVCodecContext to default values.
3716  *
3717  * @param s The AVCodecContext of which the fields should be set to default values.
3718  */
3719 void avcodec_get_context_defaults(AVCodecContext *s);
3720
3721 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3722  *  we WILL change its arguments and name a few times! */
3723 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3724
3725 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3726  *  we WILL change its arguments and name a few times! */
3727 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3728
3729 #if FF_API_ALLOC_CONTEXT
3730 /**
3731  * Allocate an AVCodecContext and set its fields to default values.  The
3732  * resulting struct can be deallocated by simply calling av_free().
3733  *
3734  * @return An AVCodecContext filled with default values or NULL on failure.
3735  * @see avcodec_get_context_defaults
3736  *
3737  * @deprecated use avcodec_alloc_context3()
3738  */
3739 attribute_deprecated
3740 AVCodecContext *avcodec_alloc_context(void);
3741
3742 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3743  *  we WILL change its arguments and name a few times! */
3744 attribute_deprecated
3745 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3746 #endif
3747
3748 /**
3749  * Allocate an AVCodecContext and set its fields to default values.  The
3750  * resulting struct can be deallocated by simply calling av_free().
3751  *
3752  * @param codec if non-NULL, allocate private data and initialize defaults
3753  *              for the given codec. It is illegal to then call avcodec_open()
3754  *              with a different codec.
3755  *
3756  * @return An AVCodecContext filled with default values or NULL on failure.
3757  * @see avcodec_get_context_defaults
3758  *
3759  * @deprecated use avcodec_alloc_context3()
3760  */
3761 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3762
3763 /**
3764  * Copy the settings of the source AVCodecContext into the destination
3765  * AVCodecContext. The resulting destination codec context will be
3766  * unopened, i.e. you are required to call avcodec_open() before you
3767  * can use this AVCodecContext to decode/encode video/audio data.
3768  *
3769  * @param dest target codec context, should be initialized with
3770  *             avcodec_alloc_context3(), but otherwise uninitialized
3771  * @param src source codec context
3772  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3773  */
3774 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3775
3776 /**
3777  * Set the fields of the given AVFrame to default values.
3778  *
3779  * @param pic The AVFrame of which the fields should be set to default values.
3780  */
3781 void avcodec_get_frame_defaults(AVFrame *pic);
3782
3783 /**
3784  * Allocate an AVFrame and set its fields to default values.  The resulting
3785  * struct can be deallocated by simply calling av_free().
3786  *
3787  * @return An AVFrame filled with default values or NULL on failure.
3788  * @see avcodec_get_frame_defaults
3789  */
3790 AVFrame *avcodec_alloc_frame(void);
3791
3792 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3793 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3794 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3795
3796 /**
3797  * Return the amount of padding in pixels which the get_buffer callback must
3798  * provide around the edge of the image for codecs which do not have the
3799  * CODEC_FLAG_EMU_EDGE flag.
3800  *
3801  * @return Required padding in pixels.
3802  */
3803 unsigned avcodec_get_edge_width(void);
3804 /**
3805  * Modify width and height values so that they will result in a memory
3806  * buffer that is acceptable for the codec if you do not use any horizontal
3807  * padding.
3808  *
3809  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3810  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3811  * according to avcodec_get_edge_width() before.
3812  */
3813 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3814 /**
3815  * Modify width and height values so that they will result in a memory
3816  * buffer that is acceptable for the codec if you also ensure that all
3817  * line sizes are a multiple of the respective linesize_align[i].
3818  *
3819  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3820  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3821  * according to avcodec_get_edge_width() before.
3822  */
3823 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3824                                int linesize_align[4]);
3825
3826 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3827
3828 #if FF_API_THREAD_INIT
3829 /**
3830  * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3831  */
3832 attribute_deprecated
3833 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3834 #endif
3835
3836 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3837 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3838 //FIXME func typedef
3839
3840 #if FF_API_AVCODEC_OPEN
3841 /**
3842  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3843  * function the context has to be allocated.
3844  *
3845  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3846  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3847  * retrieving a codec.
3848  *
3849  * @warning This function is not thread safe!
3850  *
3851  * @code
3852  * avcodec_register_all();
3853  * codec = avcodec_find_decoder(CODEC_ID_H264);
3854  * if (!codec)
3855  *     exit(1);
3856  *
3857  * context = avcodec_alloc_context3(codec);
3858  *
3859  * if (avcodec_open(context, codec) < 0)
3860  *     exit(1);
3861  * @endcode
3862  *
3863  * @param avctx The context which will be set up to use the given codec.
3864  * @param codec The codec to use within the context.
3865  * @return zero on success, a negative value on error
3866  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3867  *
3868  * @deprecated use avcodec_open2
3869  */
3870 attribute_deprecated
3871 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3872 #endif
3873
3874 /**
3875  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3876  * function the context has to be allocated with avcodec_alloc_context().
3877  *
3878  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3879  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3880  * retrieving a codec.
3881  *
3882  * @warning This function is not thread safe!
3883  *
3884  * @code
3885  * avcodec_register_all();
3886  * av_dict_set(&opts, "b", "2.5M", 0);
3887  * codec = avcodec_find_decoder(CODEC_ID_H264);
3888  * if (!codec)
3889  *     exit(1);
3890  *
3891  * context = avcodec_alloc_context();
3892  *
3893  * if (avcodec_open(context, codec, opts) < 0)
3894  *     exit(1);
3895  * @endcode
3896  *
3897  * @param avctx The context to initialize.
3898  * @param options A dictionary filled with AVCodecContext and codec-private options.
3899  *                On return this object will be filled with options that were not found.
3900  *
3901  * @return zero on success, a negative value on error
3902  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3903  *      av_dict_set(), av_opt_find().
3904  */
3905 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3906
3907 /**
3908  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3909  * Some decoders may support multiple frames in a single AVPacket, such
3910  * decoders would then just decode the first frame. In this case,
3911  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3912  * the remaining data in order to decode the second frame etc.
3913  * If no frame
3914  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3915  * decompressed frame size in bytes.
3916  *
3917  * @warning You must set frame_size_ptr to the allocated size of the
3918  * output buffer before calling avcodec_decode_audio3().
3919  *
3920  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3921  * the actual read bytes because some optimized bitstream readers read 32 or 64
3922  * bits at once and could read over the end.
3923  *
3924  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3925  * no overreading happens for damaged MPEG streams.
3926  *
3927  * @note You might have to align the input buffer avpkt->data and output buffer
3928  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3929  * necessary at all, on others it won't work at all if not aligned and on others
3930  * it will work but it will have an impact on performance.
3931  *
3932  * In practice, avpkt->data should have 4 byte alignment at minimum and
3933  * samples should be 16 byte aligned unless the CPU doesn't need it
3934  * (AltiVec and SSE do).
3935  *
3936  * @param avctx the codec context
3937  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3938  * @param[in,out] frame_size_ptr the output buffer size in bytes
3939  * @param[in] avpkt The input AVPacket containing the input buffer.
3940  *            You can create such packet with av_init_packet() and by then setting
3941  *            data and size, some decoders might in addition need other fields.
3942  *            All decoders are designed to use the least fields possible though.
3943  * @return On error a negative value is returned, otherwise the number of bytes
3944  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3945  */
3946 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3947                          int *frame_size_ptr,
3948                          AVPacket *avpkt);
3949
3950 /**
3951  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3952  * Some decoders may support multiple frames in a single AVPacket, such
3953  * decoders would then just decode the first frame.
3954  *
3955  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3956  * the actual read bytes because some optimized bitstream readers read 32 or 64
3957  * bits at once and could read over the end.
3958  *
3959  * @warning The end of the input buffer buf should be set to 0 to ensure that
3960  * no overreading happens for damaged MPEG streams.
3961  *
3962  * @note You might have to align the input buffer avpkt->data.
3963  * The alignment requirements depend on the CPU: on some CPUs it isn't
3964  * necessary at all, on others it won't work at all if not aligned and on others
3965  * it will work but it will have an impact on performance.
3966  *
3967  * In practice, avpkt->data should have 4 byte alignment at minimum.
3968  *
3969  * @note Some codecs have a delay between input and output, these need to be
3970  * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3971  *
3972  * @param avctx the codec context
3973  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3974  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3975  *             allocate memory for the actual bitmap.
3976  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3977  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3978  *                   decodes and the decoder tells the user once it does not need the data anymore,
3979  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3980  *
3981  * @param[in] avpkt The input AVpacket containing the input buffer.
3982  *            You can create such packet with av_init_packet() and by then setting
3983  *            data and size, some decoders might in addition need other fields like
3984  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3985  *            fields possible.
3986  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3987  * @return On error a negative value is returned, otherwise the number of bytes
3988  * used or zero if no frame could be decompressed.
3989  */
3990 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3991                          int *got_picture_ptr,
3992                          AVPacket *avpkt);
3993
3994 /**
3995  * Decode a subtitle message.
3996  * Return a negative value on error, otherwise return the number of bytes used.
3997  * If no subtitle could be decompressed, got_sub_ptr is zero.
3998  * Otherwise, the subtitle is stored in *sub.
3999  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4000  * simplicity, because the performance difference is expect to be negligible
4001  * and reusing a get_buffer written for video codecs would probably perform badly
4002  * due to a potentially very different allocation pattern.
4003  *
4004  * @param avctx the codec context
4005  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4006                    freed with avsubtitle_free if *got_sub_ptr is set.
4007  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4008  * @param[in] avpkt The input AVPacket containing the input buffer.
4009  */
4010 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4011                             int *got_sub_ptr,
4012                             AVPacket *avpkt);
4013
4014 /**
4015  * Frees all allocated data in the given subtitle struct.
4016  *
4017  * @param sub AVSubtitle to free.
4018  */
4019 void avsubtitle_free(AVSubtitle *sub);
4020
4021 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
4022                         int *data_size_ptr,
4023                         uint8_t *buf, int buf_size);
4024
4025 /**
4026  * Encode an audio frame from samples into buf.
4027  *
4028  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
4029  * However, for PCM audio the user will know how much space is needed
4030  * because it depends on the value passed in buf_size as described
4031  * below. In that case a lower value can be used.
4032  *
4033  * @param avctx the codec context
4034  * @param[out] buf the output buffer
4035  * @param[in] buf_size the output buffer size
4036  * @param[in] samples the input buffer containing the samples
4037  * The number of samples read from this buffer is frame_size*channels,
4038  * both of which are defined in avctx.
4039  * For PCM audio the number of samples read from samples is equal to
4040  * buf_size * input_sample_size / output_sample_size.
4041  * @return On error a negative value is returned, on success zero or the number
4042  * of bytes used to encode the data read from the input buffer.
4043  */
4044 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4045                          const short *samples);
4046
4047 /**
4048  * Encode a video frame from pict into buf.
4049  * The input picture should be
4050  * stored using a specific format, namely avctx.pix_fmt.
4051  *
4052  * @param avctx the codec context
4053  * @param[out] buf the output buffer for the bitstream of encoded frame
4054  * @param[in] buf_size the size of the output buffer in bytes
4055  * @param[in] pict the input picture to encode
4056  * @return On error a negative value is returned, on success zero or the number
4057  * of bytes used from the output buffer.
4058  */
4059 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4060                          const AVFrame *pict);
4061 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4062                             const AVSubtitle *sub);
4063
4064 int avcodec_close(AVCodecContext *avctx);
4065
4066 /**
4067  * Register all the codecs, parsers and bitstream filters which were enabled at
4068  * configuration time. If you do not call this function you can select exactly
4069  * which formats you want to support, by using the individual registration
4070  * functions.
4071  *
4072  * @see avcodec_register
4073  * @see av_register_codec_parser
4074  * @see av_register_bitstream_filter
4075  */
4076 void avcodec_register_all(void);
4077
4078 /**
4079  * Flush buffers, should be called when seeking or when switching to a different stream.
4080  */
4081 void avcodec_flush_buffers(AVCodecContext *avctx);
4082
4083 void avcodec_default_free_buffers(AVCodecContext *s);
4084
4085 /* misc useful functions */
4086
4087 #if FF_API_OLD_FF_PICT_TYPES
4088 /**
4089  * Return a single letter to describe the given picture type pict_type.
4090  *
4091  * @param[in] pict_type the picture type
4092  * @return A single character representing the picture type.
4093  * @deprecated Use av_get_picture_type_char() instead.
4094  */
4095 attribute_deprecated
4096 char av_get_pict_type_char(int pict_type);
4097 #endif
4098
4099 /**
4100  * Return codec bits per sample.
4101  *
4102  * @param[in] codec_id the codec
4103  * @return Number of bits per sample or zero if unknown for the given codec.
4104  */
4105 int av_get_bits_per_sample(enum CodecID codec_id);
4106
4107 #if FF_API_OLD_SAMPLE_FMT
4108 /**
4109  * @deprecated Use av_get_bytes_per_sample() instead.
4110  */
4111 attribute_deprecated
4112 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4113 #endif
4114
4115 /* frame parsing */
4116 typedef struct AVCodecParserContext {
4117     void *priv_data;
4118     struct AVCodecParser *parser;
4119     int64_t frame_offset; /* offset of the current frame */
4120     int64_t cur_offset; /* current offset
4121                            (incremented by each av_parser_parse()) */
4122     int64_t next_frame_offset; /* offset of the next frame */
4123     /* video info */
4124     int pict_type; /* XXX: Put it back in AVCodecContext. */
4125     /**
4126      * This field is used for proper frame duration computation in lavf.
4127      * It signals, how much longer the frame duration of the current frame
4128      * is compared to normal frame duration.
4129      *
4130      * frame_duration = (1 + repeat_pict) * time_base
4131      *
4132      * It is used by codecs like H.264 to display telecined material.
4133      */
4134     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4135     int64_t pts;     /* pts of the current frame */
4136     int64_t dts;     /* dts of the current frame */
4137
4138     /* private data */
4139     int64_t last_pts;
4140     int64_t last_dts;
4141     int fetch_timestamp;
4142
4143 #define AV_PARSER_PTS_NB 4
4144     int cur_frame_start_index;
4145     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4146     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4147     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4148
4149     int flags;
4150 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4151 #define PARSER_FLAG_ONCE                      0x0002
4152 /// Set if the parser has a valid file offset
4153 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4154
4155     int64_t offset;      ///< byte offset from starting packet start
4156     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4157
4158     /**
4159      * Set by parser to 1 for key frames and 0 for non-key frames.
4160      * It is initialized to -1, so if the parser doesn't set this flag,
4161      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4162      * will be used.
4163      */
4164     int key_frame;
4165
4166     /**
4167      * Time difference in stream time base units from the pts of this
4168      * packet to the point at which the output from the decoder has converged
4169      * independent from the availability of previous frames. That is, the
4170      * frames are virtually identical no matter if decoding started from
4171      * the very first frame or from this keyframe.
4172      * Is AV_NOPTS_VALUE if unknown.
4173      * This field is not the display duration of the current frame.
4174      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4175      * set.
4176      *
4177      * The purpose of this field is to allow seeking in streams that have no
4178      * keyframes in the conventional sense. It corresponds to the
4179      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4180      * essential for some types of subtitle streams to ensure that all
4181      * subtitles are correctly displayed after seeking.
4182      */
4183     int64_t convergence_duration;
4184
4185     // Timestamp generation support:
4186     /**
4187      * Synchronization point for start of timestamp generation.
4188      *
4189      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4190      * (default).
4191      *
4192      * For example, this corresponds to presence of H.264 buffering period
4193      * SEI message.
4194      */
4195     int dts_sync_point;
4196
4197     /**
4198      * Offset of the current timestamp against last timestamp sync point in
4199      * units of AVCodecContext.time_base.
4200      *
4201      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4202      * contain a valid timestamp offset.
4203      *
4204      * Note that the timestamp of sync point has usually a nonzero
4205      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4206      * the next frame after timestamp sync point will be usually 1.
4207      *
4208      * For example, this corresponds to H.264 cpb_removal_delay.
4209      */
4210     int dts_ref_dts_delta;
4211
4212     /**
4213      * Presentation delay of current frame in units of AVCodecContext.time_base.
4214      *
4215      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4216      * contain valid non-negative timestamp delta (presentation time of a frame
4217      * must not lie in the past).
4218      *
4219      * This delay represents the difference between decoding and presentation
4220      * time of the frame.
4221      *
4222      * For example, this corresponds to H.264 dpb_output_delay.
4223      */
4224     int pts_dts_delta;
4225
4226     /**
4227      * Position of the packet in file.
4228      *
4229      * Analogous to cur_frame_pts/dts
4230      */
4231     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4232
4233     /**
4234      * Byte position of currently parsed frame in stream.
4235      */
4236     int64_t pos;
4237
4238     /**
4239      * Previous frame byte position.
4240      */
4241     int64_t last_pos;
4242 } AVCodecParserContext;
4243
4244 typedef struct AVCodecParser {
4245     int codec_ids[5]; /* several codec IDs are permitted */
4246     int priv_data_size;
4247     int (*parser_init)(AVCodecParserContext *s);
4248     int (*parser_parse)(AVCodecParserContext *s,
4249                         AVCodecContext *avctx,
4250                         const uint8_t **poutbuf, int *poutbuf_size,
4251                         const uint8_t *buf, int buf_size);
4252     void (*parser_close)(AVCodecParserContext *s);
4253     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4254     struct AVCodecParser *next;
4255 } AVCodecParser;
4256
4257 AVCodecParser *av_parser_next(AVCodecParser *c);
4258
4259 void av_register_codec_parser(AVCodecParser *parser);
4260 AVCodecParserContext *av_parser_init(int codec_id);
4261
4262 /**
4263  * Parse a packet.
4264  *
4265  * @param s             parser context.
4266  * @param avctx         codec context.
4267  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4268  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4269  * @param buf           input buffer.
4270  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4271  * @param pts           input presentation timestamp.
4272  * @param dts           input decoding timestamp.
4273  * @param pos           input byte position in stream.
4274  * @return the number of bytes of the input bitstream used.
4275  *
4276  * Example:
4277  * @code
4278  *   while(in_len){
4279  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4280  *                                        in_data, in_len,
4281  *                                        pts, dts, pos);
4282  *       in_data += len;
4283  *       in_len  -= len;
4284  *
4285  *       if(size)
4286  *          decode_frame(data, size);
4287  *   }
4288  * @endcode
4289  */
4290 int av_parser_parse2(AVCodecParserContext *s,
4291                      AVCodecContext *avctx,
4292                      uint8_t **poutbuf, int *poutbuf_size,
4293                      const uint8_t *buf, int buf_size,
4294                      int64_t pts, int64_t dts,
4295                      int64_t pos);
4296
4297 int av_parser_change(AVCodecParserContext *s,
4298                      AVCodecContext *avctx,
4299                      uint8_t **poutbuf, int *poutbuf_size,
4300                      const uint8_t *buf, int buf_size, int keyframe);
4301 void av_parser_close(AVCodecParserContext *s);
4302
4303
4304 typedef struct AVBitStreamFilterContext {
4305     void *priv_data;
4306     struct AVBitStreamFilter *filter;
4307     AVCodecParserContext *parser;
4308     struct AVBitStreamFilterContext *next;
4309 } AVBitStreamFilterContext;
4310
4311
4312 typedef struct AVBitStreamFilter {
4313     const char *name;
4314     int priv_data_size;
4315     int (*filter)(AVBitStreamFilterContext *bsfc,
4316                   AVCodecContext *avctx, const char *args,
4317                   uint8_t **poutbuf, int *poutbuf_size,
4318                   const uint8_t *buf, int buf_size, int keyframe);
4319     void (*close)(AVBitStreamFilterContext *bsfc);
4320     struct AVBitStreamFilter *next;
4321 } AVBitStreamFilter;
4322
4323 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4324 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4325 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4326                                AVCodecContext *avctx, const char *args,
4327                                uint8_t **poutbuf, int *poutbuf_size,
4328                                const uint8_t *buf, int buf_size, int keyframe);
4329 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4330
4331 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4332
4333 /* memory */
4334
4335 /**
4336  * Reallocate the given block if it is not large enough, otherwise do nothing.
4337  *
4338  * @see av_realloc
4339  */
4340 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4341
4342 /**
4343  * Allocate a buffer, reusing the given one if large enough.
4344  *
4345  * Contrary to av_fast_realloc the current buffer contents might not be
4346  * preserved and on error the old buffer is freed, thus no special
4347  * handling to avoid memleaks is necessary.
4348  *
4349  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4350  * @param size size of the buffer *ptr points to
4351  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4352  *                 *size 0 if an error occurred.
4353  */
4354 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4355
4356 /**
4357  * Copy image src to dst. Wraps av_picture_data_copy() above.
4358  */
4359 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4360                      enum PixelFormat pix_fmt, int width, int height);
4361
4362 /**
4363  * Crop image top and left side.
4364  */
4365 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4366                     enum PixelFormat pix_fmt, int top_band, int left_band);
4367
4368 /**
4369  * Pad image.
4370  */
4371 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4372             int padtop, int padbottom, int padleft, int padright, int *color);
4373
4374 /**
4375  * Encode extradata length to a buffer. Used by xiph codecs.
4376  *
4377  * @param s buffer to write to; must be at least (v/255+1) bytes long
4378  * @param v size of extradata in bytes
4379  * @return number of bytes written to the buffer.
4380  */
4381 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4382
4383 /**
4384  * Logs a generic warning message about a missing feature. This function is
4385  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4386  * only, and would normally not be used by applications.
4387  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4388  * a pointer to an AVClass struct
4389  * @param[in] feature string containing the name of the missing feature
4390  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4391  * If want_sample is non-zero, additional verbage will be added to the log
4392  * message which tells the user how to report samples to the development
4393  * mailing list.
4394  */
4395 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4396
4397 /**
4398  * Log a generic warning message asking for a sample. This function is
4399  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4400  * only, and would normally not be used by applications.
4401  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4402  * a pointer to an AVClass struct
4403  * @param[in] msg string containing an optional message, or NULL if no message
4404  */
4405 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4406
4407 /**
4408  * Register the hardware accelerator hwaccel.
4409  */
4410 void av_register_hwaccel(AVHWAccel *hwaccel);
4411
4412 /**
4413  * If hwaccel is NULL, returns the first registered hardware accelerator,
4414  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4415  * after hwaccel, or NULL if hwaccel is the last one.
4416  */
4417 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4418
4419
4420 /**
4421  * Lock operation used by lockmgr
4422  */
4423 enum AVLockOp {
4424   AV_LOCK_CREATE,  ///< Create a mutex
4425   AV_LOCK_OBTAIN,  ///< Lock the mutex
4426   AV_LOCK_RELEASE, ///< Unlock the mutex
4427   AV_LOCK_DESTROY, ///< Free mutex resources
4428 };
4429
4430 /**
4431  * Register a user provided lock manager supporting the operations
4432  * specified by AVLockOp. mutex points to a (void *) where the
4433  * lockmgr should store/get a pointer to a user allocated mutex. It's
4434  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4435  *
4436  * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4437  *           callback during the call to av_lockmgr_register().
4438  *           Thus, the application must be prepared to handle that.
4439  *           If cb is set to NULL the lockmgr will be unregistered.
4440  *           Also note that during unregistration the previously registered
4441  *           lockmgr callback may also be invoked.
4442  */
4443 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4444
4445 /**
4446  * Get the type of the given codec.
4447  */
4448 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4449
4450 /**
4451  * Get the AVClass for AVCodecContext. It can be used in combination with
4452  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4453  *
4454  * @see av_opt_find().
4455  */
4456 const AVClass *avcodec_get_class(void);
4457
4458 #endif /* AVCODEC_AVCODEC_H */