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

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