git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

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