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