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