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

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