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