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