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