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

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