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

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