sbc: implement SBC encoder (low-complexity subband codec)
[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     AV_CODEC_ID_SBC,
640
641     /* subtitle codecs */
642     AV_CODEC_ID_FIRST_SUBTITLE = 0x17000,          ///< A dummy ID pointing at the start of subtitle codecs.
643     AV_CODEC_ID_DVD_SUBTITLE = 0x17000,
644     AV_CODEC_ID_DVB_SUBTITLE,
645     AV_CODEC_ID_TEXT,  ///< raw UTF-8 text
646     AV_CODEC_ID_XSUB,
647     AV_CODEC_ID_SSA,
648     AV_CODEC_ID_MOV_TEXT,
649     AV_CODEC_ID_HDMV_PGS_SUBTITLE,
650     AV_CODEC_ID_DVB_TELETEXT,
651     AV_CODEC_ID_SRT,
652
653     AV_CODEC_ID_MICRODVD   = 0x17800,
654     AV_CODEC_ID_EIA_608,
655     AV_CODEC_ID_JACOSUB,
656     AV_CODEC_ID_SAMI,
657     AV_CODEC_ID_REALTEXT,
658     AV_CODEC_ID_STL,
659     AV_CODEC_ID_SUBVIEWER1,
660     AV_CODEC_ID_SUBVIEWER,
661     AV_CODEC_ID_SUBRIP,
662     AV_CODEC_ID_WEBVTT,
663     AV_CODEC_ID_MPL2,
664     AV_CODEC_ID_VPLAYER,
665     AV_CODEC_ID_PJS,
666     AV_CODEC_ID_ASS,
667     AV_CODEC_ID_HDMV_TEXT_SUBTITLE,
668
669     /* other specific kind of codecs (generally used for attachments) */
670     AV_CODEC_ID_FIRST_UNKNOWN = 0x18000,           ///< A dummy ID pointing at the start of various fake codecs.
671     AV_CODEC_ID_TTF = 0x18000,
672
673     AV_CODEC_ID_SCTE_35, ///< Contain timestamp estimated through PCR of program stream.
674     AV_CODEC_ID_BINTEXT    = 0x18800,
675     AV_CODEC_ID_XBIN,
676     AV_CODEC_ID_IDF,
677     AV_CODEC_ID_OTF,
678     AV_CODEC_ID_SMPTE_KLV,
679     AV_CODEC_ID_DVD_NAV,
680     AV_CODEC_ID_TIMED_ID3,
681     AV_CODEC_ID_BIN_DATA,
682
683
684     AV_CODEC_ID_PROBE = 0x19000, ///< codec_id is not known (like AV_CODEC_ID_NONE) but lavf should attempt to identify it
685
686     AV_CODEC_ID_MPEG2TS = 0x20000, /**< _FAKE_ codec to indicate a raw MPEG-2 TS
687                                 * stream (only used by libavformat) */
688     AV_CODEC_ID_MPEG4SYSTEMS = 0x20001, /**< _FAKE_ codec to indicate a MPEG-4 Systems
689                                 * stream (only used by libavformat) */
690     AV_CODEC_ID_FFMETADATA = 0x21000,   ///< Dummy codec for streams containing only metadata information.
691     AV_CODEC_ID_WRAPPED_AVFRAME = 0x21001, ///< Passthrough codec, AVFrames wrapped in AVPacket
692 };
693
694 /**
695  * This struct describes the properties of a single codec described by an
696  * AVCodecID.
697  * @see avcodec_descriptor_get()
698  */
699 typedef struct AVCodecDescriptor {
700     enum AVCodecID     id;
701     enum AVMediaType type;
702     /**
703      * Name of the codec described by this descriptor. It is non-empty and
704      * unique for each codec descriptor. It should contain alphanumeric
705      * characters and '_' only.
706      */
707     const char      *name;
708     /**
709      * A more descriptive name for this codec. May be NULL.
710      */
711     const char *long_name;
712     /**
713      * Codec properties, a combination of AV_CODEC_PROP_* flags.
714      */
715     int             props;
716     /**
717      * MIME type(s) associated with the codec.
718      * May be NULL; if not, a NULL-terminated array of MIME types.
719      * The first item is always non-NULL and is the preferred MIME type.
720      */
721     const char *const *mime_types;
722     /**
723      * If non-NULL, an array of profiles recognized for this codec.
724      * Terminated with FF_PROFILE_UNKNOWN.
725      */
726     const struct AVProfile *profiles;
727 } AVCodecDescriptor;
728
729 /**
730  * Codec uses only intra compression.
731  * Video and audio codecs only.
732  */
733 #define AV_CODEC_PROP_INTRA_ONLY    (1 << 0)
734 /**
735  * Codec supports lossy compression. Audio and video codecs only.
736  * @note a codec may support both lossy and lossless
737  * compression modes
738  */
739 #define AV_CODEC_PROP_LOSSY         (1 << 1)
740 /**
741  * Codec supports lossless compression. Audio and video codecs only.
742  */
743 #define AV_CODEC_PROP_LOSSLESS      (1 << 2)
744 /**
745  * Codec supports frame reordering. That is, the coded order (the order in which
746  * the encoded packets are output by the encoders / stored / input to the
747  * decoders) may be different from the presentation order of the corresponding
748  * frames.
749  *
750  * For codecs that do not have this property set, PTS and DTS should always be
751  * equal.
752  */
753 #define AV_CODEC_PROP_REORDER       (1 << 3)
754 /**
755  * Subtitle codec is bitmap based
756  * Decoded AVSubtitle data can be read from the AVSubtitleRect->pict field.
757  */
758 #define AV_CODEC_PROP_BITMAP_SUB    (1 << 16)
759 /**
760  * Subtitle codec is text based.
761  * Decoded AVSubtitle data can be read from the AVSubtitleRect->ass field.
762  */
763 #define AV_CODEC_PROP_TEXT_SUB      (1 << 17)
764
765 /**
766  * @ingroup lavc_decoding
767  * Required number of additionally allocated bytes at the end of the input bitstream for decoding.
768  * This is mainly needed because some optimized bitstream readers read
769  * 32 or 64 bit at once and could read over the end.<br>
770  * Note: If the first 23 bits of the additional bytes are not 0, then damaged
771  * MPEG bitstreams could cause overread and segfault.
772  */
773 #define AV_INPUT_BUFFER_PADDING_SIZE 64
774
775 /**
776  * @ingroup lavc_encoding
777  * minimum encoding buffer size
778  * Used to avoid some checks during header writing.
779  */
780 #define AV_INPUT_BUFFER_MIN_SIZE 16384
781
782 /**
783  * @ingroup lavc_decoding
784  */
785 enum AVDiscard{
786     /* We leave some space between them for extensions (drop some
787      * keyframes for intra-only or drop just some bidir frames). */
788     AVDISCARD_NONE    =-16, ///< discard nothing
789     AVDISCARD_DEFAULT =  0, ///< discard useless packets like 0 size packets in avi
790     AVDISCARD_NONREF  =  8, ///< discard all non reference
791     AVDISCARD_BIDIR   = 16, ///< discard all bidirectional frames
792     AVDISCARD_NONINTRA= 24, ///< discard all non intra frames
793     AVDISCARD_NONKEY  = 32, ///< discard all frames except keyframes
794     AVDISCARD_ALL     = 48, ///< discard all
795 };
796
797 enum AVAudioServiceType {
798     AV_AUDIO_SERVICE_TYPE_MAIN              = 0,
799     AV_AUDIO_SERVICE_TYPE_EFFECTS           = 1,
800     AV_AUDIO_SERVICE_TYPE_VISUALLY_IMPAIRED = 2,
801     AV_AUDIO_SERVICE_TYPE_HEARING_IMPAIRED  = 3,
802     AV_AUDIO_SERVICE_TYPE_DIALOGUE          = 4,
803     AV_AUDIO_SERVICE_TYPE_COMMENTARY        = 5,
804     AV_AUDIO_SERVICE_TYPE_EMERGENCY         = 6,
805     AV_AUDIO_SERVICE_TYPE_VOICE_OVER        = 7,
806     AV_AUDIO_SERVICE_TYPE_KARAOKE           = 8,
807     AV_AUDIO_SERVICE_TYPE_NB                   , ///< Not part of ABI
808 };
809
810 /**
811  * @ingroup lavc_encoding
812  */
813 typedef struct RcOverride{
814     int start_frame;
815     int end_frame;
816     int qscale; // If this is 0 then quality_factor will be used instead.
817     float quality_factor;
818 } RcOverride;
819
820 /* encoding support
821    These flags can be passed in AVCodecContext.flags before initialization.
822    Note: Not everything is supported yet.
823 */
824
825 /**
826  * Allow decoders to produce frames with data planes that are not aligned
827  * to CPU requirements (e.g. due to cropping).
828  */
829 #define AV_CODEC_FLAG_UNALIGNED       (1 <<  0)
830 /**
831  * Use fixed qscale.
832  */
833 #define AV_CODEC_FLAG_QSCALE          (1 <<  1)
834 /**
835  * 4 MV per MB allowed / advanced prediction for H.263.
836  */
837 #define AV_CODEC_FLAG_4MV             (1 <<  2)
838 /**
839  * Output even those frames that might be corrupted.
840  */
841 #define AV_CODEC_FLAG_OUTPUT_CORRUPT  (1 <<  3)
842 /**
843  * Use qpel MC.
844  */
845 #define AV_CODEC_FLAG_QPEL            (1 <<  4)
846 /**
847  * Use internal 2pass ratecontrol in first pass mode.
848  */
849 #define AV_CODEC_FLAG_PASS1           (1 <<  9)
850 /**
851  * Use internal 2pass ratecontrol in second pass mode.
852  */
853 #define AV_CODEC_FLAG_PASS2           (1 << 10)
854 /**
855  * loop filter.
856  */
857 #define AV_CODEC_FLAG_LOOP_FILTER     (1 << 11)
858 /**
859  * Only decode/encode grayscale.
860  */
861 #define AV_CODEC_FLAG_GRAY            (1 << 13)
862 /**
863  * error[?] variables will be set during encoding.
864  */
865 #define AV_CODEC_FLAG_PSNR            (1 << 15)
866 /**
867  * Input bitstream might be truncated at a random location
868  * instead of only at frame boundaries.
869  */
870 #define AV_CODEC_FLAG_TRUNCATED       (1 << 16)
871 /**
872  * Use interlaced DCT.
873  */
874 #define AV_CODEC_FLAG_INTERLACED_DCT  (1 << 18)
875 /**
876  * Force low delay.
877  */
878 #define AV_CODEC_FLAG_LOW_DELAY       (1 << 19)
879 /**
880  * Place global headers in extradata instead of every keyframe.
881  */
882 #define AV_CODEC_FLAG_GLOBAL_HEADER   (1 << 22)
883 /**
884  * Use only bitexact stuff (except (I)DCT).
885  */
886 #define AV_CODEC_FLAG_BITEXACT        (1 << 23)
887 /* Fx : Flag for H.263+ extra options */
888 /**
889  * H.263 advanced intra coding / MPEG-4 AC prediction
890  */
891 #define AV_CODEC_FLAG_AC_PRED         (1 << 24)
892 /**
893  * interlaced motion estimation
894  */
895 #define AV_CODEC_FLAG_INTERLACED_ME   (1 << 29)
896 #define AV_CODEC_FLAG_CLOSED_GOP      (1U << 31)
897
898 /**
899  * Allow non spec compliant speedup tricks.
900  */
901 #define AV_CODEC_FLAG2_FAST           (1 <<  0)
902 /**
903  * Skip bitstream encoding.
904  */
905 #define AV_CODEC_FLAG2_NO_OUTPUT      (1 <<  2)
906 /**
907  * Place global headers at every keyframe instead of in extradata.
908  */
909 #define AV_CODEC_FLAG2_LOCAL_HEADER   (1 <<  3)
910
911 /**
912  * timecode is in drop frame format. DEPRECATED!!!!
913  */
914 #define AV_CODEC_FLAG2_DROP_FRAME_TIMECODE (1 << 13)
915
916 /**
917  * Input bitstream might be truncated at a packet boundaries
918  * instead of only at frame boundaries.
919  */
920 #define AV_CODEC_FLAG2_CHUNKS         (1 << 15)
921 /**
922  * Discard cropping information from SPS.
923  */
924 #define AV_CODEC_FLAG2_IGNORE_CROP    (1 << 16)
925
926 /**
927  * Show all frames before the first keyframe
928  */
929 #define AV_CODEC_FLAG2_SHOW_ALL       (1 << 22)
930 /**
931  * Export motion vectors through frame side data
932  */
933 #define AV_CODEC_FLAG2_EXPORT_MVS     (1 << 28)
934 /**
935  * Do not skip samples and export skip information as frame side data
936  */
937 #define AV_CODEC_FLAG2_SKIP_MANUAL    (1 << 29)
938 /**
939  * Do not reset ASS ReadOrder field on flush (subtitles decoding)
940  */
941 #define AV_CODEC_FLAG2_RO_FLUSH_NOOP  (1 << 30)
942
943 /* Unsupported options :
944  *              Syntax Arithmetic coding (SAC)
945  *              Reference Picture Selection
946  *              Independent Segment Decoding */
947 /* /Fx */
948 /* codec capabilities */
949
950 /**
951  * Decoder can use draw_horiz_band callback.
952  */
953 #define AV_CODEC_CAP_DRAW_HORIZ_BAND     (1 <<  0)
954 /**
955  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
956  * If not set, it might not use get_buffer() at all or use operations that
957  * assume the buffer was allocated by avcodec_default_get_buffer.
958  */
959 #define AV_CODEC_CAP_DR1                 (1 <<  1)
960 #define AV_CODEC_CAP_TRUNCATED           (1 <<  3)
961 /**
962  * Encoder or decoder requires flushing with NULL input at the end in order to
963  * give the complete and correct output.
964  *
965  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
966  *       with NULL data. The user can still send NULL data to the public encode
967  *       or decode function, but libavcodec will not pass it along to the codec
968  *       unless this flag is set.
969  *
970  * Decoders:
971  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
972  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
973  * returns frames.
974  *
975  * Encoders:
976  * The encoder needs to be fed with NULL data at the end of encoding until the
977  * encoder no longer returns data.
978  *
979  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
980  *       flag also means that the encoder must set the pts and duration for
981  *       each output packet. If this flag is not set, the pts and duration will
982  *       be determined by libavcodec from the input frame.
983  */
984 #define AV_CODEC_CAP_DELAY               (1 <<  5)
985 /**
986  * Codec can be fed a final frame with a smaller size.
987  * This can be used to prevent truncation of the last audio samples.
988  */
989 #define AV_CODEC_CAP_SMALL_LAST_FRAME    (1 <<  6)
990
991 /**
992  * Codec can output multiple frames per AVPacket
993  * Normally demuxers return one frame at a time, demuxers which do not do
994  * are connected to a parser to split what they return into proper frames.
995  * This flag is reserved to the very rare category of codecs which have a
996  * bitstream that cannot be split into frames without timeconsuming
997  * operations like full decoding. Demuxers carrying such bitstreams thus
998  * may return multiple frames in a packet. This has many disadvantages like
999  * prohibiting stream copy in many cases thus it should only be considered
1000  * as a last resort.
1001  */
1002 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1003 /**
1004  * Codec is experimental and is thus avoided in favor of non experimental
1005  * encoders
1006  */
1007 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1008 /**
1009  * Codec should fill in channel configuration and samplerate instead of container
1010  */
1011 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1012 /**
1013  * Codec supports frame-level multithreading.
1014  */
1015 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1016 /**
1017  * Codec supports slice-based (or partition-based) multithreading.
1018  */
1019 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1020 /**
1021  * Codec supports changed parameters at any point.
1022  */
1023 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1024 /**
1025  * Codec supports avctx->thread_count == 0 (auto).
1026  */
1027 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1028 /**
1029  * Audio encoder supports receiving a different number of samples in each call.
1030  */
1031 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1032 /**
1033  * Decoder is not a preferred choice for probing.
1034  * This indicates that the decoder is not a good choice for probing.
1035  * It could for example be an expensive to spin up hardware decoder,
1036  * or it could simply not provide a lot of useful information about
1037  * the stream.
1038  * A decoder marked with this flag should only be used as last resort
1039  * choice for probing.
1040  */
1041 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
1042 /**
1043  * Codec is intra only.
1044  */
1045 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1046 /**
1047  * Codec is lossless.
1048  */
1049 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1050
1051 /**
1052  * Codec is backed by a hardware implementation. Typically used to
1053  * identify a non-hwaccel hardware decoder. For information about hwaccels, use
1054  * avcodec_get_hw_config() instead.
1055  */
1056 #define AV_CODEC_CAP_HARDWARE            (1 << 18)
1057
1058 /**
1059  * Codec is potentially backed by a hardware implementation, but not
1060  * necessarily. This is used instead of AV_CODEC_CAP_HARDWARE, if the
1061  * implementation provides some sort of internal fallback.
1062  */
1063 #define AV_CODEC_CAP_HYBRID              (1 << 19)
1064
1065 /**
1066  * Pan Scan area.
1067  * This specifies the area which should be displayed.
1068  * Note there may be multiple such areas for one frame.
1069  */
1070 typedef struct AVPanScan {
1071     /**
1072      * id
1073      * - encoding: Set by user.
1074      * - decoding: Set by libavcodec.
1075      */
1076     int id;
1077
1078     /**
1079      * width and height in 1/16 pel
1080      * - encoding: Set by user.
1081      * - decoding: Set by libavcodec.
1082      */
1083     int width;
1084     int height;
1085
1086     /**
1087      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1088      * - encoding: Set by user.
1089      * - decoding: Set by libavcodec.
1090      */
1091     int16_t position[3][2];
1092 } AVPanScan;
1093
1094 /**
1095  * This structure describes the bitrate properties of an encoded bitstream. It
1096  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1097  * parameters for H.264/HEVC.
1098  */
1099 typedef struct AVCPBProperties {
1100     /**
1101      * Maximum bitrate of the stream, in bits per second.
1102      * Zero if unknown or unspecified.
1103      */
1104     int max_bitrate;
1105     /**
1106      * Minimum bitrate of the stream, in bits per second.
1107      * Zero if unknown or unspecified.
1108      */
1109     int min_bitrate;
1110     /**
1111      * Average bitrate of the stream, in bits per second.
1112      * Zero if unknown or unspecified.
1113      */
1114     int avg_bitrate;
1115
1116     /**
1117      * The size of the buffer to which the ratecontrol is applied, in bits.
1118      * Zero if unknown or unspecified.
1119      */
1120     int buffer_size;
1121
1122     /**
1123      * The delay between the time the packet this structure is associated with
1124      * is received and the time when it should be decoded, in periods of a 27MHz
1125      * clock.
1126      *
1127      * UINT64_MAX when unknown or unspecified.
1128      */
1129     uint64_t vbv_delay;
1130 } AVCPBProperties;
1131
1132 /**
1133  * The decoder will keep a reference to the frame and may reuse it later.
1134  */
1135 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1136
1137 /**
1138  * @defgroup lavc_packet AVPacket
1139  *
1140  * Types and functions for working with AVPacket.
1141  * @{
1142  */
1143 enum AVPacketSideDataType {
1144     /**
1145      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1146      * bytes worth of palette. This side data signals that a new palette is
1147      * present.
1148      */
1149     AV_PKT_DATA_PALETTE,
1150
1151     /**
1152      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1153      * that the extradata buffer was changed and the receiving side should
1154      * act upon it appropriately. The new extradata is embedded in the side
1155      * data buffer and should be immediately used for processing the current
1156      * frame or packet.
1157      */
1158     AV_PKT_DATA_NEW_EXTRADATA,
1159
1160     /**
1161      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1162      * @code
1163      * u32le param_flags
1164      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1165      *     s32le channel_count
1166      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1167      *     u64le channel_layout
1168      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1169      *     s32le sample_rate
1170      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1171      *     s32le width
1172      *     s32le height
1173      * @endcode
1174      */
1175     AV_PKT_DATA_PARAM_CHANGE,
1176
1177     /**
1178      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1179      * structures with info about macroblocks relevant to splitting the
1180      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1181      * That is, it does not necessarily contain info about all macroblocks,
1182      * as long as the distance between macroblocks in the info is smaller
1183      * than the target payload size.
1184      * Each MB info structure is 12 bytes, and is laid out as follows:
1185      * @code
1186      * u32le bit offset from the start of the packet
1187      * u8    current quantizer at the start of the macroblock
1188      * u8    GOB number
1189      * u16le macroblock address within the GOB
1190      * u8    horizontal MV predictor
1191      * u8    vertical MV predictor
1192      * u8    horizontal MV predictor for block number 3
1193      * u8    vertical MV predictor for block number 3
1194      * @endcode
1195      */
1196     AV_PKT_DATA_H263_MB_INFO,
1197
1198     /**
1199      * This side data should be associated with an audio stream and contains
1200      * ReplayGain information in form of the AVReplayGain struct.
1201      */
1202     AV_PKT_DATA_REPLAYGAIN,
1203
1204     /**
1205      * This side data contains a 3x3 transformation matrix describing an affine
1206      * transformation that needs to be applied to the decoded video frames for
1207      * correct presentation.
1208      *
1209      * See libavutil/display.h for a detailed description of the data.
1210      */
1211     AV_PKT_DATA_DISPLAYMATRIX,
1212
1213     /**
1214      * This side data should be associated with a video stream and contains
1215      * Stereoscopic 3D information in form of the AVStereo3D struct.
1216      */
1217     AV_PKT_DATA_STEREO3D,
1218
1219     /**
1220      * This side data should be associated with an audio stream and corresponds
1221      * to enum AVAudioServiceType.
1222      */
1223     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1224
1225     /**
1226      * This side data contains quality related information from the encoder.
1227      * @code
1228      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1229      * u8    picture type
1230      * u8    error count
1231      * u16   reserved
1232      * u64le[error count] sum of squared differences between encoder in and output
1233      * @endcode
1234      */
1235     AV_PKT_DATA_QUALITY_STATS,
1236
1237     /**
1238      * This side data contains an integer value representing the stream index
1239      * of a "fallback" track.  A fallback track indicates an alternate
1240      * track to use when the current track can not be decoded for some reason.
1241      * e.g. no decoder available for codec.
1242      */
1243     AV_PKT_DATA_FALLBACK_TRACK,
1244
1245     /**
1246      * This side data corresponds to the AVCPBProperties struct.
1247      */
1248     AV_PKT_DATA_CPB_PROPERTIES,
1249
1250     /**
1251      * Recommmends skipping the specified number of samples
1252      * @code
1253      * u32le number of samples to skip from start of this packet
1254      * u32le number of samples to skip from end of this packet
1255      * u8    reason for start skip
1256      * u8    reason for end   skip (0=padding silence, 1=convergence)
1257      * @endcode
1258      */
1259     AV_PKT_DATA_SKIP_SAMPLES,
1260
1261     /**
1262      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1263      * the packet may contain "dual mono" audio specific to Japanese DTV
1264      * and if it is true, recommends only the selected channel to be used.
1265      * @code
1266      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1267      * @endcode
1268      */
1269     AV_PKT_DATA_JP_DUALMONO,
1270
1271     /**
1272      * A list of zero terminated key/value strings. There is no end marker for
1273      * the list, so it is required to rely on the side data size to stop.
1274      */
1275     AV_PKT_DATA_STRINGS_METADATA,
1276
1277     /**
1278      * Subtitle event position
1279      * @code
1280      * u32le x1
1281      * u32le y1
1282      * u32le x2
1283      * u32le y2
1284      * @endcode
1285      */
1286     AV_PKT_DATA_SUBTITLE_POSITION,
1287
1288     /**
1289      * Data found in BlockAdditional element of matroska container. There is
1290      * no end marker for the data, so it is required to rely on the side data
1291      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1292      * by data.
1293      */
1294     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1295
1296     /**
1297      * The optional first identifier line of a WebVTT cue.
1298      */
1299     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1300
1301     /**
1302      * The optional settings (rendering instructions) that immediately
1303      * follow the timestamp specifier of a WebVTT cue.
1304      */
1305     AV_PKT_DATA_WEBVTT_SETTINGS,
1306
1307     /**
1308      * A list of zero terminated key/value strings. There is no end marker for
1309      * the list, so it is required to rely on the side data size to stop. This
1310      * side data includes updated metadata which appeared in the stream.
1311      */
1312     AV_PKT_DATA_METADATA_UPDATE,
1313
1314     /**
1315      * MPEGTS stream ID, this is required to pass the stream ID
1316      * information from the demuxer to the corresponding muxer.
1317      */
1318     AV_PKT_DATA_MPEGTS_STREAM_ID,
1319
1320     /**
1321      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1322      * should be associated with a video stream and contains data in the form
1323      * of the AVMasteringDisplayMetadata struct.
1324      */
1325     AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1326
1327     /**
1328      * This side data should be associated with a video stream and corresponds
1329      * to the AVSphericalMapping structure.
1330      */
1331     AV_PKT_DATA_SPHERICAL,
1332
1333     /**
1334      * Content light level (based on CTA-861.3). This metadata should be
1335      * associated with a video stream and contains data in the form of the
1336      * AVContentLightMetadata struct.
1337      */
1338     AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1339
1340     /**
1341      * ATSC A53 Part 4 Closed Captions. This metadata should be associated with
1342      * a video stream. A53 CC bitstream is stored as uint8_t in AVPacketSideData.data.
1343      * The number of bytes of CC data is AVPacketSideData.size.
1344      */
1345     AV_PKT_DATA_A53_CC,
1346
1347     /**
1348      * The number of side data types.
1349      * This is not part of the public API/ABI in the sense that it may
1350      * change when new side data types are added.
1351      * This must stay the last enum value.
1352      * If its value becomes huge, some code using it
1353      * needs to be updated as it assumes it to be smaller than other limits.
1354      */
1355     AV_PKT_DATA_NB
1356 };
1357
1358 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1359
1360 typedef struct AVPacketSideData {
1361     uint8_t *data;
1362     int      size;
1363     enum AVPacketSideDataType type;
1364 } AVPacketSideData;
1365
1366 /**
1367  * This structure stores compressed data. It is typically exported by demuxers
1368  * and then passed as input to decoders, or received as output from encoders and
1369  * then passed to muxers.
1370  *
1371  * For video, it should typically contain one compressed frame. For audio it may
1372  * contain several compressed frames. Encoders are allowed to output empty
1373  * packets, with no compressed data, containing only side data
1374  * (e.g. to update some stream parameters at the end of encoding).
1375  *
1376  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1377  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1378  * without libavcodec and libavformat major bump.
1379  *
1380  * The semantics of data ownership depends on the buf field.
1381  * If it is set, the packet data is dynamically allocated and is
1382  * valid indefinitely until a call to av_packet_unref() reduces the
1383  * reference count to 0.
1384  *
1385  * If the buf field is not set av_packet_ref() would make a copy instead
1386  * of increasing the reference count.
1387  *
1388  * The side data is always allocated with av_malloc(), copied by
1389  * av_packet_ref() and freed by av_packet_unref().
1390  *
1391  * @see av_packet_ref
1392  * @see av_packet_unref
1393  */
1394 typedef struct AVPacket {
1395     /**
1396      * A reference to the reference-counted buffer where the packet data is
1397      * stored.
1398      * May be NULL, then the packet data is not reference-counted.
1399      */
1400     AVBufferRef *buf;
1401     /**
1402      * Presentation timestamp in AVStream->time_base units; the time at which
1403      * the decompressed packet will be presented to the user.
1404      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1405      * pts MUST be larger or equal to dts as presentation cannot happen before
1406      * decompression, unless one wants to view hex dumps. Some formats misuse
1407      * the terms dts and pts/cts to mean something different. Such timestamps
1408      * must be converted to true pts/dts before they are stored in AVPacket.
1409      */
1410     int64_t pts;
1411     /**
1412      * Decompression timestamp in AVStream->time_base units; the time at which
1413      * the packet is decompressed.
1414      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1415      */
1416     int64_t dts;
1417     uint8_t *data;
1418     int   size;
1419     int   stream_index;
1420     /**
1421      * A combination of AV_PKT_FLAG values
1422      */
1423     int   flags;
1424     /**
1425      * Additional packet data that can be provided by the container.
1426      * Packet can contain several types of side information.
1427      */
1428     AVPacketSideData *side_data;
1429     int side_data_elems;
1430
1431     /**
1432      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1433      * Equals next_pts - this_pts in presentation order.
1434      */
1435     int64_t duration;
1436
1437     int64_t pos;                            ///< byte position in stream, -1 if unknown
1438
1439 #if FF_API_CONVERGENCE_DURATION
1440     /**
1441      * @deprecated Same as the duration field, but as int64_t. This was required
1442      * for Matroska subtitles, whose duration values could overflow when the
1443      * duration field was still an int.
1444      */
1445     attribute_deprecated
1446     int64_t convergence_duration;
1447 #endif
1448 } AVPacket;
1449 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1450 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1451 /**
1452  * Flag is used to discard packets which are required to maintain valid
1453  * decoder state but are not required for output and should be dropped
1454  * after decoding.
1455  **/
1456 #define AV_PKT_FLAG_DISCARD   0x0004
1457 /**
1458  * The packet comes from a trusted source.
1459  *
1460  * Otherwise-unsafe constructs such as arbitrary pointers to data
1461  * outside the packet may be followed.
1462  */
1463 #define AV_PKT_FLAG_TRUSTED   0x0008
1464 /**
1465  * Flag is used to indicate packets that contain frames that can
1466  * be discarded by the decoder.  I.e. Non-reference frames.
1467  */
1468 #define AV_PKT_FLAG_DISPOSABLE 0x0010
1469
1470
1471 enum AVSideDataParamChangeFlags {
1472     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1473     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1474     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1475     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1476 };
1477 /**
1478  * @}
1479  */
1480
1481 struct AVCodecInternal;
1482
1483 enum AVFieldOrder {
1484     AV_FIELD_UNKNOWN,
1485     AV_FIELD_PROGRESSIVE,
1486     AV_FIELD_TT,          //< Top coded_first, top displayed first
1487     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1488     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1489     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1490 };
1491
1492 /**
1493  * main external API structure.
1494  * New fields can be added to the end with minor version bumps.
1495  * Removal, reordering and changes to existing fields require a major
1496  * version bump.
1497  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1498  * applications.
1499  * The name string for AVOptions options matches the associated command line
1500  * parameter name and can be found in libavcodec/options_table.h
1501  * The AVOption/command line parameter names differ in some cases from the C
1502  * structure field names for historic reasons or brevity.
1503  * sizeof(AVCodecContext) must not be used outside libav*.
1504  */
1505 typedef struct AVCodecContext {
1506     /**
1507      * information on struct for av_log
1508      * - set by avcodec_alloc_context3
1509      */
1510     const AVClass *av_class;
1511     int log_level_offset;
1512
1513     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1514     const struct AVCodec  *codec;
1515     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1516
1517     /**
1518      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1519      * This is used to work around some encoder bugs.
1520      * A demuxer should set this to what is stored in the field used to identify the codec.
1521      * If there are multiple such fields in a container then the demuxer should choose the one
1522      * which maximizes the information about the used codec.
1523      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1524      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1525      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1526      * first.
1527      * - encoding: Set by user, if not then the default based on codec_id will be used.
1528      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1529      */
1530     unsigned int codec_tag;
1531
1532     void *priv_data;
1533
1534     /**
1535      * Private context used for internal data.
1536      *
1537      * Unlike priv_data, this is not codec-specific. It is used in general
1538      * libavcodec functions.
1539      */
1540     struct AVCodecInternal *internal;
1541
1542     /**
1543      * Private data of the user, can be used to carry app specific stuff.
1544      * - encoding: Set by user.
1545      * - decoding: Set by user.
1546      */
1547     void *opaque;
1548
1549     /**
1550      * the average bitrate
1551      * - encoding: Set by user; unused for constant quantizer encoding.
1552      * - decoding: Set by user, may be overwritten by libavcodec
1553      *             if this info is available in the stream
1554      */
1555     int64_t bit_rate;
1556
1557     /**
1558      * number of bits the bitstream is allowed to diverge from the reference.
1559      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1560      * - encoding: Set by user; unused for constant quantizer encoding.
1561      * - decoding: unused
1562      */
1563     int bit_rate_tolerance;
1564
1565     /**
1566      * Global quality for codecs which cannot change it per frame.
1567      * This should be proportional to MPEG-1/2/4 qscale.
1568      * - encoding: Set by user.
1569      * - decoding: unused
1570      */
1571     int global_quality;
1572
1573     /**
1574      * - encoding: Set by user.
1575      * - decoding: unused
1576      */
1577     int compression_level;
1578 #define FF_COMPRESSION_DEFAULT -1
1579
1580     /**
1581      * AV_CODEC_FLAG_*.
1582      * - encoding: Set by user.
1583      * - decoding: Set by user.
1584      */
1585     int flags;
1586
1587     /**
1588      * AV_CODEC_FLAG2_*
1589      * - encoding: Set by user.
1590      * - decoding: Set by user.
1591      */
1592     int flags2;
1593
1594     /**
1595      * some codecs need / can use extradata like Huffman tables.
1596      * MJPEG: Huffman tables
1597      * rv10: additional flags
1598      * MPEG-4: global headers (they can be in the bitstream or here)
1599      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1600      * than extradata_size to avoid problems if it is read with the bitstream reader.
1601      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1602      * - encoding: Set/allocated/freed by libavcodec.
1603      * - decoding: Set/allocated/freed by user.
1604      */
1605     uint8_t *extradata;
1606     int extradata_size;
1607
1608     /**
1609      * This is the fundamental unit of time (in seconds) in terms
1610      * of which frame timestamps are represented. For fixed-fps content,
1611      * timebase should be 1/framerate and timestamp increments should be
1612      * identically 1.
1613      * This often, but not always is the inverse of the frame rate or field rate
1614      * for video. 1/time_base is not the average frame rate if the frame rate is not
1615      * constant.
1616      *
1617      * Like containers, elementary streams also can store timestamps, 1/time_base
1618      * is the unit in which these timestamps are specified.
1619      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1620      * vop_time_increment_resolution and fixed_vop_rate
1621      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1622      *
1623      * - encoding: MUST be set by user.
1624      * - decoding: the use of this field for decoding is deprecated.
1625      *             Use framerate instead.
1626      */
1627     AVRational time_base;
1628
1629     /**
1630      * For some codecs, the time base is closer to the field rate than the frame rate.
1631      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1632      * if no telecine is used ...
1633      *
1634      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1635      */
1636     int ticks_per_frame;
1637
1638     /**
1639      * Codec delay.
1640      *
1641      * Encoding: Number of frames delay there will be from the encoder input to
1642      *           the decoder output. (we assume the decoder matches the spec)
1643      * Decoding: Number of frames delay in addition to what a standard decoder
1644      *           as specified in the spec would produce.
1645      *
1646      * Video:
1647      *   Number of frames the decoded output will be delayed relative to the
1648      *   encoded input.
1649      *
1650      * Audio:
1651      *   For encoding, this field is unused (see initial_padding).
1652      *
1653      *   For decoding, this is the number of samples the decoder needs to
1654      *   output before the decoder's output is valid. When seeking, you should
1655      *   start decoding this many samples prior to your desired seek point.
1656      *
1657      * - encoding: Set by libavcodec.
1658      * - decoding: Set by libavcodec.
1659      */
1660     int delay;
1661
1662
1663     /* video only */
1664     /**
1665      * picture width / height.
1666      *
1667      * @note Those fields may not match the values of the last
1668      * AVFrame output by avcodec_decode_video2 due frame
1669      * reordering.
1670      *
1671      * - encoding: MUST be set by user.
1672      * - decoding: May be set by the user before opening the decoder if known e.g.
1673      *             from the container. Some decoders will require the dimensions
1674      *             to be set by the caller. During decoding, the decoder may
1675      *             overwrite those values as required while parsing the data.
1676      */
1677     int width, height;
1678
1679     /**
1680      * Bitstream width / height, may be different from width/height e.g. when
1681      * the decoded frame is cropped before being output or lowres is enabled.
1682      *
1683      * @note Those field may not match the value of the last
1684      * AVFrame output by avcodec_receive_frame() due frame
1685      * reordering.
1686      *
1687      * - encoding: unused
1688      * - decoding: May be set by the user before opening the decoder if known
1689      *             e.g. from the container. During decoding, the decoder may
1690      *             overwrite those values as required while parsing the data.
1691      */
1692     int coded_width, coded_height;
1693
1694     /**
1695      * the number of pictures in a group of pictures, or 0 for intra_only
1696      * - encoding: Set by user.
1697      * - decoding: unused
1698      */
1699     int gop_size;
1700
1701     /**
1702      * Pixel format, see AV_PIX_FMT_xxx.
1703      * May be set by the demuxer if known from headers.
1704      * May be overridden by the decoder if it knows better.
1705      *
1706      * @note This field may not match the value of the last
1707      * AVFrame output by avcodec_receive_frame() due frame
1708      * reordering.
1709      *
1710      * - encoding: Set by user.
1711      * - decoding: Set by user if known, overridden by libavcodec while
1712      *             parsing the data.
1713      */
1714     enum AVPixelFormat pix_fmt;
1715
1716     /**
1717      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1718      * decoder to draw a horizontal band. It improves cache usage. Not
1719      * all codecs can do that. You must check the codec capabilities
1720      * beforehand.
1721      * When multithreading is used, it may be called from multiple threads
1722      * at the same time; threads might draw different parts of the same AVFrame,
1723      * or multiple AVFrames, and there is no guarantee that slices will be drawn
1724      * in order.
1725      * The function is also used by hardware acceleration APIs.
1726      * It is called at least once during frame decoding to pass
1727      * the data needed for hardware render.
1728      * In that mode instead of pixel data, AVFrame points to
1729      * a structure specific to the acceleration API. The application
1730      * reads the structure and can change some fields to indicate progress
1731      * or mark state.
1732      * - encoding: unused
1733      * - decoding: Set by user.
1734      * @param height the height of the slice
1735      * @param y the y position of the slice
1736      * @param type 1->top field, 2->bottom field, 3->frame
1737      * @param offset offset into the AVFrame.data from which the slice should be read
1738      */
1739     void (*draw_horiz_band)(struct AVCodecContext *s,
1740                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
1741                             int y, int type, int height);
1742
1743     /**
1744      * callback to negotiate the pixelFormat
1745      * @param fmt is the list of formats which are supported by the codec,
1746      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
1747      * The first is always the native one.
1748      * @note The callback may be called again immediately if initialization for
1749      * the selected (hardware-accelerated) pixel format failed.
1750      * @warning Behavior is undefined if the callback returns a value not
1751      * in the fmt list of formats.
1752      * @return the chosen format
1753      * - encoding: unused
1754      * - decoding: Set by user, if not set the native format will be chosen.
1755      */
1756     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
1757
1758     /**
1759      * maximum number of B-frames between non-B-frames
1760      * Note: The output will be delayed by max_b_frames+1 relative to the input.
1761      * - encoding: Set by user.
1762      * - decoding: unused
1763      */
1764     int max_b_frames;
1765
1766     /**
1767      * qscale factor between IP and B-frames
1768      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
1769      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1770      * - encoding: Set by user.
1771      * - decoding: unused
1772      */
1773     float b_quant_factor;
1774
1775 #if FF_API_PRIVATE_OPT
1776     /** @deprecated use encoder private options instead */
1777     attribute_deprecated
1778     int b_frame_strategy;
1779 #endif
1780
1781     /**
1782      * qscale offset between IP and B-frames
1783      * - encoding: Set by user.
1784      * - decoding: unused
1785      */
1786     float b_quant_offset;
1787
1788     /**
1789      * Size of the frame reordering buffer in the decoder.
1790      * For MPEG-2 it is 1 IPB or 0 low delay IP.
1791      * - encoding: Set by libavcodec.
1792      * - decoding: Set by libavcodec.
1793      */
1794     int has_b_frames;
1795
1796 #if FF_API_PRIVATE_OPT
1797     /** @deprecated use encoder private options instead */
1798     attribute_deprecated
1799     int mpeg_quant;
1800 #endif
1801
1802     /**
1803      * qscale factor between P- and I-frames
1804      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
1805      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
1806      * - encoding: Set by user.
1807      * - decoding: unused
1808      */
1809     float i_quant_factor;
1810
1811     /**
1812      * qscale offset between P and I-frames
1813      * - encoding: Set by user.
1814      * - decoding: unused
1815      */
1816     float i_quant_offset;
1817
1818     /**
1819      * luminance masking (0-> disabled)
1820      * - encoding: Set by user.
1821      * - decoding: unused
1822      */
1823     float lumi_masking;
1824
1825     /**
1826      * temporary complexity masking (0-> disabled)
1827      * - encoding: Set by user.
1828      * - decoding: unused
1829      */
1830     float temporal_cplx_masking;
1831
1832     /**
1833      * spatial complexity masking (0-> disabled)
1834      * - encoding: Set by user.
1835      * - decoding: unused
1836      */
1837     float spatial_cplx_masking;
1838
1839     /**
1840      * p block masking (0-> disabled)
1841      * - encoding: Set by user.
1842      * - decoding: unused
1843      */
1844     float p_masking;
1845
1846     /**
1847      * darkness masking (0-> disabled)
1848      * - encoding: Set by user.
1849      * - decoding: unused
1850      */
1851     float dark_masking;
1852
1853     /**
1854      * slice count
1855      * - encoding: Set by libavcodec.
1856      * - decoding: Set by user (or 0).
1857      */
1858     int slice_count;
1859
1860 #if FF_API_PRIVATE_OPT
1861     /** @deprecated use encoder private options instead */
1862     attribute_deprecated
1863      int prediction_method;
1864 #define FF_PRED_LEFT   0
1865 #define FF_PRED_PLANE  1
1866 #define FF_PRED_MEDIAN 2
1867 #endif
1868
1869     /**
1870      * slice offsets in the frame in bytes
1871      * - encoding: Set/allocated by libavcodec.
1872      * - decoding: Set/allocated by user (or NULL).
1873      */
1874     int *slice_offset;
1875
1876     /**
1877      * sample aspect ratio (0 if unknown)
1878      * That is the width of a pixel divided by the height of the pixel.
1879      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
1880      * - encoding: Set by user.
1881      * - decoding: Set by libavcodec.
1882      */
1883     AVRational sample_aspect_ratio;
1884
1885     /**
1886      * motion estimation comparison function
1887      * - encoding: Set by user.
1888      * - decoding: unused
1889      */
1890     int me_cmp;
1891     /**
1892      * subpixel motion estimation comparison function
1893      * - encoding: Set by user.
1894      * - decoding: unused
1895      */
1896     int me_sub_cmp;
1897     /**
1898      * macroblock comparison function (not supported yet)
1899      * - encoding: Set by user.
1900      * - decoding: unused
1901      */
1902     int mb_cmp;
1903     /**
1904      * interlaced DCT comparison function
1905      * - encoding: Set by user.
1906      * - decoding: unused
1907      */
1908     int ildct_cmp;
1909 #define FF_CMP_SAD          0
1910 #define FF_CMP_SSE          1
1911 #define FF_CMP_SATD         2
1912 #define FF_CMP_DCT          3
1913 #define FF_CMP_PSNR         4
1914 #define FF_CMP_BIT          5
1915 #define FF_CMP_RD           6
1916 #define FF_CMP_ZERO         7
1917 #define FF_CMP_VSAD         8
1918 #define FF_CMP_VSSE         9
1919 #define FF_CMP_NSSE         10
1920 #define FF_CMP_W53          11
1921 #define FF_CMP_W97          12
1922 #define FF_CMP_DCTMAX       13
1923 #define FF_CMP_DCT264       14
1924 #define FF_CMP_MEDIAN_SAD   15
1925 #define FF_CMP_CHROMA       256
1926
1927     /**
1928      * ME diamond size & shape
1929      * - encoding: Set by user.
1930      * - decoding: unused
1931      */
1932     int dia_size;
1933
1934     /**
1935      * amount of previous MV predictors (2a+1 x 2a+1 square)
1936      * - encoding: Set by user.
1937      * - decoding: unused
1938      */
1939     int last_predictor_count;
1940
1941 #if FF_API_PRIVATE_OPT
1942     /** @deprecated use encoder private options instead */
1943     attribute_deprecated
1944     int pre_me;
1945 #endif
1946
1947     /**
1948      * motion estimation prepass comparison function
1949      * - encoding: Set by user.
1950      * - decoding: unused
1951      */
1952     int me_pre_cmp;
1953
1954     /**
1955      * ME prepass diamond size & shape
1956      * - encoding: Set by user.
1957      * - decoding: unused
1958      */
1959     int pre_dia_size;
1960
1961     /**
1962      * subpel ME quality
1963      * - encoding: Set by user.
1964      * - decoding: unused
1965      */
1966     int me_subpel_quality;
1967
1968     /**
1969      * maximum motion estimation search range in subpel units
1970      * If 0 then no limit.
1971      *
1972      * - encoding: Set by user.
1973      * - decoding: unused
1974      */
1975     int me_range;
1976
1977     /**
1978      * slice flags
1979      * - encoding: unused
1980      * - decoding: Set by user.
1981      */
1982     int slice_flags;
1983 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
1984 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
1985 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
1986
1987     /**
1988      * macroblock decision mode
1989      * - encoding: Set by user.
1990      * - decoding: unused
1991      */
1992     int mb_decision;
1993 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
1994 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
1995 #define FF_MB_DECISION_RD     2        ///< rate distortion
1996
1997     /**
1998      * custom intra quantization matrix
1999      * - encoding: Set by user, can be NULL.
2000      * - decoding: Set by libavcodec.
2001      */
2002     uint16_t *intra_matrix;
2003
2004     /**
2005      * custom inter quantization matrix
2006      * - encoding: Set by user, can be NULL.
2007      * - decoding: Set by libavcodec.
2008      */
2009     uint16_t *inter_matrix;
2010
2011 #if FF_API_PRIVATE_OPT
2012     /** @deprecated use encoder private options instead */
2013     attribute_deprecated
2014     int scenechange_threshold;
2015
2016     /** @deprecated use encoder private options instead */
2017     attribute_deprecated
2018     int noise_reduction;
2019 #endif
2020
2021     /**
2022      * precision of the intra DC coefficient - 8
2023      * - encoding: Set by user.
2024      * - decoding: Set by libavcodec
2025      */
2026     int intra_dc_precision;
2027
2028     /**
2029      * Number of macroblock rows at the top which are skipped.
2030      * - encoding: unused
2031      * - decoding: Set by user.
2032      */
2033     int skip_top;
2034
2035     /**
2036      * Number of macroblock rows at the bottom which are skipped.
2037      * - encoding: unused
2038      * - decoding: Set by user.
2039      */
2040     int skip_bottom;
2041
2042     /**
2043      * minimum MB Lagrange multiplier
2044      * - encoding: Set by user.
2045      * - decoding: unused
2046      */
2047     int mb_lmin;
2048
2049     /**
2050      * maximum MB Lagrange multiplier
2051      * - encoding: Set by user.
2052      * - decoding: unused
2053      */
2054     int mb_lmax;
2055
2056 #if FF_API_PRIVATE_OPT
2057     /**
2058      * @deprecated use encoder private options instead
2059      */
2060     attribute_deprecated
2061     int me_penalty_compensation;
2062 #endif
2063
2064     /**
2065      * - encoding: Set by user.
2066      * - decoding: unused
2067      */
2068     int bidir_refine;
2069
2070 #if FF_API_PRIVATE_OPT
2071     /** @deprecated use encoder private options instead */
2072     attribute_deprecated
2073     int brd_scale;
2074 #endif
2075
2076     /**
2077      * minimum GOP size
2078      * - encoding: Set by user.
2079      * - decoding: unused
2080      */
2081     int keyint_min;
2082
2083     /**
2084      * number of reference frames
2085      * - encoding: Set by user.
2086      * - decoding: Set by lavc.
2087      */
2088     int refs;
2089
2090 #if FF_API_PRIVATE_OPT
2091     /** @deprecated use encoder private options instead */
2092     attribute_deprecated
2093     int chromaoffset;
2094 #endif
2095
2096     /**
2097      * Note: Value depends upon the compare function used for fullpel ME.
2098      * - encoding: Set by user.
2099      * - decoding: unused
2100      */
2101     int mv0_threshold;
2102
2103 #if FF_API_PRIVATE_OPT
2104     /** @deprecated use encoder private options instead */
2105     attribute_deprecated
2106     int b_sensitivity;
2107 #endif
2108
2109     /**
2110      * Chromaticity coordinates of the source primaries.
2111      * - encoding: Set by user
2112      * - decoding: Set by libavcodec
2113      */
2114     enum AVColorPrimaries color_primaries;
2115
2116     /**
2117      * Color Transfer Characteristic.
2118      * - encoding: Set by user
2119      * - decoding: Set by libavcodec
2120      */
2121     enum AVColorTransferCharacteristic color_trc;
2122
2123     /**
2124      * YUV colorspace type.
2125      * - encoding: Set by user
2126      * - decoding: Set by libavcodec
2127      */
2128     enum AVColorSpace colorspace;
2129
2130     /**
2131      * MPEG vs JPEG YUV range.
2132      * - encoding: Set by user
2133      * - decoding: Set by libavcodec
2134      */
2135     enum AVColorRange color_range;
2136
2137     /**
2138      * This defines the location of chroma samples.
2139      * - encoding: Set by user
2140      * - decoding: Set by libavcodec
2141      */
2142     enum AVChromaLocation chroma_sample_location;
2143
2144     /**
2145      * Number of slices.
2146      * Indicates number of picture subdivisions. Used for parallelized
2147      * decoding.
2148      * - encoding: Set by user
2149      * - decoding: unused
2150      */
2151     int slices;
2152
2153     /** Field order
2154      * - encoding: set by libavcodec
2155      * - decoding: Set by user.
2156      */
2157     enum AVFieldOrder field_order;
2158
2159     /* audio only */
2160     int sample_rate; ///< samples per second
2161     int channels;    ///< number of audio channels
2162
2163     /**
2164      * audio sample format
2165      * - encoding: Set by user.
2166      * - decoding: Set by libavcodec.
2167      */
2168     enum AVSampleFormat sample_fmt;  ///< sample format
2169
2170     /* The following data should not be initialized. */
2171     /**
2172      * Number of samples per channel in an audio frame.
2173      *
2174      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2175      *   except the last must contain exactly frame_size samples per channel.
2176      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2177      *   frame size is not restricted.
2178      * - decoding: may be set by some decoders to indicate constant frame size
2179      */
2180     int frame_size;
2181
2182     /**
2183      * Frame counter, set by libavcodec.
2184      *
2185      * - decoding: total number of frames returned from the decoder so far.
2186      * - encoding: total number of frames passed to the encoder so far.
2187      *
2188      *   @note the counter is not incremented if encoding/decoding resulted in
2189      *   an error.
2190      */
2191     int frame_number;
2192
2193     /**
2194      * number of bytes per packet if constant and known or 0
2195      * Used by some WAV based audio codecs.
2196      */
2197     int block_align;
2198
2199     /**
2200      * Audio cutoff bandwidth (0 means "automatic")
2201      * - encoding: Set by user.
2202      * - decoding: unused
2203      */
2204     int cutoff;
2205
2206     /**
2207      * Audio channel layout.
2208      * - encoding: set by user.
2209      * - decoding: set by user, may be overwritten by libavcodec.
2210      */
2211     uint64_t channel_layout;
2212
2213     /**
2214      * Request decoder to use this channel layout if it can (0 for default)
2215      * - encoding: unused
2216      * - decoding: Set by user.
2217      */
2218     uint64_t request_channel_layout;
2219
2220     /**
2221      * Type of service that the audio stream conveys.
2222      * - encoding: Set by user.
2223      * - decoding: Set by libavcodec.
2224      */
2225     enum AVAudioServiceType audio_service_type;
2226
2227     /**
2228      * desired sample format
2229      * - encoding: Not used.
2230      * - decoding: Set by user.
2231      * Decoder will decode to this format if it can.
2232      */
2233     enum AVSampleFormat request_sample_fmt;
2234
2235     /**
2236      * This callback is called at the beginning of each frame to get data
2237      * buffer(s) for it. There may be one contiguous buffer for all the data or
2238      * there may be a buffer per each data plane or anything in between. What
2239      * this means is, you may set however many entries in buf[] you feel necessary.
2240      * Each buffer must be reference-counted using the AVBuffer API (see description
2241      * of buf[] below).
2242      *
2243      * The following fields will be set in the frame before this callback is
2244      * called:
2245      * - format
2246      * - width, height (video only)
2247      * - sample_rate, channel_layout, nb_samples (audio only)
2248      * Their values may differ from the corresponding values in
2249      * AVCodecContext. This callback must use the frame values, not the codec
2250      * context values, to calculate the required buffer size.
2251      *
2252      * This callback must fill the following fields in the frame:
2253      * - data[]
2254      * - linesize[]
2255      * - extended_data:
2256      *   * if the data is planar audio with more than 8 channels, then this
2257      *     callback must allocate and fill extended_data to contain all pointers
2258      *     to all data planes. data[] must hold as many pointers as it can.
2259      *     extended_data must be allocated with av_malloc() and will be freed in
2260      *     av_frame_unref().
2261      *   * otherwise extended_data must point to data
2262      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2263      *   the frame's data and extended_data pointers must be contained in these. That
2264      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2265      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2266      *   and av_buffer_ref().
2267      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2268      *   this callback and filled with the extra buffers if there are more
2269      *   buffers than buf[] can hold. extended_buf will be freed in
2270      *   av_frame_unref().
2271      *
2272      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2273      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2274      * some other means.
2275      *
2276      * Each data plane must be aligned to the maximum required by the target
2277      * CPU.
2278      *
2279      * @see avcodec_default_get_buffer2()
2280      *
2281      * Video:
2282      *
2283      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2284      * (read and/or written to if it is writable) later by libavcodec.
2285      *
2286      * avcodec_align_dimensions2() should be used to find the required width and
2287      * height, as they normally need to be rounded up to the next multiple of 16.
2288      *
2289      * Some decoders do not support linesizes changing between frames.
2290      *
2291      * If frame multithreading is used and thread_safe_callbacks is set,
2292      * this callback may be called from a different thread, but not from more
2293      * than one at once. Does not need to be reentrant.
2294      *
2295      * @see avcodec_align_dimensions2()
2296      *
2297      * Audio:
2298      *
2299      * Decoders request a buffer of a particular size by setting
2300      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2301      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2302      * to a smaller value in the output frame.
2303      *
2304      * As a convenience, av_samples_get_buffer_size() and
2305      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2306      * functions to find the required data size and to fill data pointers and
2307      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2308      * since all planes must be the same size.
2309      *
2310      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2311      *
2312      * - encoding: unused
2313      * - decoding: Set by libavcodec, user can override.
2314      */
2315     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2316
2317     /**
2318      * If non-zero, the decoded audio and video frames returned from
2319      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2320      * and are valid indefinitely. The caller must free them with
2321      * av_frame_unref() when they are not needed anymore.
2322      * Otherwise, the decoded frames must not be freed by the caller and are
2323      * only valid until the next decode call.
2324      *
2325      * This is always automatically enabled if avcodec_receive_frame() is used.
2326      *
2327      * - encoding: unused
2328      * - decoding: set by the caller before avcodec_open2().
2329      */
2330     attribute_deprecated
2331     int refcounted_frames;
2332
2333     /* - encoding parameters */
2334     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2335     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2336
2337     /**
2338      * minimum quantizer
2339      * - encoding: Set by user.
2340      * - decoding: unused
2341      */
2342     int qmin;
2343
2344     /**
2345      * maximum quantizer
2346      * - encoding: Set by user.
2347      * - decoding: unused
2348      */
2349     int qmax;
2350
2351     /**
2352      * maximum quantizer difference between frames
2353      * - encoding: Set by user.
2354      * - decoding: unused
2355      */
2356     int max_qdiff;
2357
2358     /**
2359      * decoder bitstream buffer size
2360      * - encoding: Set by user.
2361      * - decoding: unused
2362      */
2363     int rc_buffer_size;
2364
2365     /**
2366      * ratecontrol override, see RcOverride
2367      * - encoding: Allocated/set/freed by user.
2368      * - decoding: unused
2369      */
2370     int rc_override_count;
2371     RcOverride *rc_override;
2372
2373     /**
2374      * maximum bitrate
2375      * - encoding: Set by user.
2376      * - decoding: Set by user, may be overwritten by libavcodec.
2377      */
2378     int64_t rc_max_rate;
2379
2380     /**
2381      * minimum bitrate
2382      * - encoding: Set by user.
2383      * - decoding: unused
2384      */
2385     int64_t rc_min_rate;
2386
2387     /**
2388      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2389      * - encoding: Set by user.
2390      * - decoding: unused.
2391      */
2392     float rc_max_available_vbv_use;
2393
2394     /**
2395      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2396      * - encoding: Set by user.
2397      * - decoding: unused.
2398      */
2399     float rc_min_vbv_overflow_use;
2400
2401     /**
2402      * Number of bits which should be loaded into the rc buffer before decoding starts.
2403      * - encoding: Set by user.
2404      * - decoding: unused
2405      */
2406     int rc_initial_buffer_occupancy;
2407
2408 #if FF_API_CODER_TYPE
2409 #define FF_CODER_TYPE_VLC       0
2410 #define FF_CODER_TYPE_AC        1
2411 #define FF_CODER_TYPE_RAW       2
2412 #define FF_CODER_TYPE_RLE       3
2413     /**
2414      * @deprecated use encoder private options instead
2415      */
2416     attribute_deprecated
2417     int coder_type;
2418 #endif /* FF_API_CODER_TYPE */
2419
2420 #if FF_API_PRIVATE_OPT
2421     /** @deprecated use encoder private options instead */
2422     attribute_deprecated
2423     int context_model;
2424 #endif
2425
2426 #if FF_API_PRIVATE_OPT
2427     /** @deprecated use encoder private options instead */
2428     attribute_deprecated
2429     int frame_skip_threshold;
2430
2431     /** @deprecated use encoder private options instead */
2432     attribute_deprecated
2433     int frame_skip_factor;
2434
2435     /** @deprecated use encoder private options instead */
2436     attribute_deprecated
2437     int frame_skip_exp;
2438
2439     /** @deprecated use encoder private options instead */
2440     attribute_deprecated
2441     int frame_skip_cmp;
2442 #endif /* FF_API_PRIVATE_OPT */
2443
2444     /**
2445      * trellis RD quantization
2446      * - encoding: Set by user.
2447      * - decoding: unused
2448      */
2449     int trellis;
2450
2451 #if FF_API_PRIVATE_OPT
2452     /** @deprecated use encoder private options instead */
2453     attribute_deprecated
2454     int min_prediction_order;
2455
2456     /** @deprecated use encoder private options instead */
2457     attribute_deprecated
2458     int max_prediction_order;
2459
2460     /** @deprecated use encoder private options instead */
2461     attribute_deprecated
2462     int64_t timecode_frame_start;
2463 #endif
2464
2465 #if FF_API_RTP_CALLBACK
2466     /**
2467      * @deprecated unused
2468      */
2469     /* The RTP callback: This function is called    */
2470     /* every time the encoder has a packet to send. */
2471     /* It depends on the encoder if the data starts */
2472     /* with a Start Code (it should). H.263 does.   */
2473     /* mb_nb contains the number of macroblocks     */
2474     /* encoded in the RTP payload.                  */
2475     attribute_deprecated
2476     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2477 #endif
2478
2479 #if FF_API_PRIVATE_OPT
2480     /** @deprecated use encoder private options instead */
2481     attribute_deprecated
2482     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2483                             /* do its best to deliver a chunk with size     */
2484                             /* below rtp_payload_size, the chunk will start */
2485                             /* with a start code on some codecs like H.263. */
2486                             /* This doesn't take account of any particular  */
2487                             /* headers inside the transmitted RTP payload.  */
2488 #endif
2489
2490 #if FF_API_STAT_BITS
2491     /* statistics, used for 2-pass encoding */
2492     attribute_deprecated
2493     int mv_bits;
2494     attribute_deprecated
2495     int header_bits;
2496     attribute_deprecated
2497     int i_tex_bits;
2498     attribute_deprecated
2499     int p_tex_bits;
2500     attribute_deprecated
2501     int i_count;
2502     attribute_deprecated
2503     int p_count;
2504     attribute_deprecated
2505     int skip_count;
2506     attribute_deprecated
2507     int misc_bits;
2508
2509     /** @deprecated this field is unused */
2510     attribute_deprecated
2511     int frame_bits;
2512 #endif
2513
2514     /**
2515      * pass1 encoding statistics output buffer
2516      * - encoding: Set by libavcodec.
2517      * - decoding: unused
2518      */
2519     char *stats_out;
2520
2521     /**
2522      * pass2 encoding statistics input buffer
2523      * Concatenated stuff from stats_out of pass1 should be placed here.
2524      * - encoding: Allocated/set/freed by user.
2525      * - decoding: unused
2526      */
2527     char *stats_in;
2528
2529     /**
2530      * Work around bugs in encoders which sometimes cannot be detected automatically.
2531      * - encoding: Set by user
2532      * - decoding: Set by user
2533      */
2534     int workaround_bugs;
2535 #define FF_BUG_AUTODETECT       1  ///< autodetection
2536 #define FF_BUG_XVID_ILACE       4
2537 #define FF_BUG_UMP4             8
2538 #define FF_BUG_NO_PADDING       16
2539 #define FF_BUG_AMV              32
2540 #define FF_BUG_QPEL_CHROMA      64
2541 #define FF_BUG_STD_QPEL         128
2542 #define FF_BUG_QPEL_CHROMA2     256
2543 #define FF_BUG_DIRECT_BLOCKSIZE 512
2544 #define FF_BUG_EDGE             1024
2545 #define FF_BUG_HPEL_CHROMA      2048
2546 #define FF_BUG_DC_CLIP          4096
2547 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2548 #define FF_BUG_TRUNCATED       16384
2549 #define FF_BUG_IEDGE           32768
2550
2551     /**
2552      * strictly follow the standard (MPEG-4, ...).
2553      * - encoding: Set by user.
2554      * - decoding: Set by user.
2555      * Setting this to STRICT or higher means the encoder and decoder will
2556      * generally do stupid things, whereas setting it to unofficial or lower
2557      * will mean the encoder might produce output that is not supported by all
2558      * spec-compliant decoders. Decoders don't differentiate between normal,
2559      * unofficial and experimental (that is, they always try to decode things
2560      * when they can) unless they are explicitly asked to behave stupidly
2561      * (=strictly conform to the specs)
2562      */
2563     int strict_std_compliance;
2564 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2565 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2566 #define FF_COMPLIANCE_NORMAL        0
2567 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2568 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2569
2570     /**
2571      * error concealment flags
2572      * - encoding: unused
2573      * - decoding: Set by user.
2574      */
2575     int error_concealment;
2576 #define FF_EC_GUESS_MVS   1
2577 #define FF_EC_DEBLOCK     2
2578 #define FF_EC_FAVOR_INTER 256
2579
2580     /**
2581      * debug
2582      * - encoding: Set by user.
2583      * - decoding: Set by user.
2584      */
2585     int debug;
2586 #define FF_DEBUG_PICT_INFO   1
2587 #define FF_DEBUG_RC          2
2588 #define FF_DEBUG_BITSTREAM   4
2589 #define FF_DEBUG_MB_TYPE     8
2590 #define FF_DEBUG_QP          16
2591 #if FF_API_DEBUG_MV
2592 /**
2593  * @deprecated this option does nothing
2594  */
2595 #define FF_DEBUG_MV          32
2596 #endif
2597 #define FF_DEBUG_DCT_COEFF   0x00000040
2598 #define FF_DEBUG_SKIP        0x00000080
2599 #define FF_DEBUG_STARTCODE   0x00000100
2600 #define FF_DEBUG_ER          0x00000400
2601 #define FF_DEBUG_MMCO        0x00000800
2602 #define FF_DEBUG_BUGS        0x00001000
2603 #if FF_API_DEBUG_MV
2604 #define FF_DEBUG_VIS_QP      0x00002000
2605 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
2606 #endif
2607 #define FF_DEBUG_BUFFERS     0x00008000
2608 #define FF_DEBUG_THREADS     0x00010000
2609 #define FF_DEBUG_GREEN_MD    0x00800000
2610 #define FF_DEBUG_NOMC        0x01000000
2611
2612 #if FF_API_DEBUG_MV
2613     /**
2614      * debug
2615      * - encoding: Set by user.
2616      * - decoding: Set by user.
2617      */
2618     int debug_mv;
2619 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
2620 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
2621 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
2622 #endif
2623
2624     /**
2625      * Error recognition; may misdetect some more or less valid parts as errors.
2626      * - encoding: unused
2627      * - decoding: Set by user.
2628      */
2629     int err_recognition;
2630
2631 /**
2632  * Verify checksums embedded in the bitstream (could be of either encoded or
2633  * decoded data, depending on the codec) and print an error message on mismatch.
2634  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
2635  * decoder returning an error.
2636  */
2637 #define AV_EF_CRCCHECK  (1<<0)
2638 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
2639 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
2640 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
2641
2642 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
2643 #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
2644 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
2645 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
2646
2647
2648     /**
2649      * opaque 64-bit number (generally a PTS) that will be reordered and
2650      * output in AVFrame.reordered_opaque
2651      * - encoding: unused
2652      * - decoding: Set by user.
2653      */
2654     int64_t reordered_opaque;
2655
2656     /**
2657      * Hardware accelerator in use
2658      * - encoding: unused.
2659      * - decoding: Set by libavcodec
2660      */
2661     const struct AVHWAccel *hwaccel;
2662
2663     /**
2664      * Hardware accelerator context.
2665      * For some hardware accelerators, a global context needs to be
2666      * provided by the user. In that case, this holds display-dependent
2667      * data FFmpeg cannot instantiate itself. Please refer to the
2668      * FFmpeg HW accelerator documentation to know how to fill this
2669      * is. e.g. for VA API, this is a struct vaapi_context.
2670      * - encoding: unused
2671      * - decoding: Set by user
2672      */
2673     void *hwaccel_context;
2674
2675     /**
2676      * error
2677      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
2678      * - decoding: unused
2679      */
2680     uint64_t error[AV_NUM_DATA_POINTERS];
2681
2682     /**
2683      * DCT algorithm, see FF_DCT_* below
2684      * - encoding: Set by user.
2685      * - decoding: unused
2686      */
2687     int dct_algo;
2688 #define FF_DCT_AUTO    0
2689 #define FF_DCT_FASTINT 1
2690 #define FF_DCT_INT     2
2691 #define FF_DCT_MMX     3
2692 #define FF_DCT_ALTIVEC 5
2693 #define FF_DCT_FAAN    6
2694
2695     /**
2696      * IDCT algorithm, see FF_IDCT_* below.
2697      * - encoding: Set by user.
2698      * - decoding: Set by user.
2699      */
2700     int idct_algo;
2701 #define FF_IDCT_AUTO          0
2702 #define FF_IDCT_INT           1
2703 #define FF_IDCT_SIMPLE        2
2704 #define FF_IDCT_SIMPLEMMX     3
2705 #define FF_IDCT_ARM           7
2706 #define FF_IDCT_ALTIVEC       8
2707 #define FF_IDCT_SIMPLEARM     10
2708 #define FF_IDCT_XVID          14
2709 #define FF_IDCT_SIMPLEARMV5TE 16
2710 #define FF_IDCT_SIMPLEARMV6   17
2711 #define FF_IDCT_FAAN          20
2712 #define FF_IDCT_SIMPLENEON    22
2713 #define FF_IDCT_NONE          24 /* Used by XvMC to extract IDCT coefficients with FF_IDCT_PERM_NONE */
2714 #define FF_IDCT_SIMPLEAUTO    128
2715
2716     /**
2717      * bits per sample/pixel from the demuxer (needed for huffyuv).
2718      * - encoding: Set by libavcodec.
2719      * - decoding: Set by user.
2720      */
2721      int bits_per_coded_sample;
2722
2723     /**
2724      * Bits per sample/pixel of internal libavcodec pixel/sample format.
2725      * - encoding: set by user.
2726      * - decoding: set by libavcodec.
2727      */
2728     int bits_per_raw_sample;
2729
2730 #if FF_API_LOWRES
2731     /**
2732      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
2733      * - encoding: unused
2734      * - decoding: Set by user.
2735      */
2736      int lowres;
2737 #endif
2738
2739 #if FF_API_CODED_FRAME
2740     /**
2741      * the picture in the bitstream
2742      * - encoding: Set by libavcodec.
2743      * - decoding: unused
2744      *
2745      * @deprecated use the quality factor packet side data instead
2746      */
2747     attribute_deprecated AVFrame *coded_frame;
2748 #endif
2749
2750     /**
2751      * thread count
2752      * is used to decide how many independent tasks should be passed to execute()
2753      * - encoding: Set by user.
2754      * - decoding: Set by user.
2755      */
2756     int thread_count;
2757
2758     /**
2759      * Which multithreading methods to use.
2760      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
2761      * so clients which cannot provide future frames should not use it.
2762      *
2763      * - encoding: Set by user, otherwise the default is used.
2764      * - decoding: Set by user, otherwise the default is used.
2765      */
2766     int thread_type;
2767 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
2768 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
2769
2770     /**
2771      * Which multithreading methods are in use by the codec.
2772      * - encoding: Set by libavcodec.
2773      * - decoding: Set by libavcodec.
2774      */
2775     int active_thread_type;
2776
2777     /**
2778      * Set by the client if its custom get_buffer() callback can be called
2779      * synchronously from another thread, which allows faster multithreaded decoding.
2780      * draw_horiz_band() will be called from other threads regardless of this setting.
2781      * Ignored if the default get_buffer() is used.
2782      * - encoding: Set by user.
2783      * - decoding: Set by user.
2784      */
2785     int thread_safe_callbacks;
2786
2787     /**
2788      * The codec may call this to execute several independent things.
2789      * It will return only after finishing all tasks.
2790      * The user may replace this with some multithreaded implementation,
2791      * the default implementation will execute the parts serially.
2792      * @param count the number of things to execute
2793      * - encoding: Set by libavcodec, user can override.
2794      * - decoding: Set by libavcodec, user can override.
2795      */
2796     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
2797
2798     /**
2799      * The codec may call this to execute several independent things.
2800      * It will return only after finishing all tasks.
2801      * The user may replace this with some multithreaded implementation,
2802      * the default implementation will execute the parts serially.
2803      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
2804      * @param c context passed also to func
2805      * @param count the number of things to execute
2806      * @param arg2 argument passed unchanged to func
2807      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
2808      * @param func function that will be called count times, with jobnr from 0 to count-1.
2809      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
2810      *             two instances of func executing at the same time will have the same threadnr.
2811      * @return always 0 currently, but code should handle a future improvement where when any call to func
2812      *         returns < 0 no further calls to func may be done and < 0 is returned.
2813      * - encoding: Set by libavcodec, user can override.
2814      * - decoding: Set by libavcodec, user can override.
2815      */
2816     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
2817
2818     /**
2819      * noise vs. sse weight for the nsse comparison function
2820      * - encoding: Set by user.
2821      * - decoding: unused
2822      */
2823      int nsse_weight;
2824
2825     /**
2826      * profile
2827      * - encoding: Set by user.
2828      * - decoding: Set by libavcodec.
2829      */
2830      int profile;
2831 #define FF_PROFILE_UNKNOWN -99
2832 #define FF_PROFILE_RESERVED -100
2833
2834 #define FF_PROFILE_AAC_MAIN 0
2835 #define FF_PROFILE_AAC_LOW  1
2836 #define FF_PROFILE_AAC_SSR  2
2837 #define FF_PROFILE_AAC_LTP  3
2838 #define FF_PROFILE_AAC_HE   4
2839 #define FF_PROFILE_AAC_HE_V2 28
2840 #define FF_PROFILE_AAC_LD   22
2841 #define FF_PROFILE_AAC_ELD  38
2842 #define FF_PROFILE_MPEG2_AAC_LOW 128
2843 #define FF_PROFILE_MPEG2_AAC_HE  131
2844
2845 #define FF_PROFILE_DNXHD         0
2846 #define FF_PROFILE_DNXHR_LB      1
2847 #define FF_PROFILE_DNXHR_SQ      2
2848 #define FF_PROFILE_DNXHR_HQ      3
2849 #define FF_PROFILE_DNXHR_HQX     4
2850 #define FF_PROFILE_DNXHR_444     5
2851
2852 #define FF_PROFILE_DTS         20
2853 #define FF_PROFILE_DTS_ES      30
2854 #define FF_PROFILE_DTS_96_24   40
2855 #define FF_PROFILE_DTS_HD_HRA  50
2856 #define FF_PROFILE_DTS_HD_MA   60
2857 #define FF_PROFILE_DTS_EXPRESS 70
2858
2859 #define FF_PROFILE_MPEG2_422    0
2860 #define FF_PROFILE_MPEG2_HIGH   1
2861 #define FF_PROFILE_MPEG2_SS     2
2862 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
2863 #define FF_PROFILE_MPEG2_MAIN   4
2864 #define FF_PROFILE_MPEG2_SIMPLE 5
2865
2866 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
2867 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
2868
2869 #define FF_PROFILE_H264_BASELINE             66
2870 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
2871 #define FF_PROFILE_H264_MAIN                 77
2872 #define FF_PROFILE_H264_EXTENDED             88
2873 #define FF_PROFILE_H264_HIGH                 100
2874 #define FF_PROFILE_H264_HIGH_10              110
2875 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
2876 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
2877 #define FF_PROFILE_H264_HIGH_422             122
2878 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
2879 #define FF_PROFILE_H264_STEREO_HIGH          128
2880 #define FF_PROFILE_H264_HIGH_444             144
2881 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
2882 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
2883 #define FF_PROFILE_H264_CAVLC_444            44
2884
2885 #define FF_PROFILE_VC1_SIMPLE   0
2886 #define FF_PROFILE_VC1_MAIN     1
2887 #define FF_PROFILE_VC1_COMPLEX  2
2888 #define FF_PROFILE_VC1_ADVANCED 3
2889
2890 #define FF_PROFILE_MPEG4_SIMPLE                     0
2891 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
2892 #define FF_PROFILE_MPEG4_CORE                       2
2893 #define FF_PROFILE_MPEG4_MAIN                       3
2894 #define FF_PROFILE_MPEG4_N_BIT                      4
2895 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
2896 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
2897 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
2898 #define FF_PROFILE_MPEG4_HYBRID                     8
2899 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
2900 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
2901 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
2902 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
2903 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
2904 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
2905 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
2906
2907 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
2908 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
2909 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
2910 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
2911 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
2912
2913 #define FF_PROFILE_VP9_0                            0
2914 #define FF_PROFILE_VP9_1                            1
2915 #define FF_PROFILE_VP9_2                            2
2916 #define FF_PROFILE_VP9_3                            3
2917
2918 #define FF_PROFILE_HEVC_MAIN                        1
2919 #define FF_PROFILE_HEVC_MAIN_10                     2
2920 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
2921 #define FF_PROFILE_HEVC_REXT                        4
2922
2923 #define FF_PROFILE_MJPEG_HUFFMAN_BASELINE_DCT            0xc0
2924 #define FF_PROFILE_MJPEG_HUFFMAN_EXTENDED_SEQUENTIAL_DCT 0xc1
2925 #define FF_PROFILE_MJPEG_HUFFMAN_PROGRESSIVE_DCT         0xc2
2926 #define FF_PROFILE_MJPEG_HUFFMAN_LOSSLESS                0xc3
2927 #define FF_PROFILE_MJPEG_JPEG_LS                         0xf7
2928
2929 #define FF_PROFILE_SBC_MSBC                         1
2930
2931     /**
2932      * level
2933      * - encoding: Set by user.
2934      * - decoding: Set by libavcodec.
2935      */
2936      int level;
2937 #define FF_LEVEL_UNKNOWN -99
2938
2939     /**
2940      * Skip loop filtering for selected frames.
2941      * - encoding: unused
2942      * - decoding: Set by user.
2943      */
2944     enum AVDiscard skip_loop_filter;
2945
2946     /**
2947      * Skip IDCT/dequantization for selected frames.
2948      * - encoding: unused
2949      * - decoding: Set by user.
2950      */
2951     enum AVDiscard skip_idct;
2952
2953     /**
2954      * Skip decoding for selected frames.
2955      * - encoding: unused
2956      * - decoding: Set by user.
2957      */
2958     enum AVDiscard skip_frame;
2959
2960     /**
2961      * Header containing style information for text subtitles.
2962      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
2963      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
2964      * the Format line following. It shouldn't include any Dialogue line.
2965      * - encoding: Set/allocated/freed by user (before avcodec_open2())
2966      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
2967      */
2968     uint8_t *subtitle_header;
2969     int subtitle_header_size;
2970
2971 #if FF_API_VBV_DELAY
2972     /**
2973      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
2974      * Used for compliant TS muxing.
2975      * - encoding: Set by libavcodec.
2976      * - decoding: unused.
2977      * @deprecated this value is now exported as a part of
2978      * AV_PKT_DATA_CPB_PROPERTIES packet side data
2979      */
2980     attribute_deprecated
2981     uint64_t vbv_delay;
2982 #endif
2983
2984 #if FF_API_SIDEDATA_ONLY_PKT
2985     /**
2986      * Encoding only and set by default. Allow encoders to output packets
2987      * that do not contain any encoded data, only side data.
2988      *
2989      * Some encoders need to output such packets, e.g. to update some stream
2990      * parameters at the end of encoding.
2991      *
2992      * @deprecated this field disables the default behaviour and
2993      *             it is kept only for compatibility.
2994      */
2995     attribute_deprecated
2996     int side_data_only_packets;
2997 #endif
2998
2999     /**
3000      * Audio only. The number of "priming" samples (padding) inserted by the
3001      * encoder at the beginning of the audio. I.e. this number of leading
3002      * decoded samples must be discarded by the caller to get the original audio
3003      * without leading padding.
3004      *
3005      * - decoding: unused
3006      * - encoding: Set by libavcodec. The timestamps on the output packets are
3007      *             adjusted by the encoder so that they always refer to the
3008      *             first sample of the data actually contained in the packet,
3009      *             including any added padding.  E.g. if the timebase is
3010      *             1/samplerate and the timestamp of the first input sample is
3011      *             0, the timestamp of the first output packet will be
3012      *             -initial_padding.
3013      */
3014     int initial_padding;
3015
3016     /**
3017      * - decoding: For codecs that store a framerate value in the compressed
3018      *             bitstream, the decoder may export it here. { 0, 1} when
3019      *             unknown.
3020      * - encoding: May be used to signal the framerate of CFR content to an
3021      *             encoder.
3022      */
3023     AVRational framerate;
3024
3025     /**
3026      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3027      * - encoding: unused.
3028      * - decoding: Set by libavcodec before calling get_format()
3029      */
3030     enum AVPixelFormat sw_pix_fmt;
3031
3032     /**
3033      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3034      * - encoding unused.
3035      * - decoding set by user.
3036      */
3037     AVRational pkt_timebase;
3038
3039     /**
3040      * AVCodecDescriptor
3041      * - encoding: unused.
3042      * - decoding: set by libavcodec.
3043      */
3044     const AVCodecDescriptor *codec_descriptor;
3045
3046 #if !FF_API_LOWRES
3047     /**
3048      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3049      * - encoding: unused
3050      * - decoding: Set by user.
3051      */
3052      int lowres;
3053 #endif
3054
3055     /**
3056      * Current statistics for PTS correction.
3057      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3058      * - encoding: unused
3059      */
3060     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3061     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3062     int64_t pts_correction_last_pts;       /// PTS of the last frame
3063     int64_t pts_correction_last_dts;       /// DTS of the last frame
3064
3065     /**
3066      * Character encoding of the input subtitles file.
3067      * - decoding: set by user
3068      * - encoding: unused
3069      */
3070     char *sub_charenc;
3071
3072     /**
3073      * Subtitles character encoding mode. Formats or codecs might be adjusting
3074      * this setting (if they are doing the conversion themselves for instance).
3075      * - decoding: set by libavcodec
3076      * - encoding: unused
3077      */
3078     int sub_charenc_mode;
3079 #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)
3080 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3081 #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
3082
3083     /**
3084      * Skip processing alpha if supported by codec.
3085      * Note that if the format uses pre-multiplied alpha (common with VP6,
3086      * and recommended due to better video quality/compression)
3087      * the image will look as if alpha-blended onto a black background.
3088      * However for formats that do not use pre-multiplied alpha
3089      * there might be serious artefacts (though e.g. libswscale currently
3090      * assumes pre-multiplied alpha anyway).
3091      *
3092      * - decoding: set by user
3093      * - encoding: unused
3094      */
3095     int skip_alpha;
3096
3097     /**
3098      * Number of samples to skip after a discontinuity
3099      * - decoding: unused
3100      * - encoding: set by libavcodec
3101      */
3102     int seek_preroll;
3103
3104 #if !FF_API_DEBUG_MV
3105     /**
3106      * debug motion vectors
3107      * - encoding: Set by user.
3108      * - decoding: Set by user.
3109      */
3110     int debug_mv;
3111 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3112 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3113 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3114 #endif
3115
3116     /**
3117      * custom intra quantization matrix
3118      * - encoding: Set by user, can be NULL.
3119      * - decoding: unused.
3120      */
3121     uint16_t *chroma_intra_matrix;
3122
3123     /**
3124      * dump format separator.
3125      * can be ", " or "\n      " or anything else
3126      * - encoding: Set by user.
3127      * - decoding: Set by user.
3128      */
3129     uint8_t *dump_separator;
3130
3131     /**
3132      * ',' separated list of allowed decoders.
3133      * If NULL then all are allowed
3134      * - encoding: unused
3135      * - decoding: set by user
3136      */
3137     char *codec_whitelist;
3138
3139     /**
3140      * Properties of the stream that gets decoded
3141      * - encoding: unused
3142      * - decoding: set by libavcodec
3143      */
3144     unsigned properties;
3145 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3146 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3147
3148     /**
3149      * Additional data associated with the entire coded stream.
3150      *
3151      * - decoding: unused
3152      * - encoding: may be set by libavcodec after avcodec_open2().
3153      */
3154     AVPacketSideData *coded_side_data;
3155     int            nb_coded_side_data;
3156
3157     /**
3158      * A reference to the AVHWFramesContext describing the input (for encoding)
3159      * or output (decoding) frames. The reference is set by the caller and
3160      * afterwards owned (and freed) by libavcodec - it should never be read by
3161      * the caller after being set.
3162      *
3163      * - decoding: This field should be set by the caller from the get_format()
3164      *             callback. The previous reference (if any) will always be
3165      *             unreffed by libavcodec before the get_format() call.
3166      *
3167      *             If the default get_buffer2() is used with a hwaccel pixel
3168      *             format, then this AVHWFramesContext will be used for
3169      *             allocating the frame buffers.
3170      *
3171      * - encoding: For hardware encoders configured to use a hwaccel pixel
3172      *             format, this field should be set by the caller to a reference
3173      *             to the AVHWFramesContext describing input frames.
3174      *             AVHWFramesContext.format must be equal to
3175      *             AVCodecContext.pix_fmt.
3176      *
3177      *             This field should be set before avcodec_open2() is called.
3178      */
3179     AVBufferRef *hw_frames_ctx;
3180
3181     /**
3182      * Control the form of AVSubtitle.rects[N]->ass
3183      * - decoding: set by user
3184      * - encoding: unused
3185      */
3186     int sub_text_format;
3187 #define FF_SUB_TEXT_FMT_ASS              0
3188 #if FF_API_ASS_TIMING
3189 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3190 #endif
3191
3192     /**
3193      * Audio only. The amount of padding (in samples) appended by the encoder to
3194      * the end of the audio. I.e. this number of decoded samples must be
3195      * discarded by the caller from the end of the stream to get the original
3196      * audio without any trailing padding.
3197      *
3198      * - decoding: unused
3199      * - encoding: unused
3200      */
3201     int trailing_padding;
3202
3203     /**
3204      * The number of pixels per image to maximally accept.
3205      *
3206      * - decoding: set by user
3207      * - encoding: set by user
3208      */
3209     int64_t max_pixels;
3210
3211     /**
3212      * A reference to the AVHWDeviceContext describing the device which will
3213      * be used by a hardware encoder/decoder.  The reference is set by the
3214      * caller and afterwards owned (and freed) by libavcodec.
3215      *
3216      * This should be used if either the codec device does not require
3217      * hardware frames or any that are used are to be allocated internally by
3218      * libavcodec.  If the user wishes to supply any of the frames used as
3219      * encoder input or decoder output then hw_frames_ctx should be used
3220      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3221      * field will be ignored while decoding the associated stream segment, but
3222      * may again be used on a following one after another get_format() call.
3223      *
3224      * For both encoders and decoders this field should be set before
3225      * avcodec_open2() is called and must not be written to thereafter.
3226      *
3227      * Note that some decoders may require this field to be set initially in
3228      * order to support hw_frames_ctx at all - in that case, all frames
3229      * contexts used must be created on the same device.
3230      */
3231     AVBufferRef *hw_device_ctx;
3232
3233     /**
3234      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3235      * decoding (if active).
3236      * - encoding: unused
3237      * - decoding: Set by user (either before avcodec_open2(), or in the
3238      *             AVCodecContext.get_format callback)
3239      */
3240     int hwaccel_flags;
3241
3242     /**
3243      * Video decoding only. Certain video codecs support cropping, meaning that
3244      * only a sub-rectangle of the decoded frame is intended for display.  This
3245      * option controls how cropping is handled by libavcodec.
3246      *
3247      * When set to 1 (the default), libavcodec will apply cropping internally.
3248      * I.e. it will modify the output frame width/height fields and offset the
3249      * data pointers (only by as much as possible while preserving alignment, or
3250      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3251      * the frames output by the decoder refer only to the cropped area. The
3252      * crop_* fields of the output frames will be zero.
3253      *
3254      * When set to 0, the width/height fields of the output frames will be set
3255      * to the coded dimensions and the crop_* fields will describe the cropping
3256      * rectangle. Applying the cropping is left to the caller.
3257      *
3258      * @warning When hardware acceleration with opaque output frames is used,
3259      * libavcodec is unable to apply cropping from the top/left border.
3260      *
3261      * @note when this option is set to zero, the width/height fields of the
3262      * AVCodecContext and output AVFrames have different meanings. The codec
3263      * context fields store display dimensions (with the coded dimensions in
3264      * coded_width/height), while the frame fields store the coded dimensions
3265      * (with the display dimensions being determined by the crop_* fields).
3266      */
3267     int apply_cropping;
3268
3269     /*
3270      * Video decoding only.  Sets the number of extra hardware frames which
3271      * the decoder will allocate for use by the caller.  This must be set
3272      * before avcodec_open2() is called.
3273      *
3274      * Some hardware decoders require all frames that they will use for
3275      * output to be defined in advance before decoding starts.  For such
3276      * decoders, the hardware frame pool must therefore be of a fixed size.
3277      * The extra frames set here are on top of any number that the decoder
3278      * needs internally in order to operate normally (for example, frames
3279      * used as reference pictures).
3280      */
3281     int extra_hw_frames;
3282 } AVCodecContext;
3283
3284 #if FF_API_CODEC_GET_SET
3285 /**
3286  * Accessors for some AVCodecContext fields. These used to be provided for ABI
3287  * compatibility, and do not need to be used anymore.
3288  */
3289 attribute_deprecated
3290 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3291 attribute_deprecated
3292 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3293
3294 attribute_deprecated
3295 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3296 attribute_deprecated
3297 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3298
3299 attribute_deprecated
3300 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3301
3302 #if FF_API_LOWRES
3303 attribute_deprecated
3304 int  av_codec_get_lowres(const AVCodecContext *avctx);
3305 attribute_deprecated
3306 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3307 #endif
3308
3309 attribute_deprecated
3310 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3311 attribute_deprecated
3312 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3313
3314 attribute_deprecated
3315 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3316 attribute_deprecated
3317 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3318 #endif
3319
3320 /**
3321  * AVProfile.
3322  */
3323 typedef struct AVProfile {
3324     int profile;
3325     const char *name; ///< short name for the profile
3326 } AVProfile;
3327
3328 enum {
3329     /**
3330      * The codec supports this format via the hw_device_ctx interface.
3331      *
3332      * When selecting this format, AVCodecContext.hw_device_ctx should
3333      * have been set to a device of the specified type before calling
3334      * avcodec_open2().
3335      */
3336     AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX = 0x01,
3337     /**
3338      * The codec supports this format via the hw_frames_ctx interface.
3339      *
3340      * When selecting this format for a decoder,
3341      * AVCodecContext.hw_frames_ctx should be set to a suitable frames
3342      * context inside the get_format() callback.  The frames context
3343      * must have been created on a device of the specified type.
3344      */
3345     AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX = 0x02,
3346     /**
3347      * The codec supports this format by some internal method.
3348      *
3349      * This format can be selected without any additional configuration -
3350      * no device or frames context is required.
3351      */
3352     AV_CODEC_HW_CONFIG_METHOD_INTERNAL      = 0x04,
3353     /**
3354      * The codec supports this format by some ad-hoc method.
3355      *
3356      * Additional settings and/or function calls are required.  See the
3357      * codec-specific documentation for details.  (Methods requiring
3358      * this sort of configuration are deprecated and others should be
3359      * used in preference.)
3360      */
3361     AV_CODEC_HW_CONFIG_METHOD_AD_HOC        = 0x08,
3362 };
3363
3364 typedef struct AVCodecHWConfig {
3365     /**
3366      * A hardware pixel format which the codec can use.
3367      */
3368     enum AVPixelFormat pix_fmt;
3369     /**
3370      * Bit set of AV_CODEC_HW_CONFIG_METHOD_* flags, describing the possible
3371      * setup methods which can be used with this configuration.
3372      */
3373     int methods;
3374     /**
3375      * The device type associated with the configuration.
3376      *
3377      * Must be set for AV_CODEC_HW_CONFIG_METHOD_HW_DEVICE_CTX and
3378      * AV_CODEC_HW_CONFIG_METHOD_HW_FRAMES_CTX, otherwise unused.
3379      */
3380     enum AVHWDeviceType device_type;
3381 } AVCodecHWConfig;
3382
3383 typedef struct AVCodecDefault AVCodecDefault;
3384
3385 struct AVSubtitle;
3386
3387 /**
3388  * AVCodec.
3389  */
3390 typedef struct AVCodec {
3391     /**
3392      * Name of the codec implementation.
3393      * The name is globally unique among encoders and among decoders (but an
3394      * encoder and a decoder can share the same name).
3395      * This is the primary way to find a codec from the user perspective.
3396      */
3397     const char *name;
3398     /**
3399      * Descriptive name for the codec, meant to be more human readable than name.
3400      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3401      */
3402     const char *long_name;
3403     enum AVMediaType type;
3404     enum AVCodecID id;
3405     /**
3406      * Codec capabilities.
3407      * see AV_CODEC_CAP_*
3408      */
3409     int capabilities;
3410     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3411     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3412     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3413     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3414     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3415     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3416     const AVClass *priv_class;              ///< AVClass for the private context
3417     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3418
3419     /**
3420      * Group name of the codec implementation.
3421      * This is a short symbolic name of the wrapper backing this codec. A
3422      * wrapper uses some kind of external implementation for the codec, such
3423      * as an external library, or a codec implementation provided by the OS or
3424      * the hardware.
3425      * If this field is NULL, this is a builtin, libavcodec native codec.
3426      * If non-NULL, this will be the suffix in AVCodec.name in most cases
3427      * (usually AVCodec.name will be of the form "<codec_name>_<wrapper_name>").
3428      */
3429     const char *wrapper_name;
3430
3431     /*****************************************************************
3432      * No fields below this line are part of the public API. They
3433      * may not be used outside of libavcodec and can be changed and
3434      * removed at will.
3435      * New public fields should be added right above.
3436      *****************************************************************
3437      */
3438     int priv_data_size;
3439     struct AVCodec *next;
3440     /**
3441      * @name Frame-level threading support functions
3442      * @{
3443      */
3444     /**
3445      * If defined, called on thread contexts when they are created.
3446      * If the codec allocates writable tables in init(), re-allocate them here.
3447      * priv_data will be set to a copy of the original.
3448      */
3449     int (*init_thread_copy)(AVCodecContext *);
3450     /**
3451      * Copy necessary context variables from a previous thread context to the current one.
3452      * If not defined, the next thread will start automatically; otherwise, the codec
3453      * must call ff_thread_finish_setup().
3454      *
3455      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3456      */
3457     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3458     /** @} */
3459
3460     /**
3461      * Private codec-specific defaults.
3462      */
3463     const AVCodecDefault *defaults;
3464
3465     /**
3466      * Initialize codec static data, called from avcodec_register().
3467      *
3468      * This is not intended for time consuming operations as it is
3469      * run for every codec regardless of that codec being used.
3470      */
3471     void (*init_static_data)(struct AVCodec *codec);
3472
3473     int (*init)(AVCodecContext *);
3474     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3475                       const struct AVSubtitle *sub);
3476     /**
3477      * Encode data to an AVPacket.
3478      *
3479      * @param      avctx          codec context
3480      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3481      * @param[in]  frame          AVFrame containing the raw data to be encoded
3482      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3483      *                            non-empty packet was returned in avpkt.
3484      * @return 0 on success, negative error code on failure
3485      */
3486     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3487                    int *got_packet_ptr);
3488     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3489     int (*close)(AVCodecContext *);
3490     /**
3491      * Encode API with decoupled packet/frame dataflow. The API is the
3492      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3493      * that:
3494      * - never called if the codec is closed or the wrong type,
3495      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3496      * - only one drain frame is ever passed down,
3497      */
3498     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3499     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3500
3501     /**
3502      * Decode API with decoupled packet/frame dataflow. This function is called
3503      * to get one output frame. It should call ff_decode_get_packet() to obtain
3504      * input data.
3505      */
3506     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3507     /**
3508      * Flush buffers.
3509      * Will be called when seeking
3510      */
3511     void (*flush)(AVCodecContext *);
3512     /**
3513      * Internal codec capabilities.
3514      * See FF_CODEC_CAP_* in internal.h
3515      */
3516     int caps_internal;
3517
3518     /**
3519      * Decoding only, a comma-separated list of bitstream filters to apply to
3520      * packets before decoding.
3521      */
3522     const char *bsfs;
3523
3524     /**
3525      * Array of pointers to hardware configurations supported by the codec,
3526      * or NULL if no hardware supported.  The array is terminated by a NULL
3527      * pointer.
3528      *
3529      * The user can only access this field via avcodec_get_hw_config().
3530      */
3531     const struct AVCodecHWConfigInternal **hw_configs;
3532 } AVCodec;
3533
3534 #if FF_API_CODEC_GET_SET
3535 attribute_deprecated
3536 int av_codec_get_max_lowres(const AVCodec *codec);
3537 #endif
3538
3539 struct MpegEncContext;
3540
3541 /**
3542  * Retrieve supported hardware configurations for a codec.
3543  *
3544  * Values of index from zero to some maximum return the indexed configuration
3545  * descriptor; all other values return NULL.  If the codec does not support
3546  * any hardware configurations then it will always return NULL.
3547  */
3548 const AVCodecHWConfig *avcodec_get_hw_config(const AVCodec *codec, int index);
3549
3550 /**
3551  * @defgroup lavc_hwaccel AVHWAccel
3552  *
3553  * @note  Nothing in this structure should be accessed by the user.  At some
3554  *        point in future it will not be externally visible at all.
3555  *
3556  * @{
3557  */
3558 typedef struct AVHWAccel {
3559     /**
3560      * Name of the hardware accelerated codec.
3561      * The name is globally unique among encoders and among decoders (but an
3562      * encoder and a decoder can share the same name).
3563      */
3564     const char *name;
3565
3566     /**
3567      * Type of codec implemented by the hardware accelerator.
3568      *
3569      * See AVMEDIA_TYPE_xxx
3570      */
3571     enum AVMediaType type;
3572
3573     /**
3574      * Codec implemented by the hardware accelerator.
3575      *
3576      * See AV_CODEC_ID_xxx
3577      */
3578     enum AVCodecID id;
3579
3580     /**
3581      * Supported pixel format.
3582      *
3583      * Only hardware accelerated formats are supported here.
3584      */
3585     enum AVPixelFormat pix_fmt;
3586
3587     /**
3588      * Hardware accelerated codec capabilities.
3589      * see AV_HWACCEL_CODEC_CAP_*
3590      */
3591     int capabilities;
3592
3593     /*****************************************************************
3594      * No fields below this line are part of the public API. They
3595      * may not be used outside of libavcodec and can be changed and
3596      * removed at will.
3597      * New public fields should be added right above.
3598      *****************************************************************
3599      */
3600
3601     /**
3602      * Allocate a custom buffer
3603      */
3604     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3605
3606     /**
3607      * Called at the beginning of each frame or field picture.
3608      *
3609      * Meaningful frame information (codec specific) is guaranteed to
3610      * be parsed at this point. This function is mandatory.
3611      *
3612      * Note that buf can be NULL along with buf_size set to 0.
3613      * Otherwise, this means the whole frame is available at this point.
3614      *
3615      * @param avctx the codec context
3616      * @param buf the frame data buffer base
3617      * @param buf_size the size of the frame in bytes
3618      * @return zero if successful, a negative value otherwise
3619      */
3620     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3621
3622     /**
3623      * Callback for parameter data (SPS/PPS/VPS etc).
3624      *
3625      * Useful for hardware decoders which keep persistent state about the
3626      * video parameters, and need to receive any changes to update that state.
3627      *
3628      * @param avctx the codec context
3629      * @param type the nal unit type
3630      * @param buf the nal unit data buffer
3631      * @param buf_size the size of the nal unit in bytes
3632      * @return zero if successful, a negative value otherwise
3633      */
3634     int (*decode_params)(AVCodecContext *avctx, int type, const uint8_t *buf, uint32_t buf_size);
3635
3636     /**
3637      * Callback for each slice.
3638      *
3639      * Meaningful slice information (codec specific) is guaranteed to
3640      * be parsed at this point. This function is mandatory.
3641      * The only exception is XvMC, that works on MB level.
3642      *
3643      * @param avctx the codec context
3644      * @param buf the slice data buffer base
3645      * @param buf_size the size of the slice in bytes
3646      * @return zero if successful, a negative value otherwise
3647      */
3648     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3649
3650     /**
3651      * Called at the end of each frame or field picture.
3652      *
3653      * The whole picture is parsed at this point and can now be sent
3654      * to the hardware accelerator. This function is mandatory.
3655      *
3656      * @param avctx the codec context
3657      * @return zero if successful, a negative value otherwise
3658      */
3659     int (*end_frame)(AVCodecContext *avctx);
3660
3661     /**
3662      * Size of per-frame hardware accelerator private data.
3663      *
3664      * Private data is allocated with av_mallocz() before
3665      * AVCodecContext.get_buffer() and deallocated after
3666      * AVCodecContext.release_buffer().
3667      */
3668     int frame_priv_data_size;
3669
3670     /**
3671      * Called for every Macroblock in a slice.
3672      *
3673      * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3674      * Instead of decoding to raw picture, MB parameters are
3675      * stored in an array provided by the video driver.
3676      *
3677      * @param s the mpeg context
3678      */
3679     void (*decode_mb)(struct MpegEncContext *s);
3680
3681     /**
3682      * Initialize the hwaccel private data.
3683      *
3684      * This will be called from ff_get_format(), after hwaccel and
3685      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3686      * is allocated.
3687      */
3688     int (*init)(AVCodecContext *avctx);
3689
3690     /**
3691      * Uninitialize the hwaccel private data.
3692      *
3693      * This will be called from get_format() or avcodec_close(), after hwaccel
3694      * and hwaccel_context are already uninitialized.
3695      */
3696     int (*uninit)(AVCodecContext *avctx);
3697
3698     /**
3699      * Size of the private data to allocate in
3700      * AVCodecInternal.hwaccel_priv_data.
3701      */
3702     int priv_data_size;
3703
3704     /**
3705      * Internal hwaccel capabilities.
3706      */
3707     int caps_internal;
3708
3709     /**
3710      * Fill the given hw_frames context with current codec parameters. Called
3711      * from get_format. Refer to avcodec_get_hw_frames_parameters() for
3712      * details.
3713      *
3714      * This CAN be called before AVHWAccel.init is called, and you must assume
3715      * that avctx->hwaccel_priv_data is invalid.
3716      */
3717     int (*frame_params)(AVCodecContext *avctx, AVBufferRef *hw_frames_ctx);
3718 } AVHWAccel;
3719
3720 /**
3721  * HWAccel is experimental and is thus avoided in favor of non experimental
3722  * codecs
3723  */
3724 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
3725
3726 /**
3727  * Hardware acceleration should be used for decoding even if the codec level
3728  * used is unknown or higher than the maximum supported level reported by the
3729  * hardware driver.
3730  *
3731  * It's generally a good idea to pass this flag unless you have a specific
3732  * reason not to, as hardware tends to under-report supported levels.
3733  */
3734 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
3735
3736 /**
3737  * Hardware acceleration can output YUV pixel formats with a different chroma
3738  * sampling than 4:2:0 and/or other than 8 bits per component.
3739  */
3740 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
3741
3742 /**
3743  * Hardware acceleration should still be attempted for decoding when the
3744  * codec profile does not match the reported capabilities of the hardware.
3745  *
3746  * For example, this can be used to try to decode baseline profile H.264
3747  * streams in hardware - it will often succeed, because many streams marked
3748  * as baseline profile actually conform to constrained baseline profile.
3749  *
3750  * @warning If the stream is actually not supported then the behaviour is
3751  *          undefined, and may include returning entirely incorrect output
3752  *          while indicating success.
3753  */
3754 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
3755
3756 /**
3757  * @}
3758  */
3759
3760 #if FF_API_AVPICTURE
3761 /**
3762  * @defgroup lavc_picture AVPicture
3763  *
3764  * Functions for working with AVPicture
3765  * @{
3766  */
3767
3768 /**
3769  * Picture data structure.
3770  *
3771  * Up to four components can be stored into it, the last component is
3772  * alpha.
3773  * @deprecated use AVFrame or imgutils functions instead
3774  */
3775 typedef struct AVPicture {
3776     attribute_deprecated
3777     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
3778     attribute_deprecated
3779     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
3780 } AVPicture;
3781
3782 /**
3783  * @}
3784  */
3785 #endif
3786
3787 enum AVSubtitleType {
3788     SUBTITLE_NONE,
3789
3790     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
3791
3792     /**
3793      * Plain text, the text field must be set by the decoder and is
3794      * authoritative. ass and pict fields may contain approximations.
3795      */
3796     SUBTITLE_TEXT,
3797
3798     /**