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

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