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