Add libcodec2 en/decoder
[ffmpeg.git] / libavcodec / avcodec.h
1 /*
2  * copyright (c) 2001 Fabrice Bellard
3  *
4  * This file is part of FFmpeg.
5  *
6  * FFmpeg is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * FFmpeg is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with FFmpeg; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19  */
20
21 #ifndef AVCODEC_AVCODEC_H
22 #define AVCODEC_AVCODEC_H
23
24 /**
25  * @file
26  * @ingroup libavc
27  * Libavcodec external API header
28  */
29
30 #include <errno.h>
31 #include "libavutil/samplefmt.h"
32 #include "libavutil/attributes.h"
33 #include "libavutil/avutil.h"
34 #include "libavutil/buffer.h"
35 #include "libavutil/cpu.h"
36 #include "libavutil/channel_layout.h"
37 #include "libavutil/dict.h"
38 #include "libavutil/frame.h"
39 #include "libavutil/hwcontext.h"
40 #include "libavutil/log.h"
41 #include "libavutil/pixfmt.h"
42 #include "libavutil/rational.h"
43
44 #include "version.h"
45
46 /**
47  * @defgroup libavc libavcodec
48  * Encoding/Decoding Library
49  *
50  * @{
51  *
52  * @defgroup lavc_decoding Decoding
53  * @{
54  * @}
55  *
56  * @defgroup lavc_encoding Encoding
57  * @{
58  * @}
59  *
60  * @defgroup lavc_codec Codecs
61  * @{
62  * @defgroup lavc_codec_native Native Codecs
63  * @{
64  * @}
65  * @defgroup lavc_codec_wrappers External library wrappers
66  * @{
67  * @}
68  * @defgroup lavc_codec_hwaccel Hardware Accelerators bridge
69  * @{
70  * @}
71  * @}
72  * @defgroup lavc_internal Internal
73  * @{
74  * @}
75  * @}
76  */
77
78 /**
79  * @ingroup libavc
80  * @defgroup lavc_encdec send/receive encoding and decoding API overview
81  * @{
82  *
83  * The avcodec_send_packet()/avcodec_receive_frame()/avcodec_send_frame()/
84  * avcodec_receive_packet() functions provide an encode/decode API, which
85  * decouples input and output.
86  *
87  * The API is very similar for encoding/decoding and audio/video, and works as
88  * follows:
89  * - Set up and open the AVCodecContext as usual.
90  * - Send valid input:
91  *   - For decoding, call avcodec_send_packet() to give the decoder raw
92  *     compressed data in an AVPacket.
93  *   - For encoding, call avcodec_send_frame() to give the encoder an AVFrame
94  *     containing uncompressed audio or video.
95  *   In both cases, it is recommended that AVPackets and AVFrames are
96  *   refcounted, or libavcodec might have to copy the input data. (libavformat
97  *   always returns refcounted AVPackets, and av_frame_get_buffer() allocates
98  *   refcounted AVFrames.)
99  * - Receive output in a loop. Periodically call one of the avcodec_receive_*()
100  *   functions and process their output:
101  *   - For decoding, call avcodec_receive_frame(). On success, it will return
102  *     an AVFrame containing uncompressed audio or video data.
103  *   - For encoding, call avcodec_receive_packet(). On success, it will return
104  *     an AVPacket with a compressed frame.
105  *   Repeat this call until it returns AVERROR(EAGAIN) or an error. The
106  *   AVERROR(EAGAIN) return value means that new input data is required to
107  *   return new output. In this case, continue with sending input. For each
108  *   input frame/packet, the codec will typically return 1 output frame/packet,
109  *   but it can also be 0 or more than 1.
110  *
111  * At the beginning of decoding or encoding, the codec might accept multiple
112  * input frames/packets without returning a frame, until its internal buffers
113  * are filled. This situation is handled transparently if you follow the steps
114  * outlined above.
115  *
116  * In theory, sending input can result in EAGAIN - this should happen only if
117  * not all output was received. You can use this to structure alternative decode
118  * or encode loops other than the one suggested above. For example, you could
119  * try sending new input on each iteration, and try to receive output if that
120  * returns EAGAIN.
121  *
122  * End of stream situations. These require "flushing" (aka draining) the codec,
123  * as the codec might buffer multiple frames or packets internally for
124  * performance or out of necessity (consider B-frames).
125  * This is handled as follows:
126  * - Instead of valid input, send NULL to the avcodec_send_packet() (decoding)
127  *   or avcodec_send_frame() (encoding) functions. This will enter draining
128  *   mode.
129  * - Call avcodec_receive_frame() (decoding) or avcodec_receive_packet()
130  *   (encoding) in a loop until AVERROR_EOF is returned. The functions will
131  *   not return AVERROR(EAGAIN), unless you forgot to enter draining mode.
132  * - Before decoding can be resumed again, the codec has to be reset with
133  *   avcodec_flush_buffers().
134  *
135  * Using the API as outlined above is highly recommended. But it is also
136  * possible to call functions outside of this rigid schema. For example, you can
137  * call avcodec_send_packet() repeatedly without calling
138  * avcodec_receive_frame(). In this case, avcodec_send_packet() will succeed
139  * until the codec's internal buffer has been filled up (which is typically of
140  * size 1 per output frame, after initial input), and then reject input with
141  * AVERROR(EAGAIN). Once it starts rejecting input, you have no choice but to
142  * read at least some output.
143  *
144  * Not all codecs will follow a rigid and predictable dataflow; the only
145  * guarantee is that an AVERROR(EAGAIN) return value on a send/receive call on
146  * one end implies that a receive/send call on the other end will succeed, or
147  * at least will not fail with AVERROR(EAGAIN). In general, no codec will
148  * permit unlimited buffering of input or output.
149  *
150  * This API replaces the following legacy functions:
151  * - avcodec_decode_video2() and avcodec_decode_audio4():
152  *   Use avcodec_send_packet() to feed input to the decoder, then use
153  *   avcodec_receive_frame() to receive decoded frames after each packet.
154  *   Unlike with the old video decoding API, multiple frames might result from
155  *   a packet. For audio, splitting the input packet into frames by partially
156  *   decoding packets becomes transparent to the API user. You never need to
157  *   feed an AVPacket to the API twice (unless it is rejected with AVERROR(EAGAIN) - then
158  *   no data was read from the packet).
159  *   Additionally, sending a flush/draining packet is required only once.
160  * - avcodec_encode_video2()/avcodec_encode_audio2():
161  *   Use avcodec_send_frame() to feed input to the encoder, then use
162  *   avcodec_receive_packet() to receive encoded packets.
163  *   Providing user-allocated buffers for avcodec_receive_packet() is not
164  *   possible.
165  * - The new API does not handle subtitles yet.
166  *
167  * Mixing new and old function calls on the same AVCodecContext is not allowed,
168  * and will result in undefined behavior.
169  *
170  * Some codecs might require using the new API; using the old API will return
171  * an error when calling it. All codecs support the new API.
172  *
173  * A codec is not allowed to return AVERROR(EAGAIN) for both sending and receiving. This
174  * would be an invalid state, which could put the codec user into an endless
175  * loop. The API has no concept of time either: it cannot happen that trying to
176  * do avcodec_send_packet() results in AVERROR(EAGAIN), but a repeated call 1 second
177  * later accepts the packet (with no other receive/flush API calls involved).
178  * The API is a strict state machine, and the passage of time is not supposed
179  * to influence it. Some timing-dependent behavior might still be deemed
180  * acceptable in certain cases. But it must never result in both send/receive
181  * returning EAGAIN at the same time at any point. It must also absolutely be
182  * avoided that the current state is "unstable" and can "flip-flop" between
183  * the send/receive APIs allowing progress. For example, it's not allowed that
184  * the codec randomly decides that it actually wants to consume a packet now
185  * instead of returning a frame, after it just returned AVERROR(EAGAIN) on an
186  * avcodec_send_packet() call.
187  * @}
188  */
189
190 /**
191  * @defgroup lavc_core Core functions/structures.
192  * @ingroup libavc
193  *
194  * Basic definitions, functions for querying libavcodec capabilities,
195  * allocating core structures, etc.
196  * @{
197  */
198
199
200 /**
201  * Identify the syntax and semantics of the bitstream.
202  * The principle is roughly:
203  * Two decoders with the same ID can decode the same streams.
204  * Two encoders with the same ID can encode compatible streams.
205  * There may be slight deviations from the principle due to implementation
206  * details.
207  *
208  * If you add a codec ID to this list, add it so that
209  * 1. no value of an existing codec ID changes (that would break ABI),
210  * 2. it is as close as possible to similar codecs
211  *
212  * After adding new codec IDs, do not forget to add an entry to the codec
213  * descriptor list and bump libavcodec minor version.
214  */
215 enum AVCodecID {
216     AV_CODEC_ID_NONE,
217
218     /* video codecs */
219     AV_CODEC_ID_MPEG1VIDEO,
220     AV_CODEC_ID_MPEG2VIDEO, ///< preferred ID for MPEG-1/2 video decoding
221     AV_CODEC_ID_H261,
222     AV_CODEC_ID_H263,
223     AV_CODEC_ID_RV10,
224     AV_CODEC_ID_RV20,
225     AV_CODEC_ID_MJPEG,
226     AV_CODEC_ID_MJPEGB,
227     AV_CODEC_ID_LJPEG,
228     AV_CODEC_ID_SP5X,
229     AV_CODEC_ID_JPEGLS,
230     AV_CODEC_ID_MPEG4,
231     AV_CODEC_ID_RAWVIDEO,
232     AV_CODEC_ID_MSMPEG4V1,
233     AV_CODEC_ID_MSMPEG4V2,
234     AV_CODEC_ID_MSMPEG4V3,
235     AV_CODEC_ID_WMV1,
236     AV_CODEC_ID_WMV2,
237     AV_CODEC_ID_H263P,
238     AV_CODEC_ID_H263I,
239     AV_CODEC_ID_FLV1,
240     AV_CODEC_ID_SVQ1,
241     AV_CODEC_ID_SVQ3,
242     AV_CODEC_ID_DVVIDEO,
243     AV_CODEC_ID_HUFFYUV,
244     AV_CODEC_ID_CYUV,
245     AV_CODEC_ID_H264,
246     AV_CODEC_ID_INDEO3,
247     AV_CODEC_ID_VP3,
248     AV_CODEC_ID_THEORA,
249     AV_CODEC_ID_ASV1,
250     AV_CODEC_ID_ASV2,
251     AV_CODEC_ID_FFV1,
252     AV_CODEC_ID_4XM,
253     AV_CODEC_ID_VCR1,
254     AV_CODEC_ID_CLJR,
255     AV_CODEC_ID_MDEC,
256     AV_CODEC_ID_ROQ,
257     AV_CODEC_ID_INTERPLAY_VIDEO,
258     AV_CODEC_ID_XAN_WC3,
259     AV_CODEC_ID_XAN_WC4,
260     AV_CODEC_ID_RPZA,
261     AV_CODEC_ID_CINEPAK,
262     AV_CODEC_ID_WS_VQA,
263     AV_CODEC_ID_MSRLE,
264     AV_CODEC_ID_MSVIDEO1,
265     AV_CODEC_ID_IDCIN,
266     AV_CODEC_ID_8BPS,
267     AV_CODEC_ID_SMC,
268     AV_CODEC_ID_FLIC,
269     AV_CODEC_ID_TRUEMOTION1,
270     AV_CODEC_ID_VMDVIDEO,
271     AV_CODEC_ID_MSZH,
272     AV_CODEC_ID_ZLIB,
273     AV_CODEC_ID_QTRLE,
274     AV_CODEC_ID_TSCC,
275     AV_CODEC_ID_ULTI,
276     AV_CODEC_ID_QDRAW,
277     AV_CODEC_ID_VIXL,
278     AV_CODEC_ID_QPEG,
279     AV_CODEC_ID_PNG,
280     AV_CODEC_ID_PPM,
281     AV_CODEC_ID_PBM,
282     AV_CODEC_ID_PGM,
283     AV_CODEC_ID_PGMYUV,
284     AV_CODEC_ID_PAM,
285     AV_CODEC_ID_FFVHUFF,
286     AV_CODEC_ID_RV30,
287     AV_CODEC_ID_RV40,
288     AV_CODEC_ID_VC1,
289     AV_CODEC_ID_WMV3,
290     AV_CODEC_ID_LOCO,
291     AV_CODEC_ID_WNV1,
292     AV_CODEC_ID_AASC,
293     AV_CODEC_ID_INDEO2,
294     AV_CODEC_ID_FRAPS,
295     AV_CODEC_ID_TRUEMOTION2,
296     AV_CODEC_ID_BMP,
297     AV_CODEC_ID_CSCD,
298     AV_CODEC_ID_MMVIDEO,
299     AV_CODEC_ID_ZMBV,
300     AV_CODEC_ID_AVS,
301     AV_CODEC_ID_SMACKVIDEO,
302     AV_CODEC_ID_NUV,
303     AV_CODEC_ID_KMVC,
304     AV_CODEC_ID_FLASHSV,
305     AV_CODEC_ID_CAVS,
306     AV_CODEC_ID_JPEG2000,
307     AV_CODEC_ID_VMNC,
308     AV_CODEC_ID_VP5,
309     AV_CODEC_ID_VP6,
310     AV_CODEC_ID_VP6F,
311     AV_CODEC_ID_TARGA,
312     AV_CODEC_ID_DSICINVIDEO,
313     AV_CODEC_ID_TIERTEXSEQVIDEO,
314     AV_CODEC_ID_TIFF,
315     AV_CODEC_ID_GIF,
316     AV_CODEC_ID_DXA,
317     AV_CODEC_ID_DNXHD,
318     AV_CODEC_ID_THP,
319     AV_CODEC_ID_SGI,
320     AV_CODEC_ID_C93,
321     AV_CODEC_ID_BETHSOFTVID,
322     AV_CODEC_ID_PTX,
323     AV_CODEC_ID_TXD,
324     AV_CODEC_ID_VP6A,
325     AV_CODEC_ID_AMV,
326     AV_CODEC_ID_VB,
327     AV_CODEC_ID_PCX,
328     AV_CODEC_ID_SUNRAST,
329     AV_CODEC_ID_INDEO4,
330     AV_CODEC_ID_INDEO5,
331     AV_CODEC_ID_MIMIC,
332     AV_CODEC_ID_RL2,
333     AV_CODEC_ID_ESCAPE124,
334     AV_CODEC_ID_DIRAC,
335     AV_CODEC_ID_BFI,
336     AV_CODEC_ID_CMV,
337     AV_CODEC_ID_MOTIONPIXELS,
338     AV_CODEC_ID_TGV,
339     AV_CODEC_ID_TGQ,
340     AV_CODEC_ID_TQI,
341     AV_CODEC_ID_AURA,
342     AV_CODEC_ID_AURA2,
343     AV_CODEC_ID_V210X,
344     AV_CODEC_ID_TMV,
345     AV_CODEC_ID_V210,
346     AV_CODEC_ID_DPX,
347     AV_CODEC_ID_MAD,
348     AV_CODEC_ID_FRWU,
349     AV_CODEC_ID_FLASHSV2,
350     AV_CODEC_ID_CDGRAPHICS,
351     AV_CODEC_ID_R210,
352     AV_CODEC_ID_ANM,
353     AV_CODEC_ID_BINKVIDEO,
354     AV_CODEC_ID_IFF_ILBM,
355 #define AV_CODEC_ID_IFF_BYTERUN1 AV_CODEC_ID_IFF_ILBM
356     AV_CODEC_ID_KGV1,
357     AV_CODEC_ID_YOP,
358     AV_CODEC_ID_VP8,
359     AV_CODEC_ID_PICTOR,
360     AV_CODEC_ID_ANSI,
361     AV_CODEC_ID_A64_MULTI,
362     AV_CODEC_ID_A64_MULTI5,
363     AV_CODEC_ID_R10K,
364     AV_CODEC_ID_MXPEG,
365     AV_CODEC_ID_LAGARITH,
366     AV_CODEC_ID_PRORES,
367     AV_CODEC_ID_JV,
368     AV_CODEC_ID_DFA,
369     AV_CODEC_ID_WMV3IMAGE,
370     AV_CODEC_ID_VC1IMAGE,
371     AV_CODEC_ID_UTVIDEO,
372     AV_CODEC_ID_BMV_VIDEO,
373     AV_CODEC_ID_VBLE,
374     AV_CODEC_ID_DXTORY,
375     AV_CODEC_ID_V410,
376     AV_CODEC_ID_XWD,
377     AV_CODEC_ID_CDXL,
378     AV_CODEC_ID_XBM,
379     AV_CODEC_ID_ZEROCODEC,
380     AV_CODEC_ID_MSS1,
381     AV_CODEC_ID_MSA1,
382     AV_CODEC_ID_TSCC2,
383     AV_CODEC_ID_MTS2,
384     AV_CODEC_ID_CLLC,
385     AV_CODEC_ID_MSS2,
386     AV_CODEC_ID_VP9,
387     AV_CODEC_ID_AIC,
388     AV_CODEC_ID_ESCAPE130,
389     AV_CODEC_ID_G2M,
390     AV_CODEC_ID_WEBP,
391     AV_CODEC_ID_HNM4_VIDEO,
392     AV_CODEC_ID_HEVC,
393 #define AV_CODEC_ID_H265 AV_CODEC_ID_HEVC
394     AV_CODEC_ID_FIC,
395     AV_CODEC_ID_ALIAS_PIX,
396     AV_CODEC_ID_BRENDER_PIX,
397     AV_CODEC_ID_PAF_VIDEO,
398     AV_CODEC_ID_EXR,
399     AV_CODEC_ID_VP7,
400     AV_CODEC_ID_SANM,
401     AV_CODEC_ID_SGIRLE,
402     AV_CODEC_ID_MVC1,
403     AV_CODEC_ID_MVC2,
404     AV_CODEC_ID_HQX,
405     AV_CODEC_ID_TDSC,
406     AV_CODEC_ID_HQ_HQA,
407     AV_CODEC_ID_HAP,
408     AV_CODEC_ID_DDS,
409     AV_CODEC_ID_DXV,
410     AV_CODEC_ID_SCREENPRESSO,
411     AV_CODEC_ID_RSCC,
412
413     AV_CODEC_ID_Y41P = 0x8000,
414     AV_CODEC_ID_AVRP,
415     AV_CODEC_ID_012V,
416     AV_CODEC_ID_AVUI,
417     AV_CODEC_ID_AYUV,
418     AV_CODEC_ID_TARGA_Y216,
419     AV_CODEC_ID_V308,
420     AV_CODEC_ID_V408,
421     AV_CODEC_ID_YUV4,
422     AV_CODEC_ID_AVRN,
423     AV_CODEC_ID_CPIA,
424     AV_CODEC_ID_XFACE,
425     AV_CODEC_ID_SNOW,
426     AV_CODEC_ID_SMVJPEG,
427     AV_CODEC_ID_APNG,
428     AV_CODEC_ID_DAALA,
429     AV_CODEC_ID_CFHD,
430     AV_CODEC_ID_TRUEMOTION2RT,
431     AV_CODEC_ID_M101,
432     AV_CODEC_ID_MAGICYUV,
433     AV_CODEC_ID_SHEERVIDEO,
434     AV_CODEC_ID_YLC,
435     AV_CODEC_ID_PSD,
436     AV_CODEC_ID_PIXLET,
437     AV_CODEC_ID_SPEEDHQ,
438     AV_CODEC_ID_FMVC,
439     AV_CODEC_ID_SCPR,
440     AV_CODEC_ID_CLEARVIDEO,
441     AV_CODEC_ID_XPM,
442     AV_CODEC_ID_AV1,
443     AV_CODEC_ID_BITPACKED,
444     AV_CODEC_ID_MSCC,
445     AV_CODEC_ID_SRGC,
446     AV_CODEC_ID_SVG,
447     AV_CODEC_ID_GDV,
448     AV_CODEC_ID_FITS,
449
450     /* various PCM "codecs" */
451     AV_CODEC_ID_FIRST_AUDIO = 0x10000,     ///< A dummy id pointing at the start of audio codecs
452     AV_CODEC_ID_PCM_S16LE = 0x10000,
453     AV_CODEC_ID_PCM_S16BE,
454     AV_CODEC_ID_PCM_U16LE,
455     AV_CODEC_ID_PCM_U16BE,
456     AV_CODEC_ID_PCM_S8,
457     AV_CODEC_ID_PCM_U8,
458     AV_CODEC_ID_PCM_MULAW,
459     AV_CODEC_ID_PCM_ALAW,
460     AV_CODEC_ID_PCM_S32LE,
461     AV_CODEC_ID_PCM_S32BE,
462     AV_CODEC_ID_PCM_U32LE,
463     AV_CODEC_ID_PCM_U32BE,
464     AV_CODEC_ID_PCM_S24LE,
465     AV_CODEC_ID_PCM_S24BE,
466     AV_CODEC_ID_PCM_U24LE,
467     AV_CODEC_ID_PCM_U24BE,
468     AV_CODEC_ID_PCM_S24DAUD,
469     AV_CODEC_ID_PCM_ZORK,
470     AV_CODEC_ID_PCM_S16LE_PLANAR,
471     AV_CODEC_ID_PCM_DVD,
472     AV_CODEC_ID_PCM_F32BE,
473     AV_CODEC_ID_PCM_F32LE,
474     AV_CODEC_ID_PCM_F64BE,
475     AV_CODEC_ID_PCM_F64LE,
476     AV_CODEC_ID_PCM_BLURAY,
477     AV_CODEC_ID_PCM_LXF,
478     AV_CODEC_ID_S302M,
479     AV_CODEC_ID_PCM_S8_PLANAR,
480     AV_CODEC_ID_PCM_S24LE_PLANAR,
481     AV_CODEC_ID_PCM_S32LE_PLANAR,
482     AV_CODEC_ID_PCM_S16BE_PLANAR,
483
484     AV_CODEC_ID_PCM_S64LE = 0x10800,
485     AV_CODEC_ID_PCM_S64BE,
486     AV_CODEC_ID_PCM_F16LE,
487     AV_CODEC_ID_PCM_F24LE,
488
489     /* various ADPCM codecs */
490     AV_CODEC_ID_ADPCM_IMA_QT = 0x11000,
491     AV_CODEC_ID_ADPCM_IMA_WAV,
492     AV_CODEC_ID_ADPCM_IMA_DK3,
493     AV_CODEC_ID_ADPCM_IMA_DK4,
494     AV_CODEC_ID_ADPCM_IMA_WS,
495     AV_CODEC_ID_ADPCM_IMA_SMJPEG,
496     AV_CODEC_ID_ADPCM_MS,
497     AV_CODEC_ID_ADPCM_4XM,
498     AV_CODEC_ID_ADPCM_XA,
499     AV_CODEC_ID_ADPCM_ADX,
500     AV_CODEC_ID_ADPCM_EA,
501     AV_CODEC_ID_ADPCM_G726,
502     AV_CODEC_ID_ADPCM_CT,
503     AV_CODEC_ID_ADPCM_SWF,
504     AV_CODEC_ID_ADPCM_YAMAHA,
505     AV_CODEC_ID_ADPCM_SBPRO_4,
506     AV_CODEC_ID_ADPCM_SBPRO_3,
507     AV_CODEC_ID_ADPCM_SBPRO_2,
508     AV_CODEC_ID_ADPCM_THP,
509     AV_CODEC_ID_ADPCM_IMA_AMV,
510     AV_CODEC_ID_ADPCM_EA_R1,
511     AV_CODEC_ID_ADPCM_EA_R3,
512     AV_CODEC_ID_ADPCM_EA_R2,
513     AV_CODEC_ID_ADPCM_IMA_EA_SEAD,
514     AV_CODEC_ID_ADPCM_IMA_EA_EACS,
515     AV_CODEC_ID_ADPCM_EA_XAS,
516     AV_CODEC_ID_ADPCM_EA_MAXIS_XA,
517     AV_CODEC_ID_ADPCM_IMA_ISS,
518     AV_CODEC_ID_ADPCM_G722,
519     AV_CODEC_ID_ADPCM_IMA_APC,
520     AV_CODEC_ID_ADPCM_VIMA,
521
522     AV_CODEC_ID_ADPCM_AFC = 0x11800,
523     AV_CODEC_ID_ADPCM_IMA_OKI,
524     AV_CODEC_ID_ADPCM_DTK,
525     AV_CODEC_ID_ADPCM_IMA_RAD,
526     AV_CODEC_ID_ADPCM_G726LE,
527     AV_CODEC_ID_ADPCM_THP_LE,
528     AV_CODEC_ID_ADPCM_PSX,
529     AV_CODEC_ID_ADPCM_AICA,
530     AV_CODEC_ID_ADPCM_IMA_DAT4,
531     AV_CODEC_ID_ADPCM_MTAF,
532
533     /* AMR */
534     AV_CODEC_ID_AMR_NB = 0x12000,
535     AV_CODEC_ID_AMR_WB,
536
537     /* RealAudio codecs*/
538     AV_CODEC_ID_RA_144 = 0x13000,
539     AV_CODEC_ID_RA_288,
540
541     /* various DPCM codecs */
542     AV_CODEC_ID_ROQ_DPCM = 0x14000,
543     AV_CODEC_ID_INTERPLAY_DPCM,
544     AV_CODEC_ID_XAN_DPCM,
545     AV_CODEC_ID_SOL_DPCM,
546
547     AV_CODEC_ID_SDX2_DPCM = 0x14800,
548     AV_CODEC_ID_GREMLIN_DPCM,
549
550     /* audio codecs */
551     AV_CODEC_ID_MP2 = 0x15000,
552     AV_CODEC_ID_MP3, ///< preferred ID for decoding MPEG audio layer 1, 2 or 3
553     AV_CODEC_ID_AAC,
554     AV_CODEC_ID_AC3,
555     AV_CODEC_ID_DTS,
556     AV_CODEC_ID_VORBIS,
557     AV_CODEC_ID_DVAUDIO,
558     AV_CODEC_ID_WMAV1,
559     AV_CODEC_ID_WMAV2,
560     AV_CODEC_ID_MACE3,
561     AV_CODEC_ID_MACE6,
562     AV_CODEC_ID_VMDAUDIO,
563     AV_CODEC_ID_FLAC,
564     AV_CODEC_ID_MP3ADU,
565     AV_CODEC_ID_MP3ON4,
566     AV_CODEC_ID_SHORTEN,
567     AV_CODEC_ID_ALAC,
568     AV_CODEC_ID_WESTWOOD_SND1,
569     AV_CODEC_ID_GSM, ///< as in Berlin toast format
570     AV_CODEC_ID_QDM2,
571     AV_CODEC_ID_COOK,
572     AV_CODEC_ID_TRUESPEECH,
573     AV_CODEC_ID_TTA,
574     AV_CODEC_ID_SMACKAUDIO,
575     AV_CODEC_ID_QCELP,
576     AV_CODEC_ID_WAVPACK,
577     AV_CODEC_ID_DSICINAUDIO,
578     AV_CODEC_ID_IMC,
579     AV_CODEC_ID_MUSEPACK7,
580     AV_CODEC_ID_MLP,
581     AV_CODEC_ID_GSM_MS, /* as found in WAV */
582     AV_CODEC_ID_ATRAC3,
583     AV_CODEC_ID_APE,
584     AV_CODEC_ID_NELLYMOSER,
585     AV_CODEC_ID_MUSEPACK8,
586     AV_CODEC_ID_SPEEX,
587     AV_CODEC_ID_WMAVOICE,
588     AV_CODEC_ID_WMAPRO,
589     AV_CODEC_ID_WMALOSSLESS,
590     AV_CODEC_ID_ATRAC3P,
591     AV_CODEC_ID_EAC3,
592     AV_CODEC_ID_SIPR,
593     AV_CODEC_ID_MP1,
594     AV_CODEC_ID_TWINVQ,
595     AV_CODEC_ID_TRUEHD,
596     AV_CODEC_ID_MP4ALS,
597     AV_CODEC_ID_ATRAC1,
598     AV_CODEC_ID_BINKAUDIO_RDFT,
599     AV_CODEC_ID_BINKAUDIO_DCT,
600     AV_CODEC_ID_AAC_LATM,
601     AV_CODEC_ID_QDMC,
602     AV_CODEC_ID_CELT,
603     AV_CODEC_ID_G723_1,
604     AV_CODEC_ID_G729,
605     AV_CODEC_ID_8SVX_EXP,
606     AV_CODEC_ID_8SVX_FIB,
607     AV_CODEC_ID_BMV_AUDIO,
608     AV_CODEC_ID_RALF,
609     AV_CODEC_ID_IAC,
610     AV_CODEC_ID_ILBC,
611     AV_CODEC_ID_OPUS,
612     AV_CODEC_ID_COMFORT_NOISE,
613     AV_CODEC_ID_TAK,
614     AV_CODEC_ID_METASOUND,
615     AV_CODEC_ID_PAF_AUDIO,
616     AV_CODEC_ID_ON2AVC,
617     AV_CODEC_ID_DSS_SP,
618     AV_CODEC_ID_CODEC2,
619
620     AV_CODEC_ID_FFWAVESYNTH = 0x15800,
621     AV_CODEC_ID_SONIC,
622     AV_CODEC_ID_SONIC_LS,
623     AV_CODEC_ID_EVRC,
624     AV_CODEC_ID_SMV,
625     AV_CODEC_ID_DSD_LSBF,
626     AV_CODEC_ID_DSD_MSBF,
627     AV_CODEC_ID_DSD_LSBF_PLANAR,
628     AV_CODEC_ID_DSD_MSBF_PLANAR,
629     AV_CODEC_ID_4GV,
630     AV_CODEC_ID_INTERPLAY_ACM,
631     AV_CODEC_ID_XMA1,
632     AV_CODEC_ID_XMA2,
633     AV_CODEC_ID_DST,
634     AV_CODEC_ID_ATRAC3AL,
635     AV_CODEC_ID_ATRAC3PAL,
636     AV_CODEC_ID_DOLBY_E,
637     AV_CODEC_ID_APTX,
638     AV_CODEC_ID_APTX_HD,
639
640     /* subtitle codecs */
641     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
642     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
643     AV_CODEC_ID_DVB_SUBTITLE,
644     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
645     AV_CODEC_ID_XSUB,
646     AV_CODEC_ID_SSA,
647     AV_CODEC_ID_MOV_TEXT,
648     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
649     AV_CODEC_ID_DVB_TELETEXT,
650     AV_CODEC_ID_SRT,
651
652     AV_CODEC_ID_MICRODVD   = 0x17800,
653     AV_CODEC_ID_EIA_608,
654     AV_CODEC_ID_JACOSUB,
655     AV_CODEC_ID_SAMI,
656     AV_CODEC_ID_REALTEXT,
657     AV_CODEC_ID_STL,
658     AV_CODEC_ID_SUBVIEWER1,
659     AV_CODEC_ID_SUBVIEWER,
660     AV_CODEC_ID_SUBRIP,
661     AV_CODEC_ID_WEBVTT,
662     AV_CODEC_ID_MPL2,
663     AV_CODEC_ID_VPLAYER,
664     AV_CODEC_ID_PJS,
665     AV_CODEC_ID_ASS,
666     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
667
668     /* other specific kind of codecs (generally used for attachments) */
669     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
670     AV_CODEC_ID_TTF = 0x18000,
671
672     AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
673     AV_CODEC_ID_BINTEXT    = 0x18800,
674     AV_CODEC_ID_XBIN,
675     AV_CODEC_ID_IDF,
676     AV_CODEC_ID_OTF,
677     AV_CODEC_ID_SMPTE_KLV,
678     AV_CODEC_ID_DVD_NAV,
679     AV_CODEC_ID_TIMED_ID3,
680     AV_CODEC_ID_BIN_DATA,
681
682
683     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
684
685     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
686                                 * stream (only used by libavformat) */
687     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
688                                 * stream (only used by libavformat) */
689     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
690     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
691 };
692
693 /**
694  * This struct describes the properties of a single codec described by an
695  * AVCodecID.
696  * @see avcodec_descriptor_get()
697  */
698 typedef struct AVCodecDescriptor {
699     enum AVCodecID     id;
700     enum AVMediaType type;
701     /**
702      * Name of the codec described by this descriptor. It is non-empty and
703      * unique for each codec descriptor. It should contain alphanumeric
704      * characters and '_' only.
705      */
706     const char      *name;
707     /**
708      * A more descriptive name for this codec. May be NULL.
709      */
710     const char *long_name;
711     /**
712      * Codec properties, a combination of AV_CODEC_PROP_* flags.
713      */
714     int             props;
715     /**
716      * MIME type(s) associated with the codec.
717      * May be NULL; if not, a NULL-terminated array of MIME types.
718      * The first item is always non-NULL and is the preferred MIME type.
719      */
720     const char *const *mime_types;
721     /**
722      * If non-NULL, an array of profiles recognized for this codec.
723      * Terminated with FF_PROFILE_UNKNOWN.
724      */
725     const struct AVProfile *profiles;
726 } AVCodecDescriptor;
727
728 /**
729  * Codec uses only intra compression.
730  * Video and audio codecs only.
731  */
732 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
733 /**
734  * Codec supports lossy compression. Audio and video codecs only.
735  * @note a codec may support both lossy and lossless
736  * compression modes
737  */
738 #define AV_CODEC_PROP_LOSSY         (1 << 1)
739 /**
740  * Codec supports lossless compression. Audio and video codecs only.
741  */
742 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
743 /**
744  * Codec supports frame reordering. That is, the coded order (the order in which
745  * the encoded packets are output by the encoders / stored / input to the
746  * decoders) may be different from the presentation order of the corresponding
747  * frames.
748  *
749  * For codecs that do not have this property set, PTS and DTS should always be
750  * equal.
751  */
752 #define AV_CODEC_PROP_REORDER       (1 << 3)
753 /**
754  * Subtitle codec is bitmap based
755  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
756  */
757 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
758 /**
759  * Subtitle codec is text based.
760  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
761  */
762 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
763
764 /**
765  * @ingroup lavc_decoding
766  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
767  * This is mainly needed because some optimized bitstream readers read
768  * 32 or 64 bit at once and could read over the end.<br>
769  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
770  * MPEG bitstreams could cause overread and segfault.
771  */
772 #define AV_INPUT_BUFFER_PADDING_SIZE 64
773
774 /**
775  * @ingroup lavc_encoding
776  * minimum encoding buffer size
777  * Used to avoid some checks during header writing.
778  */
779 #define AV_INPUT_BUFFER_MIN_SIZE 16384
780
781 /**
782  * @ingroup lavc_decoding
783  */
784 enum AVDiscard{
785     /* We leave some space between them for extensions (drop some
786      * keyframes for intra-only or drop just some bidir frames). */
787     AVDISCARD_NONE    =-16, ///< discard nothing
788     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
789     AVDISCARD_NONREF  =  8, ///< discard all non reference
790     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
791     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
792     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
793     AVDISCARD_ALL     = 48, ///< discard all
794 };
795
796 enum AVAudioServiceType {
797     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
798     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
799     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
800     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
801     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
802     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
803     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
804     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
805     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
806     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
807 };
808
809 /**
810  * @ingroup lavc_encoding
811  */
812 typedef struct RcOverride{
813     int start_frame;
814     int end_frame;
815     int qscale; // If this is 0 then quality_factor will be used instead.
816     float quality_factor;
817 } RcOverride;
818
819 /* encoding support
820    These flags can be passed in AVCodecContext.flags before initialization.
821    Note: Not everything is supported yet.
822 */
823
824 /**
825  * Allow decoders to produce frames with data planes that are not aligned
826  * to CPU requirements (e.g. due to cropping).
827  */
828 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
829 /**
830  * Use fixed qscale.
831  */
832 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
833 /**
834  * 4 MV per MB allowed / advanced prediction for H.263.
835  */
836 #define AV_CODEC_FLAG_4MV             (1 <<  2)
837 /**
838  * Output even those frames that might be corrupted.
839  */
840 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
841 /**
842  * Use qpel MC.
843  */
844 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
845 /**
846  * Use internal 2pass ratecontrol in first pass mode.
847  */
848 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
849 /**
850  * Use internal 2pass ratecontrol in second pass mode.
851  */
852 #define AV_CODEC_FLAG_PASS2           (1 << 10)
853 /**
854  * loop filter.
855  */
856 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
857 /**
858  * Only decode/encode grayscale.
859  */
860 #define AV_CODEC_FLAG_GRAY            (1 << 13)
861 /**
862  * error[?] variables will be set during encoding.
863  */
864 #define AV_CODEC_FLAG_PSNR            (1 << 15)
865 /**
866  * Input bitstream might be truncated at a random location
867  * instead of only at frame boundaries.
868  */
869 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
870 /**
871  * Use interlaced DCT.
872  */
873 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
874 /**
875  * Force low delay.
876  */
877 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
878 /**
879  * Place global headers in extradata instead of every keyframe.
880  */
881 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
882 /**
883  * Use only bitexact stuff (except (I)DCT).
884  */
885 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
886 /* Fx : Flag for H.263+ extra options */
887 /**
888  * H.263 advanced intra coding / MPEG-4 AC prediction
889  */
890 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
891 /**
892  * interlaced motion estimation
893  */
894 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
895 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
896
897 /**
898  * Allow non spec compliant speedup tricks.
899  */
900 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
901 /**
902  * Skip bitstream encoding.
903  */
904 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
905 /**
906  * Place global headers at every keyframe instead of in extradata.
907  */
908 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
909
910 /**
911  * timecode is in drop frame format. DEPRECATED!!!!
912  */
913 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
914
915 /**
916  * Input bitstream might be truncated at a packet boundaries
917  * instead of only at frame boundaries.
918  */
919 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
920 /**
921  * Discard cropping information from SPS.
922  */
923 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
924
925 /**
926  * Show all frames before the first keyframe
927  */
928 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
929 /**
930  * Export motion vectors through frame side data
931  */
932 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
933 /**
934  * Do not skip samples and export skip information as frame side data
935  */
936 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
937 /**
938  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
939  */
940 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
941
942 /* Unsupported options :
943  *              Syntax Arithmetic coding (SAC)
944  *              Reference Picture Selection
945  *              Independent Segment Decoding */
946 /* /Fx */
947 /* codec capabilities */
948
949 /**
950  * Decoder can use draw_horiz_band callback.
951  */
952 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
953 /**
954  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
955  * If not set, it might not use get_buffer() at all or use operations that
956  * assume the buffer was allocated by avcodec_default_get_buffer.
957  */
958 #define AV_CODEC_CAP_DR1                 (1 <<  1)
959 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
960 /**
961  * Encoder or decoder requires flushing with NULL input at the end in order to
962  * give the complete and correct output.
963  *
964  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
965  *       with NULL data. The user can still send NULL data to the public encode
966  *       or decode function, but libavcodec will not pass it along to the codec
967  *       unless this flag is set.
968  *
969  * Decoders:
970  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
971  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
972  * returns frames.
973  *
974  * Encoders:
975  * The encoder needs to be fed with NULL data at the end of encoding until the
976  * encoder no longer returns data.
977  *
978  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
979  *       flag also means that the encoder must set the pts and duration for
980  *       each output packet. If this flag is not set, the pts and duration will
981  *       be determined by libavcodec from the input frame.
982  */
983 #define AV_CODEC_CAP_DELAY               (1 <<  5)
984 /**
985  * Codec can be fed a final frame with a smaller size.
986  * This can be used to prevent truncation of the last audio samples.
987  */
988 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
989
990 /**
991  * Codec can output multiple frames per AVPacket
992  * Normally demuxers return one frame at a time, demuxers which do not do
993  * are connected to a parser to split what they return into proper frames.
994  * This flag is reserved to the very rare category of codecs which have a
995  * bitstream that cannot be split into frames without timeconsuming
996  * operations like full decoding. Demuxers carrying such bitstreams thus
997  * may return multiple frames in a packet. This has many disadvantages like
998  * prohibiting stream copy in many cases thus it should only be considered
999  * as a last resort.
1000  */
1001 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1002 /**
1003  * Codec is experimental and is thus avoided in favor of non experimental
1004  * encoders
1005  */
1006 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1007 /**
1008  * Codec should fill in channel configuration and samplerate instead of container
1009  */
1010 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1011 /**
1012  * Codec supports frame-level multithreading.
1013  */
1014 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1015 /**
1016  * Codec supports slice-based (or partition-based) multithreading.
1017  */
1018 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1019 /**
1020  * Codec supports changed parameters at any point.
1021  */
1022 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1023 /**
1024  * Codec supports avctx->thread_count == 0 (auto).
1025  */
1026 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1027 /**
1028  * Audio encoder supports receiving a different number of samples in each call.
1029  */
1030 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1031 /**
1032  * Decoder is not a preferred choice for probing.
1033  * This indicates that the decoder is not a good choice for probing.
1034  * It could for example be an expensive to spin up hardware decoder,
1035  * or it could simply not provide a lot of useful information about
1036  * the stream.
1037  * A decoder marked with this flag should only be used as last resort
1038  * choice for probing.
1039  */
1040 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
1041 /**
1042  * Codec is intra only.
1043  */
1044 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1045 /**
1046  * Codec is lossless.
1047  */
1048 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1049
1050 /**
1051  * Codec is backed by a hardware implementation. Typically used to
1052  * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1053  * avcodec_get_hw_config() instead.
1054  */
1055 #define AV_CODEC_CAP_HARDWARE            (1 << 18)
1056
1057 /**
1058  * Codec is potentially backed by a hardware implementation, but not
1059  * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1060  * implementation provides some sort of internal fallback.
1061  */
1062 #define AV_CODEC_CAP_HYBRID              (1 << 19)
1063
1064 /**
1065  * Pan Scan area.
1066  * This specifies the area which should be displayed.
1067  * Note there may be multiple such areas for one frame.
1068  */
1069 typedef struct AVPanScan {
1070     /**
1071      * id
1072      * - encoding: Set by user.
1073      * - decoding: Set by libavcodec.
1074      */
1075     int id;
1076
1077     /**
1078      * width and height in 1/16 pel
1079      * - encoding: Set by user.
1080      * - decoding: Set by libavcodec.
1081      */
1082     int width;
1083     int height;
1084
1085     /**
1086      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1087      * - encoding: Set by user.
1088      * - decoding: Set by libavcodec.
1089      */
1090     int16_t position[3][2];
1091 } AVPanScan;
1092
1093 /**
1094  * This structure describes the bitrate properties of an encoded bitstream. It
1095  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1096  * parameters for H.264/HEVC.
1097  */
1098 typedef struct AVCPBProperties {
1099     /**
1100      * Maximum bitrate of the stream, in bits per second.
1101      * Zero if unknown or unspecified.
1102      */
1103     int max_bitrate;
1104     /**
1105      * Minimum bitrate of the stream, in bits per second.
1106      * Zero if unknown or unspecified.
1107      */
1108     int min_bitrate;
1109     /**
1110      * Average bitrate of the stream, in bits per second.
1111      * Zero if unknown or unspecified.
1112      */
1113     int avg_bitrate;
1114
1115     /**
1116      * The size of the buffer to which the ratecontrol is applied, in bits.
1117      * Zero if unknown or unspecified.
1118      */
1119     int buffer_size;
1120
1121     /**
1122      * The delay between the time the packet this structure is associated with
1123      * is received and the time when it should be decoded, in periods of a 27MHz
1124      * clock.
1125      *
1126      * UINT64_MAX when unknown or unspecified.
1127      */
1128     uint64_t vbv_delay;
1129 } AVCPBProperties;
1130
1131 /**
1132  * The decoder will keep a reference to the frame and may reuse it later.
1133  */
1134 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1135
1136 /**
1137  * @defgroup lavc_packet AVPacket
1138  *
1139  * Types and functions for working with AVPacket.
1140  * @{
1141  */
1142 enum AVPacketSideDataType {
1143     /**
1144      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1145      * bytes worth of palette. This side data signals that a new palette is
1146      * present.
1147      */
1148     AV_PKT_DATA_PALETTE,
1149
1150     /**
1151      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1152      * that the extradata buffer was changed and the receiving side should
1153      * act upon it appropriately. The new extradata is embedded in the side
1154      * data buffer and should be immediately used for processing the current
1155      * frame or packet.
1156      */
1157     AV_PKT_DATA_NEW_EXTRADATA,
1158
1159     /**
1160      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1161      * @code
1162      * u32le param_flags
1163      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1164      *     s32le channel_count
1165      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1166      *     u64le channel_layout
1167      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1168      *     s32le sample_rate
1169      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1170      *     s32le width
1171      *     s32le height
1172      * @endcode
1173      */
1174     AV_PKT_DATA_PARAM_CHANGE,
1175
1176     /**
1177      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1178      * structures with info about macroblocks relevant to splitting the
1179      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1180      * That is, it does not necessarily contain info about all macroblocks,
1181      * as long as the distance between macroblocks in the info is smaller
1182      * than the target payload size.
1183      * Each MB info structure is 12 bytes, and is laid out as follows:
1184      * @code
1185      * u32le bit offset from the start of the packet
1186      * u8    current quantizer at the start of the macroblock
1187      * u8    GOB number
1188      * u16le macroblock address within the GOB
1189      * u8    horizontal MV predictor
1190      * u8    vertical MV predictor
1191      * u8    horizontal MV predictor for block number 3
1192      * u8    vertical MV predictor for block number 3
1193      * @endcode
1194      */
1195     AV_PKT_DATA_H263_MB_INFO,
1196
1197     /**
1198      * This side data should be associated with an audio stream and contains
1199      * ReplayGain information in form of the AVReplayGain struct.
1200      */
1201     AV_PKT_DATA_REPLAYGAIN,
1202
1203     /**
1204      * This side data contains a 3x3 transformation matrix describing an affine
1205      * transformation that needs to be applied to the decoded video frames for
1206      * correct presentation.
1207      *
1208      * See libavutil/display.h for a detailed description of the data.
1209      */
1210     AV_PKT_DATA_DISPLAYMATRIX,
1211
1212     /**
1213      * This side data should be associated with a video stream and contains
1214      * Stereoscopic 3D information in form of the AVStereo3D struct.
1215      */
1216     AV_PKT_DATA_STEREO3D,
1217
1218     /**
1219      * This side data should be associated with an audio stream and corresponds
1220      * to enum AVAudioServiceType.
1221      */
1222     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1223
1224     /**
1225      * This side data contains quality related information from the encoder.
1226      * @code
1227      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1228      * u8    picture type
1229      * u8    error count
1230      * u16   reserved
1231      * u64le[error count] sum of squared differences between encoder in and output
1232      * @endcode
1233      */
1234     AV_PKT_DATA_QUALITY_STATS,
1235
1236     /**
1237      * This side data contains an integer value representing the stream index
1238      * of a "fallback" track.  A fallback track indicates an alternate
1239      * track to use when the current track can not be decoded for some reason.
1240      * e.g. no decoder available for codec.
1241      */
1242     AV_PKT_DATA_FALLBACK_TRACK,
1243
1244     /**
1245      * This side data corresponds to the AVCPBProperties struct.
1246      */
1247     AV_PKT_DATA_CPB_PROPERTIES,
1248
1249     /**
1250      * Recommmends skipping the specified number of samples
1251      * @code
1252      * u32le number of samples to skip from start of this packet
1253      * u32le number of samples to skip from end of this packet
1254      * u8    reason for start skip
1255      * u8    reason for end   skip (0=padding silence, 1=convergence)
1256      * @endcode
1257      */
1258     AV_PKT_DATA_SKIP_SAMPLES,
1259
1260     /**
1261      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1262      * the packet may contain "dual mono" audio specific to Japanese DTV
1263      * and if it is true, recommends only the selected channel to be used.
1264      * @code
1265      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1266      * @endcode
1267      */
1268     AV_PKT_DATA_JP_DUALMONO,
1269
1270     /**
1271      * A list of zero terminated key/value strings. There is no end marker for
1272      * the list, so it is required to rely on the side data size to stop.
1273      */
1274     AV_PKT_DATA_STRINGS_METADATA,
1275
1276     /**
1277      * Subtitle event position
1278      * @code
1279      * u32le x1
1280      * u32le y1
1281      * u32le x2
1282      * u32le y2
1283      * @endcode
1284      */
1285     AV_PKT_DATA_SUBTITLE_POSITION,
1286
1287     /**
1288      * Data found in BlockAdditional element of matroska container. There is
1289      * no end marker for the data, so it is required to rely on the side data
1290      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1291      * by data.
1292      */
1293     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1294
1295     /**
1296      * The optional first identifier line of a WebVTT cue.
1297      */
1298     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1299
1300     /**
1301      * The optional settings (rendering instructions) that immediately
1302      * follow the timestamp specifier of a WebVTT cue.
1303      */
1304     AV_PKT_DATA_WEBVTT_SETTINGS,
1305
1306     /**
1307      * A list of zero terminated key/value strings. There is no end marker for
1308      * the list, so it is required to rely on the side data size to stop. This
1309      * side data includes updated metadata which appeared in the stream.
1310      */
1311     AV_PKT_DATA_METADATA_UPDATE,
1312
1313     /**
1314      * MPEGTS stream ID, this is required to pass the stream ID
1315      * information from the demuxer to the corresponding muxer.
1316      */
1317     AV_PKT_DATA_MPEGTS_STREAM_ID,
1318
1319     /**
1320      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1321      * should be associated with a video stream and contains data in the form
1322      * of the AVMasteringDisplayMetadata struct.
1323      */
1324     AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1325
1326     /**
1327      * This side data should be associated with a video stream and corresponds
1328      * to the AVSphericalMapping structure.
1329      */
1330     AV_PKT_DATA_SPHERICAL,
1331
1332     /**
1333      * Content light level (based on CTA-861.3). This metadata should be
1334      * associated with a video stream and contains data in the form of the
1335      * AVContentLightMetadata struct.
1336      */
1337     AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1338
1339     /**
1340      * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1341      * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1342      * The number of bytes of CC data is AVPacketSideData.size.
1343      */
1344     AV_PKT_DATA_A53_CC,
1345
1346     /**
1347      * The number of side data types.
1348      * This is not part of the public API/ABI in the sense that it may
1349      * change when new side data types are added.
1350      * This must stay the last enum value.
1351      * If its value becomes huge, some code using it
1352      * needs to be updated as it assumes it to be smaller than other limits.
1353      */
1354     AV_PKT_DATA_NB
1355 };
1356
1357 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1358
1359 typedef struct AVPacketSideData {
1360     uint8_t *data;
1361     int      size;
1362     enum AVPacketSideDataType type;
1363 } AVPacketSideData;
1364
1365 /**
1366  * This structure stores compressed data. It is typically exported by demuxers
1367  * and then passed as input to decoders, or received as output from encoders and
1368  * then passed to muxers.
1369  *
1370  * For video, it should typically contain one compressed frame. For audio it may
1371  * contain several compressed frames. Encoders are allowed to output empty
1372  * packets, with no compressed data, containing only side data
1373  * (e.g. to update some stream parameters at the end of encoding).
1374  *
1375  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1376  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1377  * without libavcodec and libavformat major bump.
1378  *
1379  * The semantics of data ownership depends on the buf field.
1380  * If it is set, the packet data is dynamically allocated and is
1381  * valid indefinitely until a call to av_packet_unref() reduces the
1382  * reference count to 0.
1383  *
1384  * If the buf field is not set av_packet_ref() would make a copy instead
1385  * of increasing the reference count.
1386  *
1387  * The side data is always allocated with av_malloc(), copied by
1388  * av_packet_ref() and freed by av_packet_unref().
1389  *
1390  * @see av_packet_ref
1391  * @see av_packet_unref
1392  */
1393 typedef struct AVPacket {
1394     /**
1395      * A reference to the reference-counted buffer where the packet data is
1396      * stored.
1397      * May be NULL, then the packet data is not reference-counted.
1398      */
1399     AVBufferRef *buf;
1400     /**
1401      * Presentation timestamp in AVStream->time_base units; the time at which
1402      * the decompressed packet will be presented to the user.
1403      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1404      * pts MUST be larger or equal to dts as presentation cannot happen before
1405      * decompression, unless one wants to view hex dumps. Some formats misuse
1406      * the terms dts and pts/cts to mean something different. Such timestamps
1407      * must be converted to true pts/dts before they are stored in AVPacket.
1408      */
1409     int64_t pts;
1410     /**
1411      * Decompression timestamp in AVStream->time_base units; the time at which
1412      * the packet is decompressed.
1413      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1414      */
1415     int64_t dts;
1416     uint8_t *data;
1417     int   size;
1418     int   stream_index;
1419     /**
1420      * A combination of AV_PKT_FLAG values
1421      */
1422     int   flags;
1423     /**
1424      * Additional packet data that can be provided by the container.
1425      * Packet can contain several types of side information.
1426      */
1427     AVPacketSideData *side_data;
1428     int side_data_elems;
1429
1430     /**
1431      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1432      * Equals next_pts - this_pts in presentation order.
1433      */
1434     int64_t duration;
1435
1436     int64_t pos;                            ///< byte position in stream, -1 if unknown
1437
1438 #if FF_API_CONVERGENCE_DURATION
1439     /**
1440      * @deprecated Same as the duration field, but as int64_t. This was required
1441      * for Matroska subtitles, whose duration values could overflow when the
1442      * duration field was still an int.
1443      */
1444     attribute_deprecated
1445     int64_t convergence_duration;
1446 #endif
1447 } AVPacket;
1448 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1449 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1450 /**
1451  * Flag is used to discard packets which are required to maintain valid
1452  * decoder state but are not required for output and should be dropped
1453  * after decoding.
1454  **/
1455 #define AV_PKT_FLAG_DISCARD   0x0004
1456 /**
1457  * The packet comes from a trusted source.
1458  *
1459  * Otherwise-unsafe constructs such as arbitrary pointers to data
1460  * outside the packet may be followed.
1461  */
1462 #define AV_PKT_FLAG_TRUSTED   0x0008
1463 /**
1464  * Flag is used to indicate packets that contain frames that can
1465  * be discarded by the decoder.  I.e. Non-reference frames.
1466  */
1467 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1468
1469
1470 enum AVSideDataParamChangeFlags {
1471     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1472     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1473     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1474     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1475 };
1476 /**
1477  * @}
1478  */
1479
1480 struct AVCodecInternal;
1481
1482 enum AVFieldOrder {
1483     AV_FIELD_UNKNOWN,
1484     AV_FIELD_PROGRESSIVE,
1485     AV_FIELD_TT,          //< Top coded_first, top displayed first
1486     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1487     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1488     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1489 };
1490
1491 /**
1492  * main external API structure.
1493  * New fields can be added to the end with minor version bumps.
1494  * Removal, reordering and changes to existing fields require a major
1495  * version bump.
1496  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1497  * applications.
1498  * The name string for AVOptions options matches the associated command line
1499  * parameter name and can be found in libavcodec/options_table.h
1500  * The AVOption/command line parameter names differ in some cases from the C
1501  * structure field names for historic reasons or brevity.
1502  * sizeof(AVCodecContext) must not be used outside libav*.
1503  */
1504 typedef struct AVCodecContext {
1505     /**
1506      * information on struct for av_log
1507      * - set by avcodec_alloc_context3
1508      */
1509     const AVClass *av_class;
1510     int log_level_offset;
1511
1512     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1513     const struct AVCodec  *codec;
1514     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1515
1516     /**
1517      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1518      * This is used to work around some encoder bugs.
1519      * A demuxer should set this to what is stored in the field used to identify the codec.
1520      * If there are multiple such fields in a container then the demuxer should choose the one
1521      * which maximizes the information about the used codec.
1522      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1523      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1524      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1525      * first.
1526      * - encoding: Set by user, if not then the default based on codec_id will be used.
1527      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1528      */
1529     unsigned int codec_tag;
1530
1531     void *priv_data;
1532
1533     /**
1534      * Private context used for internal data.
1535      *
1536      * Unlike priv_data, this is not codec-specific. It is used in general
1537      * libavcodec functions.
1538      */
1539     struct AVCodecInternal *internal;
1540
1541     /**
1542      * Private data of the user, can be used to carry app specific stuff.
1543      * - encoding: Set by user.
1544      * - decoding: Set by user.
1545      */
1546     void *opaque;
1547
1548     /**
1549      * the average bitrate
1550      * - encoding: Set by user; unused for constant quantizer encoding.
1551      * - decoding: Set by user, may be overwritten by libavcodec
1552      *             if this info is available in the stream
1553      */
1554     int64_t bit_rate;
1555
1556     /**
1557      * number of bits the bitstream is allowed to diverge from the reference.
1558      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1559      * - encoding: Set by user; unused for constant quantizer encoding.
1560      * - decoding: unused
1561      */
1562     int bit_rate_tolerance;
1563
1564     /**
1565      * Global quality for codecs which cannot change it per frame.
1566      * This should be proportional to MPEG-1/2/4 qscale.
1567      * - encoding: Set by user.
1568      * - decoding: unused
1569      */
1570     int global_quality;
1571
1572     /**
1573      * - encoding: Set by user.
1574      * - decoding: unused
1575      */
1576     int compression_level;
1577 #define FF_COMPRESSION_DEFAULT -1
1578
1579     /**
1580      * AV_CODEC_FLAG_*.
1581      * - encoding: Set by user.
1582      * - decoding: Set by user.
1583      */
1584     int flags;
1585
1586     /**
1587      * AV_CODEC_FLAG2_*
1588      * - encoding: Set by user.
1589      * - decoding: Set by user.
1590      */
1591     int flags2;
1592
1593     /**
1594      * some codecs need / can use extradata like Huffman tables.
1595      * MJPEG: Huffman tables
1596      * rv10: additional flags
1597      * MPEG-4: global headers (they can be in the bitstream or here)
1598      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1599      * than extradata_size to avoid problems if it is read with the bitstream reader.
1600      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1601      * - encoding: Set/allocated/freed by libavcodec.
1602      * - decoding: Set/allocated/freed by user.
1603      */
1604     uint8_t *extradata;
1605     int extradata_size;
1606
1607     /**
1608      * This is the fundamental unit of time (in seconds) in terms
1609      * of which frame timestamps are represented. For fixed-fps content,
1610      * timebase should be 1/framerate and timestamp increments should be
1611      * identically 1.
1612      * This often, but not always is the inverse of the frame rate or field rate
1613      * for video. 1/time_base is not the average frame rate if the frame rate is not
1614      * constant.
1615      *
1616      * Like containers, elementary streams also can store timestamps, 1/time_base
1617      * is the unit in which these timestamps are specified.
1618      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1619      * vop_time_increment_resolution and fixed_vop_rate
1620      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1621      *
1622      * - encoding: MUST be set by user.
1623      * - decoding: the use of this field for decoding is deprecated.
1624      *             Use framerate instead.
1625      */
1626     AVRational time_base;
1627
1628     /**
1629      * For some codecs, the time base is closer to the field rate than the frame rate.
1630      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1631      * if no telecine is used ...
1632      *
1633      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1634      */
1635     int ticks_per_frame;
1636
1637     /**
1638      * Codec delay.
1639      *
1640      * Encoding: Number of frames delay there will be from the encoder input to
1641      *           the decoder output. (we assume the decoder matches the spec)
1642      * Decoding: Number of frames delay in addition to what a standard decoder
1643      *           as specified in the spec would produce.
1644      *
1645      * Video:
1646      *   Number of frames the decoded output will be delayed relative to the
1647      *   encoded input.
1648      *
1649      * Audio:
1650      *   For encoding, this field is unused (see initial_padding).
1651      *
1652      *   For decoding, this is the number of samples the decoder needs to
1653      *   output before the decoder's output is valid. When seeking, you should
1654      *   start decoding this many samples prior to your desired seek point.
1655      *
1656      * - encoding: Set by libavcodec.
1657      * - decoding: Set by libavcodec.
1658      */
1659     int delay;
1660
1661
1662     /* video only */
1663     /**
1664      * picture width / height.
1665      *
1666      * @note Those fields may not match the values of the last
1667      * AVFrame output by avcodec_decode_video2 due frame
1668      * reordering.
1669      *
1670      * - encoding: MUST be set by user.
1671      * - decoding: May be set by the user before opening the decoder if known e.g.
1672      *             from the container. Some decoders will require the dimensions
1673      *             to be set by the caller. During decoding, the decoder may
1674      *             overwrite those values as required while parsing the data.
1675      */
1676     int width, height;
1677
1678     /**
1679      * Bitstream width / height, may be different from width/height e.g. when
1680      * the decoded frame is cropped before being output or lowres is enabled.
1681      *
1682      * @note Those field may not match the value of the last
1683      * AVFrame output by avcodec_receive_frame() due frame
1684      * reordering.
1685      *
1686      * - encoding: unused
1687      * - decoding: May be set by the user before opening the decoder if known
1688      *             e.g. from the container. During decoding, the decoder may
1689      *             overwrite those values as required while parsing the data.
1690      */
1691     int coded_width, coded_height;
1692
1693     /**
1694      * the number of pictures in a group of pictures, or 0 for intra_only
1695      * - encoding: Set by user.
1696      * - decoding: unused
1697      */
1698     int gop_size;
1699
1700     /**
1701      * Pixel format, see AV_PIX_FMT_xxx.
1702      * May be set by the demuxer if known from headers.
1703      * May be overridden by the decoder if it knows better.
1704      *
1705      * @note This field may not match the value of the last
1706      * AVFrame output by avcodec_receive_frame() due frame
1707      * reordering.
1708      *
1709      * - encoding: Set by user.
1710      * - decoding: Set by user if known, overridden by libavcodec while
1711      *             parsing the data.
1712      */
1713     enum AVPixelFormat pix_fmt;
1714
1715     /**
1716      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1717      * decoder to draw a horizontal band. It improves cache usage. Not
1718      * all codecs can do that. You must check the codec capabilities
1719      * beforehand.
1720      * When multithreading is used, it may be called from multiple threads
1721      * at the same time; threads might draw different parts of the same AVFrame,
1722      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1723      * in order.
1724      * The function is also used by hardware acceleration APIs.
1725      * It is called at least once during frame decoding to pass
1726      * the data needed for hardware render.
1727      * In that mode instead of pixel data, AVFrame points to
1728      * a structure specific to the acceleration API. The application
1729      * reads the structure and can change some fields to indicate progress
1730      * or mark state.
1731      * - encoding: unused
1732      * - decoding: Set by user.
1733      * @param height the height of the slice
1734      * @param y the y position of the slice
1735      * @param type 1->top field, 2->bottom field, 3->frame
1736      * @param offset offset into the AVFrame.data from which the slice should be read
1737      */
1738     void (*draw_horiz_band)(struct AVCodecContext *s,
1739                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1740                             int y, int type, int height);
1741
1742     /**
1743      * callback to negotiate the pixelFormat
1744      * @param fmt is the list of formats which are supported by the codec,
1745      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1746      * The first is always the native one.
1747      * @note The callback may be called again immediately if initialization for
1748      * the selected (hardware-accelerated) pixel format failed.
1749      * @warning Behavior is undefined if the callback returns a value not
1750      * in the fmt list of formats.
1751      * @return the chosen format
1752      * - encoding: unused
1753      * - decoding: Set by user, if not set the native format will be chosen.
1754      */
1755     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1756
1757     /**
1758      * maximum number of B-frames between non-B-frames
1759      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1760      * - encoding: Set by user.
1761      * - decoding: unused
1762      */
1763     int max_b_frames;
1764
1765     /**
1766      * qscale factor between IP and B-frames
1767      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1768      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1769      * - encoding: Set by user.
1770      * - decoding: unused
1771      */
1772     float b_quant_factor;
1773
1774 #if FF_API_PRIVATE_OPT
1775     /** @deprecated use encoder private options instead */
1776     attribute_deprecated
1777     int b_frame_strategy;
1778 #endif
1779
1780     /**
1781      * qscale offset between IP and B-frames
1782      * - encoding: Set by user.
1783      * - decoding: unused
1784      */
1785     float b_quant_offset;
1786
1787     /**
1788      * Size of the frame reordering buffer in the decoder.
1789      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1790      * - encoding: Set by libavcodec.
1791      * - decoding: Set by libavcodec.
1792      */
1793     int has_b_frames;
1794
1795 #if FF_API_PRIVATE_OPT
1796     /** @deprecated use encoder private options instead */
1797     attribute_deprecated
1798     int mpeg_quant;
1799 #endif
1800
1801     /**
1802      * qscale factor between P- and I-frames
1803      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1804      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1805      * - encoding: Set by user.
1806      * - decoding: unused
1807      */
1808     float i_quant_factor;
1809
1810     /**
1811      * qscale offset between P and I-frames
1812      * - encoding: Set by user.
1813      * - decoding: unused
1814      */
1815     float i_quant_offset;
1816
1817     /**
1818      * luminance masking (0-> disabled)
1819      * - encoding: Set by user.
1820      * - decoding: unused
1821      */
1822     float lumi_masking;
1823
1824     /**
1825      * temporary complexity masking (0-> disabled)
1826      * - encoding: Set by user.
1827      * - decoding: unused
1828      */
1829     float temporal_cplx_masking;
1830
1831     /**
1832      * spatial complexity masking (0-> disabled)
1833      * - encoding: Set by user.
1834      * - decoding: unused
1835      */
1836     float spatial_cplx_masking;
1837
1838     /**
1839      * p block masking (0-> disabled)
1840      * - encoding: Set by user.
1841      * - decoding: unused
1842      */
1843     float p_masking;
1844
1845     /**
1846      * darkness masking (0-> disabled)
1847      * - encoding: Set by user.
1848      * - decoding: unused
1849      */
1850     float dark_masking;
1851
1852     /**
1853      * slice count
1854      * - encoding: Set by libavcodec.
1855      * - decoding: Set by user (or 0).
1856      */
1857     int slice_count;
1858
1859 #if FF_API_PRIVATE_OPT
1860     /** @deprecated use encoder private options instead */
1861     attribute_deprecated
1862      int prediction_method;
1863 #define FF_PRED_LEFT   0
1864 #define FF_PRED_PLANE  1
1865 #define FF_PRED_MEDIAN 2
1866 #endif
1867
1868     /**
1869      * slice offsets in the frame in bytes
1870      * - encoding: Set/allocated by libavcodec.
1871      * - decoding: Set/allocated by user (or NULL).
1872      */
1873     int *slice_offset;
1874
1875     /**
1876      * sample aspect ratio (0 if unknown)
1877      * That is the width of a pixel divided by the height of the pixel.
1878      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1879      * - encoding: Set by user.
1880      * - decoding: Set by libavcodec.
1881      */
1882     AVRational sample_aspect_ratio;
1883
1884     /**
1885      * motion estimation comparison function
1886      * - encoding: Set by user.
1887      * - decoding: unused
1888      */
1889     int me_cmp;
1890     /**
1891      * subpixel motion estimation comparison function
1892      * - encoding: Set by user.
1893      * - decoding: unused
1894      */
1895     int me_sub_cmp;
1896     /**
1897      * macroblock comparison function (not supported yet)
1898      * - encoding: Set by user.
1899      * - decoding: unused
1900      */
1901     int mb_cmp;
1902     /**
1903      * interlaced DCT comparison function
1904      * - encoding: Set by user.
1905      * - decoding: unused
1906      */
1907     int ildct_cmp;
1908 #define FF_CMP_SAD          0
1909 #define FF_CMP_SSE          1
1910 #define FF_CMP_SATD         2
1911 #define FF_CMP_DCT          3
1912 #define FF_CMP_PSNR         4
1913 #define FF_CMP_BIT          5
1914 #define FF_CMP_RD           6
1915 #define FF_CMP_ZERO         7
1916 #define FF_CMP_VSAD         8
1917 #define FF_CMP_VSSE         9
1918 #define FF_CMP_NSSE         10
1919 #define FF_CMP_W53          11
1920 #define FF_CMP_W97          12
1921 #define FF_CMP_DCTMAX       13
1922 #define FF_CMP_DCT264       14
1923 #define FF_CMP_MEDIAN_SAD   15
1924 #define FF_CMP_CHROMA       256
1925
1926     /**
1927      * ME diamond size & shape
1928      * - encoding: Set by user.
1929      * - decoding: unused
1930      */
1931     int dia_size;
1932
1933     /**
1934      * amount of previous MV predictors (2a+1 x 2a+1 square)
1935      * - encoding: Set by user.
1936      * - decoding: unused
1937      */
1938     int last_predictor_count;
1939
1940 #if FF_API_PRIVATE_OPT
1941     /** @deprecated use encoder private options instead */
1942     attribute_deprecated
1943     int pre_me;
1944 #endif
1945
1946     /**
1947      * motion estimation prepass comparison function
1948      * - encoding: Set by user.
1949      * - decoding: unused
1950      */
1951     int me_pre_cmp;
1952
1953     /**
1954      * ME prepass diamond size & shape
1955      * - encoding: Set by user.
1956      * - decoding: unused
1957      */
1958     int pre_dia_size;
1959
1960     /**
1961      * subpel ME quality
1962      * - encoding: Set by user.
1963      * - decoding: unused
1964      */
1965     int me_subpel_quality;
1966
1967     /**
1968      * maximum motion estimation search range in subpel units
1969      * If 0 then no limit.
1970      *
1971      * - encoding: Set by user.
1972      * - decoding: unused
1973      */
1974     int me_range;
1975
1976     /**
1977      * slice flags
1978      * - encoding: unused
1979      * - decoding: Set by user.
1980      */
1981     int slice_flags;
1982 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1983 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1984 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1985
1986     /**
1987      * macroblock decision mode
1988      * - encoding: Set by user.
1989      * - decoding: unused
1990      */
1991     int mb_decision;
1992 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1993 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1994 #define FF_MB_DECISION_RD     2        ///< rate distortion
1995
1996     /**
1997      * custom intra quantization matrix
1998      * - encoding: Set by user, can be NULL.
1999      * - decoding: Set by libavcodec.
2000      */
2001     uint16_t *intra_matrix;
2002
2003     /**
2004      * custom inter quantization matrix
2005      * - encoding: Set by user, can be NULL.
2006      * - decoding: Set by libavcodec.
2007      */
2008     uint16_t *inter_matrix;
2009
2010 #if FF_API_PRIVATE_OPT
2011     /** @deprecated use encoder private options instead */
2012     attribute_deprecated
2013     int scenechange_threshold;
2014
2015     /** @deprecated use encoder private options instead */
2016     attribute_deprecated
2017     int noise_reduction;
2018 #endif
2019
2020     /**
2021      * precision of the intra DC coefficient - 8
2022      * - encoding: Set by user.
2023      * - decoding: Set by libavcodec
2024      */
2025     int intra_dc_precision;
2026
2027     /**
2028      * Number of macroblock rows at the top which are skipped.
2029      * - encoding: unused
2030      * - decoding: Set by user.
2031      */
2032     int skip_top;
2033
2034     /**
2035      * Number of macroblock rows at the bottom which are skipped.
2036      * - encoding: unused
2037      * - decoding: Set by user.
2038      */
2039     int skip_bottom;
2040
2041     /**
2042      * minimum MB Lagrange multiplier
2043      * - encoding: Set by user.
2044      * - decoding: unused
2045      */
2046     int mb_lmin;
2047
2048     /**
2049      * maximum MB Lagrange multiplier
2050      * - encoding: Set by user.
2051      * - decoding: unused
2052      */
2053     int mb_lmax;
2054
2055 #if FF_API_PRIVATE_OPT
2056     /**
2057      * @deprecated use encoder private options instead
2058      */
2059     attribute_deprecated
2060     int me_penalty_compensation;
2061 #endif
2062
2063     /**
2064      * - encoding: Set by user.
2065      * - decoding: unused
2066      */
2067     int bidir_refine;
2068
2069 #if FF_API_PRIVATE_OPT
2070     /** @deprecated use encoder private options instead */
2071     attribute_deprecated
2072     int brd_scale;
2073 #endif
2074
2075     /**
2076      * minimum GOP size
2077      * - encoding: Set by user.
2078      * - decoding: unused
2079      */
2080     int keyint_min;
2081
2082     /**
2083      * number of reference frames
2084      * - encoding: Set by user.
2085      * - decoding: Set by lavc.
2086      */
2087     int refs;
2088
2089 #if FF_API_PRIVATE_OPT
2090     /** @deprecated use encoder private options instead */
2091     attribute_deprecated
2092     int chromaoffset;
2093 #endif
2094
2095     /**
2096      * Note: Value depends upon the compare function used for fullpel ME.
2097      * - encoding: Set by user.
2098      * - decoding: unused
2099      */
2100     int mv0_threshold;
2101
2102 #if FF_API_PRIVATE_OPT
2103     /** @deprecated use encoder private options instead */
2104     attribute_deprecated
2105     int b_sensitivity;
2106 #endif
2107
2108     /**
2109      * Chromaticity coordinates of the source primaries.
2110      * - encoding: Set by user
2111      * - decoding: Set by libavcodec
2112      */
2113     enum AVColorPrimaries color_primaries;
2114
2115     /**
2116      * Color Transfer Characteristic.
2117      * - encoding: Set by user
2118      * - decoding: Set by libavcodec
2119      */
2120     enum AVColorTransferCharacteristic color_trc;
2121
2122     /**
2123      * YUV colorspace type.
2124      * - encoding: Set by user
2125      * - decoding: Set by libavcodec
2126      */
2127     enum AVColorSpace colorspace;
2128
2129     /**
2130      * MPEG vs JPEG YUV range.
2131      * - encoding: Set by user
2132      * - decoding: Set by libavcodec
2133      */
2134     enum AVColorRange color_range;
2135
2136     /**
2137      * This defines the location of chroma samples.
2138      * - encoding: Set by user
2139      * - decoding: Set by libavcodec
2140      */
2141     enum AVChromaLocation chroma_sample_location;
2142
2143     /**
2144      * Number of slices.
2145      * Indicates number of picture subdivisions. Used for parallelized
2146      * decoding.
2147      * - encoding: Set by user
2148      * - decoding: unused
2149      */
2150     int slices;
2151
2152     /** Field order
2153      * - encoding: set by libavcodec
2154      * - decoding: Set by user.
2155      */
2156     enum AVFieldOrder field_order;
2157
2158     /* audio only */
2159     int sample_rate; ///< samples per second
2160     int channels;    ///< number of audio channels
2161
2162     /**
2163      * audio sample format
2164      * - encoding: Set by user.
2165      * - decoding: Set by libavcodec.
2166      */
2167     enum AVSampleFormat sample_fmt;  ///< sample format
2168
2169     /* The following data should not be initialized. */
2170     /**
2171      * Number of samples per channel in an audio frame.
2172      *
2173      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2174      *   except the last must contain exactly frame_size samples per channel.
2175      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2176      *   frame size is not restricted.
2177      * - decoding: may be set by some decoders to indicate constant frame size
2178      */
2179     int frame_size;
2180
2181     /**
2182      * Frame counter, set by libavcodec.
2183      *
2184      * - decoding: total number of frames returned from the decoder so far.
2185      * - encoding: total number of frames passed to the encoder so far.
2186      *
2187      *   @note the counter is not incremented if encoding/decoding resulted in
2188      *   an error.
2189      */
2190     int frame_number;
2191
2192     /**
2193      * number of bytes per packet if constant and known or 0
2194      * Used by some WAV based audio codecs.
2195      */
2196     int block_align;
2197
2198     /**
2199      * Audio cutoff bandwidth (0 means "automatic")
2200      * - encoding: Set by user.
2201      * - decoding: unused
2202      */
2203     int cutoff;
2204
2205     /**
2206      * Audio channel layout.
2207      * - encoding: set by user.
2208      * - decoding: set by user, may be overwritten by libavcodec.
2209      */
2210     uint64_t channel_layout;
2211
2212     /**
2213      * Request decoder to use this channel layout if it can (0 for default)
2214      * - encoding: unused
2215      * - decoding: Set by user.
2216      */
2217     uint64_t request_channel_layout;
2218
2219     /**
2220      * Type of service that the audio stream conveys.
2221      * - encoding: Set by user.
2222      * - decoding: Set by libavcodec.
2223      */
2224     enum AVAudioServiceType audio_service_type;
2225
2226     /**
2227      * desired sample format
2228      * - encoding: Not used.
2229      * - decoding: Set by user.
2230      * Decoder will decode to this format if it can.
2231      */
2232     enum AVSampleFormat request_sample_fmt;
2233
2234     /**
2235      * This callback is called at the beginning of each frame to get data
2236      * buffer(s) for it. There may be one contiguous buffer for all the data or
2237      * there may be a buffer per each data plane or anything in between. What
2238      * this means is, you may set however many entries in buf[] you feel necessary.
2239      * Each buffer must be reference-counted using the AVBuffer API (see description
2240      * of buf[] below).
2241      *
2242      * The following fields will be set in the frame before this callback is
2243      * called:
2244      * - format
2245      * - width, height (video only)
2246      * - sample_rate, channel_layout, nb_samples (audio only)
2247      * Their values may differ from the corresponding values in
2248      * AVCodecContext. This callback must use the frame values, not the codec
2249      * context values, to calculate the required buffer size.
2250      *
2251      * This callback must fill the following fields in the frame:
2252      * - data[]
2253      * - linesize[]
2254      * - extended_data:
2255      *   * if the data is planar audio with more than 8 channels, then this
2256      *     callback must allocate and fill extended_data to contain all pointers
2257      *     to all data planes. data[] must hold as many pointers as it can.
2258      *     extended_data must be allocated with av_malloc() and will be freed in
2259      *     av_frame_unref().
2260      *   * otherwise extended_data must point to data
2261      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2262      *   the frame's data and extended_data pointers must be contained in these. That
2263      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2264      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2265      *   and av_buffer_ref().
2266      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2267      *   this callback and filled with the extra buffers if there are more
2268      *   buffers than buf[] can hold. extended_buf will be freed in
2269      *   av_frame_unref().
2270      *
2271      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2272      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2273      * some other means.
2274      *
2275      * Each data plane must be aligned to the maximum required by the target
2276      * CPU.
2277      *
2278      * @see avcodec_default_get_buffer2()
2279      *
2280      * Video:
2281      *
2282      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2283      * (read and/or written to if it is writable) later by libavcodec.
2284      *
2285      * avcodec_align_dimensions2() should be used to find the required width and
2286      * height, as they normally need to be rounded up to the next multiple of 16.
2287      *
2288      * Some decoders do not support linesizes changing between frames.
2289      *
2290      * If frame multithreading is used and thread_safe_callbacks is set,
2291      * this callback may be called from a different thread, but not from more
2292      * than one at once. Does not need to be reentrant.
2293      *
2294      * @see avcodec_align_dimensions2()
2295      *
2296      * Audio:
2297      *
2298      * Decoders request a buffer of a particular size by setting
2299      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2300      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2301      * to a smaller value in the output frame.
2302      *
2303      * As a convenience, av_samples_get_buffer_size() and
2304      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2305      * functions to find the required data size and to fill data pointers and
2306      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2307      * since all planes must be the same size.
2308      *
2309      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2310      *
2311      * - encoding: unused
2312      * - decoding: Set by libavcodec, user can override.
2313      */
2314     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2315
2316     /**
2317      * If non-zero, the decoded audio and video frames returned from
2318      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2319      * and are valid indefinitely. The caller must free them with
2320      * av_frame_unref() when they are not needed anymore.
2321      * Otherwise, the decoded frames must not be freed by the caller and are
2322      * only valid until the next decode call.
2323      *
2324      * This is always automatically enabled if avcodec_receive_frame() is used.
2325      *
2326      * - encoding: unused
2327      * - decoding: set by the caller before avcodec_open2().
2328      */
2329     attribute_deprecated
2330     int refcounted_frames;
2331
2332     /* - encoding parameters */
2333     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2334     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2335
2336     /**
2337      * minimum quantizer
2338      * - encoding: Set by user.
2339      * - decoding: unused
2340      */
2341     int qmin;
2342
2343     /**
2344      * maximum quantizer
2345      * - encoding: Set by user.
2346      * - decoding: unused
2347      */
2348     int qmax;
2349
2350     /**
2351      * maximum quantizer difference between frames
2352      * - encoding: Set by user.
2353      * - decoding: unused
2354      */
2355     int max_qdiff;
2356
2357     /**
2358      * decoder bitstream buffer size
2359      * - encoding: Set by user.
2360      * - decoding: unused
2361      */
2362     int rc_buffer_size;
2363
2364     /**
2365      * ratecontrol override, see RcOverride
2366      * - encoding: Allocated/set/freed by user.
2367      * - decoding: unused
2368      */
2369     int rc_override_count;
2370     RcOverride *rc_override;
2371
2372     /**
2373      * maximum bitrate
2374      * - encoding: Set by user.
2375      * - decoding: Set by user, may be overwritten by libavcodec.
2376      */
2377     int64_t rc_max_rate;
2378
2379     /**
2380      * minimum bitrate
2381      * - encoding: Set by user.
2382      * - decoding: unused
2383      */
2384     int64_t rc_min_rate;
2385
2386     /**
2387      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2388      * - encoding: Set by user.
2389      * - decoding: unused.
2390      */
2391     float rc_max_available_vbv_use;
2392
2393     /**
2394      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2395      * - encoding: Set by user.
2396      * - decoding: unused.
2397      */
2398     float rc_min_vbv_overflow_use;
2399
2400     /**
2401      * Number of bits which should be loaded into the rc buffer before decoding starts.
2402      * - encoding: Set by user.
2403      * - decoding: unused
2404      */
2405     int rc_initial_buffer_occupancy;
2406
2407 #if FF_API_CODER_TYPE
2408 #define FF_CODER_TYPE_VLC       0
2409 #define FF_CODER_TYPE_AC        1
2410 #define FF_CODER_TYPE_RAW       2
2411 #define FF_CODER_TYPE_RLE       3
2412     /**
2413      * @deprecated use encoder private options instead
2414      */
2415     attribute_deprecated
2416     int coder_type;
2417 #endif /* FF_API_CODER_TYPE */
2418
2419 #if FF_API_PRIVATE_OPT
2420     /** @deprecated use encoder private options instead */
2421     attribute_deprecated
2422     int context_model;
2423 #endif
2424
2425 #if FF_API_PRIVATE_OPT
2426     /** @deprecated use encoder private options instead */
2427     attribute_deprecated
2428     int frame_skip_threshold;
2429
2430     /** @deprecated use encoder private options instead */
2431     attribute_deprecated
2432     int frame_skip_factor;
2433
2434     /** @deprecated use encoder private options instead */
2435     attribute_deprecated
2436     int frame_skip_exp;
2437
2438     /** @deprecated use encoder private options instead */
2439     attribute_deprecated
2440     int frame_skip_cmp;
2441 #endif /* FF_API_PRIVATE_OPT */
2442
2443     /**
2444      * trellis RD quantization
2445      * - encoding: Set by user.
2446      * - decoding: unused
2447      */
2448     int trellis;
2449
2450 #if FF_API_PRIVATE_OPT
2451     /** @deprecated use encoder private options instead */
2452     attribute_deprecated
2453     int min_prediction_order;
2454
2455     /** @deprecated use encoder private options instead */
2456     attribute_deprecated
2457     int max_prediction_order;
2458
2459     /** @deprecated use encoder private options instead */
2460     attribute_deprecated
2461     int64_t timecode_frame_start;
2462 #endif
2463
2464 #if FF_API_RTP_CALLBACK
2465     /**
2466      * @deprecated unused
2467      */
2468     /* The RTP callback: This function is called    */
2469     /* every time the encoder has a packet to send. */
2470     /* It depends on the encoder if the data starts */
2471     /* with a Start Code (it should). H.263 does.   */
2472     /* mb_nb contains the number of macroblocks     */
2473     /* encoded in the RTP payload.                  */
2474     attribute_deprecated
2475     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2476 #endif
2477
2478 #if FF_API_PRIVATE_OPT
2479     /** @deprecated use encoder private options instead */
2480     attribute_deprecated
2481     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2482                             /* do its best to deliver a chunk with size     */
2483                             /* below rtp_payload_size, the chunk will start */
2484                             /* with a start code on some codecs like H.263. */
2485                             /* This doesn't take account of any particular  */
2486                             /* headers inside the transmitted RTP payload.  */
2487 #endif
2488
2489 #if FF_API_STAT_BITS
2490     /* statistics, used for 2-pass encoding */
2491     attribute_deprecated
2492     int mv_bits;
2493     attribute_deprecated
2494     int header_bits;
2495     attribute_deprecated
2496     int i_tex_bits;
2497     attribute_deprecated
2498     int p_tex_bits;
2499     attribute_deprecated
2500     int i_count;
2501     attribute_deprecated
2502     int p_count;
2503     attribute_deprecated
2504     int skip_count;
2505     attribute_deprecated
2506     int misc_bits;
2507
2508     /** @deprecated this field is unused */
2509     attribute_deprecated
2510     int frame_bits;
2511 #endif
2512
2513     /**
2514      * pass1 encoding statistics output buffer
2515      * - encoding: Set by libavcodec.
2516      * - decoding: unused
2517      */
2518     char *stats_out;
2519
2520     /**
2521      * pass2 encoding statistics input buffer
2522      * Concatenated stuff from stats_out of pass1 should be placed here.
2523      * - encoding: Allocated/set/freed by user.
2524      * - decoding: unused
2525      */
2526     char *stats_in;
2527
2528     /**
2529      * Work around bugs in encoders which sometimes cannot be detected automatically.
2530      * - encoding: Set by user
2531      * - decoding: Set by user
2532      */
2533     int workaround_bugs;
2534 #define FF_BUG_AUTODETECT       1  ///< autodetection
2535 #define FF_BUG_XVID_ILACE       4
2536 #define FF_BUG_UMP4             8
2537 #define FF_BUG_NO_PADDING       16
2538 #define FF_BUG_AMV              32
2539 #define FF_BUG_QPEL_CHROMA      64
2540 #define FF_BUG_STD_QPEL         128
2541 #define FF_BUG_QPEL_CHROMA2     256
2542 #define FF_BUG_DIRECT_BLOCKSIZE 512
2543 #define FF_BUG_EDGE             1024
2544 #define FF_BUG_HPEL_CHROMA      2048
2545 #define FF_BUG_DC_CLIP          4096
2546 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2547 #define FF_BUG_TRUNCATED       16384
2548 #define FF_BUG_IEDGE           32768
2549
2550     /**
2551      * strictly follow the standard (MPEG-4, ...).
2552      * - encoding: Set by user.
2553      * - decoding: Set by user.
2554      * Setting this to STRICT or higher means the encoder and decoder will
2555      * generally do stupid things, whereas setting it to unofficial or lower
2556      * will mean the encoder might produce output that is not supported by all
2557      * spec-compliant decoders. Decoders don't differentiate between normal,
2558      * unofficial and experimental (that is, they always try to decode things
2559      * when they can) unless they are explicitly asked to behave stupidly
2560      * (=strictly conform to the specs)
2561      */
2562     int strict_std_compliance;
2563 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2564 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2565 #define FF_COMPLIANCE_NORMAL        0
2566 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2567 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2568
2569     /**
2570      * error concealment flags
2571      * - encoding: unused
2572      * - decoding: Set by user.
2573      */
2574     int error_concealment;
2575 #define FF_EC_GUESS_MVS   1
2576 #define FF_EC_DEBLOCK     2
2577 #define FF_EC_FAVOR_INTER 256
2578
2579     /**
2580      * debug
2581      * - encoding: Set by user.
2582      * - decoding: Set by user.
2583      */
2584     int debug;
2585 #define FF_DEBUG_PICT_INFO   1
2586 #define FF_DEBUG_RC          2
2587 #define FF_DEBUG_BITSTREAM   4
2588 #define FF_DEBUG_MB_TYPE     8
2589 #define FF_DEBUG_QP          16
2590 #if FF_API_DEBUG_MV
2591 /**
2592  * @deprecated this option does nothing
2593  */
2594 #define FF_DEBUG_MV          32
2595 #endif
2596 #define FF_DEBUG_DCT_COEFF   0x00000040
2597 #define FF_DEBUG_SKIP        0x00000080
2598 #define FF_DEBUG_STARTCODE   0x00000100
2599 #define FF_DEBUG_ER          0x00000400
2600 #define FF_DEBUG_MMCO        0x00000800
2601 #define FF_DEBUG_BUGS        0x00001000
2602 #if FF_API_DEBUG_MV
2603 #define FF_DEBUG_VIS_QP      0x00002000
2604 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2605 #endif
2606 #define FF_DEBUG_BUFFERS     0x00008000
2607 #define FF_DEBUG_THREADS     0x00010000
2608 #define FF_DEBUG_GREEN_MD    0x00800000
2609 #define FF_DEBUG_NOMC        0x01000000
2610
2611 #if FF_API_DEBUG_MV
2612     /**
2613      * debug
2614      * - encoding: Set by user.
2615      * - decoding: Set by user.
2616      */
2617     int debug_mv;
2618 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
2619 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
2620 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2621 #endif
2622
2623     /**
2624      * Error recognition; may misdetect some more or less valid parts as errors.
2625      * - encoding: unused
2626      * - decoding: Set by user.
2627      */
2628     int err_recognition;
2629
2630 /**
2631  * Verify checksums embedded in the bitstream (could be of either encoded or
2632  * decoded data, depending on the codec) and print an error message on mismatch.
2633  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2634  * decoder returning an error.
2635  */
2636 #define AV_EF_CRCCHECK  (1<<0)
2637 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
2638 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
2639 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
2640
2641 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
2642 #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
2643 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
2644 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
2645
2646
2647     /**
2648      * opaque 64-bit number (generally a PTS) that will be reordered and
2649      * output in AVFrame.reordered_opaque
2650      * - encoding: unused
2651      * - decoding: Set by user.
2652      */
2653     int64_t reordered_opaque;
2654
2655     /**
2656      * Hardware accelerator in use
2657      * - encoding: unused.
2658      * - decoding: Set by libavcodec
2659      */
2660     const struct AVHWAccel *hwaccel;
2661
2662     /**
2663      * Hardware accelerator context.
2664      * For some hardware accelerators, a global context needs to be
2665      * provided by the user. In that case, this holds display-dependent
2666      * data FFmpeg cannot instantiate itself. Please refer to the
2667      * FFmpeg HW accelerator documentation to know how to fill this
2668      * is. e.g. for VA API, this is a struct vaapi_context.
2669      * - encoding: unused
2670      * - decoding: Set by user
2671      */
2672     void *hwaccel_context;
2673
2674     /**
2675      * error
2676      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2677      * - decoding: unused
2678      */
2679     uint64_t error[AV_NUM_DATA_POINTERS];
2680
2681     /**
2682      * DCT algorithm, see FF_DCT_* below
2683      * - encoding: Set by user.
2684      * - decoding: unused
2685      */
2686     int dct_algo;
2687 #define FF_DCT_AUTO    0
2688 #define FF_DCT_FASTINT 1
2689 #define FF_DCT_INT     2
2690 #define FF_DCT_MMX     3
2691 #define FF_DCT_ALTIVEC 5
2692 #define FF_DCT_FAAN    6
2693
2694     /**
2695      * IDCT algorithm, see FF_IDCT_* below.
2696      * - encoding: Set by user.
2697      * - decoding: Set by user.
2698      */
2699     int idct_algo;
2700 #define FF_IDCT_AUTO          0
2701 #define FF_IDCT_INT           1
2702 #define FF_IDCT_SIMPLE        2
2703 #define FF_IDCT_SIMPLEMMX     3
2704 #define FF_IDCT_ARM           7
2705 #define FF_IDCT_ALTIVEC       8
2706 #define FF_IDCT_SIMPLEARM     10
2707 #define FF_IDCT_XVID          14
2708 #define FF_IDCT_SIMPLEARMV5TE 16
2709 #define FF_IDCT_SIMPLEARMV6   17
2710 #define FF_IDCT_FAAN          20
2711 #define FF_IDCT_SIMPLENEON    22
2712 #define FF_IDCT_NONE          24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2713 #define FF_IDCT_SIMPLEAUTO    128
2714
2715     /**
2716      * bits per sample/pixel from the demuxer (needed for huffyuv).
2717      * - encoding: Set by libavcodec.
2718      * - decoding: Set by user.
2719      */
2720      int bits_per_coded_sample;
2721
2722     /**
2723      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2724      * - encoding: set by user.
2725      * - decoding: set by libavcodec.
2726      */
2727     int bits_per_raw_sample;
2728
2729 #if FF_API_LOWRES
2730     /**
2731      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2732      * - encoding: unused
2733      * - decoding: Set by user.
2734      */
2735      int lowres;
2736 #endif
2737
2738 #if FF_API_CODED_FRAME
2739     /**
2740      * the picture in the bitstream
2741      * - encoding: Set by libavcodec.
2742      * - decoding: unused
2743      *
2744      * @deprecated use the quality factor packet side data instead
2745      */
2746     attribute_deprecated AVFrame *coded_frame;
2747 #endif
2748
2749     /**
2750      * thread count
2751      * is used to decide how many independent tasks should be passed to execute()
2752      * - encoding: Set by user.
2753      * - decoding: Set by user.
2754      */
2755     int thread_count;
2756
2757     /**
2758      * Which multithreading methods to use.
2759      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2760      * so clients which cannot provide future frames should not use it.
2761      *
2762      * - encoding: Set by user, otherwise the default is used.
2763      * - decoding: Set by user, otherwise the default is used.
2764      */
2765     int thread_type;
2766 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2767 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2768
2769     /**
2770      * Which multithreading methods are in use by the codec.
2771      * - encoding: Set by libavcodec.
2772      * - decoding: Set by libavcodec.
2773      */
2774     int active_thread_type;
2775
2776     /**
2777      * Set by the client if its custom get_buffer() callback can be called
2778      * synchronously from another thread, which allows faster multithreaded decoding.
2779      * draw_horiz_band() will be called from other threads regardless of this setting.
2780      * Ignored if the default get_buffer() is used.
2781      * - encoding: Set by user.
2782      * - decoding: Set by user.
2783      */
2784     int thread_safe_callbacks;
2785
2786     /**
2787      * The codec may call this to execute several independent things.
2788      * It will return only after finishing all tasks.
2789      * The user may replace this with some multithreaded implementation,
2790      * the default implementation will execute the parts serially.
2791      * @param count the number of things to execute
2792      * - encoding: Set by libavcodec, user can override.
2793      * - decoding: Set by libavcodec, user can override.
2794      */
2795     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2796
2797     /**
2798      * The codec may call this to execute several independent things.
2799      * It will return only after finishing all tasks.
2800      * The user may replace this with some multithreaded implementation,
2801      * the default implementation will execute the parts serially.
2802      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2803      * @param c context passed also to func
2804      * @param count the number of things to execute
2805      * @param arg2 argument passed unchanged to func
2806      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2807      * @param func function that will be called count times, with jobnr from 0 to count-1.
2808      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2809      *             two instances of func executing at the same time will have the same threadnr.
2810      * @return always 0 currently, but code should handle a future improvement where when any call to func
2811      *         returns < 0 no further calls to func may be done and < 0 is returned.
2812      * - encoding: Set by libavcodec, user can override.
2813      * - decoding: Set by libavcodec, user can override.
2814      */
2815     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2816
2817     /**
2818      * noise vs. sse weight for the nsse comparison function
2819      * - encoding: Set by user.
2820      * - decoding: unused
2821      */
2822      int nsse_weight;
2823
2824     /**
2825      * profile
2826      * - encoding: Set by user.
2827      * - decoding: Set by libavcodec.
2828      */
2829      int profile;
2830 #define FF_PROFILE_UNKNOWN -99
2831 #define FF_PROFILE_RESERVED -100
2832
2833 #define FF_PROFILE_AAC_MAIN 0
2834 #define FF_PROFILE_AAC_LOW  1
2835 #define FF_PROFILE_AAC_SSR  2
2836 #define FF_PROFILE_AAC_LTP  3
2837 #define FF_PROFILE_AAC_HE   4
2838 #define FF_PROFILE_AAC_HE_V2 28
2839 #define FF_PROFILE_AAC_LD   22
2840 #define FF_PROFILE_AAC_ELD  38
2841 #define FF_PROFILE_MPEG2_AAC_LOW 128
2842 #define FF_PROFILE_MPEG2_AAC_HE  131
2843
2844 #define FF_PROFILE_DNXHD         0
2845 #define FF_PROFILE_DNXHR_LB      1
2846 #define FF_PROFILE_DNXHR_SQ      2
2847 #define FF_PROFILE_DNXHR_HQ      3
2848 #define FF_PROFILE_DNXHR_HQX     4
2849 #define FF_PROFILE_DNXHR_444     5
2850
2851 #define FF_PROFILE_DTS         20
2852 #define FF_PROFILE_DTS_ES      30
2853 #define FF_PROFILE_DTS_96_24   40
2854 #define FF_PROFILE_DTS_HD_HRA  50
2855 #define FF_PROFILE_DTS_HD_MA   60
2856 #define FF_PROFILE_DTS_EXPRESS 70
2857
2858 #define FF_PROFILE_MPEG2_422    0
2859 #define FF_PROFILE_MPEG2_HIGH   1
2860 #define FF_PROFILE_MPEG2_SS     2
2861 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2862 #define FF_PROFILE_MPEG2_MAIN   4
2863 #define FF_PROFILE_MPEG2_SIMPLE 5
2864
2865 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2866 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2867
2868 #define FF_PROFILE_H264_BASELINE             66
2869 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2870 #define FF_PROFILE_H264_MAIN                 77
2871 #define FF_PROFILE_H264_EXTENDED             88
2872 #define FF_PROFILE_H264_HIGH                 100
2873 #define FF_PROFILE_H264_HIGH_10              110
2874 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2875 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2876 #define FF_PROFILE_H264_HIGH_422             122
2877 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2878 #define FF_PROFILE_H264_STEREO_HIGH          128
2879 #define FF_PROFILE_H264_HIGH_444             144
2880 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2881 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2882 #define FF_PROFILE_H264_CAVLC_444            44
2883
2884 #define FF_PROFILE_VC1_SIMPLE   0
2885 #define FF_PROFILE_VC1_MAIN     1
2886 #define FF_PROFILE_VC1_COMPLEX  2
2887 #define FF_PROFILE_VC1_ADVANCED 3
2888
2889 #define FF_PROFILE_MPEG4_SIMPLE                     0
2890 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2891 #define FF_PROFILE_MPEG4_CORE                       2
2892 #define FF_PROFILE_MPEG4_MAIN                       3
2893 #define FF_PROFILE_MPEG4_N_BIT                      4
2894 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2895 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2896 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2897 #define FF_PROFILE_MPEG4_HYBRID                     8
2898 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2899 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2900 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2901 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2902 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2903 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2904 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2905
2906 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2907 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2908 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2909 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2910 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2911
2912 #define FF_PROFILE_VP9_0                            0
2913 #define FF_PROFILE_VP9_1                            1
2914 #define FF_PROFILE_VP9_2                            2
2915 #define FF_PROFILE_VP9_3                            3
2916
2917 #define FF_PROFILE_HEVC_MAIN                        1
2918 #define FF_PROFILE_HEVC_MAIN_10                     2
2919 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2920 #define FF_PROFILE_HEVC_REXT                        4
2921
2922 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT            0xc0
2923 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2924 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT         0xc2
2925 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS                0xc3
2926 #define FF_PROFILE_MJPEG_JPEG_LS                         0xf7
2927
2928     /**
2929      * level
2930      * - encoding: Set by user.
2931      * - decoding: Set by libavcodec.
2932      */
2933      int level;
2934 #define FF_LEVEL_UNKNOWN -99
2935
2936     /**
2937      * Skip loop filtering for selected frames.
2938      * - encoding: unused
2939      * - decoding: Set by user.
2940      */
2941     enum AVDiscard skip_loop_filter;
2942
2943     /**
2944      * Skip IDCT/dequantization for selected frames.
2945      * - encoding: unused
2946      * - decoding: Set by user.
2947      */
2948     enum AVDiscard skip_idct;
2949
2950     /**
2951      * Skip decoding for selected frames.
2952      * - encoding: unused
2953      * - decoding: Set by user.
2954      */
2955     enum AVDiscard skip_frame;
2956
2957     /**
2958      * Header containing style information for text subtitles.
2959      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2960      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2961      * the Format line following. It shouldn't include any Dialogue line.
2962      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2963      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2964      */
2965     uint8_t *subtitle_header;
2966     int subtitle_header_size;
2967
2968 #if FF_API_VBV_DELAY
2969     /**
2970      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2971      * Used for compliant TS muxing.
2972      * - encoding: Set by libavcodec.
2973      * - decoding: unused.
2974      * @deprecated this value is now exported as a part of
2975      * AV_PKT_DATA_CPB_PROPERTIES packet side data
2976      */
2977     attribute_deprecated
2978     uint64_t vbv_delay;
2979 #endif
2980
2981 #if FF_API_SIDEDATA_ONLY_PKT
2982     /**
2983      * Encoding only and set by default. Allow encoders to output packets
2984      * that do not contain any encoded data, only side data.
2985      *
2986      * Some encoders need to output such packets, e.g. to update some stream
2987      * parameters at the end of encoding.
2988      *
2989      * @deprecated this field disables the default behaviour and
2990      *             it is kept only for compatibility.
2991      */
2992     attribute_deprecated
2993     int side_data_only_packets;
2994 #endif
2995
2996     /**
2997      * Audio only. The number of "priming" samples (padding) inserted by the
2998      * encoder at the beginning of the audio. I.e. this number of leading
2999      * decoded samples must be discarded by the caller to get the original audio
3000      * without leading padding.
3001      *
3002      * - decoding: unused
3003      * - encoding: Set by libavcodec. The timestamps on the output packets are
3004      *             adjusted by the encoder so that they always refer to the
3005      *             first sample of the data actually contained in the packet,
3006      *             including any added padding.  E.g. if the timebase is
3007      *             1/samplerate and the timestamp of the first input sample is
3008      *             0, the timestamp of the first output packet will be
3009      *             -initial_padding.
3010      */
3011     int initial_padding;
3012
3013     /**
3014      * - decoding: For codecs that store a framerate value in the compressed
3015      *             bitstream, the decoder may export it here. { 0, 1} when
3016      *             unknown.
3017      * - encoding: May be used to signal the framerate of CFR content to an
3018      *             encoder.
3019      */
3020     AVRational framerate;
3021
3022     /**
3023      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3024      * - encoding: unused.
3025      * - decoding: Set by libavcodec before calling get_format()
3026      */
3027     enum AVPixelFormat sw_pix_fmt;
3028
3029     /**
3030      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3031      * - encoding unused.
3032      * - decoding set by user.
3033      */
3034     AVRational pkt_timebase;
3035
3036     /**
3037      * AVCodecDescriptor
3038      * - encoding: unused.
3039      * - decoding: set by libavcodec.
3040      */
3041     const AVCodecDescriptor *codec_descriptor;
3042
3043 #if !FF_API_LOWRES
3044     /**
3045      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3046      * - encoding: unused
3047      * - decoding: Set by user.
3048      */
3049      int lowres;
3050 #endif
3051
3052     /**
3053      * Current statistics for PTS correction.
3054      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3055      * - encoding: unused
3056      */
3057     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3058     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3059     int64_t pts_correction_last_pts;       /// PTS of the last frame
3060     int64_t pts_correction_last_dts;       /// DTS of the last frame
3061
3062     /**
3063      * Character encoding of the input subtitles file.
3064      * - decoding: set by user
3065      * - encoding: unused
3066      */
3067     char *sub_charenc;
3068
3069     /**
3070      * Subtitles character encoding mode. Formats or codecs might be adjusting
3071      * this setting (if they are doing the conversion themselves for instance).
3072      * - decoding: set by libavcodec
3073      * - encoding: unused
3074      */
3075     int sub_charenc_mode;
3076 #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)
3077 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3078 #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
3079
3080     /**
3081      * Skip processing alpha if supported by codec.
3082      * Note that if the format uses pre-multiplied alpha (common with VP6,
3083      * and recommended due to better video quality/compression)
3084      * the image will look as if alpha-blended onto a black background.
3085      * However for formats that do not use pre-multiplied alpha
3086      * there might be serious artefacts (though e.g. libswscale currently
3087      * assumes pre-multiplied alpha anyway).
3088      *
3089      * - decoding: set by user
3090      * - encoding: unused
3091      */
3092     int skip_alpha;
3093
3094     /**
3095      * Number of samples to skip after a discontinuity
3096      * - decoding: unused
3097      * - encoding: set by libavcodec
3098      */
3099     int seek_preroll;
3100
3101 #if !FF_API_DEBUG_MV
3102     /**
3103      * debug motion vectors
3104      * - encoding: Set by user.
3105      * - decoding: Set by user.
3106      */
3107     int debug_mv;
3108 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3109 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3110 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3111 #endif
3112
3113     /**
3114      * custom intra quantization matrix
3115      * - encoding: Set by user, can be NULL.
3116      * - decoding: unused.
3117      */
3118     uint16_t *chroma_intra_matrix;
3119
3120     /**
3121      * dump format separator.
3122      * can be ", " or "\n      " or anything else
3123      * - encoding: Set by user.
3124      * - decoding: Set by user.
3125      */
3126     uint8_t *dump_separator;
3127
3128     /**
3129      * ',' separated list of allowed decoders.
3130      * If NULL then all are allowed
3131      * - encoding: unused
3132      * - decoding: set by user
3133      */
3134     char *codec_whitelist;
3135
3136     /**
3137      * Properties of the stream that gets decoded
3138      * - encoding: unused
3139      * - decoding: set by libavcodec
3140      */
3141     unsigned properties;
3142 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3143 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3144
3145     /**
3146      * Additional data associated with the entire coded stream.
3147      *
3148      * - decoding: unused
3149      * - encoding: may be set by libavcodec after avcodec_open2().
3150      */
3151     AVPacketSideData *coded_side_data;
3152     int            nb_coded_side_data;
3153
3154     /**
3155      * A reference to the AVHWFramesContext describing the input (for encoding)
3156      * or output (decoding) frames. The reference is set by the caller and
3157      * afterwards owned (and freed) by libavcodec - it should never be read by
3158      * the caller after being set.
3159      *
3160      * - decoding: This field should be set by the caller from the get_format()
3161      *             callback. The previous reference (if any) will always be
3162      *             unreffed by libavcodec before the get_format() call.
3163      *
3164      *             If the default get_buffer2() is used with a hwaccel pixel
3165      *             format, then this AVHWFramesContext will be used for
3166      *             allocating the frame buffers.
3167      *
3168      * - encoding: For hardware encoders configured to use a hwaccel pixel
3169      *             format, this field should be set by the caller to a reference
3170      *             to the AVHWFramesContext describing input frames.
3171      *             AVHWFramesContext.format must be equal to
3172      *             AVCodecContext.pix_fmt.
3173      *
3174      *             This field should be set before avcodec_open2() is called.
3175      */
3176     AVBufferRef *hw_frames_ctx;
3177
3178     /**
3179      * Control the form of AVSubtitle.rects[N]->ass
3180      * - decoding: set by user
3181      * - encoding: unused
3182      */
3183     int sub_text_format;
3184 #define FF_SUB_TEXT_FMT_ASS              0
3185 #if FF_API_ASS_TIMING
3186 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3187 #endif
3188
3189     /**
3190      * Audio only. The amount of padding (in samples) appended by the encoder to
3191      * the end of the audio. I.e. this number of decoded samples must be
3192      * discarded by the caller from the end of the stream to get the original
3193      * audio without any trailing padding.
3194      *
3195      * - decoding: unused
3196      * - encoding: unused
3197      */
3198     int trailing_padding;
3199
3200     /**
3201      * The number of pixels per image to maximally accept.
3202      *
3203      * - decoding: set by user
3204      * - encoding: set by user
3205      */
3206     int64_t max_pixels;
3207
3208     /**
3209      * A reference to the AVHWDeviceContext describing the device which will
3210      * be used by a hardware encoder/decoder.  The reference is set by the
3211      * caller and afterwards owned (and freed) by libavcodec.
3212      *
3213      * This should be used if either the codec device does not require
3214      * hardware frames or any that are used are to be allocated internally by
3215      * libavcodec.  If the user wishes to supply any of the frames used as
3216      * encoder input or decoder output then hw_frames_ctx should be used
3217      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3218      * field will be ignored while decoding the associated stream segment, but
3219      * may again be used on a following one after another get_format() call.
3220      *
3221      * For both encoders and decoders this field should be set before
3222      * avcodec_open2() is called and must not be written to thereafter.
3223      *
3224      * Note that some decoders may require this field to be set initially in
3225      * order to support hw_frames_ctx at all - in that case, all frames
3226      * contexts used must be created on the same device.
3227      */
3228     AVBufferRef *hw_device_ctx;
3229
3230     /**
3231      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3232      * decoding (if active).
3233      * - encoding: unused
3234      * - decoding: Set by user (either before avcodec_open2(), or in the
3235      *             AVCodecContext.get_format callback)
3236      */
3237     int hwaccel_flags;
3238
3239     /**
3240      * Video decoding only. Certain video codecs support cropping, meaning that
3241      * only a sub-rectangle of the decoded frame is intended for display.  This
3242      * option controls how cropping is handled by libavcodec.
3243      *
3244      * When set to 1 (the default), libavcodec will apply cropping internally.
3245      * I.e. it will modify the output frame width/height fields and offset the
3246      * data pointers (only by as much as possible while preserving alignment, or
3247      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3248      * the frames output by the decoder refer only to the cropped area. The
3249      * crop_* fields of the output frames will be zero.
3250      *
3251      * When set to 0, the width/height fields of the output frames will be set
3252      * to the coded dimensions and the crop_* fields will describe the cropping
3253      * rectangle. Applying the cropping is left to the caller.
3254      *
3255      * @warning When hardware acceleration with opaque output frames is used,
3256      * libavcodec is unable to apply cropping from the top/left border.
3257      *
3258      * @note when this option is set to zero, the width/height fields of the
3259      * AVCodecContext and output AVFrames have different meanings. The codec
3260      * context fields store display dimensions (with the coded dimensions in
3261      * coded_width/height), while the frame fields store the coded dimensions
3262      * (with the display dimensions being determined by the crop_* fields).
3263      */
3264     int apply_cropping;
3265
3266     /*
3267      * Video decoding only.  Sets the number of extra hardware frames which
3268      * the decoder will allocate for use by the caller.  This must be set
3269      * before avcodec_open2() is called.
3270      *
3271      * Some hardware decoders require all frames that they will use for
3272      * output to be defined in advance before decoding starts.  For such
3273      * decoders, the hardware frame pool must therefore be of a fixed size.
3274      * The extra frames set here are on top of any number that the decoder
3275      * needs internally in order to operate normally (for example, frames
3276      * used as reference pictures).
3277      */
3278     int extra_hw_frames;
3279 } AVCodecContext;
3280
3281 #if FF_API_CODEC_GET_SET
3282 /**
3283  * Accessors for some AVCodecContext fields. These used to be provided for ABI
3284  * compatibility, and do not need to be used anymore.
3285  */
3286 attribute_deprecated
3287 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3288 attribute_deprecated
3289 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3290
3291 attribute_deprecated
3292 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3293 attribute_deprecated
3294 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3295
3296 attribute_deprecated
3297 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3298
3299 #if FF_API_LOWRES
3300 attribute_deprecated
3301 int  av_codec_get_lowres(const AVCodecContext *avctx);
3302 attribute_deprecated
3303 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3304 #endif
3305
3306 attribute_deprecated
3307 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3308 attribute_deprecated
3309 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3310
3311 attribute_deprecated
3312 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3313 attribute_deprecated
3314 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3315 #endif
3316
3317 /**
3318  * AVProfile.
3319  */
3320 typedef struct AVProfile {
3321     int profile;
3322     const char *name; ///< short name for the profile
3323 } AVProfile;
3324
3325 enum {
3326     /**
3327      * The codec supports this format via the hw_device_ctx interface.
3328      *
3329      * When selecting this format, AVCodecContext.hw_device_ctx should
3330      * have been set to a device of the specified type before calling
3331      * avcodec_open2().
3332      */
3333     AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3334     /**
3335      * The codec supports this format via the hw_frames_ctx interface.
3336      *
3337      * When selecting this format for a decoder,
3338      * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3339      * context inside the get_format() callback.  The frames context
3340      * must have been created on a device of the specified type.
3341      */
3342     AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3343     /**
3344      * The codec supports this format by some internal method.
3345      *
3346      * This format can be selected without any additional configuration -
3347      * no device or frames context is required.
3348      */
3349     AV_CODEC_HW_CONFIG_METHOD_INTERNAL      = 0x04,
3350     /**
3351      * The codec supports this format by some ad-hoc method.
3352      *
3353      * Additional settings and/or function calls are required.  See the
3354      * codec-specific documentation for details.  (Methods requiring
3355      * this sort of configuration are deprecated and others should be
3356      * used in preference.)
3357      */
3358     AV_CODEC_HW_CONFIG_METHOD_AD_HOC        = 0x08,
3359 };
3360
3361 typedef struct AVCodecHWConfig {
3362     /**
3363      * A hardware pixel format which the codec can use.
3364      */
3365     enum AVPixelFormat pix_fmt;
3366     /**
3367      * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3368      * setup methods which can be used with this configuration.
3369      */
3370     int methods;
3371     /**
3372      * The device type associated with the configuration.
3373      *
3374      * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3375      * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3376      */
3377     enum AVHWDeviceType device_type;
3378 } AVCodecHWConfig;
3379
3380 typedef struct AVCodecDefault AVCodecDefault;
3381
3382 struct AVSubtitle;
3383
3384 /**
3385  * AVCodec.
3386  */
3387 typedef struct AVCodec {
3388     /**
3389      * Name of the codec implementation.
3390      * The name is globally unique among encoders and among decoders (but an
3391      * encoder and a decoder can share the same name).
3392      * This is the primary way to find a codec from the user perspective.
3393      */
3394     const char *name;
3395     /**
3396      * Descriptive name for the codec, meant to be more human readable than name.
3397      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3398      */
3399     const char *long_name;
3400     enum AVMediaType type;
3401     enum AVCodecID id;
3402     /**
3403      * Codec capabilities.
3404      * see AV_CODEC_CAP_*
3405      */
3406     int capabilities;
3407     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3408     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3409     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3410     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3411     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3412     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3413     const AVClass *priv_class;              ///< AVClass for the private context
3414     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3415
3416     /**
3417      * Group name of the codec implementation.
3418      * This is a short symbolic name of the wrapper backing this codec. A
3419      * wrapper uses some kind of external implementation for the codec, such
3420      * as an external library, or a codec implementation provided by the OS or
3421      * the hardware.
3422      * If this field is NULL, this is a builtin, libavcodec native codec.
3423      * If non-NULL, this will be the suffix in AVCodec.name in most cases
3424      * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3425      */
3426     const char *wrapper_name;
3427
3428     /*****************************************************************
3429      * No fields below this line are part of the public API. They
3430      * may not be used outside of libavcodec and can be changed and
3431      * removed at will.
3432      * New public fields should be added right above.
3433      *****************************************************************
3434      */
3435     int priv_data_size;
3436     struct AVCodec *next;
3437     /**
3438      * @name Frame-level threading support functions
3439      * @{
3440      */
3441     /**
3442      * If defined, called on thread contexts when they are created.
3443      * If the codec allocates writable tables in init(), re-allocate them here.
3444      * priv_data will be set to a copy of the original.
3445      */
3446     int (*init_thread_copy)(AVCodecContext *);
3447     /**
3448      * Copy necessary context variables from a previous thread context to the current one.
3449      * If not defined, the next thread will start automatically; otherwise, the codec
3450      * must call ff_thread_finish_setup().
3451      *
3452      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3453      */
3454     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3455     /** @} */
3456
3457     /**
3458      * Private codec-specific defaults.
3459      */
3460     const AVCodecDefault *defaults;
3461
3462     /**
3463      * Initialize codec static data, called from avcodec_register().
3464      *
3465      * This is not intended for time consuming operations as it is
3466      * run for every codec regardless of that codec being used.
3467      */
3468     void (*init_static_data)(struct AVCodec *codec);
3469
3470     int (*init)(AVCodecContext *);
3471     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3472                       const struct AVSubtitle *sub);
3473     /**
3474      * Encode data to an AVPacket.
3475      *
3476      * @param      avctx          codec context
3477      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3478      * @param[in]  frame          AVFrame containing the raw data to be encoded
3479      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3480      *                            non-empty packet was returned in avpkt.
3481      * @return 0 on success, negative error code on failure
3482      */
3483     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3484                    int *got_packet_ptr);
3485     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3486     int (*close)(AVCodecContext *);
3487     /**
3488      * Encode API with decoupled packet/frame dataflow. The API is the
3489      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3490      * that:
3491      * - never called if the codec is closed or the wrong type,
3492      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3493      * - only one drain frame is ever passed down,
3494      */
3495     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3496     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3497
3498     /**
3499      * Decode API with decoupled packet/frame dataflow. This function is called
3500      * to get one output frame. It should call ff_decode_get_packet() to obtain
3501      * input data.
3502      */
3503     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3504     /**
3505      * Flush buffers.
3506      * Will be called when seeking
3507      */
3508     void (*flush)(AVCodecContext *);
3509     /**
3510      * Internal codec capabilities.
3511      * See FF_CODEC_CAP_* in internal.h
3512      */
3513     int caps_internal;
3514
3515     /**
3516      * Decoding only, a comma-separated list of bitstream filters to apply to
3517      * packets before decoding.
3518      */
3519     const char *bsfs;
3520
3521     /**
3522      * Array of pointers to hardware configurations supported by the codec,
3523      * or NULL if no hardware supported.  The array is terminated by a NULL
3524      * pointer.
3525      *
3526      * The user can only access this field via avcodec_get_hw_config().
3527      */
3528     const struct AVCodecHWConfigInternal **hw_configs;
3529 } AVCodec;
3530
3531 #if FF_API_CODEC_GET_SET
3532 attribute_deprecated
3533 int av_codec_get_max_lowres(const AVCodec *codec);
3534 #endif
3535
3536 struct MpegEncContext;
3537
3538 /**
3539  * Retrieve supported hardware configurations for a codec.
3540  *
3541  * Values of index from zero to some maximum return the indexed configuration
3542  * descriptor; all other values return NULL.  If the codec does not support
3543  * any hardware configurations then it will always return NULL.
3544  */
3545 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3546
3547 /**
3548  * @defgroup lavc_hwaccel AVHWAccel
3549  *
3550  * @note  Nothing in this structure should be accessed by the user.  At some
3551  *        point in future it will not be externally visible at all.
3552  *
3553  * @{
3554  */
3555 typedef struct AVHWAccel {
3556     /**
3557      * Name of the hardware accelerated codec.
3558      * The name is globally unique among encoders and among decoders (but an
3559      * encoder and a decoder can share the same name).
3560      */
3561     const char *name;
3562
3563     /**
3564      * Type of codec implemented by the hardware accelerator.
3565      *
3566      * See AVMEDIA_TYPE_xxx
3567      */
3568     enum AVMediaType type;
3569
3570     /**
3571      * Codec implemented by the hardware accelerator.
3572      *
3573      * See AV_CODEC_ID_xxx
3574      */
3575     enum AVCodecID id;
3576
3577     /**
3578      * Supported pixel format.
3579      *
3580      * Only hardware accelerated formats are supported here.
3581      */
3582     enum AVPixelFormat pix_fmt;
3583
3584     /**
3585      * Hardware accelerated codec capabilities.
3586      * see AV_HWACCEL_CODEC_CAP_*
3587      */
3588     int capabilities;
3589
3590     /*****************************************************************
3591      * No fields below this line are part of the public API. They
3592      * may not be used outside of libavcodec and can be changed and
3593      * removed at will.
3594      * New public fields should be added right above.
3595      *****************************************************************
3596      */
3597
3598     /**
3599      * Allocate a custom buffer
3600      */
3601     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3602
3603     /**
3604      * Called at the beginning of each frame or field picture.
3605      *
3606      * Meaningful frame information (codec specific) is guaranteed to
3607      * be parsed at this point. This function is mandatory.
3608      *
3609      * Note that buf can be NULL along with buf_size set to 0.
3610      * Otherwise, this means the whole frame is available at this point.
3611      *
3612      * @param avctx the codec context
3613      * @param buf the frame data buffer base
3614      * @param buf_size the size of the frame in bytes
3615      * @return zero if successful, a negative value otherwise
3616      */
3617     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3618
3619     /**
3620      * Callback for parameter data (SPS/PPS/VPS etc).
3621      *
3622      * Useful for hardware decoders which keep persistent state about the
3623      * video parameters, and need to receive any changes to update that state.
3624      *
3625      * @param avctx the codec context
3626      * @param type the nal unit type
3627      * @param buf the nal unit data buffer
3628      * @param buf_size the size of the nal unit in bytes
3629      * @return zero if successful, a negative value otherwise
3630      */
3631     int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3632
3633     /**
3634      * Callback for each slice.
3635      *
3636      * Meaningful slice information (codec specific) is guaranteed to
3637      * be parsed at this point. This function is mandatory.
3638      * The only exception is XvMC, that works on MB level.
3639      *
3640      * @param avctx the codec context
3641      * @param buf the slice data buffer base
3642      * @param buf_size the size of the slice in bytes
3643      * @return zero if successful, a negative value otherwise
3644      */
3645     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3646
3647     /**
3648      * Called at the end of each frame or field picture.
3649      *
3650      * The whole picture is parsed at this point and can now be sent
3651      * to the hardware accelerator. This function is mandatory.
3652      *
3653      * @param avctx the codec context
3654      * @return zero if successful, a negative value otherwise
3655      */
3656     int (*end_frame)(AVCodecContext *avctx);
3657
3658     /**
3659      * Size of per-frame hardware accelerator private data.
3660      *
3661      * Private data is allocated with av_mallocz() before
3662      * AVCodecContext.get_buffer() and deallocated after
3663      * AVCodecContext.release_buffer().
3664      */
3665     int frame_priv_data_size;
3666
3667     /**
3668      * Called for every Macroblock in a slice.
3669      *
3670      * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3671      * Instead of decoding to raw picture, MB parameters are
3672      * stored in an array provided by the video driver.
3673      *
3674      * @param s the mpeg context
3675      */
3676     void (*decode_mb)(struct MpegEncContext *s);
3677
3678     /**
3679      * Initialize the hwaccel private data.
3680      *
3681      * This will be called from ff_get_format(), after hwaccel and
3682      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3683      * is allocated.
3684      */
3685     int (*init)(AVCodecContext *avctx);
3686
3687     /**
3688      * Uninitialize the hwaccel private data.
3689      *
3690      * This will be called from get_format() or avcodec_close(), after hwaccel
3691      * and hwaccel_context are already uninitialized.
3692      */
3693     int (*uninit)(AVCodecContext *avctx);
3694
3695     /**
3696      * Size of the private data to allocate in
3697      * AVCodecInternal.hwaccel_priv_data.
3698      */
3699     int priv_data_size;
3700
3701     /**
3702      * Internal hwaccel capabilities.
3703      */
3704     int caps_internal;
3705
3706     /**
3707      * Fill the given hw_frames context with current codec parameters. Called
3708      * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3709      * details.
3710      *
3711      * This CAN be called before AVHWAccel.init is called, and you must assume
3712      * that avctx->hwaccel_priv_data is invalid.
3713      */
3714     int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3715 } AVHWAccel;
3716
3717 /**
3718  * HWAccel is experimental and is thus avoided in favor of non experimental
3719  * codecs
3720  */
3721 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3722
3723 /**
3724  * Hardware acceleration should be used for decoding even if the codec level
3725  * used is unknown or higher than the maximum supported level reported by the
3726  * hardware driver.
3727  *
3728  * It's generally a good idea to pass this flag unless you have a specific
3729  * reason not to, as hardware tends to under-report supported levels.
3730  */
3731 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3732
3733 /**
3734  * Hardware acceleration can output YUV pixel formats with a different chroma
3735  * sampling than 4:2:0 and/or other than 8 bits per component.
3736  */
3737 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3738
3739 /**
3740  * Hardware acceleration should still be attempted for decoding when the
3741  * codec profile does not match the reported capabilities of the hardware.
3742  *
3743  * For example, this can be used to try to decode baseline profile H.264
3744  * streams in hardware - it will often succeed, because many streams marked
3745  * as baseline profile actually conform to constrained baseline profile.
3746  *
3747  * @warning If the stream is actually not supported then the behaviour is
3748  *          undefined, and may include returning entirely incorrect output
3749  *          while indicating success.
3750  */
3751 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3752
3753 /**
3754  * @}
3755  */
3756
3757 #if FF_API_AVPICTURE
3758 /**
3759  * @defgroup lavc_picture AVPicture
3760  *
3761  * Functions for working with AVPicture
3762  * @{
3763  */
3764
3765 /**
3766  * Picture data structure.
3767  *
3768  * Up to four components can be stored into it, the last component is
3769  * alpha.
3770  * @deprecated use AVFrame or imgutils functions instead
3771  */
3772 typedef struct AVPicture {
3773     attribute_deprecated
3774     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
3775     attribute_deprecated
3776     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3777 } AVPicture;
3778
3779 /**
3780  * @}
3781  */
3782 #endif
3783
3784 enum AVSubtitleType {
3785     SUBTITLE_NONE,
3786
3787     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3788
3789     /**
3790      * Plain text, the text field must be set by the decoder and is
3791      * authoritative. ass and pict fields may contain approximations.
3792      */
3793     SUBTITLE_TEXT,
3794
3795     /**
3796      * Formatted text, the ass field must be set by the decoder and is
3797      * authoritative. pict and text fields may contain approximations.
3798      */
3799     SUBTITLE_ASS,
3800 };
3801
3802 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
3803
3804 typedef struct AVSubtitleRect {
3805     int x;         ///< top left corner  of pict, undefined when pict is not set
3806     int y;         ///< top left corner  of pict, undefined when pict is not set
3807     int w;         ///< width            of pict, undefined when pict is not set
3808     int h;         ///< height           of pict, undefined when pict is not set
3809     int nb_colors; ///< number of colors in pict, undefined when pict is not set
3810
3811 #if FF_API_AVPICTURE
3812     /**
3813      * @deprecated unused
3814      */
3815     attribute_deprecated
3816     AVPicture pict;
3817 #endif
3818     /**
3819      * data+linesize for the bitmap of this subtitle.
3820      * Can be set for text/ass as well once they are rendered.
3821      */
3822     uint8_t *data[4];
3823     int linesize[4];
3824
3825     enum AVSubtitleType type;
3826
3827     char *text;                     ///< 0 terminated plain UTF-8 text
3828
3829     /**
3830      * 0 terminated ASS/SSA compatible event line.
3831      * The presentation of this is unaffected by the other values in this
3832      * struct.
3833      */
3834     char *ass;
3835
3836     int flags;
3837 } AVSubtitleRect;
3838
3839 typedef struct AVSubtitle {
3840     uint16_t format; /* 0 = graphics */
3841     uint32_t start_display_time; /* relative to packet pts, in ms */
3842     uint32_t end_display_time; /* relative to packet pts, in ms */
3843     unsigned num_rects;
3844     AVSubtitleRect **rects;
3845     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
3846 } AVSubtitle;
3847
3848 /**
3849  * This struct describes the properties of an encoded stream.
3850  *
3851  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
3852  * be allocated with avcodec_parameters_alloc() and freed with
3853  * avcodec_parameters_free().
3854  */
3855 typedef struct AVCodecParameters {
3856     /**
3857      * General type of the encoded data.
3858      */
3859     enum AVMediaType codec_type;
3860     /**
3861      * Specific type of the encoded data (the codec used).
3862      */
3863     enum AVCodecID   codec_id;
3864     /**
3865      * Additional information about the codec (corresponds to the AVI FOURCC).
3866      */
3867     uint32_t         codec_tag;
3868
3869     /**
3870      * Extra binary data needed for initializing the decoder, codec-dependent.
3871      *
3872      * Must be allocated with av_malloc() and will be freed by
3873      * avcodec_parameters_free(). The allocated size of extradata must be at
3874      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
3875      * bytes zeroed.
3876      */
3877     uint8_t *extradata;
3878     /**
3879      * Size of the extradata content in bytes.
3880      */
3881     int      extradata_size;
3882
3883     /**
3884      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
3885      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
3886      */
3887     int format;
3888
3889     /**
3890      * The average bitrate of the encoded data (in bits per second).
3891      */
3892     int64_t bit_rate;
3893
3894     /**
3895      * The number of bits per sample in the codedwords.
3896      *
3897      * This is basically the bitrate per sample. It is mandatory for a bunch of
3898      * formats to actually decode them. It's the number of bits for one sample in
3899      * the actual coded bitstream.
3900      *
3901      * This could be for example 4 for ADPCM
3902      * For PCM formats this matches bits_per_raw_sample
3903      * Can be 0
3904      */
3905     int bits_per_coded_sample;
3906
3907     /**
3908      * This is the number of valid bits in each output sample. If the
3909      * sample format has more bits, the least significant bits are additional
3910      * padding bits, which are always 0. Use right shifts to reduce the sample
3911      * to its actual size. For example, audio formats with 24 bit samples will
3912      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
3913      * To get the original sample use "(int32_t)sample >> 8"."
3914      *
3915      * For ADPCM this might be 12 or 16 or similar
3916      * Can be 0
3917      */
3918     int bits_per_raw_sample;
3919
3920     /**
3921      * Codec-specific bitstream restrictions that the stream conforms to.
3922      */
3923     int profile;
3924     int level;
3925
3926     /**
3927      * Video only. The dimensions of the video frame in pixels.
3928      */
3929     int width;
3930     int height;
3931
3932     /**
3933      * Video only. The aspect ratio (width / height) which a single pixel
3934      * should have when displayed.
3935      *
3936      * When the aspect ratio is unknown / undefined, the numerator should be
3937      * set to 0 (the denominator may have any value).
3938      */
3939     AVRational sample_aspect_ratio;
3940
3941     /**
3942      * Video only. The order of the fields in interlaced video.
3943      */
3944     enum AVFieldOrder                  field_order;
3945
3946     /**
3947      * Video only. Additional colorspace characteristics.
3948      */
3949     enum AVColorRange                  color_range;
3950     enum AVColorPrimaries              color_primaries;
3951     enum AVColorTransferCharacteristic color_trc;
3952     enum AVColorSpace                  color_space;
3953     enum AVChromaLocation              chroma_location;
3954
3955     /**
3956      * Video only. Number of delayed frames.
3957      */
3958     int video_delay;
3959
3960     /**
3961      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
3962      * unknown or unspecified, otherwise the number of bits set must be equal to
3963      * the channels field.
3964      */
3965     uint64_t channel_layout;
3966     /**
3967      * Audio only. The number of audio channels.
3968      */
3969     int      channels;
3970     /**
3971      * Audio only. The number of audio samples per second.
3972      */
3973     int      sample_rate;
3974     /**
3975      * Audio only. The number of bytes per coded audio frame, required by some
3976      * formats.
3977      *
3978      * Corresponds to nBlockAlign in WAVEFORMATEX.
3979      */
3980     int      block_align;
3981     /**
3982      * Audio only. Audio frame size, if known. Required by some formats to be static.
3983      */
3984     int      frame_size;
3985
3986     /**
3987      * Audio only. The amount of padding (in samples) inserted by the encoder at
3988      * the beginning of the audio. I.e. this number of leading decoded samples
3989      * must be discarded by the caller to get the original audio without leading
3990      * padding.
3991      */
3992     int initial_padding;
3993     /**
3994      * Audio only. The amount of padding (in samples) appended by the encoder to
3995      * the end of the audio. I.e. this number of decoded samples must be
3996      * discarded by the caller from the end of the stream to get the original
3997      * audio without any trailing padding.
3998      */
3999     int trailing_padding;
4000     /**
4001      * Audio only. Number of samples to skip after a discontinuity.
4002      */
4003     int seek_preroll;
4004 } AVCodecParameters;
4005
4006 /**
4007  * Iterate over all registered codecs.
4008  *
4009  * @param opaque a pointer where libavcodec will store the iteration state. Must
4010  *               point to NULL to start the iteration.
4011  *
4012  * @return the next registered codec or NULL when the iteration is
4013  *         finished
4014  */
4015 const AVCodec *av_codec_iterate(void **opaque);
4016
4017 #if FF_API_NEXT
4018 /**
4019  * If c is NULL, returns the first registered codec,
4020  * if c is non-NULL, returns the next registered codec after c,
4021  * or NULL if c is the last one.
4022  */
4023 attribute_deprecated
4024 AVCodec *av_codec_next(const AVCodec *c);
4025 #endif
4026
4027 /**
4028  * Return the LIBAVCODEC_VERSION_INT constant.
4029  */
4030 unsigned avcodec_version(void);
4031
4032 /**
4033  * Return the libavcodec build-time configuration.
4034  */
4035 const char *avcodec_configuration(void);
4036
4037 /**
4038  * Return the libavcodec license.
4039  */
4040 const char *avcodec_license(void);
4041
4042 #if FF_API_NEXT
4043 /**
4044  * Register the codec codec and initialize libavcodec.
4045  *
4046  * @warning either this function or avcodec_register_all() must be called
4047  * before any other libavcodec functions.
4048  *
4049  * @see avcodec_register_all()
4050  */
4051 attribute_deprecated
4052 void avcodec_register(AVCodec *codec);
4053
4054 /**
4055  * Register all the codecs, parsers and bitstream filters which were enabled at
4056  * configuration time. If you do not call this function you can select exactly
4057  * which formats you want to support, by using the individual registration
4058  * functions.
4059  *
4060  * @see avcodec_register
4061  * @see av_register_codec_parser
4062  * @see av_register_bitstream_filter
4063  */
4064 attribute_deprecated
4065 void avcodec_register_all(void);
4066 #endif
4067
4068 /**
4069  * Allocate an AVCodecContext and set its fields to default values. The
4070  * resulting struct should be freed with avcodec_free_context().
4071  *
4072  * @param codec if non-NULL, allocate private data and initialize defaults
4073  *              for the given codec. It is illegal to then call avcodec_open2()
4074  *              with a different codec.
4075  *              If NULL, then the codec-specific defaults won't be initialized,
4076  *              which may result in suboptimal default settings (this is
4077  *              important mainly for encoders, e.g. libx264).
4078  *
4079  * @return An AVCodecContext filled with default values or NULL on failure.
4080  */
4081 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4082
4083 /**
4084  * Free the codec context and everything associated with it and write NULL to
4085  * the provided pointer.
4086  */
4087 void avcodec_free_context(AVCodecContext **avctx);
4088
4089 #if FF_API_GET_CONTEXT_DEFAULTS
4090 /**
4091  * @deprecated This function should not be used, as closing and opening a codec
4092  * context multiple time is not supported. A new codec context should be
4093  * allocated for each new use.
4094  */
4095 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4096 #endif
4097
4098 /**
4099  * Get the AVClass for AVCodecContext. It can be used in combination with
4100  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4101  *
4102  * @see av_opt_find().
4103  */
4104 const AVClass *avcodec_get_class(void);
4105
4106 #if FF_API_COPY_CONTEXT
4107 /**
4108  * Get the AVClass for AVFrame. It can be used in combination with
4109  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4110  *
4111  * @see av_opt_find().
4112  */
4113 const AVClass *avcodec_get_frame_class(void);
4114
4115 /**
4116  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4117  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4118  *
4119  * @see av_opt_find().
4120  */
4121 const AVClass *avcodec_get_subtitle_rect_class(void);
4122
4123 /**
4124  * Copy the settings of the source AVCodecContext into the destination
4125  * AVCodecContext. The resulting destination codec context will be
4126  * unopened, i.e. you are required to call avcodec_open2() before you
4127  * can use this AVCodecContext to decode/encode video/audio data.
4128  *
4129  * @param dest target codec context, should be initialized with
4130  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
4131  * @param src source codec context
4132  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4133  *
4134  * @deprecated The semantics of this function are ill-defined and it should not
4135  * be used. If you need to transfer the stream parameters from one codec context
4136  * to another, use an intermediate AVCodecParameters instance and the
4137  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4138  * functions.
4139  */
4140 attribute_deprecated
4141 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4142 #endif
4143
4144 /**
4145  * Allocate a new AVCodecParameters and set its fields to default values
4146  * (unknown/invalid/0). The returned struct must be freed with
4147  * avcodec_parameters_free().
4148  */
4149 AVCodecParameters *avcodec_parameters_alloc(void);
4150
4151 /**
4152  * Free an AVCodecParameters instance and everything associated with it and
4153  * write NULL to the supplied pointer.
4154  */
4155 void avcodec_parameters_free(AVCodecParameters **par);
4156
4157 /**
4158  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4159  * replaced with newly allocated duplicates of the corresponding fields in src.
4160  *
4161  * @return >= 0 on success, a negative AVERROR code on failure.
4162  */
4163 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4164
4165 /**
4166  * Fill the parameters struct based on the values from the supplied codec
4167  * context. Any allocated fields in par are freed and replaced with duplicates
4168  * of the corresponding fields in codec.
4169  *
4170  * @return >= 0 on success, a negative AVERROR code on failure
4171  */
4172 int avcodec_parameters_from_context(AVCodecParameters *par,
4173                                     const AVCodecContext *codec);
4174
4175 /**
4176  * Fill the codec context based on the values from the supplied codec
4177  * parameters. Any allocated fields in codec that have a corresponding field in
4178  * par are freed and replaced with duplicates of the corresponding field in par.
4179  * Fields in codec that do not have a counterpart in par are not touched.
4180  *
4181  * @return >= 0 on success, a negative AVERROR code on failure.
4182  */
4183 int avcodec_parameters_to_context(AVCodecContext *codec,
4184                                   const AVCodecParameters *par);
4185
4186 /**
4187  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4188  * function the context has to be allocated with avcodec_alloc_context3().
4189  *
4190  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4191  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4192  * retrieving a codec.
4193  *
4194  * @warning This function is not thread safe!
4195  *
4196  * @note Always call this function before using decoding routines (such as
4197  * @ref avcodec_receive_frame()).
4198  *
4199  * @code
4200  * avcodec_register_all();
4201  * av_dict_set(&opts, "b", "2.5M", 0);
4202  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4203  * if (!codec)
4204  *     exit(1);
4205  *
4206  * context = avcodec_alloc_context3(codec);
4207  *
4208  * if (avcodec_open2(context, codec, opts) < 0)
4209  *     exit(1);
4210  * @endcode
4211  *
4212  * @param avctx The context to initialize.
4213  * @param codec The codec to open this context for. If a non-NULL codec has been
4214  *              previously passed to avcodec_alloc_context3() or
4215  *              for this context, then this parameter MUST be either NULL or
4216  *              equal to the previously passed codec.
4217  * @param options A dictionary filled with AVCodecContext and codec-private options.
4218  *                On return this object will be filled with options that were not found.
4219  *
4220  * @return zero on success, a negative value on error
4221  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4222  *      av_dict_set(), av_opt_find().
4223  */
4224 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4225
4226 /**
4227  * Close a given AVCodecContext and free all the data associated with it
4228  * (but not the AVCodecContext itself).
4229  *
4230  * Calling this function on an AVCodecContext that hasn't been opened will free
4231  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4232  * codec. Subsequent calls will do nothing.
4233  *
4234  * @note Do not use this function. Use avcodec_free_context() to destroy a
4235  * codec context (either open or closed). Opening and closing a codec context
4236  * multiple times is not supported anymore -- use multiple codec contexts
4237  * instead.
4238  */
4239 int avcodec_close(AVCodecContext *avctx);
4240
4241 /**
4242  * Free all allocated data in the given subtitle struct.
4243  *
4244  * @param sub AVSubtitle to free.
4245  */
4246 void avsubtitle_free(AVSubtitle *sub);
4247
4248 /**
4249  * @}
4250  */
4251
4252 /**
4253  * @addtogroup lavc_packet
4254  * @{
4255  */
4256
4257 /**
4258  * Allocate an AVPacket and set its fields to default values.  The resulting
4259  * struct must be freed using av_packet_free().
4260  *
4261  * @return An AVPacket filled with default values or NULL on failure.
4262  *
4263  * @note this only allocates the AVPacket itself, not the data buffers. Those
4264  * must be allocated through other means such as av_new_packet.
4265  *
4266  * @see av_new_packet
4267  */
4268 AVPacket *av_packet_alloc(void);
4269
4270 /**
4271  * Create a new packet that references the same data as src.
4272  *
4273  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4274  *
4275  * @return newly created AVPacket on success, NULL on error.
4276  *
4277  * @see av_packet_alloc
4278  * @see av_packet_ref
4279  */
4280 AVPacket *av_packet_clone(const AVPacket *src);
4281
4282 /**
4283  * Free the packet, if the packet is reference counted, it will be
4284  * unreferenced first.
4285  *
4286  * @param pkt packet to be freed. The pointer will be set to NULL.
4287  * @note passing NULL is a no-op.
4288  */
4289 void av_packet_free(AVPacket **pkt);
4290
4291 /**
4292  * Initialize optional fields of a packet with default values.
4293  *
4294  * Note, this does not touch the data and size members, which have to be
4295  * initialized separately.
4296  *
4297  * @param pkt packet
4298  */
4299 void av_init_packet(AVPacket *pkt);
4300
4301 /**
4302  * Allocate the payload of a packet and initialize its fields with
4303  * default values.
4304  *
4305  * @param pkt packet
4306  * @param size wanted payload size
4307  * @return 0 if OK, AVERROR_xxx otherwise
4308  */
4309 int av_new_packet(AVPacket *pkt, int size);
4310
4311 /**
4312  * Reduce packet size, correctly zeroing padding
4313  *
4314  * @param pkt packet
4315  * @param size new size
4316  */
4317 void av_shrink_packet(AVPacket *pkt, int size);
4318
4319 /**
4320  * Increase packet size, correctly zeroing padding
4321  *
4322  * @param pkt packet
4323  * @param grow_by number of bytes by which to increase the size of the packet
4324  */
4325 int av_grow_packet(AVPacket *pkt, int grow_by);
4326
4327 /**
4328  * Initialize a reference-counted packet from av_malloc()ed data.
4329  *
4330  * @param pkt packet to be initialized. This function will set the data, size,
4331  *        buf and destruct fields, all others are left untouched.
4332  * @param data Data allocated by av_malloc() to be used as packet data. If this
4333  *        function returns successfully, the data is owned by the underlying AVBuffer.
4334  *        The caller may not access the data through other means.
4335  * @param size size of data in bytes, without the padding. I.e. the full buffer
4336  *        size is assumed to be size + AV_INPUT_BUFFER_PADDING_SIZE.
4337  *
4338  * @return 0 on success, a negative AVERROR on error
4339  */
4340 int av_packet_from_data(AVPacket *pkt, uint8_t *data, int size);
4341
4342 #if FF_API_AVPACKET_OLD_API
4343 /**
4344  * @warning This is a hack - the packet memory allocation stuff is broken. The
4345  * packet is allocated if it was not really allocated.
4346  *
4347  * @deprecated Use av_packet_ref
4348  */
4349 attribute_deprecated
4350 int av_dup_packet(AVPacket *pkt);
4351 /**
4352  * Copy packet, including contents
4353  *
4354  * @return 0 on success, negative AVERROR on fail
4355  *
4356  * @deprecated Use av_packet_ref
4357  */
4358 attribute_deprecated
4359 int av_copy_packet(AVPacket *dst, const AVPacket *src);
4360
4361 /**
4362  * Copy packet side data
4363  *
4364  * @return 0 on success, negative AVERROR on fail
4365  *
4366  * @deprecated Use av_packet_copy_props
4367  */
4368 attribute_deprecated
4369 int av_copy_packet_side_data(AVPacket *dst, const AVPacket *src);
4370
4371 /**
4372  * Free a packet.
4373  *
4374  * @deprecated Use av_packet_unref
4375  *
4376  * @param pkt packet to free
4377  */
4378 attribute_deprecated
4379 void av_free_packet(AVPacket *pkt);
4380 #endif
4381 /**
4382  * Allocate new information of a packet.
4383  *
4384  * @param pkt packet
4385  * @param type side information type
4386  * @param size side information size
4387  * @return pointer to fresh allocated data or NULL otherwise
4388  */
4389 uint8_t* av_packet_new_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4390                                  int size);
4391
4392 /**
4393  * Wrap an existing array as a packet side data.
4394  *
4395  * @param pkt packet
4396  * @param type side information type
4397  * @param data the side data array. It must be allocated with the av_malloc()
4398  *             family of functions. The ownership of the data is transferred to
4399  *             pkt.
4400  * @param size side information size
4401  * @return a non-negative number on success, a negative AVERROR code on
4402  *         failure. On failure, the packet is unchanged and the data remains
4403  *         owned by the caller.
4404  */
4405 int av_packet_add_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4406                             uint8_t *data, size_t size);
4407
4408 /**
4409  * Shrink the already allocated side data buffer
4410  *
4411  * @param pkt packet
4412  * @param type side information type
4413  * @param size new side information size
4414  * @return 0 on success, < 0 on failure
4415  */
4416 int av_packet_shrink_side_data(AVPacket *pkt, enum AVPacketSideDataType type,
4417                                int size);
4418
4419 /**
4420  * Get side information from packet.
4421  *
4422  * @param pkt packet
4423  * @param type desired side information type
4424  * @param size pointer for side information size to store (optional)
4425  * @return pointer to data if present or NULL otherwise
4426  */
4427 uint8_t* av_packet_get_side_data(const AVPacket *pkt, enum AVPacketSideDataType type,
4428                                  int *size);
4429
4430 #if FF_API_MERGE_SD_API
4431 attribute_deprecated
4432 int av_packet_merge_side_data(AVPacket *pkt);
4433
4434 attribute_deprecated
4435 int av_packet_split_side_data(AVPacket *pkt);
4436 #endif
4437
4438 const char *av_packet_side_data_name(enum AVPacketSideDataType type);
4439
4440 /**
4441  * Pack a dictionary for use in side_data.
4442  *
4443  * @param dict The dictionary to pack.
4444  * @param size pointer to store the size of the returned data
4445  * @return pointer to data if successful, NULL otherwise
4446  */
4447 uint8_t *av_packet_pack_dictionary(AVDictionary *dict, int *size);
4448 /**
4449  * Unpack a dictionary from side_data.
4450  *
4451  * @param data data from side_data
4452  * @param size size of the data
4453  * @param dict the metadata storage dictionary
4454  * @return 0 on success, < 0 on failure
4455  */
4456 int av_packet_unpack_dictionary(const uint8_t *data, int size, AVDictionary **dict);
4457
4458
4459 /**
4460  * Convenience function to free all the side data stored.
4461  * All the other fields stay untouched.
4462  *
4463  * @param pkt packet
4464  */
4465 void av_packet_free_side_data(AVPacket *pkt);
4466
4467 /**
4468  * Setup a new reference to the data described by a given packet
4469  *
4470  * If src is reference-counted, setup dst as a new reference to the
4471  * buffer in src. Otherwise allocate a new buffer in dst and copy the
4472  * data from src into it.
4473  *
4474  * All the other fields are copied from src.
4475  *
4476  * @see av_packet_unref
4477  *
4478  * @param dst Destination packet
4479  * @param src Source packet
4480  *
4481  * @return 0 on success, a negative AVERROR on error.
4482  */
4483 int av_packet_ref(AVPacket *dst, const AVPacket *src);
4484
4485 /**
4486  * Wipe the packet.
4487  *
4488  * Unreference the buffer referenced by the packet and reset the
4489  * remaining packet fields to their default values.
4490  *
4491  * @param pkt The packet to be unreferenced.
4492  */
4493 void av_packet_unref(AVPacket *pkt);
4494
4495 /**
4496  * Move every field in src to dst and reset src.
4497  *
4498  * @see av_packet_unref
4499  *
4500  * @param src Source packet, will be reset
4501  * @param dst Destination packet
4502  */
4503 void av_packet_move_ref(AVPacket *dst, AVPacket *src);
4504
4505 /**
4506  * Copy only "properties" fields from src to dst.
4507  *
4508  * Properties for the purpose of this function are all the fields
4509  * beside those related to the packet data (buf, data, size)
4510  *
4511  * @param dst Destination packet
4512  * @param src Source packet
4513  *
4514  * @return 0 on success AVERROR on failure.
4515  */
4516 int av_packet_copy_props(AVPacket *dst, const AVPacket *src);
4517
4518 /**
4519  * Convert valid timing fields (timestamps / durations) in a packet from one
4520  * timebase to another. Timestamps with unknown values (AV_NOPTS_VALUE) will be
4521  * ignored.
4522  *
4523  * @param pkt packet on which the conversion will be performed
4524  * @param tb_src source timebase, in which the timing fields in pkt are
4525  *               expressed
4526  * @param tb_dst destination timebase, to which the timing fields will be
4527  *               converted
4528  */
4529 void av_packet_rescale_