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