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