libavcodec/avcodec.h

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