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