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