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

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