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