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