libavcodec/avcodec.h

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