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