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