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