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