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

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