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