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