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