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

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