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