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