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