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