libavcodec/avcodec.h

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