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