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