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