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