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

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