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