git.sesse.net Git - ffmpeg/blob - libavcodec/avcodec.h

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