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