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 #if FF_API_DATA_POINTERS
 858 #define AV_NUM_DATA_POINTERS 4
 859 #else
 860 #define AV_NUM_DATA_POINTERS 8
 861 #endif
 862     /**
 863      * pointer to the picture/channel planes.
 864      * This might be different from the first allocated byte
 865      * - encoding: Set by user
 866      * - decoding: set by AVCodecContext.get_buffer()
 867      */
 868     uint8_t *data[AV_NUM_DATA_POINTERS];
 869
 870     /**
 871      * Size, in bytes, of the data for each picture/channel plane.
 872      *
 873      * For audio, only linesize[0] may be set. For planar audio, each channel
 874      * plane must be the same size.
 875      *
 876      * - encoding: Set by user (video only)
 877      * - decoding: set by AVCodecContext.get_buffer()
 878      */
 879     int linesize[AV_NUM_DATA_POINTERS];
 880
 881     /**
 882      * pointer to the first allocated byte of the picture. Can be used in get_buffer/release_buffer.
 883      * This isn't used by libavcodec unless the default get/release_buffer() is used.
 884      * - encoding:
 885      * - decoding:
 886      */
 887     uint8_t *base[AV_NUM_DATA_POINTERS];
 888     /**
 889      * 1 -> keyframe, 0-> not
 890      * - encoding: Set by libavcodec.
 891      * - decoding: Set by libavcodec.
 892      */
 893     int key_frame;
 894
 895     /**
 896      * Picture type of the frame, see ?_TYPE below.
 897      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
 898      * - decoding: Set by libavcodec.
 899      */
 900     enum AVPictureType pict_type;
 901
 902     /**
 903      * presentation timestamp in time_base units (time when frame should be shown to user)
 904      * If AV_NOPTS_VALUE then frame_rate = 1/time_base will be assumed.
 905      * - encoding: MUST be set by user.
 906      * - decoding: Set by libavcodec.
 907      */
 908     int64_t pts;
 909
 910     /**
 911      * picture number in bitstream order
 912      * - encoding: set by
 913      * - decoding: Set by libavcodec.
 914      */
 915     int coded_picture_number;
 916     /**
 917      * picture number in display order
 918      * - encoding: set by
 919      * - decoding: Set by libavcodec.
 920      */
 921     int display_picture_number;
 922
 923     /**
 924      * quality (between 1 (good) and FF_LAMBDA_MAX (bad))
 925      * - encoding: Set by libavcodec. for coded_picture (and set by user for input).
 926      * - decoding: Set by libavcodec.
 927      */
 928     int quality;
 929
 930 #if FF_API_AVFRAME_AGE
 931     /**
 932      * @deprecated unused
 933      */
 934     attribute_deprecated int age;
 935 #endif
 936
 937     /**
 938      * is this picture used as reference
 939      * The values for this are the same as the MpegEncContext.picture_structure
 940      * variable, that is 1->top field, 2->bottom field, 3->frame/both fields.
 941      * Set to 4 for delayed, non-reference frames.
 942      * - encoding: unused
 943      * - decoding: Set by libavcodec. (before get_buffer() call)).
 944      */
 945     int reference;
 946
 947     /**
 948      * QP table
 949      * - encoding: unused
 950      * - decoding: Set by libavcodec.
 951      */
 952     int8_t *qscale_table;
 953     /**
 954      * QP store stride
 955      * - encoding: unused
 956      * - decoding: Set by libavcodec.
 957      */
 958     int qstride;
 959
 960     /**
 961      * mbskip_table[mb]>=1 if MB didn't change
 962      * stride= mb_width = (width+15)>>4
 963      * - encoding: unused
 964      * - decoding: Set by libavcodec.
 965      */
 966     uint8_t *mbskip_table;
 967
 968     /**
 969      * motion vector table
 970      * @code
 971      * example:
 972      * int mv_sample_log2= 4 - motion_subsample_log2;
 973      * int mb_width= (width+15)>>4;
 974      * int mv_stride= (mb_width << mv_sample_log2) + 1;
 975      * motion_val[direction][x + y*mv_stride][0->mv_x, 1->mv_y];
 976      * @endcode
 977      * - encoding: Set by user.
 978      * - decoding: Set by libavcodec.
 979      */
 980     int16_t (*motion_val[2])[2];
 981
 982     /**
 983      * macroblock type table
 984      * mb_type_base + mb_width + 2
 985      * - encoding: Set by user.
 986      * - decoding: Set by libavcodec.
 987      */
 988     uint32_t *mb_type;
 989
 990     /**
 991      * log2 of the size of the block which a single vector in motion_val represents:
 992      * (4->16x16, 3->8x8, 2-> 4x4, 1-> 2x2)
 993      * - encoding: unused
 994      * - decoding: Set by libavcodec.
 995      */
 996     uint8_t motion_subsample_log2;
 997
 998     /**
 999      * for some private data of the user
1000      * - encoding: unused
1001      * - decoding: Set by user.
1002      */
1003     void *opaque;
1004
1005     /**
1006      * error
1007      * - encoding: Set by libavcodec. if flags&CODEC_FLAG_PSNR.
1008      * - decoding: unused
1009      */
1010     uint64_t error[AV_NUM_DATA_POINTERS];
1011
1012     /**
1013      * type of the buffer (to keep track of who has to deallocate data[*])
1014      * - encoding: Set by the one who allocates it.
1015      * - decoding: Set by the one who allocates it.
1016      * Note: User allocated (direct rendering) & internal buffers cannot coexist currently.
1017      */
1018     int type;
1019
1020     /**
1021      * When decoding, this signals how much the picture must be delayed.
1022      * extra_delay = repeat_pict / (2*fps)
1023      * - encoding: unused
1024      * - decoding: Set by libavcodec.
1025      */
1026     int repeat_pict;
1027
1028     /**
1029      *
1030      */
1031     int qscale_type;
1032
1033     /**
1034      * The content of the picture is interlaced.
1035      * - encoding: Set by user.
1036      * - decoding: Set by libavcodec. (default 0)
1037      */
1038     int interlaced_frame;
1039
1040     /**
1041      * If the content is interlaced, is top field displayed first.
1042      * - encoding: Set by user.
1043      * - decoding: Set by libavcodec.
1044      */
1045     int top_field_first;
1046
1047     /**
1048      * Pan scan.
1049      * - encoding: Set by user.
1050      * - decoding: Set by libavcodec.
1051      */
1052     AVPanScan *pan_scan;
1053
1054     /**
1055      * Tell user application that palette has changed from previous frame.
1056      * - encoding: ??? (no palette-enabled encoder yet)
1057      * - decoding: Set by libavcodec. (default 0).
1058      */
1059     int palette_has_changed;
1060
1061     /**
1062      * codec suggestion on buffer type if != 0
1063      * - encoding: unused
1064      * - decoding: Set by libavcodec. (before get_buffer() call)).
1065      */
1066     int buffer_hints;
1067
1068     /**
1069      * DCT coefficients
1070      * - encoding: unused
1071      * - decoding: Set by libavcodec.
1072      */
1073     short *dct_coeff;
1074
1075     /**
1076      * motion reference frame index
1077      * the order in which these are stored can depend on the codec.
1078      * - encoding: Set by user.
1079      * - decoding: Set by libavcodec.
1080      */
1081     int8_t *ref_index[2];
1082
1083     /**
1084      * reordered opaque 64bit (generally an integer or a double precision float
1085      * PTS but can be anything).
1086      * The user sets AVCodecContext.reordered_opaque to represent the input at
1087      * that time,
1088      * the decoder reorders values as needed and sets AVFrame.reordered_opaque
1089      * to exactly one of the values provided by the user through AVCodecContext.reordered_opaque
1090      * @deprecated in favor of pkt_pts
1091      * - encoding: unused
1092      * - decoding: Read by user.
1093      */
1094     int64_t reordered_opaque;
1095
1096     /**
1097      * hardware accelerator private data (Libav-allocated)
1098      * - encoding: unused
1099      * - decoding: Set by libavcodec
1100      */
1101     void *hwaccel_picture_private;
1102
1103     /**
1104      * reordered pts from the last AVPacket that has been input into the decoder
1105      * - encoding: unused
1106      * - decoding: Read by user.
1107      */
1108     int64_t pkt_pts;
1109
1110     /**
1111      * dts from the last AVPacket that has been input into the decoder
1112      * - encoding: unused
1113      * - decoding: Read by user.
1114      */
1115     int64_t pkt_dts;
1116
1117     /**
1118      * the AVCodecContext which ff_thread_get_buffer() was last called on
1119      * - encoding: Set by libavcodec.
1120      * - decoding: Set by libavcodec.
1121      */
1122     struct AVCodecContext *owner;
1123
1124     /**
1125      * used by multithreading to store frame-specific info
1126      * - encoding: Set by libavcodec.
1127      * - decoding: Set by libavcodec.
1128      */
1129     void *thread_opaque;
1130
1131     /**
1132      * number of audio samples (per channel) described by this frame
1133      * - encoding: unused
1134      * - decoding: Set by libavcodec
1135      */
1136     int nb_samples;
1137
1138     /**
1139      * pointers to the data planes/channels.
1140      *
1141      * For video, this should simply point to data[].
1142      *
1143      * For planar audio, each channel has a separate data pointer, and
1144      * linesize[0] contains the size of each channel buffer.
1145      * For packed audio, there is just one data pointer, and linesize[0]
1146      * contains the total size of the buffer for all channels.
1147      *
1148      * Note: Both data and extended_data will always be set by get_buffer(),
1149      * but for planar audio with more channels that can fit in data,
1150      * extended_data must be used by the decoder in order to access all
1151      * channels.
1152      *
1153      * encoding: unused
1154      * decoding: set by AVCodecContext.get_buffer()
1155      */
1156     uint8_t **extended_data;
1157
1158     /**
1159      * sample aspect ratio for the video frame, 0/1 if unknown\unspecified
1160      * - encoding: unused
1161      * - decoding: Read by user.
1162      */
1163     AVRational sample_aspect_ratio;
1164
1165     /**
1166      * width and height of the video frame
1167      * - encoding: unused
1168      * - decoding: Read by user.
1169      */
1170     int width, height;
1171
1172     /**
1173      * format of the frame, -1 if unknown or unset
1174      * Values correspond to enum PixelFormat for video frames,
1175      * enum AVSampleFormat for audio)
1176      * - encoding: unused
1177      * - decoding: Read by user.
1178      */
1179     int format;
1180 } AVFrame;
1181
1182 struct AVCodecInternal;
1183
1184 enum AVFieldOrder {
1185     AV_FIELD_UNKNOWN,
1186     AV_FIELD_PROGRESSIVE,
1187     AV_FIELD_TT,          //< Top coded_first, top displayed first
1188     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1189     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1190     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1191 };
1192
1193 /**
1194  * main external API structure.
1195  * New fields can be added to the end with minor version bumps.
1196  * Removal, reordering and changes to existing fields require a major
1197  * version bump.
1198  * sizeof(AVCodecContext) must not be used outside libav*.
1199  */
1200 typedef struct AVCodecContext {
1201     /**
1202      * information on struct for av_log
1203      * - set by avcodec_alloc_context3
1204      */
1205     const AVClass *av_class;
1206     /**
1207      * the average bitrate
1208      * - encoding: Set by user; unused for constant quantizer encoding.
1209      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1210      */
1211     int bit_rate;
1212
1213     /**
1214      * number of bits the bitstream is allowed to diverge from the reference.
1215      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1216      * - encoding: Set by user; unused for constant quantizer encoding.
1217      * - decoding: unused
1218      */
1219     int bit_rate_tolerance;
1220
1221     /**
1222      * CODEC_FLAG_*.
1223      * - encoding: Set by user.
1224      * - decoding: Set by user.
1225      */
1226     int flags;
1227
1228     /**
1229      * Some codecs need additional format info. It is stored here.
1230      * If any muxer uses this then ALL demuxers/parsers AND encoders for the
1231      * specific codec MUST set it correctly otherwise stream copy breaks.
1232      * In general use of this field by muxers is not recommended.
1233      * - encoding: Set by libavcodec.
1234      * - decoding: Set by libavcodec. (FIXME: Is this OK?)
1235      */
1236     int sub_id;
1237
1238     /**
1239      * Motion estimation algorithm used for video coding.
1240      * 1 (zero), 2 (full), 3 (log), 4 (phods), 5 (epzs), 6 (x1), 7 (hex),
1241      * 8 (umh), 9 (iter), 10 (tesa) [7, 8, 10 are x264 specific, 9 is snow specific]
1242      * - encoding: MUST be set by user.
1243      * - decoding: unused
1244      */
1245     int me_method;
1246
1247     /**
1248      * some codecs need / can use extradata like Huffman tables.
1249      * mjpeg: Huffman tables
1250      * rv10: additional flags
1251      * mpeg4: global headers (they can be in the bitstream or here)
1252      * The allocated memory should be FF_INPUT_BUFFER_PADDING_SIZE bytes larger
1253      * than extradata_size to avoid prolems if it is read with the bitstream reader.
1254      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1255      * - encoding: Set/allocated/freed by libavcodec.
1256      * - decoding: Set/allocated/freed by user.
1257      */
1258     uint8_t *extradata;
1259     int extradata_size;
1260
1261     /**
1262      * This is the fundamental unit of time (in seconds) in terms
1263      * of which frame timestamps are represented. For fixed-fps content,
1264      * timebase should be 1/framerate and timestamp increments should be
1265      * identically 1.
1266      * - encoding: MUST be set by user.
1267      * - decoding: Set by libavcodec.
1268      */
1269     AVRational time_base;
1270
1271     /* video only */
1272     /**
1273      * picture width / height.
1274      * - encoding: MUST be set by user.
1275      * - decoding: Set by libavcodec.
1276      * Note: For compatibility it is possible to set this instead of
1277      * coded_width/height before decoding.
1278      */
1279     int width, height;
1280
1281 #define FF_ASPECT_EXTENDED 15
1282
1283     /**
1284      * the number of pictures in a group of pictures, or 0 for intra_only
1285      * - encoding: Set by user.
1286      * - decoding: unused
1287      */
1288     int gop_size;
1289
1290     /**
1291      * Pixel format, see PIX_FMT_xxx.
1292      * May be set by the demuxer if known from headers.
1293      * May be overriden by the decoder if it knows better.
1294      * - encoding: Set by user.
1295      * - decoding: Set by user if known, overridden by libavcodec if known
1296      */
1297     enum PixelFormat pix_fmt;
1298
1299     /**
1300      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1301      * decoder to draw a horizontal band. It improves cache usage. Not
1302      * all codecs can do that. You must check the codec capabilities
1303      * beforehand.
1304      * When multithreading is used, it may be called from multiple threads
1305      * at the same time; threads might draw different parts of the same AVFrame,
1306      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1307      * in order.
1308      * The function is also used by hardware acceleration APIs.
1309      * It is called at least once during frame decoding to pass
1310      * the data needed for hardware render.
1311      * In that mode instead of pixel data, AVFrame points to
1312      * a structure specific to the acceleration API. The application
1313      * reads the structure and can change some fields to indicate progress
1314      * or mark state.
1315      * - encoding: unused
1316      * - decoding: Set by user.
1317      * @param height the height of the slice
1318      * @param y the y position of the slice
1319      * @param type 1->top field, 2->bottom field, 3->frame
1320      * @param offset offset into the AVFrame.data from which the slice should be read
1321      */
1322     void (*draw_horiz_band)(struct AVCodecContext *s,
1323                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1324                             int y, int type, int height);
1325
1326     /* audio only */
1327     int sample_rate; ///< samples per second
1328     int channels;    ///< number of audio channels
1329
1330     /**
1331      * audio sample format
1332      * - encoding: Set by user.
1333      * - decoding: Set by libavcodec.
1334      */
1335     enum AVSampleFormat sample_fmt;  ///< sample format
1336
1337     /* The following data should not be initialized. */
1338     /**
1339      * Samples per packet, initialized when calling 'init'.
1340      */
1341     int frame_size;
1342     int frame_number;   ///< audio or video frame number
1343
1344     /**
1345      * Number of frames the decoded output will be delayed relative to
1346      * the encoded input.
1347      * - encoding: Set by libavcodec.
1348      * - decoding: unused
1349      */
1350     int delay;
1351
1352     /* - encoding parameters */
1353     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
1354     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
1355
1356     /**
1357      * minimum quantizer
1358      * - encoding: Set by user.
1359      * - decoding: unused
1360      */
1361     int qmin;
1362
1363     /**
1364      * maximum quantizer
1365      * - encoding: Set by user.
1366      * - decoding: unused
1367      */
1368     int qmax;
1369
1370     /**
1371      * maximum quantizer difference between frames
1372      * - encoding: Set by user.
1373      * - decoding: unused
1374      */
1375     int max_qdiff;
1376
1377     /**
1378      * maximum number of B-frames between non-B-frames
1379      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1380      * - encoding: Set by user.
1381      * - decoding: unused
1382      */
1383     int max_b_frames;
1384
1385     /**
1386      * qscale factor between IP and B-frames
1387      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1388      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1389      * - encoding: Set by user.
1390      * - decoding: unused
1391      */
1392     float b_quant_factor;
1393
1394     /** obsolete FIXME remove */
1395     int rc_strategy;
1396 #define FF_RC_STRATEGY_XVID 1
1397
1398     int b_frame_strategy;
1399
1400     struct AVCodec *codec;
1401
1402     void *priv_data;
1403
1404     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
1405                             /* do its best to deliver a chunk with size     */
1406                             /* below rtp_payload_size, the chunk will start */
1407                             /* with a start code on some codecs like H.263. */
1408                             /* This doesn't take account of any particular  */
1409                             /* headers inside the transmitted RTP payload.  */
1410
1411
1412     /* The RTP callback: This function is called    */
1413     /* every time the encoder has a packet to send. */
1414     /* It depends on the encoder if the data starts */
1415     /* with a Start Code (it should). H.263 does.   */
1416     /* mb_nb contains the number of macroblocks     */
1417     /* encoded in the RTP payload.                  */
1418     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
1419
1420     /* statistics, used for 2-pass encoding */
1421     int mv_bits;
1422     int header_bits;
1423     int i_tex_bits;
1424     int p_tex_bits;
1425     int i_count;
1426     int p_count;
1427     int skip_count;
1428     int misc_bits;
1429
1430     /**
1431      * number of bits used for the previously encoded frame
1432      * - encoding: Set by libavcodec.
1433      * - decoding: unused
1434      */
1435     int frame_bits;
1436
1437     /**
1438      * Private data of the user, can be used to carry app specific stuff.
1439      * - encoding: Set by user.
1440      * - decoding: Set by user.
1441      */
1442     void *opaque;
1443
1444     char codec_name[32];
1445     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1446     enum CodecID codec_id; /* see CODEC_ID_xxx */
1447
1448     /**
1449      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1450      * This is used to work around some encoder bugs.
1451      * A demuxer should set this to what is stored in the field used to identify the codec.
1452      * If there are multiple such fields in a container then the demuxer should choose the one
1453      * which maximizes the information about the used codec.
1454      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1455      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1456      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1457      * first.
1458      * - encoding: Set by user, if not then the default based on codec_id will be used.
1459      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1460      */
1461     unsigned int codec_tag;
1462
1463     /**
1464      * Work around bugs in encoders which sometimes cannot be detected automatically.
1465      * - encoding: Set by user
1466      * - decoding: Set by user
1467      */
1468     int workaround_bugs;
1469 #define FF_BUG_AUTODETECT       1  ///< autodetection
1470 #define FF_BUG_OLD_MSMPEG4      2
1471 #define FF_BUG_XVID_ILACE       4
1472 #define FF_BUG_UMP4             8
1473 #define FF_BUG_NO_PADDING       16
1474 #define FF_BUG_AMV              32
1475 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
1476 #define FF_BUG_QPEL_CHROMA      64
1477 #define FF_BUG_STD_QPEL         128
1478 #define FF_BUG_QPEL_CHROMA2     256
1479 #define FF_BUG_DIRECT_BLOCKSIZE 512
1480 #define FF_BUG_EDGE             1024
1481 #define FF_BUG_HPEL_CHROMA      2048
1482 #define FF_BUG_DC_CLIP          4096
1483 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
1484 #define FF_BUG_TRUNCATED       16384
1485 //#define FF_BUG_FAKE_SCALABILITY 16 //Autodetection should work 100%.
1486
1487     /**
1488      * luma single coefficient elimination threshold
1489      * - encoding: Set by user.
1490      * - decoding: unused
1491      */
1492     int luma_elim_threshold;
1493
1494     /**
1495      * chroma single coeff elimination threshold
1496      * - encoding: Set by user.
1497      * - decoding: unused
1498      */
1499     int chroma_elim_threshold;
1500
1501     /**
1502      * strictly follow the standard (MPEG4, ...).
1503      * - encoding: Set by user.
1504      * - decoding: Set by user.
1505      * Setting this to STRICT or higher means the encoder and decoder will
1506      * generally do stupid things, whereas setting it to unofficial or lower
1507      * will mean the encoder might produce output that is not supported by all
1508      * spec-compliant decoders. Decoders don't differentiate between normal,
1509      * unofficial and experimental (that is, they always try to decode things
1510      * when they can) unless they are explicitly asked to behave stupidly
1511      * (=strictly conform to the specs)
1512      */
1513     int strict_std_compliance;
1514 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
1515 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
1516 #define FF_COMPLIANCE_NORMAL        0
1517 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
1518 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
1519
1520     /**
1521      * qscale offset between IP and B-frames
1522      * - encoding: Set by user.
1523      * - decoding: unused
1524      */
1525     float b_quant_offset;
1526
1527     /**
1528      * Called at the beginning of each frame to get a buffer for it.
1529      *
1530      * The function will set AVFrame.data[], AVFrame.linesize[].
1531      * AVFrame.extended_data[] must also be set, but it should be the same as
1532      * AVFrame.data[] except for planar audio with more channels than can fit
1533      * in AVFrame.data[]. In that case, AVFrame.data[] shall still contain as
1534      * many data pointers as it can hold.
1535      *
1536      * if CODEC_CAP_DR1 is not set then get_buffer() must call
1537      * avcodec_default_get_buffer() instead of providing buffers allocated by
1538      * some other means.
1539      *
1540      * AVFrame.data[] should be 32- or 16-byte-aligned unless the CPU doesn't
1541      * need it. avcodec_default_get_buffer() aligns the output buffer properly,
1542      * but if get_buffer() is overridden then alignment considerations should
1543      * be taken into account.
1544      *
1545      * @see avcodec_default_get_buffer()
1546      *
1547      * Video:
1548      *
1549      * If pic.reference is set then the frame will be read later by libavcodec.
1550      * avcodec_align_dimensions2() should be used to find the required width and
1551      * height, as they normally need to be rounded up to the next multiple of 16.
1552      *
1553      * If frame multithreading is used and thread_safe_callbacks is set,
1554      * it may be called from a different thread, but not from more than one at
1555      * once. Does not need to be reentrant.
1556      *
1557      * @see release_buffer(), reget_buffer()
1558      * @see avcodec_align_dimensions2()
1559      *
1560      * Audio:
1561      *
1562      * Decoders request a buffer of a particular size by setting
1563      * AVFrame.nb_samples prior to calling get_buffer(). The decoder may,
1564      * however, utilize only part of the buffer by setting AVFrame.nb_samples
1565      * to a smaller value in the output frame.
1566      *
1567      * Decoders cannot use the buffer after returning from
1568      * avcodec_decode_audio4(), so they will not call release_buffer(), as it
1569      * is assumed to be released immediately upon return.
1570      *
1571      * As a convenience, av_samples_get_buffer_size() and
1572      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer()
1573      * functions to find the required data size and to fill data pointers and
1574      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
1575      * since all planes must be the same size.
1576      *
1577      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
1578      *
1579      * - encoding: unused
1580      * - decoding: Set by libavcodec, user can override.
1581      */
1582     int (*get_buffer)(struct AVCodecContext *c, AVFrame *pic);
1583
1584     /**
1585      * Called to release buffers which were allocated with get_buffer.
1586      * A released buffer can be reused in get_buffer().
1587      * pic.data[*] must be set to NULL.
1588      * May be called from a different thread if frame multithreading is used,
1589      * but not by more than one thread at once, so does not need to be reentrant.
1590      * - encoding: unused
1591      * - decoding: Set by libavcodec, user can override.
1592      */
1593     void (*release_buffer)(struct AVCodecContext *c, AVFrame *pic);
1594
1595     /**
1596      * Size of the frame reordering buffer in the decoder.
1597      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1598      * - encoding: Set by libavcodec.
1599      * - decoding: Set by libavcodec.
1600      */
1601     int has_b_frames;
1602
1603     /**
1604      * number of bytes per packet if constant and known or 0
1605      * Used by some WAV based audio codecs.
1606      */
1607     int block_align;
1608
1609     /**
1610      * 0-> h263 quant 1-> mpeg quant
1611      * - encoding: Set by user.
1612      * - decoding: unused
1613      */
1614     int mpeg_quant;
1615
1616     /**
1617      * pass1 encoding statistics output buffer
1618      * - encoding: Set by libavcodec.
1619      * - decoding: unused
1620      */
1621     char *stats_out;
1622
1623     /**
1624      * pass2 encoding statistics input buffer
1625      * Concatenated stuff from stats_out of pass1 should be placed here.
1626      * - encoding: Allocated/set/freed by user.
1627      * - decoding: unused
1628      */
1629     char *stats_in;
1630
1631     /**
1632      * ratecontrol qmin qmax limiting method
1633      * 0-> clipping, 1-> use a nice continous function to limit qscale wthin qmin/qmax.
1634      * - encoding: Set by user.
1635      * - decoding: unused
1636      */
1637     float rc_qsquish;
1638
1639     float rc_qmod_amp;
1640     int rc_qmod_freq;
1641
1642     /**
1643      * ratecontrol override, see RcOverride
1644      * - encoding: Allocated/set/freed by user.
1645      * - decoding: unused
1646      */
1647     RcOverride *rc_override;
1648     int rc_override_count;
1649
1650     /**
1651      * rate control equation
1652      * - encoding: Set by user
1653      * - decoding: unused
1654      */
1655     const char *rc_eq;
1656
1657     /**
1658      * maximum bitrate
1659      * - encoding: Set by user.
1660      * - decoding: unused
1661      */
1662     int rc_max_rate;
1663
1664     /**
1665      * minimum bitrate
1666      * - encoding: Set by user.
1667      * - decoding: unused
1668      */
1669     int rc_min_rate;
1670
1671     /**
1672      * decoder bitstream buffer size
1673      * - encoding: Set by user.
1674      * - decoding: unused
1675      */
1676     int rc_buffer_size;
1677     float rc_buffer_aggressivity;
1678
1679     /**
1680      * qscale factor between P and I-frames
1681      * If > 0 then the last p frame quantizer will be used (q= lastp_q*factor+offset).
1682      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1683      * - encoding: Set by user.
1684      * - decoding: unused
1685      */
1686     float i_quant_factor;
1687
1688     /**
1689      * qscale offset between P and I-frames
1690      * - encoding: Set by user.
1691      * - decoding: unused
1692      */
1693     float i_quant_offset;
1694
1695     /**
1696      * initial complexity for pass1 ratecontrol
1697      * - encoding: Set by user.
1698      * - decoding: unused
1699      */
1700     float rc_initial_cplx;
1701
1702     /**
1703      * DCT algorithm, see FF_DCT_* below
1704      * - encoding: Set by user.
1705      * - decoding: unused
1706      */
1707     int dct_algo;
1708 #define FF_DCT_AUTO    0
1709 #define FF_DCT_FASTINT 1
1710 #define FF_DCT_INT     2
1711 #define FF_DCT_MMX     3
1712 #define FF_DCT_MLIB    4
1713 #define FF_DCT_ALTIVEC 5
1714 #define FF_DCT_FAAN    6
1715
1716     /**
1717      * luminance masking (0-> disabled)
1718      * - encoding: Set by user.
1719      * - decoding: unused
1720      */
1721     float lumi_masking;
1722
1723     /**
1724      * temporary complexity masking (0-> disabled)
1725      * - encoding: Set by user.
1726      * - decoding: unused
1727      */
1728     float temporal_cplx_masking;
1729
1730     /**
1731      * spatial complexity masking (0-> disabled)
1732      * - encoding: Set by user.
1733      * - decoding: unused
1734      */
1735     float spatial_cplx_masking;
1736
1737     /**
1738      * p block masking (0-> disabled)
1739      * - encoding: Set by user.
1740      * - decoding: unused
1741      */
1742     float p_masking;
1743
1744     /**
1745      * darkness masking (0-> disabled)
1746      * - encoding: Set by user.
1747      * - decoding: unused
1748      */
1749     float dark_masking;
1750
1751     /**
1752      * IDCT algorithm, see FF_IDCT_* below.
1753      * - encoding: Set by user.
1754      * - decoding: Set by user.
1755      */
1756     int idct_algo;
1757 #define FF_IDCT_AUTO          0
1758 #define FF_IDCT_INT           1
1759 #define FF_IDCT_SIMPLE        2
1760 #define FF_IDCT_SIMPLEMMX     3
1761 #define FF_IDCT_LIBMPEG2MMX   4
1762 #define FF_IDCT_PS2           5
1763 #define FF_IDCT_MLIB          6
1764 #define FF_IDCT_ARM           7
1765 #define FF_IDCT_ALTIVEC       8
1766 #define FF_IDCT_SH4           9
1767 #define FF_IDCT_SIMPLEARM     10
1768 #define FF_IDCT_H264          11
1769 #define FF_IDCT_VP3           12
1770 #define FF_IDCT_IPP           13
1771 #define FF_IDCT_XVIDMMX       14
1772 #define FF_IDCT_CAVS          15
1773 #define FF_IDCT_SIMPLEARMV5TE 16
1774 #define FF_IDCT_SIMPLEARMV6   17
1775 #define FF_IDCT_SIMPLEVIS     18
1776 #define FF_IDCT_WMV2          19
1777 #define FF_IDCT_FAAN          20
1778 #define FF_IDCT_EA            21
1779 #define FF_IDCT_SIMPLENEON    22
1780 #define FF_IDCT_SIMPLEALPHA   23
1781 #define FF_IDCT_BINK          24
1782
1783     /**
1784      * slice count
1785      * - encoding: Set by libavcodec.
1786      * - decoding: Set by user (or 0).
1787      */
1788     int slice_count;
1789     /**
1790      * slice offsets in the frame in bytes
1791      * - encoding: Set/allocated by libavcodec.
1792      * - decoding: Set/allocated by user (or NULL).
1793      */
1794     int *slice_offset;
1795
1796     /**
1797      * error concealment flags
1798      * - encoding: unused
1799      * - decoding: Set by user.
1800      */
1801     int error_concealment;
1802 #define FF_EC_GUESS_MVS   1
1803 #define FF_EC_DEBLOCK     2
1804
1805     /**
1806      * dsp_mask could be add used to disable unwanted CPU features
1807      * CPU features (i.e. MMX, SSE. ...)
1808      *
1809      * With the FORCE flag you may instead enable given CPU features.
1810      * (Dangerous: Usable in case of misdetection, improper usage however will
1811      * result into program crash.)
1812      */
1813     unsigned dsp_mask;
1814
1815     /**
1816      * bits per sample/pixel from the demuxer (needed for huffyuv).
1817      * - encoding: Set by libavcodec.
1818      * - decoding: Set by user.
1819      */
1820      int bits_per_coded_sample;
1821
1822     /**
1823      * prediction method (needed for huffyuv)
1824      * - encoding: Set by user.
1825      * - decoding: unused
1826      */
1827      int prediction_method;
1828 #define FF_PRED_LEFT   0
1829 #define FF_PRED_PLANE  1
1830 #define FF_PRED_MEDIAN 2
1831
1832     /**
1833      * sample aspect ratio (0 if unknown)
1834      * That is the width of a pixel divided by the height of the pixel.
1835      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1836      * - encoding: Set by user.
1837      * - decoding: Set by libavcodec.
1838      */
1839     AVRational sample_aspect_ratio;
1840
1841     /**
1842      * the picture in the bitstream
1843      * - encoding: Set by libavcodec.
1844      * - decoding: Set by libavcodec.
1845      */
1846     AVFrame *coded_frame;
1847
1848     /**
1849      * debug
1850      * - encoding: Set by user.
1851      * - decoding: Set by user.
1852      */
1853     int debug;
1854 #define FF_DEBUG_PICT_INFO   1
1855 #define FF_DEBUG_RC          2
1856 #define FF_DEBUG_BITSTREAM   4
1857 #define FF_DEBUG_MB_TYPE     8
1858 #define FF_DEBUG_QP          16
1859 #define FF_DEBUG_MV          32
1860 #define FF_DEBUG_DCT_COEFF   0x00000040
1861 #define FF_DEBUG_SKIP        0x00000080
1862 #define FF_DEBUG_STARTCODE   0x00000100
1863 #define FF_DEBUG_PTS         0x00000200
1864 #define FF_DEBUG_ER          0x00000400
1865 #define FF_DEBUG_MMCO        0x00000800
1866 #define FF_DEBUG_BUGS        0x00001000
1867 #define FF_DEBUG_VIS_QP      0x00002000
1868 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
1869 #define FF_DEBUG_BUFFERS     0x00008000
1870 #define FF_DEBUG_THREADS     0x00010000
1871
1872     /**
1873      * debug
1874      * - encoding: Set by user.
1875      * - decoding: Set by user.
1876      */
1877     int debug_mv;
1878 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
1879 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
1880 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
1881
1882     /**
1883      * error
1884      * - encoding: Set by libavcodec if flags&CODEC_FLAG_PSNR.
1885      * - decoding: unused
1886      */
1887     uint64_t error[AV_NUM_DATA_POINTERS];
1888
1889     /**
1890      * motion estimation comparison function
1891      * - encoding: Set by user.
1892      * - decoding: unused
1893      */
1894     int me_cmp;
1895     /**
1896      * subpixel motion estimation comparison function
1897      * - encoding: Set by user.
1898      * - decoding: unused
1899      */
1900     int me_sub_cmp;
1901     /**
1902      * macroblock comparison function (not supported yet)
1903      * - encoding: Set by user.
1904      * - decoding: unused
1905      */
1906     int mb_cmp;
1907     /**
1908      * interlaced DCT comparison function
1909      * - encoding: Set by user.
1910      * - decoding: unused
1911      */
1912     int ildct_cmp;
1913 #define FF_CMP_SAD    0
1914 #define FF_CMP_SSE    1
1915 #define FF_CMP_SATD   2
1916 #define FF_CMP_DCT    3
1917 #define FF_CMP_PSNR   4
1918 #define FF_CMP_BIT    5
1919 #define FF_CMP_RD     6
1920 #define FF_CMP_ZERO   7
1921 #define FF_CMP_VSAD   8
1922 #define FF_CMP_VSSE   9
1923 #define FF_CMP_NSSE   10
1924 #define FF_CMP_W53    11
1925 #define FF_CMP_W97    12
1926 #define FF_CMP_DCTMAX 13
1927 #define FF_CMP_DCT264 14
1928 #define FF_CMP_CHROMA 256
1929
1930     /**
1931      * ME diamond size & shape
1932      * - encoding: Set by user.
1933      * - decoding: unused
1934      */
1935     int dia_size;
1936
1937     /**
1938      * amount of previous MV predictors (2a+1 x 2a+1 square)
1939      * - encoding: Set by user.
1940      * - decoding: unused
1941      */
1942     int last_predictor_count;
1943
1944     /**
1945      * prepass for motion estimation
1946      * - encoding: Set by user.
1947      * - decoding: unused
1948      */
1949     int pre_me;
1950
1951     /**
1952      * motion estimation prepass comparison function
1953      * - encoding: Set by user.
1954      * - decoding: unused
1955      */
1956     int me_pre_cmp;
1957
1958     /**
1959      * ME prepass diamond size & shape
1960      * - encoding: Set by user.
1961      * - decoding: unused
1962      */
1963     int pre_dia_size;
1964
1965     /**
1966      * subpel ME quality
1967      * - encoding: Set by user.
1968      * - decoding: unused
1969      */
1970     int me_subpel_quality;
1971
1972     /**
1973      * callback to negotiate the pixelFormat
1974      * @param fmt is the list of formats which are supported by the codec,
1975      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1976      * The first is always the native one.
1977      * @return the chosen format
1978      * - encoding: unused
1979      * - decoding: Set by user, if not set the native format will be chosen.
1980      */
1981     enum PixelFormat (*get_format)(struct AVCodecContext *s, const enum PixelFormat * fmt);
1982
1983     /**
1984      * DTG active format information (additional aspect ratio
1985      * information only used in DVB MPEG-2 transport streams)
1986      * 0 if not set.
1987      *
1988      * - encoding: unused
1989      * - decoding: Set by decoder.
1990      */
1991     int dtg_active_format;
1992 #define FF_DTG_AFD_SAME         8
1993 #define FF_DTG_AFD_4_3          9
1994 #define FF_DTG_AFD_16_9         10
1995 #define FF_DTG_AFD_14_9         11
1996 #define FF_DTG_AFD_4_3_SP_14_9  13
1997 #define FF_DTG_AFD_16_9_SP_14_9 14
1998 #define FF_DTG_AFD_SP_4_3       15
1999
2000     /**
2001      * maximum motion estimation search range in subpel units
2002      * If 0 then no limit.
2003      *
2004      * - encoding: Set by user.
2005      * - decoding: unused
2006      */
2007     int me_range;
2008
2009     /**
2010      * intra quantizer bias
2011      * - encoding: Set by user.
2012      * - decoding: unused
2013      */
2014     int intra_quant_bias;
2015 #define FF_DEFAULT_QUANT_BIAS 999999
2016
2017     /**
2018      * inter quantizer bias
2019      * - encoding: Set by user.
2020      * - decoding: unused
2021      */
2022     int inter_quant_bias;
2023
2024     /**
2025      * color table ID
2026      * - encoding: unused
2027      * - decoding: Which clrtable should be used for 8bit RGB images.
2028      *             Tables have to be stored somewhere. FIXME
2029      */
2030     int color_table_id;
2031
2032     /**
2033      * Global quality for codecs which cannot change it per frame.
2034      * This should be proportional to MPEG-1/2/4 qscale.
2035      * - encoding: Set by user.
2036      * - decoding: unused
2037      */
2038     int global_quality;
2039
2040 #define FF_CODER_TYPE_VLC       0
2041 #define FF_CODER_TYPE_AC        1
2042 #define FF_CODER_TYPE_RAW       2
2043 #define FF_CODER_TYPE_RLE       3
2044 #define FF_CODER_TYPE_DEFLATE   4
2045     /**
2046      * coder type
2047      * - encoding: Set by user.
2048      * - decoding: unused
2049      */
2050     int coder_type;
2051
2052     /**
2053      * context model
2054      * - encoding: Set by user.
2055      * - decoding: unused
2056      */
2057     int context_model;
2058 #if 0
2059     /**
2060      *
2061      * - encoding: unused
2062      * - decoding: Set by user.
2063      */
2064     uint8_t * (*realloc)(struct AVCodecContext *s, uint8_t *buf, int buf_size);
2065 #endif
2066
2067     /**
2068      * slice flags
2069      * - encoding: unused
2070      * - decoding: Set by user.
2071      */
2072     int slice_flags;
2073 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2074 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG2 field pics)
2075 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2076
2077     /**
2078      * XVideo Motion Acceleration
2079      * - encoding: forbidden
2080      * - decoding: set by decoder
2081      */
2082     int xvmc_acceleration;
2083
2084     /**
2085      * macroblock decision mode
2086      * - encoding: Set by user.
2087      * - decoding: unused
2088      */
2089     int mb_decision;
2090 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2091 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2092 #define FF_MB_DECISION_RD     2        ///< rate distortion
2093
2094     /**
2095      * custom intra quantization matrix
2096      * - encoding: Set by user, can be NULL.
2097      * - decoding: Set by libavcodec.
2098      */
2099     uint16_t *intra_matrix;
2100
2101     /**
2102      * custom inter quantization matrix
2103      * - encoding: Set by user, can be NULL.
2104      * - decoding: Set by libavcodec.
2105      */
2106     uint16_t *inter_matrix;
2107
2108     /**
2109      * fourcc from the AVI stream header (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
2110      * This is used to work around some encoder bugs.
2111      * - encoding: unused
2112      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
2113      */
2114     unsigned int stream_codec_tag;
2115
2116     /**
2117      * scene change detection threshold
2118      * 0 is default, larger means fewer detected scene changes.
2119      * - encoding: Set by user.
2120      * - decoding: unused
2121      */
2122     int scenechange_threshold;
2123
2124     /**
2125      * minimum Lagrange multipler
2126      * - encoding: Set by user.
2127      * - decoding: unused
2128      */
2129     int lmin;
2130
2131     /**
2132      * maximum Lagrange multipler
2133      * - encoding: Set by user.
2134      * - decoding: unused
2135      */
2136     int lmax;
2137
2138     /**
2139      * noise reduction strength
2140      * - encoding: Set by user.
2141      * - decoding: unused
2142      */
2143     int noise_reduction;
2144
2145     /**
2146      * Called at the beginning of a frame to get cr buffer for it.
2147      * Buffer type (size, hints) must be the same. libavcodec won't check it.
2148      * libavcodec will pass previous buffer in pic, function should return
2149      * same buffer or new buffer with old frame "painted" into it.
2150      * If pic.data[0] == NULL must behave like get_buffer().
2151      * if CODEC_CAP_DR1 is not set then reget_buffer() must call
2152      * avcodec_default_reget_buffer() instead of providing buffers allocated by
2153      * some other means.
2154      * - encoding: unused
2155      * - decoding: Set by libavcodec, user can override.
2156      */
2157     int (*reget_buffer)(struct AVCodecContext *c, AVFrame *pic);
2158
2159     /**
2160      * Number of bits which should be loaded into the rc buffer before decoding starts.
2161      * - encoding: Set by user.
2162      * - decoding: unused
2163      */
2164     int rc_initial_buffer_occupancy;
2165
2166     /**
2167      *
2168      * - encoding: Set by user.
2169      * - decoding: unused
2170      */
2171     int inter_threshold;
2172
2173     /**
2174      * CODEC_FLAG2_*
2175      * - encoding: Set by user.
2176      * - decoding: Set by user.
2177      */
2178     int flags2;
2179
2180     /**
2181      * Simulates errors in the bitstream to test error concealment.
2182      * - encoding: Set by user.
2183      * - decoding: unused
2184      */
2185     int error_rate;
2186
2187     /**
2188      * quantizer noise shaping
2189      * - encoding: Set by user.
2190      * - decoding: unused
2191      */
2192     int quantizer_noise_shaping;
2193
2194     /**
2195      * thread count
2196      * is used to decide how many independent tasks should be passed to execute()
2197      * - encoding: Set by user.
2198      * - decoding: Set by user.
2199      */
2200     int thread_count;
2201
2202     /**
2203      * The codec may call this to execute several independent things.
2204      * It will return only after finishing all tasks.
2205      * The user may replace this with some multithreaded implementation,
2206      * the default implementation will execute the parts serially.
2207      * @param count the number of things to execute
2208      * - encoding: Set by libavcodec, user can override.
2209      * - decoding: Set by libavcodec, user can override.
2210      */
2211     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2212
2213     /**
2214      * thread opaque
2215      * Can be used by execute() to store some per AVCodecContext stuff.
2216      * - encoding: set by execute()
2217      * - decoding: set by execute()
2218      */
2219     void *thread_opaque;
2220
2221     /**
2222      * Motion estimation threshold below which no motion estimation is
2223      * performed, but instead the user specified motion vectors are used.
2224      *
2225      * - encoding: Set by user.
2226      * - decoding: unused
2227      */
2228      int me_threshold;
2229
2230     /**
2231      * Macroblock threshold below which the user specified macroblock types will be used.
2232      * - encoding: Set by user.
2233      * - decoding: unused
2234      */
2235      int mb_threshold;
2236
2237     /**
2238      * precision of the intra DC coefficient - 8
2239      * - encoding: Set by user.
2240      * - decoding: unused
2241      */
2242      int intra_dc_precision;
2243
2244     /**
2245      * noise vs. sse weight for the nsse comparsion function
2246      * - encoding: Set by user.
2247      * - decoding: unused
2248      */
2249      int nsse_weight;
2250
2251     /**
2252      * Number of macroblock rows at the top which are skipped.
2253      * - encoding: unused
2254      * - decoding: Set by user.
2255      */
2256      int skip_top;
2257
2258     /**
2259      * Number of macroblock rows at the bottom which are skipped.
2260      * - encoding: unused
2261      * - decoding: Set by user.
2262      */
2263      int skip_bottom;
2264
2265     /**
2266      * profile
2267      * - encoding: Set by user.
2268      * - decoding: Set by libavcodec.
2269      */
2270      int profile;
2271 #define FF_PROFILE_UNKNOWN -99
2272 #define FF_PROFILE_RESERVED -100
2273
2274 #define FF_PROFILE_AAC_MAIN 0
2275 #define FF_PROFILE_AAC_LOW  1
2276 #define FF_PROFILE_AAC_SSR  2
2277 #define FF_PROFILE_AAC_LTP  3
2278
2279 #define FF_PROFILE_DTS         20
2280 #define FF_PROFILE_DTS_ES      30
2281 #define FF_PROFILE_DTS_96_24   40
2282 #define FF_PROFILE_DTS_HD_HRA  50
2283 #define FF_PROFILE_DTS_HD_MA   60
2284
2285 #define FF_PROFILE_MPEG2_422    0
2286 #define FF_PROFILE_MPEG2_HIGH   1
2287 #define FF_PROFILE_MPEG2_SS     2
2288 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2289 #define FF_PROFILE_MPEG2_MAIN   4
2290 #define FF_PROFILE_MPEG2_SIMPLE 5
2291
2292 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2293 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2294
2295 #define FF_PROFILE_H264_BASELINE             66
2296 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2297 #define FF_PROFILE_H264_MAIN                 77
2298 #define FF_PROFILE_H264_EXTENDED             88
2299 #define FF_PROFILE_H264_HIGH                 100
2300 #define FF_PROFILE_H264_HIGH_10              110
2301 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2302 #define FF_PROFILE_H264_HIGH_422             122
2303 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2304 #define FF_PROFILE_H264_HIGH_444             144
2305 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2306 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2307 #define FF_PROFILE_H264_CAVLC_444            44
2308
2309 #define FF_PROFILE_VC1_SIMPLE   0
2310 #define FF_PROFILE_VC1_MAIN     1
2311 #define FF_PROFILE_VC1_COMPLEX  2
2312 #define FF_PROFILE_VC1_ADVANCED 3
2313
2314 #define FF_PROFILE_MPEG4_SIMPLE                     0
2315 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2316 #define FF_PROFILE_MPEG4_CORE                       2
2317 #define FF_PROFILE_MPEG4_MAIN                       3
2318 #define FF_PROFILE_MPEG4_N_BIT                      4
2319 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2320 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2321 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2322 #define FF_PROFILE_MPEG4_HYBRID                     8
2323 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2324 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2325 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2326 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2327 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2328 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2329 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2330
2331     /**
2332      * level
2333      * - encoding: Set by user.
2334      * - decoding: Set by libavcodec.
2335      */
2336      int level;
2337 #define FF_LEVEL_UNKNOWN -99
2338
2339     /**
2340      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2341      * - encoding: unused
2342      * - decoding: Set by user.
2343      */
2344      int lowres;
2345
2346     /**
2347      * Bitstream width / height, may be different from width/height if lowres enabled.
2348      * - encoding: unused
2349      * - decoding: Set by user before init if known. Codec should override / dynamically change if needed.
2350      */
2351     int coded_width, coded_height;
2352
2353     /**
2354      * frame skip threshold
2355      * - encoding: Set by user.
2356      * - decoding: unused
2357      */
2358     int frame_skip_threshold;
2359
2360     /**
2361      * frame skip factor
2362      * - encoding: Set by user.
2363      * - decoding: unused
2364      */
2365     int frame_skip_factor;
2366
2367     /**
2368      * frame skip exponent
2369      * - encoding: Set by user.
2370      * - decoding: unused
2371      */
2372     int frame_skip_exp;
2373
2374     /**
2375      * frame skip comparison function
2376      * - encoding: Set by user.
2377      * - decoding: unused
2378      */
2379     int frame_skip_cmp;
2380
2381     /**
2382      * Border processing masking, raises the quantizer for mbs on the borders
2383      * of the picture.
2384      * - encoding: Set by user.
2385      * - decoding: unused
2386      */
2387     float border_masking;
2388
2389     /**
2390      * minimum MB lagrange multipler
2391      * - encoding: Set by user.
2392      * - decoding: unused
2393      */
2394     int mb_lmin;
2395
2396     /**
2397      * maximum MB lagrange multipler
2398      * - encoding: Set by user.
2399      * - decoding: unused
2400      */
2401     int mb_lmax;
2402
2403     /**
2404      *
2405      * - encoding: Set by user.
2406      * - decoding: unused
2407      */
2408     int me_penalty_compensation;
2409
2410     /**
2411      *
2412      * - encoding: unused
2413      * - decoding: Set by user.
2414      */
2415     enum AVDiscard skip_loop_filter;
2416
2417     /**
2418      *
2419      * - encoding: unused
2420      * - decoding: Set by user.
2421      */
2422     enum AVDiscard skip_idct;
2423
2424     /**
2425      *
2426      * - encoding: unused
2427      * - decoding: Set by user.
2428      */
2429     enum AVDiscard skip_frame;
2430
2431     /**
2432      *
2433      * - encoding: Set by user.
2434      * - decoding: unused
2435      */
2436     int bidir_refine;
2437
2438     /**
2439      *
2440      * - encoding: Set by user.
2441      * - decoding: unused
2442      */
2443     int brd_scale;
2444
2445     /**
2446      * minimum GOP size
2447      * - encoding: Set by user.
2448      * - decoding: unused
2449      */
2450     int keyint_min;
2451
2452     /**
2453      * number of reference frames
2454      * - encoding: Set by user.
2455      * - decoding: Set by lavc.
2456      */
2457     int refs;
2458
2459     /**
2460      * chroma qp offset from luma
2461      * - encoding: Set by user.
2462      * - decoding: unused
2463      */
2464     int chromaoffset;
2465
2466     /**
2467      * trellis RD quantization
2468      * - encoding: Set by user.
2469      * - decoding: unused
2470      */
2471     int trellis;
2472
2473     /**
2474      * Audio cutoff bandwidth (0 means "automatic")
2475      * - encoding: Set by user.
2476      * - decoding: unused
2477      */
2478     int cutoff;
2479
2480     /**
2481      * Multiplied by qscale for each frame and added to scene_change_score.
2482      * - encoding: Set by user.
2483      * - decoding: unused
2484      */
2485     int scenechange_factor;
2486
2487     /**
2488      *
2489      * Note: Value depends upon the compare function used for fullpel ME.
2490      * - encoding: Set by user.
2491      * - decoding: unused
2492      */
2493     int mv0_threshold;
2494
2495     /**
2496      * Adjust sensitivity of b_frame_strategy 1.
2497      * - encoding: Set by user.
2498      * - decoding: unused
2499      */
2500     int b_sensitivity;
2501
2502     /**
2503      * - encoding: Set by user.
2504      * - decoding: unused
2505      */
2506     int compression_level;
2507 #define FF_COMPRESSION_DEFAULT -1
2508
2509     /**
2510      * - encoding: Set by user.
2511      * - decoding: unused
2512      */
2513     int min_prediction_order;
2514
2515     /**
2516      * - encoding: Set by user.
2517      * - decoding: unused
2518      */
2519     int max_prediction_order;
2520
2521     /**
2522      * GOP timecode frame start number, in non drop frame format
2523      * - encoding: Set by user.
2524      * - decoding: unused
2525      */
2526     int64_t timecode_frame_start;
2527
2528 #if FF_API_REQUEST_CHANNELS
2529     /**
2530      * Decoder should decode to this many channels if it can (0 for default)
2531      * - encoding: unused
2532      * - decoding: Set by user.
2533      * @deprecated Deprecated in favor of request_channel_layout.
2534      */
2535     int request_channels;
2536 #endif
2537
2538     /**
2539      * opaque 64bit number (generally a PTS) that will be reordered and
2540      * output in AVFrame.reordered_opaque
2541      * @deprecated in favor of pkt_pts
2542      * - encoding: unused
2543      * - decoding: Set by user.
2544      */
2545     int64_t reordered_opaque;
2546
2547     /**
2548      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2549      * - encoding: set by user.
2550      * - decoding: set by libavcodec.
2551      */
2552     int bits_per_raw_sample;
2553
2554     /**
2555      * Audio channel layout.
2556      * - encoding: set by user.
2557      * - decoding: set by libavcodec.
2558      */
2559     uint64_t channel_layout;
2560
2561     /**
2562      * Request decoder to use this channel layout if it can (0 for default)
2563      * - encoding: unused
2564      * - decoding: Set by user.
2565      */
2566     uint64_t request_channel_layout;
2567
2568     /**
2569      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2570      * - encoding: Set by user.
2571      * - decoding: unused.
2572      */
2573     float rc_max_available_vbv_use;
2574
2575     /**
2576      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2577      * - encoding: Set by user.
2578      * - decoding: unused.
2579      */
2580     float rc_min_vbv_overflow_use;
2581
2582     /**
2583      * Hardware accelerator in use
2584      * - encoding: unused.
2585      * - decoding: Set by libavcodec
2586      */
2587     struct AVHWAccel *hwaccel;
2588
2589     /**
2590      * For some codecs, the time base is closer to the field rate than the frame rate.
2591      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
2592      * if no telecine is used ...
2593      *
2594      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
2595      */
2596     int ticks_per_frame;
2597
2598     /**
2599      * Hardware accelerator context.
2600      * For some hardware accelerators, a global context needs to be
2601      * provided by the user. In that case, this holds display-dependent
2602      * data Libav cannot instantiate itself. Please refer to the
2603      * Libav HW accelerator documentation to know how to fill this
2604      * is. e.g. for VA API, this is a struct vaapi_context.
2605      * - encoding: unused
2606      * - decoding: Set by user
2607      */
2608     void *hwaccel_context;
2609
2610     /**
2611      * Chromaticity coordinates of the source primaries.
2612      * - encoding: Set by user
2613      * - decoding: Set by libavcodec
2614      */
2615     enum AVColorPrimaries color_primaries;
2616
2617     /**
2618      * Color Transfer Characteristic.
2619      * - encoding: Set by user
2620      * - decoding: Set by libavcodec
2621      */
2622     enum AVColorTransferCharacteristic color_trc;
2623
2624     /**
2625      * YUV colorspace type.
2626      * - encoding: Set by user
2627      * - decoding: Set by libavcodec
2628      */
2629     enum AVColorSpace colorspace;
2630
2631     /**
2632      * MPEG vs JPEG YUV range.
2633      * - encoding: Set by user
2634      * - decoding: Set by libavcodec
2635      */
2636     enum AVColorRange color_range;
2637
2638     /**
2639      * This defines the location of chroma samples.
2640      * - encoding: Set by user
2641      * - decoding: Set by libavcodec
2642      */
2643     enum AVChromaLocation chroma_sample_location;
2644
2645     /**
2646      * The codec may call this to execute several independent things.
2647      * It will return only after finishing all tasks.
2648      * The user may replace this with some multithreaded implementation,
2649      * the default implementation will execute the parts serially.
2650      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2651      * @param c context passed also to func
2652      * @param count the number of things to execute
2653      * @param arg2 argument passed unchanged to func
2654      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2655      * @param func function that will be called count times, with jobnr from 0 to count-1.
2656      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2657      *             two instances of func executing at the same time will have the same threadnr.
2658      * @return always 0 currently, but code should handle a future improvement where when any call to func
2659      *         returns < 0 no further calls to func may be done and < 0 is returned.
2660      * - encoding: Set by libavcodec, user can override.
2661      * - decoding: Set by libavcodec, user can override.
2662      */
2663     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2664
2665     int log_level_offset;
2666
2667     /**
2668      * Number of slices.
2669      * Indicates number of picture subdivisions. Used for parallelized
2670      * decoding.
2671      * - encoding: Set by user
2672      * - decoding: unused
2673      */
2674     int slices;
2675
2676     /**
2677      * Header containing style information for text subtitles.
2678      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2679      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2680      * the Format line following. It shouldn't include any Dialogue line.
2681      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2682      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2683      */
2684     uint8_t *subtitle_header;
2685     int subtitle_header_size;
2686
2687     /**
2688      * Current packet as passed into the decoder, to avoid having
2689      * to pass the packet into every function. Currently only valid
2690      * inside lavc and get/release_buffer callbacks.
2691      * - decoding: set by avcodec_decode_*, read by get_buffer() for setting pkt_pts
2692      * - encoding: unused
2693      */
2694     AVPacket *pkt;
2695
2696     /**
2697      * Which multithreading methods to use.
2698      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2699      * so clients which cannot provide future frames should not use it.
2700      *
2701      * - encoding: Set by user, otherwise the default is used.
2702      * - decoding: Set by user, otherwise the default is used.
2703      */
2704     int thread_type;
2705 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2706 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2707
2708     /**
2709      * Which multithreading methods are in use by the codec.
2710      * - encoding: Set by libavcodec.
2711      * - decoding: Set by libavcodec.
2712      */
2713     int active_thread_type;
2714
2715     /**
2716      * Set by the client if its custom get_buffer() callback can be called
2717      * from another thread, which allows faster multithreaded decoding.
2718      * draw_horiz_band() will be called from other threads regardless of this setting.
2719      * Ignored if the default get_buffer() is used.
2720      * - encoding: Set by user.
2721      * - decoding: Set by user.
2722      */
2723     int thread_safe_callbacks;
2724
2725     /**
2726      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2727      * Used for compliant TS muxing.
2728      * - encoding: Set by libavcodec.
2729      * - decoding: unused.
2730      */
2731     uint64_t vbv_delay;
2732
2733     /**
2734      * Type of service that the audio stream conveys.
2735      * - encoding: Set by user.
2736      * - decoding: Set by libavcodec.
2737      */
2738     enum AVAudioServiceType audio_service_type;
2739
2740     /**
2741      * Used to request a sample format from the decoder.
2742      * - encoding: unused.
2743      * - decoding: Set by user.
2744      */
2745     enum AVSampleFormat request_sample_fmt;
2746
2747     /**
2748      * Error recognition; may misdetect some more or less valid parts as errors.
2749      * - encoding: unused
2750      * - decoding: Set by user.
2751      */
2752     int err_recognition;
2753 #define AV_EF_CRCCHECK  (1<<0)
2754 #define AV_EF_BITSTREAM (1<<1)
2755 #define AV_EF_BUFFER    (1<<2)
2756 #define AV_EF_EXPLODE   (1<<3)
2757
2758     /**
2759      * Private context used for internal data.
2760      *
2761      * Unlike priv_data, this is not codec-specific. It is used in general
2762      * libavcodec functions.
2763      */
2764     struct AVCodecInternal *internal;
2765
2766     /** Field order
2767      * - encoding: set by libavcodec
2768      * - decoding: Set by libavcodec
2769      */
2770     enum AVFieldOrder field_order;
2771 } AVCodecContext;
2772
2773 /**
2774  * AVProfile.
2775  */
2776 typedef struct AVProfile {
2777     int profile;
2778     const char *name; ///< short name for the profile
2779 } AVProfile;
2780
2781 typedef struct AVCodecDefault AVCodecDefault;
2782
2783 /**
2784  * AVCodec.
2785  */
2786 typedef struct AVCodec {
2787     /**
2788      * Name of the codec implementation.
2789      * The name is globally unique among encoders and among decoders (but an
2790      * encoder and a decoder can share the same name).
2791      * This is the primary way to find a codec from the user perspective.
2792      */
2793     const char *name;
2794     enum AVMediaType type;
2795     enum CodecID id;
2796     int priv_data_size;
2797     int (*init)(AVCodecContext *);
2798     int (*encode)(AVCodecContext *, uint8_t *buf, int buf_size, void *data);
2799     int (*close)(AVCodecContext *);
2800     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
2801     /**
2802      * Codec capabilities.
2803      * see CODEC_CAP_*
2804      */
2805     int capabilities;
2806     struct AVCodec *next;
2807     /**
2808      * Flush buffers.
2809      * Will be called when seeking
2810      */
2811     void (*flush)(AVCodecContext *);
2812     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
2813     const enum PixelFormat *pix_fmts;       ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
2814     /**
2815      * Descriptive name for the codec, meant to be more human readable than name.
2816      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
2817      */
2818     const char *long_name;
2819     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
2820     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
2821     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
2822     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
2823     const AVClass *priv_class;              ///< AVClass for the private context
2824     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
2825
2826     /**
2827      * @name Frame-level threading support functions
2828      * @{
2829      */
2830     /**
2831      * If defined, called on thread contexts when they are created.
2832      * If the codec allocates writable tables in init(), re-allocate them here.
2833      * priv_data will be set to a copy of the original.
2834      */
2835     int (*init_thread_copy)(AVCodecContext *);
2836     /**
2837      * Copy necessary context variables from a previous thread context to the current one.
2838      * If not defined, the next thread will start automatically; otherwise, the codec
2839      * must call ff_thread_finish_setup().
2840      *
2841      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
2842      */
2843     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
2844     /** @} */
2845
2846     /**
2847      * Private codec-specific defaults.
2848      */
2849     const AVCodecDefault *defaults;
2850
2851     /**
2852      * Initialize codec static data, called from avcodec_register().
2853      */
2854     void (*init_static_data)(struct AVCodec *codec);
2855
2856     /**
2857      * Encode data to an AVPacket.
2858      *
2859      * @param      avctx          codec context
2860      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
2861      * @param[in]  frame          AVFrame containing the raw data to be encoded
2862      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
2863      *                            non-empty packet was returned in avpkt.
2864      * @return 0 on success, negative error code on failure
2865      */
2866     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
2867                    int *got_packet_ptr);
2868 } AVCodec;
2869
2870 /**
2871  * AVHWAccel.
2872  */
2873 typedef struct AVHWAccel {
2874     /**
2875      * Name of the hardware accelerated codec.
2876      * The name is globally unique among encoders and among decoders (but an
2877      * encoder and a decoder can share the same name).
2878      */
2879     const char *name;
2880
2881     /**
2882      * Type of codec implemented by the hardware accelerator.
2883      *
2884      * See AVMEDIA_TYPE_xxx
2885      */
2886     enum AVMediaType type;
2887
2888     /**
2889      * Codec implemented by the hardware accelerator.
2890      *
2891      * See CODEC_ID_xxx
2892      */
2893     enum CodecID id;
2894
2895     /**
2896      * Supported pixel format.
2897      *
2898      * Only hardware accelerated formats are supported here.
2899      */
2900     enum PixelFormat pix_fmt;
2901
2902     /**
2903      * Hardware accelerated codec capabilities.
2904      * see FF_HWACCEL_CODEC_CAP_*
2905      */
2906     int capabilities;
2907
2908     struct AVHWAccel *next;
2909
2910     /**
2911      * Called at the beginning of each frame or field picture.
2912      *
2913      * Meaningful frame information (codec specific) is guaranteed to
2914      * be parsed at this point. This function is mandatory.
2915      *
2916      * Note that buf can be NULL along with buf_size set to 0.
2917      * Otherwise, this means the whole frame is available at this point.
2918      *
2919      * @param avctx the codec context
2920      * @param buf the frame data buffer base
2921      * @param buf_size the size of the frame in bytes
2922      * @return zero if successful, a negative value otherwise
2923      */
2924     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2925
2926     /**
2927      * Callback for each slice.
2928      *
2929      * Meaningful slice information (codec specific) is guaranteed to
2930      * be parsed at this point. This function is mandatory.
2931      *
2932      * @param avctx the codec context
2933      * @param buf the slice data buffer base
2934      * @param buf_size the size of the slice in bytes
2935      * @return zero if successful, a negative value otherwise
2936      */
2937     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
2938
2939     /**
2940      * Called at the end of each frame or field picture.
2941      *
2942      * The whole picture is parsed at this point and can now be sent
2943      * to the hardware accelerator. This function is mandatory.
2944      *
2945      * @param avctx the codec context
2946      * @return zero if successful, a negative value otherwise
2947      */
2948     int (*end_frame)(AVCodecContext *avctx);
2949
2950     /**
2951      * Size of HW accelerator private data.
2952      *
2953      * Private data is allocated with av_mallocz() before
2954      * AVCodecContext.get_buffer() and deallocated after
2955      * AVCodecContext.release_buffer().
2956      */
2957     int priv_data_size;
2958 } AVHWAccel;
2959
2960 /**
2961  * four components are given, that's all.
2962  * the last component is alpha
2963  */
2964 typedef struct AVPicture {
2965     uint8_t *data[AV_NUM_DATA_POINTERS];
2966     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
2967 } AVPicture;
2968
2969 #define AVPALETTE_SIZE 1024
2970 #define AVPALETTE_COUNT 256
2971
2972 enum AVSubtitleType {
2973     SUBTITLE_NONE,
2974
2975     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
2976
2977     /**
2978      * Plain text, the text field must be set by the decoder and is
2979      * authoritative. ass and pict fields may contain approximations.
2980      */
2981     SUBTITLE_TEXT,
2982
2983     /**
2984      * Formatted text, the ass field must be set by the decoder and is
2985      * authoritative. pict and text fields may contain approximations.
2986      */
2987     SUBTITLE_ASS,
2988 };
2989
2990 typedef struct AVSubtitleRect {
2991     int x;         ///< top left corner  of pict, undefined when pict is not set
2992     int y;         ///< top left corner  of pict, undefined when pict is not set
2993     int w;         ///< width            of pict, undefined when pict is not set
2994     int h;         ///< height           of pict, undefined when pict is not set
2995     int nb_colors; ///< number of colors in pict, undefined when pict is not set
2996
2997     /**
2998      * data+linesize for the bitmap of this subtitle.
2999      * can be set for text/ass as well once they where rendered
3000      */
3001     AVPicture pict;
3002     enum AVSubtitleType type;
3003
3004     char *text;                     ///< 0 terminated plain UTF-8 text
3005
3006     /**
3007      * 0 terminated ASS/SSA compatible event line.
3008      * The pressentation of this is unaffected by the other values in this
3009      * struct.
3010      */
3011     char *ass;
3012 } AVSubtitleRect;
3013
3014 typedef struct AVSubtitle {
3015     uint16_t format; /* 0 = graphics */
3016     uint32_t start_display_time; /* relative to packet pts, in ms */
3017     uint32_t end_display_time; /* relative to packet pts, in ms */
3018     unsigned num_rects;
3019     AVSubtitleRect **rects;
3020     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3021 } AVSubtitle;
3022
3023 /* packet functions */
3024
3025 /**
3026  * @deprecated use NULL instead
3027  */
3028 attribute_deprecated void av_destruct_packet_nofree(AVPacket *pkt);
3029
3030 /**
3031  * Default packet destructor.
3032  */
3033 void av_destruct_packet(AVPacket *pkt);
3034
3035 /**
3036  * Initialize optional fields of a packet with default values.
3037  *
3038  * @param pkt packet
3039  */
3040 void av_init_packet(AVPacket *pkt);
3041
3042 /**
3043  * Allocate the payload of a packet and initialize its fields with
3044  * default values.
3045  *
3046  * @param pkt packet
3047  * @param size wanted payload size
3048  * @return 0 if OK, AVERROR_xxx otherwise
3049  */
3050 int av_new_packet(AVPacket *pkt, int size);
3051
3052 /**
3053  * Reduce packet size, correctly zeroing padding
3054  *
3055  * @param pkt packet
3056  * @param size new size
3057  */
3058 void av_shrink_packet(AVPacket *pkt, int size);
3059
3060 /**
3061  * Increase packet size, correctly zeroing padding
3062  *
3063  * @param pkt packet
3064  * @param grow_by number of bytes by which to increase the size of the packet
3065  */
3066 int av_grow_packet(AVPacket *pkt, int grow_by);
3067
3068 /**
3069  * @warning This is a hack - the packet memory allocation stuff is broken. The
3070  * packet is allocated if it was not really allocated.
3071  */
3072 int av_dup_packet(AVPacket *pkt);
3073
3074 /**
3075  * Free a packet.
3076  *
3077  * @param pkt packet to free
3078  */
3079 void av_free_packet(AVPacket *pkt);
3080
3081 /**
3082  * Allocate new information of a packet.
3083  *
3084  * @param pkt packet
3085  * @param type side information type
3086  * @param size side information size
3087  * @return pointer to fresh allocated data or NULL otherwise
3088  */
3089 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3090                                  int size);
3091
3092 /**
3093  * Get side information from packet.
3094  *
3095  * @param pkt packet
3096  * @param type desired side information type
3097  * @param size pointer for side information size to store (optional)
3098  * @return pointer to data if present or NULL otherwise
3099  */
3100 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
3101                                  int *size);
3102
3103 /* resample.c */
3104
3105 struct ReSampleContext;
3106 struct AVResampleContext;
3107
3108 typedef struct ReSampleContext ReSampleContext;
3109
3110 /**
3111  *  Initialize audio resampling context.
3112  *
3113  * @param output_channels  number of output channels
3114  * @param input_channels   number of input channels
3115  * @param output_rate      output sample rate
3116  * @param input_rate       input sample rate
3117  * @param sample_fmt_out   requested output sample format
3118  * @param sample_fmt_in    input sample format
3119  * @param filter_length    length of each FIR filter in the filterbank relative to the cutoff frequency
3120  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3121  * @param linear           if 1 then the used FIR filter will be linearly interpolated
3122                            between the 2 closest, if 0 the closest will be used
3123  * @param cutoff           cutoff frequency, 1.0 corresponds to half the output sampling rate
3124  * @return allocated ReSampleContext, NULL if error occurred
3125  */
3126 ReSampleContext *av_audio_resample_init(int output_channels, int input_channels,
3127                                         int output_rate, int input_rate,
3128                                         enum AVSampleFormat sample_fmt_out,
3129                                         enum AVSampleFormat sample_fmt_in,
3130                                         int filter_length, int log2_phase_count,
3131                                         int linear, double cutoff);
3132
3133 int audio_resample(ReSampleContext *s, short *output, short *input, int nb_samples);
3134
3135 /**
3136  * Free resample context.
3137  *
3138  * @param s a non-NULL pointer to a resample context previously
3139  *          created with av_audio_resample_init()
3140  */
3141 void audio_resample_close(ReSampleContext *s);
3142
3143
3144 /**
3145  * Initialize an audio resampler.
3146  * Note, if either rate is not an integer then simply scale both rates up so they are.
3147  * @param filter_length length of each FIR filter in the filterbank relative to the cutoff freq
3148  * @param log2_phase_count log2 of the number of entries in the polyphase filterbank
3149  * @param linear If 1 then the used FIR filter will be linearly interpolated
3150                  between the 2 closest, if 0 the closest will be used
3151  * @param cutoff cutoff frequency, 1.0 corresponds to half the output sampling rate
3152  */
3153 struct AVResampleContext *av_resample_init(int out_rate, int in_rate, int filter_length, int log2_phase_count, int linear, double cutoff);
3154
3155 /**
3156  * Resample an array of samples using a previously configured context.
3157  * @param src an array of unconsumed samples
3158  * @param consumed the number of samples of src which have been consumed are returned here
3159  * @param src_size the number of unconsumed samples available
3160  * @param dst_size the amount of space in samples available in dst
3161  * @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.
3162  * @return the number of samples written in dst or -1 if an error occurred
3163  */
3164 int av_resample(struct AVResampleContext *c, short *dst, short *src, int *consumed, int src_size, int dst_size, int update_ctx);
3165
3166
3167 /**
3168  * Compensate samplerate/timestamp drift. The compensation is done by changing
3169  * the resampler parameters, so no audible clicks or similar distortions occur
3170  * @param compensation_distance distance in output samples over which the compensation should be performed
3171  * @param sample_delta number of output samples which should be output less
3172  *
3173  * example: av_resample_compensate(c, 10, 500)
3174  * here instead of 510 samples only 500 samples would be output
3175  *
3176  * note, due to rounding the actual compensation might be slightly different,
3177  * especially if the compensation_distance is large and the in_rate used during init is small
3178  */
3179 void av_resample_compensate(struct AVResampleContext *c, int sample_delta, int compensation_distance);
3180 void av_resample_close(struct AVResampleContext *c);
3181
3182 /**
3183  * Allocate memory for a picture.  Call avpicture_free() to free it.
3184  *
3185  * @see avpicture_fill()
3186  *
3187  * @param picture the picture to be filled in
3188  * @param pix_fmt the format of the picture
3189  * @param width the width of the picture
3190  * @param height the height of the picture
3191  * @return zero if successful, a negative value if not
3192  */
3193 int avpicture_alloc(AVPicture *picture, enum PixelFormat pix_fmt, int width, int height);
3194
3195 /**
3196  * Free a picture previously allocated by avpicture_alloc().
3197  * The data buffer used by the AVPicture is freed, but the AVPicture structure
3198  * itself is not.
3199  *
3200  * @param picture the AVPicture to be freed
3201  */
3202 void avpicture_free(AVPicture *picture);
3203
3204 /**
3205  * Fill in the AVPicture fields.
3206  * The fields of the given AVPicture are filled in by using the 'ptr' address
3207  * which points to the image data buffer. Depending on the specified picture
3208  * format, one or multiple image data pointers and line sizes will be set.
3209  * If a planar format is specified, several pointers will be set pointing to
3210  * the different picture planes and the line sizes of the different planes
3211  * will be stored in the lines_sizes array.
3212  * Call with ptr == NULL to get the required size for the ptr buffer.
3213  *
3214  * To allocate the buffer and fill in the AVPicture fields in one call,
3215  * use avpicture_alloc().
3216  *
3217  * @param picture AVPicture whose fields are to be filled in
3218  * @param ptr Buffer which will contain or contains the actual image data
3219  * @param pix_fmt The format in which the picture data is stored.
3220  * @param width the width of the image in pixels
3221  * @param height the height of the image in pixels
3222  * @return size of the image data in bytes
3223  */
3224 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
3225                    enum PixelFormat pix_fmt, int width, int height);
3226
3227 /**
3228  * Copy pixel data from an AVPicture into a buffer.
3229  * The data is stored compactly, without any gaps for alignment or padding
3230  * which may be applied by avpicture_fill().
3231  *
3232  * @see avpicture_get_size()
3233  *
3234  * @param[in] src AVPicture containing image data
3235  * @param[in] pix_fmt The format in which the picture data is stored.
3236  * @param[in] width the width of the image in pixels.
3237  * @param[in] height the height of the image in pixels.
3238  * @param[out] dest A buffer into which picture data will be copied.
3239  * @param[in] dest_size The size of 'dest'.
3240  * @return The number of bytes written to dest, or a negative value (error code) on error.
3241  */
3242 int avpicture_layout(const AVPicture* src, enum PixelFormat pix_fmt, int width, int height,
3243                      unsigned char *dest, int dest_size);
3244
3245 /**
3246  * Calculate the size in bytes that a picture of the given width and height
3247  * would occupy if stored in the given picture format.
3248  * Note that this returns the size of a compact representation as generated
3249  * by avpicture_layout(), which can be smaller than the size required for e.g.
3250  * avpicture_fill().
3251  *
3252  * @param pix_fmt the given picture format
3253  * @param width the width of the image
3254  * @param height the height of the image
3255  * @return Image data size in bytes or -1 on error (e.g. too large dimensions).
3256  */
3257 int avpicture_get_size(enum PixelFormat pix_fmt, int width, int height);
3258 void avcodec_get_chroma_sub_sample(enum PixelFormat pix_fmt, int *h_shift, int *v_shift);
3259
3260 void avcodec_set_dimensions(AVCodecContext *s, int width, int height);
3261
3262 /**
3263  * Return a value representing the fourCC code associated to the
3264  * pixel format pix_fmt, or 0 if no associated fourCC code can be
3265  * found.
3266  */
3267 unsigned int avcodec_pix_fmt_to_codec_tag(enum PixelFormat pix_fmt);
3268
3269 /**
3270  * Put a string representing the codec tag codec_tag in buf.
3271  *
3272  * @param buf_size size in bytes of buf
3273  * @return the length of the string that would have been generated if
3274  * enough space had been available, excluding the trailing null
3275  */
3276 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
3277
3278 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
3279 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
3280 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
3281 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
3282 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
3283 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
3284
3285 /**
3286  * Compute what kind of losses will occur when converting from one specific
3287  * pixel format to another.
3288  * When converting from one pixel format to another, information loss may occur.
3289  * For example, when converting from RGB24 to GRAY, the color information will
3290  * be lost. Similarly, other losses occur when converting from some formats to
3291  * other formats. These losses can involve loss of chroma, but also loss of
3292  * resolution, loss of color depth, loss due to the color space conversion, loss
3293  * of the alpha bits or loss due to color quantization.
3294  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
3295  * which will occur when converting from one pixel format to another.
3296  *
3297  * @param[in] dst_pix_fmt destination pixel format
3298  * @param[in] src_pix_fmt source pixel format
3299  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3300  * @return Combination of flags informing you what kind of losses will occur.
3301  */
3302 int avcodec_get_pix_fmt_loss(enum PixelFormat dst_pix_fmt, enum PixelFormat src_pix_fmt,
3303                              int has_alpha);
3304
3305 /**
3306  * Find the best pixel format to convert to given a certain source pixel
3307  * format.  When converting from one pixel format to another, information loss
3308  * may occur.  For example, when converting from RGB24 to GRAY, the color
3309  * information will be lost. Similarly, other losses occur when converting from
3310  * some formats to other formats. avcodec_find_best_pix_fmt() searches which of
3311  * the given pixel formats should be used to suffer the least amount of loss.
3312  * The pixel formats from which it chooses one, are determined by the
3313  * pix_fmt_mask parameter.
3314  *
3315  * @code
3316  * src_pix_fmt = PIX_FMT_YUV420P;
3317  * pix_fmt_mask = (1 << PIX_FMT_YUV422P) || (1 << PIX_FMT_RGB24);
3318  * dst_pix_fmt = avcodec_find_best_pix_fmt(pix_fmt_mask, src_pix_fmt, alpha, &loss);
3319  * @endcode
3320  *
3321  * @param[in] pix_fmt_mask bitmask determining which pixel format to choose from
3322  * @param[in] src_pix_fmt source pixel format
3323  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
3324  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
3325  * @return The best pixel format to convert to or -1 if none was found.
3326  */
3327 enum PixelFormat avcodec_find_best_pix_fmt(int64_t pix_fmt_mask, enum PixelFormat src_pix_fmt,
3328                               int has_alpha, int *loss_ptr);
3329
3330 /* deinterlace a picture */
3331 /* deinterlace - if not supported return -1 */
3332 int avpicture_deinterlace(AVPicture *dst, const AVPicture *src,
3333                           enum PixelFormat pix_fmt, int width, int height);
3334
3335 /* external high level API */
3336
3337 /**
3338  * If c is NULL, returns the first registered codec,
3339  * if c is non-NULL, returns the next registered codec after c,
3340  * or NULL if c is the last one.
3341  */
3342 AVCodec *av_codec_next(AVCodec *c);
3343
3344 /**
3345  * Return the LIBAVCODEC_VERSION_INT constant.
3346  */
3347 unsigned avcodec_version(void);
3348
3349 /**
3350  * Return the libavcodec build-time configuration.
3351  */
3352 const char *avcodec_configuration(void);
3353
3354 /**
3355  * Return the libavcodec license.
3356  */
3357 const char *avcodec_license(void);
3358
3359 /**
3360  * Register the codec codec and initialize libavcodec.
3361  *
3362  * @warning either this function or avcodec_register_all() must be called
3363  * before any other libavcodec functions.
3364  *
3365  * @see avcodec_register_all()
3366  */
3367 void avcodec_register(AVCodec *codec);
3368
3369 /**
3370  * Find a registered encoder with a matching codec ID.
3371  *
3372  * @param id CodecID of the requested encoder
3373  * @return An encoder if one was found, NULL otherwise.
3374  */
3375 AVCodec *avcodec_find_encoder(enum CodecID id);
3376
3377 /**
3378  * Find a registered encoder with the specified name.
3379  *
3380  * @param name name of the requested encoder
3381  * @return An encoder if one was found, NULL otherwise.
3382  */
3383 AVCodec *avcodec_find_encoder_by_name(const char *name);
3384
3385 /**
3386  * Find a registered decoder with a matching codec ID.
3387  *
3388  * @param id CodecID of the requested decoder
3389  * @return A decoder if one was found, NULL otherwise.
3390  */
3391 AVCodec *avcodec_find_decoder(enum CodecID id);
3392
3393 /**
3394  * Find a registered decoder with the specified name.
3395  *
3396  * @param name name of the requested decoder
3397  * @return A decoder if one was found, NULL otherwise.
3398  */
3399 AVCodec *avcodec_find_decoder_by_name(const char *name);
3400 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
3401
3402 /**
3403  * Return a name for the specified profile, if available.
3404  *
3405  * @param codec the codec that is searched for the given profile
3406  * @param profile the profile value for which a name is requested
3407  * @return A name for the profile if found, NULL otherwise.
3408  */
3409 const char *av_get_profile_name(const AVCodec *codec, int profile);
3410
3411 /**
3412  * Set the fields of the given AVCodecContext to default values corresponding
3413  * to the given codec (defaults may be codec-dependent).
3414  *
3415  * Do not call this function if a non-NULL codec has been passed
3416  * to avcodec_alloc_context3() that allocated this AVCodecContext.
3417  * If codec is non-NULL, it is illegal to call avcodec_open2() with a
3418  * different codec on this AVCodecContext.
3419  */
3420 int avcodec_get_context_defaults3(AVCodecContext *s, AVCodec *codec);
3421
3422 /**
3423  * Allocate an AVCodecContext and set its fields to default values.  The
3424  * resulting struct can be deallocated by simply calling av_free().
3425  *
3426  * @param codec if non-NULL, allocate private data and initialize defaults
3427  *              for the given codec. It is illegal to then call avcodec_open2()
3428  *              with a different codec.
3429  *
3430  * @return An AVCodecContext filled with default values or NULL on failure.
3431  * @see avcodec_get_context_defaults
3432  */
3433 AVCodecContext *avcodec_alloc_context3(AVCodec *codec);
3434
3435 /**
3436  * Copy the settings of the source AVCodecContext into the destination
3437  * AVCodecContext. The resulting destination codec context will be
3438  * unopened, i.e. you are required to call avcodec_open2() before you
3439  * can use this AVCodecContext to decode/encode video/audio data.
3440  *
3441  * @param dest target codec context, should be initialized with
3442  *             avcodec_alloc_context3(), but otherwise uninitialized
3443  * @param src source codec context
3444  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3445  */
3446 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3447
3448 /**
3449  * Set the fields of the given AVFrame to default values.
3450  *
3451  * @param pic The AVFrame of which the fields should be set to default values.
3452  */
3453 void avcodec_get_frame_defaults(AVFrame *pic);
3454
3455 /**
3456  * Allocate an AVFrame and set its fields to default values.  The resulting
3457  * struct can be deallocated by simply calling av_free().
3458  *
3459  * @return An AVFrame filled with default values or NULL on failure.
3460  * @see avcodec_get_frame_defaults
3461  */
3462 AVFrame *avcodec_alloc_frame(void);
3463
3464 int avcodec_default_get_buffer(AVCodecContext *s, AVFrame *pic);
3465 void avcodec_default_release_buffer(AVCodecContext *s, AVFrame *pic);
3466 int avcodec_default_reget_buffer(AVCodecContext *s, AVFrame *pic);
3467
3468 /**
3469  * Return the amount of padding in pixels which the get_buffer callback must
3470  * provide around the edge of the image for codecs which do not have the
3471  * CODEC_FLAG_EMU_EDGE flag.
3472  *
3473  * @return Required padding in pixels.
3474  */
3475 unsigned avcodec_get_edge_width(void);
3476 /**
3477  * Modify width and height values so that they will result in a memory
3478  * buffer that is acceptable for the codec if you do not use any horizontal
3479  * padding.
3480  *
3481  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3482  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3483  * according to avcodec_get_edge_width() before.
3484  */
3485 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
3486 /**
3487  * Modify width and height values so that they will result in a memory
3488  * buffer that is acceptable for the codec if you also ensure that all
3489  * line sizes are a multiple of the respective linesize_align[i].
3490  *
3491  * May only be used if a codec with CODEC_CAP_DR1 has been opened.
3492  * If CODEC_FLAG_EMU_EDGE is not set, the dimensions must have been increased
3493  * according to avcodec_get_edge_width() before.
3494  */
3495 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
3496                                int linesize_align[AV_NUM_DATA_POINTERS]);
3497
3498 enum PixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum PixelFormat * fmt);
3499
3500 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
3501 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
3502 //FIXME func typedef
3503
3504 /**
3505  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3506  * function the context has to be allocated with avcodec_alloc_context3().
3507  *
3508  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3509  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3510  * retrieving a codec.
3511  *
3512  * @warning This function is not thread safe!
3513  *
3514  * @code
3515  * avcodec_register_all();
3516  * av_dict_set(&opts, "b", "2.5M", 0);
3517  * codec = avcodec_find_decoder(CODEC_ID_H264);
3518  * if (!codec)
3519  *     exit(1);
3520  *
3521  * context = avcodec_alloc_context3(codec);
3522  *
3523  * if (avcodec_open2(context, codec, opts) < 0)
3524  *     exit(1);
3525  * @endcode
3526  *
3527  * @param avctx The context to initialize.
3528  * @param options A dictionary filled with AVCodecContext and codec-private options.
3529  *                On return this object will be filled with options that were not found.
3530  *
3531  * @return zero on success, a negative value on error
3532  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3533  *      av_dict_set(), av_opt_find().
3534  */
3535 int avcodec_open2(AVCodecContext *avctx, AVCodec *codec, AVDictionary **options);
3536
3537 #if FF_API_OLD_DECODE_AUDIO
3538 /**
3539  * Wrapper function which calls avcodec_decode_audio4.
3540  *
3541  * @deprecated Use avcodec_decode_audio4 instead.
3542  *
3543  * Decode the audio frame of size avpkt->size from avpkt->data into samples.
3544  * Some decoders may support multiple frames in a single AVPacket, such
3545  * decoders would then just decode the first frame. In this case,
3546  * avcodec_decode_audio3 has to be called again with an AVPacket that contains
3547  * the remaining data in order to decode the second frame etc.
3548  * If no frame
3549  * could be outputted, frame_size_ptr is zero. Otherwise, it is the
3550  * decompressed frame size in bytes.
3551  *
3552  * @warning You must set frame_size_ptr to the allocated size of the
3553  * output buffer before calling avcodec_decode_audio3().
3554  *
3555  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3556  * the actual read bytes because some optimized bitstream readers read 32 or 64
3557  * bits at once and could read over the end.
3558  *
3559  * @warning The end of the input buffer avpkt->data should be set to 0 to ensure that
3560  * no overreading happens for damaged MPEG streams.
3561  *
3562  * @warning You must not provide a custom get_buffer() when using
3563  * avcodec_decode_audio3().  Doing so will override it with
3564  * avcodec_default_get_buffer.  Use avcodec_decode_audio4() instead,
3565  * which does allow the application to provide a custom get_buffer().
3566  *
3567  * @note You might have to align the input buffer avpkt->data and output buffer
3568  * samples. The alignment requirements depend on the CPU: On some CPUs it isn't
3569  * necessary at all, on others it won't work at all if not aligned and on others
3570  * it will work but it will have an impact on performance.
3571  *
3572  * In practice, avpkt->data should have 4 byte alignment at minimum and
3573  * samples should be 16 byte aligned unless the CPU doesn't need it
3574  * (AltiVec and SSE do).
3575  *
3576  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3577  * between input and output, these need to be fed with avpkt->data=NULL,
3578  * avpkt->size=0 at the end to return the remaining frames.
3579  *
3580  * @param avctx the codec context
3581  * @param[out] samples the output buffer, sample type in avctx->sample_fmt
3582  *                     If the sample format is planar, each channel plane will
3583  *                     be the same size, with no padding between channels.
3584  * @param[in,out] frame_size_ptr the output buffer size in bytes
3585  * @param[in] avpkt The input AVPacket containing the input buffer.
3586  *            You can create such packet with av_init_packet() and by then setting
3587  *            data and size, some decoders might in addition need other fields.
3588  *            All decoders are designed to use the least fields possible though.
3589  * @return On error a negative value is returned, otherwise the number of bytes
3590  * used or zero if no frame data was decompressed (used) from the input AVPacket.
3591  */
3592 attribute_deprecated int avcodec_decode_audio3(AVCodecContext *avctx, int16_t *samples,
3593                          int *frame_size_ptr,
3594                          AVPacket *avpkt);
3595 #endif
3596
3597 /**
3598  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
3599  *
3600  * Some decoders may support multiple frames in a single AVPacket. Such
3601  * decoders would then just decode the first frame. In this case,
3602  * avcodec_decode_audio4 has to be called again with an AVPacket containing
3603  * the remaining data in order to decode the second frame, etc...
3604  * Even if no frames are returned, the packet needs to be fed to the decoder
3605  * with remaining data until it is completely consumed or an error occurs.
3606  *
3607  * @warning The input buffer, avpkt->data must be FF_INPUT_BUFFER_PADDING_SIZE
3608  *          larger than the actual read bytes because some optimized bitstream
3609  *          readers read 32 or 64 bits at once and could read over the end.
3610  *
3611  * @note You might have to align the input buffer. The alignment requirements
3612  *       depend on the CPU and the decoder.
3613  *
3614  * @param      avctx the codec context
3615  * @param[out] frame The AVFrame in which to store decoded audio samples.
3616  *                   Decoders request a buffer of a particular size by setting
3617  *                   AVFrame.nb_samples prior to calling get_buffer(). The
3618  *                   decoder may, however, only utilize part of the buffer by
3619  *                   setting AVFrame.nb_samples to a smaller value in the
3620  *                   output frame.
3621  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
3622  *                           non-zero.
3623  * @param[in]  avpkt The input AVPacket containing the input buffer.
3624  *                   At least avpkt->data and avpkt->size should be set. Some
3625  *                   decoders might also require additional fields to be set.
3626  * @return A negative error code is returned if an error occurred during
3627  *         decoding, otherwise the number of bytes consumed from the input
3628  *         AVPacket is returned.
3629  */
3630 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
3631                           int *got_frame_ptr, AVPacket *avpkt);
3632
3633 /**
3634  * Decode the video frame of size avpkt->size from avpkt->data into picture.
3635  * Some decoders may support multiple frames in a single AVPacket, such
3636  * decoders would then just decode the first frame.
3637  *
3638  * @warning The input buffer must be FF_INPUT_BUFFER_PADDING_SIZE larger than
3639  * the actual read bytes because some optimized bitstream readers read 32 or 64
3640  * bits at once and could read over the end.
3641  *
3642  * @warning The end of the input buffer buf should be set to 0 to ensure that
3643  * no overreading happens for damaged MPEG streams.
3644  *
3645  * @note You might have to align the input buffer avpkt->data.
3646  * The alignment requirements depend on the CPU: on some CPUs it isn't
3647  * necessary at all, on others it won't work at all if not aligned and on others
3648  * it will work but it will have an impact on performance.
3649  *
3650  * In practice, avpkt->data should have 4 byte alignment at minimum.
3651  *
3652  * @note Codecs which have the CODEC_CAP_DELAY capability set have a delay
3653  * between input and output, these need to be fed with avpkt->data=NULL,
3654  * avpkt->size=0 at the end to return the remaining frames.
3655  *
3656  * @param avctx the codec context
3657  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
3658  *             Use avcodec_alloc_frame to get an AVFrame, the codec will
3659  *             allocate memory for the actual bitmap.
3660  *             with default get/release_buffer(), the decoder frees/reuses the bitmap as it sees fit.
3661  *             with overridden get/release_buffer() (needs CODEC_CAP_DR1) the user decides into what buffer the decoder
3662  *                   decodes and the decoder tells the user once it does not need the data anymore,
3663  *                   the user app can at this point free/reuse/keep the memory as it sees fit.
3664  *
3665  * @param[in] avpkt The input AVpacket containing the input buffer.
3666  *            You can create such packet with av_init_packet() and by then setting
3667  *            data and size, some decoders might in addition need other fields like
3668  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
3669  *            fields possible.
3670  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
3671  * @return On error a negative value is returned, otherwise the number of bytes
3672  * used or zero if no frame could be decompressed.
3673  */
3674 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
3675                          int *got_picture_ptr,
3676                          AVPacket *avpkt);
3677
3678 /**
3679  * Decode a subtitle message.
3680  * Return a negative value on error, otherwise return the number of bytes used.
3681  * If no subtitle could be decompressed, got_sub_ptr is zero.
3682  * Otherwise, the subtitle is stored in *sub.
3683  * Note that CODEC_CAP_DR1 is not available for subtitle codecs. This is for
3684  * simplicity, because the performance difference is expect to be negligible
3685  * and reusing a get_buffer written for video codecs would probably perform badly
3686  * due to a potentially very different allocation pattern.
3687  *
3688  * @param avctx the codec context
3689  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
3690                    freed with avsubtitle_free if *got_sub_ptr is set.
3691  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
3692  * @param[in] avpkt The input AVPacket containing the input buffer.
3693  */
3694 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
3695                             int *got_sub_ptr,
3696                             AVPacket *avpkt);
3697
3698 /**
3699  * Free all allocated data in the given subtitle struct.
3700  *
3701  * @param sub AVSubtitle to free.
3702  */
3703 void avsubtitle_free(AVSubtitle *sub);
3704
3705 #if FF_API_OLD_ENCODE_AUDIO
3706 /**
3707  * Encode an audio frame from samples into buf.
3708  *
3709  * @deprecated Use avcodec_encode_audio2 instead.
3710  *
3711  * @note The output buffer should be at least FF_MIN_BUFFER_SIZE bytes large.
3712  * However, for codecs with avctx->frame_size equal to 0 (e.g. PCM) the user
3713  * will know how much space is needed because it depends on the value passed
3714  * in buf_size as described below. In that case a lower value can be used.
3715  *
3716  * @param avctx the codec context
3717  * @param[out] buf the output buffer
3718  * @param[in] buf_size the output buffer size
3719  * @param[in] samples the input buffer containing the samples
3720  * The number of samples read from this buffer is frame_size*channels,
3721  * both of which are defined in avctx.
3722  * For codecs which have avctx->frame_size equal to 0 (e.g. PCM) the number of
3723  * samples read from samples is equal to:
3724  * buf_size * 8 / (avctx->channels * av_get_bits_per_sample(avctx->codec_id))
3725  * This also implies that av_get_bits_per_sample() must not return 0 for these
3726  * codecs.
3727  * @return On error a negative value is returned, on success zero or the number
3728  * of bytes used to encode the data read from the input buffer.
3729  */
3730 int attribute_deprecated avcodec_encode_audio(AVCodecContext *avctx,
3731                                               uint8_t *buf, int buf_size,
3732                                               const short *samples);
3733 #endif
3734
3735 /**
3736  * Encode a frame of audio.
3737  *
3738  * Takes input samples from frame and writes the next output packet, if
3739  * available, to avpkt. The output packet does not necessarily contain data for
3740  * the most recent frame, as encoders can delay, split, and combine input frames
3741  * internally as needed.
3742  *
3743  * @param avctx     codec context
3744  * @param avpkt     output AVPacket.
3745  *                  The user can supply an output buffer by setting
3746  *                  avpkt->data and avpkt->size prior to calling the
3747  *                  function, but if the size of the user-provided data is not
3748  *                  large enough, encoding will fail. All other AVPacket fields
3749  *                  will be reset by the encoder using av_init_packet(). If
3750  *                  avpkt->data is NULL, the encoder will allocate it.
3751  *                  The encoder will set avpkt->size to the size of the
3752  *                  output packet.
3753  * @param[in] frame AVFrame containing the raw audio data to be encoded.
3754  *                  May be NULL when flushing an encoder that has the
3755  *                  CODEC_CAP_DELAY capability set.
3756  *                  There are 2 codec capabilities that affect the allowed
3757  *                  values of frame->nb_samples.
3758  *                  If CODEC_CAP_SMALL_LAST_FRAME is set, then only the final
3759  *                  frame may be smaller than avctx->frame_size, and all other
3760  *                  frames must be equal to avctx->frame_size.
3761  *                  If CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
3762  *                  can have any number of samples.
3763  *                  If neither is set, frame->nb_samples must be equal to
3764  *                  avctx->frame_size for all frames.
3765  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
3766  *                            output packet is non-empty, and to 0 if it is
3767  *                            empty. If the function returns an error, the
3768  *                            packet can be assumed to be invalid, and the
3769  *                            value of got_packet_ptr is undefined and should
3770  *                            not be used.
3771  * @return          0 on success, negative error code on failure
3772  */
3773 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
3774                           const AVFrame *frame, int *got_packet_ptr);
3775
3776 /**
3777  * Fill audio frame data and linesize.
3778  * AVFrame extended_data channel pointers are allocated if necessary for
3779  * planar audio.
3780  *
3781  * @param frame       the AVFrame
3782  *                    frame->nb_samples must be set prior to calling the
3783  *                    function. This function fills in frame->data,
3784  *                    frame->extended_data, frame->linesize[0].
3785  * @param nb_channels channel count
3786  * @param sample_fmt  sample format
3787  * @param buf         buffer to use for frame data
3788  * @param buf_size    size of buffer
3789  * @param align       plane size sample alignment
3790  * @return            0 on success, negative error code on failure
3791  */
3792 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
3793                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
3794                              int buf_size, int align);
3795
3796 /**
3797  * Encode a video frame from pict into buf.
3798  * The input picture should be
3799  * stored using a specific format, namely avctx.pix_fmt.
3800  *
3801  * @param avctx the codec context
3802  * @param[out] buf the output buffer for the bitstream of encoded frame
3803  * @param[in] buf_size the size of the output buffer in bytes
3804  * @param[in] pict the input picture to encode
3805  * @return On error a negative value is returned, on success zero or the number
3806  * of bytes used from the output buffer.
3807  */
3808 int avcodec_encode_video(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3809                          const AVFrame *pict);
3810 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
3811                             const AVSubtitle *sub);
3812
3813 int avcodec_close(AVCodecContext *avctx);
3814
3815 /**
3816  * Register all the codecs, parsers and bitstream filters which were enabled at
3817  * configuration time. If you do not call this function you can select exactly
3818  * which formats you want to support, by using the individual registration
3819  * functions.
3820  *
3821  * @see avcodec_register
3822  * @see av_register_codec_parser
3823  * @see av_register_bitstream_filter
3824  */
3825 void avcodec_register_all(void);
3826
3827 /**
3828  * Flush buffers, should be called when seeking or when switching to a different stream.
3829  */
3830 void avcodec_flush_buffers(AVCodecContext *avctx);
3831
3832 void avcodec_default_free_buffers(AVCodecContext *s);
3833
3834 /* misc useful functions */
3835
3836 /**
3837  * Return codec bits per sample.
3838  *
3839  * @param[in] codec_id the codec
3840  * @return Number of bits per sample or zero if unknown for the given codec.
3841  */
3842 int av_get_bits_per_sample(enum CodecID codec_id);
3843
3844 /* frame parsing */
3845 typedef struct AVCodecParserContext {
3846     void *priv_data;
3847     struct AVCodecParser *parser;
3848     int64_t frame_offset; /* offset of the current frame */
3849     int64_t cur_offset; /* current offset
3850                            (incremented by each av_parser_parse()) */
3851     int64_t next_frame_offset; /* offset of the next frame */
3852     /* video info */
3853     int pict_type; /* XXX: Put it back in AVCodecContext. */
3854     /**
3855      * This field is used for proper frame duration computation in lavf.
3856      * It signals, how much longer the frame duration of the current frame
3857      * is compared to normal frame duration.
3858      *
3859      * frame_duration = (1 + repeat_pict) * time_base
3860      *
3861      * It is used by codecs like H.264 to display telecined material.
3862      */
3863     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
3864     int64_t pts;     /* pts of the current frame */
3865     int64_t dts;     /* dts of the current frame */
3866
3867     /* private data */
3868     int64_t last_pts;
3869     int64_t last_dts;
3870     int fetch_timestamp;
3871
3872 #define AV_PARSER_PTS_NB 4
3873     int cur_frame_start_index;
3874     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
3875     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
3876     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
3877
3878     int flags;
3879 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
3880 #define PARSER_FLAG_ONCE                      0x0002
3881 /// Set if the parser has a valid file offset
3882 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
3883
3884     int64_t offset;      ///< byte offset from starting packet start
3885     int64_t cur_frame_end[AV_PARSER_PTS_NB];
3886
3887     /**
3888      * Set by parser to 1 for key frames and 0 for non-key frames.
3889      * It is initialized to -1, so if the parser doesn't set this flag,
3890      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
3891      * will be used.
3892      */
3893     int key_frame;
3894
3895     /**
3896      * Time difference in stream time base units from the pts of this
3897      * packet to the point at which the output from the decoder has converged
3898      * independent from the availability of previous frames. That is, the
3899      * frames are virtually identical no matter if decoding started from
3900      * the very first frame or from this keyframe.
3901      * Is AV_NOPTS_VALUE if unknown.
3902      * This field is not the display duration of the current frame.
3903      * This field has no meaning if the packet does not have AV_PKT_FLAG_KEY
3904      * set.
3905      *
3906      * The purpose of this field is to allow seeking in streams that have no
3907      * keyframes in the conventional sense. It corresponds to the
3908      * recovery point SEI in H.264 and match_time_delta in NUT. It is also
3909      * essential for some types of subtitle streams to ensure that all
3910      * subtitles are correctly displayed after seeking.
3911      */
3912     int64_t convergence_duration;
3913
3914     // Timestamp generation support:
3915     /**
3916      * Synchronization point for start of timestamp generation.
3917      *
3918      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
3919      * (default).
3920      *
3921      * For example, this corresponds to presence of H.264 buffering period
3922      * SEI message.
3923      */
3924     int dts_sync_point;
3925
3926     /**
3927      * Offset of the current timestamp against last timestamp sync point in
3928      * units of AVCodecContext.time_base.
3929      *
3930      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3931      * contain a valid timestamp offset.
3932      *
3933      * Note that the timestamp of sync point has usually a nonzero
3934      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
3935      * the next frame after timestamp sync point will be usually 1.
3936      *
3937      * For example, this corresponds to H.264 cpb_removal_delay.
3938      */
3939     int dts_ref_dts_delta;
3940
3941     /**
3942      * Presentation delay of current frame in units of AVCodecContext.time_base.
3943      *
3944      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
3945      * contain valid non-negative timestamp delta (presentation time of a frame
3946      * must not lie in the past).
3947      *
3948      * This delay represents the difference between decoding and presentation
3949      * time of the frame.
3950      *
3951      * For example, this corresponds to H.264 dpb_output_delay.
3952      */
3953     int pts_dts_delta;
3954
3955     /**
3956      * Position of the packet in file.
3957      *
3958      * Analogous to cur_frame_pts/dts
3959      */
3960     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
3961
3962     /**
3963      * Byte position of currently parsed frame in stream.
3964      */
3965     int64_t pos;
3966
3967     /**
3968      * Previous frame byte position.
3969      */
3970     int64_t last_pos;
3971 } AVCodecParserContext;
3972
3973 typedef struct AVCodecParser {
3974     int codec_ids[5]; /* several codec IDs are permitted */
3975     int priv_data_size;
3976     int (*parser_init)(AVCodecParserContext *s);
3977     int (*parser_parse)(AVCodecParserContext *s,
3978                         AVCodecContext *avctx,
3979                         const uint8_t **poutbuf, int *poutbuf_size,
3980                         const uint8_t *buf, int buf_size);
3981     void (*parser_close)(AVCodecParserContext *s);
3982     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
3983     struct AVCodecParser *next;
3984 } AVCodecParser;
3985
3986 AVCodecParser *av_parser_next(AVCodecParser *c);
3987
3988 void av_register_codec_parser(AVCodecParser *parser);
3989 AVCodecParserContext *av_parser_init(int codec_id);
3990
3991 /**
3992  * Parse a packet.
3993  *
3994  * @param s             parser context.
3995  * @param avctx         codec context.
3996  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
3997  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
3998  * @param buf           input buffer.
3999  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4000  * @param pts           input presentation timestamp.
4001  * @param dts           input decoding timestamp.
4002  * @param pos           input byte position in stream.
4003  * @return the number of bytes of the input bitstream used.
4004  *
4005  * Example:
4006  * @code
4007  *   while(in_len){
4008  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4009  *                                        in_data, in_len,
4010  *                                        pts, dts, pos);
4011  *       in_data += len;
4012  *       in_len  -= len;
4013  *
4014  *       if(size)
4015  *          decode_frame(data, size);
4016  *   }
4017  * @endcode
4018  */
4019 int av_parser_parse2(AVCodecParserContext *s,
4020                      AVCodecContext *avctx,
4021                      uint8_t **poutbuf, int *poutbuf_size,
4022                      const uint8_t *buf, int buf_size,
4023                      int64_t pts, int64_t dts,
4024                      int64_t pos);
4025
4026 int av_parser_change(AVCodecParserContext *s,
4027                      AVCodecContext *avctx,
4028                      uint8_t **poutbuf, int *poutbuf_size,
4029                      const uint8_t *buf, int buf_size, int keyframe);
4030 void av_parser_close(AVCodecParserContext *s);
4031
4032
4033 typedef struct AVBitStreamFilterContext {
4034     void *priv_data;
4035     struct AVBitStreamFilter *filter;
4036     AVCodecParserContext *parser;
4037     struct AVBitStreamFilterContext *next;
4038 } AVBitStreamFilterContext;
4039
4040
4041 typedef struct AVBitStreamFilter {
4042     const char *name;
4043     int priv_data_size;
4044     int (*filter)(AVBitStreamFilterContext *bsfc,
4045                   AVCodecContext *avctx, const char *args,
4046                   uint8_t **poutbuf, int *poutbuf_size,
4047                   const uint8_t *buf, int buf_size, int keyframe);
4048     void (*close)(AVBitStreamFilterContext *bsfc);
4049     struct AVBitStreamFilter *next;
4050 } AVBitStreamFilter;
4051
4052 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
4053 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
4054 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
4055                                AVCodecContext *avctx, const char *args,
4056                                uint8_t **poutbuf, int *poutbuf_size,
4057                                const uint8_t *buf, int buf_size, int keyframe);
4058 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
4059
4060 AVBitStreamFilter *av_bitstream_filter_next(AVBitStreamFilter *f);
4061
4062 /* memory */
4063
4064 /**
4065  * Reallocate the given block if it is not large enough, otherwise do nothing.
4066  *
4067  * @see av_realloc
4068  */
4069 void *av_fast_realloc(void *ptr, unsigned int *size, size_t min_size);
4070
4071 /**
4072  * Allocate a buffer, reusing the given one if large enough.
4073  *
4074  * Contrary to av_fast_realloc the current buffer contents might not be
4075  * preserved and on error the old buffer is freed, thus no special
4076  * handling to avoid memleaks is necessary.
4077  *
4078  * @param ptr pointer to pointer to already allocated buffer, overwritten with pointer to new buffer
4079  * @param size size of the buffer *ptr points to
4080  * @param min_size minimum size of *ptr buffer after returning, *ptr will be NULL and
4081  *                 *size 0 if an error occurred.
4082  */
4083 void av_fast_malloc(void *ptr, unsigned int *size, size_t min_size);
4084
4085 /**
4086  * Copy image src to dst. Wraps av_picture_data_copy() above.
4087  */
4088 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4089                      enum PixelFormat pix_fmt, int width, int height);
4090
4091 /**
4092  * Crop image top and left side.
4093  */
4094 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4095                     enum PixelFormat pix_fmt, int top_band, int left_band);
4096
4097 /**
4098  * Pad image.
4099  */
4100 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum PixelFormat pix_fmt,
4101             int padtop, int padbottom, int padleft, int padright, int *color);
4102
4103 /**
4104  * Encode extradata length to a buffer. Used by xiph codecs.
4105  *
4106  * @param s buffer to write to; must be at least (v/255+1) bytes long
4107  * @param v size of extradata in bytes
4108  * @return number of bytes written to the buffer.
4109  */
4110 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
4111
4112 /**
4113  * Log a generic warning message about a missing feature. This function is
4114  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4115  * only, and would normally not be used by applications.
4116  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4117  * a pointer to an AVClass struct
4118  * @param[in] feature string containing the name of the missing feature
4119  * @param[in] want_sample indicates if samples are wanted which exhibit this feature.
4120  * If want_sample is non-zero, additional verbage will be added to the log
4121  * message which tells the user how to report samples to the development
4122  * mailing list.
4123  */
4124 void av_log_missing_feature(void *avc, const char *feature, int want_sample);
4125
4126 /**
4127  * Log a generic warning message asking for a sample. This function is
4128  * intended to be used internally by Libav (libavcodec, libavformat, etc.)
4129  * only, and would normally not be used by applications.
4130  * @param[in] avc a pointer to an arbitrary struct of which the first field is
4131  * a pointer to an AVClass struct
4132  * @param[in] msg string containing an optional message, or NULL if no message
4133  */
4134 void av_log_ask_for_sample(void *avc, const char *msg, ...) av_printf_format(2, 3);
4135
4136 /**
4137  * Register the hardware accelerator hwaccel.
4138  */
4139 void av_register_hwaccel(AVHWAccel *hwaccel);
4140
4141 /**
4142  * If hwaccel is NULL, returns the first registered hardware accelerator,
4143  * if hwaccel is non-NULL, returns the next registered hardware accelerator
4144  * after hwaccel, or NULL if hwaccel is the last one.
4145  */
4146 AVHWAccel *av_hwaccel_next(AVHWAccel *hwaccel);
4147
4148
4149 /**
4150  * Lock operation used by lockmgr
4151  */
4152 enum AVLockOp {
4153   AV_LOCK_CREATE,  ///< Create a mutex
4154   AV_LOCK_OBTAIN,  ///< Lock the mutex
4155   AV_LOCK_RELEASE, ///< Unlock the mutex
4156   AV_LOCK_DESTROY, ///< Free mutex resources
4157 };
4158
4159 /**
4160  * Register a user provided lock manager supporting the operations
4161  * specified by AVLockOp. mutex points to a (void *) where the
4162  * lockmgr should store/get a pointer to a user allocated mutex. It's
4163  * NULL upon AV_LOCK_CREATE and != NULL for all other ops.
4164  *
4165  * @param cb User defined callback. Note: Libav may invoke calls to this
4166  *           callback during the call to av_lockmgr_register().
4167  *           Thus, the application must be prepared to handle that.
4168  *           If cb is set to NULL the lockmgr will be unregistered.
4169  *           Also note that during unregistration the previously registered
4170  *           lockmgr callback may also be invoked.
4171  */
4172 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
4173
4174 /**
4175  * Get the type of the given codec.
4176  */
4177 enum AVMediaType avcodec_get_type(enum CodecID codec_id);
4178
4179 /**
4180  * Get the AVClass for AVCodecContext. It can be used in combination with
4181  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4182  *
4183  * @see av_opt_find().
4184  */
4185 const AVClass *avcodec_get_class(void);
4186
4187 #endif /* AVCODEC_AVCODEC_H */