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