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