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

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