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 #if FF_API_VERY_AGGRESSIVE
1496 #define FF_ER_VERY_AGGRESSIVE 4
1497 #define FF_ER_EXPLODE         5
1498 #else
1499 #define FF_ER_EXPLODE         4
1500 #endif /* FF_API_VERY_AGGRESSIVE */
1501
1502     /**
1503      * Called at the beginning of each frame to get a buffer for it.
1504      * If pic.reference is set then the frame will be read later by libavcodec.
1505      * avcodec_align_dimensions2() should be used to find the required width and
1506      * height, as they normally need to be rounded up to the next multiple of 16.
1507      * if CODEC_CAP_DR1 is not set then get_buffer() must call
1508      * avcodec_default_get_buffer() instead of providing buffers allocated by
1509      * some other means.
1510      * If frame multithreading is used and thread_safe_callbacks is set,
1511      * it may be called from a different thread, but not from more than one at once.
1512      * Does not need to be reentrant.
1513      * - encoding: unused
1514      * - decoding: Set by libavcodec, user can override.
1515      */
1516     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1517
1518     /**
1519      * Called to release buffers which were allocated with get_buffer.
1520      * A released buffer can be reused in get_buffer().
1521      * pic.data[*] must be set to NULL.
1522      * May be called from a different thread if frame multithreading is used,
1523      * but not by more than one thread at once, so does not need to be reentrant.
1524      * - encoding: unused
1525      * - decoding: Set by libavcodec, user can override.
1526      */
1527     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1528
1529     /**
1530      * Size of the frame reordering buffer in the decoder.
1531      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1532      * - encoding: Set by libavcodec.
1533      * - decoding: Set by libavcodec.
1534      */
1535     int has_b_frames;
1536
1537     /**
1538      * number of bytes per packet if constant and known or 0
1539      * Used by some WAV based audio codecs.
1540      */
1541     int block_align;
1542
1543     int parse_only; /* - decoding only: If true, only parsing is done
1544                        (function avcodec_parse_frame()). The frame
1545                        data is returned. Only MPEG codecs support this now. */
1546
1547     /**
1548      * 0-> h263 quant 1-> mpeg quant
1549      * - encoding: Set by user.
1550      * - decoding: unused
1551      */
1552     int mpeg_quant;
1553
1554     /**
1555      * pass1 encoding statistics output buffer
1556      * - encoding: Set by libavcodec.
1557      * - decoding: unused
1558      */
1559     char *stats_out;
1560
1561     /**
1562      * pass2 encoding statistics input buffer
1563      * Concatenated stuff from stats_out of pass1 should be placed here.
1564      * - encoding: Allocated/set/freed by user.
1565      * - decoding: unused
1566      */
1567     char *stats_in;
1568
1569     /**
1570      * ratecontrol qmin qmax limiting method
1571      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1572      * - encoding: Set by user.
1573      * - decoding: unused
1574      */
1575     float rc_qsquish;
1576
1577     float rc_qmod_amp;
1578     int rc_qmod_freq;
1579
1580     /**
1581      * ratecontrol override, see RcOverride
1582      * - encoding: Allocated/set/freed by user.
1583      * - decoding: unused
1584      */
1585     RcOverride *rc_override;
1586     int rc_override_count;
1587
1588     /**
1589      * rate control equation
1590      * - encoding: Set by user
1591      * - decoding: unused
1592      */
1593     const char *rc_eq;
1594
1595     /**
1596      * maximum bitrate
1597      * - encoding: Set by user.
1598      * - decoding: unused
1599      */
1600     int rc_max_rate;
1601
1602     /**
1603      * minimum bitrate
1604      * - encoding: Set by user.
1605      * - decoding: unused
1606      */
1607     int rc_min_rate;
1608
1609     /**
1610      * decoder bitstream buffer size
1611      * - encoding: Set by user.
1612      * - decoding: unused
1613      */
1614     int rc_buffer_size;
1615     float rc_buffer_aggressivity;
1616
1617     /**
1618      * qscale factor between P and I-frames
1619      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1620      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1621      * - encoding: Set by user.
1622      * - decoding: unused
1623      */
1624     float i_quant_factor;
1625
1626     /**
1627      * qscale offset between P and I-frames
1628      * - encoding: Set by user.
1629      * - decoding: unused
1630      */
1631     float i_quant_offset;
1632
1633     /**
1634      * initial complexity for pass1 ratecontrol
1635      * - encoding: Set by user.
1636      * - decoding: unused
1637      */
1638     float rc_initial_cplx;
1639
1640     /**
1641      * DCT algorithm, see FF_DCT_* below
1642      * - encoding: Set by user.
1643      * - decoding: unused
1644      */
1645     int dct_algo;
1646 #define FF_DCT_AUTO    0
1647 #define FF_DCT_FASTINT 1
1648 #define FF_DCT_INT     2
1649 #define FF_DCT_MMX     3
1650 #define FF_DCT_MLIB    4
1651 #define FF_DCT_ALTIVEC 5
1652 #define FF_DCT_FAAN    6
1653
1654     /**
1655      * luminance masking (0-> disabled)
1656      * - encoding: Set by user.
1657      * - decoding: unused
1658      */
1659     float lumi_masking;
1660
1661     /**
1662      * temporary complexity masking (0-> disabled)
1663      * - encoding: Set by user.
1664      * - decoding: unused
1665      */
1666     float temporal_cplx_masking;
1667
1668     /**
1669      * spatial complexity masking (0-> disabled)
1670      * - encoding: Set by user.
1671      * - decoding: unused
1672      */
1673     float spatial_cplx_masking;
1674
1675     /**
1676      * p block masking (0-> disabled)
1677      * - encoding: Set by user.
1678      * - decoding: unused
1679      */
1680     float p_masking;
1681
1682     /**
1683      * darkness masking (0-> disabled)
1684      * - encoding: Set by user.
1685      * - decoding: unused
1686      */
1687     float dark_masking;
1688
1689     /**
1690      * IDCT algorithm, see FF_IDCT_* below.
1691      * - encoding: Set by user.
1692      * - decoding: Set by user.
1693      */
1694     int idct_algo;
1695 #define FF_IDCT_AUTO          0
1696 #define FF_IDCT_INT           1
1697 #define FF_IDCT_SIMPLE        2
1698 #define FF_IDCT_SIMPLEMMX     3
1699 #define FF_IDCT_LIBMPEG2MMX   4
1700 #define FF_IDCT_PS2           5
1701 #define FF_IDCT_MLIB          6
1702 #define FF_IDCT_ARM           7
1703 #define FF_IDCT_ALTIVEC       8
1704 #define FF_IDCT_SH4           9
1705 #define FF_IDCT_SIMPLEARM     10
1706 #define FF_IDCT_H264          11
1707 #define FF_IDCT_VP3           12
1708 #define FF_IDCT_IPP           13
1709 #define FF_IDCT_XVIDMMX       14
1710 #define FF_IDCT_CAVS          15
1711 #define FF_IDCT_SIMPLEARMV5TE 16
1712 #define FF_IDCT_SIMPLEARMV6   17
1713 #define FF_IDCT_SIMPLEVIS     18
1714 #define FF_IDCT_WMV2          19
1715 #define FF_IDCT_FAAN          20
1716 #define FF_IDCT_EA            21
1717 #define FF_IDCT_SIMPLENEON    22
1718 #define FF_IDCT_SIMPLEALPHA   23
1719 #define FF_IDCT_BINK          24
1720
1721     /**
1722      * slice count
1723      * - encoding: Set by libavcodec.
1724      * - decoding: Set by user (or 0).
1725      */
1726     int slice_count;
1727     /**
1728      * slice offsets in the frame in bytes
1729      * - encoding: Set/allocated by libavcodec.
1730      * - decoding: Set/allocated by user (or NULL).
1731      */
1732     int *slice_offset;
1733
1734     /**
1735      * error concealment flags
1736      * - encoding: unused
1737      * - decoding: Set by user.
1738      */
1739     int error_concealment;
1740 #define FF_EC_GUESS_MVS   1
1741 #define FF_EC_DEBLOCK     2
1742
1743     /**
1744      * dsp_mask could be add used to disable unwanted CPU features
1745      * CPU features (i.e. MMX, SSE. ...)
1746      *
1747      * With the FORCE flag you may instead enable given CPU features.
1748      * (Dangerous: Usable in case of misdetection, improper usage however will
1749      * result into program crash.)
1750      */
1751     unsigned dsp_mask;
1752
1753     /**
1754      * bits per sample/pixel from the demuxer (needed for huffyuv).
1755      * - encoding: Set by libavcodec.
1756      * - decoding: Set by user.
1757      */
1758      int bits_per_coded_sample;
1759
1760     /**
1761      * prediction method (needed for huffyuv)
1762      * - encoding: Set by user.
1763      * - decoding: unused
1764      */
1765      int prediction_method;
1766 #define FF_PRED_LEFT   0
1767 #define FF_PRED_PLANE  1
1768 #define FF_PRED_MEDIAN 2
1769
1770     /**
1771      * sample aspect ratio (0 if unknown)
1772      * That is the width of a pixel divided by the height of the pixel.
1773      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1774      * - encoding: Set by user.
1775      * - decoding: Set by libavcodec.
1776      */
1777     AVRational sample_aspect_ratio;
1778
1779     /**
1780      * the picture in the bitstream
1781      * - encoding: Set by libavcodec.
1782      * - decoding: Set by libavcodec.
1783      */
1784     AVFrame *coded_frame;
1785
1786     /**
1787      * debug
1788      * - encoding: Set by user.
1789      * - decoding: Set by user.
1790      */
1791     int debug;
1792 #define FF_DEBUG_PICT_INFO   1
1793 #define FF_DEBUG_RC          2
1794 #define FF_DEBUG_BITSTREAM   4
1795 #define FF_DEBUG_MB_TYPE     8
1796 #define FF_DEBUG_QP          16
1797 #define FF_DEBUG_MV          32
1798 #define FF_DEBUG_DCT_COEFF   0x00000040
1799 #define FF_DEBUG_SKIP        0x00000080
1800 #define FF_DEBUG_STARTCODE   0x00000100
1801 #define FF_DEBUG_PTS         0x00000200
1802 #define FF_DEBUG_ER          0x00000400
1803 #define FF_DEBUG_MMCO        0x00000800
1804 #define FF_DEBUG_BUGS        0x00001000
1805 #define FF_DEBUG_VIS_QP      0x00002000
1806 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1807 #define FF_DEBUG_BUFFERS     0x00008000
1808 #define FF_DEBUG_THREADS     0x00010000
1809
1810     /**
1811      * debug
1812      * - encoding: Set by user.
1813      * - decoding: Set by user.
1814      */
1815     int debug_mv;
1816 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1817 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1818 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1819
1820     /**
1821      * error
1822      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1823      * - decoding: unused
1824      */
1825     uint64_t error[4];
1826
1827     /**
1828      * motion estimation comparison function
1829      * - encoding: Set by user.
1830      * - decoding: unused
1831      */
1832     int me_cmp;
1833     /**
1834      * subpixel motion estimation comparison function
1835      * - encoding: Set by user.
1836      * - decoding: unused
1837      */
1838     int me_sub_cmp;
1839     /**
1840      * macroblock comparison function (not supported yet)
1841      * - encoding: Set by user.
1842      * - decoding: unused
1843      */
1844     int mb_cmp;
1845     /**
1846      * interlaced DCT comparison function
1847      * - encoding: Set by user.
1848      * - decoding: unused
1849      */
1850     int ildct_cmp;
1851 #define FF_CMP_SAD    0
1852 #define FF_CMP_SSE    1
1853 #define FF_CMP_SATD   2
1854 #define FF_CMP_DCT    3
1855 #define FF_CMP_PSNR   4
1856 #define FF_CMP_BIT    5
1857 #define FF_CMP_RD     6
1858 #define FF_CMP_ZERO   7
1859 #define FF_CMP_VSAD   8
1860 #define FF_CMP_VSSE   9
1861 #define FF_CMP_NSSE   10
1862 #define FF_CMP_W53    11
1863 #define FF_CMP_W97    12
1864 #define FF_CMP_DCTMAX 13
1865 #define FF_CMP_DCT264 14
1866 #define FF_CMP_CHROMA 256
1867
1868     /**
1869      * ME diamond size & shape
1870      * - encoding: Set by user.
1871      * - decoding: unused
1872      */
1873     int dia_size;
1874
1875     /**
1876      * amount of previous MV predictors (2a+1 x 2a+1 square)
1877      * - encoding: Set by user.
1878      * - decoding: unused
1879      */
1880     int last_predictor_count;
1881
1882     /**
1883      * prepass for motion estimation
1884      * - encoding: Set by user.
1885      * - decoding: unused
1886      */
1887     int pre_me;
1888
1889     /**
1890      * motion estimation prepass comparison function
1891      * - encoding: Set by user.
1892      * - decoding: unused
1893      */
1894     int me_pre_cmp;
1895
1896     /**
1897      * ME prepass diamond size & shape
1898      * - encoding: Set by user.
1899      * - decoding: unused
1900      */
1901     int pre_dia_size;
1902
1903     /**
1904      * subpel ME quality
1905      * - encoding: Set by user.
1906      * - decoding: unused
1907      */
1908     int me_subpel_quality;
1909
1910     /**
1911      * callback to negotiate the pixelFormat
1912      * @param fmt is the list of formats which are supported by the codec,
1913      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1914      * The first is always the native one.
1915      * @return the chosen format
1916      * - encoding: unused
1917      * - decoding: Set by user, if not set the native format will be chosen.
1918      */
1919     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1920
1921     /**
1922      * DTG active format information (additional aspect ratio
1923      * information only used in DVB MPEG-2 transport streams)
1924      * 0 if not set.
1925      *
1926      * - encoding: unused
1927      * - decoding: Set by decoder.
1928      */
1929     int dtg_active_format;
1930 #define FF_DTG_AFD_SAME         8
1931 #define FF_DTG_AFD_4_3          9
1932 #define FF_DTG_AFD_16_9         10
1933 #define FF_DTG_AFD_14_9         11
1934 #define FF_DTG_AFD_4_3_SP_14_9  13
1935 #define FF_DTG_AFD_16_9_SP_14_9 14
1936 #define FF_DTG_AFD_SP_4_3       15
1937
1938     /**
1939      * maximum motion estimation search range in subpel units
1940      * If 0 then no limit.
1941      *
1942      * - encoding: Set by user.
1943      * - decoding: unused
1944      */
1945     int me_range;
1946
1947     /**
1948      * intra quantizer bias
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     int intra_quant_bias;
1953 #define FF_DEFAULT_QUANT_BIAS 999999
1954
1955     /**
1956      * inter quantizer bias
1957      * - encoding: Set by user.
1958      * - decoding: unused
1959      */
1960     int inter_quant_bias;
1961
1962     /**
1963      * color table ID
1964      * - encoding: unused
1965      * - decoding: Which clrtable should be used for 8bit RGB images.
1966      *             Tables have to be stored somewhere. FIXME
1967      */
1968     int color_table_id;
1969
1970     /**
1971      * internal_buffer count
1972      * Don't touch, used by libavcodec default_get_buffer().
1973      */
1974     int internal_buffer_count;
1975
1976     /**
1977      * internal_buffers
1978      * Don't touch, used by libavcodec default_get_buffer().
1979      */
1980     void *internal_buffer;
1981
1982     /**
1983      * Global quality for codecs which cannot change it per frame.
1984      * This should be proportional to MPEG-1/2/4 qscale.
1985      * - encoding: Set by user.
1986      * - decoding: unused
1987      */
1988     int global_quality;
1989
1990 #define FF_CODER_TYPE_VLC       0
1991 #define FF_CODER_TYPE_AC        1
1992 #define FF_CODER_TYPE_RAW       2
1993 #define FF_CODER_TYPE_RLE       3
1994 #define FF_CODER_TYPE_DEFLATE   4
1995     /**
1996      * coder type
1997      * - encoding: Set by user.
1998      * - decoding: unused
1999      */
2000     int coder_type;
2001
2002     /**
2003      * context model
2004      * - encoding: Set by user.
2005      * - decoding: unused
2006      */
2007     int context_model;
2008 #if 0
2009     /**
2010      *
2011      * - encoding: unused
2012      * - decoding: Set by user.
2013      */
2014     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2015 #endif
2016
2017     /**
2018      * slice flags
2019      * - encoding: unused
2020      * - decoding: Set by user.
2021      */
2022     int slice_flags;
2023 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2024 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2025 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2026
2027     /**
2028      * XVideo Motion Acceleration
2029      * - encoding: forbidden
2030      * - decoding: set by decoder
2031      */
2032     int xvmc_acceleration;
2033
2034     /**
2035      * macroblock decision mode
2036      * - encoding: Set by user.
2037      * - decoding: unused
2038      */
2039     int mb_decision;
2040 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2041 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2042 #define FF_MB_DECISION_RD     2        ///< rate distortion
2043
2044     /**
2045      * custom intra quantization matrix
2046      * - encoding: Set by user, can be NULL.
2047      * - decoding: Set by libavcodec.
2048      */
2049     uint16_t *intra_matrix;
2050
2051     /**
2052      * custom inter quantization matrix
2053      * - encoding: Set by user, can be NULL.
2054      * - decoding: Set by libavcodec.
2055      */
2056     uint16_t *inter_matrix;
2057
2058     /**
2059      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2060      * This is used to work around some encoder bugs.
2061      * - encoding: unused
2062      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2063      */
2064     unsigned int stream_codec_tag;
2065
2066     /**
2067      * scene change detection threshold
2068      * 0 is default, larger means fewer detected scene changes.
2069      * - encoding: Set by user.
2070      * - decoding: unused
2071      */
2072     int scenechange_threshold;
2073
2074     /**
2075      * minimum Lagrange multipler
2076      * - encoding: Set by user.
2077      * - decoding: unused
2078      */
2079     int lmin;
2080
2081     /**
2082      * maximum Lagrange multipler
2083      * - encoding: Set by user.
2084      * - decoding: unused
2085      */
2086     int lmax;
2087
2088 #if FF_API_PALETTE_CONTROL
2089     /**
2090      * palette control structure
2091      * - encoding: ??? (no palette-enabled encoder yet)
2092      * - decoding: Set by user.
2093      */
2094     struct AVPaletteControl *palctrl;
2095 #endif
2096
2097     /**
2098      * noise reduction strength
2099      * - encoding: Set by user.
2100      * - decoding: unused
2101      */
2102     int noise_reduction;
2103
2104     /**
2105      * Called at the beginning of a frame to get cr buffer for it.
2106      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2107      * libavcodec will pass previous buffer in pic, function should return
2108      * same buffer or new buffer with old frame "painted" into it.
2109      * If pic.data[0] == NULL must behave like get_buffer().
2110      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2111      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2112      * some other means.
2113      * - encoding: unused
2114      * - decoding: Set by libavcodec, user can override.
2115      */
2116     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2117
2118     /**
2119      * Number of bits which should be loaded into the rc buffer before decoding starts.
2120      * - encoding: Set by user.
2121      * - decoding: unused
2122      */
2123     int rc_initial_buffer_occupancy;
2124
2125     /**
2126      *
2127      * - encoding: Set by user.
2128      * - decoding: unused
2129      */
2130     int inter_threshold;
2131
2132     /**
2133      * CODEC_FLAG2_*
2134      * - encoding: Set by user.
2135      * - decoding: Set by user.
2136      */
2137     int flags2;
2138
2139     /**
2140      * Simulates errors in the bitstream to test error concealment.
2141      * - encoding: Set by user.
2142      * - decoding: unused
2143      */
2144     int error_rate;
2145
2146 #if FF_API_ANTIALIAS_ALGO
2147     /**
2148      * MP3 antialias algorithm, see FF_AA_* below.
2149      * - encoding: unused
2150      * - decoding: Set by user.
2151      */
2152     attribute_deprecated int antialias_algo;
2153 #define FF_AA_AUTO    0
2154 #define FF_AA_FASTINT 1 //not implemented yet
2155 #define FF_AA_INT     2
2156 #define FF_AA_FLOAT   3
2157 #endif
2158
2159     /**
2160      * quantizer noise shaping
2161      * - encoding: Set by user.
2162      * - decoding: unused
2163      */
2164     int quantizer_noise_shaping;
2165
2166     /**
2167      * thread count
2168      * is used to decide how many independent tasks should be passed to execute()
2169      * - encoding: Set by user.
2170      * - decoding: Set by user.
2171      */
2172     int thread_count;
2173
2174     /**
2175      * The codec may call this to execute several independent things.
2176      * It will return only after finishing all tasks.
2177      * The user may replace this with some multithreaded implementation,
2178      * the default implementation will execute the parts serially.
2179      * @param count the number of things to execute
2180      * - encoding: Set by libavcodec, user can override.
2181      * - decoding: Set by libavcodec, user can override.
2182      */
2183     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2184
2185     /**
2186      * thread opaque
2187      * Can be used by execute() to store some per AVCodecContext stuff.
2188      * - encoding: set by execute()
2189      * - decoding: set by execute()
2190      */
2191     void *thread_opaque;
2192
2193     /**
2194      * Motion estimation threshold below which no motion estimation is
2195      * performed, but instead the user specified motion vectors are used.
2196      *
2197      * - encoding: Set by user.
2198      * - decoding: unused
2199      */
2200      int me_threshold;
2201
2202     /**
2203      * Macroblock threshold below which the user specified macroblock types will be used.
2204      * - encoding: Set by user.
2205      * - decoding: unused
2206      */
2207      int mb_threshold;
2208
2209     /**
2210      * precision of the intra DC coefficient - 8
2211      * - encoding: Set by user.
2212      * - decoding: unused
2213      */
2214      int intra_dc_precision;
2215
2216     /**
2217      * noise vs. sse weight for the nsse comparsion function
2218      * - encoding: Set by user.
2219      * - decoding: unused
2220      */
2221      int nsse_weight;
2222
2223     /**
2224      * Number of macroblock rows at the top which are skipped.
2225      * - encoding: unused
2226      * - decoding: Set by user.
2227      */
2228      int skip_top;
2229
2230     /**
2231      * Number of macroblock rows at the bottom which are skipped.
2232      * - encoding: unused
2233      * - decoding: Set by user.
2234      */
2235      int skip_bottom;
2236
2237     /**
2238      * profile
2239      * - encoding: Set by user.
2240      * - decoding: Set by libavcodec.
2241      */
2242      int profile;
2243 #define FF_PROFILE_UNKNOWN -99
2244 #define FF_PROFILE_RESERVED -100
2245
2246 #define FF_PROFILE_AAC_MAIN 0
2247 #define FF_PROFILE_AAC_LOW  1
2248 #define FF_PROFILE_AAC_SSR  2
2249 #define FF_PROFILE_AAC_LTP  3
2250
2251 #define FF_PROFILE_DTS         20
2252 #define FF_PROFILE_DTS_ES      30
2253 #define FF_PROFILE_DTS_96_24   40
2254 #define FF_PROFILE_DTS_HD_HRA  50
2255 #define FF_PROFILE_DTS_HD_MA   60
2256
2257 #define FF_PROFILE_MPEG2_422    0
2258 #define FF_PROFILE_MPEG2_HIGH   1
2259 #define FF_PROFILE_MPEG2_SS     2
2260 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2261 #define FF_PROFILE_MPEG2_MAIN   4
2262 #define FF_PROFILE_MPEG2_SIMPLE 5
2263
2264 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2265 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2266
2267 #define FF_PROFILE_H264_BASELINE             66
2268 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2269 #define FF_PROFILE_H264_MAIN                 77
2270 #define FF_PROFILE_H264_EXTENDED             88
2271 #define FF_PROFILE_H264_HIGH                 100
2272 #define FF_PROFILE_H264_HIGH_10              110
2273 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2274 #define FF_PROFILE_H264_HIGH_422             122
2275 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2276 #define FF_PROFILE_H264_HIGH_444             144
2277 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2278 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2279 #define FF_PROFILE_H264_CAVLC_444            44
2280
2281 #define FF_PROFILE_VC1_SIMPLE   0
2282 #define FF_PROFILE_VC1_MAIN     1
2283 #define FF_PROFILE_VC1_COMPLEX  2
2284 #define FF_PROFILE_VC1_ADVANCED 3
2285
2286 #define FF_PROFILE_MPEG4_SIMPLE                     0
2287 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2288 #define FF_PROFILE_MPEG4_CORE                       2
2289 #define FF_PROFILE_MPEG4_MAIN                       3
2290 #define FF_PROFILE_MPEG4_N_BIT                      4
2291 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2292 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2293 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2294 #define FF_PROFILE_MPEG4_HYBRID                     8
2295 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2296 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2297 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2298 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2299 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2300 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2301 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2302
2303     /**
2304      * level
2305      * - encoding: Set by user.
2306      * - decoding: Set by libavcodec.
2307      */
2308      int level;
2309 #define FF_LEVEL_UNKNOWN -99
2310
2311     /**
2312      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2313      * - encoding: unused
2314      * - decoding: Set by user.
2315      */
2316      int lowres;
2317
2318     /**
2319      * Bitstream width / height, may be different from width/height if lowres
2320      * or other things are used.
2321      * - encoding: unused
2322      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2323      */
2324     int coded_width, coded_height;
2325
2326     /**
2327      * frame skip threshold
2328      * - encoding: Set by user.
2329      * - decoding: unused
2330      */
2331     int frame_skip_threshold;
2332
2333     /**
2334      * frame skip factor
2335      * - encoding: Set by user.
2336      * - decoding: unused
2337      */
2338     int frame_skip_factor;
2339
2340     /**
2341      * frame skip exponent
2342      * - encoding: Set by user.
2343      * - decoding: unused
2344      */
2345     int frame_skip_exp;
2346
2347     /**
2348      * frame skip comparison function
2349      * - encoding: Set by user.
2350      * - decoding: unused
2351      */
2352     int frame_skip_cmp;
2353
2354     /**
2355      * Border processing masking, raises the quantizer for mbs on the borders
2356      * of the picture.
2357      * - encoding: Set by user.
2358      * - decoding: unused
2359      */
2360     float border_masking;
2361
2362     /**
2363      * minimum MB lagrange multipler
2364      * - encoding: Set by user.
2365      * - decoding: unused
2366      */
2367     int mb_lmin;
2368
2369     /**
2370      * maximum MB lagrange multipler
2371      * - encoding: Set by user.
2372      * - decoding: unused
2373      */
2374     int mb_lmax;
2375
2376     /**
2377      *
2378      * - encoding: Set by user.
2379      * - decoding: unused
2380      */
2381     int me_penalty_compensation;
2382
2383     /**
2384      *
2385      * - encoding: unused
2386      * - decoding: Set by user.
2387      */
2388     enum AVDiscard skip_loop_filter;
2389
2390     /**
2391      *
2392      * - encoding: unused
2393      * - decoding: Set by user.
2394      */
2395     enum AVDiscard skip_idct;
2396
2397     /**
2398      *
2399      * - encoding: unused
2400      * - decoding: Set by user.
2401      */
2402     enum AVDiscard skip_frame;
2403
2404     /**
2405      *
2406      * - encoding: Set by user.
2407      * - decoding: unused
2408      */
2409     int bidir_refine;
2410
2411     /**
2412      *
2413      * - encoding: Set by user.
2414      * - decoding: unused
2415      */
2416     int brd_scale;
2417
2418     /**
2419      * constant rate factor - quality-based VBR - values ~correspond to qps
2420      * - encoding: Set by user.
2421      * - decoding: unused
2422      */
2423     float crf;
2424
2425     /**
2426      * constant quantization parameter rate control method
2427      * - encoding: Set by user.
2428      * - decoding: unused
2429      */
2430     int cqp;
2431
2432     /**
2433      * minimum GOP size
2434      * - encoding: Set by user.
2435      * - decoding: unused
2436      */
2437     int keyint_min;
2438
2439     /**
2440      * number of reference frames
2441      * - encoding: Set by user.
2442      * - decoding: Set by lavc.
2443      */
2444     int refs;
2445
2446     /**
2447      * chroma qp offset from luma
2448      * - encoding: Set by user.
2449      * - decoding: unused
2450      */
2451     int chromaoffset;
2452
2453     /**
2454      * Influences how often B-frames are used.
2455      * - encoding: Set by user.
2456      * - decoding: unused
2457      */
2458     int bframebias;
2459
2460     /**
2461      * trellis RD quantization
2462      * - encoding: Set by user.
2463      * - decoding: unused
2464      */
2465     int trellis;
2466
2467     /**
2468      * Reduce fluctuations in qp (before curve compression).
2469      * - encoding: Set by user.
2470      * - decoding: unused
2471      */
2472     float complexityblur;
2473
2474     /**
2475      * in-loop deblocking filter alphac0 parameter
2476      * alpha is in the range -6...6
2477      * - encoding: Set by user.
2478      * - decoding: unused
2479      */
2480     int deblockalpha;
2481
2482     /**
2483      * in-loop deblocking filter beta parameter
2484      * beta is in the range -6...6
2485      * - encoding: Set by user.
2486      * - decoding: unused
2487      */
2488     int deblockbeta;
2489
2490     /**
2491      * macroblock subpartition sizes to consider - p8x8, p4x4, b8x8, i8x8, i4x4
2492      * - encoding: Set by user.
2493      * - decoding: unused
2494      */
2495     int partitions;
2496 #define X264_PART_I4X4 0x001  /* Analyze i4x4 */
2497 #define X264_PART_I8X8 0x002  /* Analyze i8x8 (requires 8x8 transform) */
2498 #define X264_PART_P8X8 0x010  /* Analyze p16x8, p8x16 and p8x8 */
2499 #define X264_PART_P4X4 0x020  /* Analyze p8x4, p4x8, p4x4 */
2500 #define X264_PART_B8X8 0x100  /* Analyze b16x8, b8x16 and b8x8 */
2501
2502     /**
2503      * direct MV prediction mode - 0 (none), 1 (spatial), 2 (temporal), 3 (auto)
2504      * - encoding: Set by user.
2505      * - decoding: unused
2506      */
2507     int directpred;
2508
2509     /**
2510      * Audio cutoff bandwidth (0 means "automatic")
2511      * - encoding: Set by user.
2512      * - decoding: unused
2513      */
2514     int cutoff;
2515
2516     /**
2517      * Multiplied by qscale for each frame and added to scene_change_score.
2518      * - encoding: Set by user.
2519      * - decoding: unused
2520      */
2521     int scenechange_factor;
2522
2523     /**
2524      *
2525      * Note: Value depends upon the compare function used for fullpel ME.
2526      * - encoding: Set by user.
2527      * - decoding: unused
2528      */
2529     int mv0_threshold;
2530
2531     /**
2532      * Adjusts sensitivity of b_frame_strategy 1.
2533      * - encoding: Set by user.
2534      * - decoding: unused
2535      */
2536     int b_sensitivity;
2537
2538     /**
2539      * - encoding: Set by user.
2540      * - decoding: unused
2541      */
2542     int compression_level;
2543 #define FF_COMPRESSION_DEFAULT -1
2544
2545     /**
2546      * - encoding: Set by user.
2547      * - decoding: unused
2548      */
2549     int min_prediction_order;
2550
2551     /**
2552      * - encoding: Set by user.
2553      * - decoding: unused
2554      */
2555     int max_prediction_order;
2556
2557 #if FF_API_FLAC_GLOBAL_OPTS
2558     /**
2559      * @name FLAC options
2560      * @deprecated Use FLAC encoder private options instead.
2561      * @{
2562      */
2563
2564     /**
2565      * LPC coefficient precision - used by FLAC encoder
2566      * - encoding: Set by user.
2567      * - decoding: unused
2568      */
2569     attribute_deprecated int lpc_coeff_precision;
2570
2571     /**
2572      * search method for selecting prediction order
2573      * - encoding: Set by user.
2574      * - decoding: unused
2575      */
2576     attribute_deprecated int prediction_order_method;
2577
2578     /**
2579      * - encoding: Set by user.
2580      * - decoding: unused
2581      */
2582     attribute_deprecated int min_partition_order;
2583
2584     /**
2585      * - encoding: Set by user.
2586      * - decoding: unused
2587      */
2588     attribute_deprecated int max_partition_order;
2589     /**
2590      * @}
2591      */
2592 #endif
2593
2594     /**
2595      * GOP timecode frame start number, in non drop frame format
2596      * - encoding: Set by user.
2597      * - decoding: unused
2598      */
2599     int64_t timecode_frame_start;
2600
2601 #if FF_API_REQUEST_CHANNELS
2602     /**
2603      * Decoder should decode to this many channels if it can (0 for default)
2604      * - encoding: unused
2605      * - decoding: Set by user.
2606      * @deprecated Deprecated in favor of request_channel_layout.
2607      */
2608     int request_channels;
2609 #endif
2610
2611 #if FF_API_DRC_SCALE
2612     /**
2613      * Percentage of dynamic range compression to be applied by the decoder.
2614      * The default value is 1.0, corresponding to full compression.
2615      * - encoding: unused
2616      * - decoding: Set by user.
2617      * @deprecated use AC3 decoder private option instead.
2618      */
2619     attribute_deprecated float drc_scale;
2620 #endif
2621
2622     /**
2623      * opaque 64bit number (generally a PTS) that will be reordered and
2624      * output in AVFrame.reordered_opaque
2625      * @deprecated in favor of pkt_pts
2626      * - encoding: unused
2627      * - decoding: Set by user.
2628      */
2629     int64_t reordered_opaque;
2630
2631     /**
2632      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2633      * This field is applicable only when sample_fmt is AV_SAMPLE_FMT_S32.
2634      * - encoding: set by user.
2635      * - decoding: set by libavcodec.
2636      */
2637     int bits_per_raw_sample;
2638
2639     /**
2640      * Audio channel layout.
2641      * - encoding: set by user.
2642      * - decoding: set by user, may be overwritten by libavcodec.
2643      */
2644     int64_t channel_layout;
2645
2646     /**
2647      * Request decoder to use this channel layout if it can (0 for default)
2648      * - encoding: unused
2649      * - decoding: Set by user.
2650      */
2651     int64_t request_channel_layout;
2652
2653     /**
2654      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2655      * - encoding: Set by user.
2656      * - decoding: unused.
2657      */
2658     float rc_max_available_vbv_use;
2659
2660     /**
2661      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2662      * - encoding: Set by user.
2663      * - decoding: unused.
2664      */
2665     float rc_min_vbv_overflow_use;
2666
2667     /**
2668      * Hardware accelerator in use
2669      * - encoding: unused.
2670      * - decoding: Set by libavcodec
2671      */
2672     struct AVHWAccel *hwaccel;
2673
2674     /**
2675      * For some codecs, the time base is closer to the field rate than the frame rate.
2676      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2677      * if no telecine is used ...
2678      *
2679      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2680      */
2681     int ticks_per_frame;
2682
2683     /**
2684      * Hardware accelerator context.
2685      * For some hardware accelerators, a global context needs to be
2686      * provided by the user. In that case, this holds display-dependent
2687      * data FFmpeg cannot instantiate itself. Please refer to the
2688      * FFmpeg HW accelerator documentation to know how to fill this
2689      * is. e.g. for VA API, this is a struct vaapi_context.
2690      * - encoding: unused
2691      * - decoding: Set by user
2692      */
2693     void *hwaccel_context;
2694
2695     /**
2696      * Chromaticity coordinates of the source primaries.
2697      * - encoding: Set by user
2698      * - decoding: Set by libavcodec
2699      */
2700     enum AVColorPrimaries color_primaries;
2701
2702     /**
2703      * Color Transfer Characteristic.
2704      * - encoding: Set by user
2705      * - decoding: Set by libavcodec
2706      */
2707     enum AVColorTransferCharacteristic color_trc;
2708
2709     /**
2710      * YUV colorspace type.
2711      * - encoding: Set by user
2712      * - decoding: Set by libavcodec
2713      */
2714     enum AVColorSpace colorspace;
2715
2716     /**
2717      * MPEG vs JPEG YUV range.
2718      * - encoding: Set by user
2719      * - decoding: Set by libavcodec
2720      */
2721     enum AVColorRange color_range;
2722
2723     /**
2724      * This defines the location of chroma samples.
2725      * - encoding: Set by user
2726      * - decoding: Set by libavcodec
2727      */
2728     enum AVChromaLocation chroma_sample_location;
2729
2730     /**
2731      * The codec may call this to execute several independent things.
2732      * It will return only after finishing all tasks.
2733      * The user may replace this with some multithreaded implementation,
2734      * the default implementation will execute the parts serially.
2735      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2736      * @param c context passed also to func
2737      * @param count the number of things to execute
2738      * @param arg2 argument passed unchanged to func
2739      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2740      * @param func function that will be called count times, with jobnr from 0 to count-1.
2741      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2742      *             two instances of func executing at the same time will have the same threadnr.
2743      * @return always 0 currently, but code should handle a future improvement where when any call to func
2744      *         returns < 0 no further calls to func may be done and < 0 is returned.
2745      * - encoding: Set by libavcodec, user can override.
2746      * - decoding: Set by libavcodec, user can override.
2747      */
2748     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2749
2750     /**
2751      * explicit P-frame weighted prediction analysis method
2752      * 0: off
2753      * 1: fast blind weighting (one reference duplicate with -1 offset)
2754      * 2: smart weighting (full fade detection analysis)
2755      * - encoding: Set by user.
2756      * - decoding: unused
2757      */
2758     int weighted_p_pred;
2759
2760     /**
2761      * AQ mode
2762      * 0: Disabled
2763      * 1: Variance AQ (complexity mask)
2764      * 2: Auto-variance AQ (experimental)
2765      * - encoding: Set by user
2766      * - decoding: unused
2767      */
2768     int aq_mode;
2769
2770     /**
2771      * AQ strength
2772      * Reduces blocking and blurring in flat and textured areas.
2773      * - encoding: Set by user
2774      * - decoding: unused
2775      */
2776     float aq_strength;
2777
2778     /**
2779      * PSY RD
2780      * Strength of psychovisual optimization
2781      * - encoding: Set by user
2782      * - decoding: unused
2783      */
2784     float psy_rd;
2785
2786     /**
2787      * PSY trellis
2788      * Strength of psychovisual optimization
2789      * - encoding: Set by user
2790      * - decoding: unused
2791      */
2792     float psy_trellis;
2793
2794     /**
2795      * RC lookahead
2796      * Number of frames for frametype and ratecontrol lookahead
2797      * - encoding: Set by user
2798      * - decoding: unused
2799      */
2800     int rc_lookahead;
2801
2802     /**
2803      * Constant rate factor maximum
2804      * With CRF encoding mode and VBV restrictions enabled, prevents quality from being worse
2805      * than crf_max, even if doing so would violate VBV restrictions.
2806      * - encoding: Set by user.
2807      * - decoding: unused
2808      */
2809     float crf_max;
2810
2811     int log_level_offset;
2812
2813 #if FF_API_FLAC_GLOBAL_OPTS
2814     /**
2815      * Determines which LPC analysis algorithm to use.
2816      * - encoding: Set by user
2817      * - decoding: unused
2818      */
2819     attribute_deprecated enum AVLPCType lpc_type;
2820
2821     /**
2822      * Number of passes to use for Cholesky factorization during LPC analysis
2823      * - encoding: Set by user
2824      * - decoding: unused
2825      */
2826     attribute_deprecated int lpc_passes;
2827 #endif
2828
2829     /**
2830      * Number of slices.
2831      * Indicates number of picture subdivisions. Used for parallelized
2832      * decoding.
2833      * - encoding: Set by user
2834      * - decoding: unused
2835      */
2836     int slices;
2837
2838     /**
2839      * Header containing style information for text subtitles.
2840      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2841      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2842      * the Format line following. It shouldn't include any Dialogue line.
2843      * - encoding: Set/allocated/freed by user (before avcodec_open())
2844      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open())
2845      */
2846     uint8_t *subtitle_header;
2847     int subtitle_header_size;
2848
2849     /**
2850      * Current packet as passed into the decoder, to avoid having
2851      * to pass the packet into every function. Currently only valid
2852      * inside lavc and get/release_buffer callbacks.
2853      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2854      * - encoding: unused
2855      */
2856     AVPacket *pkt;
2857
2858     /**
2859      * Whether this is a copy of the context which had init() called on it.
2860      * This is used by multithreading - shared tables and picture pointers
2861      * should be freed from the original context only.
2862      * - encoding: Set by libavcodec.
2863      * - decoding: Set by libavcodec.
2864      */
2865     int is_copy;
2866
2867     /**
2868      * Which multithreading methods to use.
2869      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2870      * so clients which cannot provide future frames should not use it.
2871      *
2872      * - encoding: Set by user, otherwise the default is used.
2873      * - decoding: Set by user, otherwise the default is used.
2874      */
2875     int thread_type;
2876 #define FF_THREAD_FRAME   1 //< Decode more than one frame at once
2877 #define FF_THREAD_SLICE   2 //< Decode more than one part of a single frame at once
2878
2879     /**
2880      * Which multithreading methods are in use by the codec.
2881      * - encoding: Set by libavcodec.
2882      * - decoding: Set by libavcodec.
2883      */
2884     int active_thread_type;
2885
2886     /**
2887      * Set by the client if its custom get_buffer() callback can be called
2888      * from another thread, which allows faster multithreaded decoding.
2889      * draw_horiz_band() will be called from other threads regardless of this setting.
2890      * Ignored if the default get_buffer() is used.
2891      * - encoding: Set by user.
2892      * - decoding: Set by user.
2893      */
2894     int thread_safe_callbacks;
2895
2896     /**
2897      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2898      * Used for compliant TS muxing.
2899      * - encoding: Set by libavcodec.
2900      * - decoding: unused.
2901      */
2902     uint64_t vbv_delay;
2903
2904     /**
2905      * Type of service that the audio stream conveys.
2906      * - encoding: Set by user.
2907      * - decoding: Set by libavcodec.
2908      */
2909     enum AVAudioServiceType audio_service_type;
2910
2911     /**
2912      * desired sample format
2913      * - encoding: Not used.
2914      * - decoding: Set by user.
2915      * Decoder will decode to this format if it can.
2916      */
2917     enum AVSampleFormat request_sample_fmt;
2918
2919     /**
2920      * Current statistics for PTS correction.
2921      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
2922      * - encoding: unused
2923      */
2924     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
2925     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
2926     int64_t pts_correction_last_pts;       /// PTS of the last frame
2927     int64_t pts_correction_last_dts;       /// DTS of the last frame
2928
2929
2930 } AVCodecContext;
2931
2932 /**
2933  * AVProfile.
2934  */
2935 typedef struct AVProfile {
2936     int profile;
2937     const char *name; ///< short name for the profile
2938 } AVProfile;
2939
2940 typedef struct AVCodecDefault AVCodecDefault;
2941
2942 /**
2943  * AVCodec.
2944  */
2945 typedef struct AVCodec {
2946     /**
2947      * Name of the codec implementation.
2948      * The name is globally unique among encoders and among decoders (but an
2949      * encoder and a decoder can share the same name).
2950      * This is the primary way to find a codec from the user perspective.
2951      */
2952     const char *name;
2953     enum AVMediaType type;
2954     enum CodecID id;
2955     int priv_data_size;
2956     int (*init)(AVCodecContext *);
2957     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2958     int (*close)(AVCodecContext *);
2959     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2960     /**
2961      * Codec capabilities.
2962      * see CODEC_CAP_*
2963      */
2964     int capabilities;
2965     struct AVCodec *next;
2966     /**
2967      * Flush buffers.
2968      * Will be called when seeking
2969      */
2970     void (*flush)(AVCodecContext *);
2971     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2972     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2973     /**
2974      * Descriptive name for the codec, meant to be more human readable than name.
2975      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2976      */
2977     const char *long_name;
2978     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2979     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2980     const int64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2981     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2982     const AVClass *priv_class;              ///< AVClass for the private context
2983     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2984
2985     /**
2986      * @name Frame-level threading support functions
2987      * @{
2988      */
2989     /**
2990      * If defined, called on thread contexts when they are created.
2991      * If the codec allocates writable tables in init(), re-allocate them here.
2992      * priv_data will be set to a copy of the original.
2993      */
2994     int (*init_thread_copy)(AVCodecContext *);
2995     /**
2996      * Copy necessary context variables from a previous thread context to the current one.
2997      * If not defined, the next thread will start automatically; otherwise, the codec
2998      * must call ff_thread_finish_setup().
2999      *
3000      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3001      */
3002     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3003     /** @} */
3004
3005     /**
3006      * Private codec-specific defaults.
3007      */
3008     const AVCodecDefault *defaults;
3009 } AVCodec;
3010
3011 /**
3012  * AVHWAccel.
3013  */
3014 typedef struct AVHWAccel {
3015     /**
3016      * Name of the hardware accelerated codec.
3017      * The name is globally unique among encoders and among decoders (but an
3018      * encoder and a decoder can share the same name).
3019      */
3020     const char *name;
3021
3022     /**
3023      * Type of codec implemented by the hardware accelerator.
3024      *
3025      * See AVMEDIA_TYPE_xxx
3026      */
3027     enum AVMediaType type;
3028
3029     /**
3030      * Codec implemented by the hardware accelerator.
3031      *
3032      * See CODEC_ID_xxx
3033      */
3034     enum CodecID id;
3035
3036     /**
3037      * Supported pixel format.
3038      *
3039      * Only hardware accelerated formats are supported here.
3040      */
3041     enum PixelFormat pix_fmt;
3042
3043     /**
3044      * Hardware accelerated codec capabilities.
3045      * see FF_HWACCEL_CODEC_CAP_*
3046      */
3047     int capabilities;
3048
3049     struct AVHWAccel *next;
3050
3051     /**
3052      * Called at the beginning of each frame or field picture.
3053      *
3054      * Meaningful frame information (codec specific) is guaranteed to
3055      * be parsed at this point. This function is mandatory.
3056      *
3057      * Note that buf can be NULL along with buf_size set to 0.
3058      * Otherwise, this means the whole frame is available at this point.
3059      *
3060      * @param avctx the codec context
3061      * @param buf the frame data buffer base
3062      * @param buf_size the size of the frame in bytes
3063      * @return zero if successful, a negative value otherwise
3064      */
3065     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3066
3067     /**
3068      * Callback for each slice.
3069      *
3070      * Meaningful slice information (codec specific) is guaranteed to
3071      * be parsed at this point. This function is mandatory.
3072      *
3073      * @param avctx the codec context
3074      * @param buf the slice data buffer base
3075      * @param buf_size the size of the slice in bytes
3076      * @return zero if successful, a negative value otherwise
3077      */
3078     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3079
3080     /**
3081      * Called at the end of each frame or field picture.
3082      *
3083      * The whole picture is parsed at this point and can now be sent
3084      * to the hardware accelerator. This function is mandatory.
3085      *
3086      * @param avctx the codec context
3087      * @return zero if successful, a negative value otherwise
3088      */
3089     int (*end_frame)(AVCodecContext *avctx);
3090
3091     /**
3092      * Size of HW accelerator private data.
3093      *
3094      * Private data is allocated with av_mallocz() before
3095      * AVCodecContext.get_buffer() and deallocated after
3096      * AVCodecContext.release_buffer().
3097      */
3098     int priv_data_size;
3099 } AVHWAccel;
3100
3101 /**
3102  * four components are given, that's all.
3103  * the last component is alpha
3104  */
3105 typedef struct AVPicture {
3106     uint8_t *data[4];
3107     int linesize[4];       ///< number of bytes per line
3108 } AVPicture;
3109
3110 #if FF_API_PALETTE_CONTROL
3111 /**
3112  * AVPaletteControl
3113  * This structure defines a method for communicating palette changes
3114  * between and demuxer and a decoder.
3115  *
3116  * @deprecated Use AVPacket to send palette changes instead.
3117  * This is totally broken.
3118  */
3119 #define AVPALETTE_SIZE 1024
3120 #define AVPALETTE_COUNT 256
3121 typedef struct AVPaletteControl {
3122
3123     /* Demuxer sets this to 1 to indicate the palette has changed;
3124      * decoder resets to 0. */
3125     int palette_changed;
3126
3127     /* 4-byte ARGB palette entries, stored in native byte order; note that
3128      * the individual palette components should be on a 8-bit scale; if
3129      * the palette data comes from an IBM VGA native format, the component
3130      * data is probably 6 bits in size and needs to be scaled. */
3131     unsigned int palette[AVPALETTE_COUNT];
3132
3133 } AVPaletteControl attribute_deprecated;
3134 #endif
3135
3136 enum AVSubtitleType {
3137     SUBTITLE_NONE,
3138
3139     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3140
3141     /**
3142      * Plain text, the text field must be set by the decoder and is
3143      * authoritative. ass and pict fields may contain approximations.
3144      */
3145     SUBTITLE_TEXT,
3146
3147     /**
3148      * Formatted text, the ass field must be set by the decoder and is
3149      * authoritative. pict and text fields may contain approximations.
3150      */
3151     SUBTITLE_ASS,
3152 };
3153
3154 typedef struct AVSubtitleRect {
3155     int x;         ///< top left corner  of pict, undefined when pict is not set
3156     int y;         ///< top left corner  of pict, undefined when pict is not set
3157     int w;         ///< width            of pict, undefined when pict is not set
3158     int h;         ///< height           of pict, undefined when pict is not set
3159     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3160
3161     /**
3162      * data+linesize for the bitmap of this subtitle.
3163      * can be set for text/ass as well once they where rendered
3164      */
3165     AVPicture pict;
3166     enum AVSubtitleType type;
3167
3168     char *text;                     ///< 0 terminated plain UTF-8 text
3169
3170     /**
3171      * 0 terminated ASS/SSA compatible event line.
3172      * The pressentation of this is unaffected by the other values in this
3173      * struct.
3174      */
3175     char *ass;
3176 } AVSubtitleRect;
3177
3178 typedef struct AVSubtitle {
3179     uint16_t format; /* 0 = graphics */
3180     uint32_t start_display_time; /* relative to packet pts, in ms */
3181     uint32_t end_display_time; /* relative to packet pts, in ms */
3182     unsigned num_rects;
3183     AVSubtitleRect **rects;
3184     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3185 } AVSubtitle;
3186
3187 /* packet functions */
3188
3189 /**
3190  * @deprecated use NULL instead
3191  */
3192 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3193
3194 /**
3195  * Default packet destructor.
3196  */
3197 void av_destruct_packet(AVPacket *pkt);
3198
3199 /**
3200  * Initialize optional fields of a packet with default values.
3201  *
3202  * @param pkt packet
3203  */
3204 void av_init_packet(AVPacket *pkt);
3205
3206 /**
3207  * Allocate the payload of a packet and initialize its fields with
3208  * default values.
3209  *
3210  * @param pkt packet
3211  * @param size wanted payload size
3212  * @return 0 if OK, AVERROR_xxx otherwise
3213  */
3214 int av_new_packet(AVPacket *pkt, int size);
3215
3216 /**
3217  * Reduce packet size, correctly zeroing padding
3218  *
3219  * @param pkt packet
3220  * @param size new size
3221  */
3222 void av_shrink_packet(AVPacket *pkt, int size);
3223
3224 /**
3225  * Increase packet size, correctly zeroing padding
3226  *
3227  * @param pkt packet
3228  * @param grow_by number of bytes by which to increase the size of the packet
3229  */
3230 int av_grow_packet(AVPacket *pkt, int grow_by);
3231
3232 /**
3233  * @warning This is a hack - the packet memory allocation stuff is broken. The
3234  * packet is allocated if it was not really allocated.
3235  */
3236 int av_dup_packet(AVPacket *pkt);
3237
3238 /**
3239  * Free a packet.
3240  *
3241  * @param pkt packet to free
3242  */
3243 void av_free_packet(AVPacket *pkt);
3244
3245 /**
3246  * Allocate new information of a packet.
3247  *
3248  * @param pkt packet
3249  * @param type side information type
3250  * @param size side information size
3251  * @return pointer to fresh allocated data or NULL otherwise
3252  */
3253 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3254                                  int size);
3255
3256 /**
3257  * Get side information from packet.
3258  *
3259  * @param pkt packet
3260  * @param type desired side information type
3261  * @param size pointer for side information size to store (optional)
3262  * @return pointer to data if present or NULL otherwise
3263  */
3264 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3265                                  int *size);
3266
3267 int av_packet_merge_side_data(AVPacket *pkt);
3268
3269 int av_packet_split_side_data(AVPacket *pkt);
3270
3271
3272 /* resample.c */
3273
3274 struct ReSampleContext;
3275 struct AVResampleContext;
3276
3277 typedef struct ReSampleContext ReSampleContext;
3278
3279 /**
3280  *  Initialize audio resampling context.
3281  *
3282  * @param output_channels  number of output channels
3283  * @param input_channels   number of input channels
3284  * @param output_rate      output sample rate
3285  * @param input_rate       input sample rate
3286  * @param sample_fmt_out   requested output sample format
3287  * @param sample_fmt_in    input sample format
3288  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3289  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3290  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3291                            between the 2 closest, if 0 the closest will be used
3292  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3293  * @return allocated ReSampleContext, NULL if error occured
3294  */
3295 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3296                                         int output_rate, int input_rate,
3297                                         enum AVSampleFormat sample_fmt_out,
3298                                         enum AVSampleFormat sample_fmt_in,
3299                                         int filter_length, int log2_phase_count,
3300                                         int linear, double cutoff);
3301
3302 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3303
3304 /**
3305  * Free resample context.
3306  *
3307  * @param s a non-NULL pointer to a resample context previously
3308  *          created with av_audio_resample_init()
3309  */
3310 void audio_resample_close(ReSampleContext *s);
3311
3312
3313 /**
3314  * Initialize an audio resampler.
3315  * Note, if either rate is not an integer then simply scale both rates up so they are.
3316  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3317  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3318  * @param linear If 1 then the used FIR filter will be linearly interpolated
3319                  between the 2 closest, if 0 the closest will be used
3320  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3321  */
3322 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3323
3324 /**
3325  * Resample an array of samples using a previously configured context.
3326  * @param src an array of unconsumed samples
3327  * @param consumed the number of samples of src which have been consumed are returned here
3328  * @param src_size the number of unconsumed samples available
3329  * @param dst_size the amount of space in samples available in dst
3330  * @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.
3331  * @return the number of samples written in dst or -1 if an error occurred
3332  */
3333 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3334
3335
3336 /**
3337  * Compensate samplerate/timestamp drift. The compensation is done by changing
3338  * the resampler parameters, so no audible clicks or similar distortions occur
3339  * @param compensation_distance distance in output samples over which the compensation should be performed
3340  * @param sample_delta number of output samples which should be output less
3341  *
3342  * example: av_resample_compensate(c, 10, 500)
3343  * here instead of 510 samples only 500 samples would be output
3344  *
3345  * note, due to rounding the actual compensation might be slightly different,
3346  * especially if the compensation_distance is large and the in_rate used during init is small
3347  */
3348 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3349 void av_resample_close(struct AVResampleContext *c);
3350
3351 /**
3352  * Allocate memory for a picture.  Call avpicture_free() to free it.
3353  *
3354  * @see avpicture_fill()
3355  *
3356  * @param picture the picture to be filled in
3357  * @param pix_fmt the format of the picture
3358  * @param width the width of the picture
3359  * @param height the height of the picture
3360  * @return zero if successful, a negative value if not
3361  */
3362 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3363
3364 /**
3365  * Free a picture previously allocated by avpicture_alloc().
3366  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3367  * itself is not.
3368  *
3369  * @param picture the AVPicture to be freed
3370  */
3371 void avpicture_free(AVPicture *picture);
3372
3373 /**
3374  * Fill in the AVPicture fields.
3375  * The fields of the given AVPicture are filled in by using the 'ptr' address
3376  * which points to the image data buffer. Depending on the specified picture
3377  * format, one or multiple image data pointers and line sizes will be set.
3378  * If a planar format is specified, several pointers will be set pointing to
3379  * the different picture planes and the line sizes of the different planes
3380  * will be stored in the lines_sizes array.
3381  * Call with ptr == NULL to get the required size for the ptr buffer.
3382  *
3383  * To allocate the buffer and fill in the AVPicture fields in one call,
3384  * use avpicture_alloc().
3385  *
3386  * @param picture AVPicture whose fields are to be filled in
3387  * @param ptr Buffer which will contain or contains the actual image data
3388  * @param pix_fmt The format in which the picture data is stored.
3389  * @param width the width of the image in pixels
3390  * @param height the height of the image in pixels
3391  * @return size of the image data in bytes
3392  */
3393 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3394                    enum PixelFormat pix_fmt, int width, int height);
3395
3396 /**
3397  * Copy pixel data from an AVPicture into a buffer.
3398  * The data is stored compactly, without any gaps for alignment or padding
3399  * which may be applied by avpicture_fill().
3400  *
3401  * @see avpicture_get_size()
3402  *
3403  * @param[in] src AVPicture containing image data
3404  * @param[in] pix_fmt The format in which the picture data is stored.
3405  * @param[in] width the width of the image in pixels.
3406  * @param[in] height the height of the image in pixels.
3407  * @param[out] dest A buffer into which picture data will be copied.
3408  * @param[in] dest_size The size of 'dest'.
3409  * @return The number of bytes written to dest, or a negative value (error code) on error.
3410  */
3411 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3412                      unsigned char *dest, int dest_size);
3413
3414 /**
3415  * Calculate the size in bytes that a picture of the given width and height
3416  * would occupy if stored in the given picture format.
3417  * Note that this returns the size of a compact representation as generated
3418  * by avpicture_layout(), which can be smaller than the size required for e.g.
3419  * avpicture_fill().
3420  *
3421  * @param pix_fmt the given picture format
3422  * @param width the width of the image
3423  * @param height the height of the image
3424  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3425  */
3426 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3427 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3428
3429 #if FF_API_GET_PIX_FMT_NAME
3430 /**
3431  * Return the short name for a pixel format.
3432  *
3433  * \see av_get_pix_fmt(), av_get_pix_fmt_string().
3434  * @deprecated Deprecated in favor of av_get_pix_fmt_name().
3435  */
3436 attribute_deprecated
3437 const char *avcodec_get_pix_fmt_name(enum PixelFormat pix_fmt);
3438 #endif
3439
3440 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3441
3442 /**
3443  * Return a value representing the fourCC code associated to the
3444  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3445  * found.
3446  */
3447 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3448
3449 /**
3450  * Put a string representing the codec tag codec_tag in buf.
3451  *
3452  * @param buf_size size in bytes of buf
3453  * @return the length of the string that would have been generated if
3454  * enough space had been available, excluding the trailing null
3455  */
3456 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3457
3458 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3459 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3460 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3461 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3462 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3463 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3464
3465 /**
3466  * Compute what kind of losses will occur when converting from one specific
3467  * pixel format to another.
3468  * When converting from one pixel format to another, information loss may occur.
3469  * For example, when converting from RGB24 to GRAY, the color information will
3470  * be lost. Similarly, other losses occur when converting from some formats to
3471  * other formats. These losses can involve loss of chroma, but also loss of
3472  * resolution, loss of color depth, loss due to the color space conversion, loss
3473  * of the alpha bits or loss due to color quantization.
3474  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3475  * which will occur when converting from one pixel format to another.
3476  *
3477  * @param[in] dst_pix_fmt destination pixel format
3478  * @param[in] src_pix_fmt source pixel format
3479  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3480  * @return Combination of flags informing you what kind of losses will occur.
3481  */
3482 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3483                              int has_alpha);
3484
3485 /**
3486  * Find the best pixel format to convert to given a certain source pixel
3487  * format.  When converting from one pixel format to another, information loss
3488  * may occur.  For example, when converting from RGB24 to GRAY, the color
3489  * information will be lost. Similarly, other losses occur when converting from
3490  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3491  * the given pixel formats should be used to suffer the least amount of loss.
3492  * The pixel formats from which it chooses one, are determined by the
3493  * pix_fmt_mask parameter.
3494  *
3495  * @code
3496  * src_pix_fmt = PIX_FMT_YUV420P;
3497  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3498  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3499  * @endcode
3500  *
3501  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3502  * @param[in] src_pix_fmt source pixel format
3503  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3504  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3505  * @return The best pixel format to convert to or -1 if none was found.
3506  */
3507 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3508                               int has_alpha, int *loss_ptr);
3509
3510 #define FF_ALPHA_TRANSP       0x0001 /* image has some totally transparent pixels */
3511 #define FF_ALPHA_SEMI_TRANSP  0x0002 /* image has some transparent pixels */
3512
3513 /**
3514  * Tell if an image really has transparent alpha values.
3515  * @return ored mask of FF_ALPHA_xxx constants
3516  */
3517 int img_get_alpha_info(const AVPicture *src,
3518                        enum PixelFormat pix_fmt, int width, int height);
3519
3520 /* deinterlace a picture */
3521 /* deinterlace - if not supported return -1 */
3522 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3523                           enum PixelFormat pix_fmt, int width, int height);
3524
3525 /* external high level API */
3526
3527 /**
3528  * If c is NULL, returns the first registered codec,
3529  * if c is non-NULL, returns the next registered codec after c,
3530  * or NULL if c is the last one.
3531  */
3532 AVCodec *av_codec_next(AVCodec *c);
3533
3534 /**
3535  * Return the LIBAVCODEC_VERSION_INT constant.
3536  */
3537 unsigned avcodec_version(void);
3538
3539 /**
3540  * Return the libavcodec build-time configuration.
3541  */
3542 const char *avcodec_configuration(void);
3543
3544 /**
3545  * Return the libavcodec license.
3546  */
3547 const char *avcodec_license(void);
3548
3549 /**
3550  * Initialize libavcodec.
3551  * If called more than once, does nothing.
3552  *
3553  * @warning This function must be called before any other libavcodec
3554  * function.
3555  *
3556  * @warning This function is not thread-safe.
3557  */
3558 void avcodec_init(void);
3559
3560 /**
3561  * Register the codec codec and initialize libavcodec.
3562  *
3563  * @see avcodec_init(), avcodec_register_all()
3564  */
3565 void avcodec_register(AVCodec *codec);
3566
3567 /**
3568  * Find a registered encoder with a matching codec ID.
3569  *
3570  * @param id CodecID of the requested encoder
3571  * @return An encoder if one was found, NULL otherwise.
3572  */
3573 AVCodec *avcodec_find_encoder(enum CodecID id);
3574
3575 /**
3576  * Find a registered encoder with the specified name.
3577  *
3578  * @param name name of the requested encoder
3579  * @return An encoder if one was found, NULL otherwise.
3580  */
3581 AVCodec *avcodec_find_encoder_by_name(const char *name);
3582
3583 /**
3584  * Find a registered decoder with a matching codec ID.
3585  *
3586  * @param id CodecID of the requested decoder
3587  * @return A decoder if one was found, NULL otherwise.
3588  */
3589 AVCodec *avcodec_find_decoder(enum CodecID id);
3590
3591 /**
3592  * Find a registered decoder with the specified name.
3593  *
3594  * @param name name of the requested decoder
3595  * @return A decoder if one was found, NULL otherwise.
3596  */
3597 AVCodec *avcodec_find_decoder_by_name(const char *name);
3598 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3599
3600 /**
3601  * Return a name for the specified profile, if available.
3602  *
3603  * @param codec the codec that is searched for the given profile
3604  * @param profile the profile value for which a name is requested
3605  * @return A name for the profile if found, NULL otherwise.
3606  */
3607 const char *av_get_profile_name(const AVCodec *codec, int profile);
3608
3609 /**
3610  * Set the fields of the given AVCodecContext to default values.
3611  *
3612  * @param s The AVCodecContext of which the fields should be set to default values.
3613  */
3614 void avcodec_get_context_defaults(AVCodecContext *s);
3615
3616 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3617  *  we WILL change its arguments and name a few times! */
3618 void avcodec_get_context_defaults2(AVCodecContext *s, enum AVMediaType);
3619
3620 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3621  *  we WILL change its arguments and name a few times! */
3622 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3623
3624 #if FF_API_ALLOC_CONTEXT
3625 /**
3626  * Allocate an AVCodecContext and set its fields to default values.  The
3627  * resulting struct can be deallocated by simply calling av_free().
3628  *
3629  * @return An AVCodecContext filled with default values or NULL on failure.
3630  * @see avcodec_get_context_defaults
3631  *
3632  * @deprecated use avcodec_alloc_context3()
3633  */
3634 attribute_deprecated
3635 AVCodecContext *avcodec_alloc_context(void);
3636
3637 /** THIS FUNCTION IS NOT YET PART OF THE PUBLIC API!
3638  *  we WILL change its arguments and name a few times! */
3639 attribute_deprecated
3640 AVCodecContext *avcodec_alloc_context2(enum AVMediaType);
3641 #endif
3642
3643 /**
3644  * Allocate an AVCodecContext and set its fields to default values.  The
3645  * resulting struct can be deallocated by simply calling av_free().
3646  *
3647  * @param codec if non-NULL, allocate private data and initialize defaults
3648  *              for the given codec. It is illegal to then call avcodec_open()
3649  *              with a different codec.
3650  *
3651  * @return An AVCodecContext filled with default values or NULL on failure.
3652  * @see avcodec_get_context_defaults
3653  *
3654  * @deprecated use avcodec_alloc_context3()
3655  */
3656 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3657
3658 /**
3659  * Copy the settings of the source AVCodecContext into the destination
3660  * AVCodecContext. The resulting destination codec context will be
3661  * unopened, i.e. you are required to call avcodec_open() before you
3662  * can use this AVCodecContext to decode/encode video/audio data.
3663  *
3664  * @param dest target codec context, should be initialized with
3665  *             avcodec_alloc_context3(), but otherwise uninitialized
3666  * @param src source codec context
3667  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3668  */
3669 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3670
3671 /**
3672  * Set the fields of the given AVFrame to default values.
3673  *
3674  * @param pic The AVFrame of which the fields should be set to default values.
3675  */
3676 void avcodec_get_frame_defaults(AVFrame *pic);
3677
3678 /**
3679  * Allocate an AVFrame and set its fields to default values.  The resulting
3680  * struct can be deallocated by simply calling av_free().
3681  *
3682  * @return An AVFrame filled with default values or NULL on failure.
3683  * @see avcodec_get_frame_defaults
3684  */
3685 AVFrame *avcodec_alloc_frame(void);
3686
3687 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3688 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3689 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3690
3691 /**
3692  * Return the amount of padding in pixels which the get_buffer callback must
3693  * provide around the edge of the image for codecs which do not have the
3694  * CODEC_FLAG_EMU_EDGE flag.
3695  *
3696  * @return Required padding in pixels.
3697  */
3698 unsigned avcodec_get_edge_width(void);
3699 /**
3700  * Modify width and height values so that they will result in a memory
3701  * buffer that is acceptable for the codec if you do not use any horizontal
3702  * padding.
3703  *
3704  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3705  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3706  * according to avcodec_get_edge_width() before.
3707  */
3708 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3709 /**
3710  * Modify width and height values so that they will result in a memory
3711  * buffer that is acceptable for the codec if you also ensure that all
3712  * line sizes are a multiple of the respective linesize_align[i].
3713  *
3714  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3715  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3716  * according to avcodec_get_edge_width() before.
3717  */
3718 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3719                                int linesize_align[4]);
3720
3721 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3722
3723 #if FF_API_THREAD_INIT
3724 /**
3725  * @deprecated Set s->thread_count before calling avcodec_open() instead of calling this.
3726  */
3727 attribute_deprecated
3728 int avcodec_thread_init(AVCodecContext *s, int thread_count);
3729 #endif
3730
3731 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3732 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3733 //FIXME func typedef
3734
3735 #if FF_API_AVCODEC_OPEN
3736 /**
3737  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3738  * function the context has to be allocated.
3739  *
3740  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3741  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3742  * retrieving a codec.
3743  *
3744  * @warning This function is not thread safe!
3745  *
3746  * @code
3747  * avcodec_register_all();
3748  * codec = avcodec_find_decoder(CODEC_ID_H264);
3749  * if (!codec)
3750  *     exit(1);
3751  *
3752  * context = avcodec_alloc_context3(codec);
3753  *
3754  * if (avcodec_open(context, codec) < 0)
3755  *     exit(1);
3756  * @endcode
3757  *
3758  * @param avctx The context which will be set up to use the given codec.
3759  * @param codec The codec to use within the context.
3760  * @return zero on success, a negative value on error
3761  * @see avcodec_alloc_context3, avcodec_find_decoder, avcodec_find_encoder, avcodec_close
3762  *
3763  * @deprecated use avcodec_open2
3764  */
3765 attribute_deprecated
3766 int avcodec_open(AVCodecContext *avctx, AVCodec *codec);
3767 #endif
3768
3769 /**
3770  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3771  * function the context has to be allocated with avcodec_alloc_context().
3772  *
3773  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3774  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3775  * retrieving a codec.
3776  *
3777  * @warning This function is not thread safe!
3778  *
3779  * @code
3780  * avcodec_register_all();
3781  * av_dict_set(&opts, "b", "2.5M", 0);
3782  * codec = avcodec_find_decoder(CODEC_ID_H264);
3783  * if (!codec)
3784  *     exit(1);
3785  *
3786  * context = avcodec_alloc_context();
3787  *
3788  * if (avcodec_open(context, codec, opts) < 0)
3789  *     exit(1);
3790  * @endcode
3791  *
3792  * @param avctx The context to initialize.
3793  * @param options A dictionary filled with AVCodecContext and codec-private options.
3794  *                On return this object will be filled with options that were not found.
3795  *
3796  * @return zero on success, a negative value on error
3797  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3798  *      av_dict_set(), av_opt_find().
3799  */
3800 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3801
3802 /**
3803  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3804  * Some decoders may support multiple frames in a single AVPacket, such
3805  * decoders would then just decode the first frame. In this case,
3806  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3807  * the remaining data in order to decode the second frame etc.
3808  * If no frame
3809  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3810  * decompressed frame size in bytes.
3811  *
3812  * @warning You must set frame_size_ptr to the allocated size of the
3813  * output buffer before calling avcodec_decode_audio3().
3814  *
3815  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3816  * the actual read bytes because some optimized bitstream readers read 32 or 64
3817  * bits at once and could read over the end.
3818  *
3819  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3820  * no overreading happens for damaged MPEG streams.
3821  *
3822  * @note You might have to align the input buffer avpkt->data and output buffer
3823  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3824  * necessary at all, on others it won't work at all if not aligned and on others
3825  * it will work but it will have an impact on performance.
3826  *
3827  * In practice, avpkt->data should have 4 byte alignment at minimum and
3828  * samples should be 16 byte aligned unless the CPU doesn't need it
3829  * (AltiVec and SSE do).
3830  *
3831  * @param avctx the codec context
3832  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3833  * @param[in,out] frame_size_ptr the output buffer size in bytes
3834  * @param[in] avpkt The input AVPacket containing the input buffer.
3835  *            You can create such packet with av_init_packet() and by then setting
3836  *            data and size, some decoders might in addition need other fields.
3837  *            All decoders are designed to use the least fields possible though.
3838  * @return On error a negative value is returned, otherwise the number of bytes
3839  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3840  */
3841 int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3842                          int *frame_size_ptr,
3843                          AVPacket *avpkt);
3844
3845 /**
3846  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3847  * Some decoders may support multiple frames in a single AVPacket, such
3848  * decoders would then just decode the first frame.
3849  *
3850  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3851  * the actual read bytes because some optimized bitstream readers read 32 or 64
3852  * bits at once and could read over the end.
3853  *
3854  * @warning The end of the input buffer buf should be set to 0 to ensure that
3855  * no overreading happens for damaged MPEG streams.
3856  *
3857  * @note You might have to align the input buffer avpkt->data.
3858  * The alignment requirements depend on the CPU: on some CPUs it isn't
3859  * necessary at all, on others it won't work at all if not aligned and on others
3860  * it will work but it will have an impact on performance.
3861  *
3862  * In practice, avpkt->data should have 4 byte alignment at minimum.
3863  *
3864  * @note Some codecs have a delay between input and output, these need to be
3865  * fed with avpkt->data=NULL, avpkt->size=0 at the end to return the remaining frames.
3866  *
3867  * @param avctx the codec context
3868  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3869  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3870  *             allocate memory for the actual bitmap.
3871  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3872  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3873  *                   decodes and the decoder tells the user once it does not need the data anymore,
3874  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3875  *
3876  * @param[in] avpkt The input AVpacket containing the input buffer.
3877  *            You can create such packet with av_init_packet() and by then setting
3878  *            data and size, some decoders might in addition need other fields like
3879  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3880  *            fields possible.
3881  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3882  * @return On error a negative value is returned, otherwise the number of bytes
3883  * used or zero if no frame could be decompressed.
3884  */
3885 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3886                          int *got_picture_ptr,
3887                          AVPacket *avpkt);
3888
3889 /**
3890  * Decode a subtitle message.
3891  * Return a negative value on error, otherwise return the number of bytes used.
3892  * If no subtitle could be decompressed, got_sub_ptr is zero.
3893  * Otherwise, the subtitle is stored in *sub.
3894  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3895  * simplicity, because the performance difference is expect to be negligible
3896  * and reusing a get_buffer written for video codecs would probably perform badly
3897  * due to a potentially very different allocation pattern.
3898  *
3899  * @param avctx the codec context
3900  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3901                    freed with avsubtitle_free if *got_sub_ptr is set.
3902  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3903  * @param[in] avpkt The input AVPacket containing the input buffer.
3904  */
3905 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3906                             int *got_sub_ptr,
3907                             AVPacket *avpkt);
3908
3909 /**
3910  * Frees all allocated data in the given subtitle struct.
3911  *
3912  * @param sub AVSubtitle to free.
3913  */
3914 void avsubtitle_free(AVSubtitle *sub);
3915
3916 int avcodec_parse_frame(AVCodecContext *avctx, uint8_t **pdata,
3917                         int *data_size_ptr,
3918                         uint8_t *buf, int buf_size);
3919
3920 /**
3921  * Encode an audio frame from samples into buf.
3922  *
3923  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3924  * However, for PCM audio the user will know how much space is needed
3925  * because it depends on the value passed in buf_size as described
3926  * below. In that case a lower value can be used.
3927  *
3928  * @param avctx the codec context
3929  * @param[out] buf the output buffer
3930  * @param[in] buf_size the output buffer size
3931  * @param[in] samples the input buffer containing the samples
3932  * The number of samples read from this buffer is frame_size*channels,
3933  * both of which are defined in avctx.
3934  * For PCM audio the number of samples read from samples is equal to
3935  * buf_size * input_sample_size / output_sample_size.
3936  * @return On error a negative value is returned, on success zero or the number
3937  * of bytes used to encode the data read from the input buffer.
3938  */
3939 int avcodec_encode_audio(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3940                          const short *samples);
3941
3942 /**
3943  * Encode a video frame from pict into buf.
3944  * The input picture should be
3945  * stored using a specific format, namely avctx.pix_fmt.
3946  *
3947  * @param avctx the codec context
3948  * @param[out] buf the output buffer for the bitstream of encoded frame
3949  * @param[in] buf_size the size of the output buffer in bytes
3950  * @param[in] pict the input picture to encode
3951  * @return On error a negative value is returned, on success zero or the number
3952  * of bytes used from the output buffer.
3953  */
3954 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3955                          const AVFrame *pict);
3956 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3957                             const AVSubtitle *sub);
3958
3959 int avcodec_close(AVCodecContext *avctx);
3960
3961 /**
3962  * Register all the codecs, parsers and bitstream filters which were enabled at
3963  * configuration time. If you do not call this function you can select exactly
3964  * which formats you want to support, by using the individual registration
3965  * functions.
3966  *
3967  * @see avcodec_register
3968  * @see av_register_codec_parser
3969  * @see av_register_bitstream_filter
3970  */
3971 void avcodec_register_all(void);
3972
3973 /**
3974  * Flush buffers, should be called when seeking or when switching to a different stream.
3975  */
3976 void avcodec_flush_buffers(AVCodecContext *avctx);
3977
3978 void avcodec_default_free_buffers(AVCodecContext *s);
3979
3980 /* misc useful functions */
3981
3982 #if FF_API_OLD_FF_PICT_TYPES
3983 /**
3984  * Return a single letter to describe the given picture type pict_type.
3985  *
3986  * @param[in] pict_type the picture type
3987  * @return A single character representing the picture type.
3988  * @deprecated Use av_get_picture_type_char() instead.
3989  */
3990 attribute_deprecated
3991 char av_get_pict_type_char(int pict_type);
3992 #endif
3993
3994 /**
3995  * Return codec bits per sample.
3996  *
3997  * @param[in] codec_id the codec
3998  * @return Number of bits per sample or zero if unknown for the given codec.
3999  */
4000 int av_get_bits_per_sample(enum CodecID codec_id);
4001
4002 #if FF_API_OLD_SAMPLE_FMT
4003 /**
4004  * @deprecated Use av_get_bytes_per_sample() instead.
4005  */
4006 attribute_deprecated
4007 int av_get_bits_per_sample_format(enum AVSampleFormat sample_fmt);
4008 #endif
4009
4010 /* frame parsing */
4011 typedef struct AVCodecParserContext {
4012     void *priv_data;
4013     struct AVCodecParser *parser;
4014     int64_t frame_offset; /* offset of the current frame */
4015     int64_t cur_offset; /* current offset
4016                            (incremented by each av_parser_parse()) */
4017     int64_t next_frame_offset; /* offset of the next frame */
4018     /* video info */
4019     int pict_type; /* XXX: Put it back in AVCodecContext. */
4020     /**
4021      * This field is used for proper frame duration computation in lavf.
4022      * It signals, how much longer the frame duration of the current frame
4023      * is compared to normal frame duration.
4024      *
4025      * frame_duration = (1 + repeat_pict) * time_base
4026      *
4027      * It is used by codecs like H.264 to display telecined material.
4028      */
4029     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4030     int64_t pts;     /* pts of the current frame */
4031     int64_t dts;     /* dts of the current frame */
4032
4033     /* private data */
4034     int64_t last_pts;
4035     int64_t last_dts;
4036     int fetch_timestamp;
4037
4038 #define AV_PARSER_PTS_NB 4
4039     int cur_frame_start_index;
4040     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4041     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4042     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4043
4044     int flags;
4045 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4046 #define PARSER_FLAG_ONCE                      0x0002
4047 /// Set if the parser has a valid file offset
4048 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4049
4050     int64_t offset;      ///< byte offset from starting packet start
4051     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4052
4053     /**
4054      * Set by parser to 1 for key frames and 0 for non-key frames.
4055      * It is initialized to -1, so if the parser doesn't set this flag,
4056      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4057      * will be used.
4058      */
4059     int key_frame;
4060
4061     /**
4062      * Time difference in stream time base units from the pts of this
4063      * packet to the point at which the output from the decoder has converged
4064      * independent from the availability of previous frames. That is, the
4065      * frames are virtually identical no matter if decoding started from
4066      * the very first frame or from this keyframe.
4067      * Is AV_NOPTS_VALUE if unknown.
4068      * This field is not the display duration of the current frame.
4069      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
4070      * set.
4071      *
4072      * The purpose of this field is to allow seeking in streams that have no
4073      * keyframes in the conventional sense. It corresponds to the
4074      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
4075      * essential for some types of subtitle streams to ensure that all
4076      * subtitles are correctly displayed after seeking.
4077      */
4078     int64_t convergence_duration;
4079
4080     // Timestamp generation support:
4081     /**
4082      * Synchronization point for start of timestamp generation.
4083      *
4084      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4085      * (default).
4086      *
4087      * For example, this corresponds to presence of H.264 buffering period
4088      * SEI message.
4089      */
4090     int dts_sync_point;
4091
4092     /**
4093      * Offset of the current timestamp against last timestamp sync point in
4094      * units of AVCodecContext.time_base.
4095      *
4096      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4097      * contain a valid timestamp offset.
4098      *
4099      * Note that the timestamp of sync point has usually a nonzero
4100      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4101      * the next frame after timestamp sync point will be usually 1.
4102      *
4103      * For example, this corresponds to H.264 cpb_removal_delay.
4104      */
4105     int dts_ref_dts_delta;
4106
4107     /**
4108      * Presentation delay of current frame in units of AVCodecContext.time_base.
4109      *
4110      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4111      * contain valid non-negative timestamp delta (presentation time of a frame
4112      * must not lie in the past).
4113      *
4114      * This delay represents the difference between decoding and presentation
4115      * time of the frame.
4116      *
4117      * For example, this corresponds to H.264 dpb_output_delay.
4118      */
4119     int pts_dts_delta;
4120
4121     /**
4122      * Position of the packet in file.
4123      *
4124      * Analogous to cur_frame_pts/dts
4125      */
4126     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4127
4128     /**
4129      * Byte position of currently parsed frame in stream.
4130      */
4131     int64_t pos;
4132
4133     /**
4134      * Previous frame byte position.
4135      */
4136     int64_t last_pos;
4137 } AVCodecParserContext;
4138
4139 typedef struct AVCodecParser {
4140     int codec_ids[5]; /* several codec IDs are permitted */
4141     int priv_data_size;
4142     int (*parser_init)(AVCodecParserContext *s);
4143     int (*parser_parse)(AVCodecParserContext *s,
4144                         AVCodecContext *avctx,
4145                         const uint8_t **poutbuf, int *poutbuf_size,
4146                         const uint8_t *buf, int buf_size);
4147     void (*parser_close)(AVCodecParserContext *s);
4148     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4149     struct AVCodecParser *next;
4150 } AVCodecParser;
4151
4152 AVCodecParser *av_parser_next(AVCodecParser *c);
4153
4154 void av_register_codec_parser(AVCodecParser *parser);
4155 AVCodecParserContext *av_parser_init(int codec_id);
4156
4157 /**
4158  * Parse a packet.
4159  *
4160  * @param s             parser context.
4161  * @param avctx         codec context.
4162  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4163  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4164  * @param buf           input buffer.
4165  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4166  * @param pts           input presentation timestamp.
4167  * @param dts           input decoding timestamp.
4168  * @param pos           input byte position in stream.
4169  * @return the number of bytes of the input bitstream used.
4170  *
4171  * Example:
4172  * @code
4173  *   while(in_len){
4174  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4175  *                                        in_data, in_len,
4176  *                                        pts, dts, pos);
4177  *       in_data += len;
4178  *       in_len  -= len;
4179  *
4180  *       if(size)
4181  *          decode_frame(data, size);
4182  *   }
4183  * @endcode
4184  */
4185 int av_parser_parse2(AVCodecParserContext *s,
4186                      AVCodecContext *avctx,
4187                      uint8_t **poutbuf, int *poutbuf_size,
4188                      const uint8_t *buf, int buf_size,
4189                      int64_t pts, int64_t dts,
4190                      int64_t pos);
4191
4192 int av_parser_change(AVCodecParserContext *s,
4193                      AVCodecContext *avctx,
4194                      uint8_t **poutbuf, int *poutbuf_size,
4195                      const uint8_t *buf, int buf_size, int keyframe);
4196 void av_parser_close(AVCodecParserContext *s);
4197
4198
4199 typedef struct AVBitStreamFilterContext {
4200     void *priv_data;
4201     struct AVBitStreamFilter *filter;
4202     AVCodecParserContext *parser;
4203     struct AVBitStreamFilterContext *next;
4204 } AVBitStreamFilterContext;
4205
4206
4207 typedef struct AVBitStreamFilter {
4208     const char *name;
4209     int priv_data_size;
4210     int (*filter)(AVBitStreamFilterContext *bsfc,
4211                   AVCodecContext *avctx, const char *args,
4212                   uint8_t **poutbuf, int *poutbuf_size,
4213                   const uint8_t *buf, int buf_size, int keyframe);
4214     void (*close)(AVBitStreamFilterContext *bsfc);
4215     struct AVBitStreamFilter *next;
4216 } AVBitStreamFilter;
4217
4218 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4219 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4220 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4221                                AVCodecContext *avctx, const char *args,
4222                                uint8_t **poutbuf, int *poutbuf_size,
4223                                const uint8_t *buf, int buf_size, int keyframe);
4224 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4225
4226 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4227
4228 /* memory */
4229
4230 /**
4231  * Reallocate the given block if it is not large enough, otherwise do nothing.
4232  *
4233  * @see av_realloc
4234  */
4235 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4236
4237 /**
4238  * Allocate a buffer, reusing the given one if large enough.
4239  *
4240  * Contrary to av_fast_realloc the current buffer contents might not be
4241  * preserved and on error the old buffer is freed, thus no special
4242  * handling to avoid memleaks is necessary.
4243  *
4244  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4245  * @param size size of the buffer *ptr points to
4246  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4247  *                 *size 0 if an error occurred.
4248  */
4249 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4250
4251 /**
4252  * Copy image src to dst. Wraps av_picture_data_copy() above.
4253  */
4254 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4255                      enum PixelFormat pix_fmt, int width, int height);
4256
4257 /**
4258  * Crop image top and left side.
4259  */
4260 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4261                     enum PixelFormat pix_fmt, int top_band, int left_band);
4262
4263 /**
4264  * Pad image.
4265  */
4266 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4267             int padtop, int padbottom, int padleft, int padright, int *color);
4268
4269 /**
4270  * Encode extradata length to a buffer. Used by xiph codecs.
4271  *
4272  * @param s buffer to write to; must be at least (v/255+1) bytes long
4273  * @param v size of extradata in bytes
4274  * @return number of bytes written to the buffer.
4275  */
4276 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4277
4278 /**
4279  * Logs a generic warning message about a missing feature. This function is
4280  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4281  * only, and would normally not be used by applications.
4282  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4283  * a pointer to an AVClass struct
4284  * @param[in] feature string containing the name of the missing feature
4285  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4286  * If want_sample is non-zero, additional verbage will be added to the log
4287  * message which tells the user how to report samples to the development
4288  * mailing list.
4289  */
4290 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4291
4292 /**
4293  * Log a generic warning message asking for a sample. This function is
4294  * intended to be used internally by FFmpeg (libavcodec, libavformat, etc.)
4295  * only, and would normally not be used by applications.
4296  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4297  * a pointer to an AVClass struct
4298  * @param[in] msg string containing an optional message, or NULL if no message
4299  */
4300 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4301
4302 /**
4303  * Register the hardware accelerator hwaccel.
4304  */
4305 void av_register_hwaccel(AVHWAccel *hwaccel);
4306
4307 /**
4308  * If hwaccel is NULL, returns the first registered hardware accelerator,
4309  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4310  * after hwaccel, or NULL if hwaccel is the last one.
4311  */
4312 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4313
4314
4315 /**
4316  * Lock operation used by lockmgr
4317  */
4318 enum AVLockOp {
4319   AV_LOCK_CREATE,  ///< Create a mutex
4320   AV_LOCK_OBTAIN,  ///< Lock the mutex
4321   AV_LOCK_RELEASE, ///< Unlock the mutex
4322   AV_LOCK_DESTROY, ///< Free mutex resources
4323 };
4324
4325 /**
4326  * Register a user provided lock manager supporting the operations
4327  * specified by AVLockOp. mutex points to a (void *) where the
4328  * lockmgr should store/get a pointer to a user allocated mutex. It's
4329  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4330  *
4331  * @param cb User defined callback. Note: FFmpeg may invoke calls to this
4332  *           callback during the call to av_lockmgr_register().
4333  *           Thus, the application must be prepared to handle that.
4334  *           If cb is set to NULL the lockmgr will be unregistered.
4335  *           Also note that during unregistration the previously registered
4336  *           lockmgr callback may also be invoked.
4337  */
4338 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4339
4340 #endif /* AVCODEC_AVCODEC_H */