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