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  * @ingroup libavc
  27  * Libavcodec external API header
  28  */
  29
  30 #include <errno.h>
  31 #include "libavutil/samplefmt.h"
  32 #include "libavutil/attributes.h"
  33 #include "libavutil/avutil.h"
  34 #include "libavutil/buffer.h"
  35 #include "libavutil/cpu.h"
  36 #include "libavutil/dict.h"
  37 #include "libavutil/frame.h"
  38 #include "libavutil/log.h"
  39 #include "libavutil/pixfmt.h"
  40 #include "libavutil/rational.h"
  41
  42 #include "version.h"
  43
  44 #if FF_API_FAST_MALLOC
  45 // to provide fast_*alloc
  46 #include "libavutil/mem.h"
  47 #endif
  48
  49 /**
  50  * @defgroup libavc Encoding/Decoding Library
  51  * @{
  52  *
  53  * @defgroup lavc_decoding Decoding
  54  * @{
  55  * @}
  56  *
  57  * @defgroup lavc_encoding Encoding
  58  * @{
  59  * @}
  60  *
  61  * @defgroup lavc_codec Codecs
  62  * @{
  63  * @defgroup lavc_codec_native Native Codecs
  64  * @{
  65  * @}
  66  * @defgroup lavc_codec_wrappers External library wrappers
  67  * @{
  68  * @}
  69  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
  70  * @{
  71  * @}
  72  * @}
  73  * @defgroup lavc_internal Internal
  74  * @{
  75  * @}
  76  * @}
  77  */
  78
  79 /**
  80  * @ingroup libavc
  81  * @defgroup lavc_encdec send/receive encoding and decoding API overview
  82  * @{
  83  *
  84  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
  85  * avcodec_receive_packet() functions provide an encode/decode API, which
  86  * decouples input and output.
  87  *
  88  * The API is very similar for encoding/decoding and audio/video, and works as
  89  * follows:
  90  * - Set up and open the AVCodecContext as usual.
  91  * - Send valid input:
  92  *   - For decoding, call avcodec_send_packet() to give the decoder raw
  93  *     compressed data in an AVPacket.
  94  *   - For encoding, call avcodec_send_frame() to give the decoder an AVFrame
  95  *     containing uncompressed audio or video.
  96  *   In both cases, it is recommended that AVPackets and AVFrames are
  97  *   refcounted, or libavcodec might have to copy the input data. (libavformat
  98  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
  99  *   refcounted AVFrames.)
 100  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
 101  *   functions and process their output:
 102  *   - For decoding, call avcodec_receive_frame(). On success, it will return
 103  *     an AVFrame containing uncompressed audio or video data.
 104  *   - For encoding, call avcodec_receive_packet(). On success, it will return
 105  *     an AVPacket with a compressed frame.
 106  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
 107  *   AVERROR(EAGAIN) return value means that new input data is required to
 108  *   return new output. In this case, continue with sending input. For each
 109  *   input frame/packet, the codec will typically return 1 output frame/packet,
 110  *   but it can also be 0 or more than 1.
 111  *
 112  * At the beginning of decoding or encoding, the codec might accept multiple
 113  * input frames/packets without returning a frame, until its internal buffers
 114  * are filled. This situation is handled transparently if you follow the steps
 115  * outlined above.
 116  *
 117  * In theory, sending input can result in EAGAIN - this should happen only if
 118  * not all output was received. You can use this to structure alternative decode
 119  * or encode loops other than the one suggested above. For example, you could
 120  * try sending new input on each iteration, and try to receive output if that
 121  * returns EAGAIN.
 122  *
 123  * End of stream situations. These require "flushing" (aka draining) the codec,
 124  * as the codec might buffer multiple frames or packets internally for
 125  * performance or out of necessity (consider B-frames).
 126  * This is handled as follows:
 127  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
 128  *   or avcodec_send_frame() (encoding) functions. This will enter draining
 129  *   mode.
 130  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
 131  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
 132  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
 133  * - Before decoding can be resumed again, the codec has to be reset with
 134  *   avcodec_flush_buffers().
 135  *
 136  * Using the API as outlined above is highly recommended. But it is also
 137  * possible to call functions outside of this rigid schema. For example, you can
 138  * call avcodec_send_packet() repeatedly without calling
 139  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
 140  * until the codec's internal buffer has been filled up (which is typically of
 141  * size 1 per output frame, after initial input), and then reject input with
 142  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
 143  * read at least some output.
 144  *
 145  * Not all codecs will follow a rigid and predictable dataflow; the only
 146  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
 147  * one end implies that a receive/send call on the other end will succeed. In
 148  * general, no codec will permit unlimited buffering of input or output.
 149  *
 150  * This API replaces the following legacy functions:
 151  * - avcodec_decode_video2() and avcodec_decode_audio4():
 152  *   Use avcodec_send_packet() to feed input to the decoder, then use
 153  *   avcodec_receive_frame() to receive decoded frames after each packet.
 154  *   Unlike with the old video decoding API, multiple frames might result from
 155  *   a packet. For audio, splitting the input packet into frames by partially
 156  *   decoding packets becomes transparent to the API user. You never need to
 157  *   feed an AVPacket to the API twice (unless it is rejected with EAGAIN - then
 158  *   no data was read from the packet).
 159  *   Additionally, sending a flush/draining packet is required only once.
 160  * - avcodec_encode_video2()/avcodec_encode_audio2():
 161  *   Use avcodec_send_frame() to feed input to the encoder, then use
 162  *   avcodec_receive_packet() to receive encoded packets.
 163  *   Providing user-allocated buffers for avcodec_receive_packet() is not
 164  *   possible.
 165  * - The new API does not handle subtitles yet.
 166  *
 167  * Mixing new and old function calls on the same AVCodecContext is not allowed,
 168  * and will result in arbitrary behavior.
 169  *
 170  * Some codecs might require using the new API; using the old API will return
 171  * an error when calling it. All codecs support the new API.
 172  *
 173  * A codec is not allowed to return EAGAIN for both sending and receiving. This
 174  * would be an invalid state, which could put the codec user into an endless
 175  * loop. The API has no concept of time either: it cannot happen that trying to
 176  * do avcodec_send_packet() results in EAGAIN, but a repeated call 1 second
 177  * later accepts the packet (with no other receive/flush API calls involved).
 178  * The API is a strict state machine, and the passage of time is not supposed
 179  * to influence it. Some timing-dependent behavior might still be deemed
 180  * acceptable in certain cases. But it must never result in both send/receive
 181  * returning EAGAIN at the same time at any point. It must also absolutely be
 182  * avoided that the current state is "unstable" and can "flip-flop" between
 183  * the send/receive APIs allowing progress. For example, it's not allowed that
 184  * the codec randomly decides that it actually wants to consume a packet now
 185  * instead of returning a frame, after it just returned EAGAIN on an
 186  * avcodec_send_packet() call.
 187  * @}
 188  */
 189
 190 /**
 191  * @defgroup lavc_core Core functions/structures.
 192  * @ingroup libavc
 193  *
 194  * Basic definitions, functions for querying libavcodec capabilities,
 195  * allocating core structures, etc.
 196  * @{
 197  */
 198
 199
 200 /**
 201  * Identify the syntax and semantics of the bitstream.
 202  * The principle is roughly:
 203  * Two decoders with the same ID can decode the same streams.
 204  * Two encoders with the same ID can encode compatible streams.
 205  * There may be slight deviations from the principle due to implementation
 206  * details.
 207  *
 208  * If you add a codec ID to this list, add it so that
 209  * 1. no value of a existing codec ID changes (that would break ABI),
 210  * 2. it is as close as possible to similar codecs.
 211  *
 212  * After adding new codec IDs, do not forget to add an entry to the codec
 213  * descriptor list and bump libavcodec minor version.
 214  */
 215 enum AVCodecID {
 216     AV_CODEC_ID_NONE,
 217
 218     /* video codecs */
 219     AV_CODEC_ID_MPEG1VIDEO,
 220     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
 221 #if FF_API_XVMC
 222     AV_CODEC_ID_MPEG2VIDEO_XVMC,
 223 #endif /* FF_API_XVMC */
 224     AV_CODEC_ID_H261,
 225     AV_CODEC_ID_H263,
 226     AV_CODEC_ID_RV10,
 227     AV_CODEC_ID_RV20,
 228     AV_CODEC_ID_MJPEG,
 229     AV_CODEC_ID_MJPEGB,
 230     AV_CODEC_ID_LJPEG,
 231     AV_CODEC_ID_SP5X,
 232     AV_CODEC_ID_JPEGLS,
 233     AV_CODEC_ID_MPEG4,
 234     AV_CODEC_ID_RAWVIDEO,
 235     AV_CODEC_ID_MSMPEG4V1,
 236     AV_CODEC_ID_MSMPEG4V2,
 237     AV_CODEC_ID_MSMPEG4V3,
 238     AV_CODEC_ID_WMV1,
 239     AV_CODEC_ID_WMV2,
 240     AV_CODEC_ID_H263P,
 241     AV_CODEC_ID_H263I,
 242     AV_CODEC_ID_FLV1,
 243     AV_CODEC_ID_SVQ1,
 244     AV_CODEC_ID_SVQ3,
 245     AV_CODEC_ID_DVVIDEO,
 246     AV_CODEC_ID_HUFFYUV,
 247     AV_CODEC_ID_CYUV,
 248     AV_CODEC_ID_H264,
 249     AV_CODEC_ID_INDEO3,
 250     AV_CODEC_ID_VP3,
 251     AV_CODEC_ID_THEORA,
 252     AV_CODEC_ID_ASV1,
 253     AV_CODEC_ID_ASV2,
 254     AV_CODEC_ID_FFV1,
 255     AV_CODEC_ID_4XM,
 256     AV_CODEC_ID_VCR1,
 257     AV_CODEC_ID_CLJR,
 258     AV_CODEC_ID_MDEC,
 259     AV_CODEC_ID_ROQ,
 260     AV_CODEC_ID_INTERPLAY_VIDEO,
 261     AV_CODEC_ID_XAN_WC3,
 262     AV_CODEC_ID_XAN_WC4,
 263     AV_CODEC_ID_RPZA,
 264     AV_CODEC_ID_CINEPAK,
 265     AV_CODEC_ID_WS_VQA,
 266     AV_CODEC_ID_MSRLE,
 267     AV_CODEC_ID_MSVIDEO1,
 268     AV_CODEC_ID_IDCIN,
 269     AV_CODEC_ID_8BPS,
 270     AV_CODEC_ID_SMC,
 271     AV_CODEC_ID_FLIC,
 272     AV_CODEC_ID_TRUEMOTION1,
 273     AV_CODEC_ID_VMDVIDEO,
 274     AV_CODEC_ID_MSZH,
 275     AV_CODEC_ID_ZLIB,
 276     AV_CODEC_ID_QTRLE,
 277     AV_CODEC_ID_TSCC,
 278     AV_CODEC_ID_ULTI,
 279     AV_CODEC_ID_QDRAW,
 280     AV_CODEC_ID_VIXL,
 281     AV_CODEC_ID_QPEG,
 282     AV_CODEC_ID_PNG,
 283     AV_CODEC_ID_PPM,
 284     AV_CODEC_ID_PBM,
 285     AV_CODEC_ID_PGM,
 286     AV_CODEC_ID_PGMYUV,
 287     AV_CODEC_ID_PAM,
 288     AV_CODEC_ID_FFVHUFF,
 289     AV_CODEC_ID_RV30,
 290     AV_CODEC_ID_RV40,
 291     AV_CODEC_ID_VC1,
 292     AV_CODEC_ID_WMV3,
 293     AV_CODEC_ID_LOCO,
 294     AV_CODEC_ID_WNV1,
 295     AV_CODEC_ID_AASC,
 296     AV_CODEC_ID_INDEO2,
 297     AV_CODEC_ID_FRAPS,
 298     AV_CODEC_ID_TRUEMOTION2,
 299     AV_CODEC_ID_BMP,
 300     AV_CODEC_ID_CSCD,
 301     AV_CODEC_ID_MMVIDEO,
 302     AV_CODEC_ID_ZMBV,
 303     AV_CODEC_ID_AVS,
 304     AV_CODEC_ID_SMACKVIDEO,
 305     AV_CODEC_ID_NUV,
 306     AV_CODEC_ID_KMVC,
 307     AV_CODEC_ID_FLASHSV,
 308     AV_CODEC_ID_CAVS,
 309     AV_CODEC_ID_JPEG2000,
 310     AV_CODEC_ID_VMNC,
 311     AV_CODEC_ID_VP5,
 312     AV_CODEC_ID_VP6,
 313     AV_CODEC_ID_VP6F,
 314     AV_CODEC_ID_TARGA,
 315     AV_CODEC_ID_DSICINVIDEO,
 316     AV_CODEC_ID_TIERTEXSEQVIDEO,
 317     AV_CODEC_ID_TIFF,
 318     AV_CODEC_ID_GIF,
 319     AV_CODEC_ID_DXA,
 320     AV_CODEC_ID_DNXHD,
 321     AV_CODEC_ID_THP,
 322     AV_CODEC_ID_SGI,
 323     AV_CODEC_ID_C93,
 324     AV_CODEC_ID_BETHSOFTVID,
 325     AV_CODEC_ID_PTX,
 326     AV_CODEC_ID_TXD,
 327     AV_CODEC_ID_VP6A,
 328     AV_CODEC_ID_AMV,
 329     AV_CODEC_ID_VB,
 330     AV_CODEC_ID_PCX,
 331     AV_CODEC_ID_SUNRAST,
 332     AV_CODEC_ID_INDEO4,
 333     AV_CODEC_ID_INDEO5,
 334     AV_CODEC_ID_MIMIC,
 335     AV_CODEC_ID_RL2,
 336     AV_CODEC_ID_ESCAPE124,
 337     AV_CODEC_ID_DIRAC,
 338     AV_CODEC_ID_BFI,
 339     AV_CODEC_ID_CMV,
 340     AV_CODEC_ID_MOTIONPIXELS,
 341     AV_CODEC_ID_TGV,
 342     AV_CODEC_ID_TGQ,
 343     AV_CODEC_ID_TQI,
 344     AV_CODEC_ID_AURA,
 345     AV_CODEC_ID_AURA2,
 346     AV_CODEC_ID_V210X,
 347     AV_CODEC_ID_TMV,
 348     AV_CODEC_ID_V210,
 349     AV_CODEC_ID_DPX,
 350     AV_CODEC_ID_MAD,
 351     AV_CODEC_ID_FRWU,
 352     AV_CODEC_ID_FLASHSV2,
 353     AV_CODEC_ID_CDGRAPHICS,
 354     AV_CODEC_ID_R210,
 355     AV_CODEC_ID_ANM,
 356     AV_CODEC_ID_BINKVIDEO,
 357     AV_CODEC_ID_IFF_ILBM,
 358     AV_CODEC_ID_IFF_BYTERUN1,
 359     AV_CODEC_ID_KGV1,
 360     AV_CODEC_ID_YOP,
 361     AV_CODEC_ID_VP8,
 362     AV_CODEC_ID_PICTOR,
 363     AV_CODEC_ID_ANSI,
 364     AV_CODEC_ID_A64_MULTI,
 365     AV_CODEC_ID_A64_MULTI5,
 366     AV_CODEC_ID_R10K,
 367     AV_CODEC_ID_MXPEG,
 368     AV_CODEC_ID_LAGARITH,
 369     AV_CODEC_ID_PRORES,
 370     AV_CODEC_ID_JV,
 371     AV_CODEC_ID_DFA,
 372     AV_CODEC_ID_WMV3IMAGE,
 373     AV_CODEC_ID_VC1IMAGE,
 374     AV_CODEC_ID_UTVIDEO,
 375     AV_CODEC_ID_BMV_VIDEO,
 376     AV_CODEC_ID_VBLE,
 377     AV_CODEC_ID_DXTORY,
 378     AV_CODEC_ID_V410,
 379     AV_CODEC_ID_XWD,
 380     AV_CODEC_ID_CDXL,
 381     AV_CODEC_ID_XBM,
 382     AV_CODEC_ID_ZEROCODEC,
 383     AV_CODEC_ID_MSS1,
 384     AV_CODEC_ID_MSA1,
 385     AV_CODEC_ID_TSCC2,
 386     AV_CODEC_ID_MTS2,
 387     AV_CODEC_ID_CLLC,
 388     AV_CODEC_ID_MSS2,
 389     AV_CODEC_ID_VP9,
 390     AV_CODEC_ID_AIC,
 391     AV_CODEC_ID_ESCAPE130,
 392     AV_CODEC_ID_G2M,
 393     AV_CODEC_ID_WEBP,
 394     AV_CODEC_ID_HNM4_VIDEO,
 395     AV_CODEC_ID_HEVC,
 396     AV_CODEC_ID_FIC,
 397     AV_CODEC_ID_ALIAS_PIX,
 398     AV_CODEC_ID_BRENDER_PIX,
 399     AV_CODEC_ID_PAF_VIDEO,
 400     AV_CODEC_ID_EXR,
 401     AV_CODEC_ID_VP7,
 402     AV_CODEC_ID_SANM,
 403     AV_CODEC_ID_SGIRLE,
 404     AV_CODEC_ID_MVC1,
 405     AV_CODEC_ID_MVC2,
 406     AV_CODEC_ID_HQX,
 407     AV_CODEC_ID_TDSC,
 408     AV_CODEC_ID_HQ_HQA,
 409     AV_CODEC_ID_HAP,
 410     AV_CODEC_ID_DDS,
 411     AV_CODEC_ID_DXV,
 412     AV_CODEC_ID_SCREENPRESSO,
 413     AV_CODEC_ID_RSCC,
 414     AV_CODEC_ID_MAGICYUV,
 415     AV_CODEC_ID_TRUEMOTION2RT,
 416     AV_CODEC_ID_AV1,
 417     AV_CODEC_ID_PIXLET,
 418     AV_CODEC_ID_CFHD,
 419
 420     /* various PCM "codecs" */
 421     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
 422     AV_CODEC_ID_PCM_S16LE = 0x10000,
 423     AV_CODEC_ID_PCM_S16BE,
 424     AV_CODEC_ID_PCM_U16LE,
 425     AV_CODEC_ID_PCM_U16BE,
 426     AV_CODEC_ID_PCM_S8,
 427     AV_CODEC_ID_PCM_U8,
 428     AV_CODEC_ID_PCM_MULAW,
 429     AV_CODEC_ID_PCM_ALAW,
 430     AV_CODEC_ID_PCM_S32LE,
 431     AV_CODEC_ID_PCM_S32BE,
 432     AV_CODEC_ID_PCM_U32LE,
 433     AV_CODEC_ID_PCM_U32BE,
 434     AV_CODEC_ID_PCM_S24LE,
 435     AV_CODEC_ID_PCM_S24BE,
 436     AV_CODEC_ID_PCM_U24LE,
 437     AV_CODEC_ID_PCM_U24BE,
 438     AV_CODEC_ID_PCM_S24DAUD,
 439     AV_CODEC_ID_PCM_ZORK,
 440     AV_CODEC_ID_PCM_S16LE_PLANAR,
 441     AV_CODEC_ID_PCM_DVD,
 442     AV_CODEC_ID_PCM_F32BE,
 443     AV_CODEC_ID_PCM_F32LE,
 444     AV_CODEC_ID_PCM_F64BE,
 445     AV_CODEC_ID_PCM_F64LE,
 446     AV_CODEC_ID_PCM_BLURAY,
 447     AV_CODEC_ID_PCM_LXF,
 448     AV_CODEC_ID_S302M,
 449     AV_CODEC_ID_PCM_S8_PLANAR,
 450     AV_CODEC_ID_PCM_S24LE_PLANAR,
 451     AV_CODEC_ID_PCM_S32LE_PLANAR,
 452     AV_CODEC_ID_PCM_S16BE_PLANAR,
 453
 454     /* various ADPCM codecs */
 455     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
 456     AV_CODEC_ID_ADPCM_IMA_WAV,
 457     AV_CODEC_ID_ADPCM_IMA_DK3,
 458     AV_CODEC_ID_ADPCM_IMA_DK4,
 459     AV_CODEC_ID_ADPCM_IMA_WS,
 460     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
 461     AV_CODEC_ID_ADPCM_MS,
 462     AV_CODEC_ID_ADPCM_4XM,
 463     AV_CODEC_ID_ADPCM_XA,
 464     AV_CODEC_ID_ADPCM_ADX,
 465     AV_CODEC_ID_ADPCM_EA,
 466     AV_CODEC_ID_ADPCM_G726,
 467     AV_CODEC_ID_ADPCM_CT,
 468     AV_CODEC_ID_ADPCM_SWF,
 469     AV_CODEC_ID_ADPCM_YAMAHA,
 470     AV_CODEC_ID_ADPCM_SBPRO_4,
 471     AV_CODEC_ID_ADPCM_SBPRO_3,
 472     AV_CODEC_ID_ADPCM_SBPRO_2,
 473     AV_CODEC_ID_ADPCM_THP,
 474     AV_CODEC_ID_ADPCM_IMA_AMV,
 475     AV_CODEC_ID_ADPCM_EA_R1,
 476     AV_CODEC_ID_ADPCM_EA_R3,
 477     AV_CODEC_ID_ADPCM_EA_R2,
 478     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
 479     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
 480     AV_CODEC_ID_ADPCM_EA_XAS,
 481     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
 482     AV_CODEC_ID_ADPCM_IMA_ISS,
 483     AV_CODEC_ID_ADPCM_G722,
 484     AV_CODEC_ID_ADPCM_IMA_APC,
 485     AV_CODEC_ID_ADPCM_VIMA,
 486
 487     /* AMR */
 488     AV_CODEC_ID_AMR_NB = 0x12000,
 489     AV_CODEC_ID_AMR_WB,
 490
 491     /* RealAudio codecs*/
 492     AV_CODEC_ID_RA_144 = 0x13000,
 493     AV_CODEC_ID_RA_288,
 494
 495     /* various DPCM codecs */
 496     AV_CODEC_ID_ROQ_DPCM = 0x14000,
 497     AV_CODEC_ID_INTERPLAY_DPCM,
 498     AV_CODEC_ID_XAN_DPCM,
 499     AV_CODEC_ID_SOL_DPCM,
 500
 501     /* audio codecs */
 502     AV_CODEC_ID_MP2 = 0x15000,
 503     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
 504     AV_CODEC_ID_AAC,
 505     AV_CODEC_ID_AC3,
 506     AV_CODEC_ID_DTS,
 507     AV_CODEC_ID_VORBIS,
 508     AV_CODEC_ID_DVAUDIO,
 509     AV_CODEC_ID_WMAV1,
 510     AV_CODEC_ID_WMAV2,
 511     AV_CODEC_ID_MACE3,
 512     AV_CODEC_ID_MACE6,
 513     AV_CODEC_ID_VMDAUDIO,
 514     AV_CODEC_ID_FLAC,
 515     AV_CODEC_ID_MP3ADU,
 516     AV_CODEC_ID_MP3ON4,
 517     AV_CODEC_ID_SHORTEN,
 518     AV_CODEC_ID_ALAC,
 519     AV_CODEC_ID_WESTWOOD_SND1,
 520     AV_CODEC_ID_GSM, ///< as in Berlin toast format
 521     AV_CODEC_ID_QDM2,
 522     AV_CODEC_ID_COOK,
 523     AV_CODEC_ID_TRUESPEECH,
 524     AV_CODEC_ID_TTA,
 525     AV_CODEC_ID_SMACKAUDIO,
 526     AV_CODEC_ID_QCELP,
 527     AV_CODEC_ID_WAVPACK,
 528     AV_CODEC_ID_DSICINAUDIO,
 529     AV_CODEC_ID_IMC,
 530     AV_CODEC_ID_MUSEPACK7,
 531     AV_CODEC_ID_MLP,
 532     AV_CODEC_ID_GSM_MS, /* as found in WAV */
 533     AV_CODEC_ID_ATRAC3,
 534     AV_CODEC_ID_APE,
 535     AV_CODEC_ID_NELLYMOSER,
 536     AV_CODEC_ID_MUSEPACK8,
 537     AV_CODEC_ID_SPEEX,
 538     AV_CODEC_ID_WMAVOICE,
 539     AV_CODEC_ID_WMAPRO,
 540     AV_CODEC_ID_WMALOSSLESS,
 541     AV_CODEC_ID_ATRAC3P,
 542     AV_CODEC_ID_EAC3,
 543     AV_CODEC_ID_SIPR,
 544     AV_CODEC_ID_MP1,
 545     AV_CODEC_ID_TWINVQ,
 546     AV_CODEC_ID_TRUEHD,
 547     AV_CODEC_ID_MP4ALS,
 548     AV_CODEC_ID_ATRAC1,
 549     AV_CODEC_ID_BINKAUDIO_RDFT,
 550     AV_CODEC_ID_BINKAUDIO_DCT,
 551     AV_CODEC_ID_AAC_LATM,
 552     AV_CODEC_ID_QDMC,
 553     AV_CODEC_ID_CELT,
 554     AV_CODEC_ID_G723_1,
 555     AV_CODEC_ID_G729,
 556     AV_CODEC_ID_8SVX_EXP,
 557     AV_CODEC_ID_8SVX_FIB,
 558     AV_CODEC_ID_BMV_AUDIO,
 559     AV_CODEC_ID_RALF,
 560     AV_CODEC_ID_IAC,
 561     AV_CODEC_ID_ILBC,
 562     AV_CODEC_ID_OPUS,
 563     AV_CODEC_ID_COMFORT_NOISE,
 564     AV_CODEC_ID_TAK,
 565     AV_CODEC_ID_METASOUND,
 566     AV_CODEC_ID_PAF_AUDIO,
 567     AV_CODEC_ID_ON2AVC,
 568     AV_CODEC_ID_DSS_SP,
 569
 570     /* subtitle codecs */
 571     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
 572     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
 573     AV_CODEC_ID_DVB_SUBTITLE,
 574     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
 575     AV_CODEC_ID_XSUB,
 576     AV_CODEC_ID_SSA,
 577     AV_CODEC_ID_MOV_TEXT,
 578     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
 579     AV_CODEC_ID_DVB_TELETEXT,
 580     AV_CODEC_ID_SRT,
 581
 582     /* other specific kind of codecs (generally used for attachments) */
 583     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
 584     AV_CODEC_ID_TTF = 0x18000,
 585
 586     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
 587
 588     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
 589                                 * stream (only used by libavformat) */
 590     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
 591                                 * stream (only used by libavformat) */
 592     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
 593     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
 594 };
 595
 596 /**
 597  * This struct describes the properties of a single codec described by an
 598  * AVCodecID.
 599  * @see avcodec_descriptor_get()
 600  */
 601 typedef struct AVCodecDescriptor {
 602     enum AVCodecID     id;
 603     enum AVMediaType type;
 604     /**
 605      * Name of the codec described by this descriptor. It is non-empty and
 606      * unique for each codec descriptor. It should contain alphanumeric
 607      * characters and '_' only.
 608      */
 609     const char      *name;
 610     /**
 611      * A more descriptive name for this codec. May be NULL.
 612      */
 613     const char *long_name;
 614     /**
 615      * Codec properties, a combination of AV_CODEC_PROP_* flags.
 616      */
 617     int             props;
 618     /**
 619      * If non-NULL, an array of profiles recognized for this codec.
 620      * Terminated with FF_PROFILE_UNKNOWN.
 621      */
 622     const struct AVProfile *profiles;
 623 } AVCodecDescriptor;
 624
 625 /**
 626  * Codec uses only intra compression.
 627  * Video codecs only.
 628  */
 629 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
 630 /**
 631  * Codec supports lossy compression. Audio and video codecs only.
 632  * @note a codec may support both lossy and lossless
 633  * compression modes
 634  */
 635 #define AV_CODEC_PROP_LOSSY         (1 << 1)
 636 /**
 637  * Codec supports lossless compression. Audio and video codecs only.
 638  */
 639 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
 640 /**
 641  * Codec supports frame reordering. That is, the coded order (the order in which
 642  * the encoded packets are output by the encoders / stored / input to the
 643  * decoders) may be different from the presentation order of the corresponding
 644  * frames.
 645  *
 646  * For codecs that do not have this property set, PTS and DTS should always be
 647  * equal.
 648  */
 649 #define AV_CODEC_PROP_REORDER       (1 << 3)
 650
 651 /**
 652  * @ingroup lavc_decoding
 653  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
 654  * This is mainly needed because some optimized bitstream readers read
 655  * 32 or 64 bit at once and could read over the end.<br>
 656  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
 657  * MPEG bitstreams could cause overread and segfault.
 658  */
 659 #define AV_INPUT_BUFFER_PADDING_SIZE 8
 660
 661 /**
 662  * @ingroup lavc_encoding
 663  * minimum encoding buffer size
 664  * Used to avoid some checks during header writing.
 665  */
 666 #define AV_INPUT_BUFFER_MIN_SIZE 16384
 667
 668 #if FF_API_WITHOUT_PREFIX
 669 /**
 670  * @deprecated use AV_INPUT_BUFFER_PADDING_SIZE instead
 671  */
 672 #define FF_INPUT_BUFFER_PADDING_SIZE 8
 673
 674 /**
 675  * @deprecated use AV_INPUT_BUFFER_MIN_SIZE instead
 676  */
 677 #define FF_MIN_BUFFER_SIZE 16384
 678 #endif /* FF_API_WITHOUT_PREFIX */
 679
 680 /**
 681  * @ingroup lavc_encoding
 682  * motion estimation type.
 683  * @deprecated use codec private option instead
 684  */
 685 #if FF_API_MOTION_EST
 686 enum Motion_Est_ID {
 687     ME_ZERO = 1,    ///< no search, that is use 0,0 vector whenever one is needed
 688     ME_FULL,
 689     ME_LOG,
 690     ME_PHODS,
 691     ME_EPZS,        ///< enhanced predictive zonal search
 692     ME_X1,          ///< reserved for experiments
 693     ME_HEX,         ///< hexagon based search
 694     ME_UMH,         ///< uneven multi-hexagon search
 695     ME_TESA,        ///< transformed exhaustive search algorithm
 696 };
 697 #endif
 698
 699 /**
 700  * @ingroup lavc_decoding
 701  */
 702 enum AVDiscard{
 703     /* We leave some space between them for extensions (drop some
 704      * keyframes for intra-only or drop just some bidir frames). */
 705     AVDISCARD_NONE    =-16, ///< discard nothing
 706     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
 707     AVDISCARD_NONREF  =  8, ///< discard all non reference
 708     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
 709     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
 710     AVDISCARD_ALL     = 48, ///< discard all
 711 };
 712
 713 enum AVAudioServiceType {
 714     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
 715     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
 716     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
 717     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
 718     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
 719     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
 720     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
 721     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
 722     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
 723     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
 724 };
 725
 726 /**
 727  * @ingroup lavc_encoding
 728  */
 729 typedef struct RcOverride{
 730     int start_frame;
 731     int end_frame;
 732     int qscale; // If this is 0 then quality_factor will be used instead.
 733     float quality_factor;
 734 } RcOverride;
 735
 736 #if FF_API_MAX_BFRAMES
 737 /**
 738  * @deprecated there is no libavcodec-wide limit on the number of B-frames
 739  */
 740 #define FF_MAX_B_FRAMES 16
 741 #endif
 742
 743 /* encoding support
 744    These flags can be passed in AVCodecContext.flags before initialization.
 745    Note: Not everything is supported yet.
 746 */
 747
 748 /**
 749  * Allow decoders to produce frames with data planes that are not aligned
 750  * to CPU requirements (e.g. due to cropping).
 751  */
 752 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
 753 /**
 754  * Use fixed qscale.
 755  */
 756 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
 757 /**
 758  * 4 MV per MB allowed / advanced prediction for H.263.
 759  */
 760 #define AV_CODEC_FLAG_4MV             (1 <<  2)
 761 /**
 762  * Output even those frames that might be corrupted.
 763  */
 764 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
 765 /**
 766  * Use qpel MC.
 767  */
 768 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
 769 /**
 770  * Use internal 2pass ratecontrol in first pass mode.
 771  */
 772 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
 773 /**
 774  * Use internal 2pass ratecontrol in second pass mode.
 775  */
 776 #define AV_CODEC_FLAG_PASS2           (1 << 10)
 777 /**
 778  * loop filter.
 779  */
 780 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
 781 /**
 782  * Only decode/encode grayscale.
 783  */
 784 #define AV_CODEC_FLAG_GRAY            (1 << 13)
 785 /**
 786  * error[?] variables will be set during encoding.
 787  */
 788 #define AV_CODEC_FLAG_PSNR            (1 << 15)
 789 /**
 790  * Input bitstream might be truncated at a random location
 791  * instead of only at frame boundaries.
 792  */
 793 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
 794 /**
 795  * Use interlaced DCT.
 796  */
 797 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
 798 /**
 799  * Force low delay.
 800  */
 801 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
 802 /**
 803  * Place global headers in extradata instead of every keyframe.
 804  */
 805 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
 806 /**
 807  * Use only bitexact stuff (except (I)DCT).
 808  */
 809 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
 810 /* Fx : Flag for H.263+ extra options */
 811 /**
 812  * H.263 advanced intra coding / MPEG-4 AC prediction
 813  */
 814 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
 815 /**
 816  * interlaced motion estimation
 817  */
 818 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
 819 #define AV_CODEC_FLAG_CLOSED_GOP      (1 << 31)
 820
 821 /**
 822  * Allow non spec compliant speedup tricks.
 823  */
 824 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
 825 /**
 826  * Skip bitstream encoding.
 827  */
 828 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
 829 /**
 830  * Place global headers at every keyframe instead of in extradata.
 831  */
 832 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
 833 /**
 834  * Input bitstream might be truncated at a packet boundaries
 835  * instead of only at frame boundaries.
 836  */
 837 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
 838 /**
 839  * Discard cropping information from SPS.
 840  */
 841 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
 842
 843 /* Unsupported options :
 844  *              Syntax Arithmetic coding (SAC)
 845  *              Reference Picture Selection
 846  *              Independent Segment Decoding */
 847 /* /Fx */
 848 /* codec capabilities */
 849
 850 /**
 851  * Decoder can use draw_horiz_band callback.
 852  */
 853 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
 854 /**
 855  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
 856  * If not set, it might not use get_buffer() at all or use operations that
 857  * assume the buffer was allocated by avcodec_default_get_buffer.
 858  */
 859 #define AV_CODEC_CAP_DR1                 (1 <<  1)
 860 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
 861 /**
 862  * Encoder or decoder requires flushing with NULL input at the end in order to
 863  * give the complete and correct output.
 864  *
 865  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
 866  *       with NULL data. The user can still send NULL data to the public encode
 867  *       or decode function, but libavcodec will not pass it along to the codec
 868  *       unless this flag is set.
 869  *
 870  * Decoders:
 871  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
 872  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
 873  * returns frames.
 874  *
 875  * Encoders:
 876  * The encoder needs to be fed with NULL data at the end of encoding until the
 877  * encoder no longer returns data.
 878  *
 879  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
 880  *       flag also means that the encoder must set the pts and duration for
 881  *       each output packet. If this flag is not set, the pts and duration will
 882  *       be determined by libavcodec from the input frame.
 883  */
 884 #define AV_CODEC_CAP_DELAY               (1 <<  5)
 885 /**
 886  * Codec can be fed a final frame with a smaller size.
 887  * This can be used to prevent truncation of the last audio samples.
 888  */
 889 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
 890 /**
 891  * Codec can output multiple frames per AVPacket
 892  * Normally demuxers return one frame at a time, demuxers which do not do
 893  * are connected to a parser to split what they return into proper frames.
 894  * This flag is reserved to the very rare category of codecs which have a
 895  * bitstream that cannot be split into frames without timeconsuming
 896  * operations like full decoding. Demuxers carrying such bitstreams thus
 897  * may return multiple frames in a packet. This has many disadvantages like
 898  * prohibiting stream copy in many cases thus it should only be considered
 899  * as a last resort.
 900  */
 901 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
 902 /**
 903  * Codec is experimental and is thus avoided in favor of non experimental
 904  * encoders
 905  */
 906 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
 907 /**
 908  * Codec should fill in channel configuration and samplerate instead of container
 909  */
 910 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
 911 /**
 912  * Codec supports frame-level multithreading.
 913  */
 914 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
 915 /**
 916  * Codec supports slice-based (or partition-based) multithreading.
 917  */
 918 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
 919 /**
 920  * Codec supports changed parameters at any point.
 921  */
 922 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
 923 /**
 924  * Codec supports avctx->thread_count == 0 (auto).
 925  */
 926 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
 927 /**
 928  * Audio encoder supports receiving a different number of samples in each call.
 929  */
 930 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
 931
 932 #if FF_API_WITHOUT_PREFIX
 933 /**
 934  * Allow decoders to produce frames with data planes that are not aligned
 935  * to CPU requirements (e.g. due to cropping).
 936  */
 937 #define CODEC_FLAG_UNALIGNED 0x0001
 938 #define CODEC_FLAG_QSCALE 0x0002  ///< Use fixed qscale.
 939 #define CODEC_FLAG_4MV    0x0004  ///< 4 MV per MB allowed / advanced prediction for H.263.
 940 #define CODEC_FLAG_OUTPUT_CORRUPT 0x0008 ///< Output even those frames that might be corrupted
 941 #define CODEC_FLAG_QPEL   0x0010  ///< Use qpel MC.
 942 #if FF_API_GMC
 943 /**
 944  * @deprecated use the "gmc" private option of the libxvid encoder
 945  */
 946 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
 947 #endif
 948 #if FF_API_MV0
 949 /**
 950  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
 951  * mpegvideo encoders
 952  */
 953 #define CODEC_FLAG_MV0    0x0040
 954 #endif
 955 #if FF_API_INPUT_PRESERVED
 956 /**
 957  * @deprecated passing reference-counted frames to the encoders replaces this
 958  * flag
 959  */
 960 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
 961 #endif
 962 #define CODEC_FLAG_PASS1           0x0200   ///< Use internal 2pass ratecontrol in first pass mode.
 963 #define CODEC_FLAG_PASS2           0x0400   ///< Use internal 2pass ratecontrol in second pass mode.
 964 #define CODEC_FLAG_GRAY            0x2000   ///< Only decode/encode grayscale.
 965 #if FF_API_EMU_EDGE
 966 /**
 967  * @deprecated edges are not used/required anymore. I.e. this flag is now always
 968  * set.
 969  */
 970 #define CODEC_FLAG_EMU_EDGE        0x4000
 971 #endif
 972 #define CODEC_FLAG_PSNR            0x8000   ///< error[?] variables will be set during encoding.
 973 #define CODEC_FLAG_TRUNCATED       0x00010000 /** Input bitstream might be truncated at a random
 974                                                   location instead of only at frame boundaries. */
 975 #if FF_API_NORMALIZE_AQP
 976 /**
 977  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
 978  * mpegvideo encoders
 979  */
 980 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
 981 #endif
 982 #define CODEC_FLAG_INTERLACED_DCT 0x00040000 ///< Use interlaced DCT.
 983 #define CODEC_FLAG_LOW_DELAY      0x00080000 ///< Force low delay.
 984 #define CODEC_FLAG_GLOBAL_HEADER  0x00400000 ///< Place global headers in extradata instead of every keyframe.
 985 #define CODEC_FLAG_BITEXACT       0x00800000 ///< Use only bitexact stuff (except (I)DCT).
 986 /* Fx : Flag for H.263+ extra options */
 987 #define CODEC_FLAG_AC_PRED        0x01000000 ///< H.263 advanced intra coding / MPEG-4 AC prediction
 988 #define CODEC_FLAG_LOOP_FILTER    0x00000800 ///< loop filter
 989 #define CODEC_FLAG_INTERLACED_ME  0x20000000 ///< interlaced motion estimation
 990 #define CODEC_FLAG_CLOSED_GOP     0x80000000
 991 #define CODEC_FLAG2_FAST          0x00000001 ///< Allow non spec compliant speedup tricks.
 992 #define CODEC_FLAG2_NO_OUTPUT     0x00000004 ///< Skip bitstream encoding.
 993 #define CODEC_FLAG2_LOCAL_HEADER  0x00000008 ///< Place global headers at every keyframe instead of in extradata.
 994 #define CODEC_FLAG2_IGNORE_CROP   0x00010000 ///< Discard cropping information from SPS.
 995
 996 #define CODEC_FLAG2_CHUNKS        0x00008000 ///< Input bitstream might be truncated at a packet boundaries instead of only at frame boundaries.
 997
 998 /* Unsupported options :
 999  *              Syntax Arithmetic coding (SAC)
1000  *              Reference Picture Selection
1001  *              Independent Segment Decoding */
1002 /* /Fx */
1003 /* codec capabilities */
1004
1005 #define CODEC_CAP_DRAW_HORIZ_BAND 0x0001 ///< Decoder can use draw_horiz_band callback.
1006 /**
1007  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1008  * If not set, it might not use get_buffer() at all or use operations that
1009  * assume the buffer was allocated by avcodec_default_get_buffer.
1010  */
1011 #define CODEC_CAP_DR1             0x0002
1012 #define CODEC_CAP_TRUNCATED       0x0008
1013 #if FF_API_XVMC
1014 /* Codec can export data for HW decoding (XvMC). */
1015 #define CODEC_CAP_HWACCEL         0x0010
1016 #endif /* FF_API_XVMC */
1017 /**
1018  * Encoder or decoder requires flushing with NULL input at the end in order to
1019  * give the complete and correct output.
1020  *
1021  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1022  *       with NULL data. The user can still send NULL data to the public encode
1023  *       or decode function, but libavcodec will not pass it along to the codec
1024  *       unless this flag is set.
1025  *
1026  * Decoders:
1027  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1028  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1029  * returns frames.
1030  *
1031  * Encoders:
1032  * The encoder needs to be fed with NULL data at the end of encoding until the
1033  * encoder no longer returns data.
1034  *
1035  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1036  *       flag also means that the encoder must set the pts and duration for
1037  *       each output packet. If this flag is not set, the pts and duration will
1038  *       be determined by libavcodec from the input frame.
1039  */
1040 #define CODEC_CAP_DELAY           0x0020
1041 /**
1042  * Codec can be fed a final frame with a smaller size.
1043  * This can be used to prevent truncation of the last audio samples.
1044  */
1045 #define CODEC_CAP_SMALL_LAST_FRAME 0x0040
1046 /**
1047  * Codec can output multiple frames per AVPacket
1048  * Normally demuxers return one frame at a time, demuxers which do not do
1049  * are connected to a parser to split what they return into proper frames.
1050  * This flag is reserved to the very rare category of codecs which have a
1051  * bitstream that cannot be split into frames without timeconsuming
1052  * operations like full decoding. Demuxers carrying such bitstreams thus
1053  * may return multiple frames in a packet. This has many disadvantages like
1054  * prohibiting stream copy in many cases thus it should only be considered
1055  * as a last resort.
1056  */
1057 #define CODEC_CAP_SUBFRAMES        0x0100
1058 /**
1059  * Codec is experimental and is thus avoided in favor of non experimental
1060  * encoders
1061  */
1062 #define CODEC_CAP_EXPERIMENTAL     0x0200
1063 /**
1064  * Codec should fill in channel configuration and samplerate instead of container
1065  */
1066 #define CODEC_CAP_CHANNEL_CONF     0x0400
1067 #if FF_API_NEG_LINESIZES
1068 /**
1069  * @deprecated no codecs use this capability
1070  */
1071 #define CODEC_CAP_NEG_LINESIZES    0x0800
1072 #endif
1073 /**
1074  * Codec supports frame-level multithreading.
1075  */
1076 #define CODEC_CAP_FRAME_THREADS    0x1000
1077 /**
1078  * Codec supports slice-based (or partition-based) multithreading.
1079  */
1080 #define CODEC_CAP_SLICE_THREADS    0x2000
1081 /**
1082  * Codec supports changed parameters at any point.
1083  */
1084 #define CODEC_CAP_PARAM_CHANGE     0x4000
1085 /**
1086  * Codec supports avctx->thread_count == 0 (auto).
1087  */
1088 #define CODEC_CAP_AUTO_THREADS     0x8000
1089 /**
1090  * Audio encoder supports receiving a different number of samples in each call.
1091  */
1092 #define CODEC_CAP_VARIABLE_FRAME_SIZE 0x10000
1093 #endif /* FF_API_WITHOUT_PREFIX */
1094
1095 #if FF_API_MB_TYPE
1096 //The following defines may change, don't expect compatibility if you use them.
1097 #define MB_TYPE_INTRA4x4   0x0001
1098 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1099 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1100 #define MB_TYPE_16x16      0x0008
1101 #define MB_TYPE_16x8       0x0010
1102 #define MB_TYPE_8x16       0x0020
1103 #define MB_TYPE_8x8        0x0040
1104 #define MB_TYPE_INTERLACED 0x0080
1105 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1106 #define MB_TYPE_ACPRED     0x0200
1107 #define MB_TYPE_GMC        0x0400
1108 #define MB_TYPE_SKIP       0x0800
1109 #define MB_TYPE_P0L0       0x1000
1110 #define MB_TYPE_P1L0       0x2000
1111 #define MB_TYPE_P0L1       0x4000
1112 #define MB_TYPE_P1L1       0x8000
1113 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1114 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1115 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1116 #define MB_TYPE_QUANT      0x00010000
1117 #define MB_TYPE_CBP        0x00020000
1118 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1119 #endif
1120
1121 /**
1122  * Pan Scan area.
1123  * This specifies the area which should be displayed.
1124  * Note there may be multiple such areas for one frame.
1125  */
1126 typedef struct AVPanScan{
1127     /**
1128      * id
1129      * - encoding: Set by user.
1130      * - decoding: Set by libavcodec.
1131      */
1132     int id;
1133
1134     /**
1135      * width and height in 1/16 pel
1136      * - encoding: Set by user.
1137      * - decoding: Set by libavcodec.
1138      */
1139     int width;
1140     int height;
1141
1142     /**
1143      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1144      * - encoding: Set by user.
1145      * - decoding: Set by libavcodec.
1146      */
1147     int16_t position[3][2];
1148 }AVPanScan;
1149
1150 /**
1151  * This structure describes the bitrate properties of an encoded bitstream. It
1152  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1153  * parameters for H.264/HEVC.
1154  */
1155 typedef struct AVCPBProperties {
1156     /**
1157      * Maximum bitrate of the stream, in bits per second.
1158      * Zero if unknown or unspecified.
1159      */
1160     int max_bitrate;
1161     /**
1162      * Minimum bitrate of the stream, in bits per second.
1163      * Zero if unknown or unspecified.
1164      */
1165     int min_bitrate;
1166     /**
1167      * Average bitrate of the stream, in bits per second.
1168      * Zero if unknown or unspecified.
1169      */
1170     int avg_bitrate;
1171
1172     /**
1173      * The size of the buffer to which the ratecontrol is applied, in bits.
1174      * Zero if unknown or unspecified.
1175      */
1176     int buffer_size;
1177
1178     /**
1179      * The delay between the time the packet this structure is associated with
1180      * is received and the time when it should be decoded, in periods of a 27MHz
1181      * clock.
1182      *
1183      * UINT64_MAX when unknown or unspecified.
1184      */
1185     uint64_t vbv_delay;
1186 } AVCPBProperties;
1187
1188 #if FF_API_QSCALE_TYPE
1189 #define FF_QSCALE_TYPE_MPEG1 0
1190 #define FF_QSCALE_TYPE_MPEG2 1
1191 #define FF_QSCALE_TYPE_H264  2
1192 #define FF_QSCALE_TYPE_VP56  3
1193 #endif
1194
1195 /**
1196  * The decoder will keep a reference to the frame and may reuse it later.
1197  */
1198 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1199
1200 /**
1201  * @defgroup lavc_packet AVPacket
1202  *
1203  * Types and functions for working with AVPacket.
1204  * @{
1205  */
1206 enum AVPacketSideDataType {
1207     /**
1208      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1209      * bytes worth of palette. This side data signals that a new palette is
1210      * present.
1211      */
1212     AV_PKT_DATA_PALETTE,
1213
1214     /**
1215      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1216      * that the extradata buffer was changed and the receiving side should
1217      * act upon it appropriately. The new extradata is embedded in the side
1218      * data buffer and should be immediately used for processing the current
1219      * frame or packet.
1220      */
1221     AV_PKT_DATA_NEW_EXTRADATA,
1222
1223     /**
1224      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1225      * @code
1226      * u32le param_flags
1227      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1228      *     s32le channel_count
1229      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1230      *     u64le channel_layout
1231      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1232      *     s32le sample_rate
1233      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1234      *     s32le width
1235      *     s32le height
1236      * @endcode
1237      */
1238     AV_PKT_DATA_PARAM_CHANGE,
1239
1240     /**
1241      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1242      * structures with info about macroblocks relevant to splitting the
1243      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1244      * That is, it does not necessarily contain info about all macroblocks,
1245      * as long as the distance between macroblocks in the info is smaller
1246      * than the target payload size.
1247      * Each MB info structure is 12 bytes, and is laid out as follows:
1248      * @code
1249      * u32le bit offset from the start of the packet
1250      * u8    current quantizer at the start of the macroblock
1251      * u8    GOB number
1252      * u16le macroblock address within the GOB
1253      * u8    horizontal MV predictor
1254      * u8    vertical MV predictor
1255      * u8    horizontal MV predictor for block number 3
1256      * u8    vertical MV predictor for block number 3
1257      * @endcode
1258      */
1259     AV_PKT_DATA_H263_MB_INFO,
1260
1261     /**
1262      * This side data should be associated with an audio stream and contains
1263      * ReplayGain information in form of the AVReplayGain struct.
1264      */
1265     AV_PKT_DATA_REPLAYGAIN,
1266
1267     /**
1268      * This side data contains a 3x3 transformation matrix describing an affine
1269      * transformation that needs to be applied to the decoded video frames for
1270      * correct presentation.
1271      *
1272      * See libavutil/display.h for a detailed description of the data.
1273      */
1274     AV_PKT_DATA_DISPLAYMATRIX,
1275
1276     /**
1277      * This side data should be associated with a video stream and contains
1278      * Stereoscopic 3D information in form of the AVStereo3D struct.
1279      */
1280     AV_PKT_DATA_STEREO3D,
1281
1282     /**
1283      * This side data should be associated with an audio stream and corresponds
1284      * to enum AVAudioServiceType.
1285      */
1286     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1287
1288     /**
1289      * This side data contains an integer value representing the quality
1290      * factor of the compressed frame. Allowed range is between 1 (good)
1291      * and FF_LAMBDA_MAX (bad).
1292      */
1293     AV_PKT_DATA_QUALITY_FACTOR,
1294
1295     /**
1296      * This side data contains an integer value representing the stream index
1297      * of a "fallback" track.  A fallback track indicates an alternate
1298      * track to use when the current track can not be decoded for some reason.
1299      * e.g. no decoder available for codec.
1300      */
1301     AV_PKT_DATA_FALLBACK_TRACK,
1302
1303     /**
1304      * This side data corresponds to the AVCPBProperties struct.
1305      */
1306     AV_PKT_DATA_CPB_PROPERTIES,
1307
1308     /**
1309      * This side data should be associated with a video stream and corresponds
1310      * to the AVSphericalMapping structure.
1311      */
1312     AV_PKT_DATA_SPHERICAL,
1313 };
1314
1315 typedef struct AVPacketSideData {
1316     uint8_t *data;
1317     int      size;
1318     enum AVPacketSideDataType type;
1319 } AVPacketSideData;
1320
1321 /**
1322  * This structure stores compressed data. It is typically exported by demuxers
1323  * and then passed as input to decoders, or received as output from encoders and
1324  * then passed to muxers.
1325  *
1326  * For video, it should typically contain one compressed frame. For audio it may
1327  * contain several compressed frames. Encoders are allowed to output empty
1328  * packets, with no compressed data, containing only side data
1329  * (e.g. to update some stream parameters at the end of encoding).
1330  *
1331  * AVPacket is one of the few structs in Libav, whose size is a part of public
1332  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1333  * without libavcodec and libavformat major bump.
1334  *
1335  * The semantics of data ownership depends on the buf field.
1336  * If it is set, the packet data is dynamically allocated and is
1337  * valid indefinitely until a call to av_packet_unref() reduces the
1338  * reference count to 0.
1339  *
1340  * If the buf field is not set av_packet_ref() would make a copy instead
1341  * of increasing the reference count.
1342  *
1343  * The side data is always allocated with av_malloc(), copied by
1344  * av_packet_ref() and freed by av_packet_unref().
1345  *
1346  * @see av_packet_ref
1347  * @see av_packet_unref
1348  */
1349 typedef struct AVPacket {
1350     /**
1351      * A reference to the reference-counted buffer where the packet data is
1352      * stored.
1353      * May be NULL, then the packet data is not reference-counted.
1354      */
1355     AVBufferRef *buf;
1356     /**
1357      * Presentation timestamp in AVStream->time_base units; the time at which
1358      * the decompressed packet will be presented to the user.
1359      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1360      * pts MUST be larger or equal to dts as presentation cannot happen before
1361      * decompression, unless one wants to view hex dumps. Some formats misuse
1362      * the terms dts and pts/cts to mean something different. Such timestamps
1363      * must be converted to true pts/dts before they are stored in AVPacket.
1364      */
1365     int64_t pts;
1366     /**
1367      * Decompression timestamp in AVStream->time_base units; the time at which
1368      * the packet is decompressed.
1369      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1370      */
1371     int64_t dts;
1372     uint8_t *data;
1373     int   size;
1374     int   stream_index;
1375     /**
1376      * A combination of AV_PKT_FLAG values
1377      */
1378     int   flags;
1379     /**
1380      * Additional packet data that can be provided by the container.
1381      * Packet can contain several types of side information.
1382      */
1383     AVPacketSideData *side_data;
1384     int side_data_elems;
1385
1386     /**
1387      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1388      * Equals next_pts - this_pts in presentation order.
1389      */
1390     int64_t duration;
1391
1392     int64_t pos;                            ///< byte position in stream, -1 if unknown
1393
1394 #if FF_API_CONVERGENCE_DURATION
1395     /**
1396      * @deprecated Same as the duration field, but as int64_t. This was required
1397      * for Matroska subtitles, whose duration values could overflow when the
1398      * duration field was still an int.
1399      */
1400     attribute_deprecated
1401     int64_t convergence_duration;
1402 #endif
1403 } AVPacket;
1404 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1405 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1406
1407 enum AVSideDataParamChangeFlags {
1408     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1409     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1410     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1411     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1412 };
1413 /**
1414  * @}
1415  */
1416
1417 struct AVCodecInternal;
1418
1419 enum AVFieldOrder {
1420     AV_FIELD_UNKNOWN,
1421     AV_FIELD_PROGRESSIVE,
1422     AV_FIELD_TT,          //< Top coded_first, top displayed first
1423     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1424     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1425     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1426 };
1427
1428 /**
1429  * main external API structure.
1430  * New fields can be added to the end with minor version bumps.
1431  * Removal, reordering and changes to existing fields require a major
1432  * version bump.
1433  * sizeof(AVCodecContext) must not be used outside libav*.
1434  */
1435 typedef struct AVCodecContext {
1436     /**
1437      * information on struct for av_log
1438      * - set by avcodec_alloc_context3
1439      */
1440     const AVClass *av_class;
1441     int log_level_offset;
1442
1443     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1444     const struct AVCodec  *codec;
1445 #if FF_API_CODEC_NAME
1446     /**
1447      * @deprecated this field is not used for anything in libavcodec
1448      */
1449     attribute_deprecated
1450     char             codec_name[32];
1451 #endif
1452     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1453
1454     /**
1455      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1456      * This is used to work around some encoder bugs.
1457      * A demuxer should set this to what is stored in the field used to identify the codec.
1458      * If there are multiple such fields in a container then the demuxer should choose the one
1459      * which maximizes the information about the used codec.
1460      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1461      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1462      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1463      * first.
1464      * - encoding: Set by user, if not then the default based on codec_id will be used.
1465      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1466      */
1467     unsigned int codec_tag;
1468
1469 #if FF_API_STREAM_CODEC_TAG
1470     /**
1471      * @deprecated this field is unused
1472      */
1473     attribute_deprecated
1474     unsigned int stream_codec_tag;
1475 #endif
1476
1477     void *priv_data;
1478
1479     /**
1480      * Private context used for internal data.
1481      *
1482      * Unlike priv_data, this is not codec-specific. It is used in general
1483      * libavcodec functions.
1484      */
1485     struct AVCodecInternal *internal;
1486
1487     /**
1488      * Private data of the user, can be used to carry app specific stuff.
1489      * - encoding: Set by user.
1490      * - decoding: Set by user.
1491      */
1492     void *opaque;
1493
1494     /**
1495      * the average bitrate
1496      * - encoding: Set by user; unused for constant quantizer encoding.
1497      * - decoding: Set by libavcodec. 0 or some bitrate if this info is available in the stream.
1498      */
1499     int bit_rate;
1500
1501     /**
1502      * number of bits the bitstream is allowed to diverge from the reference.
1503      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1504      * - encoding: Set by user; unused for constant quantizer encoding.
1505      * - decoding: unused
1506      */
1507     int bit_rate_tolerance;
1508
1509     /**
1510      * Global quality for codecs which cannot change it per frame.
1511      * This should be proportional to MPEG-1/2/4 qscale.
1512      * - encoding: Set by user.
1513      * - decoding: unused
1514      */
1515     int global_quality;
1516
1517     /**
1518      * - encoding: Set by user.
1519      * - decoding: unused
1520      */
1521     int compression_level;
1522 #define FF_COMPRESSION_DEFAULT -1
1523
1524     /**
1525      * AV_CODEC_FLAG_*.
1526      * - encoding: Set by user.
1527      * - decoding: Set by user.
1528      */
1529     int flags;
1530
1531     /**
1532      * AV_CODEC_FLAG2_*
1533      * - encoding: Set by user.
1534      * - decoding: Set by user.
1535      */
1536     int flags2;
1537
1538     /**
1539      * some codecs need / can use extradata like Huffman tables.
1540      * MJPEG: Huffman tables
1541      * rv10: additional flags
1542      * MPEG-4: global headers (they can be in the bitstream or here)
1543      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1544      * than extradata_size to avoid problems if it is read with the bitstream reader.
1545      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1546      * - encoding: Set/allocated/freed by libavcodec.
1547      * - decoding: Set/allocated/freed by user.
1548      */
1549     uint8_t *extradata;
1550     int extradata_size;
1551
1552     /**
1553      * This is the fundamental unit of time (in seconds) in terms
1554      * of which frame timestamps are represented. For fixed-fps content,
1555      * timebase should be 1/framerate and timestamp increments should be
1556      * identically 1.
1557      * - encoding: MUST be set by user.
1558      * - decoding: the use of this field for decoding is deprecated.
1559      *             Use framerate instead.
1560      */
1561     AVRational time_base;
1562
1563     /**
1564      * For some codecs, the time base is closer to the field rate than the frame rate.
1565      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1566      * if no telecine is used ...
1567      *
1568      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1569      */
1570     int ticks_per_frame;
1571
1572     /**
1573      * Codec delay.
1574      *
1575      * Video:
1576      *   Number of frames the decoded output will be delayed relative to the
1577      *   encoded input.
1578      *
1579      * Audio:
1580      *   For encoding, this field is unused (see initial_padding).
1581      *
1582      *   For decoding, this is the number of samples the decoder needs to
1583      *   output before the decoder's output is valid. When seeking, you should
1584      *   start decoding this many samples prior to your desired seek point.
1585      *
1586      * - encoding: Set by libavcodec.
1587      * - decoding: Set by libavcodec.
1588      */
1589     int delay;
1590
1591
1592     /* video only */
1593     /**
1594      * picture width / height.
1595      *
1596      * @note Those fields may not match the values of the last
1597      * AVFrame output by avcodec_decode_video2 due frame
1598      * reordering.
1599      *
1600      * - encoding: MUST be set by user.
1601      * - decoding: May be set by the user before opening the decoder if known e.g.
1602      *             from the container. Some decoders will require the dimensions
1603      *             to be set by the caller. During decoding, the decoder may
1604      *             overwrite those values as required while parsing the data.
1605      */
1606     int width, height;
1607
1608     /**
1609      * Bitstream width / height, may be different from width/height e.g. when
1610      * the decoded frame is cropped before being output.
1611      *
1612      * @note Those field may not match the value of the last
1613      * AVFrame output by avcodec_receive_frame() due frame
1614      * reordering.
1615      *
1616      * - encoding: unused
1617      * - decoding: May be set by the user before opening the decoder if known
1618      *             e.g. from the container. During decoding, the decoder may
1619      *             overwrite those values as required while parsing the data.
1620      */
1621     int coded_width, coded_height;
1622
1623 #if FF_API_ASPECT_EXTENDED
1624 #define FF_ASPECT_EXTENDED 15
1625 #endif
1626
1627     /**
1628      * the number of pictures in a group of pictures, or 0 for intra_only
1629      * - encoding: Set by user.
1630      * - decoding: unused
1631      */
1632     int gop_size;
1633
1634     /**
1635      * Pixel format, see AV_PIX_FMT_xxx.
1636      * May be set by the demuxer if known from headers.
1637      * May be overridden by the decoder if it knows better.
1638      *
1639      * @note This field may not match the value of the last
1640      * AVFrame output by avcodec_receive_frame() due frame
1641      * reordering.
1642      *
1643      * - encoding: Set by user.
1644      * - decoding: Set by user if known, overridden by libavcodec while
1645      *             parsing the data.
1646      */
1647     enum AVPixelFormat pix_fmt;
1648
1649 #if FF_API_MOTION_EST
1650     /**
1651      * This option does nothing
1652      * @deprecated use codec private options instead
1653      */
1654     attribute_deprecated int me_method;
1655 #endif
1656
1657     /**
1658      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1659      * decoder to draw a horizontal band. It improves cache usage. Not
1660      * all codecs can do that. You must check the codec capabilities
1661      * beforehand.
1662      * When multithreading is used, it may be called from multiple threads
1663      * at the same time; threads might draw different parts of the same AVFrame,
1664      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1665      * in order.
1666      * The function is also used by hardware acceleration APIs.
1667      * It is called at least once during frame decoding to pass
1668      * the data needed for hardware render.
1669      * In that mode instead of pixel data, AVFrame points to
1670      * a structure specific to the acceleration API. The application
1671      * reads the structure and can change some fields to indicate progress
1672      * or mark state.
1673      * - encoding: unused
1674      * - decoding: Set by user.
1675      * @param height the height of the slice
1676      * @param y the y position of the slice
1677      * @param type 1->top field, 2->bottom field, 3->frame
1678      * @param offset offset into the AVFrame.data from which the slice should be read
1679      */
1680     void (*draw_horiz_band)(struct AVCodecContext *s,
1681                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1682                             int y, int type, int height);
1683
1684     /**
1685      * callback to negotiate the pixelFormat
1686      * @param fmt is the list of formats which are supported by the codec,
1687      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1688      * The first is always the native one.
1689      * @note The callback may be called again immediately if initialization for
1690      * the selected (hardware-accelerated) pixel format failed.
1691      * @warning Behavior is undefined if the callback returns a value not
1692      * in the fmt list of formats.
1693      * @return the chosen format
1694      * - encoding: unused
1695      * - decoding: Set by user, if not set the native format will be chosen.
1696      */
1697     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1698
1699     /**
1700      * maximum number of B-frames between non-B-frames
1701      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1702      * - encoding: Set by user.
1703      * - decoding: unused
1704      */
1705     int max_b_frames;
1706
1707     /**
1708      * qscale factor between IP and B-frames
1709      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1710      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1711      * - encoding: Set by user.
1712      * - decoding: unused
1713      */
1714     float b_quant_factor;
1715
1716 #if FF_API_RC_STRATEGY
1717     /** @deprecated use codec private option instead */
1718     attribute_deprecated int rc_strategy;
1719 #define FF_RC_STRATEGY_XVID 1
1720 #endif
1721
1722 #if FF_API_PRIVATE_OPT
1723     /** @deprecated use encoder private options instead */
1724     attribute_deprecated
1725     int b_frame_strategy;
1726 #endif
1727
1728     /**
1729      * qscale offset between IP and B-frames
1730      * - encoding: Set by user.
1731      * - decoding: unused
1732      */
1733     float b_quant_offset;
1734
1735     /**
1736      * Size of the frame reordering buffer in the decoder.
1737      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1738      * - encoding: Set by libavcodec.
1739      * - decoding: Set by libavcodec.
1740      */
1741     int has_b_frames;
1742
1743 #if FF_API_PRIVATE_OPT
1744     /** @deprecated use encoder private options instead */
1745     attribute_deprecated
1746     int mpeg_quant;
1747 #endif
1748
1749     /**
1750      * qscale factor between P- and I-frames
1751      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1752      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1753      * - encoding: Set by user.
1754      * - decoding: unused
1755      */
1756     float i_quant_factor;
1757
1758     /**
1759      * qscale offset between P and I-frames
1760      * - encoding: Set by user.
1761      * - decoding: unused
1762      */
1763     float i_quant_offset;
1764
1765     /**
1766      * luminance masking (0-> disabled)
1767      * - encoding: Set by user.
1768      * - decoding: unused
1769      */
1770     float lumi_masking;
1771
1772     /**
1773      * temporary complexity masking (0-> disabled)
1774      * - encoding: Set by user.
1775      * - decoding: unused
1776      */
1777     float temporal_cplx_masking;
1778
1779     /**
1780      * spatial complexity masking (0-> disabled)
1781      * - encoding: Set by user.
1782      * - decoding: unused
1783      */
1784     float spatial_cplx_masking;
1785
1786     /**
1787      * p block masking (0-> disabled)
1788      * - encoding: Set by user.
1789      * - decoding: unused
1790      */
1791     float p_masking;
1792
1793     /**
1794      * darkness masking (0-> disabled)
1795      * - encoding: Set by user.
1796      * - decoding: unused
1797      */
1798     float dark_masking;
1799
1800     /**
1801      * slice count
1802      * - encoding: Set by libavcodec.
1803      * - decoding: Set by user (or 0).
1804      */
1805     int slice_count;
1806
1807 #if FF_API_PRIVATE_OPT
1808     /** @deprecated use encoder private options instead */
1809     attribute_deprecated
1810      int prediction_method;
1811 #define FF_PRED_LEFT   0
1812 #define FF_PRED_PLANE  1
1813 #define FF_PRED_MEDIAN 2
1814 #endif
1815
1816     /**
1817      * slice offsets in the frame in bytes
1818      * - encoding: Set/allocated by libavcodec.
1819      * - decoding: Set/allocated by user (or NULL).
1820      */
1821     int *slice_offset;
1822
1823     /**
1824      * sample aspect ratio (0 if unknown)
1825      * That is the width of a pixel divided by the height of the pixel.
1826      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1827      * - encoding: Set by user.
1828      * - decoding: Set by libavcodec.
1829      */
1830     AVRational sample_aspect_ratio;
1831
1832     /**
1833      * motion estimation comparison function
1834      * - encoding: Set by user.
1835      * - decoding: unused
1836      */
1837     int me_cmp;
1838     /**
1839      * subpixel motion estimation comparison function
1840      * - encoding: Set by user.
1841      * - decoding: unused
1842      */
1843     int me_sub_cmp;
1844     /**
1845      * macroblock comparison function (not supported yet)
1846      * - encoding: Set by user.
1847      * - decoding: unused
1848      */
1849     int mb_cmp;
1850     /**
1851      * interlaced DCT comparison function
1852      * - encoding: Set by user.
1853      * - decoding: unused
1854      */
1855     int ildct_cmp;
1856 #define FF_CMP_SAD    0
1857 #define FF_CMP_SSE    1
1858 #define FF_CMP_SATD   2
1859 #define FF_CMP_DCT    3
1860 #define FF_CMP_PSNR   4
1861 #define FF_CMP_BIT    5
1862 #define FF_CMP_RD     6
1863 #define FF_CMP_ZERO   7
1864 #define FF_CMP_VSAD   8
1865 #define FF_CMP_VSSE   9
1866 #define FF_CMP_NSSE   10
1867 #define FF_CMP_DCTMAX 13
1868 #define FF_CMP_DCT264 14
1869 #define FF_CMP_CHROMA 256
1870
1871     /**
1872      * ME diamond size & shape
1873      * - encoding: Set by user.
1874      * - decoding: unused
1875      */
1876     int dia_size;
1877
1878     /**
1879      * amount of previous MV predictors (2a+1 x 2a+1 square)
1880      * - encoding: Set by user.
1881      * - decoding: unused
1882      */
1883     int last_predictor_count;
1884
1885 #if FF_API_PRIVATE_OPT
1886     /** @deprecated use encoder private options instead */
1887     attribute_deprecated
1888     int pre_me;
1889 #endif
1890
1891     /**
1892      * motion estimation prepass comparison function
1893      * - encoding: Set by user.
1894      * - decoding: unused
1895      */
1896     int me_pre_cmp;
1897
1898     /**
1899      * ME prepass diamond size & shape
1900      * - encoding: Set by user.
1901      * - decoding: unused
1902      */
1903     int pre_dia_size;
1904
1905     /**
1906      * subpel ME quality
1907      * - encoding: Set by user.
1908      * - decoding: unused
1909      */
1910     int me_subpel_quality;
1911
1912 #if FF_API_AFD
1913     /**
1914      * DTG active format information (additional aspect ratio
1915      * information only used in DVB MPEG-2 transport streams)
1916      * 0 if not set.
1917      *
1918      * - encoding: unused
1919      * - decoding: Set by decoder.
1920      * @deprecated Deprecated in favor of AVSideData
1921      */
1922     attribute_deprecated int dtg_active_format;
1923 #define FF_DTG_AFD_SAME         8
1924 #define FF_DTG_AFD_4_3          9
1925 #define FF_DTG_AFD_16_9         10
1926 #define FF_DTG_AFD_14_9         11
1927 #define FF_DTG_AFD_4_3_SP_14_9  13
1928 #define FF_DTG_AFD_16_9_SP_14_9 14
1929 #define FF_DTG_AFD_SP_4_3       15
1930 #endif /* FF_API_AFD */
1931
1932     /**
1933      * maximum motion estimation search range in subpel units
1934      * If 0 then no limit.
1935      *
1936      * - encoding: Set by user.
1937      * - decoding: unused
1938      */
1939     int me_range;
1940
1941 #if FF_API_QUANT_BIAS
1942     /**
1943      * @deprecated use encoder private option instead
1944      */
1945     attribute_deprecated int intra_quant_bias;
1946 #define FF_DEFAULT_QUANT_BIAS 999999
1947
1948     /**
1949      * @deprecated use encoder private option instead
1950      */
1951     attribute_deprecated int inter_quant_bias;
1952 #endif
1953
1954     /**
1955      * slice flags
1956      * - encoding: unused
1957      * - decoding: Set by user.
1958      */
1959     int slice_flags;
1960 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1961 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1962 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1963
1964 #if FF_API_XVMC
1965     /**
1966      * XVideo Motion Acceleration
1967      * - encoding: forbidden
1968      * - decoding: set by decoder
1969      * @deprecated XvMC support is slated for removal.
1970      */
1971     attribute_deprecated int xvmc_acceleration;
1972 #endif /* FF_API_XVMC */
1973
1974     /**
1975      * macroblock decision mode
1976      * - encoding: Set by user.
1977      * - decoding: unused
1978      */
1979     int mb_decision;
1980 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1981 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1982 #define FF_MB_DECISION_RD     2        ///< rate distortion
1983
1984     /**
1985      * custom intra quantization matrix
1986      * - encoding: Set by user, can be NULL.
1987      * - decoding: Set by libavcodec.
1988      */
1989     uint16_t *intra_matrix;
1990
1991     /**
1992      * custom inter quantization matrix
1993      * - encoding: Set by user, can be NULL.
1994      * - decoding: Set by libavcodec.
1995      */
1996     uint16_t *inter_matrix;
1997
1998 #if FF_API_PRIVATE_OPT
1999     /** @deprecated use encoder private options instead */
2000     attribute_deprecated
2001     int scenechange_threshold;
2002
2003     /** @deprecated use encoder private options instead */
2004     attribute_deprecated
2005     int noise_reduction;
2006 #endif
2007
2008 #if FF_API_MPV_OPT
2009     /**
2010      * @deprecated this field is unused
2011      */
2012     attribute_deprecated
2013     int me_threshold;
2014
2015     /**
2016      * @deprecated this field is unused
2017      */
2018     attribute_deprecated
2019     int mb_threshold;
2020 #endif
2021
2022     /**
2023      * precision of the intra DC coefficient - 8
2024      * - encoding: Set by user.
2025      * - decoding: unused
2026      */
2027     int intra_dc_precision;
2028
2029     /**
2030      * Number of macroblock rows at the top which are skipped.
2031      * - encoding: unused
2032      * - decoding: Set by user.
2033      */
2034     int skip_top;
2035
2036     /**
2037      * Number of macroblock rows at the bottom which are skipped.
2038      * - encoding: unused
2039      * - decoding: Set by user.
2040      */
2041     int skip_bottom;
2042
2043 #if FF_API_MPV_OPT
2044     /**
2045      * @deprecated use encoder private options instead
2046      */
2047     attribute_deprecated
2048     float border_masking;
2049 #endif
2050
2051     /**
2052      * minimum MB Lagrange multiplier
2053      * - encoding: Set by user.
2054      * - decoding: unused
2055      */
2056     int mb_lmin;
2057
2058     /**
2059      * maximum MB Lagrange multiplier
2060      * - encoding: Set by user.
2061      * - decoding: unused
2062      */
2063     int mb_lmax;
2064
2065 #if FF_API_PRIVATE_OPT
2066     /**
2067      * @deprecated use encoder private options instead
2068      */
2069     attribute_deprecated
2070     int me_penalty_compensation;
2071 #endif
2072
2073     /**
2074      * - encoding: Set by user.
2075      * - decoding: unused
2076      */
2077     int bidir_refine;
2078
2079 #if FF_API_PRIVATE_OPT
2080     /** @deprecated use encoder private options instead */
2081     attribute_deprecated
2082     int brd_scale;
2083 #endif
2084
2085     /**
2086      * minimum GOP size
2087      * - encoding: Set by user.
2088      * - decoding: unused
2089      */
2090     int keyint_min;
2091
2092     /**
2093      * number of reference frames
2094      * - encoding: Set by user.
2095      * - decoding: Set by lavc.
2096      */
2097     int refs;
2098
2099 #if FF_API_PRIVATE_OPT
2100     /** @deprecated use encoder private options instead */
2101     attribute_deprecated
2102     int chromaoffset;
2103 #endif
2104
2105 #if FF_API_UNUSED_MEMBERS
2106     /**
2107      * Multiplied by qscale for each frame and added to scene_change_score.
2108      * - encoding: Set by user.
2109      * - decoding: unused
2110      */
2111     attribute_deprecated int scenechange_factor;
2112 #endif
2113
2114     /**
2115      * Note: Value depends upon the compare function used for fullpel ME.
2116      * - encoding: Set by user.
2117      * - decoding: unused
2118      */
2119     int mv0_threshold;
2120
2121 #if FF_API_PRIVATE_OPT
2122     /** @deprecated use encoder private options instead */
2123     attribute_deprecated
2124     int b_sensitivity;
2125 #endif
2126
2127     /**
2128      * Chromaticity coordinates of the source primaries.
2129      * - encoding: Set by user
2130      * - decoding: Set by libavcodec
2131      */
2132     enum AVColorPrimaries color_primaries;
2133
2134     /**
2135      * Color Transfer Characteristic.
2136      * - encoding: Set by user
2137      * - decoding: Set by libavcodec
2138      */
2139     enum AVColorTransferCharacteristic color_trc;
2140
2141     /**
2142      * YUV colorspace type.
2143      * - encoding: Set by user
2144      * - decoding: Set by libavcodec
2145      */
2146     enum AVColorSpace colorspace;
2147
2148     /**
2149      * MPEG vs JPEG YUV range.
2150      * - encoding: Set by user
2151      * - decoding: Set by libavcodec
2152      */
2153     enum AVColorRange color_range;
2154
2155     /**
2156      * This defines the location of chroma samples.
2157      * - encoding: Set by user
2158      * - decoding: Set by libavcodec
2159      */
2160     enum AVChromaLocation chroma_sample_location;
2161
2162     /**
2163      * Number of slices.
2164      * Indicates number of picture subdivisions. Used for parallelized
2165      * decoding.
2166      * - encoding: Set by user
2167      * - decoding: unused
2168      */
2169     int slices;
2170
2171     /** Field order
2172      * - encoding: set by libavcodec
2173      * - decoding: Set by libavcodec
2174      */
2175     enum AVFieldOrder field_order;
2176
2177     /* audio only */
2178     int sample_rate; ///< samples per second
2179     int channels;    ///< number of audio channels
2180
2181     /**
2182      * audio sample format
2183      * - encoding: Set by user.
2184      * - decoding: Set by libavcodec.
2185      */
2186     enum AVSampleFormat sample_fmt;  ///< sample format
2187
2188     /* The following data should not be initialized. */
2189     /**
2190      * Number of samples per channel in an audio frame.
2191      *
2192      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2193      *   except the last must contain exactly frame_size samples per channel.
2194      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2195      *   frame size is not restricted.
2196      * - decoding: may be set by some decoders to indicate constant frame size
2197      */
2198     int frame_size;
2199
2200     /**
2201      * Frame counter, set by libavcodec.
2202      *
2203      * - decoding: total number of frames returned from the decoder so far.
2204      * - encoding: total number of frames passed to the encoder so far.
2205      *
2206      *   @note the counter is not incremented if encoding/decoding resulted in
2207      *   an error.
2208      */
2209     int frame_number;
2210
2211     /**
2212      * number of bytes per packet if constant and known or 0
2213      * Used by some WAV based audio codecs.
2214      */
2215     int block_align;
2216
2217     /**
2218      * Audio cutoff bandwidth (0 means "automatic")
2219      * - encoding: Set by user.
2220      * - decoding: unused
2221      */
2222     int cutoff;
2223
2224     /**
2225      * Audio channel layout.
2226      * - encoding: set by user.
2227      * - decoding: set by libavcodec.
2228      */
2229     uint64_t channel_layout;
2230
2231     /**
2232      * Request decoder to use this channel layout if it can (0 for default)
2233      * - encoding: unused
2234      * - decoding: Set by user.
2235      */
2236     uint64_t request_channel_layout;
2237
2238     /**
2239      * Type of service that the audio stream conveys.
2240      * - encoding: Set by user.
2241      * - decoding: Set by libavcodec.
2242      */
2243     enum AVAudioServiceType audio_service_type;
2244
2245     /**
2246      * Used to request a sample format from the decoder.
2247      * - encoding: unused.
2248      * - decoding: Set by user.
2249      */
2250     enum AVSampleFormat request_sample_fmt;
2251
2252     /**
2253      * This callback is called at the beginning of each frame to get data
2254      * buffer(s) for it. There may be one contiguous buffer for all the data or
2255      * there may be a buffer per each data plane or anything in between. What
2256      * this means is, you may set however many entries in buf[] you feel necessary.
2257      * Each buffer must be reference-counted using the AVBuffer API (see description
2258      * of buf[] below).
2259      *
2260      * The following fields will be set in the frame before this callback is
2261      * called:
2262      * - format
2263      * - width, height (video only)
2264      * - sample_rate, channel_layout, nb_samples (audio only)
2265      * Their values may differ from the corresponding values in
2266      * AVCodecContext. This callback must use the frame values, not the codec
2267      * context values, to calculate the required buffer size.
2268      *
2269      * This callback must fill the following fields in the frame:
2270      * - data[]
2271      * - linesize[]
2272      * - extended_data:
2273      *   * if the data is planar audio with more than 8 channels, then this
2274      *     callback must allocate and fill extended_data to contain all pointers
2275      *     to all data planes. data[] must hold as many pointers as it can.
2276      *     extended_data must be allocated with av_malloc() and will be freed in
2277      *     av_frame_unref().
2278      *   * otherwise extended_data must point to data
2279      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2280      *   the frame's data and extended_data pointers must be contained in these. That
2281      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2282      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2283      *   and av_buffer_ref().
2284      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2285      *   this callback and filled with the extra buffers if there are more
2286      *   buffers than buf[] can hold. extended_buf will be freed in
2287      *   av_frame_unref().
2288      *
2289      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2290      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2291      * some other means.
2292      *
2293      * Each data plane must be aligned to the maximum required by the target
2294      * CPU.
2295      *
2296      * @see avcodec_default_get_buffer2()
2297      *
2298      * Video:
2299      *
2300      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2301      * (read and/or written to if it is writable) later by libavcodec.
2302      *
2303      * avcodec_align_dimensions2() should be used to find the required width and
2304      * height, as they normally need to be rounded up to the next multiple of 16.
2305      *
2306      * If frame multithreading is used and thread_safe_callbacks is set,
2307      * this callback may be called from a different thread, but not from more
2308      * than one at once. Does not need to be reentrant.
2309      *
2310      * @see avcodec_align_dimensions2()
2311      *
2312      * Audio:
2313      *
2314      * Decoders request a buffer of a particular size by setting
2315      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2316      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2317      * to a smaller value in the output frame.
2318      *
2319      * As a convenience, av_samples_get_buffer_size() and
2320      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2321      * functions to find the required data size and to fill data pointers and
2322      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2323      * since all planes must be the same size.
2324      *
2325      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2326      *
2327      * - encoding: unused
2328      * - decoding: Set by libavcodec, user can override.
2329      */
2330     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2331
2332     /**
2333      * If non-zero, the decoded audio and video frames returned from
2334      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2335      * and are valid indefinitely. The caller must free them with
2336      * av_frame_unref() when they are not needed anymore.
2337      * Otherwise, the decoded frames must not be freed by the caller and are
2338      * only valid until the next decode call.
2339      *
2340      * This is always automatically enabled if avcodec_receive_frame() is used.
2341      *
2342      * - encoding: unused
2343      * - decoding: set by the caller before avcodec_open2().
2344      */
2345     attribute_deprecated int refcounted_frames;
2346
2347     /* - encoding parameters */
2348     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2349     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2350
2351     /**
2352      * minimum quantizer
2353      * - encoding: Set by user.
2354      * - decoding: unused
2355      */
2356     int qmin;
2357
2358     /**
2359      * maximum quantizer
2360      * - encoding: Set by user.
2361      * - decoding: unused
2362      */
2363     int qmax;
2364
2365     /**
2366      * maximum quantizer difference between frames
2367      * - encoding: Set by user.
2368      * - decoding: unused
2369      */
2370     int max_qdiff;
2371
2372 #if FF_API_MPV_OPT
2373     /**
2374      * @deprecated use encoder private options instead
2375      */
2376     attribute_deprecated
2377     float rc_qsquish;
2378
2379     attribute_deprecated
2380     float rc_qmod_amp;
2381     attribute_deprecated
2382     int rc_qmod_freq;
2383 #endif
2384
2385     /**
2386      * decoder bitstream buffer size
2387      * - encoding: Set by user.
2388      * - decoding: unused
2389      */
2390     int rc_buffer_size;
2391
2392     /**
2393      * ratecontrol override, see RcOverride
2394      * - encoding: Allocated/set/freed by user.
2395      * - decoding: unused
2396      */
2397     int rc_override_count;
2398     RcOverride *rc_override;
2399
2400 #if FF_API_MPV_OPT
2401     /**
2402      * @deprecated use encoder private options instead
2403      */
2404     attribute_deprecated
2405     const char *rc_eq;
2406 #endif
2407
2408     /**
2409      * maximum bitrate
2410      * - encoding: Set by user.
2411      * - decoding: unused
2412      */
2413     int rc_max_rate;
2414
2415     /**
2416      * minimum bitrate
2417      * - encoding: Set by user.
2418      * - decoding: unused
2419      */
2420     int rc_min_rate;
2421
2422 #if FF_API_MPV_OPT
2423     /**
2424      * @deprecated use encoder private options instead
2425      */
2426     attribute_deprecated
2427     float rc_buffer_aggressivity;
2428
2429     attribute_deprecated
2430     float rc_initial_cplx;
2431 #endif
2432
2433     /**
2434      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2435      * - encoding: Set by user.
2436      * - decoding: unused.
2437      */
2438     float rc_max_available_vbv_use;
2439
2440     /**
2441      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2442      * - encoding: Set by user.
2443      * - decoding: unused.
2444      */
2445     float rc_min_vbv_overflow_use;
2446
2447     /**
2448      * Number of bits which should be loaded into the rc buffer before decoding starts.
2449      * - encoding: Set by user.
2450      * - decoding: unused
2451      */
2452     int rc_initial_buffer_occupancy;
2453
2454 #if FF_API_CODER_TYPE
2455 #define FF_CODER_TYPE_VLC       0
2456 #define FF_CODER_TYPE_AC        1
2457 #define FF_CODER_TYPE_RAW       2
2458 #define FF_CODER_TYPE_RLE       3
2459 #if FF_API_UNUSED_MEMBERS
2460 #define FF_CODER_TYPE_DEFLATE   4
2461 #endif /* FF_API_UNUSED_MEMBERS */
2462     /**
2463      * @deprecated use encoder private options instead
2464      */
2465     attribute_deprecated
2466     int coder_type;
2467 #endif /* FF_API_CODER_TYPE */
2468
2469 #if FF_API_PRIVATE_OPT
2470     /** @deprecated use encoder private options instead */
2471     attribute_deprecated
2472     int context_model;
2473 #endif
2474
2475 #if FF_API_MPV_OPT
2476     /**
2477      * @deprecated use encoder private options instead
2478      */
2479     attribute_deprecated
2480     int lmin;
2481
2482     /**
2483      * @deprecated use encoder private options instead
2484      */
2485     attribute_deprecated
2486     int lmax;
2487 #endif
2488
2489 #if FF_API_PRIVATE_OPT
2490     /** @deprecated use encoder private options instead */
2491     attribute_deprecated
2492     int frame_skip_threshold;
2493
2494     /** @deprecated use encoder private options instead */
2495     attribute_deprecated
2496     int frame_skip_factor;
2497
2498     /** @deprecated use encoder private options instead */
2499     attribute_deprecated
2500     int frame_skip_exp;
2501
2502     /** @deprecated use encoder private options instead */
2503     attribute_deprecated
2504     int frame_skip_cmp;
2505 #endif /* FF_API_PRIVATE_OPT */
2506
2507     /**
2508      * trellis RD quantization
2509      * - encoding: Set by user.
2510      * - decoding: unused
2511      */
2512     int trellis;
2513
2514 #if FF_API_PRIVATE_OPT
2515     /** @deprecated use encoder private options instead */
2516     attribute_deprecated
2517     int min_prediction_order;
2518
2519     /** @deprecated use encoder private options instead */
2520     attribute_deprecated
2521     int max_prediction_order;
2522
2523     /** @deprecated use encoder private options instead */
2524     attribute_deprecated
2525     int64_t timecode_frame_start;
2526 #endif
2527
2528 #if FF_API_RTP_CALLBACK
2529     /**
2530      * @deprecated unused
2531      */
2532     /* The RTP callback: This function is called    */
2533     /* every time the encoder has a packet to send. */
2534     /* It depends on the encoder if the data starts */
2535     /* with a Start Code (it should). H.263 does.   */
2536     /* mb_nb contains the number of macroblocks     */
2537     /* encoded in the RTP payload.                  */
2538     attribute_deprecated
2539     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2540 #endif
2541
2542 #if FF_API_PRIVATE_OPT
2543     /** @deprecated use encoder private options instead */
2544     attribute_deprecated
2545     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2546                             /* do its best to deliver a chunk with size     */
2547                             /* below rtp_payload_size, the chunk will start */
2548                             /* with a start code on some codecs like H.263. */
2549                             /* This doesn't take account of any particular  */
2550                             /* headers inside the transmitted RTP payload.  */
2551 #endif
2552
2553 #if FF_API_STAT_BITS
2554     /* statistics, used for 2-pass encoding */
2555     attribute_deprecated
2556     int mv_bits;
2557     attribute_deprecated
2558     int header_bits;
2559     attribute_deprecated
2560     int i_tex_bits;
2561     attribute_deprecated
2562     int p_tex_bits;
2563     attribute_deprecated
2564     int i_count;
2565     attribute_deprecated
2566     int p_count;
2567     attribute_deprecated
2568     int skip_count;
2569     attribute_deprecated
2570     int misc_bits;
2571
2572     /** @deprecated this field is unused */
2573     attribute_deprecated
2574     int frame_bits;
2575 #endif
2576
2577     /**
2578      * pass1 encoding statistics output buffer
2579      * - encoding: Set by libavcodec.
2580      * - decoding: unused
2581      */
2582     char *stats_out;
2583
2584     /**
2585      * pass2 encoding statistics input buffer
2586      * Concatenated stuff from stats_out of pass1 should be placed here.
2587      * - encoding: Allocated/set/freed by user.
2588      * - decoding: unused
2589      */
2590     char *stats_in;
2591
2592     /**
2593      * Work around bugs in encoders which sometimes cannot be detected automatically.
2594      * - encoding: Set by user
2595      * - decoding: Set by user
2596      */
2597     int workaround_bugs;
2598 #define FF_BUG_AUTODETECT       1  ///< autodetection
2599 #if FF_API_OLD_MSMPEG4
2600 #define FF_BUG_OLD_MSMPEG4      2
2601 #endif
2602 #define FF_BUG_XVID_ILACE       4
2603 #define FF_BUG_UMP4             8
2604 #define FF_BUG_NO_PADDING       16
2605 #define FF_BUG_AMV              32
2606 #if FF_API_AC_VLC
2607 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2608 #endif
2609 #define FF_BUG_QPEL_CHROMA      64
2610 #define FF_BUG_STD_QPEL         128
2611 #define FF_BUG_QPEL_CHROMA2     256
2612 #define FF_BUG_DIRECT_BLOCKSIZE 512
2613 #define FF_BUG_EDGE             1024
2614 #define FF_BUG_HPEL_CHROMA      2048
2615 #define FF_BUG_DC_CLIP          4096
2616 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2617 #define FF_BUG_TRUNCATED       16384
2618
2619     /**
2620      * strictly follow the standard (MPEG-4, ...).
2621      * - encoding: Set by user.
2622      * - decoding: Set by user.
2623      * Setting this to STRICT or higher means the encoder and decoder will
2624      * generally do stupid things, whereas setting it to unofficial or lower
2625      * will mean the encoder might produce output that is not supported by all
2626      * spec-compliant decoders. Decoders don't differentiate between normal,
2627      * unofficial and experimental (that is, they always try to decode things
2628      * when they can) unless they are explicitly asked to behave stupidly
2629      * (=strictly conform to the specs)
2630      */
2631     int strict_std_compliance;
2632 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2633 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2634 #define FF_COMPLIANCE_NORMAL        0
2635 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2636 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2637
2638     /**
2639      * error concealment flags
2640      * - encoding: unused
2641      * - decoding: Set by user.
2642      */
2643     int error_concealment;
2644 #define FF_EC_GUESS_MVS   1
2645 #define FF_EC_DEBLOCK     2
2646
2647     /**
2648      * debug
2649      * - encoding: Set by user.
2650      * - decoding: Set by user.
2651      */
2652     int debug;
2653 #define FF_DEBUG_PICT_INFO   1
2654 #define FF_DEBUG_RC          2
2655 #define FF_DEBUG_BITSTREAM   4
2656 #define FF_DEBUG_MB_TYPE     8
2657 #define FF_DEBUG_QP          16
2658 #if FF_API_DEBUG_MV
2659 /**
2660  * @deprecated this option does nothing
2661  */
2662 #define FF_DEBUG_MV          32
2663 #endif
2664 #define FF_DEBUG_DCT_COEFF   0x00000040
2665 #define FF_DEBUG_SKIP        0x00000080
2666 #define FF_DEBUG_STARTCODE   0x00000100
2667 #if FF_API_UNUSED_MEMBERS
2668 #define FF_DEBUG_PTS         0x00000200
2669 #endif /* FF_API_UNUSED_MEMBERS */
2670 #define FF_DEBUG_ER          0x00000400
2671 #define FF_DEBUG_MMCO        0x00000800
2672 #define FF_DEBUG_BUGS        0x00001000
2673 #if FF_API_DEBUG_MV
2674 #define FF_DEBUG_VIS_QP      0x00002000
2675 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2676 #endif
2677 #define FF_DEBUG_BUFFERS     0x00008000
2678 #define FF_DEBUG_THREADS     0x00010000
2679
2680 #if FF_API_DEBUG_MV
2681     /**
2682      * @deprecated this option does not have any effect
2683      */
2684     attribute_deprecated
2685     int debug_mv;
2686 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
2687 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
2688 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2689 #endif
2690
2691     /**
2692      * Error recognition; may misdetect some more or less valid parts as errors.
2693      * - encoding: unused
2694      * - decoding: Set by user.
2695      */
2696     int err_recognition;
2697
2698 /**
2699  * Verify checksums embedded in the bitstream (could be of either encoded or
2700  * decoded data, depending on the codec) and print an error message on mismatch.
2701  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2702  * decoder returning an error.
2703  */
2704 #define AV_EF_CRCCHECK  (1<<0)
2705 #define AV_EF_BITSTREAM (1<<1)
2706 #define AV_EF_BUFFER    (1<<2)
2707 #define AV_EF_EXPLODE   (1<<3)
2708
2709     /**
2710      * opaque 64-bit number (generally a PTS) that will be reordered and
2711      * output in AVFrame.reordered_opaque
2712      * - encoding: unused
2713      * - decoding: Set by user.
2714      */
2715     int64_t reordered_opaque;
2716
2717     /**
2718      * Hardware accelerator in use
2719      * - encoding: unused.
2720      * - decoding: Set by libavcodec
2721      */
2722     struct AVHWAccel *hwaccel;
2723
2724     /**
2725      * Hardware accelerator context.
2726      * For some hardware accelerators, a global context needs to be
2727      * provided by the user. In that case, this holds display-dependent
2728      * data Libav cannot instantiate itself. Please refer to the
2729      * Libav HW accelerator documentation to know how to fill this
2730      * is. e.g. for VA API, this is a struct vaapi_context.
2731      * - encoding: unused
2732      * - decoding: Set by user
2733      */
2734     void *hwaccel_context;
2735
2736     /**
2737      * error
2738      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2739      * - decoding: unused
2740      */
2741     uint64_t error[AV_NUM_DATA_POINTERS];
2742
2743     /**
2744      * DCT algorithm, see FF_DCT_* below
2745      * - encoding: Set by user.
2746      * - decoding: unused
2747      */
2748     int dct_algo;
2749 #define FF_DCT_AUTO    0
2750 #define FF_DCT_FASTINT 1
2751 #define FF_DCT_INT     2
2752 #define FF_DCT_MMX     3
2753 #define FF_DCT_ALTIVEC 5
2754 #define FF_DCT_FAAN    6
2755
2756     /**
2757      * IDCT algorithm, see FF_IDCT_* below.
2758      * - encoding: Set by user.
2759      * - decoding: Set by user.
2760      */
2761     int idct_algo;
2762 #define FF_IDCT_AUTO          0
2763 #define FF_IDCT_INT           1
2764 #define FF_IDCT_SIMPLE        2
2765 #define FF_IDCT_SIMPLEMMX     3
2766 #define FF_IDCT_ARM           7
2767 #define FF_IDCT_ALTIVEC       8
2768 #if FF_API_ARCH_SH4
2769 #define FF_IDCT_SH4           9
2770 #endif
2771 #define FF_IDCT_SIMPLEARM     10
2772 #if FF_API_UNUSED_MEMBERS
2773 #define FF_IDCT_IPP           13
2774 #endif /* FF_API_UNUSED_MEMBERS */
2775 #define FF_IDCT_XVID          14
2776 #if FF_API_IDCT_XVIDMMX
2777 #define FF_IDCT_XVIDMMX       14
2778 #endif /* FF_API_IDCT_XVIDMMX */
2779 #define FF_IDCT_SIMPLEARMV5TE 16
2780 #define FF_IDCT_SIMPLEARMV6   17
2781 #if FF_API_ARCH_SPARC
2782 #define FF_IDCT_SIMPLEVIS     18
2783 #endif
2784 #define FF_IDCT_FAAN          20
2785 #define FF_IDCT_SIMPLENEON    22
2786 #if FF_API_ARCH_ALPHA
2787 #define FF_IDCT_SIMPLEALPHA   23
2788 #endif
2789
2790     /**
2791      * bits per sample/pixel from the demuxer (needed for huffyuv).
2792      * - encoding: Set by libavcodec.
2793      * - decoding: Set by user.
2794      */
2795      int bits_per_coded_sample;
2796
2797     /**
2798      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2799      * - encoding: set by user.
2800      * - decoding: set by libavcodec.
2801      */
2802     int bits_per_raw_sample;
2803
2804 #if FF_API_CODED_FRAME
2805     /**
2806      * the picture in the bitstream
2807      * - encoding: Set by libavcodec.
2808      * - decoding: unused
2809      *
2810      * @deprecated use the quality factor packet side data instead
2811      */
2812     attribute_deprecated AVFrame *coded_frame;
2813 #endif
2814
2815     /**
2816      * thread count
2817      * is used to decide how many independent tasks should be passed to execute()
2818      * - encoding: Set by user.
2819      * - decoding: Set by user.
2820      */
2821     int thread_count;
2822
2823     /**
2824      * Which multithreading methods to use.
2825      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2826      * so clients which cannot provide future frames should not use it.
2827      *
2828      * - encoding: Set by user, otherwise the default is used.
2829      * - decoding: Set by user, otherwise the default is used.
2830      */
2831     int thread_type;
2832 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2833 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2834
2835     /**
2836      * Which multithreading methods are in use by the codec.
2837      * - encoding: Set by libavcodec.
2838      * - decoding: Set by libavcodec.
2839      */
2840     int active_thread_type;
2841
2842     /**
2843      * Set by the client if its custom get_buffer() callback can be called
2844      * synchronously from another thread, which allows faster multithreaded decoding.
2845      * draw_horiz_band() will be called from other threads regardless of this setting.
2846      * Ignored if the default get_buffer() is used.
2847      * - encoding: Set by user.
2848      * - decoding: Set by user.
2849      */
2850     int thread_safe_callbacks;
2851
2852     /**
2853      * The codec may call this to execute several independent things.
2854      * It will return only after finishing all tasks.
2855      * The user may replace this with some multithreaded implementation,
2856      * the default implementation will execute the parts serially.
2857      * @param count the number of things to execute
2858      * - encoding: Set by libavcodec, user can override.
2859      * - decoding: Set by libavcodec, user can override.
2860      */
2861     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2862
2863     /**
2864      * The codec may call this to execute several independent things.
2865      * It will return only after finishing all tasks.
2866      * The user may replace this with some multithreaded implementation,
2867      * the default implementation will execute the parts serially.
2868      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2869      * @param c context passed also to func
2870      * @param count the number of things to execute
2871      * @param arg2 argument passed unchanged to func
2872      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2873      * @param func function that will be called count times, with jobnr from 0 to count-1.
2874      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2875      *             two instances of func executing at the same time will have the same threadnr.
2876      * @return always 0 currently, but code should handle a future improvement where when any call to func
2877      *         returns < 0 no further calls to func may be done and < 0 is returned.
2878      * - encoding: Set by libavcodec, user can override.
2879      * - decoding: Set by libavcodec, user can override.
2880      */
2881     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2882
2883     /**
2884      * noise vs. sse weight for the nsse comparison function
2885      * - encoding: Set by user.
2886      * - decoding: unused
2887      */
2888      int nsse_weight;
2889
2890     /**
2891      * profile
2892      * - encoding: Set by user.
2893      * - decoding: Set by libavcodec.
2894      */
2895      int profile;
2896 #define FF_PROFILE_UNKNOWN -99
2897 #define FF_PROFILE_RESERVED -100
2898
2899 #define FF_PROFILE_AAC_MAIN 0
2900 #define FF_PROFILE_AAC_LOW  1
2901 #define FF_PROFILE_AAC_SSR  2
2902 #define FF_PROFILE_AAC_LTP  3
2903 #define FF_PROFILE_AAC_HE   4
2904 #define FF_PROFILE_AAC_HE_V2 28
2905 #define FF_PROFILE_AAC_LD   22
2906 #define FF_PROFILE_AAC_ELD  38
2907 #define FF_PROFILE_MPEG2_AAC_LOW 128
2908 #define FF_PROFILE_MPEG2_AAC_HE  131
2909
2910 #define FF_PROFILE_DTS         20
2911 #define FF_PROFILE_DTS_ES      30
2912 #define FF_PROFILE_DTS_96_24   40
2913 #define FF_PROFILE_DTS_HD_HRA  50
2914 #define FF_PROFILE_DTS_HD_MA   60
2915 #define FF_PROFILE_DTS_EXPRESS 70
2916
2917 #define FF_PROFILE_MPEG2_422    0
2918 #define FF_PROFILE_MPEG2_HIGH   1
2919 #define FF_PROFILE_MPEG2_SS     2
2920 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2921 #define FF_PROFILE_MPEG2_MAIN   4
2922 #define FF_PROFILE_MPEG2_SIMPLE 5
2923
2924 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2925 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2926
2927 #define FF_PROFILE_H264_BASELINE             66
2928 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2929 #define FF_PROFILE_H264_MAIN                 77
2930 #define FF_PROFILE_H264_EXTENDED             88
2931 #define FF_PROFILE_H264_HIGH                 100
2932 #define FF_PROFILE_H264_HIGH_10              110
2933 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2934 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2935 #define FF_PROFILE_H264_HIGH_422             122
2936 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2937 #define FF_PROFILE_H264_STEREO_HIGH          128
2938 #define FF_PROFILE_H264_HIGH_444             144
2939 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2940 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2941 #define FF_PROFILE_H264_CAVLC_444            44
2942
2943 #define FF_PROFILE_VC1_SIMPLE   0
2944 #define FF_PROFILE_VC1_MAIN     1
2945 #define FF_PROFILE_VC1_COMPLEX  2
2946 #define FF_PROFILE_VC1_ADVANCED 3
2947
2948 #define FF_PROFILE_MPEG4_SIMPLE                     0
2949 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2950 #define FF_PROFILE_MPEG4_CORE                       2
2951 #define FF_PROFILE_MPEG4_MAIN                       3
2952 #define FF_PROFILE_MPEG4_N_BIT                      4
2953 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2954 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2955 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2956 #define FF_PROFILE_MPEG4_HYBRID                     8
2957 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2958 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2959 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2960 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2961 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2962 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2963 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2964
2965 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2966 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2967 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2968 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2969 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2970
2971 #define FF_PROFILE_VP9_0                            0
2972 #define FF_PROFILE_VP9_1                            1
2973 #define FF_PROFILE_VP9_2                            2
2974 #define FF_PROFILE_VP9_3                            3
2975
2976 #define FF_PROFILE_HEVC_MAIN                        1
2977 #define FF_PROFILE_HEVC_MAIN_10                     2
2978 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2979 #define FF_PROFILE_HEVC_REXT                        4
2980
2981     /**
2982      * level
2983      * - encoding: Set by user.
2984      * - decoding: Set by libavcodec.
2985      */
2986      int level;
2987 #define FF_LEVEL_UNKNOWN -99
2988
2989     /**
2990      * - encoding: unused
2991      * - decoding: Set by user.
2992      */
2993     enum AVDiscard skip_loop_filter;
2994
2995     /**
2996      * - encoding: unused
2997      * - decoding: Set by user.
2998      */
2999     enum AVDiscard skip_idct;
3000
3001     /**
3002      * - encoding: unused
3003      * - decoding: Set by user.
3004      */
3005     enum AVDiscard skip_frame;
3006
3007     /**
3008      * Header containing style information for text subtitles.
3009      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3010      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3011      * the Format line following. It shouldn't include any Dialogue line.
3012      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3013      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3014      */
3015     uint8_t *subtitle_header;
3016     int subtitle_header_size;
3017
3018 #if FF_API_ERROR_RATE
3019     /**
3020      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3021      * encoders
3022      */
3023     attribute_deprecated
3024     int error_rate;
3025 #endif
3026
3027 #if FF_API_VBV_DELAY
3028     /**
3029      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3030      * Used for compliant TS muxing.
3031      * - encoding: Set by libavcodec.
3032      * - decoding: unused.
3033      * @deprecated this value is now exported as a part of
3034      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3035      */
3036     attribute_deprecated
3037     uint64_t vbv_delay;
3038 #endif
3039
3040 #if FF_API_SIDEDATA_ONLY_PKT
3041     /**
3042      * Encoding only and set by default. Allow encoders to output packets
3043      * that do not contain any encoded data, only side data.
3044      *
3045      * Some encoders need to output such packets, e.g. to update some stream
3046      * parameters at the end of encoding.
3047      *
3048      * @deprecated this field disables the default behaviour and
3049      *             it is kept only for compatibility.
3050      */
3051     attribute_deprecated
3052     int side_data_only_packets;
3053 #endif
3054
3055     /**
3056      * Audio only. The number of "priming" samples (padding) inserted by the
3057      * encoder at the beginning of the audio. I.e. this number of leading
3058      * decoded samples must be discarded by the caller to get the original audio
3059      * without leading padding.
3060      *
3061      * - decoding: unused
3062      * - encoding: Set by libavcodec. The timestamps on the output packets are
3063      *             adjusted by the encoder so that they always refer to the
3064      *             first sample of the data actually contained in the packet,
3065      *             including any added padding.  E.g. if the timebase is
3066      *             1/samplerate and the timestamp of the first input sample is
3067      *             0, the timestamp of the first output packet will be
3068      *             -initial_padding.
3069      */
3070     int initial_padding;
3071
3072     /*
3073      * - decoding: For codecs that store a framerate value in the compressed
3074      *             bitstream, the decoder may export it here. { 0, 1} when
3075      *             unknown.
3076      * - encoding: May be used to signal the framerate of CFR content to an
3077      *             encoder.
3078      */
3079     AVRational framerate;
3080
3081     /**
3082      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3083      * - encoding: unused.
3084      * - decoding: Set by libavcodec before calling get_format()
3085      */
3086     enum AVPixelFormat sw_pix_fmt;
3087
3088     /**
3089      * Additional data associated with the entire coded stream.
3090      *
3091      * - decoding: unused
3092      * - encoding: may be set by libavcodec after avcodec_open2().
3093      */
3094     AVPacketSideData *coded_side_data;
3095     int            nb_coded_side_data;
3096
3097     /**
3098      * A reference to the AVHWFramesContext describing the input (for encoding)
3099      * or output (decoding) frames. The reference is set by the caller and
3100      * afterwards owned (and freed) by libavcodec - it should never be read by
3101      * the caller after being set.
3102      *
3103      * - decoding: This field should be set by the caller from the get_format()
3104      *             callback. The previous reference (if any) will always be
3105      *             unreffed by libavcodec before the get_format() call.
3106      *
3107      *             If the default get_buffer2() is used with a hwaccel pixel
3108      *             format, then this AVHWFramesContext will be used for
3109      *             allocating the frame buffers.
3110      *
3111      * - encoding: For hardware encoders configured to use a hwaccel pixel
3112      *             format, this field should be set by the caller to a reference
3113      *             to the AVHWFramesContext describing input frames.
3114      *             AVHWFramesContext.format must be equal to
3115      *             AVCodecContext.pix_fmt.
3116      *
3117      *             This field should be set before avcodec_open2() is called.
3118      */
3119     AVBufferRef *hw_frames_ctx;
3120
3121     /**
3122      * Video decoding only. Certain video codecs support cropping, meaning that
3123      * only a sub-rectangle of the decoded frame is intended for display.  This
3124      * option controls how cropping is handled by libavcodec.
3125      *
3126      * When set to 1 (the default), libavcodec will apply cropping internally.
3127      * I.e. it will modify the output frame width/height fields and offset the
3128      * data pointers (only by as much as possible while preserving alignment, or
3129      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3130      * the frames output by the decoder refer only to the cropped area. The
3131      * crop_* fields of the output frames will be zero.
3132      *
3133      * When set to 0, the width/height fields of the output frames will be set
3134      * to the coded dimensions and the crop_* fields will describe the cropping
3135      * rectangle. Applying the cropping is left to the caller.
3136      *
3137      * @warning When hardware acceleration with opaque output frames is used,
3138      * libavcodec is unable to apply cropping from the top/left border.
3139      *
3140      * @note when this option is set to zero, the width/height fields of the
3141      * AVCodecContext and output AVFrames have different meanings. The codec
3142      * context fields store display dimensions (with the coded dimensions in
3143      * coded_width/height), while the frame fields store the coded dimensions
3144      * (with the display dimensions being determined by the crop_* fields).
3145      */
3146     int apply_cropping;
3147
3148     /**
3149      * A reference to the AVHWDeviceContext describing the device which will
3150      * be used by a hardware encoder/decoder.  The reference is set by the
3151      * caller and afterwards owned (and freed) by libavcodec.
3152      *
3153      * This should be used if either the codec device does not require
3154      * hardware frames or any that are used are to be allocated internally by
3155      * libavcodec.  If the user wishes to supply any of the frames used as
3156      * encoder input or decoder output then hw_frames_ctx should be used
3157      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3158      * field will be ignored while decoding the associated stream segment, but
3159      * may again be used on a following one after another get_format() call.
3160      *
3161      * For both encoders and decoders this field should be set before
3162      * avcodec_open2() is called and must not be written to thereafter.
3163      *
3164      * Note that some decoders may require this field to be set initially in
3165      * order to support hw_frames_ctx at all - in that case, all frames
3166      * contexts used must be created on the same device.
3167      */
3168     AVBufferRef *hw_device_ctx;
3169
3170     /**
3171      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3172      * decoding (if active).
3173      * - encoding: unused
3174      * - decoding: Set by user (either before avcodec_open2(), or in the
3175      *             AVCodecContext.get_format callback)
3176      */
3177     int hwaccel_flags;
3178 } AVCodecContext;
3179
3180 /**
3181  * AVProfile.
3182  */
3183 typedef struct AVProfile {
3184     int profile;
3185     const char *name; ///< short name for the profile
3186 } AVProfile;
3187
3188 typedef struct AVCodecDefault AVCodecDefault;
3189
3190 struct AVSubtitle;
3191
3192 /**
3193  * AVCodec.
3194  */
3195 typedef struct AVCodec {
3196     /**
3197      * Name of the codec implementation.
3198      * The name is globally unique among encoders and among decoders (but an
3199      * encoder and a decoder can share the same name).
3200      * This is the primary way to find a codec from the user perspective.
3201      */
3202     const char *name;
3203     /**
3204      * Descriptive name for the codec, meant to be more human readable than name.
3205      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3206      */
3207     const char *long_name;
3208     enum AVMediaType type;
3209     enum AVCodecID id;
3210     /**
3211      * Codec capabilities.
3212      * see AV_CODEC_CAP_*
3213      */
3214     int capabilities;
3215     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3216     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3217     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3218     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3219     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3220     const AVClass *priv_class;              ///< AVClass for the private context
3221     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3222
3223     /*****************************************************************
3224      * No fields below this line are part of the public API. They
3225      * may not be used outside of libavcodec and can be changed and
3226      * removed at will.
3227      * New public fields should be added right above.
3228      *****************************************************************
3229      */
3230     int priv_data_size;
3231     struct AVCodec *next;
3232     /**
3233      * @name Frame-level threading support functions
3234      * @{
3235      */
3236     /**
3237      * If defined, called on thread contexts when they are created.
3238      * If the codec allocates writable tables in init(), re-allocate them here.
3239      * priv_data will be set to a copy of the original.
3240      */
3241     int (*init_thread_copy)(AVCodecContext *);
3242     /**
3243      * Copy necessary context variables from a previous thread context to the current one.
3244      * If not defined, the next thread will start automatically; otherwise, the codec
3245      * must call ff_thread_finish_setup().
3246      *
3247      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3248      */
3249     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3250     /** @} */
3251
3252     /**
3253      * Private codec-specific defaults.
3254      */
3255     const AVCodecDefault *defaults;
3256
3257     /**
3258      * Initialize codec static data, called from avcodec_register().
3259      */
3260     void (*init_static_data)(struct AVCodec *codec);
3261
3262     int (*init)(AVCodecContext *);
3263     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3264                       const struct AVSubtitle *sub);
3265     /**
3266      * Encode data to an AVPacket.
3267      *
3268      * @param      avctx          codec context
3269      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3270      * @param[in]  frame          AVFrame containing the raw data to be encoded
3271      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3272      *                            non-empty packet was returned in avpkt.
3273      * @return 0 on success, negative error code on failure
3274      */
3275     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3276                    int *got_packet_ptr);
3277     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3278     int (*close)(AVCodecContext *);
3279     /**
3280      * Encode API with decoupled packet/frame dataflow. The API is the
3281      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3282      * that:
3283      * - never called if the codec is closed or the wrong type,
3284      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3285      * - only one drain frame is ever passed down,
3286      */
3287     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3288     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3289
3290     /**
3291      * Decode API with decoupled packet/frame dataflow. This function is called
3292      * to get one output frame. It should call ff_decode_get_packet() to obtain
3293      * input data.
3294      */
3295     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3296     /**
3297      * Flush buffers.
3298      * Will be called when seeking
3299      */
3300     void (*flush)(AVCodecContext *);
3301     /**
3302      * Internal codec capabilities.
3303      * See FF_CODEC_CAP_* in internal.h
3304      */
3305     int caps_internal;
3306
3307     /**
3308      * Decoding only, a comma-separated list of bitstream filters to apply to
3309      * packets before decoding.
3310      */
3311     const char *bsfs;
3312 } AVCodec;
3313
3314 /**
3315  * @defgroup lavc_hwaccel AVHWAccel
3316  * @{
3317  */
3318 typedef struct AVHWAccel {
3319     /**
3320      * Name of the hardware accelerated codec.
3321      * The name is globally unique among encoders and among decoders (but an
3322      * encoder and a decoder can share the same name).
3323      */
3324     const char *name;
3325
3326     /**
3327      * Type of codec implemented by the hardware accelerator.
3328      *
3329      * See AVMEDIA_TYPE_xxx
3330      */
3331     enum AVMediaType type;
3332
3333     /**
3334      * Codec implemented by the hardware accelerator.
3335      *
3336      * See AV_CODEC_ID_xxx
3337      */
3338     enum AVCodecID id;
3339
3340     /**
3341      * Supported pixel format.
3342      *
3343      * Only hardware accelerated formats are supported here.
3344      */
3345     enum AVPixelFormat pix_fmt;
3346
3347     /**
3348      * Hardware accelerated codec capabilities.
3349      * see FF_HWACCEL_CODEC_CAP_*
3350      */
3351     int capabilities;
3352
3353     /*****************************************************************
3354      * No fields below this line are part of the public API. They
3355      * may not be used outside of libavcodec and can be changed and
3356      * removed at will.
3357      * New public fields should be added right above.
3358      *****************************************************************
3359      */
3360     struct AVHWAccel *next;
3361
3362     /**
3363      * Allocate a custom buffer
3364      */
3365     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3366
3367     /**
3368      * Called at the beginning of each frame or field picture.
3369      *
3370      * Meaningful frame information (codec specific) is guaranteed to
3371      * be parsed at this point. This function is mandatory.
3372      *
3373      * Note that buf can be NULL along with buf_size set to 0.
3374      * Otherwise, this means the whole frame is available at this point.
3375      *
3376      * @param avctx the codec context
3377      * @param buf the frame data buffer base
3378      * @param buf_size the size of the frame in bytes
3379      * @return zero if successful, a negative value otherwise
3380      */
3381     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3382
3383     /**
3384      * Callback for each slice.
3385      *
3386      * Meaningful slice information (codec specific) is guaranteed to
3387      * be parsed at this point. This function is mandatory.
3388      *
3389      * @param avctx the codec context
3390      * @param buf the slice data buffer base
3391      * @param buf_size the size of the slice in bytes
3392      * @return zero if successful, a negative value otherwise
3393      */
3394     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3395
3396     /**
3397      * Called at the end of each frame or field picture.
3398      *
3399      * The whole picture is parsed at this point and can now be sent
3400      * to the hardware accelerator. This function is mandatory.
3401      *
3402      * @param avctx the codec context
3403      * @return zero if successful, a negative value otherwise
3404      */
3405     int (*end_frame)(AVCodecContext *avctx);
3406
3407     /**
3408      * Size of per-frame hardware accelerator private data.
3409      *
3410      * Private data is allocated with av_mallocz() before
3411      * AVCodecContext.get_buffer() and deallocated after
3412      * AVCodecContext.release_buffer().
3413      */
3414     int frame_priv_data_size;
3415
3416     /**
3417      * Initialize the hwaccel private data.
3418      *
3419      * This will be called from ff_get_format(), after hwaccel and
3420      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3421      * is allocated.
3422      */
3423     int (*init)(AVCodecContext *avctx);
3424
3425     /**
3426      * Uninitialize the hwaccel private data.
3427      *
3428      * This will be called from get_format() or avcodec_close(), after hwaccel
3429      * and hwaccel_context are already uninitialized.
3430      */
3431     int (*uninit)(AVCodecContext *avctx);
3432
3433     /**
3434      * Size of the private data to allocate in
3435      * AVCodecInternal.hwaccel_priv_data.
3436      */
3437     int priv_data_size;
3438
3439     /**
3440      * Internal hwaccel capabilities.
3441      */
3442     int caps_internal;
3443 } AVHWAccel;
3444
3445 /**
3446  * Hardware acceleration should be used for decoding even if the codec level
3447  * used is unknown or higher than the maximum supported level reported by the
3448  * hardware driver.
3449  */
3450 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3451
3452 /**
3453  * Hardware acceleration can output YUV pixel formats with a different chroma
3454  * sampling than 4:2:0 and/or other than 8 bits per component.
3455  */
3456 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3457
3458 /**
3459  * @}
3460  */
3461
3462 #if FF_API_AVPICTURE
3463 /**
3464  * @defgroup lavc_picture AVPicture
3465  *
3466  * Functions for working with AVPicture
3467  * @{
3468  */
3469
3470 /**
3471  * four components are given, that's all.
3472  * the last component is alpha
3473  * @deprecated Use the imgutils functions
3474  */
3475 typedef struct AVPicture {
3476     attribute_deprecated
3477     uint8_t *data[AV_NUM_DATA_POINTERS];
3478     attribute_deprecated
3479     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3480 } AVPicture;
3481
3482 /**
3483  * @}
3484  */
3485 #endif
3486
3487 #define AVPALETTE_SIZE 1024
3488 #define AVPALETTE_COUNT 256
3489
3490 enum AVSubtitleType {
3491     SUBTITLE_NONE,
3492
3493     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3494
3495     /**
3496      * Plain text, the text field must be set by the decoder and is
3497      * authoritative. ass and pict fields may contain approximations.
3498      */
3499     SUBTITLE_TEXT,
3500
3501     /**
3502      * Formatted text, the ass field must be set by the decoder and is
3503      * authoritative. pict and text fields may contain approximations.
3504      */
3505     SUBTITLE_ASS,
3506 };
3507
3508 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3509
3510 typedef struct AVSubtitleRect {
3511     int x;         ///< top left corner  of pict, undefined when pict is not set
3512     int y;         ///< top left corner  of pict, undefined when pict is not set
3513     int w;         ///< width            of pict, undefined when pict is not set
3514     int h;         ///< height           of pict, undefined when pict is not set
3515     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3516
3517 #if FF_API_AVPICTURE
3518     /**
3519      * @deprecated unused
3520      */
3521     attribute_deprecated
3522     AVPicture pict;
3523 #endif
3524     /**
3525      * data+linesize for the bitmap of this subtitle.
3526      * Can be set for text/ass as well once they are rendered.
3527      */
3528     uint8_t *data[4];
3529     int linesize[4];
3530
3531     enum AVSubtitleType type;
3532
3533     char *text;                     ///< 0 terminated plain UTF-8 text
3534
3535     /**
3536      * 0 terminated ASS/SSA compatible event line.
3537      * The presentation of this is unaffected by the other values in this
3538      * struct.
3539      */
3540     char *ass;
3541     int flags;
3542 } AVSubtitleRect;
3543
3544 typedef struct AVSubtitle {
3545     uint16_t format; /* 0 = graphics */
3546     uint32_t start_display_time; /* relative to packet pts, in ms */
3547     uint32_t end_display_time; /* relative to packet pts, in ms */
3548     unsigned num_rects;
3549     AVSubtitleRect **rects;
3550     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3551 } AVSubtitle;
3552
3553 /**
3554  * This struct describes the properties of an encoded stream.
3555  *
3556  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3557  * be allocated with avcodec_parameters_alloc() and freed with
3558  * avcodec_parameters_free().
3559  */
3560 typedef struct AVCodecParameters {
3561     /**
3562      * General type of the encoded data.
3563      */
3564     enum AVMediaType codec_type;
3565     /**
3566      * Specific type of the encoded data (the codec used).
3567      */
3568     enum AVCodecID   codec_id;
3569     /**
3570      * Additional information about the codec (corresponds to the AVI FOURCC).
3571      */
3572     uint32_t         codec_tag;
3573
3574     /**
3575      * Extra binary data needed for initializing the decoder, codec-dependent.
3576      *
3577      * Must be allocated with av_malloc() and will be freed by
3578      * avcodec_parameters_free(). The allocated size of extradata must be at
3579      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3580      * bytes zeroed.
3581      */
3582     uint8_t *extradata;
3583     /**
3584      * Size of the extradata content in bytes.
3585      */
3586     int      extradata_size;
3587
3588     /**
3589      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3590      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3591      */
3592     int format;
3593
3594     /**
3595      * The average bitrate of the encoded data (in bits per second).
3596      */
3597     int bit_rate;
3598
3599     int bits_per_coded_sample;
3600
3601     /**
3602      * Codec-specific bitstream restrictions that the stream conforms to.
3603      */
3604     int profile;
3605     int level;
3606
3607     /**
3608      * Video only. The dimensions of the video frame in pixels.
3609      */
3610     int width;
3611     int height;
3612
3613     /**
3614      * Video only. The aspect ratio (width / height) which a single pixel
3615      * should have when displayed.
3616      *
3617      * When the aspect ratio is unknown / undefined, the numerator should be
3618      * set to 0 (the denominator may have any value).
3619      */
3620     AVRational sample_aspect_ratio;
3621
3622     /**
3623      * Video only. The order of the fields in interlaced video.
3624      */
3625     enum AVFieldOrder                  field_order;
3626
3627     /**
3628      * Video only. Additional colorspace characteristics.
3629      */
3630     enum AVColorRange                  color_range;
3631     enum AVColorPrimaries              color_primaries;
3632     enum AVColorTransferCharacteristic color_trc;
3633     enum AVColorSpace                  color_space;
3634     enum AVChromaLocation              chroma_location;
3635
3636     /**
3637      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3638      * unknown or unspecified, otherwise the number of bits set must be equal to
3639      * the channels field.
3640      */
3641     uint64_t channel_layout;
3642     /**
3643      * Audio only. The number of audio channels.
3644      */
3645     int      channels;
3646     /**
3647      * Audio only. The number of audio samples per second.
3648      */
3649     int      sample_rate;
3650     /**
3651      * Audio only. The number of bytes per coded audio frame, required by some
3652      * formats.
3653      *
3654      * Corresponds to nBlockAlign in WAVEFORMATEX.
3655      */
3656     int      block_align;
3657
3658     /**
3659      * Audio only. The amount of padding (in samples) inserted by the encoder at
3660      * the beginning of the audio. I.e. this number of leading decoded samples
3661      * must be discarded by the caller to get the original audio without leading
3662      * padding.
3663      */
3664     int initial_padding;
3665     /**
3666      * Audio only. The amount of padding (in samples) appended by the encoder to
3667      * the end of the audio. I.e. this number of decoded samples must be
3668      * discarded by the caller from the end of the stream to get the original
3669      * audio without any trailing padding.
3670      */
3671     int trailing_padding;
3672 } AVCodecParameters;
3673
3674 /**
3675  * If c is NULL, returns the first registered codec,
3676  * if c is non-NULL, returns the next registered codec after c,
3677  * or NULL if c is the last one.
3678  */
3679 AVCodec *av_codec_next(const AVCodec *c);
3680
3681 /**
3682  * Return the LIBAVCODEC_VERSION_INT constant.
3683  */
3684 unsigned avcodec_version(void);
3685
3686 /**
3687  * Return the libavcodec build-time configuration.
3688  */
3689 const char *avcodec_configuration(void);
3690
3691 /**
3692  * Return the libavcodec license.
3693  */
3694 const char *avcodec_license(void);
3695
3696 /**
3697  * Register the codec codec and initialize libavcodec.
3698  *
3699  * @warning either this function or avcodec_register_all() must be called
3700  * before any other libavcodec functions.
3701  *
3702  * @see avcodec_register_all()
3703  */
3704 void avcodec_register(AVCodec *codec);
3705
3706 /**
3707  * Register all the codecs, parsers and bitstream filters which were enabled at
3708  * configuration time. If you do not call this function you can select exactly
3709  * which formats you want to support, by using the individual registration
3710  * functions.
3711  *
3712  * @see avcodec_register
3713  * @see av_register_codec_parser
3714  * @see av_register_bitstream_filter
3715  */
3716 void avcodec_register_all(void);
3717
3718 /**
3719  * Allocate an AVCodecContext and set its fields to default values. The
3720  * resulting struct should be freed with avcodec_free_context().
3721  *
3722  * @param codec if non-NULL, allocate private data and initialize defaults
3723  *              for the given codec. It is illegal to then call avcodec_open2()
3724  *              with a different codec.
3725  *              If NULL, then the codec-specific defaults won't be initialized,
3726  *              which may result in suboptimal default settings (this is
3727  *              important mainly for encoders, e.g. libx264).
3728  *
3729  * @return An AVCodecContext filled with default values or NULL on failure.
3730  */
3731 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
3732
3733 /**
3734  * Free the codec context and everything associated with it and write NULL to
3735  * the provided pointer.
3736  */
3737 void avcodec_free_context(AVCodecContext **avctx);
3738
3739 #if FF_API_GET_CONTEXT_DEFAULTS
3740 /**
3741  * @deprecated This function should not be used, as closing and opening a codec
3742  * context multiple time is not supported. A new codec context should be
3743  * allocated for each new use.
3744  */
3745 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
3746 #endif
3747
3748 /**
3749  * Get the AVClass for AVCodecContext. It can be used in combination with
3750  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
3751  *
3752  * @see av_opt_find().
3753  */
3754 const AVClass *avcodec_get_class(void);
3755
3756 #if FF_API_COPY_CONTEXT
3757 /**
3758  * Copy the settings of the source AVCodecContext into the destination
3759  * AVCodecContext. The resulting destination codec context will be
3760  * unopened, i.e. you are required to call avcodec_open2() before you
3761  * can use this AVCodecContext to decode/encode video/audio data.
3762  *
3763  * @param dest target codec context, should be initialized with
3764  *             avcodec_alloc_context3(), but otherwise uninitialized
3765  * @param src source codec context
3766  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
3767  *
3768  * @deprecated The semantics of this function are ill-defined and it should not
3769  * be used. If you need to transfer the stream parameters from one codec context
3770  * to another, use an intermediate AVCodecParameters instance and the
3771  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
3772  * functions.
3773  */
3774 attribute_deprecated
3775 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
3776 #endif
3777
3778 /**
3779  * Allocate a new AVCodecParameters and set its fields to default values
3780  * (unknown/invalid/0). The returned struct must be freed with
3781  * avcodec_parameters_free().
3782  */
3783 AVCodecParameters *avcodec_parameters_alloc(void);
3784
3785 /**
3786  * Free an AVCodecParameters instance and everything associated with it and
3787  * write NULL to the supplied pointer.
3788  */
3789 void avcodec_parameters_free(AVCodecParameters **par);
3790
3791 /**
3792  * Copy the contents of src to dst. Any allocated fields in dst are freed and
3793  * replaced with newly allocated duplicates of the corresponding fields in src.
3794  *
3795  * @return >= 0 on success, a negative AVERROR code on failure.
3796  */
3797 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
3798
3799 /**
3800  * Fill the parameters struct based on the values from the supplied codec
3801  * context. Any allocated fields in par are freed and replaced with duplicates
3802  * of the corresponding fields in codec.
3803  *
3804  * @return >= 0 on success, a negative AVERROR code on failure
3805  */
3806 int avcodec_parameters_from_context(AVCodecParameters *par,
3807                                     const AVCodecContext *codec);
3808
3809 /**
3810  * Fill the codec context based on the values from the supplied codec
3811  * parameters. Any allocated fields in codec that have a corresponding field in
3812  * par are freed and replaced with duplicates of the corresponding field in par.
3813  * Fields in codec that do not have a counterpart in par are not touched.
3814  *
3815  * @return >= 0 on success, a negative AVERROR code on failure.
3816  */
3817 int avcodec_parameters_to_context(AVCodecContext *codec,
3818                                   const AVCodecParameters *par);
3819
3820 /**
3821  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
3822  * function the context has to be allocated with avcodec_alloc_context3().
3823  *
3824  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
3825  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
3826  * retrieving a codec.
3827  *
3828  * @warning This function is not thread safe!
3829  *
3830  * @note Always call this function before using decoding routines (such as
3831  * @ref avcodec_receive_frame()).
3832  *
3833  * @code
3834  * avcodec_register_all();
3835  * av_dict_set(&opts, "b", "2.5M", 0);
3836  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
3837  * if (!codec)
3838  *     exit(1);
3839  *
3840  * context = avcodec_alloc_context3(codec);
3841  *
3842  * if (avcodec_open2(context, codec, opts) < 0)
3843  *     exit(1);
3844  * @endcode
3845  *
3846  * @param avctx The context to initialize.
3847  * @param codec The codec to open this context for. If a non-NULL codec has been
3848  *              previously passed to avcodec_alloc_context3() or
3849  *              for this context, then this parameter MUST be either NULL or
3850  *              equal to the previously passed codec.
3851  * @param options A dictionary filled with AVCodecContext and codec-private options.
3852  *                On return this object will be filled with options that were not found.
3853  *
3854  * @return zero on success, a negative value on error
3855  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
3856  *      av_dict_set(), av_opt_find().
3857  */
3858 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
3859
3860 /**
3861  * Close a given AVCodecContext and free all the data associated with it
3862  * (but not the AVCodecContext itself).
3863  *
3864  * Calling this function on an AVCodecContext that hasn't been opened will free
3865  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
3866  * codec. Subsequent calls will do nothing.
3867  *
3868  * @note Do not use this function. Use avcodec_free_context() to destroy a
3869  * codec context (either open or closed). Opening and closing a codec context
3870  * multiple times is not supported anymore -- use multiple codec contexts
3871  * instead.
3872  */
3873 int avcodec_close(AVCodecContext *avctx);
3874
3875 /**
3876  * Free all allocated data in the given subtitle struct.
3877  *
3878  * @param sub AVSubtitle to free.
3879  */
3880 void avsubtitle_free(AVSubtitle *sub);
3881
3882 /**
3883  * @}
3884  */
3885
3886 /**
3887  * @addtogroup lavc_packet
3888  * @{
3889  */
3890
3891 /**
3892  * Allocate an AVPacket and set its fields to default values.  The resulting
3893  * struct must be freed using av_packet_free().
3894  *
3895  * @return An AVPacket filled with default values or NULL on failure.
3896  *
3897  * @note this only allocates the AVPacket itself, not the data buffers. Those
3898  * must be allocated through other means such as av_new_packet.
3899  *
3900  * @see av_new_packet
3901  */
3902 AVPacket *av_packet_alloc(void);
3903
3904 /**
3905  * Create a new packet that references the same data as src.
3906  *
3907  * This is a shortcut for av_packet_alloc()+av_packet_ref().
3908  *
3909  * @return newly created AVPacket on success, NULL on error.
3910  *
3911  * @see av_packet_alloc
3912  * @see av_packet_ref
3913  */
3914 AVPacket *av_packet_clone(const AVPacket *src);
3915
3916 /**
3917  * Free the packet, if the packet is reference counted, it will be
3918  * unreferenced first.
3919  *
3920  * @param pkt packet to be freed. The pointer will be set to NULL.
3921  * @note passing NULL is a no-op.
3922  */
3923 void av_packet_free(AVPacket **pkt);
3924
3925 /**
3926  * Initialize optional fields of a packet with default values.
3927  *
3928  * Note, this does not touch the data and size members, which have to be
3929  * initialized separately.
3930  *
3931  * @param pkt packet
3932  */
3933 void av_init_packet(AVPacket *pkt);
3934
3935 /**
3936  * Allocate the payload of a packet and initialize its fields with
3937  * default values.
3938  *
3939  * @param pkt packet
3940  * @param size wanted payload size
3941  * @return 0 if OK, AVERROR_xxx otherwise
3942  */
3943 int av_new_packet(AVPacket *pkt, int size);
3944
3945 /**
3946  * Reduce packet size, correctly zeroing padding
3947  *
3948  * @param pkt packet
3949  * @param size new size
3950  */
3951 void av_shrink_packet(AVPacket *pkt, int size);
3952
3953 /**
3954  * Increase packet size, correctly zeroing padding
3955  *
3956  * @param pkt packet
3957  * @param grow_by number of bytes by which to increase the size of the packet
3958  */
3959 int av_grow_packet(AVPacket *pkt, int grow_by);
3960
3961 /**
3962  * Initialize a reference-counted packet from av_malloc()ed data.
3963  *
3964  * @param pkt packet to be initialized. This function will set the data, size,
3965  *        buf and destruct fields, all others are left untouched.
3966  * @param data Data allocated by av_malloc() to be used as packet data. If this
3967  *        function returns successfully, the data is owned by the underlying AVBuffer.
3968  *        The caller may not access the data through other means.
3969  * @param size size of data in bytes, without the padding. I.e. the full buffer
3970  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
3971  *
3972  * @return 0 on success, a negative AVERROR on error
3973  */
3974 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
3975
3976 #if FF_API_AVPACKET_OLD_API
3977 /**
3978  * @warning This is a hack - the packet memory allocation stuff is broken. The
3979  * packet is allocated if it was not really allocated.
3980  *
3981  * @deprecated Use av_packet_ref
3982  */
3983 attribute_deprecated
3984 int av_dup_packet(AVPacket *pkt);
3985 /**
3986  * Free a packet.
3987  *
3988  * @deprecated Use av_packet_unref
3989  *
3990  * @param pkt packet to free
3991  */
3992 attribute_deprecated
3993 void av_free_packet(AVPacket *pkt);
3994 #endif
3995 /**
3996  * Allocate new information of a packet.
3997  *
3998  * @param pkt packet
3999  * @param type side information type
4000  * @param size side information size
4001  * @return pointer to fresh allocated data or NULL otherwise
4002  */
4003 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4004                                  int size);
4005
4006 /**
4007  * Wrap an existing array as a packet side data.
4008  *
4009  * @param pkt packet
4010  * @param type side information type
4011  * @param data the side data array. It must be allocated with the av_malloc()
4012  *             family of functions. The ownership of the data is transferred to
4013  *             pkt.
4014  * @param size side information size
4015  * @return a non-negative number on success, a negative AVERROR code on
4016  *         failure. On failure, the packet is unchanged and the data remains
4017  *         owned by the caller.
4018  */
4019 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4020                             uint8_t *data, size_t size);
4021
4022 /**
4023  * Shrink the already allocated side data buffer
4024  *
4025  * @param pkt packet
4026  * @param type side information type
4027  * @param size new side information size
4028  * @return 0 on success, < 0 on failure
4029  */
4030 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4031                                int size);
4032
4033 /**
4034  * Get side information from packet.
4035  *
4036  * @param pkt packet
4037  * @param type desired side information type
4038  * @param size pointer for side information size to store (optional)
4039  * @return pointer to data if present or NULL otherwise
4040  */
4041 uint8_t* av_packet_get_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4042                                  int *size);
4043
4044 /**
4045  * Convenience function to free all the side data stored.
4046  * All the other fields stay untouched.
4047  *
4048  * @param pkt packet
4049  */
4050 void av_packet_free_side_data(AVPacket *pkt);
4051
4052 /**
4053  * Setup a new reference to the data described by a given packet
4054  *
4055  * If src is reference-counted, setup dst as a new reference to the
4056  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4057  * data from src into it.
4058  *
4059  * All the other fields are copied from src.
4060  *
4061  * @see av_packet_unref
4062  *
4063  * @param dst Destination packet
4064  * @param src Source packet
4065  *
4066  * @return 0 on success, a negative AVERROR on error.
4067  */
4068 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4069
4070 /**
4071  * Wipe the packet.
4072  *
4073  * Unreference the buffer referenced by the packet and reset the
4074  * remaining packet fields to their default values.
4075  *
4076  * @param pkt The packet to be unreferenced.
4077  */
4078 void av_packet_unref(AVPacket *pkt);
4079
4080 /**
4081  * Move every field in src to dst and reset src.
4082  *
4083  * @see av_packet_unref
4084  *
4085  * @param src Source packet, will be reset
4086  * @param dst Destination packet
4087  */
4088 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4089
4090 /**
4091  * Copy only "properties" fields from src to dst.
4092  *
4093  * Properties for the purpose of this function are all the fields
4094  * beside those related to the packet data (buf, data, size)
4095  *
4096  * @param dst Destination packet
4097  * @param src Source packet
4098  *
4099  * @return 0 on success AVERROR on failure.
4100  */
4101 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4102
4103 /**
4104  * Convert valid timing fields (timestamps / durations) in a packet from one
4105  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4106  * ignored.
4107  *
4108  * @param pkt packet on which the conversion will be performed
4109  * @param tb_src source timebase, in which the timing fields in pkt are
4110  *               expressed
4111  * @param tb_dst destination timebase, to which the timing fields will be
4112  *               converted
4113  */
4114 void av_packet_rescale_ts(AVPacket *pkt, AVRational tb_src, AVRational tb_dst);
4115
4116 /**
4117  * @}
4118  */
4119
4120 /**
4121  * @addtogroup lavc_decoding
4122  * @{
4123  */
4124
4125 /**
4126  * Find a registered decoder with a matching codec ID.
4127  *
4128  * @param id AVCodecID of the requested decoder
4129  * @return A decoder if one was found, NULL otherwise.
4130  */
4131 AVCodec *avcodec_find_decoder(enum AVCodecID id);
4132
4133 /**
4134  * Find a registered decoder with the specified name.
4135  *
4136  * @param name name of the requested decoder
4137  * @return A decoder if one was found, NULL otherwise.
4138  */
4139 AVCodec *avcodec_find_decoder_by_name(const char *name);
4140
4141 /**
4142  * The default callback for AVCodecContext.get_buffer2(). It is made public so
4143  * it can be called by custom get_buffer2() implementations for decoders without
4144  * AV_CODEC_CAP_DR1 set.
4145  */
4146 int avcodec_default_get_buffer2(AVCodecContext *s, AVFrame *frame, int flags);
4147
4148 #if FF_API_EMU_EDGE
4149 /**
4150  * Return the amount of padding in pixels which the get_buffer callback must
4151  * provide around the edge of the image for codecs which do not have the
4152  * CODEC_FLAG_EMU_EDGE flag.
4153  *
4154  * @return Required padding in pixels.
4155  *
4156  * @deprecated CODEC_FLAG_EMU_EDGE is deprecated, so this function is no longer
4157  * needed
4158  */
4159 attribute_deprecated
4160 unsigned avcodec_get_edge_width(void);
4161 #endif
4162
4163 /**
4164  * Modify width and height values so that they will result in a memory
4165  * buffer that is acceptable for the codec if you do not use any horizontal
4166  * padding.
4167  *
4168  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4169  */
4170 void avcodec_align_dimensions(AVCodecContext *s, int *width, int *height);
4171
4172 /**
4173  * Modify width and height values so that they will result in a memory
4174  * buffer that is acceptable for the codec if you also ensure that all
4175  * line sizes are a multiple of the respective linesize_align[i].
4176  *
4177  * May only be used if a codec with AV_CODEC_CAP_DR1 has been opened.
4178  */
4179 void avcodec_align_dimensions2(AVCodecContext *s, int *width, int *height,
4180                                int linesize_align[AV_NUM_DATA_POINTERS]);
4181
4182 /**
4183  * Decode the audio frame of size avpkt->size from avpkt->data into frame.
4184  *
4185  * Some decoders may support multiple frames in a single AVPacket. Such
4186  * decoders would then just decode the first frame and the return value would be
4187  * less than the packet size. In this case, avcodec_decode_audio4 has to be
4188  * called again with an AVPacket containing the remaining data in order to
4189  * decode the second frame, etc...  Even if no frames are returned, the packet
4190  * needs to be fed to the decoder with remaining data until it is completely
4191  * consumed or an error occurs.
4192  *
4193  * Some decoders (those marked with AV_CODEC_CAP_DELAY) have a delay between input
4194  * and output. This means that for some packets they will not immediately
4195  * produce decoded output and need to be flushed at the end of decoding to get
4196  * all the decoded data. Flushing is done by calling this function with packets
4197  * with avpkt->data set to NULL and avpkt->size set to 0 until it stops
4198  * returning samples. It is safe to flush even those decoders that are not
4199  * marked with AV_CODEC_CAP_DELAY, then no samples will be returned.
4200  *
4201  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4202  *          larger than the actual read bytes because some optimized bitstream
4203  *          readers read 32 or 64 bits at once and could read over the end.
4204  *
4205  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4206  * before packets may be fed to the decoder.
4207  *
4208  * @param      avctx the codec context
4209  * @param[out] frame The AVFrame in which to store decoded audio samples.
4210  *                   The decoder will allocate a buffer for the decoded frame by
4211  *                   calling the AVCodecContext.get_buffer2() callback.
4212  *                   When AVCodecContext.refcounted_frames is set to 1, the frame is
4213  *                   reference counted and the returned reference belongs to the
4214  *                   caller. The caller must release the frame using av_frame_unref()
4215  *                   when the frame is no longer needed. The caller may safely write
4216  *                   to the frame if av_frame_is_writable() returns 1.
4217  *                   When AVCodecContext.refcounted_frames is set to 0, the returned
4218  *                   reference belongs to the decoder and is valid only until the
4219  *                   next call to this function or until closing or flushing the
4220  *                   decoder. The caller may not write to it.
4221  * @param[out] got_frame_ptr Zero if no frame could be decoded, otherwise it is
4222  *                           non-zero. Note that this field being set to zero
4223  *                           does not mean that an error has occurred. For
4224  *                           decoders with AV_CODEC_CAP_DELAY set, no given decode
4225  *                           call is guaranteed to produce a frame.
4226  * @param[in]  avpkt The input AVPacket containing the input buffer.
4227  *                   At least avpkt->data and avpkt->size should be set. Some
4228  *                   decoders might also require additional fields to be set.
4229  * @return A negative error code is returned if an error occurred during
4230  *         decoding, otherwise the number of bytes consumed from the input
4231  *         AVPacket is returned.
4232  *
4233 * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4234  */
4235 attribute_deprecated
4236 int avcodec_decode_audio4(AVCodecContext *avctx, AVFrame *frame,
4237                           int *got_frame_ptr, AVPacket *avpkt);
4238
4239 /**
4240  * Decode the video frame of size avpkt->size from avpkt->data into picture.
4241  * Some decoders may support multiple frames in a single AVPacket, such
4242  * decoders would then just decode the first frame.
4243  *
4244  * @warning The input buffer must be AV_INPUT_BUFFER_PADDING_SIZE larger than
4245  * the actual read bytes because some optimized bitstream readers read 32 or 64
4246  * bits at once and could read over the end.
4247  *
4248  * @warning The end of the input buffer buf should be set to 0 to ensure that
4249  * no overreading happens for damaged MPEG streams.
4250  *
4251  * @note Codecs which have the AV_CODEC_CAP_DELAY capability set have a delay
4252  * between input and output, these need to be fed with avpkt->data=NULL,
4253  * avpkt->size=0 at the end to return the remaining frames.
4254  *
4255  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4256  * before packets may be fed to the decoder.
4257  *
4258  * @param avctx the codec context
4259  * @param[out] picture The AVFrame in which the decoded video frame will be stored.
4260  *             Use av_frame_alloc() to get an AVFrame. The codec will
4261  *             allocate memory for the actual bitmap by calling the
4262  *             AVCodecContext.get_buffer2() callback.
4263  *             When AVCodecContext.refcounted_frames is set to 1, the frame is
4264  *             reference counted and the returned reference belongs to the
4265  *             caller. The caller must release the frame using av_frame_unref()
4266  *             when the frame is no longer needed. The caller may safely write
4267  *             to the frame if av_frame_is_writable() returns 1.
4268  *             When AVCodecContext.refcounted_frames is set to 0, the returned
4269  *             reference belongs to the decoder and is valid only until the
4270  *             next call to this function or until closing or flushing the
4271  *             decoder. The caller may not write to it.
4272  *
4273  * @param[in] avpkt The input AVPacket containing the input buffer.
4274  *            You can create such packet with av_init_packet() and by then setting
4275  *            data and size, some decoders might in addition need other fields like
4276  *            flags&AV_PKT_FLAG_KEY. All decoders are designed to use the least
4277  *            fields possible.
4278  * @param[in,out] got_picture_ptr Zero if no frame could be decompressed, otherwise, it is nonzero.
4279  * @return On error a negative value is returned, otherwise the number of bytes
4280  * used or zero if no frame could be decompressed.
4281  *
4282  * @deprecated Use avcodec_send_packet() and avcodec_receive_frame().
4283  */
4284 attribute_deprecated
4285 int avcodec_decode_video2(AVCodecContext *avctx, AVFrame *picture,
4286                          int *got_picture_ptr,
4287                          AVPacket *avpkt);
4288
4289 /**
4290  * Decode a subtitle message.
4291  * Return a negative value on error, otherwise return the number of bytes used.
4292  * If no subtitle could be decompressed, got_sub_ptr is zero.
4293  * Otherwise, the subtitle is stored in *sub.
4294  * Note that AV_CODEC_CAP_DR1 is not available for subtitle codecs. This is for
4295  * simplicity, because the performance difference is expect to be negligible
4296  * and reusing a get_buffer written for video codecs would probably perform badly
4297  * due to a potentially very different allocation pattern.
4298  *
4299  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4300  * before packets may be fed to the decoder.
4301  *
4302  * @param avctx the codec context
4303  * @param[out] sub The AVSubtitle in which the decoded subtitle will be stored, must be
4304                    freed with avsubtitle_free if *got_sub_ptr is set.
4305  * @param[in,out] got_sub_ptr Zero if no subtitle could be decompressed, otherwise, it is nonzero.
4306  * @param[in] avpkt The input AVPacket containing the input buffer.
4307  */
4308 int avcodec_decode_subtitle2(AVCodecContext *avctx, AVSubtitle *sub,
4309                             int *got_sub_ptr,
4310                             AVPacket *avpkt);
4311
4312 /**
4313  * Supply raw packet data as input to a decoder.
4314  *
4315  * Internally, this call will copy relevant AVCodecContext fields, which can
4316  * influence decoding per-packet, and apply them when the packet is actually
4317  * decoded. (For example AVCodecContext.skip_frame, which might direct the
4318  * decoder to drop the frame contained by the packet sent with this function.)
4319  *
4320  * @warning The input buffer, avpkt->data must be AV_INPUT_BUFFER_PADDING_SIZE
4321  *          larger than the actual read bytes because some optimized bitstream
4322  *          readers read 32 or 64 bits at once and could read over the end.
4323  *
4324  * @warning Do not mix this API with the legacy API (like avcodec_decode_video2())
4325  *          on the same AVCodecContext. It will return unexpected results now
4326  *          or in future libavcodec versions.
4327  *
4328  * @note The AVCodecContext MUST have been opened with @ref avcodec_open2()
4329  *       before packets may be fed to the decoder.
4330  *
4331  * @param avctx codec context
4332  * @param[in] avpkt The input AVPacket. Usually, this will be a single video
4333  *                  frame, or several complete audio frames.
4334  *                  Ownership of the packet remains with the caller, and the
4335  *                  decoder will not write to the packet. The decoder may create
4336  *                  a reference to the packet data (or copy it if the packet is
4337  *                  not reference-counted).
4338  *                  Unlike with older APIs, the packet is always fully consumed,
4339  *                  and if it contains multiple frames (e.g. some audio codecs),
4340  *                  will require you to call avcodec_receive_frame() multiple
4341  *                  times afterwards before you can send a new packet.
4342  *                  It can be NULL (or an AVPacket with data set to NULL and
4343  *                  size set to 0); in this case, it is considered a flush
4344  *                  packet, which signals the end of the stream. Sending the
4345  *                  first flush packet will return success. Subsequent ones are
4346  *                  unnecessary and will return AVERROR_EOF. If the decoder
4347  *                  still has frames buffered, it will return them after sending
4348  *                  a flush packet.
4349  *
4350  * @return 0 on success, otherwise negative error code:
4351  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
4352  *                         must read output with avcodec_receive_frame() (once
4353  *                         all output is read, the packet should be resent, and
4354  *                         the call will not fail with EAGAIN).
4355  *      AVERROR_EOF:       the decoder has been flushed, and no new packets can
4356  *                         be sent to it (also returned if more than 1 flush
4357  *                         packet is sent)
4358  *      AVERROR(EINVAL):   codec not opened, it is an encoder, or requires flush
4359  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4360  *      other errors: legitimate decoding errors
4361  */
4362 int avcodec_send_packet(AVCodecContext *avctx, const AVPacket *avpkt);
4363
4364 /**
4365  * Return decoded output data from a decoder.
4366  *
4367  * @param avctx codec context
4368  * @param frame This will be set to a reference-counted video or audio
4369  *              frame (depending on the decoder type) allocated by the
4370  *              decoder. Note that the function will always call
4371  *              av_frame_unref(frame) before doing anything else.
4372  *
4373  * @return
4374  *      0:                 success, a frame was returned
4375  *      AVERROR(EAGAIN):   output is not available in this state - user must try
4376  *                         to send new input
4377  *      AVERROR_EOF:       the decoder has been fully flushed, and there will be
4378  *                         no more output frames
4379  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4380  *      other negative values: legitimate decoding errors
4381  */
4382 int avcodec_receive_frame(AVCodecContext *avctx, AVFrame *frame);
4383
4384 /**
4385  * Supply a raw video or audio frame to the encoder. Use avcodec_receive_packet()
4386  * to retrieve buffered output packets.
4387  *
4388  * @param avctx     codec context
4389  * @param[in] frame AVFrame containing the raw audio or video frame to be encoded.
4390  *                  Ownership of the frame remains with the caller, and the
4391  *                  encoder will not write to the frame. The encoder may create
4392  *                  a reference to the frame data (or copy it if the frame is
4393  *                  not reference-counted).
4394  *                  It can be NULL, in which case it is considered a flush
4395  *                  packet.  This signals the end of the stream. If the encoder
4396  *                  still has packets buffered, it will return them after this
4397  *                  call. Once flushing mode has been entered, additional flush
4398  *                  packets are ignored, and sending frames will return
4399  *                  AVERROR_EOF.
4400  *
4401  *                  For audio:
4402  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4403  *                  can have any number of samples.
4404  *                  If it is not set, frame->nb_samples must be equal to
4405  *                  avctx->frame_size for all frames except the last.
4406  *                  The final frame may be smaller than avctx->frame_size.
4407  * @return 0 on success, otherwise negative error code:
4408  *      AVERROR(EAGAIN):   input is not accepted in the current state - user
4409  *                         must read output with avcodec_receive_packet() (once
4410  *                         all output is read, the packet should be resent, and
4411  *                         the call will not fail with EAGAIN).
4412  *      AVERROR_EOF:       the encoder has been flushed, and no new frames can
4413  *                         be sent to it
4414  *      AVERROR(EINVAL):   codec not opened, refcounted_frames not set, it is a
4415  *                         decoder, or requires flush
4416  *      AVERROR(ENOMEM):   failed to add packet to internal queue, or similar
4417  *      other errors: legitimate decoding errors
4418  */
4419 int avcodec_send_frame(AVCodecContext *avctx, const AVFrame *frame);
4420
4421 /**
4422  * Read encoded data from the encoder.
4423  *
4424  * @param avctx codec context
4425  * @param avpkt This will be set to a reference-counted packet allocated by the
4426  *              encoder. Note that the function will always call
4427  *              av_frame_unref(frame) before doing anything else.
4428  * @return 0 on success, otherwise negative error code:
4429  *      AVERROR(EAGAIN):   output is not available in the current state - user
4430  *                         must try to send input
4431  *      AVERROR_EOF:       the encoder has been fully flushed, and there will be
4432  *                         no more output packets
4433  *      AVERROR(EINVAL):   codec not opened, or it is an encoder
4434  *      other errors: legitimate decoding errors
4435  */
4436 int avcodec_receive_packet(AVCodecContext *avctx, AVPacket *avpkt);
4437
4438
4439 /**
4440  * @defgroup lavc_parsing Frame parsing
4441  * @{
4442  */
4443
4444 enum AVPictureStructure {
4445     AV_PICTURE_STRUCTURE_UNKNOWN,      //< unknown
4446     AV_PICTURE_STRUCTURE_TOP_FIELD,    //< coded as top field
4447     AV_PICTURE_STRUCTURE_BOTTOM_FIELD, //< coded as bottom field
4448     AV_PICTURE_STRUCTURE_FRAME,        //< coded as frame
4449 };
4450
4451 typedef struct AVCodecParserContext {
4452     void *priv_data;
4453     struct AVCodecParser *parser;
4454     int64_t frame_offset; /* offset of the current frame */
4455     int64_t cur_offset; /* current offset
4456                            (incremented by each av_parser_parse()) */
4457     int64_t next_frame_offset; /* offset of the next frame */
4458     /* video info */
4459     int pict_type; /* XXX: Put it back in AVCodecContext. */
4460     /**
4461      * This field is used for proper frame duration computation in lavf.
4462      * It signals, how much longer the frame duration of the current frame
4463      * is compared to normal frame duration.
4464      *
4465      * frame_duration = (1 + repeat_pict) * time_base
4466      *
4467      * It is used by codecs like H.264 to display telecined material.
4468      */
4469     int repeat_pict; /* XXX: Put it back in AVCodecContext. */
4470     int64_t pts;     /* pts of the current frame */
4471     int64_t dts;     /* dts of the current frame */
4472
4473     /* private data */
4474     int64_t last_pts;
4475     int64_t last_dts;
4476     int fetch_timestamp;
4477
4478 #define AV_PARSER_PTS_NB 4
4479     int cur_frame_start_index;
4480     int64_t cur_frame_offset[AV_PARSER_PTS_NB];
4481     int64_t cur_frame_pts[AV_PARSER_PTS_NB];
4482     int64_t cur_frame_dts[AV_PARSER_PTS_NB];
4483
4484     int flags;
4485 #define PARSER_FLAG_COMPLETE_FRAMES           0x0001
4486 #define PARSER_FLAG_ONCE                      0x0002
4487 /// Set if the parser has a valid file offset
4488 #define PARSER_FLAG_FETCHED_OFFSET            0x0004
4489
4490     int64_t offset;      ///< byte offset from starting packet start
4491     int64_t cur_frame_end[AV_PARSER_PTS_NB];
4492
4493     /**
4494      * Set by parser to 1 for key frames and 0 for non-key frames.
4495      * It is initialized to -1, so if the parser doesn't set this flag,
4496      * old-style fallback using AV_PICTURE_TYPE_I picture type as key frames
4497      * will be used.
4498      */
4499     int key_frame;
4500
4501 #if FF_API_CONVERGENCE_DURATION
4502     /**
4503      * @deprecated unused
4504      */
4505     attribute_deprecated
4506     int64_t convergence_duration;
4507 #endif
4508
4509     // Timestamp generation support:
4510     /**
4511      * Synchronization point for start of timestamp generation.
4512      *
4513      * Set to >0 for sync point, 0 for no sync point and <0 for undefined
4514      * (default).
4515      *
4516      * For example, this corresponds to presence of H.264 buffering period
4517      * SEI message.
4518      */
4519     int dts_sync_point;
4520
4521     /**
4522      * Offset of the current timestamp against last timestamp sync point in
4523      * units of AVCodecContext.time_base.
4524      *
4525      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4526      * contain a valid timestamp offset.
4527      *
4528      * Note that the timestamp of sync point has usually a nonzero
4529      * dts_ref_dts_delta, which refers to the previous sync point. Offset of
4530      * the next frame after timestamp sync point will be usually 1.
4531      *
4532      * For example, this corresponds to H.264 cpb_removal_delay.
4533      */
4534     int dts_ref_dts_delta;
4535
4536     /**
4537      * Presentation delay of current frame in units of AVCodecContext.time_base.
4538      *
4539      * Set to INT_MIN when dts_sync_point unused. Otherwise, it must
4540      * contain valid non-negative timestamp delta (presentation time of a frame
4541      * must not lie in the past).
4542      *
4543      * This delay represents the difference between decoding and presentation
4544      * time of the frame.
4545      *
4546      * For example, this corresponds to H.264 dpb_output_delay.
4547      */
4548     int pts_dts_delta;
4549
4550     /**
4551      * Position of the packet in file.
4552      *
4553      * Analogous to cur_frame_pts/dts
4554      */
4555     int64_t cur_frame_pos[AV_PARSER_PTS_NB];
4556
4557     /**
4558      * Byte position of currently parsed frame in stream.
4559      */
4560     int64_t pos;
4561
4562     /**
4563      * Previous frame byte position.
4564      */
4565     int64_t last_pos;
4566
4567     /**
4568      * Duration of the current frame.
4569      * For audio, this is in units of 1 / AVCodecContext.sample_rate.
4570      * For all other types, this is in units of AVCodecContext.time_base.
4571      */
4572     int duration;
4573
4574     enum AVFieldOrder field_order;
4575
4576     /**
4577      * Indicate whether a picture is coded as a frame, top field or bottom field.
4578      *
4579      * For example, H.264 field_pic_flag equal to 0 corresponds to
4580      * AV_PICTURE_STRUCTURE_FRAME. An H.264 picture with field_pic_flag
4581      * equal to 1 and bottom_field_flag equal to 0 corresponds to
4582      * AV_PICTURE_STRUCTURE_TOP_FIELD.
4583      */
4584     enum AVPictureStructure picture_structure;
4585
4586     /**
4587      * Picture number incremented in presentation or output order.
4588      * This field may be reinitialized at the first picture of a new sequence.
4589      *
4590      * For example, this corresponds to H.264 PicOrderCnt.
4591      */
4592     int output_picture_number;
4593
4594     /**
4595      * Dimensions of the decoded video intended for presentation.
4596      */
4597     int width;
4598     int height;
4599
4600     /**
4601      * Dimensions of the coded video.
4602      */
4603     int coded_width;
4604     int coded_height;
4605
4606     /**
4607      * The format of the coded data, corresponds to enum AVPixelFormat for video
4608      * and for enum AVSampleFormat for audio.
4609      *
4610      * Note that a decoder can have considerable freedom in how exactly it
4611      * decodes the data, so the format reported here might be different from the
4612      * one returned by a decoder.
4613      */
4614     int format;
4615 } AVCodecParserContext;
4616
4617 typedef struct AVCodecParser {
4618     int codec_ids[5]; /* several codec IDs are permitted */
4619     int priv_data_size;
4620     int (*parser_init)(AVCodecParserContext *s);
4621     /* This callback never returns an error, a negative value means that
4622      * the frame start was in a previous packet. */
4623     int (*parser_parse)(AVCodecParserContext *s,
4624                         AVCodecContext *avctx,
4625                         const uint8_t **poutbuf, int *poutbuf_size,
4626                         const uint8_t *buf, int buf_size);
4627     void (*parser_close)(AVCodecParserContext *s);
4628     int (*split)(AVCodecContext *avctx, const uint8_t *buf, int buf_size);
4629     struct AVCodecParser *next;
4630 } AVCodecParser;
4631
4632 AVCodecParser *av_parser_next(const AVCodecParser *c);
4633
4634 void av_register_codec_parser(AVCodecParser *parser);
4635 AVCodecParserContext *av_parser_init(int codec_id);
4636
4637 /**
4638  * Parse a packet.
4639  *
4640  * @param s             parser context.
4641  * @param avctx         codec context.
4642  * @param poutbuf       set to pointer to parsed buffer or NULL if not yet finished.
4643  * @param poutbuf_size  set to size of parsed buffer or zero if not yet finished.
4644  * @param buf           input buffer.
4645  * @param buf_size      input length, to signal EOF, this should be 0 (so that the last frame can be output).
4646  * @param pts           input presentation timestamp.
4647  * @param dts           input decoding timestamp.
4648  * @param pos           input byte position in stream.
4649  * @return the number of bytes of the input bitstream used.
4650  *
4651  * Example:
4652  * @code
4653  *   while(in_len){
4654  *       len = av_parser_parse2(myparser, AVCodecContext, &data, &size,
4655  *                                        in_data, in_len,
4656  *                                        pts, dts, pos);
4657  *       in_data += len;
4658  *       in_len  -= len;
4659  *
4660  *       if(size)
4661  *          decode_frame(data, size);
4662  *   }
4663  * @endcode
4664  */
4665 int av_parser_parse2(AVCodecParserContext *s,
4666                      AVCodecContext *avctx,
4667                      uint8_t **poutbuf, int *poutbuf_size,
4668                      const uint8_t *buf, int buf_size,
4669                      int64_t pts, int64_t dts,
4670                      int64_t pos);
4671
4672 /**
4673  * @return 0 if the output buffer is a subset of the input, 1 if it is allocated and must be freed
4674  * @deprecated use AVBitstreamFilter
4675  */
4676 int av_parser_change(AVCodecParserContext *s,
4677                      AVCodecContext *avctx,
4678                      uint8_t **poutbuf, int *poutbuf_size,
4679                      const uint8_t *buf, int buf_size, int keyframe);
4680 void av_parser_close(AVCodecParserContext *s);
4681
4682 /**
4683  * @}
4684  * @}
4685  */
4686
4687 /**
4688  * @addtogroup lavc_encoding
4689  * @{
4690  */
4691
4692 /**
4693  * Find a registered encoder with a matching codec ID.
4694  *
4695  * @param id AVCodecID of the requested encoder
4696  * @return An encoder if one was found, NULL otherwise.
4697  */
4698 AVCodec *avcodec_find_encoder(enum AVCodecID id);
4699
4700 /**
4701  * Find a registered encoder with the specified name.
4702  *
4703  * @param name name of the requested encoder
4704  * @return An encoder if one was found, NULL otherwise.
4705  */
4706 AVCodec *avcodec_find_encoder_by_name(const char *name);
4707
4708 /**
4709  * Encode a frame of audio.
4710  *
4711  * Takes input samples from frame and writes the next output packet, if
4712  * available, to avpkt. The output packet does not necessarily contain data for
4713  * the most recent frame, as encoders can delay, split, and combine input frames
4714  * internally as needed.
4715  *
4716  * @param avctx     codec context
4717  * @param avpkt     output AVPacket.
4718  *                  The user can supply an output buffer by setting
4719  *                  avpkt->data and avpkt->size prior to calling the
4720  *                  function, but if the size of the user-provided data is not
4721  *                  large enough, encoding will fail. All other AVPacket fields
4722  *                  will be reset by the encoder using av_init_packet(). If
4723  *                  avpkt->data is NULL, the encoder will allocate it.
4724  *                  The encoder will set avpkt->size to the size of the
4725  *                  output packet.
4726  *
4727  *                  If this function fails or produces no output, avpkt will be
4728  *                  freed using av_packet_unref().
4729  * @param[in] frame AVFrame containing the raw audio data to be encoded.
4730  *                  May be NULL when flushing an encoder that has the
4731  *                  AV_CODEC_CAP_DELAY capability set.
4732  *                  If AV_CODEC_CAP_VARIABLE_FRAME_SIZE is set, then each frame
4733  *                  can have any number of samples.
4734  *                  If it is not set, frame->nb_samples must be equal to
4735  *                  avctx->frame_size for all frames except the last.
4736  *                  The final frame may be smaller than avctx->frame_size.
4737  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4738  *                            output packet is non-empty, and to 0 if it is
4739  *                            empty. If the function returns an error, the
4740  *                            packet can be assumed to be invalid, and the
4741  *                            value of got_packet_ptr is undefined and should
4742  *                            not be used.
4743  * @return          0 on success, negative error code on failure
4744  *
4745  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4746  */
4747 attribute_deprecated
4748 int avcodec_encode_audio2(AVCodecContext *avctx, AVPacket *avpkt,
4749                           const AVFrame *frame, int *got_packet_ptr);
4750
4751 /**
4752  * Encode a frame of video.
4753  *
4754  * Takes input raw video data from frame and writes the next output packet, if
4755  * available, to avpkt. The output packet does not necessarily contain data for
4756  * the most recent frame, as encoders can delay and reorder input frames
4757  * internally as needed.
4758  *
4759  * @param avctx     codec context
4760  * @param avpkt     output AVPacket.
4761  *                  The user can supply an output buffer by setting
4762  *                  avpkt->data and avpkt->size prior to calling the
4763  *                  function, but if the size of the user-provided data is not
4764  *                  large enough, encoding will fail. All other AVPacket fields
4765  *                  will be reset by the encoder using av_init_packet(). If
4766  *                  avpkt->data is NULL, the encoder will allocate it.
4767  *                  The encoder will set avpkt->size to the size of the
4768  *                  output packet. The returned data (if any) belongs to the
4769  *                  caller, he is responsible for freeing it.
4770  *
4771  *                  If this function fails or produces no output, avpkt will be
4772  *                  freed using av_packet_unref().
4773  * @param[in] frame AVFrame containing the raw video data to be encoded.
4774  *                  May be NULL when flushing an encoder that has the
4775  *                  AV_CODEC_CAP_DELAY capability set.
4776  * @param[out] got_packet_ptr This field is set to 1 by libavcodec if the
4777  *                            output packet is non-empty, and to 0 if it is
4778  *                            empty. If the function returns an error, the
4779  *                            packet can be assumed to be invalid, and the
4780  *                            value of got_packet_ptr is undefined and should
4781  *                            not be used.
4782  * @return          0 on success, negative error code on failure
4783  *
4784  * @deprecated use avcodec_send_frame()/avcodec_receive_packet() instead
4785  */
4786 attribute_deprecated
4787 int avcodec_encode_video2(AVCodecContext *avctx, AVPacket *avpkt,
4788                           const AVFrame *frame, int *got_packet_ptr);
4789
4790 int avcodec_encode_subtitle(AVCodecContext *avctx, uint8_t *buf, int buf_size,
4791                             const AVSubtitle *sub);
4792
4793
4794 /**
4795  * @}
4796  */
4797
4798 #if FF_API_AVPICTURE
4799 /**
4800  * @addtogroup lavc_picture
4801  * @{
4802  */
4803
4804 /**
4805  * @deprecated unused
4806  */
4807 attribute_deprecated
4808 int avpicture_alloc(AVPicture *picture, enum AVPixelFormat pix_fmt, int width, int height);
4809
4810 /**
4811  * @deprecated unused
4812  */
4813 attribute_deprecated
4814 void avpicture_free(AVPicture *picture);
4815
4816 /**
4817  * @deprecated use av_image_fill_arrays() instead.
4818  */
4819 attribute_deprecated
4820 int avpicture_fill(AVPicture *picture, uint8_t *ptr,
4821                    enum AVPixelFormat pix_fmt, int width, int height);
4822
4823 /**
4824  * @deprecated use av_image_copy_to_buffer() instead.
4825  */
4826 attribute_deprecated
4827 int avpicture_layout(const AVPicture* src, enum AVPixelFormat pix_fmt,
4828                      int width, int height,
4829                      unsigned char *dest, int dest_size);
4830
4831 /**
4832  * @deprecated use av_image_get_buffer_size() instead.
4833  */
4834 attribute_deprecated
4835 int avpicture_get_size(enum AVPixelFormat pix_fmt, int width, int height);
4836
4837 /**
4838  * @deprecated av_image_copy() instead.
4839  */
4840 attribute_deprecated
4841 void av_picture_copy(AVPicture *dst, const AVPicture *src,
4842                      enum AVPixelFormat pix_fmt, int width, int height);
4843
4844 /**
4845  * @deprecated unused
4846  */
4847 attribute_deprecated
4848 int av_picture_crop(AVPicture *dst, const AVPicture *src,
4849                     enum AVPixelFormat pix_fmt, int top_band, int left_band);
4850
4851 /**
4852  * @deprecated unused
4853  */
4854 attribute_deprecated
4855 int av_picture_pad(AVPicture *dst, const AVPicture *src, int height, int width, enum AVPixelFormat pix_fmt,
4856             int padtop, int padbottom, int padleft, int padright, int *color);
4857
4858 /**
4859  * @}
4860  */
4861 #endif
4862
4863 /**
4864  * @defgroup lavc_misc Utility functions
4865  * @ingroup libavc
4866  *
4867  * Miscellaneous utility functions related to both encoding and decoding
4868  * (or neither).
4869  * @{
4870  */
4871
4872 /**
4873  * @defgroup lavc_misc_pixfmt Pixel formats
4874  *
4875  * Functions for working with pixel formats.
4876  * @{
4877  */
4878
4879 /**
4880  * Return a value representing the fourCC code associated to the
4881  * pixel format pix_fmt, or 0 if no associated fourCC code can be
4882  * found.
4883  */
4884 unsigned int avcodec_pix_fmt_to_codec_tag(enum AVPixelFormat pix_fmt);
4885
4886 #define FF_LOSS_RESOLUTION  0x0001 /**< loss due to resolution change */
4887 #define FF_LOSS_DEPTH       0x0002 /**< loss due to color depth change */
4888 #define FF_LOSS_COLORSPACE  0x0004 /**< loss due to color space conversion */
4889 #define FF_LOSS_ALPHA       0x0008 /**< loss of alpha bits */
4890 #define FF_LOSS_COLORQUANT  0x0010 /**< loss due to color quantization */
4891 #define FF_LOSS_CHROMA      0x0020 /**< loss of chroma (e.g. RGB to gray conversion) */
4892
4893 /**
4894  * Compute what kind of losses will occur when converting from one specific
4895  * pixel format to another.
4896  * When converting from one pixel format to another, information loss may occur.
4897  * For example, when converting from RGB24 to GRAY, the color information will
4898  * be lost. Similarly, other losses occur when converting from some formats to
4899  * other formats. These losses can involve loss of chroma, but also loss of
4900  * resolution, loss of color depth, loss due to the color space conversion, loss
4901  * of the alpha bits or loss due to color quantization.
4902  * avcodec_get_fix_fmt_loss() informs you about the various types of losses
4903  * which will occur when converting from one pixel format to another.
4904  *
4905  * @param[in] dst_pix_fmt destination pixel format
4906  * @param[in] src_pix_fmt source pixel format
4907  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4908  * @return Combination of flags informing you what kind of losses will occur.
4909  */
4910 int avcodec_get_pix_fmt_loss(enum AVPixelFormat dst_pix_fmt, enum AVPixelFormat src_pix_fmt,
4911                              int has_alpha);
4912
4913 /**
4914  * Find the best pixel format to convert to given a certain source pixel
4915  * format.  When converting from one pixel format to another, information loss
4916  * may occur.  For example, when converting from RGB24 to GRAY, the color
4917  * information will be lost. Similarly, other losses occur when converting from
4918  * some formats to other formats. avcodec_find_best_pix_fmt2() searches which of
4919  * the given pixel formats should be used to suffer the least amount of loss.
4920  * The pixel formats from which it chooses one, are determined by the
4921  * pix_fmt_list parameter.
4922  *
4923  *
4924  * @param[in] pix_fmt_list AV_PIX_FMT_NONE terminated array of pixel formats to choose from
4925  * @param[in] src_pix_fmt source pixel format
4926  * @param[in] has_alpha Whether the source pixel format alpha channel is used.
4927  * @param[out] loss_ptr Combination of flags informing you what kind of losses will occur.
4928  * @return The best pixel format to convert to or -1 if none was found.
4929  */
4930 enum AVPixelFormat avcodec_find_best_pix_fmt2(enum AVPixelFormat *pix_fmt_list,
4931                                               enum AVPixelFormat src_pix_fmt,
4932                                               int has_alpha, int *loss_ptr);
4933
4934 enum AVPixelFormat avcodec_default_get_format(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
4935
4936 /**
4937  * @}
4938  */
4939
4940 /**
4941  * Put a string representing the codec tag codec_tag in buf.
4942  *
4943  * @param buf       buffer to place codec tag in
4944  * @param buf_size size in bytes of buf
4945  * @param codec_tag codec tag to assign
4946  * @return the length of the string that would have been generated if
4947  * enough space had been available, excluding the trailing null
4948  */
4949 size_t av_get_codec_tag_string(char *buf, size_t buf_size, unsigned int codec_tag);
4950
4951 void avcodec_string(char *buf, int buf_size, AVCodecContext *enc, int encode);
4952
4953 /**
4954  * Return a name for the specified profile, if available.
4955  *
4956  * @param codec the codec that is searched for the given profile
4957  * @param profile the profile value for which a name is requested
4958  * @return A name for the profile if found, NULL otherwise.
4959  */
4960 const char *av_get_profile_name(const AVCodec *codec, int profile);
4961
4962 /**
4963  * Return a name for the specified profile, if available.
4964  *
4965  * @param codec_id the ID of the codec to which the requested profile belongs
4966  * @param profile the profile value for which a name is requested
4967  * @return A name for the profile if found, NULL otherwise.
4968  *
4969  * @note unlike av_get_profile_name(), which searches a list of profiles
4970  *       supported by a specific decoder or encoder implementation, this
4971  *       function searches the list of profiles from the AVCodecDescriptor
4972  */
4973 const char *avcodec_profile_name(enum AVCodecID codec_id, int profile);
4974
4975 int avcodec_default_execute(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2),void *arg, int *ret, int count, int size);
4976 int avcodec_default_execute2(AVCodecContext *c, int (*func)(AVCodecContext *c2, void *arg2, int, int),void *arg, int *ret, int count);
4977 //FIXME func typedef
4978
4979 /**
4980  * Fill audio frame data and linesize.
4981  * AVFrame extended_data channel pointers are allocated if necessary for
4982  * planar audio.
4983  *
4984  * @param frame       the AVFrame
4985  *                    frame->nb_samples must be set prior to calling the
4986  *                    function. This function fills in frame->data,
4987  *                    frame->extended_data, frame->linesize[0].
4988  * @param nb_channels channel count
4989  * @param sample_fmt  sample format
4990  * @param buf         buffer to use for frame data
4991  * @param buf_size    size of buffer
4992  * @param align       plane size sample alignment (0 = default)
4993  * @return            0 on success, negative error code on failure
4994  */
4995 int avcodec_fill_audio_frame(AVFrame *frame, int nb_channels,
4996                              enum AVSampleFormat sample_fmt, const uint8_t *buf,
4997                              int buf_size, int align);
4998
4999 /**
5000  * Reset the internal decoder state / flush internal buffers. Should be called
5001  * e.g. when seeking or when switching to a different stream.
5002  *
5003  * @note when refcounted frames are not used (i.e. avctx->refcounted_frames is 0),
5004  * this invalidates the frames previously returned from the decoder. When
5005  * refcounted frames are used, the decoder just releases any references it might
5006  * keep internally, but the caller's reference remains valid.
5007  */
5008 void avcodec_flush_buffers(AVCodecContext *avctx);
5009
5010 /**
5011  * Return codec bits per sample.
5012  *
5013  * @param[in] codec_id the codec
5014  * @return Number of bits per sample or zero if unknown for the given codec.
5015  */
5016 int av_get_bits_per_sample(enum AVCodecID codec_id);
5017
5018 /**
5019  * Return codec bits per sample.
5020  * Only return non-zero if the bits per sample is exactly correct, not an
5021  * approximation.
5022  *
5023  * @param[in] codec_id the codec
5024  * @return Number of bits per sample or zero if unknown for the given codec.
5025  */
5026 int av_get_exact_bits_per_sample(enum AVCodecID codec_id);
5027
5028 /**
5029  * Return audio frame duration.
5030  *
5031  * @param avctx        codec context
5032  * @param frame_bytes  size of the frame, or 0 if unknown
5033  * @return             frame duration, in samples, if known. 0 if not able to
5034  *                     determine.
5035  */
5036 int av_get_audio_frame_duration(AVCodecContext *avctx, int frame_bytes);
5037
5038 /**
5039  * This function is the same as av_get_audio_frame_duration(), except it works
5040  * with AVCodecParameters instead of an AVCodecContext.
5041  */
5042 int av_get_audio_frame_duration2(AVCodecParameters *par, int frame_bytes);
5043
5044 #if FF_API_OLD_BSF
5045 typedef struct AVBitStreamFilterContext {
5046     void *priv_data;
5047     struct AVBitStreamFilter *filter;
5048     AVCodecParserContext *parser;
5049     struct AVBitStreamFilterContext *next;
5050 } AVBitStreamFilterContext;
5051 #endif
5052
5053 typedef struct AVBSFInternal AVBSFInternal;
5054
5055 /**
5056  * The bitstream filter state.
5057  *
5058  * This struct must be allocated with av_bsf_alloc() and freed with
5059  * av_bsf_free().
5060  *
5061  * The fields in the struct will only be changed (by the caller or by the
5062  * filter) as described in their documentation, and are to be considered
5063  * immutable otherwise.
5064  */
5065 typedef struct AVBSFContext {
5066     /**
5067      * A class for logging and AVOptions
5068      */
5069     const AVClass *av_class;
5070
5071     /**
5072      * The bitstream filter this context is an instance of.
5073      */
5074     const struct AVBitStreamFilter *filter;
5075
5076     /**
5077      * Opaque libavcodec internal data. Must not be touched by the caller in any
5078      * way.
5079      */
5080     AVBSFInternal *internal;
5081
5082     /**
5083      * Opaque filter-specific private data. If filter->priv_class is non-NULL,
5084      * this is an AVOptions-enabled struct.
5085      */
5086     void *priv_data;
5087
5088     /**
5089      * Parameters of the input stream. This field is allocated in
5090      * av_bsf_alloc(), it needs to be filled by the caller before
5091      * av_bsf_init().
5092      */
5093     AVCodecParameters *par_in;
5094
5095     /**
5096      * Parameters of the output stream. This field is allocated in
5097      * av_bsf_alloc(), it is set by the filter in av_bsf_init().
5098      */
5099     AVCodecParameters *par_out;
5100
5101     /**
5102      * The timebase used for the timestamps of the input packets. Set by the
5103      * caller before av_bsf_init().
5104      */
5105     AVRational time_base_in;
5106
5107     /**
5108      * The timebase used for the timestamps of the output packets. Set by the
5109      * filter in av_bsf_init().
5110      */
5111     AVRational time_base_out;
5112 } AVBSFContext;
5113
5114 typedef struct AVBitStreamFilter {
5115     const char *name;
5116
5117     /**
5118      * A list of codec ids supported by the filter, terminated by
5119      * AV_CODEC_ID_NONE.
5120      * May be NULL, in that case the bitstream filter works with any codec id.
5121      */
5122     const enum AVCodecID *codec_ids;
5123
5124     /**
5125      * A class for the private data, used to declare bitstream filter private
5126      * AVOptions. This field is NULL for bitstream filters that do not declare
5127      * any options.
5128      *
5129      * If this field is non-NULL, the first member of the filter private data
5130      * must be a pointer to AVClass, which will be set by libavcodec generic
5131      * code to this class.
5132      */
5133     const AVClass *priv_class;
5134
5135     /*****************************************************************
5136      * No fields below this line are part of the public API. They
5137      * may not be used outside of libavcodec and can be changed and
5138      * removed at will.
5139      * New public fields should be added right above.
5140      *****************************************************************
5141      */
5142
5143     int priv_data_size;
5144     int (*init)(AVBSFContext *ctx);
5145     int (*filter)(AVBSFContext *ctx, AVPacket *pkt);
5146     void (*close)(AVBSFContext *ctx);
5147 } AVBitStreamFilter;
5148
5149 #if FF_API_OLD_BSF
5150 /**
5151  * @deprecated the old bitstream filtering API (using AVBitStreamFilterContext)
5152  * is deprecated. Use the new bitstream filtering API (using AVBSFContext).
5153  */
5154 attribute_deprecated
5155 void av_register_bitstream_filter(AVBitStreamFilter *bsf);
5156 attribute_deprecated
5157 AVBitStreamFilterContext *av_bitstream_filter_init(const char *name);
5158 attribute_deprecated
5159 int av_bitstream_filter_filter(AVBitStreamFilterContext *bsfc,
5160                                AVCodecContext *avctx, const char *args,
5161                                uint8_t **poutbuf, int *poutbuf_size,
5162                                const uint8_t *buf, int buf_size, int keyframe);
5163 attribute_deprecated
5164 void av_bitstream_filter_close(AVBitStreamFilterContext *bsf);
5165 attribute_deprecated
5166 AVBitStreamFilter *av_bitstream_filter_next(const AVBitStreamFilter *f);
5167 #endif
5168
5169 /**
5170  * @return a bitstream filter with the specified name or NULL if no such
5171  *         bitstream filter exists.
5172  */
5173 const AVBitStreamFilter *av_bsf_get_by_name(const char *name);
5174
5175 /**
5176  * Iterate over all registered bitstream filters.
5177  *
5178  * @param opaque a pointer where libavcodec will store the iteration state. Must
5179  *               point to NULL to start the iteration.
5180  *
5181  * @return the next registered bitstream filter or NULL when the iteration is
5182  *         finished
5183  */
5184 const AVBitStreamFilter *av_bsf_next(void **opaque);
5185
5186 /**
5187  * Allocate a context for a given bitstream filter. The caller must fill in the
5188  * context parameters as described in the documentation and then call
5189  * av_bsf_init() before sending any data to the filter.
5190  *
5191  * @param filter the filter for which to allocate an instance.
5192  * @param ctx a pointer into which the pointer to the newly-allocated context
5193  *            will be written. It must be freed with av_bsf_free() after the
5194  *            filtering is done.
5195  *
5196  * @return 0 on success, a negative AVERROR code on failure
5197  */
5198 int av_bsf_alloc(const AVBitStreamFilter *filter, AVBSFContext **ctx);
5199
5200 /**
5201  * Prepare the filter for use, after all the parameters and options have been
5202  * set.
5203  */
5204 int av_bsf_init(AVBSFContext *ctx);
5205
5206 /**
5207  * Submit a packet for filtering.
5208  *
5209  * After sending each packet, the filter must be completely drained by calling
5210  * av_bsf_receive_packet() repeatedly until it returns AVERROR(EAGAIN) or
5211  * AVERROR_EOF.
5212  *
5213  * @param pkt the packet to filter. The bitstream filter will take ownership of
5214  * the packet and reset the contents of pkt. pkt is not touched if an error occurs.
5215  * This parameter may be NULL, which signals the end of the stream (i.e. no more
5216  * packets will be sent). That will cause the filter to output any packets it
5217  * may have buffered internally.
5218  *
5219  * @return 0 on success, a negative AVERROR on error.
5220  */
5221 int av_bsf_send_packet(AVBSFContext *ctx, AVPacket *pkt);
5222
5223 /**
5224  * Retrieve a filtered packet.
5225  *
5226  * @param[out] pkt this struct will be filled with the contents of the filtered
5227  *                 packet. It is owned by the caller and must be freed using
5228  *                 av_packet_unref() when it is no longer needed.
5229  *                 This parameter should be "clean" (i.e. freshly allocated
5230  *                 with av_packet_alloc() or unreffed with av_packet_unref())
5231  *                 when this function is called. If this function returns
5232  *                 successfully, the contents of pkt will be completely
5233  *                 overwritten by the returned data. On failure, pkt is not
5234  *                 touched.
5235  *
5236  * @return 0 on success. AVERROR(EAGAIN) if more packets need to be sent to the
5237  * filter (using av_bsf_send_packet()) to get more output. AVERROR_EOF if there
5238  * will be no further output from the filter. Another negative AVERROR value if
5239  * an error occurs.
5240  *
5241  * @note one input packet may result in several output packets, so after sending
5242  * a packet with av_bsf_send_packet(), this function needs to be called
5243  * repeatedly until it stops returning 0. It is also possible for a filter to
5244  * output fewer packets than were sent to it, so this function may return
5245  * AVERROR(EAGAIN) immediately after a successful av_bsf_send_packet() call.
5246  */
5247 int av_bsf_receive_packet(AVBSFContext *ctx, AVPacket *pkt);
5248
5249 /**
5250  * Free a bitstream filter context and everything associated with it; write NULL
5251  * into the supplied pointer.
5252  */
5253 void av_bsf_free(AVBSFContext **ctx);
5254
5255 /**
5256  * Get the AVClass for AVBSFContext. It can be used in combination with
5257  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
5258  *
5259  * @see av_opt_find().
5260  */
5261 const AVClass *av_bsf_get_class(void);
5262
5263 /* memory */
5264
5265 /**
5266  * Allocate a buffer with padding, reusing the given one if large enough.
5267  *
5268  * Same behaviour av_fast_malloc but the buffer has additional
5269  * AV_INPUT_PADDING_SIZE at the end which will always memset to 0.
5270  */
5271 void av_fast_padded_malloc(void *ptr, unsigned int *size, size_t min_size);
5272
5273 /**
5274  * Encode extradata length to a buffer. Used by xiph codecs.
5275  *
5276  * @param s buffer to write to; must be at least (v/255+1) bytes long
5277  * @param v size of extradata in bytes
5278  * @return number of bytes written to the buffer.
5279  */
5280 unsigned int av_xiphlacing(unsigned char *s, unsigned int v);
5281
5282 /**
5283  * Register the hardware accelerator hwaccel.
5284  */
5285 void av_register_hwaccel(AVHWAccel *hwaccel);
5286
5287 /**
5288  * If hwaccel is NULL, returns the first registered hardware accelerator,
5289  * if hwaccel is non-NULL, returns the next registered hardware accelerator
5290  * after hwaccel, or NULL if hwaccel is the last one.
5291  */
5292 AVHWAccel *av_hwaccel_next(const AVHWAccel *hwaccel);
5293
5294
5295 /**
5296  * Lock operation used by lockmgr
5297  */
5298 enum AVLockOp {
5299   AV_LOCK_CREATE,  ///< Create a mutex
5300   AV_LOCK_OBTAIN,  ///< Lock the mutex
5301   AV_LOCK_RELEASE, ///< Unlock the mutex
5302   AV_LOCK_DESTROY, ///< Free mutex resources
5303 };
5304
5305 /**
5306  * Register a user provided lock manager supporting the operations
5307  * specified by AVLockOp. The "mutex" argument to the function points
5308  * to a (void *) where the lockmgr should store/get a pointer to a user
5309  * allocated mutex. It is NULL upon AV_LOCK_CREATE and equal to the
5310  * value left by the last call for all other ops. If the lock manager is
5311  * unable to perform the op then it should leave the mutex in the same
5312  * state as when it was called and return a non-zero value. However,
5313  * when called with AV_LOCK_DESTROY the mutex will always be assumed to
5314  * have been successfully destroyed. If av_lockmgr_register succeeds
5315  * it will return a non-negative value, if it fails it will return a
5316  * negative value and destroy all mutex and unregister all callbacks.
5317  * av_lockmgr_register is not thread-safe, it must be called from a
5318  * single thread before any calls which make use of locking are used.
5319  *
5320  * @param cb User defined callback. av_lockmgr_register invokes calls
5321  *           to this callback and the previously registered callback.
5322  *           The callback will be used to create more than one mutex
5323  *           each of which must be backed by its own underlying locking
5324  *           mechanism (i.e. do not use a single static object to
5325  *           implement your lock manager). If cb is set to NULL the
5326  *           lockmgr will be unregistered.
5327  */
5328 int av_lockmgr_register(int (*cb)(void **mutex, enum AVLockOp op));
5329
5330 /**
5331  * Get the type of the given codec.
5332  */
5333 enum AVMediaType avcodec_get_type(enum AVCodecID codec_id);
5334
5335 /**
5336  * @return a positive value if s is open (i.e. avcodec_open2() was called on it
5337  * with no corresponding avcodec_close()), 0 otherwise.
5338  */
5339 int avcodec_is_open(AVCodecContext *s);
5340
5341 /**
5342  * @return a non-zero number if codec is an encoder, zero otherwise
5343  */
5344 int av_codec_is_encoder(const AVCodec *codec);
5345
5346 /**
5347  * @return a non-zero number if codec is a decoder, zero otherwise
5348  */
5349 int av_codec_is_decoder(const AVCodec *codec);
5350
5351 /**
5352  * @return descriptor for given codec ID or NULL if no descriptor exists.
5353  */
5354 const AVCodecDescriptor *avcodec_descriptor_get(enum AVCodecID id);
5355
5356 /**
5357  * Iterate over all codec descriptors known to libavcodec.
5358  *
5359  * @param prev previous descriptor. NULL to get the first descriptor.
5360  *
5361  * @return next descriptor or NULL after the last descriptor
5362  */
5363 const AVCodecDescriptor *avcodec_descriptor_next(const AVCodecDescriptor *prev);
5364
5365 /**
5366  * @return codec descriptor with the given name or NULL if no such descriptor
5367  *         exists.
5368  */
5369 const AVCodecDescriptor *avcodec_descriptor_get_by_name(const char *name);
5370
5371 /**
5372  * Allocate a CPB properties structure and initialize its fields to default
5373  * values.
5374  *
5375  * @param size if non-NULL, the size of the allocated struct will be written
5376  *             here. This is useful for embedding it in side data.
5377  *
5378  * @return the newly allocated struct or NULL on failure
5379  */
5380 AVCPBProperties *av_cpb_properties_alloc(size_t *size);
5381
5382 /**
5383  * @}
5384  */
5385
5386 #endif /* AVCODEC_AVCODEC_H */