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