b5bbc591ac6eebc205ea14a97f3109b1dc247eac
[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 #if FF_API_CAP_VDPAU
1035 /**
1036  * Codec can export data for HW decoding (VDPAU).
1037  */
1038 #define AV_CODEC_CAP_HWACCEL_VDPAU       (1 <<  7)
1039 #endif
1040
1041 /**
1042  * Codec can output multiple frames per AVPacket
1043  * Normally demuxers return one frame at a time, demuxers which do not do
1044  * are connected to a parser to split what they return into proper frames.
1045  * This flag is reserved to the very rare category of codecs which have a
1046  * bitstream that cannot be split into frames without timeconsuming
1047  * operations like full decoding. Demuxers carrying such bitstreams thus
1048  * may return multiple frames in a packet. This has many disadvantages like
1049  * prohibiting stream copy in many cases thus it should only be considered
1050  * as a last resort.
1051  */
1052 #define AV_CODEC_CAP_SUBFRAMES           (1 <<  8)
1053 /**
1054  * Codec is experimental and is thus avoided in favor of non experimental
1055  * encoders
1056  */
1057 #define AV_CODEC_CAP_EXPERIMENTAL        (1 <<  9)
1058 /**
1059  * Codec should fill in channel configuration and samplerate instead of container
1060  */
1061 #define AV_CODEC_CAP_CHANNEL_CONF        (1 << 10)
1062 /**
1063  * Codec supports frame-level multithreading.
1064  */
1065 #define AV_CODEC_CAP_FRAME_THREADS       (1 << 12)
1066 /**
1067  * Codec supports slice-based (or partition-based) multithreading.
1068  */
1069 #define AV_CODEC_CAP_SLICE_THREADS       (1 << 13)
1070 /**
1071  * Codec supports changed parameters at any point.
1072  */
1073 #define AV_CODEC_CAP_PARAM_CHANGE        (1 << 14)
1074 /**
1075  * Codec supports avctx->thread_count == 0 (auto).
1076  */
1077 #define AV_CODEC_CAP_AUTO_THREADS        (1 << 15)
1078 /**
1079  * Audio encoder supports receiving a different number of samples in each call.
1080  */
1081 #define AV_CODEC_CAP_VARIABLE_FRAME_SIZE (1 << 16)
1082 /**
1083  * Decoder is not a preferred choice for probing.
1084  * This indicates that the decoder is not a good choice for probing.
1085  * It could for example be an expensive to spin up hardware decoder,
1086  * or it could simply not provide a lot of useful information about
1087  * the stream.
1088  * A decoder marked with this flag should only be used as last resort
1089  * choice for probing.
1090  */
1091 #define AV_CODEC_CAP_AVOID_PROBING       (1 << 17)
1092 /**
1093  * Codec is intra only.
1094  */
1095 #define AV_CODEC_CAP_INTRA_ONLY       0x40000000
1096 /**
1097  * Codec is lossless.
1098  */
1099 #define AV_CODEC_CAP_LOSSLESS         0x80000000
1100
1101
1102 #if FF_API_WITHOUT_PREFIX
1103 /**
1104  * Allow decoders to produce frames with data planes that are not aligned
1105  * to CPU requirements (e.g. due to cropping).
1106  */
1107 #define CODEC_FLAG_UNALIGNED AV_CODEC_FLAG_UNALIGNED
1108 #define CODEC_FLAG_QSCALE AV_CODEC_FLAG_QSCALE
1109 #define CODEC_FLAG_4MV    AV_CODEC_FLAG_4MV
1110 #define CODEC_FLAG_OUTPUT_CORRUPT AV_CODEC_FLAG_OUTPUT_CORRUPT
1111 #define CODEC_FLAG_QPEL   AV_CODEC_FLAG_QPEL
1112 #if FF_API_GMC
1113 /**
1114  * @deprecated use the "gmc" private option of the libxvid encoder
1115  */
1116 #define CODEC_FLAG_GMC    0x0020  ///< Use GMC.
1117 #endif
1118 #if FF_API_MV0
1119 /**
1120  * @deprecated use the flag "mv0" in the "mpv_flags" private option of the
1121  * mpegvideo encoders
1122  */
1123 #define CODEC_FLAG_MV0    0x0040
1124 #endif
1125 #if FF_API_INPUT_PRESERVED
1126 /**
1127  * @deprecated passing reference-counted frames to the encoders replaces this
1128  * flag
1129  */
1130 #define CODEC_FLAG_INPUT_PRESERVED 0x0100
1131 #endif
1132 #define CODEC_FLAG_PASS1           AV_CODEC_FLAG_PASS1
1133 #define CODEC_FLAG_PASS2           AV_CODEC_FLAG_PASS2
1134 #define CODEC_FLAG_GRAY            AV_CODEC_FLAG_GRAY
1135 #if FF_API_EMU_EDGE
1136 /**
1137  * @deprecated edges are not used/required anymore. I.e. this flag is now always
1138  * set.
1139  */
1140 #define CODEC_FLAG_EMU_EDGE        0x4000
1141 #endif
1142 #define CODEC_FLAG_PSNR            AV_CODEC_FLAG_PSNR
1143 #define CODEC_FLAG_TRUNCATED       AV_CODEC_FLAG_TRUNCATED
1144
1145 #if FF_API_NORMALIZE_AQP
1146 /**
1147  * @deprecated use the flag "naq" in the "mpv_flags" private option of the
1148  * mpegvideo encoders
1149  */
1150 #define CODEC_FLAG_NORMALIZE_AQP  0x00020000
1151 #endif
1152 #define CODEC_FLAG_INTERLACED_DCT AV_CODEC_FLAG_INTERLACED_DCT
1153 #define CODEC_FLAG_LOW_DELAY      AV_CODEC_FLAG_LOW_DELAY
1154 #define CODEC_FLAG_GLOBAL_HEADER  AV_CODEC_FLAG_GLOBAL_HEADER
1155 #define CODEC_FLAG_BITEXACT       AV_CODEC_FLAG_BITEXACT
1156 #define CODEC_FLAG_AC_PRED        AV_CODEC_FLAG_AC_PRED
1157 #define CODEC_FLAG_LOOP_FILTER    AV_CODEC_FLAG_LOOP_FILTER
1158 #define CODEC_FLAG_INTERLACED_ME  AV_CODEC_FLAG_INTERLACED_ME
1159 #define CODEC_FLAG_CLOSED_GOP     AV_CODEC_FLAG_CLOSED_GOP
1160 #define CODEC_FLAG2_FAST          AV_CODEC_FLAG2_FAST
1161 #define CODEC_FLAG2_NO_OUTPUT     AV_CODEC_FLAG2_NO_OUTPUT
1162 #define CODEC_FLAG2_LOCAL_HEADER  AV_CODEC_FLAG2_LOCAL_HEADER
1163 #define CODEC_FLAG2_DROP_FRAME_TIMECODE AV_CODEC_FLAG2_DROP_FRAME_TIMECODE
1164 #define CODEC_FLAG2_IGNORE_CROP   AV_CODEC_FLAG2_IGNORE_CROP
1165
1166 #define CODEC_FLAG2_CHUNKS        AV_CODEC_FLAG2_CHUNKS
1167 #define CODEC_FLAG2_SHOW_ALL      AV_CODEC_FLAG2_SHOW_ALL
1168 #define CODEC_FLAG2_EXPORT_MVS    AV_CODEC_FLAG2_EXPORT_MVS
1169 #define CODEC_FLAG2_SKIP_MANUAL   AV_CODEC_FLAG2_SKIP_MANUAL
1170
1171 /* Unsupported options :
1172  *              Syntax Arithmetic coding (SAC)
1173  *              Reference Picture Selection
1174  *              Independent Segment Decoding */
1175 /* /Fx */
1176 /* codec capabilities */
1177
1178 #define CODEC_CAP_DRAW_HORIZ_BAND AV_CODEC_CAP_DRAW_HORIZ_BAND ///< Decoder can use draw_horiz_band callback.
1179 /**
1180  * Codec uses get_buffer() for allocating buffers and supports custom allocators.
1181  * If not set, it might not use get_buffer() at all or use operations that
1182  * assume the buffer was allocated by avcodec_default_get_buffer.
1183  */
1184 #define CODEC_CAP_DR1             AV_CODEC_CAP_DR1
1185 #define CODEC_CAP_TRUNCATED       AV_CODEC_CAP_TRUNCATED
1186 #if FF_API_XVMC
1187 /* Codec can export data for HW decoding. This flag indicates that
1188  * the codec would call get_format() with list that might contain HW accelerated
1189  * pixel formats (XvMC, VDPAU, VAAPI, etc). The application can pick any of them
1190  * including raw image format.
1191  * The application can use the passed context to determine bitstream version,
1192  * chroma format, resolution etc.
1193  */
1194 #define CODEC_CAP_HWACCEL         0x0010
1195 #endif /* FF_API_XVMC */
1196 /**
1197  * Encoder or decoder requires flushing with NULL input at the end in order to
1198  * give the complete and correct output.
1199  *
1200  * NOTE: If this flag is not set, the codec is guaranteed to never be fed with
1201  *       with NULL data. The user can still send NULL data to the public encode
1202  *       or decode function, but libavcodec will not pass it along to the codec
1203  *       unless this flag is set.
1204  *
1205  * Decoders:
1206  * The decoder has a non-zero delay and needs to be fed with avpkt->data=NULL,
1207  * avpkt->size=0 at the end to get the delayed data until the decoder no longer
1208  * returns frames.
1209  *
1210  * Encoders:
1211  * The encoder needs to be fed with NULL data at the end of encoding until the
1212  * encoder no longer returns data.
1213  *
1214  * NOTE: For encoders implementing the AVCodec.encode2() function, setting this
1215  *       flag also means that the encoder must set the pts and duration for
1216  *       each output packet. If this flag is not set, the pts and duration will
1217  *       be determined by libavcodec from the input frame.
1218  */
1219 #define CODEC_CAP_DELAY           AV_CODEC_CAP_DELAY
1220 /**
1221  * Codec can be fed a final frame with a smaller size.
1222  * This can be used to prevent truncation of the last audio samples.
1223  */
1224 #define CODEC_CAP_SMALL_LAST_FRAME AV_CODEC_CAP_SMALL_LAST_FRAME
1225 #if FF_API_CAP_VDPAU
1226 /**
1227  * Codec can export data for HW decoding (VDPAU).
1228  */
1229 #define CODEC_CAP_HWACCEL_VDPAU    AV_CODEC_CAP_HWACCEL_VDPAU
1230 #endif
1231 /**
1232  * Codec can output multiple frames per AVPacket
1233  * Normally demuxers return one frame at a time, demuxers which do not do
1234  * are connected to a parser to split what they return into proper frames.
1235  * This flag is reserved to the very rare category of codecs which have a
1236  * bitstream that cannot be split into frames without timeconsuming
1237  * operations like full decoding. Demuxers carrying such bitstreams thus
1238  * may return multiple frames in a packet. This has many disadvantages like
1239  * prohibiting stream copy in many cases thus it should only be considered
1240  * as a last resort.
1241  */
1242 #define CODEC_CAP_SUBFRAMES        AV_CODEC_CAP_SUBFRAMES
1243 /**
1244  * Codec is experimental and is thus avoided in favor of non experimental
1245  * encoders
1246  */
1247 #define CODEC_CAP_EXPERIMENTAL     AV_CODEC_CAP_EXPERIMENTAL
1248 /**
1249  * Codec should fill in channel configuration and samplerate instead of container
1250  */
1251 #define CODEC_CAP_CHANNEL_CONF     AV_CODEC_CAP_CHANNEL_CONF
1252 #if FF_API_NEG_LINESIZES
1253 /**
1254  * @deprecated no codecs use this capability
1255  */
1256 #define CODEC_CAP_NEG_LINESIZES    0x0800
1257 #endif
1258 /**
1259  * Codec supports frame-level multithreading.
1260  */
1261 #define CODEC_CAP_FRAME_THREADS    AV_CODEC_CAP_FRAME_THREADS
1262 /**
1263  * Codec supports slice-based (or partition-based) multithreading.
1264  */
1265 #define CODEC_CAP_SLICE_THREADS    AV_CODEC_CAP_SLICE_THREADS
1266 /**
1267  * Codec supports changed parameters at any point.
1268  */
1269 #define CODEC_CAP_PARAM_CHANGE     AV_CODEC_CAP_PARAM_CHANGE
1270 /**
1271  * Codec supports avctx->thread_count == 0 (auto).
1272  */
1273 #define CODEC_CAP_AUTO_THREADS     AV_CODEC_CAP_AUTO_THREADS
1274 /**
1275  * Audio encoder supports receiving a different number of samples in each call.
1276  */
1277 #define CODEC_CAP_VARIABLE_FRAME_SIZE AV_CODEC_CAP_VARIABLE_FRAME_SIZE
1278 /**
1279  * Codec is intra only.
1280  */
1281 #define CODEC_CAP_INTRA_ONLY       AV_CODEC_CAP_INTRA_ONLY
1282 /**
1283  * Codec is lossless.
1284  */
1285 #define CODEC_CAP_LOSSLESS         AV_CODEC_CAP_LOSSLESS
1286
1287 /**
1288  * HWAccel is experimental and is thus avoided in favor of non experimental
1289  * codecs
1290  */
1291 #define HWACCEL_CODEC_CAP_EXPERIMENTAL     0x0200
1292 #endif /* FF_API_WITHOUT_PREFIX */
1293
1294 #if FF_API_MB_TYPE
1295 //The following defines may change, don't expect compatibility if you use them.
1296 #define MB_TYPE_INTRA4x4   0x0001
1297 #define MB_TYPE_INTRA16x16 0x0002 //FIXME H.264-specific
1298 #define MB_TYPE_INTRA_PCM  0x0004 //FIXME H.264-specific
1299 #define MB_TYPE_16x16      0x0008
1300 #define MB_TYPE_16x8       0x0010
1301 #define MB_TYPE_8x16       0x0020
1302 #define MB_TYPE_8x8        0x0040
1303 #define MB_TYPE_INTERLACED 0x0080
1304 #define MB_TYPE_DIRECT2    0x0100 //FIXME
1305 #define MB_TYPE_ACPRED     0x0200
1306 #define MB_TYPE_GMC        0x0400
1307 #define MB_TYPE_SKIP       0x0800
1308 #define MB_TYPE_P0L0       0x1000
1309 #define MB_TYPE_P1L0       0x2000
1310 #define MB_TYPE_P0L1       0x4000
1311 #define MB_TYPE_P1L1       0x8000
1312 #define MB_TYPE_L0         (MB_TYPE_P0L0 | MB_TYPE_P1L0)
1313 #define MB_TYPE_L1         (MB_TYPE_P0L1 | MB_TYPE_P1L1)
1314 #define MB_TYPE_L0L1       (MB_TYPE_L0   | MB_TYPE_L1)
1315 #define MB_TYPE_QUANT      0x00010000
1316 #define MB_TYPE_CBP        0x00020000
1317 // Note bits 24-31 are reserved for codec specific use (H.264 ref0, MPEG-1 0mv, ...)
1318 #endif
1319
1320 /**
1321  * Pan Scan area.
1322  * This specifies the area which should be displayed.
1323  * Note there may be multiple such areas for one frame.
1324  */
1325 typedef struct AVPanScan{
1326     /**
1327      * id
1328      * - encoding: Set by user.
1329      * - decoding: Set by libavcodec.
1330      */
1331     int id;
1332
1333     /**
1334      * width and height in 1/16 pel
1335      * - encoding: Set by user.
1336      * - decoding: Set by libavcodec.
1337      */
1338     int width;
1339     int height;
1340
1341     /**
1342      * position of the top left corner in 1/16 pel for up to 3 fields/frames
1343      * - encoding: Set by user.
1344      * - decoding: Set by libavcodec.
1345      */
1346     int16_t position[3][2];
1347 }AVPanScan;
1348
1349 /**
1350  * This structure describes the bitrate properties of an encoded bitstream. It
1351  * roughly corresponds to a subset the VBV parameters for MPEG-2 or HRD
1352  * parameters for H.264/HEVC.
1353  */
1354 typedef struct AVCPBProperties {
1355     /**
1356      * Maximum bitrate of the stream, in bits per second.
1357      * Zero if unknown or unspecified.
1358      */
1359     int max_bitrate;
1360     /**
1361      * Minimum bitrate of the stream, in bits per second.
1362      * Zero if unknown or unspecified.
1363      */
1364     int min_bitrate;
1365     /**
1366      * Average bitrate of the stream, in bits per second.
1367      * Zero if unknown or unspecified.
1368      */
1369     int avg_bitrate;
1370
1371     /**
1372      * The size of the buffer to which the ratecontrol is applied, in bits.
1373      * Zero if unknown or unspecified.
1374      */
1375     int buffer_size;
1376
1377     /**
1378      * The delay between the time the packet this structure is associated with
1379      * is received and the time when it should be decoded, in periods of a 27MHz
1380      * clock.
1381      *
1382      * UINT64_MAX when unknown or unspecified.
1383      */
1384     uint64_t vbv_delay;
1385 } AVCPBProperties;
1386
1387 #if FF_API_QSCALE_TYPE
1388 #define FF_QSCALE_TYPE_MPEG1 0
1389 #define FF_QSCALE_TYPE_MPEG2 1
1390 #define FF_QSCALE_TYPE_H264  2
1391 #define FF_QSCALE_TYPE_VP56  3
1392 #endif
1393
1394 /**
1395  * The decoder will keep a reference to the frame and may reuse it later.
1396  */
1397 #define AV_GET_BUFFER_FLAG_REF (1 << 0)
1398
1399 /**
1400  * @defgroup lavc_packet AVPacket
1401  *
1402  * Types and functions for working with AVPacket.
1403  * @{
1404  */
1405 enum AVPacketSideDataType {
1406     /**
1407      * An AV_PKT_DATA_PALETTE side data packet contains exactly AVPALETTE_SIZE
1408      * bytes worth of palette. This side data signals that a new palette is
1409      * present.
1410      */
1411     AV_PKT_DATA_PALETTE,
1412
1413     /**
1414      * The AV_PKT_DATA_NEW_EXTRADATA is used to notify the codec or the format
1415      * that the extradata buffer was changed and the receiving side should
1416      * act upon it appropriately. The new extradata is embedded in the side
1417      * data buffer and should be immediately used for processing the current
1418      * frame or packet.
1419      */
1420     AV_PKT_DATA_NEW_EXTRADATA,
1421
1422     /**
1423      * An AV_PKT_DATA_PARAM_CHANGE side data packet is laid out as follows:
1424      * @code
1425      * u32le param_flags
1426      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT)
1427      *     s32le channel_count
1428      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT)
1429      *     u64le channel_layout
1430      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE)
1431      *     s32le sample_rate
1432      * if (param_flags & AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS)
1433      *     s32le width
1434      *     s32le height
1435      * @endcode
1436      */
1437     AV_PKT_DATA_PARAM_CHANGE,
1438
1439     /**
1440      * An AV_PKT_DATA_H263_MB_INFO side data packet contains a number of
1441      * structures with info about macroblocks relevant to splitting the
1442      * packet into smaller packets on macroblock edges (e.g. as for RFC 2190).
1443      * That is, it does not necessarily contain info about all macroblocks,
1444      * as long as the distance between macroblocks in the info is smaller
1445      * than the target payload size.
1446      * Each MB info structure is 12 bytes, and is laid out as follows:
1447      * @code
1448      * u32le bit offset from the start of the packet
1449      * u8    current quantizer at the start of the macroblock
1450      * u8    GOB number
1451      * u16le macroblock address within the GOB
1452      * u8    horizontal MV predictor
1453      * u8    vertical MV predictor
1454      * u8    horizontal MV predictor for block number 3
1455      * u8    vertical MV predictor for block number 3
1456      * @endcode
1457      */
1458     AV_PKT_DATA_H263_MB_INFO,
1459
1460     /**
1461      * This side data should be associated with an audio stream and contains
1462      * ReplayGain information in form of the AVReplayGain struct.
1463      */
1464     AV_PKT_DATA_REPLAYGAIN,
1465
1466     /**
1467      * This side data contains a 3x3 transformation matrix describing an affine
1468      * transformation that needs to be applied to the decoded video frames for
1469      * correct presentation.
1470      *
1471      * See libavutil/display.h for a detailed description of the data.
1472      */
1473     AV_PKT_DATA_DISPLAYMATRIX,
1474
1475     /**
1476      * This side data should be associated with a video stream and contains
1477      * Stereoscopic 3D information in form of the AVStereo3D struct.
1478      */
1479     AV_PKT_DATA_STEREO3D,
1480
1481     /**
1482      * This side data should be associated with an audio stream and corresponds
1483      * to enum AVAudioServiceType.
1484      */
1485     AV_PKT_DATA_AUDIO_SERVICE_TYPE,
1486
1487     /**
1488      * This side data contains quality related information from the encoder.
1489      * @code
1490      * u32le quality factor of the compressed frame. Allowed range is between 1 (good) and FF_LAMBDA_MAX (bad).
1491      * u8    picture type
1492      * u8    error count
1493      * u16   reserved
1494      * u64le[error count] sum of squared differences between encoder in and output
1495      * @endcode
1496      */
1497     AV_PKT_DATA_QUALITY_STATS,
1498
1499     /**
1500      * This side data contains an integer value representing the stream index
1501      * of a "fallback" track.  A fallback track indicates an alternate
1502      * track to use when the current track can not be decoded for some reason.
1503      * e.g. no decoder available for codec.
1504      */
1505     AV_PKT_DATA_FALLBACK_TRACK,
1506
1507     /**
1508      * This side data corresponds to the AVCPBProperties struct.
1509      */
1510     AV_PKT_DATA_CPB_PROPERTIES,
1511
1512     /**
1513      * Recommmends skipping the specified number of samples
1514      * @code
1515      * u32le number of samples to skip from start of this packet
1516      * u32le number of samples to skip from end of this packet
1517      * u8    reason for start skip
1518      * u8    reason for end   skip (0=padding silence, 1=convergence)
1519      * @endcode
1520      */
1521     AV_PKT_DATA_SKIP_SAMPLES=70,
1522
1523     /**
1524      * An AV_PKT_DATA_JP_DUALMONO side data packet indicates that
1525      * the packet may contain "dual mono" audio specific to Japanese DTV
1526      * and if it is true, recommends only the selected channel to be used.
1527      * @code
1528      * u8    selected channels (0=mail/left, 1=sub/right, 2=both)
1529      * @endcode
1530      */
1531     AV_PKT_DATA_JP_DUALMONO,
1532
1533     /**
1534      * A list of zero terminated key/value strings. There is no end marker for
1535      * the list, so it is required to rely on the side data size to stop.
1536      */
1537     AV_PKT_DATA_STRINGS_METADATA,
1538
1539     /**
1540      * Subtitle event position
1541      * @code
1542      * u32le x1
1543      * u32le y1
1544      * u32le x2
1545      * u32le y2
1546      * @endcode
1547      */
1548     AV_PKT_DATA_SUBTITLE_POSITION,
1549
1550     /**
1551      * Data found in BlockAdditional element of matroska container. There is
1552      * no end marker for the data, so it is required to rely on the side data
1553      * size to recognize the end. 8 byte id (as found in BlockAddId) followed
1554      * by data.
1555      */
1556     AV_PKT_DATA_MATROSKA_BLOCKADDITIONAL,
1557
1558     /**
1559      * The optional first identifier line of a WebVTT cue.
1560      */
1561     AV_PKT_DATA_WEBVTT_IDENTIFIER,
1562
1563     /**
1564      * The optional settings (rendering instructions) that immediately
1565      * follow the timestamp specifier of a WebVTT cue.
1566      */
1567     AV_PKT_DATA_WEBVTT_SETTINGS,
1568
1569     /**
1570      * A list of zero terminated key/value strings. There is no end marker for
1571      * the list, so it is required to rely on the side data size to stop. This
1572      * side data includes updated metadata which appeared in the stream.
1573      */
1574     AV_PKT_DATA_METADATA_UPDATE,
1575
1576     /**
1577      * MPEGTS stream ID, this is required to pass the stream ID
1578      * information from the demuxer to the corresponding muxer.
1579      */
1580     AV_PKT_DATA_MPEGTS_STREAM_ID,
1581
1582     /**
1583      * Mastering display metadata (based on SMPTE-2086:2014). This metadata
1584      * should be associated with a video stream and contains data in the form
1585      * of the AVMasteringDisplayMetadata struct.
1586      */
1587     AV_PKT_DATA_MASTERING_DISPLAY_METADATA,
1588
1589     /**
1590      * This side data should be associated with a video stream and corresponds
1591      * to the AVSphericalMapping structure.
1592      */
1593     AV_PKT_DATA_SPHERICAL,
1594
1595     /**
1596      * Content light level (based on CTA-861.3). This metadata should be
1597      * associated with a video stream and contains data in the form of the
1598      * AVContentLightMetadata struct.
1599      */
1600     AV_PKT_DATA_CONTENT_LIGHT_LEVEL,
1601
1602     /**
1603      * The number of side data elements (in fact a bit more than it).
1604      * This is not part of the public API/ABI in the sense that it may
1605      * change when new side data types are added.
1606      * This must stay the last enum value.
1607      * If its value becomes huge, some code using it
1608      * needs to be updated as it assumes it to be smaller than other limits.
1609      */
1610     AV_PKT_DATA_NB
1611 };
1612
1613 #define AV_PKT_DATA_QUALITY_FACTOR AV_PKT_DATA_QUALITY_STATS //DEPRECATED
1614
1615 typedef struct AVPacketSideData {
1616     uint8_t *data;
1617     int      size;
1618     enum AVPacketSideDataType type;
1619 } AVPacketSideData;
1620
1621 /**
1622  * This structure stores compressed data. It is typically exported by demuxers
1623  * and then passed as input to decoders, or received as output from encoders and
1624  * then passed to muxers.
1625  *
1626  * For video, it should typically contain one compressed frame. For audio it may
1627  * contain several compressed frames. Encoders are allowed to output empty
1628  * packets, with no compressed data, containing only side data
1629  * (e.g. to update some stream parameters at the end of encoding).
1630  *
1631  * AVPacket is one of the few structs in FFmpeg, whose size is a part of public
1632  * ABI. Thus it may be allocated on stack and no new fields can be added to it
1633  * without libavcodec and libavformat major bump.
1634  *
1635  * The semantics of data ownership depends on the buf field.
1636  * If it is set, the packet data is dynamically allocated and is
1637  * valid indefinitely until a call to av_packet_unref() reduces the
1638  * reference count to 0.
1639  *
1640  * If the buf field is not set av_packet_ref() would make a copy instead
1641  * of increasing the reference count.
1642  *
1643  * The side data is always allocated with av_malloc(), copied by
1644  * av_packet_ref() and freed by av_packet_unref().
1645  *
1646  * @see av_packet_ref
1647  * @see av_packet_unref
1648  */
1649 typedef struct AVPacket {
1650     /**
1651      * A reference to the reference-counted buffer where the packet data is
1652      * stored.
1653      * May be NULL, then the packet data is not reference-counted.
1654      */
1655     AVBufferRef *buf;
1656     /**
1657      * Presentation timestamp in AVStream->time_base units; the time at which
1658      * the decompressed packet will be presented to the user.
1659      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1660      * pts MUST be larger or equal to dts as presentation cannot happen before
1661      * decompression, unless one wants to view hex dumps. Some formats misuse
1662      * the terms dts and pts/cts to mean something different. Such timestamps
1663      * must be converted to true pts/dts before they are stored in AVPacket.
1664      */
1665     int64_t pts;
1666     /**
1667      * Decompression timestamp in AVStream->time_base units; the time at which
1668      * the packet is decompressed.
1669      * Can be AV_NOPTS_VALUE if it is not stored in the file.
1670      */
1671     int64_t dts;
1672     uint8_t *data;
1673     int   size;
1674     int   stream_index;
1675     /**
1676      * A combination of AV_PKT_FLAG values
1677      */
1678     int   flags;
1679     /**
1680      * Additional packet data that can be provided by the container.
1681      * Packet can contain several types of side information.
1682      */
1683     AVPacketSideData *side_data;
1684     int side_data_elems;
1685
1686     /**
1687      * Duration of this packet in AVStream->time_base units, 0 if unknown.
1688      * Equals next_pts - this_pts in presentation order.
1689      */
1690     int64_t duration;
1691
1692     int64_t pos;                            ///< byte position in stream, -1 if unknown
1693
1694 #if FF_API_CONVERGENCE_DURATION
1695     /**
1696      * @deprecated Same as the duration field, but as int64_t. This was required
1697      * for Matroska subtitles, whose duration values could overflow when the
1698      * duration field was still an int.
1699      */
1700     attribute_deprecated
1701     int64_t convergence_duration;
1702 #endif
1703 } AVPacket;
1704 #define AV_PKT_FLAG_KEY     0x0001 ///< The packet contains a keyframe
1705 #define AV_PKT_FLAG_CORRUPT 0x0002 ///< The packet content is corrupted
1706 /**
1707  * Flag is used to discard packets which are required to maintain valid
1708  * decoder state but are not required for output and should be dropped
1709  * after decoding.
1710  **/
1711 #define AV_PKT_FLAG_DISCARD   0x0004
1712 /**
1713  * The packet comes from a trusted source.
1714  *
1715  * Otherwise-unsafe constructs such as arbitrary pointers to data
1716  * outside the packet may be followed.
1717  */
1718 #define AV_PKT_FLAG_TRUSTED   0x0008
1719
1720 enum AVSideDataParamChangeFlags {
1721     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_COUNT  = 0x0001,
1722     AV_SIDE_DATA_PARAM_CHANGE_CHANNEL_LAYOUT = 0x0002,
1723     AV_SIDE_DATA_PARAM_CHANGE_SAMPLE_RATE    = 0x0004,
1724     AV_SIDE_DATA_PARAM_CHANGE_DIMENSIONS     = 0x0008,
1725 };
1726 /**
1727  * @}
1728  */
1729
1730 struct AVCodecInternal;
1731
1732 enum AVFieldOrder {
1733     AV_FIELD_UNKNOWN,
1734     AV_FIELD_PROGRESSIVE,
1735     AV_FIELD_TT,          //< Top coded_first, top displayed first
1736     AV_FIELD_BB,          //< Bottom coded first, bottom displayed first
1737     AV_FIELD_TB,          //< Top coded first, bottom displayed first
1738     AV_FIELD_BT,          //< Bottom coded first, top displayed first
1739 };
1740
1741 /**
1742  * main external API structure.
1743  * New fields can be added to the end with minor version bumps.
1744  * Removal, reordering and changes to existing fields require a major
1745  * version bump.
1746  * You can use AVOptions (av_opt* / av_set/get*()) to access these fields from user
1747  * applications.
1748  * The name string for AVOptions options matches the associated command line
1749  * parameter name and can be found in libavcodec/options_table.h
1750  * The AVOption/command line parameter names differ in some cases from the C
1751  * structure field names for historic reasons or brevity.
1752  * sizeof(AVCodecContext) must not be used outside libav*.
1753  */
1754 typedef struct AVCodecContext {
1755     /**
1756      * information on struct for av_log
1757      * - set by avcodec_alloc_context3
1758      */
1759     const AVClass *av_class;
1760     int log_level_offset;
1761
1762     enum AVMediaType codec_type; /* see AVMEDIA_TYPE_xxx */
1763     const struct AVCodec  *codec;
1764 #if FF_API_CODEC_NAME
1765     /**
1766      * @deprecated this field is not used for anything in libavcodec
1767      */
1768     attribute_deprecated
1769     char             codec_name[32];
1770 #endif
1771     enum AVCodecID     codec_id; /* see AV_CODEC_ID_xxx */
1772
1773     /**
1774      * fourcc (LSB first, so "ABCD" -> ('D'<<24) + ('C'<<16) + ('B'<<8) + 'A').
1775      * This is used to work around some encoder bugs.
1776      * A demuxer should set this to what is stored in the field used to identify the codec.
1777      * If there are multiple such fields in a container then the demuxer should choose the one
1778      * which maximizes the information about the used codec.
1779      * If the codec tag field in a container is larger than 32 bits then the demuxer should
1780      * remap the longer ID to 32 bits with a table or other structure. Alternatively a new
1781      * extra_codec_tag + size could be added but for this a clear advantage must be demonstrated
1782      * first.
1783      * - encoding: Set by user, if not then the default based on codec_id will be used.
1784      * - decoding: Set by user, will be converted to uppercase by libavcodec during init.
1785      */
1786     unsigned int codec_tag;
1787
1788 #if FF_API_STREAM_CODEC_TAG
1789     /**
1790      * @deprecated this field is unused
1791      */
1792     attribute_deprecated
1793     unsigned int stream_codec_tag;
1794 #endif
1795
1796     void *priv_data;
1797
1798     /**
1799      * Private context used for internal data.
1800      *
1801      * Unlike priv_data, this is not codec-specific. It is used in general
1802      * libavcodec functions.
1803      */
1804     struct AVCodecInternal *internal;
1805
1806     /**
1807      * Private data of the user, can be used to carry app specific stuff.
1808      * - encoding: Set by user.
1809      * - decoding: Set by user.
1810      */
1811     void *opaque;
1812
1813     /**
1814      * the average bitrate
1815      * - encoding: Set by user; unused for constant quantizer encoding.
1816      * - decoding: Set by user, may be overwritten by libavcodec
1817      *             if this info is available in the stream
1818      */
1819     int64_t bit_rate;
1820
1821     /**
1822      * number of bits the bitstream is allowed to diverge from the reference.
1823      *           the reference can be CBR (for CBR pass1) or VBR (for pass2)
1824      * - encoding: Set by user; unused for constant quantizer encoding.
1825      * - decoding: unused
1826      */
1827     int bit_rate_tolerance;
1828
1829     /**
1830      * Global quality for codecs which cannot change it per frame.
1831      * This should be proportional to MPEG-1/2/4 qscale.
1832      * - encoding: Set by user.
1833      * - decoding: unused
1834      */
1835     int global_quality;
1836
1837     /**
1838      * - encoding: Set by user.
1839      * - decoding: unused
1840      */
1841     int compression_level;
1842 #define FF_COMPRESSION_DEFAULT -1
1843
1844     /**
1845      * AV_CODEC_FLAG_*.
1846      * - encoding: Set by user.
1847      * - decoding: Set by user.
1848      */
1849     int flags;
1850
1851     /**
1852      * AV_CODEC_FLAG2_*
1853      * - encoding: Set by user.
1854      * - decoding: Set by user.
1855      */
1856     int flags2;
1857
1858     /**
1859      * some codecs need / can use extradata like Huffman tables.
1860      * MJPEG: Huffman tables
1861      * rv10: additional flags
1862      * MPEG-4: global headers (they can be in the bitstream or here)
1863      * The allocated memory should be AV_INPUT_BUFFER_PADDING_SIZE bytes larger
1864      * than extradata_size to avoid problems if it is read with the bitstream reader.
1865      * The bytewise contents of extradata must not depend on the architecture or CPU endianness.
1866      * - encoding: Set/allocated/freed by libavcodec.
1867      * - decoding: Set/allocated/freed by user.
1868      */
1869     uint8_t *extradata;
1870     int extradata_size;
1871
1872     /**
1873      * This is the fundamental unit of time (in seconds) in terms
1874      * of which frame timestamps are represented. For fixed-fps content,
1875      * timebase should be 1/framerate and timestamp increments should be
1876      * identically 1.
1877      * This often, but not always is the inverse of the frame rate or field rate
1878      * for video. 1/time_base is not the average frame rate if the frame rate is not
1879      * constant.
1880      *
1881      * Like containers, elementary streams also can store timestamps, 1/time_base
1882      * is the unit in which these timestamps are specified.
1883      * As example of such codec time base see ISO/IEC 14496-2:2001(E)
1884      * vop_time_increment_resolution and fixed_vop_rate
1885      * (fixed_vop_rate == 0 implies that it is different from the framerate)
1886      *
1887      * - encoding: MUST be set by user.
1888      * - decoding: the use of this field for decoding is deprecated.
1889      *             Use framerate instead.
1890      */
1891     AVRational time_base;
1892
1893     /**
1894      * For some codecs, the time base is closer to the field rate than the frame rate.
1895      * Most notably, H.264 and MPEG-2 specify time_base as half of frame duration
1896      * if no telecine is used ...
1897      *
1898      * Set to time_base ticks per frame. Default 1, e.g., H.264/MPEG-2 set it to 2.
1899      */
1900     int ticks_per_frame;
1901
1902     /**
1903      * Codec delay.
1904      *
1905      * Encoding: Number of frames delay there will be from the encoder input to
1906      *           the decoder output. (we assume the decoder matches the spec)
1907      * Decoding: Number of frames delay in addition to what a standard decoder
1908      *           as specified in the spec would produce.
1909      *
1910      * Video:
1911      *   Number of frames the decoded output will be delayed relative to the
1912      *   encoded input.
1913      *
1914      * Audio:
1915      *   For encoding, this field is unused (see initial_padding).
1916      *
1917      *   For decoding, this is the number of samples the decoder needs to
1918      *   output before the decoder's output is valid. When seeking, you should
1919      *   start decoding this many samples prior to your desired seek point.
1920      *
1921      * - encoding: Set by libavcodec.
1922      * - decoding: Set by libavcodec.
1923      */
1924     int delay;
1925
1926
1927     /* video only */
1928     /**
1929      * picture width / height.
1930      *
1931      * @note Those fields may not match the values of the last
1932      * AVFrame output by avcodec_decode_video2 due frame
1933      * reordering.
1934      *
1935      * - encoding: MUST be set by user.
1936      * - decoding: May be set by the user before opening the decoder if known e.g.
1937      *             from the container. Some decoders will require the dimensions
1938      *             to be set by the caller. During decoding, the decoder may
1939      *             overwrite those values as required while parsing the data.
1940      */
1941     int width, height;
1942
1943     /**
1944      * Bitstream width / height, may be different from width/height e.g. when
1945      * the decoded frame is cropped before being output or lowres is enabled.
1946      *
1947      * @note Those field may not match the value of the last
1948      * AVFrame output by avcodec_receive_frame() due frame
1949      * reordering.
1950      *
1951      * - encoding: unused
1952      * - decoding: May be set by the user before opening the decoder if known
1953      *             e.g. from the container. During decoding, the decoder may
1954      *             overwrite those values as required while parsing the data.
1955      */
1956     int coded_width, coded_height;
1957
1958 #if FF_API_ASPECT_EXTENDED
1959 #define FF_ASPECT_EXTENDED 15
1960 #endif
1961
1962     /**
1963      * the number of pictures in a group of pictures, or 0 for intra_only
1964      * - encoding: Set by user.
1965      * - decoding: unused
1966      */
1967     int gop_size;
1968
1969     /**
1970      * Pixel format, see AV_PIX_FMT_xxx.
1971      * May be set by the demuxer if known from headers.
1972      * May be overridden by the decoder if it knows better.
1973      *
1974      * @note This field may not match the value of the last
1975      * AVFrame output by avcodec_receive_frame() due frame
1976      * reordering.
1977      *
1978      * - encoding: Set by user.
1979      * - decoding: Set by user if known, overridden by libavcodec while
1980      *             parsing the data.
1981      */
1982     enum AVPixelFormat pix_fmt;
1983
1984 #if FF_API_MOTION_EST
1985     /**
1986      * This option does nothing
1987      * @deprecated use codec private options instead
1988      */
1989     attribute_deprecated int me_method;
1990 #endif
1991
1992     /**
1993      * If non NULL, 'draw_horiz_band' is called by the libavcodec
1994      * decoder to draw a horizontal band. It improves cache usage. Not
1995      * all codecs can do that. You must check the codec capabilities
1996      * beforehand.
1997      * When multithreading is used, it may be called from multiple threads
1998      * at the same time; threads might draw different parts of the same AVFrame,
1999      * or multiple AVFrames, and there is no guarantee that slices will be drawn
2000      * in order.
2001      * The function is also used by hardware acceleration APIs.
2002      * It is called at least once during frame decoding to pass
2003      * the data needed for hardware render.
2004      * In that mode instead of pixel data, AVFrame points to
2005      * a structure specific to the acceleration API. The application
2006      * reads the structure and can change some fields to indicate progress
2007      * or mark state.
2008      * - encoding: unused
2009      * - decoding: Set by user.
2010      * @param height the height of the slice
2011      * @param y the y position of the slice
2012      * @param type 1->top field, 2->bottom field, 3->frame
2013      * @param offset offset into the AVFrame.data from which the slice should be read
2014      */
2015     void (*draw_horiz_band)(struct AVCodecContext *s,
2016                             const AVFrame *src, int offset[AV_NUM_DATA_POINTERS],
2017                             int y, int type, int height);
2018
2019     /**
2020      * callback to negotiate the pixelFormat
2021      * @param fmt is the list of formats which are supported by the codec,
2022      * it is terminated by -1 as 0 is a valid format, the formats are ordered by quality.
2023      * The first is always the native one.
2024      * @note The callback may be called again immediately if initialization for
2025      * the selected (hardware-accelerated) pixel format failed.
2026      * @warning Behavior is undefined if the callback returns a value not
2027      * in the fmt list of formats.
2028      * @return the chosen format
2029      * - encoding: unused
2030      * - decoding: Set by user, if not set the native format will be chosen.
2031      */
2032     enum AVPixelFormat (*get_format)(struct AVCodecContext *s, const enum AVPixelFormat * fmt);
2033
2034     /**
2035      * maximum number of B-frames between non-B-frames
2036      * Note: The output will be delayed by max_b_frames+1 relative to the input.
2037      * - encoding: Set by user.
2038      * - decoding: unused
2039      */
2040     int max_b_frames;
2041
2042     /**
2043      * qscale factor between IP and B-frames
2044      * If > 0 then the last P-frame quantizer will be used (q= lastp_q*factor+offset).
2045      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2046      * - encoding: Set by user.
2047      * - decoding: unused
2048      */
2049     float b_quant_factor;
2050
2051 #if FF_API_RC_STRATEGY
2052     /** @deprecated use codec private option instead */
2053     attribute_deprecated int rc_strategy;
2054 #define FF_RC_STRATEGY_XVID 1
2055 #endif
2056
2057 #if FF_API_PRIVATE_OPT
2058     /** @deprecated use encoder private options instead */
2059     attribute_deprecated
2060     int b_frame_strategy;
2061 #endif
2062
2063     /**
2064      * qscale offset between IP and B-frames
2065      * - encoding: Set by user.
2066      * - decoding: unused
2067      */
2068     float b_quant_offset;
2069
2070     /**
2071      * Size of the frame reordering buffer in the decoder.
2072      * For MPEG-2 it is 1 IPB or 0 low delay IP.
2073      * - encoding: Set by libavcodec.
2074      * - decoding: Set by libavcodec.
2075      */
2076     int has_b_frames;
2077
2078 #if FF_API_PRIVATE_OPT
2079     /** @deprecated use encoder private options instead */
2080     attribute_deprecated
2081     int mpeg_quant;
2082 #endif
2083
2084     /**
2085      * qscale factor between P- and I-frames
2086      * If > 0 then the last P-frame quantizer will be used (q = lastp_q * factor + offset).
2087      * If < 0 then normal ratecontrol will be done (q= -normal_q*factor+offset).
2088      * - encoding: Set by user.
2089      * - decoding: unused
2090      */
2091     float i_quant_factor;
2092
2093     /**
2094      * qscale offset between P and I-frames
2095      * - encoding: Set by user.
2096      * - decoding: unused
2097      */
2098     float i_quant_offset;
2099
2100     /**
2101      * luminance masking (0-> disabled)
2102      * - encoding: Set by user.
2103      * - decoding: unused
2104      */
2105     float lumi_masking;
2106
2107     /**
2108      * temporary complexity masking (0-> disabled)
2109      * - encoding: Set by user.
2110      * - decoding: unused
2111      */
2112     float temporal_cplx_masking;
2113
2114     /**
2115      * spatial complexity masking (0-> disabled)
2116      * - encoding: Set by user.
2117      * - decoding: unused
2118      */
2119     float spatial_cplx_masking;
2120
2121     /**
2122      * p block masking (0-> disabled)
2123      * - encoding: Set by user.
2124      * - decoding: unused
2125      */
2126     float p_masking;
2127
2128     /**
2129      * darkness masking (0-> disabled)
2130      * - encoding: Set by user.
2131      * - decoding: unused
2132      */
2133     float dark_masking;
2134
2135     /**
2136      * slice count
2137      * - encoding: Set by libavcodec.
2138      * - decoding: Set by user (or 0).
2139      */
2140     int slice_count;
2141
2142 #if FF_API_PRIVATE_OPT
2143     /** @deprecated use encoder private options instead */
2144     attribute_deprecated
2145      int prediction_method;
2146 #define FF_PRED_LEFT   0
2147 #define FF_PRED_PLANE  1
2148 #define FF_PRED_MEDIAN 2
2149 #endif
2150
2151     /**
2152      * slice offsets in the frame in bytes
2153      * - encoding: Set/allocated by libavcodec.
2154      * - decoding: Set/allocated by user (or NULL).
2155      */
2156     int *slice_offset;
2157
2158     /**
2159      * sample aspect ratio (0 if unknown)
2160      * That is the width of a pixel divided by the height of the pixel.
2161      * Numerator and denominator must be relatively prime and smaller than 256 for some video standards.
2162      * - encoding: Set by user.
2163      * - decoding: Set by libavcodec.
2164      */
2165     AVRational sample_aspect_ratio;
2166
2167     /**
2168      * motion estimation comparison function
2169      * - encoding: Set by user.
2170      * - decoding: unused
2171      */
2172     int me_cmp;
2173     /**
2174      * subpixel motion estimation comparison function
2175      * - encoding: Set by user.
2176      * - decoding: unused
2177      */
2178     int me_sub_cmp;
2179     /**
2180      * macroblock comparison function (not supported yet)
2181      * - encoding: Set by user.
2182      * - decoding: unused
2183      */
2184     int mb_cmp;
2185     /**
2186      * interlaced DCT comparison function
2187      * - encoding: Set by user.
2188      * - decoding: unused
2189      */
2190     int ildct_cmp;
2191 #define FF_CMP_SAD          0
2192 #define FF_CMP_SSE          1
2193 #define FF_CMP_SATD         2
2194 #define FF_CMP_DCT          3
2195 #define FF_CMP_PSNR         4
2196 #define FF_CMP_BIT          5
2197 #define FF_CMP_RD           6
2198 #define FF_CMP_ZERO         7
2199 #define FF_CMP_VSAD         8
2200 #define FF_CMP_VSSE         9
2201 #define FF_CMP_NSSE         10
2202 #define FF_CMP_W53          11
2203 #define FF_CMP_W97          12
2204 #define FF_CMP_DCTMAX       13
2205 #define FF_CMP_DCT264       14
2206 #define FF_CMP_MEDIAN_SAD   15
2207 #define FF_CMP_CHROMA       256
2208
2209     /**
2210      * ME diamond size & shape
2211      * - encoding: Set by user.
2212      * - decoding: unused
2213      */
2214     int dia_size;
2215
2216     /**
2217      * amount of previous MV predictors (2a+1 x 2a+1 square)
2218      * - encoding: Set by user.
2219      * - decoding: unused
2220      */
2221     int last_predictor_count;
2222
2223 #if FF_API_PRIVATE_OPT
2224     /** @deprecated use encoder private options instead */
2225     attribute_deprecated
2226     int pre_me;
2227 #endif
2228
2229     /**
2230      * motion estimation prepass comparison function
2231      * - encoding: Set by user.
2232      * - decoding: unused
2233      */
2234     int me_pre_cmp;
2235
2236     /**
2237      * ME prepass diamond size & shape
2238      * - encoding: Set by user.
2239      * - decoding: unused
2240      */
2241     int pre_dia_size;
2242
2243     /**
2244      * subpel ME quality
2245      * - encoding: Set by user.
2246      * - decoding: unused
2247      */
2248     int me_subpel_quality;
2249
2250 #if FF_API_AFD
2251     /**
2252      * DTG active format information (additional aspect ratio
2253      * information only used in DVB MPEG-2 transport streams)
2254      * 0 if not set.
2255      *
2256      * - encoding: unused
2257      * - decoding: Set by decoder.
2258      * @deprecated Deprecated in favor of AVSideData
2259      */
2260     attribute_deprecated int dtg_active_format;
2261 #define FF_DTG_AFD_SAME         8
2262 #define FF_DTG_AFD_4_3          9
2263 #define FF_DTG_AFD_16_9         10
2264 #define FF_DTG_AFD_14_9         11
2265 #define FF_DTG_AFD_4_3_SP_14_9  13
2266 #define FF_DTG_AFD_16_9_SP_14_9 14
2267 #define FF_DTG_AFD_SP_4_3       15
2268 #endif /* FF_API_AFD */
2269
2270     /**
2271      * maximum motion estimation search range in subpel units
2272      * If 0 then no limit.
2273      *
2274      * - encoding: Set by user.
2275      * - decoding: unused
2276      */
2277     int me_range;
2278
2279 #if FF_API_QUANT_BIAS
2280     /**
2281      * @deprecated use encoder private option instead
2282      */
2283     attribute_deprecated int intra_quant_bias;
2284 #define FF_DEFAULT_QUANT_BIAS 999999
2285
2286     /**
2287      * @deprecated use encoder private option instead
2288      */
2289     attribute_deprecated int inter_quant_bias;
2290 #endif
2291
2292     /**
2293      * slice flags
2294      * - encoding: unused
2295      * - decoding: Set by user.
2296      */
2297     int slice_flags;
2298 #define SLICE_FLAG_CODED_ORDER    0x0001 ///< draw_horiz_band() is called in coded order instead of display
2299 #define SLICE_FLAG_ALLOW_FIELD    0x0002 ///< allow draw_horiz_band() with field slices (MPEG-2 field pics)
2300 #define SLICE_FLAG_ALLOW_PLANE    0x0004 ///< allow draw_horiz_band() with 1 component at a time (SVQ1)
2301
2302 #if FF_API_XVMC
2303     /**
2304      * XVideo Motion Acceleration
2305      * - encoding: forbidden
2306      * - decoding: set by decoder
2307      * @deprecated XvMC doesn't need it anymore.
2308      */
2309     attribute_deprecated int xvmc_acceleration;
2310 #endif /* FF_API_XVMC */
2311
2312     /**
2313      * macroblock decision mode
2314      * - encoding: Set by user.
2315      * - decoding: unused
2316      */
2317     int mb_decision;
2318 #define FF_MB_DECISION_SIMPLE 0        ///< uses mb_cmp
2319 #define FF_MB_DECISION_BITS   1        ///< chooses the one which needs the fewest bits
2320 #define FF_MB_DECISION_RD     2        ///< rate distortion
2321
2322     /**
2323      * custom intra quantization matrix
2324      * - encoding: Set by user, can be NULL.
2325      * - decoding: Set by libavcodec.
2326      */
2327     uint16_t *intra_matrix;
2328
2329     /**
2330      * custom inter quantization matrix
2331      * - encoding: Set by user, can be NULL.
2332      * - decoding: Set by libavcodec.
2333      */
2334     uint16_t *inter_matrix;
2335
2336 #if FF_API_PRIVATE_OPT
2337     /** @deprecated use encoder private options instead */
2338     attribute_deprecated
2339     int scenechange_threshold;
2340
2341     /** @deprecated use encoder private options instead */
2342     attribute_deprecated
2343     int noise_reduction;
2344 #endif
2345
2346 #if FF_API_MPV_OPT
2347     /**
2348      * @deprecated this field is unused
2349      */
2350     attribute_deprecated
2351     int me_threshold;
2352
2353     /**
2354      * @deprecated this field is unused
2355      */
2356     attribute_deprecated
2357     int mb_threshold;
2358 #endif
2359
2360     /**
2361      * precision of the intra DC coefficient - 8
2362      * - encoding: Set by user.
2363      * - decoding: Set by libavcodec
2364      */
2365     int intra_dc_precision;
2366
2367     /**
2368      * Number of macroblock rows at the top which are skipped.
2369      * - encoding: unused
2370      * - decoding: Set by user.
2371      */
2372     int skip_top;
2373
2374     /**
2375      * Number of macroblock rows at the bottom which are skipped.
2376      * - encoding: unused
2377      * - decoding: Set by user.
2378      */
2379     int skip_bottom;
2380
2381 #if FF_API_MPV_OPT
2382     /**
2383      * @deprecated use encoder private options instead
2384      */
2385     attribute_deprecated
2386     float border_masking;
2387 #endif
2388
2389     /**
2390      * minimum MB Lagrange multiplier
2391      * - encoding: Set by user.
2392      * - decoding: unused
2393      */
2394     int mb_lmin;
2395
2396     /**
2397      * maximum MB Lagrange multiplier
2398      * - encoding: Set by user.
2399      * - decoding: unused
2400      */
2401     int mb_lmax;
2402
2403 #if FF_API_PRIVATE_OPT
2404     /**
2405      * @deprecated use encoder private options instead
2406      */
2407     attribute_deprecated
2408     int me_penalty_compensation;
2409 #endif
2410
2411     /**
2412      * - encoding: Set by user.
2413      * - decoding: unused
2414      */
2415     int bidir_refine;
2416
2417 #if FF_API_PRIVATE_OPT
2418     /** @deprecated use encoder private options instead */
2419     attribute_deprecated
2420     int brd_scale;
2421 #endif
2422
2423     /**
2424      * minimum GOP size
2425      * - encoding: Set by user.
2426      * - decoding: unused
2427      */
2428     int keyint_min;
2429
2430     /**
2431      * number of reference frames
2432      * - encoding: Set by user.
2433      * - decoding: Set by lavc.
2434      */
2435     int refs;
2436
2437 #if FF_API_PRIVATE_OPT
2438     /** @deprecated use encoder private options instead */
2439     attribute_deprecated
2440     int chromaoffset;
2441 #endif
2442
2443 #if FF_API_UNUSED_MEMBERS
2444     /**
2445      * Multiplied by qscale for each frame and added to scene_change_score.
2446      * - encoding: Set by user.
2447      * - decoding: unused
2448      */
2449     attribute_deprecated int scenechange_factor;
2450 #endif
2451
2452     /**
2453      * Note: Value depends upon the compare function used for fullpel ME.
2454      * - encoding: Set by user.
2455      * - decoding: unused
2456      */
2457     int mv0_threshold;
2458
2459 #if FF_API_PRIVATE_OPT
2460     /** @deprecated use encoder private options instead */
2461     attribute_deprecated
2462     int b_sensitivity;
2463 #endif
2464
2465     /**
2466      * Chromaticity coordinates of the source primaries.
2467      * - encoding: Set by user
2468      * - decoding: Set by libavcodec
2469      */
2470     enum AVColorPrimaries color_primaries;
2471
2472     /**
2473      * Color Transfer Characteristic.
2474      * - encoding: Set by user
2475      * - decoding: Set by libavcodec
2476      */
2477     enum AVColorTransferCharacteristic color_trc;
2478
2479     /**
2480      * YUV colorspace type.
2481      * - encoding: Set by user
2482      * - decoding: Set by libavcodec
2483      */
2484     enum AVColorSpace colorspace;
2485
2486     /**
2487      * MPEG vs JPEG YUV range.
2488      * - encoding: Set by user
2489      * - decoding: Set by libavcodec
2490      */
2491     enum AVColorRange color_range;
2492
2493     /**
2494      * This defines the location of chroma samples.
2495      * - encoding: Set by user
2496      * - decoding: Set by libavcodec
2497      */
2498     enum AVChromaLocation chroma_sample_location;
2499
2500     /**
2501      * Number of slices.
2502      * Indicates number of picture subdivisions. Used for parallelized
2503      * decoding.
2504      * - encoding: Set by user
2505      * - decoding: unused
2506      */
2507     int slices;
2508
2509     /** Field order
2510      * - encoding: set by libavcodec
2511      * - decoding: Set by user.
2512      */
2513     enum AVFieldOrder field_order;
2514
2515     /* audio only */
2516     int sample_rate; ///< samples per second
2517     int channels;    ///< number of audio channels
2518
2519     /**
2520      * audio sample format
2521      * - encoding: Set by user.
2522      * - decoding: Set by libavcodec.
2523      */
2524     enum AVSampleFormat sample_fmt;  ///< sample format
2525
2526     /* The following data should not be initialized. */
2527     /**
2528      * Number of samples per channel in an audio frame.
2529      *
2530      * - encoding: set by libavcodec in avcodec_open2(). Each submitted frame
2531      *   except the last must contain exactly frame_size samples per channel.
2532      *   May be 0 when the codec has AV_CODEC_CAP_VARIABLE_FRAME_SIZE set, then the
2533      *   frame size is not restricted.
2534      * - decoding: may be set by some decoders to indicate constant frame size
2535      */
2536     int frame_size;
2537
2538     /**
2539      * Frame counter, set by libavcodec.
2540      *
2541      * - decoding: total number of frames returned from the decoder so far.
2542      * - encoding: total number of frames passed to the encoder so far.
2543      *
2544      *   @note the counter is not incremented if encoding/decoding resulted in
2545      *   an error.
2546      */
2547     int frame_number;
2548
2549     /**
2550      * number of bytes per packet if constant and known or 0
2551      * Used by some WAV based audio codecs.
2552      */
2553     int block_align;
2554
2555     /**
2556      * Audio cutoff bandwidth (0 means "automatic")
2557      * - encoding: Set by user.
2558      * - decoding: unused
2559      */
2560     int cutoff;
2561
2562     /**
2563      * Audio channel layout.
2564      * - encoding: set by user.
2565      * - decoding: set by user, may be overwritten by libavcodec.
2566      */
2567     uint64_t channel_layout;
2568
2569     /**
2570      * Request decoder to use this channel layout if it can (0 for default)
2571      * - encoding: unused
2572      * - decoding: Set by user.
2573      */
2574     uint64_t request_channel_layout;
2575
2576     /**
2577      * Type of service that the audio stream conveys.
2578      * - encoding: Set by user.
2579      * - decoding: Set by libavcodec.
2580      */
2581     enum AVAudioServiceType audio_service_type;
2582
2583     /**
2584      * desired sample format
2585      * - encoding: Not used.
2586      * - decoding: Set by user.
2587      * Decoder will decode to this format if it can.
2588      */
2589     enum AVSampleFormat request_sample_fmt;
2590
2591     /**
2592      * This callback is called at the beginning of each frame to get data
2593      * buffer(s) for it. There may be one contiguous buffer for all the data or
2594      * there may be a buffer per each data plane or anything in between. What
2595      * this means is, you may set however many entries in buf[] you feel necessary.
2596      * Each buffer must be reference-counted using the AVBuffer API (see description
2597      * of buf[] below).
2598      *
2599      * The following fields will be set in the frame before this callback is
2600      * called:
2601      * - format
2602      * - width, height (video only)
2603      * - sample_rate, channel_layout, nb_samples (audio only)
2604      * Their values may differ from the corresponding values in
2605      * AVCodecContext. This callback must use the frame values, not the codec
2606      * context values, to calculate the required buffer size.
2607      *
2608      * This callback must fill the following fields in the frame:
2609      * - data[]
2610      * - linesize[]
2611      * - extended_data:
2612      *   * if the data is planar audio with more than 8 channels, then this
2613      *     callback must allocate and fill extended_data to contain all pointers
2614      *     to all data planes. data[] must hold as many pointers as it can.
2615      *     extended_data must be allocated with av_malloc() and will be freed in
2616      *     av_frame_unref().
2617      *   * otherwise extended_data must point to data
2618      * - buf[] must contain one or more pointers to AVBufferRef structures. Each of
2619      *   the frame's data and extended_data pointers must be contained in these. That
2620      *   is, one AVBufferRef for each allocated chunk of memory, not necessarily one
2621      *   AVBufferRef per data[] entry. See: av_buffer_create(), av_buffer_alloc(),
2622      *   and av_buffer_ref().
2623      * - extended_buf and nb_extended_buf must be allocated with av_malloc() by
2624      *   this callback and filled with the extra buffers if there are more
2625      *   buffers than buf[] can hold. extended_buf will be freed in
2626      *   av_frame_unref().
2627      *
2628      * If AV_CODEC_CAP_DR1 is not set then get_buffer2() must call
2629      * avcodec_default_get_buffer2() instead of providing buffers allocated by
2630      * some other means.
2631      *
2632      * Each data plane must be aligned to the maximum required by the target
2633      * CPU.
2634      *
2635      * @see avcodec_default_get_buffer2()
2636      *
2637      * Video:
2638      *
2639      * If AV_GET_BUFFER_FLAG_REF is set in flags then the frame may be reused
2640      * (read and/or written to if it is writable) later by libavcodec.
2641      *
2642      * avcodec_align_dimensions2() should be used to find the required width and
2643      * height, as they normally need to be rounded up to the next multiple of 16.
2644      *
2645      * Some decoders do not support linesizes changing between frames.
2646      *
2647      * If frame multithreading is used and thread_safe_callbacks is set,
2648      * this callback may be called from a different thread, but not from more
2649      * than one at once. Does not need to be reentrant.
2650      *
2651      * @see avcodec_align_dimensions2()
2652      *
2653      * Audio:
2654      *
2655      * Decoders request a buffer of a particular size by setting
2656      * AVFrame.nb_samples prior to calling get_buffer2(). The decoder may,
2657      * however, utilize only part of the buffer by setting AVFrame.nb_samples
2658      * to a smaller value in the output frame.
2659      *
2660      * As a convenience, av_samples_get_buffer_size() and
2661      * av_samples_fill_arrays() in libavutil may be used by custom get_buffer2()
2662      * functions to find the required data size and to fill data pointers and
2663      * linesize. In AVFrame.linesize, only linesize[0] may be set for audio
2664      * since all planes must be the same size.
2665      *
2666      * @see av_samples_get_buffer_size(), av_samples_fill_arrays()
2667      *
2668      * - encoding: unused
2669      * - decoding: Set by libavcodec, user can override.
2670      */
2671     int (*get_buffer2)(struct AVCodecContext *s, AVFrame *frame, int flags);
2672
2673     /**
2674      * If non-zero, the decoded audio and video frames returned from
2675      * avcodec_decode_video2() and avcodec_decode_audio4() are reference-counted
2676      * and are valid indefinitely. The caller must free them with
2677      * av_frame_unref() when they are not needed anymore.
2678      * Otherwise, the decoded frames must not be freed by the caller and are
2679      * only valid until the next decode call.
2680      *
2681      * This is always automatically enabled if avcodec_receive_frame() is used.
2682      *
2683      * - encoding: unused
2684      * - decoding: set by the caller before avcodec_open2().
2685      */
2686     attribute_deprecated
2687     int refcounted_frames;
2688
2689     /* - encoding parameters */
2690     float qcompress;  ///< amount of qscale change between easy & hard scenes (0.0-1.0)
2691     float qblur;      ///< amount of qscale smoothing over time (0.0-1.0)
2692
2693     /**
2694      * minimum quantizer
2695      * - encoding: Set by user.
2696      * - decoding: unused
2697      */
2698     int qmin;
2699
2700     /**
2701      * maximum quantizer
2702      * - encoding: Set by user.
2703      * - decoding: unused
2704      */
2705     int qmax;
2706
2707     /**
2708      * maximum quantizer difference between frames
2709      * - encoding: Set by user.
2710      * - decoding: unused
2711      */
2712     int max_qdiff;
2713
2714 #if FF_API_MPV_OPT
2715     /**
2716      * @deprecated use encoder private options instead
2717      */
2718     attribute_deprecated
2719     float rc_qsquish;
2720
2721     attribute_deprecated
2722     float rc_qmod_amp;
2723     attribute_deprecated
2724     int rc_qmod_freq;
2725 #endif
2726
2727     /**
2728      * decoder bitstream buffer size
2729      * - encoding: Set by user.
2730      * - decoding: unused
2731      */
2732     int rc_buffer_size;
2733
2734     /**
2735      * ratecontrol override, see RcOverride
2736      * - encoding: Allocated/set/freed by user.
2737      * - decoding: unused
2738      */
2739     int rc_override_count;
2740     RcOverride *rc_override;
2741
2742 #if FF_API_MPV_OPT
2743     /**
2744      * @deprecated use encoder private options instead
2745      */
2746     attribute_deprecated
2747     const char *rc_eq;
2748 #endif
2749
2750     /**
2751      * maximum bitrate
2752      * - encoding: Set by user.
2753      * - decoding: Set by user, may be overwritten by libavcodec.
2754      */
2755     int64_t rc_max_rate;
2756
2757     /**
2758      * minimum bitrate
2759      * - encoding: Set by user.
2760      * - decoding: unused
2761      */
2762     int64_t rc_min_rate;
2763
2764 #if FF_API_MPV_OPT
2765     /**
2766      * @deprecated use encoder private options instead
2767      */
2768     attribute_deprecated
2769     float rc_buffer_aggressivity;
2770
2771     attribute_deprecated
2772     float rc_initial_cplx;
2773 #endif
2774
2775     /**
2776      * Ratecontrol attempt to use, at maximum, <value> of what can be used without an underflow.
2777      * - encoding: Set by user.
2778      * - decoding: unused.
2779      */
2780     float rc_max_available_vbv_use;
2781
2782     /**
2783      * Ratecontrol attempt to use, at least, <value> times the amount needed to prevent a vbv overflow.
2784      * - encoding: Set by user.
2785      * - decoding: unused.
2786      */
2787     float rc_min_vbv_overflow_use;
2788
2789     /**
2790      * Number of bits which should be loaded into the rc buffer before decoding starts.
2791      * - encoding: Set by user.
2792      * - decoding: unused
2793      */
2794     int rc_initial_buffer_occupancy;
2795
2796 #if FF_API_CODER_TYPE
2797 #define FF_CODER_TYPE_VLC       0
2798 #define FF_CODER_TYPE_AC        1
2799 #define FF_CODER_TYPE_RAW       2
2800 #define FF_CODER_TYPE_RLE       3
2801 #if FF_API_UNUSED_MEMBERS
2802 #define FF_CODER_TYPE_DEFLATE   4
2803 #endif /* FF_API_UNUSED_MEMBERS */
2804     /**
2805      * @deprecated use encoder private options instead
2806      */
2807     attribute_deprecated
2808     int coder_type;
2809 #endif /* FF_API_CODER_TYPE */
2810
2811 #if FF_API_PRIVATE_OPT
2812     /** @deprecated use encoder private options instead */
2813     attribute_deprecated
2814     int context_model;
2815 #endif
2816
2817 #if FF_API_MPV_OPT
2818     /**
2819      * @deprecated use encoder private options instead
2820      */
2821     attribute_deprecated
2822     int lmin;
2823
2824     /**
2825      * @deprecated use encoder private options instead
2826      */
2827     attribute_deprecated
2828     int lmax;
2829 #endif
2830
2831 #if FF_API_PRIVATE_OPT
2832     /** @deprecated use encoder private options instead */
2833     attribute_deprecated
2834     int frame_skip_threshold;
2835
2836     /** @deprecated use encoder private options instead */
2837     attribute_deprecated
2838     int frame_skip_factor;
2839
2840     /** @deprecated use encoder private options instead */
2841     attribute_deprecated
2842     int frame_skip_exp;
2843
2844     /** @deprecated use encoder private options instead */
2845     attribute_deprecated
2846     int frame_skip_cmp;
2847 #endif /* FF_API_PRIVATE_OPT */
2848
2849     /**
2850      * trellis RD quantization
2851      * - encoding: Set by user.
2852      * - decoding: unused
2853      */
2854     int trellis;
2855
2856 #if FF_API_PRIVATE_OPT
2857     /** @deprecated use encoder private options instead */
2858     attribute_deprecated
2859     int min_prediction_order;
2860
2861     /** @deprecated use encoder private options instead */
2862     attribute_deprecated
2863     int max_prediction_order;
2864
2865     /** @deprecated use encoder private options instead */
2866     attribute_deprecated
2867     int64_t timecode_frame_start;
2868 #endif
2869
2870 #if FF_API_RTP_CALLBACK
2871     /**
2872      * @deprecated unused
2873      */
2874     /* The RTP callback: This function is called    */
2875     /* every time the encoder has a packet to send. */
2876     /* It depends on the encoder if the data starts */
2877     /* with a Start Code (it should). H.263 does.   */
2878     /* mb_nb contains the number of macroblocks     */
2879     /* encoded in the RTP payload.                  */
2880     attribute_deprecated
2881     void (*rtp_callback)(struct AVCodecContext *avctx, void *data, int size, int mb_nb);
2882 #endif
2883
2884 #if FF_API_PRIVATE_OPT
2885     /** @deprecated use encoder private options instead */
2886     attribute_deprecated
2887     int rtp_payload_size;   /* The size of the RTP payload: the coder will  */
2888                             /* do its best to deliver a chunk with size     */
2889                             /* below rtp_payload_size, the chunk will start */
2890                             /* with a start code on some codecs like H.263. */
2891                             /* This doesn't take account of any particular  */
2892                             /* headers inside the transmitted RTP payload.  */
2893 #endif
2894
2895 #if FF_API_STAT_BITS
2896     /* statistics, used for 2-pass encoding */
2897     attribute_deprecated
2898     int mv_bits;
2899     attribute_deprecated
2900     int header_bits;
2901     attribute_deprecated
2902     int i_tex_bits;
2903     attribute_deprecated
2904     int p_tex_bits;
2905     attribute_deprecated
2906     int i_count;
2907     attribute_deprecated
2908     int p_count;
2909     attribute_deprecated
2910     int skip_count;
2911     attribute_deprecated
2912     int misc_bits;
2913
2914     /** @deprecated this field is unused */
2915     attribute_deprecated
2916     int frame_bits;
2917 #endif
2918
2919     /**
2920      * pass1 encoding statistics output buffer
2921      * - encoding: Set by libavcodec.
2922      * - decoding: unused
2923      */
2924     char *stats_out;
2925
2926     /**
2927      * pass2 encoding statistics input buffer
2928      * Concatenated stuff from stats_out of pass1 should be placed here.
2929      * - encoding: Allocated/set/freed by user.
2930      * - decoding: unused
2931      */
2932     char *stats_in;
2933
2934     /**
2935      * Work around bugs in encoders which sometimes cannot be detected automatically.
2936      * - encoding: Set by user
2937      * - decoding: Set by user
2938      */
2939     int workaround_bugs;
2940 #define FF_BUG_AUTODETECT       1  ///< autodetection
2941 #if FF_API_OLD_MSMPEG4
2942 #define FF_BUG_OLD_MSMPEG4      2
2943 #endif
2944 #define FF_BUG_XVID_ILACE       4
2945 #define FF_BUG_UMP4             8
2946 #define FF_BUG_NO_PADDING       16
2947 #define FF_BUG_AMV              32
2948 #if FF_API_AC_VLC
2949 #define FF_BUG_AC_VLC           0  ///< Will be removed, libavcodec can now handle these non-compliant files by default.
2950 #endif
2951 #define FF_BUG_QPEL_CHROMA      64
2952 #define FF_BUG_STD_QPEL         128
2953 #define FF_BUG_QPEL_CHROMA2     256
2954 #define FF_BUG_DIRECT_BLOCKSIZE 512
2955 #define FF_BUG_EDGE             1024
2956 #define FF_BUG_HPEL_CHROMA      2048
2957 #define FF_BUG_DC_CLIP          4096
2958 #define FF_BUG_MS               8192 ///< Work around various bugs in Microsoft's broken decoders.
2959 #define FF_BUG_TRUNCATED       16384
2960 #define FF_BUG_IEDGE           32768
2961
2962     /**
2963      * strictly follow the standard (MPEG-4, ...).
2964      * - encoding: Set by user.
2965      * - decoding: Set by user.
2966      * Setting this to STRICT or higher means the encoder and decoder will
2967      * generally do stupid things, whereas setting it to unofficial or lower
2968      * will mean the encoder might produce output that is not supported by all
2969      * spec-compliant decoders. Decoders don't differentiate between normal,
2970      * unofficial and experimental (that is, they always try to decode things
2971      * when they can) unless they are explicitly asked to behave stupidly
2972      * (=strictly conform to the specs)
2973      */
2974     int strict_std_compliance;
2975 #define FF_COMPLIANCE_VERY_STRICT   2 ///< Strictly conform to an older more strict version of the spec or reference software.
2976 #define FF_COMPLIANCE_STRICT        1 ///< Strictly conform to all the things in the spec no matter what consequences.
2977 #define FF_COMPLIANCE_NORMAL        0
2978 #define FF_COMPLIANCE_UNOFFICIAL   -1 ///< Allow unofficial extensions
2979 #define FF_COMPLIANCE_EXPERIMENTAL -2 ///< Allow nonstandardized experimental things.
2980
2981     /**
2982      * error concealment flags
2983      * - encoding: unused
2984      * - decoding: Set by user.
2985      */
2986     int error_concealment;
2987 #define FF_EC_GUESS_MVS   1
2988 #define FF_EC_DEBLOCK     2
2989 #define FF_EC_FAVOR_INTER 256
2990
2991     /**
2992      * debug
2993      * - encoding: Set by user.
2994      * - decoding: Set by user.
2995      */
2996     int debug;
2997 #define FF_DEBUG_PICT_INFO   1
2998 #define FF_DEBUG_RC          2
2999 #define FF_DEBUG_BITSTREAM   4
3000 #define FF_DEBUG_MB_TYPE     8
3001 #define FF_DEBUG_QP          16
3002 #if FF_API_DEBUG_MV
3003 /**
3004  * @deprecated this option does nothing
3005  */
3006 #define FF_DEBUG_MV          32
3007 #endif
3008 #define FF_DEBUG_DCT_COEFF   0x00000040
3009 #define FF_DEBUG_SKIP        0x00000080
3010 #define FF_DEBUG_STARTCODE   0x00000100
3011 #if FF_API_UNUSED_MEMBERS
3012 #define FF_DEBUG_PTS         0x00000200
3013 #endif /* FF_API_UNUSED_MEMBERS */
3014 #define FF_DEBUG_ER          0x00000400
3015 #define FF_DEBUG_MMCO        0x00000800
3016 #define FF_DEBUG_BUGS        0x00001000
3017 #if FF_API_DEBUG_MV
3018 #define FF_DEBUG_VIS_QP      0x00002000
3019 #define FF_DEBUG_VIS_MB_TYPE 0x00004000
3020 #endif
3021 #define FF_DEBUG_BUFFERS     0x00008000
3022 #define FF_DEBUG_THREADS     0x00010000
3023 #define FF_DEBUG_GREEN_MD    0x00800000
3024 #define FF_DEBUG_NOMC        0x01000000
3025
3026 #if FF_API_DEBUG_MV
3027     /**
3028      * debug
3029      * - encoding: Set by user.
3030      * - decoding: Set by user.
3031      */
3032     int debug_mv;
3033 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 // visualize forward predicted MVs of P-frames
3034 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 // visualize forward predicted MVs of B-frames
3035 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 // visualize backward predicted MVs of B-frames
3036 #endif
3037
3038     /**
3039      * Error recognition; may misdetect some more or less valid parts as errors.
3040      * - encoding: unused
3041      * - decoding: Set by user.
3042      */
3043     int err_recognition;
3044
3045 /**
3046  * Verify checksums embedded in the bitstream (could be of either encoded or
3047  * decoded data, depending on the codec) and print an error message on mismatch.
3048  * If AV_EF_EXPLODE is also set, a mismatching checksum will result in the
3049  * decoder returning an error.
3050  */
3051 #define AV_EF_CRCCHECK  (1<<0)
3052 #define AV_EF_BITSTREAM (1<<1)          ///< detect bitstream specification deviations
3053 #define AV_EF_BUFFER    (1<<2)          ///< detect improper bitstream length
3054 #define AV_EF_EXPLODE   (1<<3)          ///< abort decoding on minor error detection
3055
3056 #define AV_EF_IGNORE_ERR (1<<15)        ///< ignore errors and continue
3057 #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
3058 #define AV_EF_COMPLIANT  (1<<17)        ///< consider all spec non compliances as errors
3059 #define AV_EF_AGGRESSIVE (1<<18)        ///< consider things that a sane encoder should not do as an error
3060
3061
3062     /**
3063      * opaque 64-bit number (generally a PTS) that will be reordered and
3064      * output in AVFrame.reordered_opaque
3065      * - encoding: unused
3066      * - decoding: Set by user.
3067      */
3068     int64_t reordered_opaque;
3069
3070     /**
3071      * Hardware accelerator in use
3072      * - encoding: unused.
3073      * - decoding: Set by libavcodec
3074      */
3075     struct AVHWAccel *hwaccel;
3076
3077     /**
3078      * Hardware accelerator context.
3079      * For some hardware accelerators, a global context needs to be
3080      * provided by the user. In that case, this holds display-dependent
3081      * data FFmpeg cannot instantiate itself. Please refer to the
3082      * FFmpeg HW accelerator documentation to know how to fill this
3083      * is. e.g. for VA API, this is a struct vaapi_context.
3084      * - encoding: unused
3085      * - decoding: Set by user
3086      */
3087     void *hwaccel_context;
3088
3089     /**
3090      * error
3091      * - encoding: Set by libavcodec if flags & AV_CODEC_FLAG_PSNR.
3092      * - decoding: unused
3093      */
3094     uint64_t error[AV_NUM_DATA_POINTERS];
3095
3096     /**
3097      * DCT algorithm, see FF_DCT_* below
3098      * - encoding: Set by user.
3099      * - decoding: unused
3100      */
3101     int dct_algo;
3102 #define FF_DCT_AUTO    0
3103 #define FF_DCT_FASTINT 1
3104 #define FF_DCT_INT     2
3105 #define FF_DCT_MMX     3
3106 #define FF_DCT_ALTIVEC 5
3107 #define FF_DCT_FAAN    6
3108
3109     /**
3110      * IDCT algorithm, see FF_IDCT_* below.
3111      * - encoding: Set by user.
3112      * - decoding: Set by user.
3113      */
3114     int idct_algo;
3115 #define FF_IDCT_AUTO          0
3116 #define FF_IDCT_INT           1
3117 #define FF_IDCT_SIMPLE        2
3118 #define FF_IDCT_SIMPLEMMX     3
3119 #define FF_IDCT_ARM           7
3120 #define FF_IDCT_ALTIVEC       8
3121 #if FF_API_ARCH_SH4
3122 #define FF_IDCT_SH4           9
3123 #endif
3124 #define FF_IDCT_SIMPLEARM     10
3125 #if FF_API_UNUSED_MEMBERS
3126 #define FF_IDCT_IPP           13
3127 #endif /* FF_API_UNUSED_MEMBERS */
3128 #define FF_IDCT_XVID          14
3129 #if FF_API_IDCT_XVIDMMX
3130 #define FF_IDCT_XVIDMMX       14
3131 #endif /* FF_API_IDCT_XVIDMMX */
3132 #define FF_IDCT_SIMPLEARMV5TE 16
3133 #define FF_IDCT_SIMPLEARMV6   17
3134 #if FF_API_ARCH_SPARC
3135 #define FF_IDCT_SIMPLEVIS     18
3136 #endif
3137 #define FF_IDCT_FAAN          20
3138 #define FF_IDCT_SIMPLENEON    22
3139 #if FF_API_ARCH_ALPHA
3140 #define FF_IDCT_SIMPLEALPHA   23
3141 #endif
3142 #define FF_IDCT_SIMPLEAUTO    128
3143
3144     /**
3145      * bits per sample/pixel from the demuxer (needed for huffyuv).
3146      * - encoding: Set by libavcodec.
3147      * - decoding: Set by user.
3148      */
3149      int bits_per_coded_sample;
3150
3151     /**
3152      * Bits per sample/pixel of internal libavcodec pixel/sample format.
3153      * - encoding: set by user.
3154      * - decoding: set by libavcodec.
3155      */
3156     int bits_per_raw_sample;
3157
3158 #if FF_API_LOWRES
3159     /**
3160      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3161      * - encoding: unused
3162      * - decoding: Set by user.
3163      */
3164      int lowres;
3165 #endif
3166
3167 #if FF_API_CODED_FRAME
3168     /**
3169      * the picture in the bitstream
3170      * - encoding: Set by libavcodec.
3171      * - decoding: unused
3172      *
3173      * @deprecated use the quality factor packet side data instead
3174      */
3175     attribute_deprecated AVFrame *coded_frame;
3176 #endif
3177
3178     /**
3179      * thread count
3180      * is used to decide how many independent tasks should be passed to execute()
3181      * - encoding: Set by user.
3182      * - decoding: Set by user.
3183      */
3184     int thread_count;
3185
3186     /**
3187      * Which multithreading methods to use.
3188      * Use of FF_THREAD_FRAME will increase decoding delay by one frame per thread,
3189      * so clients which cannot provide future frames should not use it.
3190      *
3191      * - encoding: Set by user, otherwise the default is used.
3192      * - decoding: Set by user, otherwise the default is used.
3193      */
3194     int thread_type;
3195 #define FF_THREAD_FRAME   1 ///< Decode more than one frame at once
3196 #define FF_THREAD_SLICE   2 ///< Decode more than one part of a single frame at once
3197
3198     /**
3199      * Which multithreading methods are in use by the codec.
3200      * - encoding: Set by libavcodec.
3201      * - decoding: Set by libavcodec.
3202      */
3203     int active_thread_type;
3204
3205     /**
3206      * Set by the client if its custom get_buffer() callback can be called
3207      * synchronously from another thread, which allows faster multithreaded decoding.
3208      * draw_horiz_band() will be called from other threads regardless of this setting.
3209      * Ignored if the default get_buffer() is used.
3210      * - encoding: Set by user.
3211      * - decoding: Set by user.
3212      */
3213     int thread_safe_callbacks;
3214
3215     /**
3216      * The codec may call this to execute several independent things.
3217      * It will return only after finishing all tasks.
3218      * The user may replace this with some multithreaded implementation,
3219      * the default implementation will execute the parts serially.
3220      * @param count the number of things to execute
3221      * - encoding: Set by libavcodec, user can override.
3222      * - decoding: Set by libavcodec, user can override.
3223      */
3224     int (*execute)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg), void *arg2, int *ret, int count, int size);
3225
3226     /**
3227      * The codec may call this to execute several independent things.
3228      * It will return only after finishing all tasks.
3229      * The user may replace this with some multithreaded implementation,
3230      * the default implementation will execute the parts serially.
3231      * Also see avcodec_thread_init and e.g. the --enable-pthread configure option.
3232      * @param c context passed also to func
3233      * @param count the number of things to execute
3234      * @param arg2 argument passed unchanged to func
3235      * @param ret return values of executed functions, must have space for "count" values. May be NULL.
3236      * @param func function that will be called count times, with jobnr from 0 to count-1.
3237      *             threadnr will be in the range 0 to c->thread_count-1 < MAX_THREADS and so that no
3238      *             two instances of func executing at the same time will have the same threadnr.
3239      * @return always 0 currently, but code should handle a future improvement where when any call to func
3240      *         returns < 0 no further calls to func may be done and < 0 is returned.
3241      * - encoding: Set by libavcodec, user can override.
3242      * - decoding: Set by libavcodec, user can override.
3243      */
3244     int (*execute2)(struct AVCodecContext *c, int (*func)(struct AVCodecContext *c2, void *arg, int jobnr, int threadnr), void *arg2, int *ret, int count);
3245
3246     /**
3247      * noise vs. sse weight for the nsse comparison function
3248      * - encoding: Set by user.
3249      * - decoding: unused
3250      */
3251      int nsse_weight;
3252
3253     /**
3254      * profile
3255      * - encoding: Set by user.
3256      * - decoding: Set by libavcodec.
3257      */
3258      int profile;
3259 #define FF_PROFILE_UNKNOWN -99
3260 #define FF_PROFILE_RESERVED -100
3261
3262 #define FF_PROFILE_AAC_MAIN 0
3263 #define FF_PROFILE_AAC_LOW  1
3264 #define FF_PROFILE_AAC_SSR  2
3265 #define FF_PROFILE_AAC_LTP  3
3266 #define FF_PROFILE_AAC_HE   4
3267 #define FF_PROFILE_AAC_HE_V2 28
3268 #define FF_PROFILE_AAC_LD   22
3269 #define FF_PROFILE_AAC_ELD  38
3270 #define FF_PROFILE_MPEG2_AAC_LOW 128
3271 #define FF_PROFILE_MPEG2_AAC_HE  131
3272
3273 #define FF_PROFILE_DNXHD         0
3274 #define FF_PROFILE_DNXHR_LB      1
3275 #define FF_PROFILE_DNXHR_SQ      2
3276 #define FF_PROFILE_DNXHR_HQ      3
3277 #define FF_PROFILE_DNXHR_HQX     4
3278 #define FF_PROFILE_DNXHR_444     5
3279
3280 #define FF_PROFILE_DTS         20
3281 #define FF_PROFILE_DTS_ES      30
3282 #define FF_PROFILE_DTS_96_24   40
3283 #define FF_PROFILE_DTS_HD_HRA  50
3284 #define FF_PROFILE_DTS_HD_MA   60
3285 #define FF_PROFILE_DTS_EXPRESS 70
3286
3287 #define FF_PROFILE_MPEG2_422    0
3288 #define FF_PROFILE_MPEG2_HIGH   1
3289 #define FF_PROFILE_MPEG2_SS     2
3290 #define FF_PROFILE_MPEG2_SNR_SCALABLE  3
3291 #define FF_PROFILE_MPEG2_MAIN   4
3292 #define FF_PROFILE_MPEG2_SIMPLE 5
3293
3294 #define FF_PROFILE_H264_CONSTRAINED  (1<<9)  // 8+1; constraint_set1_flag
3295 #define FF_PROFILE_H264_INTRA        (1<<11) // 8+3; constraint_set3_flag
3296
3297 #define FF_PROFILE_H264_BASELINE             66
3298 #define FF_PROFILE_H264_CONSTRAINED_BASELINE (66|FF_PROFILE_H264_CONSTRAINED)
3299 #define FF_PROFILE_H264_MAIN                 77
3300 #define FF_PROFILE_H264_EXTENDED             88
3301 #define FF_PROFILE_H264_HIGH                 100
3302 #define FF_PROFILE_H264_HIGH_10              110
3303 #define FF_PROFILE_H264_HIGH_10_INTRA        (110|FF_PROFILE_H264_INTRA)
3304 #define FF_PROFILE_H264_MULTIVIEW_HIGH       118
3305 #define FF_PROFILE_H264_HIGH_422             122
3306 #define FF_PROFILE_H264_HIGH_422_INTRA       (122|FF_PROFILE_H264_INTRA)
3307 #define FF_PROFILE_H264_STEREO_HIGH          128
3308 #define FF_PROFILE_H264_HIGH_444             144
3309 #define FF_PROFILE_H264_HIGH_444_PREDICTIVE  244
3310 #define FF_PROFILE_H264_HIGH_444_INTRA       (244|FF_PROFILE_H264_INTRA)
3311 #define FF_PROFILE_H264_CAVLC_444            44
3312
3313 #define FF_PROFILE_VC1_SIMPLE   0
3314 #define FF_PROFILE_VC1_MAIN     1
3315 #define FF_PROFILE_VC1_COMPLEX  2
3316 #define FF_PROFILE_VC1_ADVANCED 3
3317
3318 #define FF_PROFILE_MPEG4_SIMPLE                     0
3319 #define FF_PROFILE_MPEG4_SIMPLE_SCALABLE            1
3320 #define FF_PROFILE_MPEG4_CORE                       2
3321 #define FF_PROFILE_MPEG4_MAIN                       3
3322 #define FF_PROFILE_MPEG4_N_BIT                      4
3323 #define FF_PROFILE_MPEG4_SCALABLE_TEXTURE           5
3324 #define FF_PROFILE_MPEG4_SIMPLE_FACE_ANIMATION      6
3325 #define FF_PROFILE_MPEG4_BASIC_ANIMATED_TEXTURE     7
3326 #define FF_PROFILE_MPEG4_HYBRID                     8
3327 #define FF_PROFILE_MPEG4_ADVANCED_REAL_TIME         9
3328 #define FF_PROFILE_MPEG4_CORE_SCALABLE             10
3329 #define FF_PROFILE_MPEG4_ADVANCED_CODING           11
3330 #define FF_PROFILE_MPEG4_ADVANCED_CORE             12
3331 #define FF_PROFILE_MPEG4_ADVANCED_SCALABLE_TEXTURE 13
3332 #define FF_PROFILE_MPEG4_SIMPLE_STUDIO             14
3333 #define FF_PROFILE_MPEG4_ADVANCED_SIMPLE           15
3334
3335 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_0   1
3336 #define FF_PROFILE_JPEG2000_CSTREAM_RESTRICTION_1   2
3337 #define FF_PROFILE_JPEG2000_CSTREAM_NO_RESTRICTION  32768
3338 #define FF_PROFILE_JPEG2000_DCINEMA_2K              3
3339 #define FF_PROFILE_JPEG2000_DCINEMA_4K              4
3340
3341 #define FF_PROFILE_VP9_0                            0
3342 #define FF_PROFILE_VP9_1                            1
3343 #define FF_PROFILE_VP9_2                            2
3344 #define FF_PROFILE_VP9_3                            3
3345
3346 #define FF_PROFILE_HEVC_MAIN                        1
3347 #define FF_PROFILE_HEVC_MAIN_10                     2
3348 #define FF_PROFILE_HEVC_MAIN_STILL_PICTURE          3
3349 #define FF_PROFILE_HEVC_REXT                        4
3350
3351     /**
3352      * level
3353      * - encoding: Set by user.
3354      * - decoding: Set by libavcodec.
3355      */
3356      int level;
3357 #define FF_LEVEL_UNKNOWN -99
3358
3359     /**
3360      * Skip loop filtering for selected frames.
3361      * - encoding: unused
3362      * - decoding: Set by user.
3363      */
3364     enum AVDiscard skip_loop_filter;
3365
3366     /**
3367      * Skip IDCT/dequantization for selected frames.
3368      * - encoding: unused
3369      * - decoding: Set by user.
3370      */
3371     enum AVDiscard skip_idct;
3372
3373     /**
3374      * Skip decoding for selected frames.
3375      * - encoding: unused
3376      * - decoding: Set by user.
3377      */
3378     enum AVDiscard skip_frame;
3379
3380     /**
3381      * Header containing style information for text subtitles.
3382      * For SUBTITLE_ASS subtitle type, it should contain the whole ASS
3383      * [Script Info] and [V4+ Styles] section, plus the [Events] line and
3384      * the Format line following. It shouldn't include any Dialogue line.
3385      * - encoding: Set/allocated/freed by user (before avcodec_open2())
3386      * - decoding: Set/allocated/freed by libavcodec (by avcodec_open2())
3387      */
3388     uint8_t *subtitle_header;
3389     int subtitle_header_size;
3390
3391 #if FF_API_ERROR_RATE
3392     /**
3393      * @deprecated use the 'error_rate' private AVOption of the mpegvideo
3394      * encoders
3395      */
3396     attribute_deprecated
3397     int error_rate;
3398 #endif
3399
3400 #if FF_API_VBV_DELAY
3401     /**
3402      * VBV delay coded in the last frame (in periods of a 27 MHz clock).
3403      * Used for compliant TS muxing.
3404      * - encoding: Set by libavcodec.
3405      * - decoding: unused.
3406      * @deprecated this value is now exported as a part of
3407      * AV_PKT_DATA_CPB_PROPERTIES packet side data
3408      */
3409     attribute_deprecated
3410     uint64_t vbv_delay;
3411 #endif
3412
3413 #if FF_API_SIDEDATA_ONLY_PKT
3414     /**
3415      * Encoding only and set by default. Allow encoders to output packets
3416      * that do not contain any encoded data, only side data.
3417      *
3418      * Some encoders need to output such packets, e.g. to update some stream
3419      * parameters at the end of encoding.
3420      *
3421      * @deprecated this field disables the default behaviour and
3422      *             it is kept only for compatibility.
3423      */
3424     attribute_deprecated
3425     int side_data_only_packets;
3426 #endif
3427
3428     /**
3429      * Audio only. The number of "priming" samples (padding) inserted by the
3430      * encoder at the beginning of the audio. I.e. this number of leading
3431      * decoded samples must be discarded by the caller to get the original audio
3432      * without leading padding.
3433      *
3434      * - decoding: unused
3435      * - encoding: Set by libavcodec. The timestamps on the output packets are
3436      *             adjusted by the encoder so that they always refer to the
3437      *             first sample of the data actually contained in the packet,
3438      *             including any added padding.  E.g. if the timebase is
3439      *             1/samplerate and the timestamp of the first input sample is
3440      *             0, the timestamp of the first output packet will be
3441      *             -initial_padding.
3442      */
3443     int initial_padding;
3444
3445     /**
3446      * - decoding: For codecs that store a framerate value in the compressed
3447      *             bitstream, the decoder may export it here. { 0, 1} when
3448      *             unknown.
3449      * - encoding: May be used to signal the framerate of CFR content to an
3450      *             encoder.
3451      */
3452     AVRational framerate;
3453
3454     /**
3455      * Nominal unaccelerated pixel format, see AV_PIX_FMT_xxx.
3456      * - encoding: unused.
3457      * - decoding: Set by libavcodec before calling get_format()
3458      */
3459     enum AVPixelFormat sw_pix_fmt;
3460
3461     /**
3462      * Timebase in which pkt_dts/pts and AVPacket.dts/pts are.
3463      * - encoding unused.
3464      * - decoding set by user.
3465      */
3466     AVRational pkt_timebase;
3467
3468     /**
3469      * AVCodecDescriptor
3470      * - encoding: unused.
3471      * - decoding: set by libavcodec.
3472      */
3473     const AVCodecDescriptor *codec_descriptor;
3474
3475 #if !FF_API_LOWRES
3476     /**
3477      * low resolution decoding, 1-> 1/2 size, 2->1/4 size
3478      * - encoding: unused
3479      * - decoding: Set by user.
3480      */
3481      int lowres;
3482 #endif
3483
3484     /**
3485      * Current statistics for PTS correction.
3486      * - decoding: maintained and used by libavcodec, not intended to be used by user apps
3487      * - encoding: unused
3488      */
3489     int64_t pts_correction_num_faulty_pts; /// Number of incorrect PTS values so far
3490     int64_t pts_correction_num_faulty_dts; /// Number of incorrect DTS values so far
3491     int64_t pts_correction_last_pts;       /// PTS of the last frame
3492     int64_t pts_correction_last_dts;       /// DTS of the last frame
3493
3494     /**
3495      * Character encoding of the input subtitles file.
3496      * - decoding: set by user
3497      * - encoding: unused
3498      */
3499     char *sub_charenc;
3500
3501     /**
3502      * Subtitles character encoding mode. Formats or codecs might be adjusting
3503      * this setting (if they are doing the conversion themselves for instance).
3504      * - decoding: set by libavcodec
3505      * - encoding: unused
3506      */
3507     int sub_charenc_mode;
3508 #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)
3509 #define FF_SUB_CHARENC_MODE_AUTOMATIC    0  ///< libavcodec will select the mode itself
3510 #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
3511
3512     /**
3513      * Skip processing alpha if supported by codec.
3514      * Note that if the format uses pre-multiplied alpha (common with VP6,
3515      * and recommended due to better video quality/compression)
3516      * the image will look as if alpha-blended onto a black background.
3517      * However for formats that do not use pre-multiplied alpha
3518      * there might be serious artefacts (though e.g. libswscale currently
3519      * assumes pre-multiplied alpha anyway).
3520      *
3521      * - decoding: set by user
3522      * - encoding: unused
3523      */
3524     int skip_alpha;
3525
3526     /**
3527      * Number of samples to skip after a discontinuity
3528      * - decoding: unused
3529      * - encoding: set by libavcodec
3530      */
3531     int seek_preroll;
3532
3533 #if !FF_API_DEBUG_MV
3534     /**
3535      * debug motion vectors
3536      * - encoding: Set by user.
3537      * - decoding: Set by user.
3538      */
3539     int debug_mv;
3540 #define FF_DEBUG_VIS_MV_P_FOR  0x00000001 //visualize forward predicted MVs of P frames
3541 #define FF_DEBUG_VIS_MV_B_FOR  0x00000002 //visualize forward predicted MVs of B frames
3542 #define FF_DEBUG_VIS_MV_B_BACK 0x00000004 //visualize backward predicted MVs of B frames
3543 #endif
3544
3545     /**
3546      * custom intra quantization matrix
3547      * - encoding: Set by user, can be NULL.
3548      * - decoding: unused.
3549      */
3550     uint16_t *chroma_intra_matrix;
3551
3552     /**
3553      * dump format separator.
3554      * can be ", " or "\n      " or anything else
3555      * - encoding: Set by user.
3556      * - decoding: Set by user.
3557      */
3558     uint8_t *dump_separator;
3559
3560     /**
3561      * ',' separated list of allowed decoders.
3562      * If NULL then all are allowed
3563      * - encoding: unused
3564      * - decoding: set by user
3565      */
3566     char *codec_whitelist;
3567
3568     /**
3569      * Properties of the stream that gets decoded
3570      * - encoding: unused
3571      * - decoding: set by libavcodec
3572      */
3573     unsigned properties;
3574 #define FF_CODEC_PROPERTY_LOSSLESS        0x00000001
3575 #define FF_CODEC_PROPERTY_CLOSED_CAPTIONS 0x00000002
3576
3577     /**
3578      * Additional data associated with the entire coded stream.
3579      *
3580      * - decoding: unused
3581      * - encoding: may be set by libavcodec after avcodec_open2().
3582      */
3583     AVPacketSideData *coded_side_data;
3584     int            nb_coded_side_data;
3585
3586     /**
3587      * A reference to the AVHWFramesContext describing the input (for encoding)
3588      * or output (decoding) frames. The reference is set by the caller and
3589      * afterwards owned (and freed) by libavcodec - it should never be read by
3590      * the caller after being set.
3591      *
3592      * - decoding: This field should be set by the caller from the get_format()
3593      *             callback. The previous reference (if any) will always be
3594      *             unreffed by libavcodec before the get_format() call.
3595      *
3596      *             If the default get_buffer2() is used with a hwaccel pixel
3597      *             format, then this AVHWFramesContext will be used for
3598      *             allocating the frame buffers.
3599      *
3600      * - encoding: For hardware encoders configured to use a hwaccel pixel
3601      *             format, this field should be set by the caller to a reference
3602      *             to the AVHWFramesContext describing input frames.
3603      *             AVHWFramesContext.format must be equal to
3604      *             AVCodecContext.pix_fmt.
3605      *
3606      *             This field should be set before avcodec_open2() is called.
3607      */
3608     AVBufferRef *hw_frames_ctx;
3609
3610     /**
3611      * Control the form of AVSubtitle.rects[N]->ass
3612      * - decoding: set by user
3613      * - encoding: unused
3614      */
3615     int sub_text_format;
3616 #define FF_SUB_TEXT_FMT_ASS              0
3617 #if FF_API_ASS_TIMING
3618 #define FF_SUB_TEXT_FMT_ASS_WITH_TIMINGS 1
3619 #endif
3620
3621     /**
3622      * Audio only. The amount of padding (in samples) appended by the encoder to
3623      * the end of the audio. I.e. this number of decoded samples must be
3624      * discarded by the caller from the end of the stream to get the original
3625      * audio without any trailing padding.
3626      *
3627      * - decoding: unused
3628      * - encoding: unused
3629      */
3630     int trailing_padding;
3631
3632     /**
3633      * The number of pixels per image to maximally accept.
3634      *
3635      * - decoding: set by user
3636      * - encoding: set by user
3637      */
3638     int64_t max_pixels;
3639
3640     /**
3641      * A reference to the AVHWDeviceContext describing the device which will
3642      * be used by a hardware encoder/decoder.  The reference is set by the
3643      * caller and afterwards owned (and freed) by libavcodec.
3644      *
3645      * This should be used if either the codec device does not require
3646      * hardware frames or any that are used are to be allocated internally by
3647      * libavcodec.  If the user wishes to supply any of the frames used as
3648      * encoder input or decoder output then hw_frames_ctx should be used
3649      * instead.  When hw_frames_ctx is set in get_format() for a decoder, this
3650      * field will be ignored while decoding the associated stream segment, but
3651      * may again be used on a following one after another get_format() call.
3652      *
3653      * For both encoders and decoders this field should be set before
3654      * avcodec_open2() is called and must not be written to thereafter.
3655      *
3656      * Note that some decoders may require this field to be set initially in
3657      * order to support hw_frames_ctx at all - in that case, all frames
3658      * contexts used must be created on the same device.
3659      */
3660     AVBufferRef *hw_device_ctx;
3661
3662     /**
3663      * Bit set of AV_HWACCEL_FLAG_* flags, which affect hardware accelerated
3664      * decoding (if active).
3665      * - encoding: unused
3666      * - decoding: Set by user (either before avcodec_open2(), or in the
3667      *             AVCodecContext.get_format callback)
3668      */
3669     int hwaccel_flags;
3670
3671     /**
3672      * Video decoding only. Certain video codecs support cropping, meaning that
3673      * only a sub-rectangle of the decoded frame is intended for display.  This
3674      * option controls how cropping is handled by libavcodec.
3675      *
3676      * When set to 1 (the default), libavcodec will apply cropping internally.
3677      * I.e. it will modify the output frame width/height fields and offset the
3678      * data pointers (only by as much as possible while preserving alignment, or
3679      * by the full amount if the AV_CODEC_FLAG_UNALIGNED flag is set) so that
3680      * the frames output by the decoder refer only to the cropped area. The
3681      * crop_* fields of the output frames will be zero.
3682      *
3683      * When set to 0, the width/height fields of the output frames will be set
3684      * to the coded dimensions and the crop_* fields will describe the cropping
3685      * rectangle. Applying the cropping is left to the caller.
3686      *
3687      * @warning When hardware acceleration with opaque output frames is used,
3688      * libavcodec is unable to apply cropping from the top/left border.
3689      *
3690      * @note when this option is set to zero, the width/height fields of the
3691      * AVCodecContext and output AVFrames have different meanings. The codec
3692      * context fields store display dimensions (with the coded dimensions in
3693      * coded_width/height), while the frame fields store the coded dimensions
3694      * (with the display dimensions being determined by the crop_* fields).
3695      */
3696     int apply_cropping;
3697 } AVCodecContext;
3698
3699 AVRational av_codec_get_pkt_timebase         (const AVCodecContext *avctx);
3700 void       av_codec_set_pkt_timebase         (AVCodecContext *avctx, AVRational val);
3701
3702 const AVCodecDescriptor *av_codec_get_codec_descriptor(const AVCodecContext *avctx);
3703 void                     av_codec_set_codec_descriptor(AVCodecContext *avctx, const AVCodecDescriptor *desc);
3704
3705 unsigned av_codec_get_codec_properties(const AVCodecContext *avctx);
3706
3707 int  av_codec_get_lowres(const AVCodecContext *avctx);
3708 void av_codec_set_lowres(AVCodecContext *avctx, int val);
3709
3710 int  av_codec_get_seek_preroll(const AVCodecContext *avctx);
3711 void av_codec_set_seek_preroll(AVCodecContext *avctx, int val);
3712
3713 uint16_t *av_codec_get_chroma_intra_matrix(const AVCodecContext *avctx);
3714 void av_codec_set_chroma_intra_matrix(AVCodecContext *avctx, uint16_t *val);
3715
3716 /**
3717  * AVProfile.
3718  */
3719 typedef struct AVProfile {
3720     int profile;
3721     const char *name; ///< short name for the profile
3722 } AVProfile;
3723
3724 typedef struct AVCodecDefault AVCodecDefault;
3725
3726 struct AVSubtitle;
3727
3728 /**
3729  * AVCodec.
3730  */
3731 typedef struct AVCodec {
3732     /**
3733      * Name of the codec implementation.
3734      * The name is globally unique among encoders and among decoders (but an
3735      * encoder and a decoder can share the same name).
3736      * This is the primary way to find a codec from the user perspective.
3737      */
3738     const char *name;
3739     /**
3740      * Descriptive name for the codec, meant to be more human readable than name.
3741      * You should use the NULL_IF_CONFIG_SMALL() macro to define it.
3742      */
3743     const char *long_name;
3744     enum AVMediaType type;
3745     enum AVCodecID id;
3746     /**
3747      * Codec capabilities.
3748      * see AV_CODEC_CAP_*
3749      */
3750     int capabilities;
3751     const AVRational *supported_framerates; ///< array of supported framerates, or NULL if any, array is terminated by {0,0}
3752     const enum AVPixelFormat *pix_fmts;     ///< array of supported pixel formats, or NULL if unknown, array is terminated by -1
3753     const int *supported_samplerates;       ///< array of supported audio samplerates, or NULL if unknown, array is terminated by 0
3754     const enum AVSampleFormat *sample_fmts; ///< array of supported sample formats, or NULL if unknown, array is terminated by -1
3755     const uint64_t *channel_layouts;         ///< array of support channel layouts, or NULL if unknown. array is terminated by 0
3756     uint8_t max_lowres;                     ///< maximum value for lowres supported by the decoder
3757     const AVClass *priv_class;              ///< AVClass for the private context
3758     const AVProfile *profiles;              ///< array of recognized profiles, or NULL if unknown, array is terminated by {FF_PROFILE_UNKNOWN}
3759
3760     /*****************************************************************
3761      * No fields below this line are part of the public API. They
3762      * may not be used outside of libavcodec and can be changed and
3763      * removed at will.
3764      * New public fields should be added right above.
3765      *****************************************************************
3766      */
3767     int priv_data_size;
3768     struct AVCodec *next;
3769     /**
3770      * @name Frame-level threading support functions
3771      * @{
3772      */
3773     /**
3774      * If defined, called on thread contexts when they are created.
3775      * If the codec allocates writable tables in init(), re-allocate them here.
3776      * priv_data will be set to a copy of the original.
3777      */
3778     int (*init_thread_copy)(AVCodecContext *);
3779     /**
3780      * Copy necessary context variables from a previous thread context to the current one.
3781      * If not defined, the next thread will start automatically; otherwise, the codec
3782      * must call ff_thread_finish_setup().
3783      *
3784      * dst and src will (rarely) point to the same context, in which case memcpy should be skipped.
3785      */
3786     int (*update_thread_context)(AVCodecContext *dst, const AVCodecContext *src);
3787     /** @} */
3788
3789     /**
3790      * Private codec-specific defaults.
3791      */
3792     const AVCodecDefault *defaults;
3793
3794     /**
3795      * Initialize codec static data, called from avcodec_register().
3796      */
3797     void (*init_static_data)(struct AVCodec *codec);
3798
3799     int (*init)(AVCodecContext *);
3800     int (*encode_sub)(AVCodecContext *, uint8_t *buf, int buf_size,
3801                       const struct AVSubtitle *sub);
3802     /**
3803      * Encode data to an AVPacket.
3804      *
3805      * @param      avctx          codec context
3806      * @param      avpkt          output AVPacket (may contain a user-provided buffer)
3807      * @param[in]  frame          AVFrame containing the raw data to be encoded
3808      * @param[out] got_packet_ptr encoder sets to 0 or 1 to indicate that a
3809      *                            non-empty packet was returned in avpkt.
3810      * @return 0 on success, negative error code on failure
3811      */
3812     int (*encode2)(AVCodecContext *avctx, AVPacket *avpkt, const AVFrame *frame,
3813                    int *got_packet_ptr);
3814     int (*decode)(AVCodecContext *, void *outdata, int *outdata_size, AVPacket *avpkt);
3815     int (*close)(AVCodecContext *);
3816     /**
3817      * Encode API with decoupled packet/frame dataflow. The API is the
3818      * same as the avcodec_ prefixed APIs (avcodec_send_frame() etc.), except
3819      * that:
3820      * - never called if the codec is closed or the wrong type,
3821      * - if AV_CODEC_CAP_DELAY is not set, drain frames are never sent,
3822      * - only one drain frame is ever passed down,
3823      */
3824     int (*send_frame)(AVCodecContext *avctx, const AVFrame *frame);
3825     int (*receive_packet)(AVCodecContext *avctx, AVPacket *avpkt);
3826
3827     /**
3828      * Decode API with decoupled packet/frame dataflow. This function is called
3829      * to get one output frame. It should call ff_decode_get_packet() to obtain
3830      * input data.
3831      */
3832     int (*receive_frame)(AVCodecContext *avctx, AVFrame *frame);
3833     /**
3834      * Flush buffers.
3835      * Will be called when seeking
3836      */
3837     void (*flush)(AVCodecContext *);
3838     /**
3839      * Internal codec capabilities.
3840      * See FF_CODEC_CAP_* in internal.h
3841      */
3842     int caps_internal;
3843
3844     /**
3845      * Decoding only, a comma-separated list of bitstream filters to apply to
3846      * packets before decoding.
3847      */
3848     const char *bsfs;
3849 } AVCodec;
3850
3851 int av_codec_get_max_lowres(const AVCodec *codec);
3852
3853 struct MpegEncContext;
3854
3855 /**
3856  * @defgroup lavc_hwaccel AVHWAccel
3857  * @{
3858  */
3859 typedef struct AVHWAccel {
3860     /**
3861      * Name of the hardware accelerated codec.
3862      * The name is globally unique among encoders and among decoders (but an
3863      * encoder and a decoder can share the same name).
3864      */
3865     const char *name;
3866
3867     /**
3868      * Type of codec implemented by the hardware accelerator.
3869      *
3870      * See AVMEDIA_TYPE_xxx
3871      */
3872     enum AVMediaType type;
3873
3874     /**
3875      * Codec implemented by the hardware accelerator.
3876      *
3877      * See AV_CODEC_ID_xxx
3878      */
3879     enum AVCodecID id;
3880
3881     /**
3882      * Supported pixel format.
3883      *
3884      * Only hardware accelerated formats are supported here.
3885      */
3886     enum AVPixelFormat pix_fmt;
3887
3888     /**
3889      * Hardware accelerated codec capabilities.
3890      * see AV_HWACCEL_CODEC_CAP_*
3891      */
3892     int capabilities;
3893
3894     /*****************************************************************
3895      * No fields below this line are part of the public API. They
3896      * may not be used outside of libavcodec and can be changed and
3897      * removed at will.
3898      * New public fields should be added right above.
3899      *****************************************************************
3900      */
3901     struct AVHWAccel *next;
3902
3903     /**
3904      * Allocate a custom buffer
3905      */
3906     int (*alloc_frame)(AVCodecContext *avctx, AVFrame *frame);
3907
3908     /**
3909      * Called at the beginning of each frame or field picture.
3910      *
3911      * Meaningful frame information (codec specific) is guaranteed to
3912      * be parsed at this point. This function is mandatory.
3913      *
3914      * Note that buf can be NULL along with buf_size set to 0.
3915      * Otherwise, this means the whole frame is available at this point.
3916      *
3917      * @param avctx the codec context
3918      * @param buf the frame data buffer base
3919      * @param buf_size the size of the frame in bytes
3920      * @return zero if successful, a negative value otherwise
3921      */
3922     int (*start_frame)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3923
3924     /**
3925      * Callback for each slice.
3926      *
3927      * Meaningful slice information (codec specific) is guaranteed to
3928      * be parsed at this point. This function is mandatory.
3929      * The only exception is XvMC, that works on MB level.
3930      *
3931      * @param avctx the codec context
3932      * @param buf the slice data buffer base
3933      * @param buf_size the size of the slice in bytes
3934      * @return zero if successful, a negative value otherwise
3935      */
3936     int (*decode_slice)(AVCodecContext *avctx, const uint8_t *buf, uint32_t buf_size);
3937
3938     /**
3939      * Called at the end of each frame or field picture.
3940      *
3941      * The whole picture is parsed at this point and can now be sent
3942      * to the hardware accelerator. This function is mandatory.
3943      *
3944      * @param avctx the codec context
3945      * @return zero if successful, a negative value otherwise
3946      */
3947     int (*end_frame)(AVCodecContext *avctx);
3948
3949     /**
3950      * Size of per-frame hardware accelerator private data.
3951      *
3952      * Private data is allocated with av_mallocz() before
3953      * AVCodecContext.get_buffer() and deallocated after
3954      * AVCodecContext.release_buffer().
3955      */
3956     int frame_priv_data_size;
3957
3958     /**
3959      * Called for every Macroblock in a slice.
3960      *
3961      * XvMC uses it to replace the ff_mpv_reconstruct_mb().
3962      * Instead of decoding to raw picture, MB parameters are
3963      * stored in an array provided by the video driver.
3964      *
3965      * @param s the mpeg context
3966      */
3967     void (*decode_mb)(struct MpegEncContext *s);
3968
3969     /**
3970      * Initialize the hwaccel private data.
3971      *
3972      * This will be called from ff_get_format(), after hwaccel and
3973      * hwaccel_context are set and the hwaccel private data in AVCodecInternal
3974      * is allocated.
3975      */
3976     int (*init)(AVCodecContext *avctx);
3977
3978     /**
3979      * Uninitialize the hwaccel private data.
3980      *
3981      * This will be called from get_format() or avcodec_close(), after hwaccel
3982      * and hwaccel_context are already uninitialized.
3983      */
3984     int (*uninit)(AVCodecContext *avctx);
3985
3986     /**
3987      * Size of the private data to allocate in
3988      * AVCodecInternal.hwaccel_priv_data.
3989      */
3990     int priv_data_size;
3991
3992     /**
3993      * Internal hwaccel capabilities.
3994      */
3995     int caps_internal;
3996 } AVHWAccel;
3997
3998 /**
3999  * HWAccel is experimental and is thus avoided in favor of non experimental
4000  * codecs
4001  */
4002 #define AV_HWACCEL_CODEC_CAP_EXPERIMENTAL 0x0200
4003
4004 /**
4005  * Hardware acceleration should be used for decoding even if the codec level
4006  * used is unknown or higher than the maximum supported level reported by the
4007  * hardware driver.
4008  *
4009  * It's generally a good idea to pass this flag unless you have a specific
4010  * reason not to, as hardware tends to under-report supported levels.
4011  */
4012 #define AV_HWACCEL_FLAG_IGNORE_LEVEL (1 << 0)
4013
4014 /**
4015  * Hardware acceleration can output YUV pixel formats with a different chroma
4016  * sampling than 4:2:0 and/or other than 8 bits per component.
4017  */
4018 #define AV_HWACCEL_FLAG_ALLOW_HIGH_DEPTH (1 << 1)
4019
4020 /**
4021  * Hardware acceleration should still be attempted for decoding when the
4022  * codec profile does not match the reported capabilities of the hardware.
4023  *
4024  * For example, this can be used to try to decode baseline profile H.264
4025  * streams in hardware - it will often succeed, because many streams marked
4026  * as baseline profile actually conform to constrained baseline profile.
4027  *
4028  * @warning If the stream is actually not supported then the behaviour is
4029  *          undefined, and may include returning entirely incorrect output
4030  *          while indicating success.
4031  */
4032 #define AV_HWACCEL_FLAG_ALLOW_PROFILE_MISMATCH (1 << 2)
4033
4034 /**
4035  * @}
4036  */
4037
4038 #if FF_API_AVPICTURE
4039 /**
4040  * @defgroup lavc_picture AVPicture
4041  *
4042  * Functions for working with AVPicture
4043  * @{
4044  */
4045
4046 /**
4047  * Picture data structure.
4048  *
4049  * Up to four components can be stored into it, the last component is
4050  * alpha.
4051  * @deprecated use AVFrame or imgutils functions instead
4052  */
4053 typedef struct AVPicture {
4054     attribute_deprecated
4055     uint8_t *data[AV_NUM_DATA_POINTERS];    ///< pointers to the image data planes
4056     attribute_deprecated
4057     int linesize[AV_NUM_DATA_POINTERS];     ///< number of bytes per line
4058 } AVPicture;
4059
4060 /**
4061  * @}
4062  */
4063 #endif
4064
4065 enum AVSubtitleType {
4066     SUBTITLE_NONE,
4067
4068     SUBTITLE_BITMAP,                ///< A bitmap, pict will be set
4069
4070     /**
4071      * Plain text, the text field must be set by the decoder and is
4072      * authoritative. ass and pict fields may contain approximations.
4073      */
4074     SUBTITLE_TEXT,
4075
4076     /**
4077      * Formatted text, the ass field must be set by the decoder and is
4078      * authoritative. pict and text fields may contain approximations.
4079      */
4080     SUBTITLE_ASS,
4081 };
4082
4083 #define AV_SUBTITLE_FLAG_FORCED 0x00000001
4084
4085 typedef struct AVSubtitleRect {
4086     int x;         ///< top left corner  of pict, undefined when pict is not set
4087     int y;         ///< top left corner  of pict, undefined when pict is not set
4088     int w;         ///< width            of pict, undefined when pict is not set
4089     int h;         ///< height           of pict, undefined when pict is not set
4090     int nb_colors; ///< number of colors in pict, undefined when pict is not set
4091
4092 #if FF_API_AVPICTURE
4093     /**
4094      * @deprecated unused
4095      */
4096     attribute_deprecated
4097     AVPicture pict;
4098 #endif
4099     /**
4100      * data+linesize for the bitmap of this subtitle.
4101      * Can be set for text/ass as well once they are rendered.
4102      */
4103     uint8_t *data[4];
4104     int linesize[4];
4105
4106     enum AVSubtitleType type;
4107
4108     char *text;                     ///< 0 terminated plain UTF-8 text
4109
4110     /**
4111      * 0 terminated ASS/SSA compatible event line.
4112      * The presentation of this is unaffected by the other values in this
4113      * struct.
4114      */
4115     char *ass;
4116
4117     int flags;
4118 } AVSubtitleRect;
4119
4120 typedef struct AVSubtitle {
4121     uint16_t format; /* 0 = graphics */
4122     uint32_t start_display_time; /* relative to packet pts, in ms */
4123     uint32_t end_display_time; /* relative to packet pts, in ms */
4124     unsigned num_rects;
4125     AVSubtitleRect **rects;
4126     int64_t pts;    ///< Same as packet pts, in AV_TIME_BASE
4127 } AVSubtitle;
4128
4129 /**
4130  * This struct describes the properties of an encoded stream.
4131  *
4132  * sizeof(AVCodecParameters) is not a part of the public ABI, this struct must
4133  * be allocated with avcodec_parameters_alloc() and freed with
4134  * avcodec_parameters_free().
4135  */
4136 typedef struct AVCodecParameters {
4137     /**
4138      * General type of the encoded data.
4139      */
4140     enum AVMediaType codec_type;
4141     /**
4142      * Specific type of the encoded data (the codec used).
4143      */
4144     enum AVCodecID   codec_id;
4145     /**
4146      * Additional information about the codec (corresponds to the AVI FOURCC).
4147      */
4148     uint32_t         codec_tag;
4149
4150     /**
4151      * Extra binary data needed for initializing the decoder, codec-dependent.
4152      *
4153      * Must be allocated with av_malloc() and will be freed by
4154      * avcodec_parameters_free(). The allocated size of extradata must be at
4155      * least extradata_size + AV_INPUT_BUFFER_PADDING_SIZE, with the padding
4156      * bytes zeroed.
4157      */
4158     uint8_t *extradata;
4159     /**
4160      * Size of the extradata content in bytes.
4161      */
4162     int      extradata_size;
4163
4164     /**
4165      * - video: the pixel format, the value corresponds to enum AVPixelFormat.
4166      * - audio: the sample format, the value corresponds to enum AVSampleFormat.
4167      */
4168     int format;
4169
4170     /**
4171      * The average bitrate of the encoded data (in bits per second).
4172      */
4173     int64_t bit_rate;
4174
4175     /**
4176      * The number of bits per sample in the codedwords.
4177      *
4178      * This is basically the bitrate per sample. It is mandatory for a bunch of
4179      * formats to actually decode them. It's the number of bits for one sample in
4180      * the actual coded bitstream.
4181      *
4182      * This could be for example 4 for ADPCM
4183      * For PCM formats this matches bits_per_raw_sample
4184      * Can be 0
4185      */
4186     int bits_per_coded_sample;
4187
4188     /**
4189      * This is the number of valid bits in each output sample. If the
4190      * sample format has more bits, the least significant bits are additional
4191      * padding bits, which are always 0. Use right shifts to reduce the sample
4192      * to its actual size. For example, audio formats with 24 bit samples will
4193      * have bits_per_raw_sample set to 24, and format set to AV_SAMPLE_FMT_S32.
4194      * To get the original sample use "(int32_t)sample >> 8"."
4195      *
4196      * For ADPCM this might be 12 or 16 or similar
4197      * Can be 0
4198      */
4199     int bits_per_raw_sample;
4200
4201     /**
4202      * Codec-specific bitstream restrictions that the stream conforms to.
4203      */
4204     int profile;
4205     int level;
4206
4207     /**
4208      * Video only. The dimensions of the video frame in pixels.
4209      */
4210     int width;
4211     int height;
4212
4213     /**
4214      * Video only. The aspect ratio (width / height) which a single pixel
4215      * should have when displayed.
4216      *
4217      * When the aspect ratio is unknown / undefined, the numerator should be
4218      * set to 0 (the denominator may have any value).
4219      */
4220     AVRational sample_aspect_ratio;
4221
4222     /**
4223      * Video only. The order of the fields in interlaced video.
4224      */
4225     enum AVFieldOrder                  field_order;
4226
4227     /**
4228      * Video only. Additional colorspace characteristics.
4229      */
4230     enum AVColorRange                  color_range;
4231     enum AVColorPrimaries              color_primaries;
4232     enum AVColorTransferCharacteristic color_trc;
4233     enum AVColorSpace                  color_space;
4234     enum AVChromaLocation              chroma_location;
4235
4236     /**
4237      * Video only. Number of delayed frames.
4238      */
4239     int video_delay;
4240
4241     /**
4242      * Audio only. The channel layout bitmask. May be 0 if the channel layout is
4243      * unknown or unspecified, otherwise the number of bits set must be equal to
4244      * the channels field.
4245      */
4246     uint64_t channel_layout;
4247     /**
4248      * Audio only. The number of audio channels.
4249      */
4250     int      channels;
4251     /**
4252      * Audio only. The number of audio samples per second.
4253      */
4254     int      sample_rate;
4255     /**
4256      * Audio only. The number of bytes per coded audio frame, required by some
4257      * formats.
4258      *
4259      * Corresponds to nBlockAlign in WAVEFORMATEX.
4260      */
4261     int      block_align;
4262     /**
4263      * Audio only. Audio frame size, if known. Required by some formats to be static.
4264      */
4265     int      frame_size;
4266
4267     /**
4268      * Audio only. The amount of padding (in samples) inserted by the encoder at
4269      * the beginning of the audio. I.e. this number of leading decoded samples
4270      * must be discarded by the caller to get the original audio without leading
4271      * padding.
4272      */
4273     int initial_padding;
4274     /**
4275      * Audio only. The amount of padding (in samples) appended by the encoder to
4276      * the end of the audio. I.e. this number of decoded samples must be
4277      * discarded by the caller from the end of the stream to get the original
4278      * audio without any trailing padding.
4279      */
4280     int trailing_padding;
4281     /**
4282      * Audio only. Number of samples to skip after a discontinuity.
4283      */
4284     int seek_preroll;
4285 } AVCodecParameters;
4286
4287 /**
4288  * If c is NULL, returns the first registered codec,
4289  * if c is non-NULL, returns the next registered codec after c,
4290  * or NULL if c is the last one.
4291  */
4292 AVCodec *av_codec_next(const AVCodec *c);
4293
4294 /**
4295  * Return the LIBAVCODEC_VERSION_INT constant.
4296  */
4297 unsigned avcodec_version(void);
4298
4299 /**
4300  * Return the libavcodec build-time configuration.
4301  */
4302 const char *avcodec_configuration(void);
4303
4304 /**
4305  * Return the libavcodec license.
4306  */
4307 const char *avcodec_license(void);
4308
4309 /**
4310  * Register the codec codec and initialize libavcodec.
4311  *
4312  * @warning either this function or avcodec_register_all() must be called
4313  * before any other libavcodec functions.
4314  *
4315  * @see avcodec_register_all()
4316  */
4317 void avcodec_register(AVCodec *codec);
4318
4319 /**
4320  * Register all the codecs, parsers and bitstream filters which were enabled at
4321  * configuration time. If you do not call this function you can select exactly
4322  * which formats you want to support, by using the individual registration
4323  * functions.
4324  *
4325  * @see avcodec_register
4326  * @see av_register_codec_parser
4327  * @see av_register_bitstream_filter
4328  */
4329 void avcodec_register_all(void);
4330
4331 /**
4332  * Allocate an AVCodecContext and set its fields to default values. The
4333  * resulting struct should be freed with avcodec_free_context().
4334  *
4335  * @param codec if non-NULL, allocate private data and initialize defaults
4336  *              for the given codec. It is illegal to then call avcodec_open2()
4337  *              with a different codec.
4338  *              If NULL, then the codec-specific defaults won't be initialized,
4339  *              which may result in suboptimal default settings (this is
4340  *              important mainly for encoders, e.g. libx264).
4341  *
4342  * @return An AVCodecContext filled with default values or NULL on failure.
4343  */
4344 AVCodecContext *avcodec_alloc_context3(const AVCodec *codec);
4345
4346 /**
4347  * Free the codec context and everything associated with it and write NULL to
4348  * the provided pointer.
4349  */
4350 void avcodec_free_context(AVCodecContext **avctx);
4351
4352 #if FF_API_GET_CONTEXT_DEFAULTS
4353 /**
4354  * @deprecated This function should not be used, as closing and opening a codec
4355  * context multiple time is not supported. A new codec context should be
4356  * allocated for each new use.
4357  */
4358 int avcodec_get_context_defaults3(AVCodecContext *s, const AVCodec *codec);
4359 #endif
4360
4361 /**
4362  * Get the AVClass for AVCodecContext. It can be used in combination with
4363  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4364  *
4365  * @see av_opt_find().
4366  */
4367 const AVClass *avcodec_get_class(void);
4368
4369 #if FF_API_COPY_CONTEXT
4370 /**
4371  * Get the AVClass for AVFrame. It can be used in combination with
4372  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4373  *
4374  * @see av_opt_find().
4375  */
4376 const AVClass *avcodec_get_frame_class(void);
4377
4378 /**
4379  * Get the AVClass for AVSubtitleRect. It can be used in combination with
4380  * AV_OPT_SEARCH_FAKE_OBJ for examining options.
4381  *
4382  * @see av_opt_find().
4383  */
4384 const AVClass *avcodec_get_subtitle_rect_class(void);
4385
4386 /**
4387  * Copy the settings of the source AVCodecContext into the destination
4388  * AVCodecContext. The resulting destination codec context will be
4389  * unopened, i.e. you are required to call avcodec_open2() before you
4390  * can use this AVCodecContext to decode/encode video/audio data.
4391  *
4392  * @param dest target codec context, should be initialized with
4393  *             avcodec_alloc_context3(NULL), but otherwise uninitialized
4394  * @param src source codec context
4395  * @return AVERROR() on error (e.g. memory allocation error), 0 on success
4396  *
4397  * @deprecated The semantics of this function are ill-defined and it should not
4398  * be used. If you need to transfer the stream parameters from one codec context
4399  * to another, use an intermediate AVCodecParameters instance and the
4400  * avcodec_parameters_from_context() / avcodec_parameters_to_context()
4401  * functions.
4402  */
4403 attribute_deprecated
4404 int avcodec_copy_context(AVCodecContext *dest, const AVCodecContext *src);
4405 #endif
4406
4407 /**
4408  * Allocate a new AVCodecParameters and set its fields to default values
4409  * (unknown/invalid/0). The returned struct must be freed with
4410  * avcodec_parameters_free().
4411  */
4412 AVCodecParameters *avcodec_parameters_alloc(void);
4413
4414 /**
4415  * Free an AVCodecParameters instance and everything associated with it and
4416  * write NULL to the supplied pointer.
4417  */
4418 void avcodec_parameters_free(AVCodecParameters **par);
4419
4420 /**
4421  * Copy the contents of src to dst. Any allocated fields in dst are freed and
4422  * replaced with newly allocated duplicates of the corresponding fields in src.
4423  *
4424  * @return >= 0 on success, a negative AVERROR code on failure.
4425  */
4426 int avcodec_parameters_copy(AVCodecParameters *dst, const AVCodecParameters *src);
4427
4428 /**
4429  * Fill the parameters struct based on the values from the supplied codec
4430  * context. Any allocated fields in par are freed and replaced with duplicates
4431  * of the corresponding fields in codec.
4432  *
4433  * @return >= 0 on success, a negative AVERROR code on failure
4434  */
4435 int avcodec_parameters_from_context(AVCodecParameters *par,
4436                                     const AVCodecContext *codec);
4437
4438 /**
4439  * Fill the codec context based on the values from the supplied codec
4440  * parameters. Any allocated fields in codec that have a corresponding field in
4441  * par are freed and replaced with duplicates of the corresponding field in par.
4442  * Fields in codec that do not have a counterpart in par are not touched.
4443  *
4444  * @return >= 0 on success, a negative AVERROR code on failure.
4445  */
4446 int avcodec_parameters_to_context(AVCodecContext *codec,
4447                                   const AVCodecParameters *par);
4448
4449 /**
4450  * Initialize the AVCodecContext to use the given AVCodec. Prior to using this
4451  * function the context has to be allocated with avcodec_alloc_context3().
4452  *
4453  * The functions avcodec_find_decoder_by_name(), avcodec_find_encoder_by_name(),
4454  * avcodec_find_decoder() and avcodec_find_encoder() provide an easy way for
4455  * retrieving a codec.
4456  *
4457  * @warning This function is not thread safe!
4458  *
4459  * @note Always call this function before using decoding routines (such as
4460  * @ref avcodec_receive_frame()).
4461  *
4462  * @code
4463  * avcodec_register_all();
4464  * av_dict_set(&opts, "b", "2.5M", 0);
4465  * codec = avcodec_find_decoder(AV_CODEC_ID_H264);
4466  * if (!codec)
4467  *     exit(1);
4468  *
4469  * context = avcodec_alloc_context3(codec);
4470  *
4471  * if (avcodec_open2(context, codec, opts) < 0)
4472  *     exit(1);
4473  * @endcode
4474  *
4475  * @param avctx The context to initialize.
4476  * @param codec The codec to open this context for. If a non-NULL codec has been
4477  *              previously passed to avcodec_alloc_context3() or
4478  *              for this context, then this parameter MUST be either NULL or
4479  *              equal to the previously passed codec.
4480  * @param options A dictionary filled with AVCodecContext and codec-private options.
4481  *                On return this object will be filled with options that were not found.
4482  *
4483  * @return zero on success, a negative value on error
4484  * @see avcodec_alloc_context3(), avcodec_find_decoder(), avcodec_find_encoder(),
4485  *      av_dict_set(), av_opt_find().
4486  */
4487 int avcodec_open2(AVCodecContext *avctx, const AVCodec *codec, AVDictionary **options);
4488
4489 /**
4490  * Close a given AVCodecContext and free all the data associated with it
4491  * (but not the AVCodecContext itself).
4492  *
4493  * Calling this function on an AVCodecContext that hasn't been opened will free
4494  * the codec-specific data allocated in avcodec_alloc_context3() with a non-NULL
4495  * codec. Subsequent calls will do nothing.
4496  *
4497  * @note Do not use this function. Use avcodec_free_context() to destroy a
4498  * codec context (either open or closed). Opening and closing a codec context
4499  * multiple times is not supported anymore -- use multiple codec contexts
4500  * instead.
4501  */
4502 int avcodec_close(AVCodecContext *avctx);
4503
4504 /**
4505  * Free all allocated data in the given subtitle struct.
4506  *
4507  * @param sub AVSubtitle to free.
4508  */
4509 void avsubtitle_free(AVSubtitle *sub);
4510
4511 /**
4512  * @}
4513  */
4514
4515 /**
4516  * @addtogroup lavc_packet
4517  * @{
4518  */
4519
4520 /**
4521  * Allocate an AVPacket and set its fields to default values.  The resulting
4522  * struct must be freed using av_packet_free().
4523  *
4524  * @return An AVPacket filled with default values or NULL on failure.
4525  *
4526  * @note this only allocates the AVPacket itself, not the data buffers. Those
4527  * must be allocated through other means such as av_new_packet.
4528  *
4529  * @see av_new_packet
4530  */
4531 AVPacket *av_packet_alloc(void);
4532
4533 /**
4534  * Create a new packet that references the same data as src.
4535  *
4536  * This is a shortcut for av_packet_alloc()+av_packet_ref().
4537  *
4538  * @return newly created AVPacket on success, NULL on error.
4539  *
4540  * @see av_packet_alloc
4541  * @see av_packet_ref
4542  */
4543 AVPacket *av_packet_clone(const AVPacket *src);
4544
4545 /**
4546  * Free the packet, if the packet is reference counted, it will be
4547  * unreferenced first.
4548  *
4549  * @param pkt packet to be freed. The pointer will be set to NULL.
4550  * @note passing NULL is a no-op.
4551  */
4552 void av_packet_free(AVPacket **pkt);
4553
4554 /**
4555  * Initialize optional fields of a packet with default values.
4556  *
4557  * Note, this does not touch the data and size members, which have to be
4558  * initialized separately.
4559  *
4560  * @param pkt packet
4561  */
4562 void av_init_packet(AVPacket *pkt);
4563
4564 /**
4565  * Allocate the payload of a packet and initialize its fields with
4566  * default values.
4567  *
4568  * @param pkt packet
4569  * @param size wanted payload size
4570  * @return 0 if OK, AVERROR_xxx otherwise
4571  */