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

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