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

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