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