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