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

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